Merge pull request #57 from shiftcode/#56-fix-provideLogRequestInfo

mumenthalers · web-flow · commit fdb1a9f3d51c · 2025-09-09T12:26:49.000+02:00
#56 fix provide log request info
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ Shows the mapping between the angular version and our lib versions.
 
 | Angular Version | Lib Version                   |
 |-----------------|-------------------------------|
-| `^20`           | `^11`                         |
+| `^20`           | `^11 \|\| ^12`                |
 | `^19`           | `^7 \|\| ^8 \|\| ^9 \|\| ^10` | 
 | `^18`           | `^6`                          | 
 | `^17`           | `^5`                          |
diff --git a/libs/components/package.json b/libs/components/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@shiftcode/ngx-components",
-  "version": "11.0.0",
+  "version": "12.0.0-pr56.2",
   "repository": "https://github.com/shiftcode/sc-ng-commons-public",
   "license": "MIT",
   "author": "shiftcode GmbH <team@shiftcode.ch>",
@@ -25,7 +25,7 @@
     "@angular/forms": "^20.0.0",
     "@angular/router": "^20.0.0",
     "@shiftcode/logger": "^3.0.0",
-    "@shiftcode/ngx-core": "^11.0.0 || ^11.0.0-pr50",
+    "@shiftcode/ngx-core": "^12.0.0 || ^12.0.0-pr56",
     "rxjs": "^6.5.3 || ^7.4.0"
   }
 }
diff --git a/libs/core/README.md b/libs/core/README.md
@@ -60,3 +60,27 @@ class MyDirective {
 - Node Console: `withNodeConsoleTransport(...)`
 - Remote: `withRemoteTransport(...)`
 - AWS CloudWatch: see `withCloudwatchTransport(...)`
+
+### LogRequestInfo Integration
+You can enrich your log requests for `Remote` and `CloudWatch` Transports with custom information like user/session/device metadata using the `withRequestInfoFn` feature.
+
+#### Usage Example
+Use the feature `withRequestInfoFn` function to provide a factory for a `LogRequestInfoFn`.
+The `LogRequestInfoFn` is a function itself that is called prior every log request. Its return value needs to be an object with the information to be included.
+
+```ts
+import { LogLevel, provideLogger, withRemoteTransport, withRequestInfoFn, LogRequestInfo } from '@shiftcode/ngx-core'
+
+bootstrapApplication(AppComponent, {
+  providers: [
+    provideLogger(
+      withRemoteTransport({ logLevel: LogLevel.INFO, /* ...other config... */ }),
+      withRequestInfoFn(() => {
+        const authService = inject(AuthService)
+        const router = inject(Router)
+        return (): LogRequestInfo => ({ userId: authService.currentUser?.id, url: this.router.url })
+      })
+    ),
+  ],
+})
+```
diff --git a/libs/core/package.json b/libs/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@shiftcode/ngx-core",
-  "version": "11.1.0",
+  "version": "12.0.0-pr56.4",
   "repository": "https://github.com/shiftcode/sc-ng-commons-public",
   "license": "MIT",
   "author": "shiftcode GmbH <team@shiftcode.ch>",
diff --git a/libs/core/src/lib/logger/cloudwatch/cloud-watch.service.ts b/libs/core/src/lib/logger/cloudwatch/cloud-watch.service.ts
@@ -1,16 +1,15 @@
 /* eslint-disable no-console */
-import { Injectable, inject } from '@angular/core'
+import { inject, Injectable } from '@angular/core'
 import { createJsonLogObjectData, LogLevel } from '@shiftcode/logger'
 import { jsonMapSetStringifyReplacer } from '@shiftcode/utilities'
 import { BehaviorSubject, concatMap, Observable, of, retry, Subject, throwError } from 'rxjs'
 import { catchError, filter, map, mergeMap, shareReplay, take } from 'rxjs/operators'
 import { CLOUD_WATCH_LOG_TRANSPORT_CONFIG } from './cloud-watch-log-transport-config.injection-token'
-import { CloudWatchLogTransportConfig } from './cloud-watch-log-transport-config.model'
 import { HttpClient } from '@angular/common/http'
 import { isLogStreamNotFoundError } from './is-error.function'
 import { ClientIdService } from '../../client-id/client-id.service'
 import { RemoteLogData } from '../remote/remote-log-data.model'
-import { LOG_REQUEST_INFO } from '../log-request-info.token'
+import { LOG_REQUEST_INFO_FN } from '../log-request-info-fn.token'
 
 interface CloudWatchLogEvent {
   logStreamName: string
@@ -25,8 +24,8 @@ interface CloudWatchLogEvent {
 @Injectable({ providedIn: 'root' })
 export class CloudWatchService {
   private readonly httpClient = inject(HttpClient)
-  private readonly config = inject<CloudWatchLogTransportConfig>(CLOUD_WATCH_LOG_TRANSPORT_CONFIG)
-  private readonly logRequestInfoProvider = inject<Record<string, string>>(LOG_REQUEST_INFO, { optional: true })
+  private readonly config = inject(CLOUD_WATCH_LOG_TRANSPORT_CONFIG)
+  private readonly logRequestInfoFn = inject(LOG_REQUEST_INFO_FN, { optional: true })
 
   private readonly retrying$ = new BehaviorSubject<boolean>(false)
   private readonly logStream$ = new Observable<void>()
@@ -62,7 +61,9 @@ export class CloudWatchService {
 
     const logDataObject: RemoteLogData = {
       ...createJsonLogObjectData(level, context, dTimestamp, args),
-      requestInfo: this.logRequestInfoProvider ?? {},
+    }
+    if (this.logRequestInfoFn) {
+      logDataObject.requestInfo = this.logRequestInfoFn()
     }
 
     this.logsSubject.next({
diff --git a/libs/core/src/lib/logger/cloudwatch/with-cloudwatch-transport.function.ts b/libs/core/src/lib/logger/cloudwatch/with-cloudwatch-transport.function.ts
@@ -1,8 +1,9 @@
-import { LoggerFeature, LoggerFeatureKind } from '../provide-logger'
 import { LogTransport } from '@shiftcode/logger'
 import { CLOUD_WATCH_LOG_TRANSPORT_CONFIG } from './cloud-watch-log-transport-config.injection-token'
 import { CloudWatchLogTransportConfig } from './cloud-watch-log-transport-config.model'
 import { CloudWatchLogTransport } from './cloud-watch-log-transport.service'
+import { LoggerFeatureKind } from '../logger-feature-kind.enum'
+import { LoggerFeature } from '../logger-feature.type'
 
 export function withCloudwatchTransport(
   cloudWatchLogTransportConfigOrFactory: CloudWatchLogTransportConfig | (() => CloudWatchLogTransportConfig),
diff --git a/libs/core/src/lib/logger/console/with-browser-console-transport.function.ts b/libs/core/src/lib/logger/console/with-browser-console-transport.function.ts
@@ -1,8 +1,9 @@
-import { LoggerFeature, LoggerFeatureKind } from '../provide-logger'
 import { ConsoleLogTransportConfig } from './console-log-transport-config'
 import { CONSOLE_LOG_TRANSPORT_CONFIG } from './console-log-transport-config.injection-token'
 import { ConsoleLogTransport } from './console-log-transport.service'
 import { LogTransport } from '@shiftcode/logger'
+import { LoggerFeatureKind } from '../logger-feature-kind.enum'
+import { LoggerFeature } from '../logger-feature.type'
 
 export function withBrowserConsoleTransport(
   consoleLoggerConfigOrFactory: ConsoleLogTransportConfig | (() => ConsoleLogTransportConfig),
diff --git a/libs/core/src/lib/logger/console/with-node-console-transport.function.ts b/libs/core/src/lib/logger/console/with-node-console-transport.function.ts
@@ -1,8 +1,9 @@
-import { LoggerFeature, LoggerFeatureKind } from '../provide-logger'
 import { ConsoleLogTransportConfig } from './console-log-transport-config'
 import { CONSOLE_LOG_TRANSPORT_CONFIG } from './console-log-transport-config.injection-token'
 import { NodeConsoleLogTransport } from './node-console-log-transport.service'
 import { LogTransport } from '@shiftcode/logger'
+import { LoggerFeatureKind } from '../logger-feature-kind.enum'
+import { LoggerFeature } from '../logger-feature.type'
 
 export function withNodeConsoleTransport(
   consoleLoggerConfigOrFactory: ConsoleLogTransportConfig | (() => ConsoleLogTransportConfig),
diff --git a/libs/core/src/lib/logger/log-request-info-fn.token.ts b/libs/core/src/lib/logger/log-request-info-fn.token.ts
@@ -0,0 +1,4 @@
+import { InjectionToken } from '@angular/core'
+import { LogRequestInfoFn } from './log-request-info-fn.type'
+
+export const LOG_REQUEST_INFO_FN = new InjectionToken<LogRequestInfoFn>('LOG_REQUEST_INFO_FN')
diff --git a/libs/core/src/lib/logger/log-request-info-fn.type.ts b/libs/core/src/lib/logger/log-request-info-fn.type.ts
@@ -0,0 +1,5 @@
+export type LogRequestInfo = Record<string, string | undefined | null>
+
+export interface LogRequestInfoFn {
+  (): LogRequestInfo
+}
diff --git a/libs/core/src/lib/logger/log-request-info.token.ts b/libs/core/src/lib/logger/log-request-info.token.ts
diff --git a/libs/core/src/lib/logger/logger-feature-kind.enum.ts b/libs/core/src/lib/logger/logger-feature-kind.enum.ts
@@ -0,0 +1,5 @@
+/** @internal */
+export enum LoggerFeatureKind {
+  TRANSPORT,
+  REQUEST_INFO_FN,
+}
diff --git a/libs/core/src/lib/logger/logger-feature.type.ts b/libs/core/src/lib/logger/logger-feature.type.ts
@@ -0,0 +1,7 @@
+import { Provider } from '@angular/core'
+import { LoggerFeatureKind } from './logger-feature-kind.enum'
+
+export interface LoggerFeature {
+  kind: LoggerFeatureKind
+  providers: Provider[]
+}
diff --git a/libs/core/src/lib/logger/provide-log-request-info.ts b/libs/core/src/lib/logger/provide-log-request-info.ts
diff --git a/libs/core/src/lib/logger/provide-logger.ts b/libs/core/src/lib/logger/provide-logger.ts
@@ -1,14 +1,6 @@
-import { EnvironmentProviders, makeEnvironmentProviders, Provider } from '@angular/core'
+import { EnvironmentProviders, makeEnvironmentProviders } from '@angular/core'
 
-/** @internal */
-export enum LoggerFeatureKind {
-  TRANSPORT,
-}
-
-export interface LoggerFeature {
-  kind: LoggerFeatureKind
-  providers: Provider[]
-}
+import { LoggerFeature } from './logger-feature.type'
 
 export function provideLogger(...features: LoggerFeature[]): EnvironmentProviders {
   return makeEnvironmentProviders([features.map((feature) => feature.providers)])
diff --git a/libs/core/src/lib/logger/remote/remote-log-data.model.ts b/libs/core/src/lib/logger/remote/remote-log-data.model.ts
@@ -1,5 +1,5 @@
 import { JsonLogObjectData } from '@shiftcode/logger'
 
 export interface RemoteLogData extends JsonLogObjectData {
-  requestInfo: Record<string, string>
+  requestInfo?: Record<string, string | undefined | null>
 }
diff --git a/libs/core/src/lib/logger/remote/remote-log.service.spec.ts b/libs/core/src/lib/logger/remote/remote-log.service.spec.ts
@@ -0,0 +1,96 @@
+import { TestBed } from '@angular/core/testing'
+import { HttpTestingController, provideHttpClientTesting } from '@angular/common/http/testing'
+import { RemoteLogService } from './remote-log.service'
+import { REMOTE_LOG_CONFIG } from './remote-log-config.injection-token'
+import { RemoteLogConfig } from './remote-log-config.model'
+import { createJsonLogObjectData, LogLevel } from '@shiftcode/logger'
+import { LOG_REQUEST_INFO_FN } from '../log-request-info-fn.token'
+import { LogRequestInfoFn } from '../log-request-info-fn.type'
+import { HttpHeaders, provideHttpClient } from '@angular/common/http'
+import { FactoryProvider, ValueProvider } from '@angular/core'
+
+describe('RemoteLogService', () => {
+  const mockConfig: RemoteLogConfig = {
+    logLevel: LogLevel.DEBUG,
+    url: 'https://logs.shiftcode.io/tests',
+  }
+
+  function setup(mockConfig: RemoteLogConfig, logRequestInfoFnFactory?: () => LogRequestInfoFn) {
+    TestBed.configureTestingModule({
+      providers: [
+        provideHttpClient(),
+        provideHttpClientTesting(),
+        { provide: REMOTE_LOG_CONFIG, useValue: mockConfig } satisfies ValueProvider,
+        ...(logRequestInfoFnFactory
+          ? [{ provide: LOG_REQUEST_INFO_FN, useFactory: logRequestInfoFnFactory } satisfies FactoryProvider]
+          : []),
+      ],
+    })
+    return [TestBed.inject(RemoteLogService), TestBed.inject(HttpTestingController)] as const
+  }
+
+  it('should be created', () => {
+    const [service] = setup(mockConfig)
+    expect(service).toBeTruthy()
+  })
+
+  it('should send log data to backend with correct payload and headers', () => {
+    const [service, httpMock] = setup(mockConfig)
+
+    const context = 'TestContext'
+    const timestamp = new Date('2025-09-08T20:25:00Z')
+    const args = ['some message', { foo: 'bar' }]
+
+    service.sendMessage(LogLevel.INFO, context, timestamp, args)
+
+    const req = httpMock.expectOne(mockConfig.url, 'Log POST request')
+    expect(req.request.method).toBe('POST')
+    expect(req.request.headers.get('Content-Type')).toBe('application/json')
+    expect(req.request.body).toEqual(
+      expect.objectContaining(createJsonLogObjectData(LogLevel.INFO, context, timestamp, args)),
+    )
+    req.flush('ok')
+
+    // assert that no other requests were made
+    httpMock.verify()
+  })
+
+  it('uses httpHeaders from the custom config', () => {
+    const headers = {
+      xCustomHeader: 'customValue',
+    } as const
+
+    const customConfig: RemoteLogConfig = {
+      logLevel: LogLevel.ERROR,
+      url: 'https://logs.shiftcode.io/tests',
+      httpHeaders: new HttpHeaders(headers),
+    }
+    const [service, httpMock] = setup(customConfig)
+
+    const context = 'TestContext'
+    const timestamp = new Date('2025-09-08T20:25:00Z')
+    const args = ['error occurred', { error: 'details' }]
+
+    service.sendMessage(LogLevel.ERROR, context, timestamp, args)
+
+    const req = httpMock.expectOne(customConfig.url, 'Log POST request with custom headers')
+    expect(req.request.method).toBe('POST')
+    expect(req.request.headers.get('xCustomHeader' satisfies keyof typeof headers)).toBe(headers.xCustomHeader)
+  })
+
+  it('calls logRequestInfoFn and includes its result in the log data', () => {
+    const logRequestInfoFn = jest.fn().mockReturnValue({ userId: '12345' })
+
+    const [service, httpMock] = setup(mockConfig, () => logRequestInfoFn)
+
+    const args = ['info message', { detail: 'info' }]
+    service.sendMessage(LogLevel.INFO, 'TestContext', new Date(), args)
+
+    const req = httpMock.expectOne(mockConfig.url, 'Log POST request with request info')
+    expect(req.request.method).toBe('POST')
+    expect(req.request.body).toEqual(expect.objectContaining({ requestInfo: { userId: '12345' } }))
+    expect(logRequestInfoFn).toHaveBeenCalledTimes(1)
+    req.flush('ok')
+    httpMock.verify()
+  })
+})
diff --git a/libs/core/src/lib/logger/remote/remote-log.service.ts b/libs/core/src/lib/logger/remote/remote-log.service.ts
@@ -1,22 +1,23 @@
 /* eslint-disable no-console */
 import { HttpClient, HttpHeaders } from '@angular/common/http'
-import { Injectable, inject } from '@angular/core'
+import { inject, Injectable } from '@angular/core'
 import { createJsonLogObjectData, LogLevel } from '@shiftcode/logger'
 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'
+import { LOG_REQUEST_INFO_FN } from '../log-request-info-fn.token'
 
 @Injectable({ providedIn: 'root' })
 export class RemoteLogService {
   private readonly httpClient = inject(HttpClient)
-  private readonly config = inject<RemoteLogConfig>(REMOTE_LOG_CONFIG)
-  private readonly logRequestInfoProvider = inject(LOG_REQUEST_INFO, { optional: true })
+  private readonly config = inject(REMOTE_LOG_CONFIG)
+  private readonly logRequestInfoFn = inject(LOG_REQUEST_INFO_FN, { optional: true })
 
   sendMessage(level: LogLevel, context: string, timestamp: Date, args: any[]) {
     const remoteLogData: RemoteLogData = {
       ...createJsonLogObjectData(level, context, timestamp, args),
-      requestInfo: this.logRequestInfoProvider ?? {},
+    }
+    if (this.logRequestInfoFn) {
+      remoteLogData.requestInfo = this.logRequestInfoFn()
     }
     this.postToBackend(remoteLogData)
   }
diff --git a/libs/core/src/lib/logger/remote/with-remote-transport.function.ts b/libs/core/src/lib/logger/remote/with-remote-transport.function.ts
@@ -1,8 +1,9 @@
-import { LoggerFeature, LoggerFeatureKind } from '../provide-logger'
 import { REMOTE_LOG_CONFIG } from './remote-log-config.injection-token'
 import { RemoteLogConfig } from './remote-log-config.model'
 import { RemoteLogTransport } from './remote-log-transport.service'
 import { LogTransport } from '@shiftcode/logger'
+import { LoggerFeatureKind } from '../logger-feature-kind.enum'
+import { LoggerFeature } from '../logger-feature.type'
 
 export function withRemoteTransport(
   remoteLogConfigOrFactory: RemoteLogConfig | (() => RemoteLogConfig),
diff --git a/libs/core/src/lib/logger/with-request-info-fn.function.ts b/libs/core/src/lib/logger/with-request-info-fn.function.ts
@@ -0,0 +1,21 @@
+import { LogRequestInfoFn } from './log-request-info-fn.type'
+import { LOG_REQUEST_INFO_FN } from './log-request-info-fn.token'
+import { FactoryProvider } from '@angular/core'
+import { LoggerFeatureKind } from './logger-feature-kind.enum'
+import { LoggerFeature } from './logger-feature.type'
+
+/**
+ * LoggerFeature feature to use with {@link provideLogger}
+ * @hint only works with {@link withRemoteTransport} and {@link withCloudwatchTransport}
+ */
+export function withRequestInfoFn(logRequestInfoFnFactory: () => LogRequestInfoFn): LoggerFeature {
+  return {
+    kind: LoggerFeatureKind.REQUEST_INFO_FN,
+    providers: [
+      {
+        provide: LOG_REQUEST_INFO_FN,
+        useFactory: logRequestInfoFnFactory,
+      } satisfies FactoryProvider,
+    ],
+  }
+}
diff --git a/libs/core/src/public-api.ts b/libs/core/src/public-api.ts
@@ -13,10 +13,11 @@ export * from './lib/local-storage/local-storage-options'
 export * from './lib/local-storage/provide-local-storage'
 
 // logger
-export * from './lib/logger/log-request-info.token'
-export * from './lib/logger/provide-log-request-info'
+export * from './lib/logger/log-request-info-fn.token'
+export * from './lib/logger/log-request-info-fn.type'
 export * from './lib/logger/logger.service'
 export * from './lib/logger/provide-logger'
+export * from './lib/logger/with-request-info-fn.function'
 
 //cloudwatch logger
 export * from './lib/logger/cloudwatch/cloud-watch.service'

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@shiftcode/ngx-components",`
`3`		`- "version": "11.0.0",`
	`3`	`+ "version": "12.0.0-pr56.2",`
`4`	`4`	`"repository": "https://github.com/shiftcode/sc-ng-commons-public",`
`5`	`5`	`"license": "MIT",`
`6`	`6`	`"author": "shiftcode GmbH <[email protected]>",`
`@@ -25,7 +25,7 @@`
`25`	`25`	`"@angular/forms": "^20.0.0",`
`26`	`26`	`"@angular/router": "^20.0.0",`
`27`	`27`	`"@shiftcode/logger": "^3.0.0",`
`28`		`- "@shiftcode/ngx-core": "^11.0.0 \|\| ^11.0.0-pr50",`
	`28`	`+ "@shiftcode/ngx-core": "^12.0.0 \|\| ^12.0.0-pr56",`
`29`	`29`	`"rxjs": "^6.5.3 \|\| ^7.4.0"`
`30`	`30`	`}`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@shiftcode/ngx-core",`
`3`		`- "version": "11.1.0",`
	`3`	`+ "version": "12.0.0-pr56.4",`
`4`	`4`	`"repository": "https://github.com/shiftcode/sc-ng-commons-public",`
`5`	`5`	`"license": "MIT",`
`6`	`6`	`"author": "shiftcode GmbH <[email protected]>",`