WIP

Author: CMCDragonkai

Diff for: src/Logger.ts

@@ -1,4 +1,4 @@
-import type { LogData, LogRecord, LogFormatter } from './types';
+import type { ToString, LogData, LogRecord, LogFormatter } from './types';
 import type Handler from './Handler';
 import { LogLevel } from './types';
 import ConsoleErrHandler from './handlers/ConsoleErrHandler';
@@ -83,10 +83,14 @@ class Logger {
     delete this.filter;
   }
 
-  public debug(msg: string, format?: LogFormatter): void;
-  public debug(msg: string, data: LogData, format?: LogFormatter): void;
+  public debug(msg: ToString | undefined, format?: LogFormatter): void;
   public debug(
-    msg: string,
+    msg: ToString | undefined,
+    data: LogData,
+    format?: LogFormatter,
+  ): void;
+  public debug(
+    msg: ToString | undefined,
     formatOrData?: LogFormatter | LogData,
     format?: LogFormatter,
   ): void {
@@ -97,10 +101,14 @@ class Logger {
     }
   }
 
-  public info(msg: string, format?: LogFormatter): void;
-  public info(msg: string, data: LogData, format?: LogFormatter): void;
+  public info(msg: ToString | undefined, format?: LogFormatter): void;
+  public info(
+    msg: ToString | undefined,
+    data: LogData,
+    format?: LogFormatter,
+  ): void;
   public info(
-    msg: string,
+    msg: ToString | undefined,
     formatOrData?: LogFormatter | LogData,
     format?: LogFormatter,
   ): void {
@@ -111,10 +119,14 @@ class Logger {
     }
   }
 
-  public warn(msg: string, format?: LogFormatter): void;
-  public warn(msg: string, data: LogData, format?: LogFormatter): void;
+  public warn(msg: ToString | undefined, format?: LogFormatter): void;
   public warn(
-    msg: string,
+    msg: ToString | undefined,
+    data: LogData,
+    format?: LogFormatter,
+  ): void;
+  public warn(
+    msg: ToString | undefined,
     formatOrData?: LogFormatter | LogData,
     format?: LogFormatter,
   ): void {
@@ -125,10 +137,14 @@ class Logger {
     }
   }
 
-  public error(msg: string, format?: LogFormatter): void;
-  public error(msg: string, data: LogData, format?: LogFormatter): void;
+  public error(msg: ToString | undefined, format?: LogFormatter): void;
+  public error(
+    msg: ToString | undefined,
+    data: LogData,
+    format?: LogFormatter,
+  ): void;
   public error(
-    msg: string,
+    msg: ToString | undefined,
     formatOrData?: LogFormatter | LogData,
     format?: LogFormatter,
   ): void {
@@ -140,11 +156,13 @@ class Logger {
   }
 
   protected log(
-    msg: string,
+    msg: ToString | undefined,
     data: LogData,
     level: LogLevel,
     format?: LogFormatter,
   ): void {
+    // Filter on level before making a record
+    if (level < this.getEffectiveLevel()) return;
     const record = this.makeRecord(msg, data, level);
     this.callHandlers(record, level, format);
   }
@@ -154,13 +172,17 @@ class Logger {
    * The `LogRecord` can contain lazy values via wrapping with a lambda
    * This improves performance as they are not evaluated unless needed during formatting
    */
-  protected makeRecord(msg: string, data: LogData, level: LogLevel): LogRecord {
+  protected makeRecord(
+    msg: ToString | undefined,
+    data: LogData,
+    level: LogLevel,
+  ): LogRecord {
     return {
       logger: this,
       key: this.key,
       date: new Date(),
       level,
-      msg,
+      msg: msg?.toString(),
       data,
       keys: () => {
         let logger: Logger = this;
@@ -197,9 +219,9 @@ class Logger {
     format?: LogFormatter,
     keys: Array<string> = [],
   ): void {
-    if (level < this.getEffectiveLevel()) {
-      return;
-    }
+    // Filter on level before calling handlers
+    // This is also called when traversing up the parent
+    if (level < this.getEffectiveLevel()) return;
     keys.push(this.key);
     if (this.filter != null) {
       const keysPath = keys.reduce((prev, curr) => `${curr}.${prev}`);

Diff for: src/formatting.ts

@@ -24,7 +24,7 @@ function format(
       } else if (value === date) {
         result += record.date.toISOString();
       } else if (value === msg) {
-        result += record.msg;
+        if (record.msg != null) result += record.msg;
       } else if (value === level) {
         result += utils.levelToString(record.level);
       } else if (value === data) {

Diff for: src/types.ts

@@ -8,6 +8,10 @@ enum LogLevel {
   ERROR = 4,
 }
 
+interface ToString {
+  toString: () => string;
+}
+
 interface ToJSON {
   toJSON: (key?: string) => string;
 }
@@ -42,7 +46,7 @@ type LogRecord = {
   key: string;
   date: Date;
   level: LogLevel;
-  msg: string;
+  msg: string | undefined;
   data: LogData;
   keys: () => string;
   stack: () => string;
@@ -52,4 +56,12 @@ type LogFormatter = (record: LogRecord) => string;
 
 export { LogLevel };
 
-export type { LogDataKey, LogDataValue, LogData, LogRecord, LogFormatter };
+export type {
+  ToString,
+  ToJSON,
+  LogDataKey,
+  LogDataValue,
+  LogData,
+  LogRecord,
+  LogFormatter,
+};