refactor(logger): remove DefineLogger and InjectEnum (#193)

artusjs · Sep 8, 2022 · 523a2c7 · 523a2c7
1 parent 060ee3f
commit 523a2c7
Show file tree

Hide file tree

Showing 12 changed files with 43 additions and 272 deletions.
diff --git a/src/application.ts b/src/application.ts
@@ -7,7 +7,7 @@ import { LoaderFactory, Manifest } from './loader';
 import { Application, ApplicationInitOptions } from './types';
 import Trigger from './trigger';
 import ConfigurationHandler from './configuration';
-import { ArtusLogger, Logger } from './logger';
+import { Logger } from './logger';
 
 export class ArtusApplication implements Application {
   public manifest?: Manifest;
@@ -36,10 +36,6 @@ export class ArtusApplication implements Application {
     return this.container.get(ArtusInjectEnum.Frameworks);
   }
 
-  get logger(): Logger {
-    return this.container.get(ArtusInjectEnum.Logger);
-  }
-
   get packages(): Record<string, any> {
     return this.container.get(ArtusInjectEnum.Packages);
   }
@@ -59,7 +55,7 @@ export class ArtusApplication implements Application {
     this.container.set({ id: ArtusInjectEnum.LifecycleManager, value: this.lifecycleManager });
 
     this.container.set({ type: ConfigurationHandler });
-    this.container.set({ type: ArtusLogger });
+    this.container.set({ type: Logger });
     this.container.set({ type: Trigger });
     this.container.set({ type: ExceptionHandler });
   }

diff --git a/src/constant.ts b/src/constant.ts
@@ -9,7 +9,6 @@ export enum ArtusInjectEnum {
   DefaultContainerName = 'artus#default_container',
   Frameworks = 'artus#framework-config',
   LifecycleManager = 'artus#lifecycle-manager',
-  Logger = 'artus#logger',
   Packages = 'artus#packages',
 }
 

diff --git a/src/logger/base.ts b/src/logger/base.ts
diff --git a/src/logger/decorator.ts b/src/logger/decorator.ts
diff --git a/src/logger/impl.ts b/src/logger/impl.ts
@@ -1,10 +1,33 @@
-import { BaseLogger } from './base';
-import { DefineLogger } from './decorator';
-import { LoggerLevel } from './level';
-import { LogOptions } from './types';
+import { Container, Inject, Injectable, ScopeEnum } from '@artus/injection';
+import { ArtusInjectEnum } from '../constant';
+import { LoggerLevel, LOGGER_LEVEL_MAP } from './level';
+import { LoggerOptions, LoggerType, LogOptions } from './types';
+
+@Injectable({
+  scope: ScopeEnum.SINGLETON,
+})
+export default class Logger implements LoggerType {
+  @Inject()
+  protected container!: Container;
+
+  protected get loggerOpts(): LoggerOptions {
+    let appConfig: Record<string, any> = {};
+    try {
+      appConfig = this.container.get(ArtusInjectEnum.Config);
+    } catch(e) {
+      // do nothing
+    }
+    return appConfig?.logger ?? {};
+  }
+
+  protected checkLoggerLevel(level: LoggerLevel) {
+    const targetLevel = this.loggerOpts.level ?? LoggerLevel.INFO;
+    if (LOGGER_LEVEL_MAP[level] < LOGGER_LEVEL_MAP[targetLevel]) {
+      return false;
+    }
+    return true;
+  }
 
-@DefineLogger()
-export default class ArtusLogger extends BaseLogger {
   public trace(message: string, ...args: any[]) {
     if (!this.checkLoggerLevel(LoggerLevel.TRACE)) {
       return;

diff --git a/src/logger/index.ts b/src/logger/index.ts
@@ -1,7 +1,5 @@
-import ArtusLogger from './impl';
+import Logger from './impl';
 
-export * from './decorator';
+export { Logger };
 export * from './level';
 export * from './types';
-
-export { ArtusLogger };
diff --git a/src/logger/types.ts b/src/logger/types.ts
@@ -10,7 +10,7 @@ export interface LogOptions {
   splat?: any[];
 }
 
-export interface Logger {
+export interface LoggerType {
   trace(message: string, ...args: any[]): void;
   debug(message: string, ...args: any[]): void;
   info(message: string, ...args: any[]): void;

diff --git a/test/app.test.ts b/test/app.test.ts
@@ -25,7 +25,6 @@ describe('test/app.test.ts', () => {
         // Check Artus Default Class Inject to Contianer
         expect(() => app.container.get(ArtusInjectEnum.Application)).not.toThrow();
         expect(() => app.container.get(ArtusInjectEnum.LifecycleManager)).not.toThrow();
-        expect(() => app.container.get(ArtusInjectEnum.Logger)).not.toThrow();
         expect(() => app.container.get(ExceptionHandler)).not.toThrow();
         expect(() => app.container.get(ConfigurationHandler)).not.toThrow();
 

diff --git a/test/fixtures/logger/src/custom_logger.ts b/test/fixtures/logger/src/custom_logger.ts
@@ -1,8 +1,9 @@
-import { DefineLogger } from '../../../../src/logger';
-import { BaseLogger } from '../../../../src/logger/base';
+import { Injectable, Logger, ScopeEnum } from '../../../../src';
 
-@DefineLogger()
-export default class CustomLogger extends BaseLogger {
+@Injectable({
+  scope: ScopeEnum.SINGLETON,
+})
+export default class CustomLogger extends Logger {
   public info(message: string, ...args: any[]): void {
     console.info('[Custom]', message, ...args);
   }

diff --git a/test/fixtures/logger/src/test_clazz.ts b/test/fixtures/logger/src/test_clazz.ts
@@ -1,12 +1,12 @@
 import { Inject, Injectable, ScopeEnum } from '@artus/injection';
-import { ArtusLogger, LoggerLevel } from '../../../../src/logger';
+import { Logger, LoggerLevel } from '../../../../src/logger';
 
 @Injectable({
   scope: ScopeEnum.SINGLETON,
 })
 export default class TestLoggerClazz {
   @Inject()
-  private logger!: ArtusLogger;
+  private logger!: Logger;
 
   public testLog(level: LoggerLevel, message: string | Error, ...splat: any[]) {
     this.logger.log({

diff --git a/test/fixtures/logger/src/test_custom_clazz.ts b/test/fixtures/logger/src/test_custom_clazz.ts
@@ -6,7 +6,7 @@ import CustomLogger from './custom_logger';
 })
 export default class TestCustomLoggerClazz {
   @Inject()
-  private logger!: CustomLogger;
+  private logger: CustomLogger;
 
   public testInfo(message: string, ...args: any[]) {
     this.logger.info(message, ...args);