Merge pull request #49 from shiftcode/#48-injection-token

Replace LogRequestInfoProvider with provider function

Author: michaelwittwer

README.md

@@ -11,18 +11,22 @@ Public Angular libraries used in various shiftcode projects.
 > ![@shiftcode/ngx-ssr](https://img.shields.io/badge/@shiftcode/ngx--ssr-deprecated-f48700)\
 > Not used anymore starting with Angular 17. See necessary changes in [ssr.md](./ssr.md)
 
+> ![@shiftcode/ngx-aws](https://img.shields.io/badge/@shiftcode/ngx--aws-deprecated-f48700)\
+> Not used anymore since we refactored how the logging to AWS CloudWatch works. See [Changlog](https://github.com/shiftcode/sc-ng-commons-public/blob/%40shiftcode/ngx-aws%407.0.0/libs/aws/CHANGELOG.md)
+> for previous versions.
+
 ## Angular to Lib Version Mapping
 Shows the mapping between the angular version and our lib versions.
 
-| Angular Version | Lib Version |
-|-----------------|-------------|
-| `^19`           | `^7`        | 
-| `^18`           | `^6`        | 
-| `^17`           | `^5`        |
-| `^16`           | `^4`        |
-| `^15`           | `^3`        |
-| `^14`           | `^2`        |
-| `^13`           | `^1`        |
+| Angular Version | Lib Version                   |
+|-----------------|-------------------------------|
+| `^19`           | `^7 \|\| ^8 \|\| ^9 \|\| ^10` | 
+| `^18`           | `^6`                          | 
+| `^17`           | `^5`                          |
+| `^16`           | `^4`                          |
+| `^15`           | `^3`                          |
+| `^14`           | `^2`                          |
+| `^13`           | `^1`                          |
 
 
 ## Anatomy of this workspace

libs/components/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shiftcode/ngx-components",
-  "version": "9.0.0",
+  "version": "10.0.0-pr48.2",
   "repository": "https://github.com/shiftcode/sc-ng-commons-public",
   "license": "MIT",
   "author": "shiftcode GmbH <team@shiftcode.ch>",
@@ -25,7 +25,7 @@
     "@angular/forms": "^19.0.0",
     "@angular/router": "^19.0.0",
     "@shiftcode/logger": "^3.0.0",
-    "@shiftcode/ngx-core": "^9.0.0 || ^9.0.0-pr46",
+    "@shiftcode/ngx-core": "^9.0.0 || ^10.0.0 || ^10.0.0-pr48",
     "rxjs": "^6.5.3 || ^7.4.0"
   }
 }

libs/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shiftcode/ngx-core",
-  "version": "9.0.0",
+  "version": "10.0.0-pr48.3",
   "repository": "https://github.com/shiftcode/sc-ng-commons-public",
   "license": "MIT",
   "author": "shiftcode GmbH <team@shiftcode.ch>",

libs/core/src/lib/logger/cloudwatch/cloud-watch.service.ts

@@ -9,8 +9,8 @@ import { CloudWatchLogTransportConfig } from './cloud-watch-log-transport-config
 import { HttpClient } from '@angular/common/http'
 import { isLogStreamNotFoundError } from './is-error.function'
 import { ClientIdService } from '../../client-id/client-id.service'
-import { LogRequestInfoProvider } from '../log-request-info-provider'
 import { RemoteLogData } from '../remote/remote-log-data.model'
+import { LOG_REQUEST_INFO } from '../log-request-info.token'
 
 interface CloudWatchLogEvent {
   logStreamName: string
@@ -34,7 +34,7 @@ export class CloudWatchService {
     private httpClient: HttpClient,
     clientIdService: ClientIdService,
     @Inject(CLOUD_WATCH_LOG_TRANSPORT_CONFIG) private readonly config: CloudWatchLogTransportConfig,
-    @Optional() private logRequestInfoProvider?: LogRequestInfoProvider,
+    @Optional() @Inject(LOG_REQUEST_INFO) private logRequestInfoProvider?: Record<string, string>,
   ) {
     this.clientId = clientIdService.clientId
     this.jsonStringifyReplacer = config.jsonStringifyReplacer || jsonMapSetStringifyReplacer
@@ -61,7 +61,7 @@ export class CloudWatchService {
 
     const logDataObject: RemoteLogData = {
       ...createJsonLogObjectData(level, context, dTimestamp, args),
-      requestInfo: this.logRequestInfoProvider?.getRequestInfo() ?? {},
+      requestInfo: this.logRequestInfoProvider ?? {},
     }
 
     this.logsSubject.next({

libs/core/src/lib/logger/log-request-info-provider.ts

@@ -0,0 +1,3 @@
+import { InjectionToken } from '@angular/core'
+
+export const LOG_REQUEST_INFO = new InjectionToken<Record<string, string>>('LOG_REQUEST_INFO')

libs/core/src/lib/logger/log-request-info.token.ts

@@ -0,0 +1,24 @@
+import { EnvironmentProviders, FactoryProvider, makeEnvironmentProviders, ValueProvider } from '@angular/core'
+import { LOG_REQUEST_INFO } from './log-request-info.token'
+
+type LogRequestInfo = Record<string, string | undefined>
+
+export function provideLogRequestInfo(
+  logRequestInfoOrFactory: LogRequestInfo | (() => LogRequestInfo),
+): EnvironmentProviders {
+  if (typeof logRequestInfoOrFactory === 'function') {
+    return makeEnvironmentProviders([
+      {
+        provide: LOG_REQUEST_INFO,
+        useFactory: logRequestInfoOrFactory,
+      } satisfies FactoryProvider,
+    ])
+  } else {
+    return makeEnvironmentProviders([
+      {
+        provide: LOG_REQUEST_INFO,
+        useValue: logRequestInfoOrFactory,
+      } satisfies ValueProvider,
+    ])
+  }
+}

libs/core/src/lib/logger/provide-log-request-info.ts

@@ -2,23 +2,23 @@
 import { HttpClient, HttpHeaders } from '@angular/common/http'
 import { Inject, Injectable, Optional } from '@angular/core'
 import { createJsonLogObjectData, LogLevel } from '@shiftcode/logger'
-import { LogRequestInfoProvider } from '../log-request-info-provider'
 import { REMOTE_LOG_CONFIG } from './remote-log-config.injection-token'
 import { RemoteLogConfig } from './remote-log-config.model'
 import { RemoteLogData } from './remote-log-data.model'
+import { LOG_REQUEST_INFO } from '../log-request-info.token'
 
 @Injectable({ providedIn: 'root' })
 export class RemoteLogService {
   protected constructor(
     private httpClient: HttpClient,
     @Inject(REMOTE_LOG_CONFIG) private config: RemoteLogConfig,
-    @Optional() private logRequestInfoProvider?: LogRequestInfoProvider,
+    @Optional() @Inject(LOG_REQUEST_INFO) private logRequestInfoProvider?: Record<string, string>,
   ) {}
 
   sendMessage(level: LogLevel, context: string, timestamp: Date, args: any[]) {
     const remoteLogData: RemoteLogData = {
       ...createJsonLogObjectData(level, context, timestamp, args),
-      requestInfo: this.logRequestInfoProvider?.getRequestInfo() ?? {},
+      requestInfo: this.logRequestInfoProvider ?? {},
     }
     this.postToBackend(remoteLogData)
   }

libs/core/src/lib/logger/remote/remote-log.service.ts

@@ -13,7 +13,8 @@ export * from './lib/local-storage/local-storage-options'
 export * from './lib/local-storage/provide-local-storage'
 
 // logger
-export * from './lib/logger/log-request-info-provider'
+export * from './lib/logger/log-request-info.token'
+export * from './lib/logger/provide-log-request-info'
 export * from './lib/logger/logger.service'
 export * from './lib/logger/provide-logger'