fix: framework logger name

packages/bull/src/framework.ts

@@ -44,6 +44,7 @@ export class BullFramework
   private bullDefaultConcurrency: number;
   private bullClearRepeatJobWhenStart: boolean;
   private queueMap: Map<string, BullQueue> = new Map();
+  protected frameworkLoggerName = 'bullLogger';
 
   @Logger('bullLogger')
   protected bullLogger: ILogger;
@@ -72,10 +73,6 @@ export class BullFramework
     return 'bull';
   }
 
-  public getFrameworkLogger(): ILogger {
-    return this.loggerService.getLogger('bullLogger');
-  }
-
   async run() {
     const processorModules = DecoratorManager.listModule(BULL_PROCESSOR_KEY);
     for (const mod of processorModules) {

packages/core/src/baseFramework.ts

@@ -48,7 +48,7 @@ export abstract class BaseFramework<
   public app: APP;
   public configurationOptions: OPT;
   protected logger: ILogger;
-  protected appLogger: ILogger;
+  protected frameworkLoggerName = 'appLogger';
   protected defaultContext = {};
   protected middlewareManager = this.createMiddlewareManager();
   protected filterManager = this.createFilterManager();
@@ -82,7 +82,6 @@ export abstract class BaseFramework<
   protected async init() {
     this.configurationOptions = this.configure() ?? ({} as OPT);
     this.logger = this.loggerService.getLogger('coreLogger');
-    this.appLogger = this.loggerService.getLogger('appLogger');
     return this;
   }
 
@@ -91,7 +90,6 @@ export abstract class BaseFramework<
     options: IMidwayBootstrapOptions
   ): void | Promise<void>;
   public abstract run(): Promise<void>;
-  public abstract getFrameworkLogger(): ILogger;
 
   public isEnable(): boolean {
     return true;
@@ -129,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,
@@ -149,7 +147,7 @@ export abstract class BaseFramework<
       ctxLoggerCache.set(name, ctxLogger);
       return ctxLogger;
     } else {
-      const appLogger = name ? this.getLogger(name) : this.getFrameworkLogger();
+      const appLogger = this.getLogger(name);
       // avoid maximum call stack size exceeded
       if (ctx['_logger']) {
         return ctx['_logger'];
@@ -371,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() {
@@ -435,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;
+  }
 }

packages/core/src/interface.ts

@@ -1078,7 +1078,6 @@ export interface IMidwayFramework<
   getBaseDir(): string;
   getLogger(name?: string): ILogger;
   getCoreLogger(): ILogger;
-  getFrameworkLogger(): ILogger;
   createLogger(name: string, options: MidwayLoggerOptions): ILogger;
   getProjectName(): string;
   useMiddleware(Middleware: CommonMiddlewareUnion<CTX, ResOrNext, Next>): void;
@@ -1090,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 {

packages/core/test/baseFramework.test.ts

@@ -859,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');
     });

packages/core/test/common/applicationManager.test.ts

@@ -1,5 +1,4 @@
 import { MidwayApplicationManager, BaseFramework, MidwayMockService } from '../../src';
-import { ILogger } from '@midwayjs/logger';
 
 describe('test/common/applicationManager.test.ts', () => {
   it('should test application manager', async () => {
@@ -18,10 +17,6 @@ describe('test/common/applicationManager.test.ts', () => {
       run(): Promise<void> {
         return Promise.resolve(undefined);
       }
-
-      getFrameworkLogger(): ILogger {
-        return undefined;
-      }
     }
 
     const framework = new CustomFramework1({} as any);

packages/core/test/fixtures/base-app-custom-framework-logger/src/framework.ts

@@ -1,8 +1,8 @@
 import { BaseFramework, Framework, IMidwayBootstrapOptions } from '../../../../src';
-import { ILogger } from '@midwayjs/logger';
 
 @Framework()
 export class CustomFramework extends BaseFramework<any, any, any> {
+  frameworkLoggerName = 'customFrameworkLogger';
   async applicationInitialize(options: IMidwayBootstrapOptions) {
     this.app = {};
   }
@@ -12,11 +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);
   }
-
-  getFrameworkLogger(): ILogger {
-    return this.loggerService.getLogger('customFrameworkLogger');
-  }
 }

packages/core/test/fixtures/base-app-multi-framework-shared/src/framework.ts

@@ -4,7 +4,6 @@ import {
   IMidwayApplication,
   IMidwayBootstrapOptions,
 } from '../../../../src';
-import { ILogger } from '@midwayjs/logger';
 
 @Framework()
 export class LightFramework extends BaseFramework<any, any, any> {
@@ -23,8 +22,4 @@ export class LightFramework extends BaseFramework<any, any, any> {
   getFrameworkName(): string {
     return 'grpc';
   }
-
-  getFrameworkLogger(): ILogger {
-    return undefined;
-  }
 }

packages/core/test/setup.test.ts

@@ -10,7 +10,6 @@ import {
   Framework,
   Inject,
 } from '../src';
-import { ILogger } from '@midwayjs/logger';
 
 describe('/test/setup.test.ts', () => {
   it('should test setup and config', async () => {
@@ -140,10 +139,6 @@ describe('/test/setup.test.ts', () => {
       configure() {
         return {};
       }
-
-      getFrameworkLogger(): ILogger {
-        return undefined;
-      }
     }
 
     @Configuration()

packages/core/test/util.ts

@@ -22,7 +22,6 @@ import {
 import { join } from 'path';
 import * as http from 'http';
 import * as getRawBody from 'raw-body';
-import { ILogger } from '@midwayjs/logger';
 
 /**
  * 任意一个数组中的对象，和预期的对象属性一致即可
@@ -129,10 +128,6 @@ export async function createLightFramework(baseDir: string = '', bootstrapOption
     getFrameworkName(): string {
       return 'light';
     }
-
-    getFrameworkLogger(): ILogger {
-      return this.loggerService.getLogger('appLogger');
-    }
   }
 
   const conf = {

packages/cron/src/framework.ts

@@ -7,7 +7,6 @@ import {
   MidwayInvokeForbiddenError,
   Utils,
   MetadataManager,
-  ILogger,
 } from '@midwayjs/core';
 import {
   Application,
@@ -23,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;
@@ -42,10 +42,6 @@ export class CronFramework extends BaseFramework<Application, Context, any> {
     return 'cron';
   }
 
-  public getFrameworkLogger(): ILogger {
-    return this.loggerService.getLogger('cronLogger');
-  }
-
   async run() {
     const jobModules = DecoratorManager.listModule(CRON_JOB_KEY);
     for (const mod of jobModules) {

packages/faas/src/framework.ts

@@ -26,7 +26,6 @@ import {
   WEB_RESPONSE_REDIRECT,
   httpError,
   MidwayFeatureNotImplementedError,
-  ILogger,
 } from '@midwayjs/core';
 import SimpleLock from '@midwayjs/simple-lock';
 import { createConsoleLogger, LoggerOptions, loggers } from '@midwayjs/logger';
@@ -593,8 +592,4 @@ export class MidwayFaaSFramework extends BaseFramework<
   public getAllHandlerNames() {
     return Array.from(this.funMappingStore.keys());
   }
-
-  public getFrameworkLogger(): ILogger {
-    return this.loggerService.getLogger('appLogger');
-  }
 }

packages/grpc/src/provider/framework.ts

@@ -22,7 +22,6 @@ import {
   MidwayInvokeForbiddenError,
   DecoratorManager,
   MetadataManager,
-  ILogger,
 } from '@midwayjs/core';
 import {
   Context,
@@ -275,8 +274,4 @@ export class MidwayGRPCFramework extends BaseFramework<
   public getFrameworkName() {
     return 'gRPC';
   }
-
-  public getFrameworkLogger(): ILogger {
-    return this.loggerService.getLogger('appLogger');
-  }
 }

packages/kafka/src/framework.ts

@@ -52,6 +52,8 @@ export class MidwayKafkaFramework extends BaseFramework<
     IKafkaConsumerInitOptions,
     IKafkaConsumer
   >;
+  protected frameworkLoggerName = 'kafkaLogger';
+
   configure() {
     return this.configService.getConfiguration('kafka');
   }
@@ -316,8 +318,4 @@ export class MidwayKafkaFramework extends BaseFramework<
       await this.typedResourceManager.destroy();
     }
   }
-
-  public getFrameworkLogger(): ILogger {
-    return this.loggerService.getLogger('kafkaLogger');
-  }
 }

packages/mock/src/creator.ts

@@ -18,7 +18,6 @@ import {
   ObjectIdentifier,
   isTypeScriptEnvironment,
   DecoratorManager,
-  ILogger,
 } from '@midwayjs/core';
 import { isAbsolute, join, resolve } from 'path';
 import { clearAllLoggers, loggers } from '@midwayjs/logger';
@@ -602,10 +601,6 @@ class LightFramework extends BaseFramework<any, any, any, any, any> {
   getFrameworkName(): string {
     return 'lightFramework';
   }
-
-  getFrameworkLogger(): ILogger {
-    return this.loggerService.getLogger('appLogger');
-  }
 }
 
 class BootstrapAppStarter implements IBootstrapAppStarter {

packages/mqtt/src/framework.ts

@@ -1,10 +1,8 @@
 import {
   Framework,
   BaseFramework,
-  Logger,
   DecoratorManager,
   MetadataManager,
-  ILogger,
 } from '@midwayjs/core';
 import {
   IMidwayMQTTApplication,
@@ -24,9 +22,7 @@ export class MidwayMQTTFramework extends BaseFramework<
 > {
   public app: IMidwayMQTTApplication;
   protected subscriberMap: Map<string, MqttClient> = new Map();
-
-  @Logger('mqttLogger')
-  mqttLogger: ILogger;
+  protected frameworkLoggerName = 'mqttLogger';
 
   configure() {
     return this.configService.getConfiguration('mqtt');
@@ -40,7 +36,7 @@ export class MidwayMQTTFramework extends BaseFramework<
     const { sub } = this.configurationOptions;
 
     if (Object.keys(sub || {}).length === 0) {
-      this.mqttLogger.info(
+      this.logger.info(
         '[midway-mqtt] Not found consumer config, skip init consumer'
       );
     }
@@ -69,7 +65,7 @@ export class MidwayMQTTFramework extends BaseFramework<
   protected async beforeStop(): Promise<void> {
     for (const [name, consumer] of this.subscriberMap) {
       await consumer.endAsync();
-      this.mqttLogger.info(`[midway-mqtt] subscriber: ${name} is closed`);
+      this.logger.info(`[midway-mqtt] subscriber: ${name} is closed`);
     }
   }
 
@@ -107,7 +103,7 @@ export class MidwayMQTTFramework extends BaseFramework<
         resolve(client);
       });
       client.on('error', err => {
-        this.mqttLogger.error(err);
+        this.logger.error(err);
       });
     });
 
@@ -143,8 +139,4 @@ export class MidwayMQTTFramework extends BaseFramework<
   public getFrameworkName() {
     return 'mqtt';
   }
-
-  public getFrameworkLogger(): ILogger {
-    return this.loggerService.getLogger('mqttLogger');
-  }
 }

packages/rabbitmq/src/framework.ts

@@ -9,7 +9,6 @@ import {
   DecoratorManager,
   MetadataManager,
   listPropertyDataFromClass,
-  ILogger,
 } from '@midwayjs/core';
 import {
   IMidwayRabbitMQApplication,
@@ -121,8 +120,4 @@ export class MidwayRabbitMQFramework extends BaseFramework<
   public getFrameworkName() {
     return 'rabbitmq';
   }
-
-  public getFrameworkLogger(): ILogger {
-    return this.loggerService.getLogger('appLogger');
-  }
 }

packages/socketio/src/framework.ts

@@ -24,7 +24,6 @@ import {
   WSEventInfo,
   WSEventTypeEnum,
   Framework,
-  ILogger,
 } from '@midwayjs/core';
 
 @Framework()
@@ -345,8 +344,4 @@ export class MidwaySocketIOFramework extends BaseFramework<
   > {
     return this.connectionMiddlewareManager;
   }
-
-  public getFrameworkLogger(): ILogger {
-    return this.loggerService.getLogger('appLogger');
-  }
 }