Skip to content

refactor: Unbind Logger from NodeJS module object (by type) #3283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mondoreale merged 2 commits into from
Dec 10, 2025
Merged

refactor: Unbind Logger from NodeJS module object (by type) #3283

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a75d24
Unbind `Logger` from `module` type
mondoreale Dec 10, 2025
ba0369c
`Scope` → `LoggerModule`
mondoreale Dec 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions packages/utils/src/Logger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ function wrappedMethodCall(
}
}

type LoggerModule = string | { id: string }

export class Logger {
static NAME_LENGTH = 25

Expand All @@ -84,13 +86,13 @@ export class Logger {
trace: (msg: string, metadata?: Record<string, unknown>) => void

constructor(
module: NodeJS.Module,
loggerModule: LoggerModule,
contextBindings?: Record<string, unknown>,
defaultLogLevel: LogLevel = 'info',
parentLogger: pino.Logger = rootLogger
) {
this.logger = parentLogger.child({
name: Logger.createName(module),
name: Logger.createName(loggerModule),
...contextBindings
}, {
level: process.env.LOG_LEVEL ?? defaultLogLevel
Expand All @@ -103,8 +105,9 @@ export class Logger {
this.trace = wrappedMethodCall(this.logger.trace.bind(this.logger))
}

static createName(module: NodeJS.Module): string {
const parsedPath = path.parse(String(module.id))
static createName(loggerModule: LoggerModule): string {
const loggerModuleId = typeof loggerModule === 'string' ? loggerModule : loggerModule.id
const parsedPath = path.parse(loggerModuleId)
let fileId = parsedPath.name
if (fileId === 'index') {
// file with name "foobar/index.ts" -> "foobar"
Expand Down