nestjs-fox-logger 0.0.3 → 0.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nestjs-fox-logger",
-  "version": "0.0.3",
+  "version": "0.1.0",
   "description": "Модуль логгера для Nestj.js",
   "author": "Semen Kononets <sploit.strannik@gmail.com, s.d.kononets@foxford.ru>",
   "license": "MIT",
@@ -34,10 +34,10 @@
     "url": "https://github.com/triple-sun/nests-fox-logger/issues"
   },
   "dependencies": {
-    "@nestjs/common": "^10.0.0",
-    "@nestjs/config": "^3.2.3",
-    "jest-mock-extended": "^4.0.0",
-    "nestjs-cls": "^6.0.1",
+    "@nestjs/common": "10.0.0",
+    "@nestjs/config": "3.2.3",
+    "jest-mock-extended": "4.0.0",
+    "nestjs-cls": "6.0.1",
     "rxjs": "^7.8.2"
   },
   "devDependencies": {

package/src/fox-logger.interfaces.ts

@@ -1,8 +1,13 @@
 import { ModuleMetadata, Provider, Type } from '@nestjs/common';
+import { ClsService } from 'nestjs-cls';
 
 export interface FoxLoggerServiceOptions {
+  timestamp?: boolean; // for compatibility
+
   name?: string;
-  timestamp?: boolean;
+  cls?: ClsService;
+  formatter?: (msg: unknown) => string;
+  prefixer?: (...args: unknown[]) => string;
 }
 
 export interface FoxLoggerServiceFeatureOptions

package/src/fox-logger.service.spec.ts

@@ -16,8 +16,9 @@ describe('FoxLoggerService', () => {
         ClsModule.forRoot({
           global: true,
         }),
-        FoxLoggerModule.forFeature({
-          name: 'TEST',
+        FoxLoggerModule.forFeatureAsync({
+          useFactory: (cls: ClsService) => ({ name: 'TEST', cls }),
+          inject: [ClsService],
         }),
       ],
       providers: [FoxLoggerService, ClsService],

package/src/fox-logger.service.ts

@@ -8,20 +8,45 @@ import { FoxLoggerServiceOptions } from './fox-logger.interfaces';
 export class FoxLoggerService extends Logger {
   private readonly $name?: string;
 
+  private readonly cls?: ClsService;
+  private readonly formatter: (msg: unknown) => string;
+  private readonly prefixer: (eventId: string, ...args: unknown[]) => string;
+
   constructor(
     @Inject(FOXLOGGER_SERVICE_OPTIONS)
     readonly options: FoxLoggerServiceOptions,
-    private readonly cls?: ClsService,
   ) {
     super();
     this.$name = options.name;
+    this.cls = options.cls;
+    this.formatter = options.formatter || this.defaultFormatter;
+    this.prefixer = options.prefixer || this.defaultPrefixer;
+  }
+
+  public log(msg: unknown, eventId?: string) {
+    return Logger.log(`${this.prefixer(eventId)}: ${this.formatter(msg)}`);
+  }
+  public warn(msg: unknown, eventId?: string) {
+    return Logger.warn(`${this.prefixer(eventId)}: ${this.formatter(msg)}`);
+  }
+  public debug(msg: unknown, eventId?: string) {
+    return Logger.debug(`${this.prefixer(eventId)}: ${this.formatter(msg)}`);
+  }
+  public error(msg: unknown, eventId?: string) {
+    return Logger.error(`${this.prefixer(eventId)}: ${this.formatter(msg)}`);
+  }
+  public verbose(msg: unknown, eventId?: string) {
+    return Logger.verbose(`${this.prefixer(eventId)}: ${this.formatter(msg)}`);
+  }
+  public fatal(msg: unknown, eventId?: string) {
+    return Logger.fatal(`${this.prefixer(eventId)}: ${this.formatter(msg)}`);
   }
 
   /**
    * Вынимаем данные из разных объектов ошибок
    * и не только, со статусом и пр.
    */
-  static FormatObjectMessage(msg: object) {
+  private defaultFormatObjectMsg(msg: object) {
     const prefix = [
       'statusCode' in msg && `[${msg.statusCode}]`,
       'status' in msg && `[${msg.status}]`,
@@ -42,56 +67,25 @@ export class FoxLoggerService extends Logger {
   }
 
   /** Получение сообщения из разных видов данных  */
-  static FormatMessage(msg: unknown) {
+  private defaultFormatter(msg: unknown) {
     /** делаем сообщение из разных типов данных */
     switch (typeof msg) {
       case 'object':
         if (Array.isArray(msg)) {
-          return msg.map(this.FormatObjectMessage).join(`\n`);
+          return msg.map(this.defaultFormatObjectMsg).join(`\n`);
         }
-        return this.FormatObjectMessage(msg);
+        return this.defaultFormatObjectMsg(msg);
       default:
         return String(msg);
     }
   }
 
   /** Задаем префикс на базе имени, cls и возможного id */
-  private getPrefix(eventId?: string) {
+  public defaultPrefixer(eventId?: string) {
     return (
       `${this.$name ? `[${this.$name}]` : ``}` +
-      `${this.cls.getId() ? `[${this.cls.getId()}]` : ''}` +
+      `${this.cls?.getId() ? `[${this.cls?.getId()}]` : ''}` +
       `${eventId ? `[${eventId}]` : ``}`
     );
   }
-
-  public log(msg: any, eventId?: string) {
-    return Logger.log(
-      `${this.getPrefix(eventId)}: ${FoxLoggerService.FormatMessage(msg)}`,
-    );
-  }
-  public warn(msg: any, eventId?: string) {
-    return Logger.warn(
-      `${this.getPrefix(eventId)}: ${FoxLoggerService.FormatMessage(msg)}`,
-    );
-  }
-  public debug(msg: any, eventId?: string) {
-    return Logger.debug(
-      `${this.getPrefix(eventId)}: ${FoxLoggerService.FormatMessage(msg)}`,
-    );
-  }
-  public error(msg: any, eventId?: string) {
-    return Logger.error(
-      `${this.getPrefix(eventId)}: ${FoxLoggerService.FormatMessage(msg)}`,
-    );
-  }
-  public verbose(msg: any, eventId?: string) {
-    return Logger.verbose(
-      `${this.getPrefix(eventId)}: ${FoxLoggerService.FormatMessage(msg)}`,
-    );
-  }
-  public fatal(msg: any, eventId?: string) {
-    return Logger.fatal(
-      `${this.getPrefix(eventId)}: ${FoxLoggerService.FormatMessage(msg)}`,
-    );
-  }
 }