Replace Logger with CommonLogger

UPGRADING.md

@@ -1,5 +1,18 @@
 # Upgrading Guide
 
+## Upgrading from `17.0.0` to `18.0.0`
+
+### Description of Breaking Changes
+- `logger` injectable dependency interface was replaced by `CommonLogger` from `@lokalise/node-core` package, It is compatible with on `pino` logger (https://github.com/pinojs/pino)
+
+### Migration steps
+- If you are using `pino` logger, or any other logger compatible with `CommonLogger` interface, you don't need to do anything
+- Otherwise, there are serveral properties that need to be provided compared to the old interface:
+  - `level` - string defining configured minimal logging level
+  - `isLevelEnabled` - utility method for determining if a given log level will write to the destination.
+  - `child` - method for generating child logger instance with predefined properties
+  - `silent` - method used for logging when `silent` level is selected
+
 ## Upgrading from `12.0.0` to `13.0.0`
 
 ### Description of Breaking Change

packages/amqp/lib/AmqpConnectionManager.ts

@@ -1,6 +1,6 @@
-import type { Logger } from '@message-queue-toolkit/core'
 import type { Connection } from 'amqplib'
 
+import type { CommonLogger } from '@lokalise/node-core'
 import type { AmqpConfig } from './amqpConnectionResolver'
 import { resolveAmqpConnection } from './amqpConnectionResolver'
 
@@ -11,14 +11,14 @@ export type ConnectionReceiver = {
 
 export class AmqpConnectionManager {
   private readonly config: AmqpConfig
-  private readonly logger: Logger
+  private readonly logger: CommonLogger
   private readonly connectionReceivers: ConnectionReceiver[]
   private connection?: Connection
   public reconnectsActive: boolean
 
   public isReconnecting: boolean
 
-  constructor(config: AmqpConfig, logger: Logger) {
+  constructor(config: AmqpConfig, logger: CommonLogger) {
     this.config = config
     this.connectionReceivers = []
     this.reconnectsActive = true

packages/amqp/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@message-queue-toolkit/amqp",
-  "version": "16.2.0",
+  "version": "17.0.0",
   "private": false,
   "license": "MIT",
   "description": "AMQP adapter for message-queue-toolkit",

packages/amqp/test/fakes/FakeLogger.ts

@@ -1,10 +1,15 @@
-import { deepClone } from '@lokalise/node-core'
-import type { Logger } from '@message-queue-toolkit/core'
+import { type CommonLogger, deepClone } from '@lokalise/node-core'
+import type { Bindings, ChildLoggerOptions } from 'pino'
+import type pino from 'pino'
 
-export class FakeLogger implements Logger {
+export class FakeLogger implements CommonLogger {
   public readonly loggedMessages: unknown[] = []
-  public readonly loggedWarnings: unknown[] = []
-  public readonly loggedErrors: unknown[] = []
+
+  public level: pino.LevelWithSilentOrString
+
+  constructor(level: pino.LevelWithSilentOrString = 'debug') {
+    this.level = level
+  }
 
   debug(obj: unknown) {
     this.saveLog(obj)
@@ -24,6 +29,19 @@ export class FakeLogger implements Logger {
   warn(obj: unknown) {
     this.saveLog(obj)
   }
+  silent(_obj: unknown) {
+    return
+  }
+
+  // Child has no effect for FakeLogger
+  child(_bindings: Bindings, options?: ChildLoggerOptions): CommonLogger {
+    return new FakeLogger(options?.level)
+  }
+
+  isLevelEnabled(_: pino.LevelWithSilentOrString): boolean {
+    // For FakeLogger we want to track all logs
+    return true
+  }
 
   private saveLog(obj: unknown) {
     this.loggedMessages.push(typeof obj === 'object' ? deepClone(obj) : obj)

packages/amqp/test/utils/testContext.ts

@@ -1,5 +1,5 @@
-import type { ErrorReporter, ErrorResolver } from '@lokalise/node-core'
-import type { Logger, TransactionObservabilityManager } from '@message-queue-toolkit/core'
+import type { CommonLogger, ErrorReporter, ErrorResolver } from '@lokalise/node-core'
+import type { TransactionObservabilityManager } from '@message-queue-toolkit/core'
 import {
   CommonMetadataFiller,
   EventRegistry,
@@ -81,7 +81,7 @@ export type TestEventsType = (typeof TestEvents)[keyof typeof TestEvents][]
 export type TestEventPublishPayloadsType = z.infer<TestEventsType[number]['publisherSchema']>
 
 // @ts-ignore
-const TestLogger: Logger = console
+const TestLogger: CommonLogger = console
 
 export async function registerDependencies(
   config: AmqpConfig,
@@ -202,7 +202,7 @@ export async function registerDependencies(
 type DiConfig = NameAndRegistrationPair<Dependencies>
 
 export interface Dependencies {
-  logger: Logger
+  logger: CommonLogger
   amqpConnectionManager: AmqpConnectionManager
   awilixManager: AwilixManager
 

packages/core/index.ts

@@ -3,8 +3,6 @@ export type {
   AsyncPublisher,
   SyncPublisher,
   TransactionObservabilityManager,
-  Logger,
-  LogFn,
   SchemaMap,
   ExtraParams,
 } from './lib/types/MessageQueueTypes'

packages/core/lib/events/DomainEventEmitter.ts

@@ -1,4 +1,5 @@
 import {
+  type CommonLogger,
   type ErrorReporter,
   InternalError,
   type TransactionObservabilityManager,
@@ -11,7 +12,6 @@ import { resolveHandlerSpy } from '../queues/HandlerSpy'
 
 import { randomUUID } from 'node:crypto'
 import type { ConsumerMessageMetadataType } from '@message-queue-toolkit/schemas'
-import type { Logger } from '../types/MessageQueueTypes'
 import type { EventRegistry } from './EventRegistry'
 import type {
   AnyEventHandler,
@@ -26,7 +26,7 @@ import type {
 export type DomainEventEmitterDependencies<SupportedEvents extends CommonEventDefinition[]> = {
   eventRegistry: EventRegistry<SupportedEvents>
   metadataFiller: MetadataFiller
-  logger: Logger
+  logger: CommonLogger
   errorReporter?: ErrorReporter
   transactionObservabilityManager?: TransactionObservabilityManager
 }
@@ -39,7 +39,7 @@ type Handlers<T> = {
 export class DomainEventEmitter<SupportedEvents extends CommonEventDefinition[]> {
   private readonly eventRegistry: EventRegistry<SupportedEvents>
   private readonly metadataFiller: MetadataFiller
-  private readonly logger: Logger
+  private readonly logger: CommonLogger
   private readonly errorReporter?: ErrorReporter
   private readonly transactionObservabilityManager?: TransactionObservabilityManager
   private readonly _handlerSpy?: HandlerSpy<

packages/core/lib/queues/AbstractQueueService.ts

@@ -1,6 +1,6 @@
 import { types } from 'node:util'
 
-import type { Either, ErrorReporter, ErrorResolver } from '@lokalise/node-core'
+import type { CommonLogger, Either, ErrorReporter, ErrorResolver } from '@lokalise/node-core'
 import { resolveGlobalErrorLogObject } from '@lokalise/node-core'
 import type { CommonEventDefinition } from '@message-queue-toolkit/schemas'
 import type { ZodSchema, ZodType } from 'zod'
@@ -11,7 +11,7 @@ import { OFFLOADED_PAYLOAD_POINTER_PAYLOAD_SCHEMA } from '../payload-store/offlo
 import type { OffloadedPayloadPointerPayload } from '../payload-store/offloadedPayloadMessageSchemas'
 import type { PayloadStoreConfig } from '../payload-store/payloadStoreTypes'
 import { isDestroyable } from '../payload-store/payloadStoreTypes'
-import type { Logger, MessageProcessingResult } from '../types/MessageQueueTypes'
+import type { MessageProcessingResult } from '../types/MessageQueueTypes'
 import type { DeletionConfig, QueueDependencies, QueueOptions } from '../types/queueOptionsTypes'
 import { isRetryDateExceeded } from '../utils/dateUtils'
 import { streamWithKnownSizeToString } from '../utils/streamUtils'
@@ -69,7 +69,7 @@ export abstract class AbstractQueueService<
   protected readonly messageTimestampField: string
 
   protected readonly errorReporter: ErrorReporter
-  public readonly logger: Logger
+  public readonly logger: CommonLogger
   protected readonly messageIdField: string
   protected readonly messageTypeField: string
   protected readonly logMessages: boolean

packages/core/lib/types/MessageQueueTypes.ts

@@ -1,4 +1,4 @@
-import type { TransactionObservabilityManager } from '@lokalise/node-core'
+import type { CommonLogger, TransactionObservabilityManager } from '@lokalise/node-core'
 import type { ZodSchema } from 'zod'
 
 import type { PublicHandlerSpy } from '../queues/HandlerSpy'
@@ -27,26 +27,8 @@ export interface AsyncPublisher<MessagePayloadType extends object, MessageOption
 
 export type { TransactionObservabilityManager }
 
-export type LogFn = {
-  // biome-ignore lint/suspicious/noExplicitAny: This is expected
-  <T extends object>(obj: T, msg?: string, ...args: any[]): void
-  // biome-ignore lint/suspicious/noExplicitAny: This is expected
-  (obj: unknown, msg?: string, ...args: any[]): void
-  // biome-ignore lint/suspicious/noExplicitAny: This is expected
-  (msg: string, ...args: any[]): void
-}
-
 export type ExtraParams = {
-  logger?: Logger
-}
-
-export type Logger = {
-  error: LogFn
-  info: LogFn
-  warn: LogFn
-  debug: LogFn
-  trace: LogFn
-  fatal: LogFn
+  logger?: CommonLogger
 }
 
 export type SchemaMap<SupportedMessageTypes extends string> = Record<

packages/core/lib/types/queueOptionsTypes.ts

@@ -1,15 +1,15 @@
-import type { ErrorReporter, ErrorResolver } from '@lokalise/node-core'
+import type { CommonLogger, ErrorReporter, ErrorResolver } from '@lokalise/node-core'
 import type { ZodSchema } from 'zod'
 
 import type { PayloadStoreConfig } from '../payload-store/payloadStoreTypes'
 import type { MessageHandlerConfig } from '../queues/HandlerContainer'
 import type { HandlerSpy, HandlerSpyParams } from '../queues/HandlerSpy'
 
-import type { Logger, TransactionObservabilityManager } from './MessageQueueTypes'
+import type { TransactionObservabilityManager } from './MessageQueueTypes'
 
 export type QueueDependencies = {
   errorReporter: ErrorReporter
-  logger: Logger
+  logger: CommonLogger
 }
 
 export type QueueConsumerDependencies = {

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@message-queue-toolkit/core",
-  "version": "17.2.1",
+  "version": "18.0.0",
   "private": false,
   "license": "MIT",
   "description": "Useful utilities, interfaces and base classes for message queue handling. Supports AMQP and SQS with a common abstraction on top currently",

packages/core/test/testContext.ts

@@ -1,8 +1,7 @@
-import type { ErrorReporter } from '@lokalise/node-core'
+import type { CommonLogger, ErrorReporter } from '@lokalise/node-core'
 import { type Resolver, asClass } from 'awilix'
 import { Lifetime, asFunction, createContainer } from 'awilix'
 import { AwilixManager } from 'awilix-manager'
-import type { Logger } from 'pino'
 import pino from 'pino'
 import { z } from 'zod'
 
@@ -19,7 +18,7 @@ export const SINGLETON_CONFIG = { lifetime: Lifetime.SINGLETON }
 
 export type DependencyOverrides = Partial<DiConfig>
 
-const TestLogger: Logger = pino()
+const TestLogger: CommonLogger = pino()
 
 export const TestEvents = {
   created: {
@@ -100,7 +99,7 @@ export async function registerDependencies(dependencyOverrides: DependencyOverri
 type DiConfig = Record<keyof Dependencies, Resolver<any>>
 
 export interface Dependencies {
-  logger: Logger
+  logger: CommonLogger
   awilixManager: AwilixManager
 
   // vendor-specific dependencies

packages/sns/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@message-queue-toolkit/sns",
-  "version": "18.0.1",
+  "version": "19.0.0",
   "private": false,
   "license": "MIT",
   "description": "SNS adapter for message-queue-toolkit",

packages/sns/test/fakes/FakeLogger.ts

@@ -1,10 +1,18 @@
-import type { Logger } from '@message-queue-toolkit/core'
+import type { CommonLogger } from '@lokalise/node-core'
+import type { Bindings, ChildLoggerOptions } from 'pino'
+import type pino from 'pino'
 
-export class FakeLogger implements Logger {
+export class FakeLogger implements CommonLogger {
   public readonly loggedMessages: unknown[] = []
   public readonly loggedWarnings: unknown[] = []
   public readonly loggedErrors: unknown[] = []
 
+  public readonly level: pino.LevelWithSilentOrString
+
+  constructor(level: pino.LevelWithSilentOrString = 'debug') {
+    this.level = level
+  }
+
   debug(obj: unknown) {
     this.loggedMessages.push(obj)
   }
@@ -23,4 +31,18 @@ export class FakeLogger implements Logger {
   warn(obj: unknown) {
     this.loggedWarnings.push(obj)
   }
+  // Noop function
+  silent(_obj: unknown) {
+    return
+  }
+
+  // Child has no effect for FakeLogger
+  child(_bindings: Bindings, options?: ChildLoggerOptions): CommonLogger {
+    return new FakeLogger(options?.level)
+  }
+
+  isLevelEnabled(_level: string): boolean {
+    // For FakeLogger we want to track all logs
+    return true
+  }
 }

packages/sns/test/utils/testContext.ts

@@ -1,8 +1,8 @@
 import { S3 } from '@aws-sdk/client-s3'
 import { SNSClient } from '@aws-sdk/client-sns'
 import { SQSClient } from '@aws-sdk/client-sqs'
-import type { ErrorReporter, ErrorResolver } from '@lokalise/node-core'
-import type { Logger, TransactionObservabilityManager } from '@message-queue-toolkit/core'
+import type { CommonLogger, ErrorReporter, ErrorResolver } from '@lokalise/node-core'
+import type { TransactionObservabilityManager } from '@message-queue-toolkit/core'
 import {
   CommonMetadataFiller,
   EventRegistry,
@@ -30,7 +30,7 @@ export const SINGLETON_CONFIG = { lifetime: Lifetime.SINGLETON }
 export type DependencyOverrides = Partial<DiConfig>
 
 // @ts-ignore
-const TestLogger: Logger = console
+const TestLogger: CommonLogger = console
 
 export const TestEvents = {
   created: {
@@ -188,7 +188,7 @@ export async function registerDependencies(
 type DiConfig = Record<keyof Dependencies, Resolver<any>>
 
 export interface Dependencies {
-  logger: Logger
+  logger: CommonLogger
   sqsClient: SQSClient
   snsClient: SNSClient
   stsClient: STSClient

packages/sqs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@message-queue-toolkit/sqs",
-  "version": "17.2.0",
+  "version": "18.0.0",
   "private": false,
   "license": "MIT",
   "description": "SQS adapter for message-queue-toolkit",