refactor(logger): move everything to the logger class and document methods

Author: ADRFranklin

pkg/api/src/loaders/logger.ts

@@ -6,90 +6,137 @@ import PinoPretty from 'pino-pretty';
 
 import pathsConfig from '@/config/env/paths';
 
-const logsFolder = path.join(pathsConfig.dataDir, './logs');
-
-function createLogger(level: string): PinoLogger<string> {
-  return pino(
-    {
-      level,
-    },
-    pino.multistream([
-      {
-        level,
-        stream: PinoPretty({
-          translateTime: 'SYS:standard',
-          ignore: 'pid,hostname',
-          singleLine: true,
-          sync: true,
-        }),
-      },
-      {
-        level,
-        stream: FileStreamRotator.getStream({
-          filename: path.join(logsFolder, 'petio-%DATE%.log'),
-          frequency: 'daily',
-          verbose: false,
-          create_symlink: true,
-          audit_file: path.join(logsFolder, 'audit.json'),
-          date_format: 'YYYY-MM-DD',
-          max_logs: '7d',
-        }),
-      },
-    ]),
-  );
-}
-
+/**
+ * The Logger class provides logging functionality for the application.
+ */
 export class Logger {
   private static instance: Logger;
 
   private logger: PinoLogger;
 
-  private children: pino.Logger<string>[] = [];
-
   private constructor() {
     const level = process.env.LOG_LEVEL || 'info';
-    this.logger = createLogger(
+    this.logger = this.createLogger(
       process.env.NODE_ENV === 'development' ? 'debug' : level,
     );
   }
 
+  /**
+   * Creates a new instance of the logger with the specified log level.
+   * @param level - The log level to use.
+   * @returns The created logger instance.
+   */
+  private createLogger(level: string): PinoLogger<string> {
+    const logsFolder = path.join(pathsConfig.dataDir, './logs');
+    return pino(
+      {
+        level,
+      },
+      pino.multistream([
+        {
+          level,
+          stream: PinoPretty({
+            translateTime: 'SYS:standard',
+            ignore: 'pid,hostname',
+            singleLine: true,
+            sync: true,
+          }),
+        },
+        {
+          level,
+          stream: FileStreamRotator.getStream({
+            filename: path.join(logsFolder, 'petio-%DATE%.log'),
+            frequency: 'daily',
+            verbose: false,
+            create_symlink: true,
+            audit_file: path.join(logsFolder, 'audit.json'),
+            date_format: 'YYYY-MM-DD',
+            max_logs: '7d',
+          }),
+        },
+      ]),
+    );
+  }
+
+  /**
+   * Gets the singleton instance of the Logger class.
+   * @returns The Logger instance.
+   */
   public static getInstance(): Logger {
     if (!Logger.instance) {
       Logger.instance = new Logger();
     }
     return Logger.instance;
   }
 
+  /**
+   * Logs an info message.
+   * @param message - The message to log.
+   * @param obj - Additional data to log.
+   */
   public info(message: string, obj = {}) {
     this.logger.info(obj, message);
   }
 
+  /**
+   * Logs a warning message.
+   * @param message - The message to log.
+   * @param obj - Additional data to log.
+   */
   public warn(message: string, obj = {}) {
     this.logger.warn(obj, message);
   }
 
+  /**
+   * Logs an error message.
+   * @param message - The message to log.
+   * @param obj - Additional data to log.
+   */
   public error(message: string, obj = {}) {
     this.logger.error(obj, message);
   }
 
+  /**
+   * Logs a debug message.
+   * @param message - The message to log.
+   * @param obj - Additional data to log.
+   */
   public debug(message: string, obj = {}) {
     this.logger.debug(obj, message);
   }
 
+  /**
+   * Logs a trace message.
+   * @param message - The message to log.
+   * @param obj - Additional data to log.
+   */
   public trace(message: string, obj = {}) {
     this.logger.trace(obj, message);
   }
 
+  /**
+   * Logs a message with the specified log level.
+   * @param level - The log level to use.
+   * @param message - The message to log.
+   * @param obj - Additional data to log.
+   */
   public log(level: string, message: string, obj = {}) {
     this.logger[level](obj, message);
   }
 
+  /**
+   * Creates a child logger with additional properties.
+   * @param obj - The additional properties for the child logger.
+   * @returns The child logger instance.
+   */
   public child(obj: object) {
-    const child = this.logger.child<string>(obj);
-    this.children.push(child);
-    return child;
+    return this.logger.child<string>(obj);
   }
 
+  /**
+   * Gets the underlying logger instance.
+   * @returns The underlying logger instance.
+   */
   public core() {
     return this.logger;
   }