Merge pull request #12161 from TheCodby/master

feat(common): added "fatal" as a log level (issue #11945)
nestjs · Aug 18, 2023 · 41790f8 · 41790f8
2 parents 7a5b6e4 + 2cb5f2c
commit 41790f8
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 1 deletion.
diff --git a/packages/common/services/console-logger.service.ts b/packages/common/services/console-logger.service.ts
@@ -26,6 +26,7 @@ const DEFAULT_LOG_LEVELS: LogLevel[] = [
   'warn',
   'debug',
   'verbose',
+  'fatal',
 ];
 
 const dateTimeFormatter = new Intl.DateTimeFormat(undefined, {
@@ -145,6 +146,23 @@ export class ConsoleLogger implements LoggerService {
     this.printMessages(messages, context, 'verbose');
   }
 
+  /**
+   * Write a 'fatal' level log, if the configured level allows for it.
+   * Prints to `stdout` with newline.
+   */
+  fatal(message: any, context?: string): void;
+  fatal(message: any, ...optionalParams: [...any, string?]): void;
+  fatal(message: any, ...optionalParams: any[]) {
+    if (!this.isLevelEnabled('fatal')) {
+      return;
+    }
+    const { messages, context } = this.getContextAndMessagesToPrint([
+      message,
+      ...optionalParams,
+    ]);
+    this.printMessages(messages, context, 'fatal');
+  }
+
   /**
    * Set log levels
    * @param levels log levels
@@ -330,6 +348,8 @@ export class ConsoleLogger implements LoggerService {
         return clc.red;
       case 'verbose':
         return clc.cyanBright;
+      case 'fatal':
+        return clc.bold;
       default:
         return clc.green;
     }

diff --git a/packages/common/services/logger.service.ts b/packages/common/services/logger.service.ts
@@ -6,7 +6,7 @@ import { isLogLevelEnabled } from './utils';
 /**
  * @publicApi
  */
-export type LogLevel = 'log' | 'error' | 'warn' | 'debug' | 'verbose';
+export type LogLevel = 'log' | 'error' | 'warn' | 'debug' | 'verbose' | 'fatal';
 
 /**
  * @publicApi
@@ -37,6 +37,11 @@ export interface LoggerService {
    */
   verbose?(message: any, ...optionalParams: any[]): any;
 
+  /**
+   * Write a 'fatal' level log.
+   */
+  fatal?(message: any, ...optionalParams: any[]): any;
+
   /**
    * Set log levels.
    * @param levels log levels
@@ -185,6 +190,19 @@ export class Logger implements LoggerService {
     this.localInstance?.verbose?.(message, ...optionalParams);
   }
 
+  /**
+   * Write a 'fatal' level log.
+   */
+  fatal(message: any, context?: string): void;
+  fatal(message: any, ...optionalParams: [...any, string?]): void;
+  @Logger.WrapBuffer
+  fatal(message: any, ...optionalParams: any[]) {
+    optionalParams = this.context
+      ? optionalParams.concat(this.context)
+      : optionalParams;
+    this.localInstance?.fatal?.(message, ...optionalParams);
+  }
+
   /**
    * Write an 'error' level log.
    */
@@ -241,6 +259,16 @@ export class Logger implements LoggerService {
     this.staticInstanceRef?.verbose?.(message, ...optionalParams);
   }
 
+  /**
+   * Write a 'fatal' level log.
+   */
+  static fatal(message: any, context?: string): void;
+  static fatal(message: any, ...optionalParams: [...any, string?]): void;
+  @Logger.WrapBuffer
+  static fatal(message: any, ...optionalParams: any[]) {
+    this.staticInstanceRef?.fatal?.(message, ...optionalParams);
+  }
+
   /**
    * Print buffered logs and detach buffer.
    */

diff --git a/packages/common/services/utils/is-log-level-enabled.util.ts b/packages/common/services/utils/is-log-level-enabled.util.ts
@@ -6,6 +6,7 @@ const LOG_LEVEL_VALUES: Record<LogLevel, number> = {
   log: 2,
   warn: 3,
   error: 4,
+  fatal: 5,
 };
 
 /**

diff --git a/packages/core/injector/helpers/silent-logger.ts b/packages/core/injector/helpers/silent-logger.ts
@@ -8,5 +8,6 @@ export class SilentLogger extends Logger {
   warn = noop;
   debug = noop;
   verbose = noop;
+  fatal = noop;
   setLogLevels = noop;
 }