Skip to content

♻️ refactor: improve logger to need initialization before usage #1

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
PFadel merged 1 commit into from
Feb 6, 2025
Merged

♻️ refactor: improve logger to need initialization before usage #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 16 additions & 4 deletions src/logger.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import type winston from 'winston';
import { createLogger, format, transports } from 'winston';
import { getHookCorrelationId } from './hooks';


type Severity = 'debug' | 'info' | 'http' | 'warn' | 'error';

export class WinstonLogger {
Expand Down Expand Up @@ -38,14 +37,27 @@ export class WinstonLogger {
}

export class Logger {
private static loggerInstance = WinstonLogger.getInstance();
private static loggerInstance: winston.Logger | undefined;

private constructor() { }

static initialize(serviceName: string) {
if (this.loggerInstance) return;
this.loggerInstance = WinstonLogger.getInstance(serviceName);
}

private static getLogger() {
if (!this.loggerInstance) throw new Error('Logger not initialized');
return this.loggerInstance;
}

static log(
private static log(
severity: Severity,
message: string,
meta?: Record<string, unknown>,
err?: unknown
) {
const logger = this.getLogger();
const errorMsg = err instanceof Error ? `Error: ${err.message}` : '';
const errObject = err instanceof Error ?
{
Expand All @@ -58,7 +70,7 @@ export class Logger {
const correlationId = getHookCorrelationId();
const logMessage = `${message}. ${errorMsg}`;
const metaObj = { ...meta, err: errObject, correlationId };
this.loggerInstance.log(severity, logMessage, metaObj);
logger.log(severity, logMessage, metaObj);
}

static debug(message: string, meta?: Record<string, unknown>, err?: unknown) {
Expand Down