refactor(logger): utility functions

Author: mumenthalers

packages/logger/package.json

@@ -13,12 +13,8 @@
       "default": "./dist/public-api.js"
     },
     "./node": {
-      "types": "./dist/node-api.d.ts",
-      "default": "./dist/node-api.js"
-    },
-    "./transports/node-console": {
-      "types": "./dist/transports/node-console-log-transport/public-api.d.ts",
-      "default": "./dist/transports/node-console-log-transport/public-api.js"
+      "types": "./dist/node/public-api.d.ts",
+      "default": "./dist/node/public-api.js"
     },
     "./testing": {
       "types": "./dist/testing/public-api.d.ts",

packages/logger/src/console-json-log-transport/console-json-log-transport-config.ts

@@ -14,6 +14,8 @@ export interface ConsoleJsonLogTransportConfig {
 
   /**
    * when true, the log output will be a JS object instead of a JSON string. {@jsonStringifyReplacer} is still used.
+   * enable this option, when your lambda function is configured with `loggingFormat='JSON'`
+   * @hint when loggingFormat='JSON' is set, you should also configure `applicationLogLevelV2` with `TRACE` - otherwise you won't see all logging output.
    */
   logJsObject?: boolean
 }

packages/logger/src/console-json-log-transport/console-json-log.transport.ts

@@ -19,10 +19,12 @@ export class ConsoleJsonLogTransport extends LogTransport {
   /** Ring buffer for log events below the configured level, flushed on ERROR */
   private pendingBuffer: BufferedLogMessage[] = []
 
+  private readonly logJsObject: boolean
   private readonly jsonStringifyReplacer: (key: string, value: any) => any
 
   constructor(config: ConsoleJsonLogTransportConfig) {
     super(config.logLevel)
+    this.logJsObject = config.logJsObject ?? false
     this.bufferSize = config.belowLevelLogBufferSize ?? ConsoleJsonLogTransport.DEFAULT_BUFFER_SIZE
     this.jsonStringifyReplacer = config.jsonStringifyReplacer ?? jsonMapSetStringifyReplacer
   }
@@ -38,6 +40,7 @@ export class ConsoleJsonLogTransport extends LogTransport {
     //   to cut any potential references to objects that could potentially change until the log is actually written.
     const message = JSON.stringify(logObject, getJsonStringifyReplacer(this.jsonStringifyReplacer))
 
+
     if (!this.isLevelEnabled(level)) {
       pushToRingBuffer(this.pendingBuffer, { level, message }, this.bufferSize)
       return
@@ -55,7 +58,7 @@ export class ConsoleJsonLogTransport extends LogTransport {
     this.logToConsole(level, message)
   }
 
-  protected logToConsole(level: LogLevel, toLog: unknown) {
+  protected logToConsole(level: LogLevel, toLog: string) {
     /* eslint-disable no-console */
     switch (level) {
       case LogLevel.DEBUG:

packages/logger/src/node-api.ts

@@ -1,25 +1,35 @@
 import { ConsoleJsonLogTransport } from '../console-json-log-transport/console-json-log.transport.js'
-import { LogLevel } from '../model/log-level.enum.js'
+import { ConsoleJsonLogTransportConfig } from '../console-json-log-transport/console-json-log-transport-config.js'
 import { LogTransport } from '../model/log-transport.js'
 import { Logger } from '../model/logger.js'
 import { BaseLoggerService } from '../services/base-logger.service.js'
 import { NodeConsoleLogTransport } from './node-console-log-transport/node-console-log.transport.js'
+import { NodeConsoleLogTransportConfig } from './node-console-log-transport/node-console-log-transport-config.js'
 
+type Config = {
+  node: NodeConsoleLogTransportConfig
+  json: ConsoleJsonLogTransportConfig
+}
 /**
  * Creates a simple {@link Logger} instance that logs to the console with the specified name and log level
 
  * @param name The name of the logger
  * @param logLevel decides the minimum log level to be logged
  * @param type decides whether to use {@link NodeConsoleLogTransport} or {@link ConsoleJsonLogTransport}
+ * @param config optional configuration for the selected transport
  */
-export function createConsoleLogger(name: string, logLevel: LogLevel, type: 'node' | 'json'): Logger {
+export function createConsoleLogger(
+  name: string,
+  config: Config,
+  type: 'node' | 'json',
+): Logger {
   let transport: LogTransport
   switch (type) {
     case 'node':
-      transport = new NodeConsoleLogTransport({ logLevel })
+      transport = new NodeConsoleLogTransport(config.node)
       break
     case 'json':
-      transport = new ConsoleJsonLogTransport({ logLevel })
+      transport = new ConsoleJsonLogTransport(config.json)
       break
     default:
       transport = type

packages/logger/src/node/create-console-logger.function.ts

@@ -6,7 +6,7 @@ import { LogLevel } from '../../model/log-level.enum.js'
 import { LogTransport } from '../../model/log-transport.js'
 import { NodeConsoleLogTransportConfig } from './node-console-log-transport-config.js'
 
-export const logLevelEmoji = ['🐞', '💬', '💣', '🔥']
+export const logLevelEmoji: Record<LogLevel, string> = ['🐞', '💬', '💣', '🔥', '']
 
 const timeFormat = new Intl.DateTimeFormat('en-US', {
   hour: '2-digit',

packages/logger/src/node/node-console-log-transport/node-console-log.transport.ts

@@ -0,0 +1,4 @@
+export * from './create-console-logger.function.js'
+export * from './node-console-log-transport/node-console-log.transport.js'
+export * from './node-console-log-transport/node-console-log-transport-config.js'
+export * from './simple-lambda-logger.function.js'

packages/logger/src/node/public-api.ts

@@ -10,5 +10,5 @@ function isAwsLambdaEnv(): boolean {
 
 export function simpleLambdaLogger(name: string, logLevel: LogLevel = LogLevel.DEBUG) {
   const isLambda = isAwsLambdaEnv()
-  return createConsoleLogger(name, logLevel, isLambda ? 'json' : 'node')
+  return createConsoleLogger(name, { json: { logLevel }, node: { logLevel } }, isLambda ? 'json' : 'node')
 }