Merge pull request #80 from shiftcode/#79-nest-logger

Nest logger doesn’t log unhandled errors properly

Author: dario-fazio

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@shiftcode/nest-logger",
-  "version": "1.0.0",
+  "version": "1.0.1-pr79.2",
   "description": "NestJS support for the logger package",
   "repository": "https://github.com/shiftcode/sc-commons-public",
   "license": "MIT",

packages/nest-logger/package.json

@@ -0,0 +1,47 @@
+import { Logger, LogLevel } from '@shiftcode/logger'
+import { beforeEach, describe, expect, test } from 'vitest'
+
+import { MockLogTransport } from '../../test/mock-log.transport.js'
+import { NestLogger } from './nest-logger.js'
+
+describe('NestLogger', () => {
+  let transport: MockLogTransport
+  let logger: Logger
+  let nestLogger: NestLogger
+
+  beforeEach(() => {
+    transport = new MockLogTransport({ logLevel: LogLevel.DEBUG, mockAttribute: 'test' })
+    logger = new Logger('TestLogger', '#ffffff', [transport])
+    nestLogger = new NestLogger(logger)
+  })
+
+  test('error(message, trace, context) forwards args as flat array, not nested', () => {
+    nestLogger.error('msg', 'trace', 'ctx')
+    expect(transport.logArgs?.args).toEqual(['msg', 'trace', 'ctx'])
+  })
+
+  test('warn(message, context) forwards args as flat array', () => {
+    nestLogger.warn('msg', 'ctx')
+    expect(transport.logArgs?.args).toEqual(['msg', 'ctx'])
+  })
+
+  test('log(message, context) forwards args as flat array', () => {
+    nestLogger.log('msg', 'ctx')
+    expect(transport.logArgs?.args).toEqual(['msg', 'ctx'])
+  })
+
+  test('debug(message, context) forwards args as flat array', () => {
+    nestLogger.debug('msg', 'ctx')
+    expect(transport.logArgs?.args).toEqual(['msg', 'ctx'])
+  })
+
+  test('verbose(message, context) forwards args as flat array', () => {
+    nestLogger.verbose('msg', 'ctx')
+    expect(transport.logArgs?.args).toEqual(['msg', 'ctx'])
+  })
+
+  test('error with only a message forwards a single-element args array', () => {
+    nestLogger.error('only message')
+    expect(transport.logArgs?.args).toEqual(['only message'])
+  })
+})

packages/nest-logger/src/model/nest-logger.spec.ts

@@ -8,23 +8,23 @@ import { Logger } from '@shiftcode/logger'
 export class NestLogger implements LoggerService {
   constructor(private readonly logger: Logger) {}
 
-  error(message: any, trace?: string) {
-    this.logger.error([message, trace])
+  error(message: any, ...optionalParams: any[]) {
+    this.logger.error(message, ...optionalParams)
   }
 
-  warn(message: any) {
-    this.logger.warn([message])
+  warn(message: any, ...optionalParams: any[]) {
+    this.logger.warn(message, ...optionalParams)
   }
 
-  debug(message: any) {
-    this.logger.debug([message])
+  debug(message: any, ...optionalParams: any[]) {
+    this.logger.debug(message, ...optionalParams)
   }
 
-  verbose(message: any) {
-    this.debug(message)
+  verbose(message: any, ...optionalParams: any[]) {
+    this.debug(message, ...optionalParams)
   }
 
-  log(message: any) {
-    this.logger.info([message])
+  log(message: any, ...optionalParams: any[]) {
+    this.logger.info(message, ...optionalParams)
   }
 }

packages/nest-logger/src/model/nest-logger.ts

@@ -5,8 +5,16 @@ export interface MockLogTransportConfig {
   mockAttribute: string
 }
 
+export interface MockLogArgs {
+  level: LogLevel
+  clazzName: string
+  hexColor: string
+  timestamp: Date
+  args: unknown[]
+}
+
 export class MockLogTransport extends LogTransport {
-  logArgs: any
+  logArgs: MockLogArgs | undefined
 
   constructor(config: MockLogTransportConfig) {
     super(config.logLevel)