feat: Unification framework logger (#4236)

* feat: use different framework logger * chore: update code * feat: use different framework logger * feat: use different framework logger * fix: web logger * fix: framework logger name * fix: socket case * fix: lint * chore: revert * chore: Use the standard logger
midwayjs · Dec 22, 2024 · 9632927 · 9632927
1 parent b504366
commit 9632927
Show file tree

Hide file tree

Showing 27 changed files with 506 additions and 850 deletions.
diff --git a/packages/bull/src/config/config.default.ts b/packages/bull/src/config/config.default.ts
@@ -8,17 +8,16 @@ export const bull = {
   },
   defaultConcurrency: 1,
   clearRepeatJobWhenStart: true,
-  contextLoggerApplyLogger: 'bullLogger',
-  contextLoggerFormat: info => {
-    const { jobId, from } = info.ctx;
-    return `${info.timestamp} ${info.LEVEL} ${info.pid} [${jobId} ${from.name}] ${info.message}`;
-  },
 };
 
 export const midwayLogger = {
   clients: {
     bullLogger: {
       fileLogName: 'midway-bull.log',
+      contextFormat: info => {
+        const { jobId, from } = info.ctx;
+        return `${info.timestamp} ${info.LEVEL} ${info.pid} [${jobId} ${from.name}] ${info.message}`;
+      },
     },
   },
 };
diff --git a/packages/bull/src/framework.ts b/packages/bull/src/framework.ts
@@ -5,8 +5,6 @@ import {
   Framework,
   Utils,
   MidwayInvokeForbiddenError,
-  ILogger,
-  Logger,
   DecoratorManager,
   MetadataManager,
 } from '@midwayjs/core';
@@ -44,9 +42,7 @@ export class BullFramework
   private bullDefaultConcurrency: number;
   private bullClearRepeatJobWhenStart: boolean;
   private queueMap: Map<string, BullQueue> = new Map();
-
-  @Logger('bullLogger')
-  protected bullLogger: ILogger;
+  protected frameworkLoggerName = 'bullLogger';
 
   async applicationInitialize(options: IMidwayBootstrapOptions) {
     this.app = {} as any;
@@ -119,7 +115,7 @@ export class BullFramework
     );
     this.queueMap.set(name, queue);
     queue.on('error', err => {
-      this.bullLogger.error(err);
+      this.logger.error(err);
     });
     return queue;
   }

diff --git a/packages/core/src/baseFramework.ts b/packages/core/src/baseFramework.ts
@@ -48,10 +48,8 @@ export abstract class BaseFramework<
   public app: APP;
   public configurationOptions: OPT;
   protected logger: ILogger;
-  protected appLogger: ILogger;
+  protected frameworkLoggerName = 'appLogger';
   protected defaultContext = {};
-  protected contextLoggerApplyLogger: string;
-  protected contextLoggerFormat: any;
   protected middlewareManager = this.createMiddlewareManager();
   protected filterManager = this.createFilterManager();
   protected guardManager = this.createGuardManager();
@@ -81,13 +79,9 @@ export abstract class BaseFramework<
   constructor(readonly applicationContext: IMidwayGlobalContainer) {}
 
   @Init()
-  async init() {
+  protected async init() {
     this.configurationOptions = this.configure() ?? ({} as OPT);
-    this.contextLoggerApplyLogger =
-      this.configurationOptions.contextLoggerApplyLogger ?? 'appLogger';
-    this.contextLoggerFormat = this.configurationOptions.contextLoggerFormat;
     this.logger = this.loggerService.getLogger('coreLogger');
-    this.appLogger = this.loggerService.getLogger('appLogger');
     return this;
   }
 
@@ -97,7 +91,7 @@ export abstract class BaseFramework<
   ): void | Promise<void>;
   public abstract run(): Promise<void>;
 
-  isEnable(): boolean {
+  public isEnable(): boolean {
     return true;
   }
 
@@ -133,7 +127,7 @@ export abstract class BaseFramework<
   }
 
   protected createContextLogger(ctx: CTX, name?: string): ILogger {
-    if (name && name !== 'appLogger') {
+    if (name && name !== this.frameworkLoggerName) {
       const appLogger = this.getLogger(name);
       let ctxLoggerCache = ctx.getAttr(REQUEST_CTX_LOGGER_CACHE_KEY) as Map<
         string,
@@ -153,14 +147,12 @@ export abstract class BaseFramework<
       ctxLoggerCache.set(name, ctxLogger);
       return ctxLogger;
     } else {
-      const appLogger = this.getLogger(name ?? this.contextLoggerApplyLogger);
       // avoid maximum call stack size exceeded
       if (ctx['_logger']) {
         return ctx['_logger'];
       }
-      ctx['_logger'] = this.loggerService.createContextLogger(ctx, appLogger, {
-        contextFormat: this.contextLoggerFormat,
-      });
+      const appLogger = this.getLogger(name);
+      ctx['_logger'] = this.loggerService.createContextLogger(ctx, appLogger);
       return ctx['_logger'];
     }
   }
@@ -377,7 +369,7 @@ export abstract class BaseFramework<
   }
 
   public getLogger(name?: string) {
-    return this.loggerService.getLogger(name) ?? this.appLogger;
+    return this.loggerService.getLogger(name ?? this.frameworkLoggerName);
   }
 
   public getCoreLogger() {
@@ -441,4 +433,12 @@ export abstract class BaseFramework<
   public getNamespace() {
     return this.namespace;
   }
+
+  /**
+   * Set the default framework logger name
+   * @since 4.0.0
+   */
+  public setFrameworkLoggerName(loggerName: string) {
+    this.frameworkLoggerName = loggerName;
+  }
 }
diff --git a/packages/core/src/interface.ts b/packages/core/src/interface.ts
@@ -1089,6 +1089,7 @@ export interface IMidwayFramework<
   useGuard(guard: CommonGuardUnion<CTX>): void;
   runGuard(ctx: CTX, supplierClz: new (...args) => any, methodName: string): Promise<boolean>;
   getNamespace(): string;
+  setFrameworkLoggerName(name: string): void;
 }
 
 export interface MidwayAppInfo {

diff --git a/packages/core/src/setup.ts b/packages/core/src/setup.ts
@@ -31,8 +31,9 @@ import {
 const debug = util.debuglog('midway:debug');
 
 let stepIdx = 1;
+let projectIdx = 1;
 function printStepDebugInfo(stepInfo: string) {
-  debug(`\n\nStep ${stepIdx++}: ${stepInfo}\n`);
+  debug(`\n\nProject ${projectIdx} - Step ${stepIdx++}: ${stepInfo}\n`);
 }
 
 /**
@@ -139,24 +140,33 @@ export async function initializeGlobalApplicationContext(
 export async function destroyGlobalApplicationContext(
   applicationContext: IMidwayGlobalContainer
 ) {
+  printStepDebugInfo('Ready to destroy applicationContext');
   const loggerService = await applicationContext.getAsync(MidwayLoggerService);
   const loggerFactory = loggerService.getCurrentLoggerFactory();
 
+  printStepDebugInfo('Stopping lifecycle');
   // stop lifecycle
   const lifecycleService = await applicationContext.getAsync(
     MidwayLifeCycleService
   );
   await lifecycleService.stop();
+
+  printStepDebugInfo('Stopping applicationContext');
   // stop container
   await applicationContext.stop();
+
+  printStepDebugInfo('Closing loggerFactory');
   loggerFactory.close();
+
+  printStepDebugInfo('Cleaning performance manager');
   MidwayPerformanceManager.cleanAll();
 
   global['MIDWAY_APPLICATION_CONTEXT'] = undefined;
   global['MIDWAY_MAIN_FRAMEWORK'] = undefined;
 
   // reset counter
   stepIdx = 1;
+  projectIdx++;
 }
 
 /**

diff --git a/packages/core/test/baseFramework.test.ts b/packages/core/test/baseFramework.test.ts
@@ -833,15 +833,14 @@ describe('/test/baseFramework.test.ts', () => {
         appDir,
         'src'
       ), {
-        custom: {
-          contextLoggerApplyLogger: 'customFrameworkLogger',
-          contextLoggerFormat: info => {
-            return `[custom ctx] ${info.message}`;
-          },
-        },
+        custom: {},
         midwayLogger: {
           clients: {
-            customFrameworkLogger: {},
+            customFrameworkLogger: {
+              contextFormat: info => {
+                return `[custom ctx] ${info.message}`;
+              },
+            },
             customLogger: {
               format: info => {
                 return `[new custom] ${info.message}`;
@@ -860,7 +859,7 @@ describe('/test/baseFramework.test.ts', () => {
       const mainFramework = midwayFrameworkService.getMainFramework();
       const ctx = mainFramework.getApplication().createAnonymousContext();
       expect(ctx.logger.info('hello world')).toEqual('[custom ctx] hello world');
-      expect(ctx.getLogger('appLogger').info('hello world')).toEqual('[custom ctx] hello world');
+      expect(ctx.getLogger('customFrameworkLogger').info('hello world')).toEqual('[custom ctx] hello world');
       expect(ctx.getLogger('customLogger').info('hello world')).toEqual('[new custom ctx] hello world');
       expect(mainFramework.getLogger('customLogger').info('hello world')).toEqual('[new custom] hello world');
     });

diff --git a/packages/core/test/fixtures/base-app-custom-framework-logger/src/framework.ts b/packages/core/test/fixtures/base-app-custom-framework-logger/src/framework.ts
@@ -2,6 +2,7 @@ import { BaseFramework, Framework, IMidwayBootstrapOptions } from '../../../../s
 
 @Framework()
 export class CustomFramework extends BaseFramework<any, any, any> {
+  frameworkLoggerName = 'customFrameworkLogger';
   async applicationInitialize(options: IMidwayBootstrapOptions) {
     this.app = {};
   }
@@ -11,7 +12,7 @@ export class CustomFramework extends BaseFramework<any, any, any> {
   }
 
   run(): Promise<void> {
-    this.app.getCoreLogger().info('run custom framework');
+    this.logger.info('run custom framework');
     return Promise.resolve(undefined);
   }
 }
diff --git a/packages/cron/src/configuration.ts b/packages/cron/src/configuration.ts
@@ -14,7 +14,6 @@ import { JobNameOrClz } from './interface';
       default: {
         cron: {
           defaultCronJobOptions: {},
-          contextLoggerApplyLogger: 'cronLogger',
         },
         midwayLogger: {
           clients: {

diff --git a/packages/cron/src/framework.ts b/packages/cron/src/framework.ts
@@ -22,6 +22,7 @@ import { CRON_JOB_KEY } from './constants';
 export class CronFramework extends BaseFramework<Application, Context, any> {
   private defaultCronJobConfig: CronOptions;
   private jobs: Map<string, CronJob> = new Map();
+  protected frameworkLoggerName = 'cronLogger';
 
   async applicationInitialize(options: IMidwayBootstrapOptions) {
     this.app = {} as any;

diff --git a/packages/grpc/src/configuration.ts b/packages/grpc/src/configuration.ts
@@ -17,6 +17,13 @@ import { GRPCClients } from './comsumer/clients';
       default: {
         grpc: {},
         grpcServer: {},
+        midwayLogger: {
+          clients: {
+            grpcLogger: {
+              fileLogName: 'midway-grpc.log',
+            },
+          },
+        },
       },
     },
   ],

diff --git a/packages/grpc/src/provider/framework.ts b/packages/grpc/src/provider/framework.ts
@@ -8,7 +8,6 @@ import {
   ServerUnaryCall,
 } from '@grpc/grpc-js';
 import {
-  Config,
   Framework,
   GRPCMetadata,
   GrpcStreamTypeEnum,
@@ -40,9 +39,7 @@ export class MidwayGRPCFramework extends BaseFramework<
 > {
   public app: IMidwayGRPCApplication;
   private server: Server;
-
-  @Config()
-  providerConfig;
+  protected frameworkLoggerName = 'grpcLogger';
 
   configure() {
     return this.configService.getConfiguration('grpcServer');
@@ -231,7 +228,6 @@ export class MidwayGRPCFramework extends BaseFramework<
             reject(err);
           }
 
-          this.server.start();
           this.logger.info(`Server port = ${bindPort} start success`);
           resolve();
         }

diff --git a/packages/kafka/src/configuration.ts b/packages/kafka/src/configuration.ts
@@ -5,9 +5,7 @@ import { Configuration } from '@midwayjs/core';
   importConfigs: [
     {
       default: {
-        kafka: {
-          contextLoggerApplyLogger: 'kafkaLogger',
-        },
+        kafka: {},
         midwayLogger: {
           clients: {
             kafkaLogger: {