feat: add custom logger

resolves #2068

Author: BrunnerLivio

e2e/helper/bootstrap-testing-module.ts

@@ -53,7 +53,6 @@ function createHealthController(func: TestingHealthFunc) {
       private readonly typeorm: TypeOrmHealthIndicator,
       private readonly mikroOrm: MikroOrmHealthIndicator,
     ) {}
-    // @ts-ignore
     @Get('health')
     health() {
       return func({

lib/health-check/health-check.service.spec.ts

@@ -3,6 +3,8 @@ import { HealthCheckService } from './health-check.service';
 import { HealthCheckExecutor } from './health-check-executor.service';
 import { ERROR_LOGGER } from './error-logger/error-logger.provider';
 import { ErrorLogger } from './error-logger/error-logger.interface';
+import { TERMINUS_LOGGER } from './logger/logger.provider';
+import { ConsoleLogger } from '@nestjs/common';
 
 const healthCheckExecutorMock: Partial<HealthCheckExecutor> = {
   execute: jest.fn(),
@@ -12,9 +14,19 @@ const errorLoggerMock: ErrorLogger = {
   getErrorMessage: jest.fn(),
 };
 
+const loggerMock: Partial<ConsoleLogger> = {
+  setContext: jest.fn(),
+  log: jest.fn(),
+  error: jest.fn(),
+  warn: jest.fn(),
+  debug: jest.fn(),
+};
+
 describe('HealthCheckService', () => {
   let healthCheckExecutor: HealthCheckExecutor;
   let healthCheckService: HealthCheckService;
+  let logger: ConsoleLogger;
+  let errorLogger: ErrorLogger;
 
   beforeEach(async () => {
     const module = Test.createTestingModule({
@@ -28,12 +40,18 @@ describe('HealthCheckService', () => {
           provide: ERROR_LOGGER,
           useValue: errorLoggerMock,
         },
+        {
+          provide: TERMINUS_LOGGER,
+          useValue: loggerMock,
+        },
       ],
     });
     const context = await module.compile();
 
     healthCheckService = context.get(HealthCheckService);
     healthCheckExecutor = context.get(HealthCheckExecutor);
+    logger = context.get(TERMINUS_LOGGER);
+    errorLogger = context.get(ERROR_LOGGER);
   });
 
   it('should return the result', async () => {
@@ -55,4 +73,17 @@ describe('HealthCheckService', () => {
       expect((error as any).status).toBe(503);
     }
   });
+
+  it('should print an error message', async () => {
+    (healthCheckExecutor.execute as jest.Mock).mockReturnValue({
+      status: 'error',
+    });
+    (errorLogger.getErrorMessage as jest.Mock).mockReturnValue('error message');
+
+    try {
+      await healthCheckService.check([() => Promise.resolve({})]);
+    } catch (error) {
+      expect(logger.error).toHaveBeenCalledWith('error message');
+    }
+  });
 });

lib/health-check/health-check.service.ts

@@ -1,14 +1,15 @@
 import {
   Injectable,
   ServiceUnavailableException,
-  Logger,
   Inject,
+  ConsoleLogger,
 } from '@nestjs/common';
 import { HealthIndicatorFunction } from '../health-indicator';
 import { ErrorLogger } from './error-logger/error-logger.interface';
 import { ERROR_LOGGER } from './error-logger/error-logger.provider';
 import { HealthCheckExecutor } from './health-check-executor.service';
 import { HealthCheckResult } from './health-check-result.interface';
+import { TERMINUS_LOGGER } from './logger/logger.provider';
 
 /**
  * Handles Health Checks which can be used in
@@ -20,9 +21,11 @@ export class HealthCheckService {
     private readonly healthCheckExecutor: HealthCheckExecutor,
     @Inject(ERROR_LOGGER)
     private readonly errorLogger: ErrorLogger,
-  ) {}
-
-  private readonly logger = new Logger(HealthCheckService.name);
+    @Inject(TERMINUS_LOGGER)
+    private readonly logger: ConsoleLogger,
+  ) {
+    this.logger.setContext(HealthCheckService.name);
+  }
 
   /**
    * Checks the given health indicators
@@ -45,7 +48,7 @@ export class HealthCheckService {
       return result;
     }
 
-    if (result.error) {
+    if (result.status === 'error') {
       const msg = this.errorLogger.getErrorMessage(
         'Health Check has failed!',
         result.details,

lib/health-check/logger/default-logger.service.ts

@@ -0,0 +1,4 @@
+import { Injectable, Scope, ConsoleLogger } from '@nestjs/common';
+
+@Injectable({ scope: Scope.TRANSIENT })
+export class DefaultTerminusLogger extends ConsoleLogger {}

lib/health-check/logger/logger.provider.ts

@@ -0,0 +1,34 @@
+import { LoggerService, Provider, Type } from '@nestjs/common';
+import { DefaultTerminusLogger } from './default-logger.service';
+
+export const TERMINUS_LOGGER = 'TERMINUS_LOGGER';
+
+export function getLoggerProvider(
+  logger?: Type<LoggerService> | boolean,
+): Provider<LoggerService> {
+  if (logger === true || logger === undefined) {
+    return {
+      provide: TERMINUS_LOGGER,
+      useClass: DefaultTerminusLogger,
+    };
+  }
+
+  if (logger === false) {
+    return {
+      provide: TERMINUS_LOGGER,
+      useValue: {
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
+        log: () => {},
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
+        error: () => {},
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
+        warn: () => {},
+      },
+    };
+  }
+
+  return {
+    provide: TERMINUS_LOGGER,
+    useClass: logger,
+  };
+}

lib/health-indicator/http/http.health.spec.ts

@@ -3,6 +3,7 @@ import { HttpModule, HttpService } from '@nestjs/axios';
 import { HttpHealthIndicator } from './http.health';
 import { checkPackages } from '../../utils/checkPackage.util';
 import { of } from 'rxjs';
+import { TERMINUS_LOGGER } from '../../health-check/logger/logger.provider';
 jest.mock('../../utils/checkPackage.util');
 
 // == MOCKS ==
@@ -33,6 +34,13 @@ describe('Http Response Health Indicator', () => {
           provide: nestJSAxiosMock.HttpService as any,
           useValue: httpServiceMock,
         },
+        {
+          provide: TERMINUS_LOGGER,
+          useValue: {
+            error: jest.fn(),
+            setContext: jest.fn(),
+          },
+        },
       ],
     }).compile();
 

lib/health-indicator/http/http.health.ts

@@ -1,16 +1,20 @@
-import { Injectable, Scope } from '@nestjs/common';
+import {
+  ConsoleLogger,
+  Inject,
+  Injectable,
+  Logger,
+  Scope,
+} from '@nestjs/common';
 import { HealthIndicator, HealthIndicatorResult } from '..';
 import { HealthCheckError } from '../../health-check/health-check.error';
 import { lastValueFrom, Observable } from 'rxjs';
 import { ModuleRef } from '@nestjs/core';
 import { checkPackages, isAxiosError } from '../../utils';
 import type * as NestJSAxios from '@nestjs/axios';
 import { AxiosRequestConfig, AxiosResponse } from './axios.interfaces';
-import { Logger } from '@nestjs/common/services/logger.service';
 import { URL } from 'url';
 import { AxiosError } from '../../errors/axios.error';
-
-const logger = new Logger('HttpHealthIndicator');
+import { TERMINUS_LOGGER } from '../../health-check/logger/logger.provider';
 
 interface HttpClientLike {
   request<T = any>(config: any): Observable<AxiosResponse<T>>;
@@ -32,8 +36,13 @@ export class HttpHealthIndicator extends HealthIndicator {
    * Initializes the health indicator
    * @param httpService The HttpService provided by Nest
    */
-  constructor(private readonly moduleRef: ModuleRef) {
+  constructor(
+    private readonly moduleRef: ModuleRef,
+    @Inject(TERMINUS_LOGGER)
+    private readonly logger: ConsoleLogger,
+  ) {
     super();
+    this.logger.setContext(HttpHealthIndicator.name);
     this.checkDependantPackages();
   }
 
@@ -53,7 +62,7 @@ export class HttpHealthIndicator extends HealthIndicator {
         strict: false,
       });
     } catch (err) {
-      logger.error(
+      this.logger.error(
         'It seems like "HttpService" is not available in the current context. Are you sure you imported the HttpModule from the @nestjs/axios package?',
       );
       throw new Error(

lib/terminus-options.interface.ts

@@ -1,5 +1,8 @@
+import { LoggerService, Type } from '@nestjs/common';
+
 export type ErrorLogStyle = 'pretty' | 'json';
 
 export interface TerminusModuleOptions {
-  errorLogStyle: ErrorLogStyle;
+  errorLogStyle?: ErrorLogStyle;
+  logger?: Type<LoggerService> | boolean;
 }

lib/terminus.module.ts

@@ -6,6 +6,7 @@ import { HealthCheckExecutor } from './health-check/health-check-executor.servic
 import { ERROR_LOGGERS } from './health-check/error-logger/error-loggers.provider';
 import { getErrorLoggerProvider } from './health-check/error-logger/error-logger.provider';
 import { TerminusModuleOptions } from './terminus-options.interface';
+import { getLoggerProvider } from './health-check/logger/logger.provider';
 
 const providers = [
   ...ERROR_LOGGERS,
@@ -24,16 +25,20 @@ const exports_ = [HealthCheckService, ...HEALTH_INDICATORS];
  * @publicApi
  */
 @Module({
-  providers: [...providers, getErrorLoggerProvider()],
+  providers: [...providers, getErrorLoggerProvider(), getLoggerProvider()],
   exports: exports_,
 })
 export class TerminusModule {
-  static forRoot(
-    options: TerminusModuleOptions = { errorLogStyle: 'json' },
-  ): DynamicModule {
+  static forRoot(options: TerminusModuleOptions = {}): DynamicModule {
+    const { errorLogStyle = 'json', logger = true } = options;
+
     return {
       module: TerminusModule,
-      providers: [...providers, getErrorLoggerProvider(options.errorLogStyle)],
+      providers: [
+        ...providers,
+        getErrorLoggerProvider(errorLogStyle),
+        getLoggerProvider(logger),
+      ],
       exports: exports_,
     };
   }

tools/gulp/config.ts

@@ -3,7 +3,7 @@ import { join } from 'path';
 
 // All paths are related to the base dir
 export const rootFolder = join(__dirname, '../../');
-export const tsconfig = join(rootFolder, 'tsconfig.json');
+export const tsconfig = join(rootFolder, 'tsconfig.build.json');
 export const libPath = join(rootFolder, 'lib');
 export const samplePath = join(rootFolder, 'sample');
 export const distPath = join(rootFolder, 'dist');

tsconfig.base.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "module": "commonjs",
+    "strict": true,
+    "declaration": true,
+    "noImplicitAny": true,
+    "removeComments": false,
+    "noLib": false,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "target": "es6",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "rootDir": "./lib",
+    "alwaysStrict": true,
+    "skipLibCheck": true
+  },
+}

tsconfig.build.json

@@ -0,0 +1,5 @@
+{
+  "extends": "./tsconfig.base.json",
+  "include": ["lib/**/*"],
+  "exclude": ["node_modules", "**/*.spec.ts", "sample/**/*.ts"]
+}

tsconfig.json

@@ -1,21 +1,5 @@
 {
-  "compilerOptions": {
-    "baseUrl": ".",
-    "module": "commonjs",
-    "strict": true,
-    "declaration": true,
-    "noImplicitAny": true,
-    "removeComments": false,
-    "noLib": false,
-    "emitDecoratorMetadata": true,
-    "experimentalDecorators": true,
-    "target": "es6",
-    "sourceMap": true,
-    "outDir": "./dist",
-    "rootDir": "./lib",
-    "alwaysStrict": true,
-    "skipLibCheck": true
-  },
-  "include": ["lib/**/*"],
-  "exclude": ["node_modules", "**/*.spec.ts", "sample/**/*.ts", "e2e_old"]
+  "extends": "./tsconfig.base.json",
+  "include": ["lib/**/*", "e2e/**/*", "tools/**/*"],
+  "exclude": ["node_modules", "sample/**/*.ts"]
 }