feat: add logger dynamic change info method (#897)

Co-authored-by: waiting <1661926154@qq.com>
midwayjs · Mar 12, 2021 · 5a11374 · 5a11374
1 parent 4640674
commit 5a11374
Show file tree

Hide file tree

Showing 4 changed files with 60 additions and 3 deletions.
diff --git a/package.json b/package.json
@@ -24,7 +24,7 @@
     "beta": "sh scripts/publish.sh --npm-tag beta --force-publish=*",
     "next": "sh scripts/publish.sh --npm-tag next",
     "release": "rm -f ./packages/.DS* && sh scripts/publish.sh",
-    "bootstrap": "rm -f ./packages/.DS* && lerna bootstrap",
+    "bootstrap": "rm -f ./packages/.DS* && lerna bootstrap --concurrency 4",
     "clean": "lerna clean --yes && rm -rf ./packages/**/package-lock.json && rm -f package-lock.json",
     "build": "sh scripts/build.sh",
     "authors": "git log --format='%aN <%aE>' | sort -u > AUTHORS",

diff --git a/packages/logger/src/interface.ts b/packages/logger/src/interface.ts
@@ -7,6 +7,11 @@ export interface ILogger {
   warn(msg: any, ...args: any[]): void;
 }
 
+
+export type LoggerCustomInfoHandler = (
+  info: MidwayTransformableInfo
+) => MidwayTransformableInfo;
+
 export interface IMidwayLogger extends ILogger {
   disableConsole();
   enableConsole();
@@ -22,6 +27,7 @@ export interface IMidwayLogger extends ILogger {
   updateConsoleLevel(level: LoggerLevel): void;
   updateDefaultLabel(defaultLabel: string): void;
   updateDefaultMeta(defaultMeta: object): void;
+  updateTransformableInfo(customInfoHandler: LoggerCustomInfoHandler): void;
   getDefaultLabel(): string;
   getDefaultMeta(): Record<string, unknown>;
   write(...args): boolean;
@@ -58,3 +64,18 @@ export interface LoggerOptions {
 export interface DelegateLoggerOptions {
   delegateLogger: ILogger;
 }
+
+export interface MidwayTransformableInfo {
+  [key: string]: any;
+  level: string;
+  timestamp: string;
+  LEVEL: string;
+  pid: number;
+  labelText: string;
+  message: string;
+  ctx: any;
+  ignoreFormat: boolean;
+  defaultLabel: string;
+  originError?: Error;
+  stack?: string;
+}
diff --git a/packages/logger/src/logger.ts b/packages/logger/src/logger.ts
@@ -5,6 +5,8 @@ import {
   LoggerLevel,
   LoggerOptions,
   IMidwayLogger,
+  MidwayTransformableInfo,
+  LoggerCustomInfoHandler,
 } from './interface';
 import { DelegateTransport, EmptyTransport } from './transport';
 import { displayLabels, displayCommonMessage } from './format';
@@ -35,6 +37,9 @@ export class MidwayBaseLogger extends EmptyLogger implements IMidwayLogger {
   loggerOptions: LoggerOptions;
   defaultLabel = '';
   defaultMetadata = {};
+  customInfoHandler: LoggerCustomInfoHandler = info => {
+    return info;
+  };
 
   constructor(options: LoggerOptions = {}) {
     super(
@@ -197,10 +202,14 @@ export class MidwayBaseLogger extends EmptyLogger implements IMidwayLogger {
     this.defaultMetadata = defaultMetadata;
   }
 
+  updateTransformableInfo(customInfoHandler: LoggerCustomInfoHandler): void {
+    this.customInfoHandler = customInfoHandler;
+  }
+
   getDefaultLoggerConfigure() {
     const printInfo = this.loggerOptions.printFormat
       ? this.loggerOptions.printFormat
-      : info => {
+      : (info: MidwayTransformableInfo): string => {
           return `${info.timestamp} ${info.LEVEL} ${info.pid} ${info.labelText}${info.message}`;
         };
 
@@ -218,7 +227,10 @@ export class MidwayBaseLogger extends EmptyLogger implements IMidwayLogger {
           if (info.ignoreFormat) {
             return info.message;
           }
-          return printInfo(info);
+          const newInfo = this.customInfoHandler(
+            info as MidwayTransformableInfo
+          );
+          return printInfo(newInfo || info);
         })
       ),
     };

diff --git a/packages/logger/test/index.test.ts b/packages/logger/test/index.test.ts
@@ -622,4 +622,28 @@ describe('/test/index.test.ts', () => {
 
   });
 
+  it('should dynamic change info data', async  ()  => {
+    clearAllLoggers();
+    const logsDir = join(__dirname, 'logs');
+    await removeFileOrDir(logsDir);
+
+    const logger = createFileLogger('file', {
+      dir: logsDir,
+      fileLogName: 'test-logger.log',
+    });
+
+    (logger as IMidwayLogger).updateTransformableInfo(info => {
+      info.timestamp = 'bbbb';
+      return info
+    });
+    logger.info('file logger');
+    logger.info('file logger1');
+    logger.info('file logger2');
+    await sleep();
+
+    expect(matchContentTimes(join(logsDir, 'test-logger.log'), 'bbbb')).toEqual(3);
+
+    await removeFileOrDir(logsDir);
+  });
+
 });