feat: logs now always render and printed boolean now returned when te…

…rminated (#93)

Logs will always render and store their render. To know if a log was printed to the console
terminated logs now expose the "printed" boolean that indicates if it was printed. Log listeners
also now receive the printed boolean. Rather than checking for render equal to null, listeners
should now check the printed boolean.

Co-authored-by: Andrew Stacy <[email protected]>

src/_contracts/Log.ts

@@ -74,6 +74,7 @@ export interface LogData {
   dumpContext: boolean;
   expression?: boolean;
   isSilent: boolean;
+  printed: boolean;
   label: LabelData;
   level: number | null;
   meta: MetaData;
@@ -104,4 +105,5 @@ export interface FinalLogData extends LogData {
 export interface TerminatedLog<I extends BaseLog> {
   log: I;
   render: LogRender | null;
+  printed: boolean;
 }

src/_contracts/Shed.ts

@@ -12,7 +12,8 @@ export type ListenerBucket = Map<number, ListenerCallback>;
 
 export type ListenerCallback = (
   LogData: LogData | FinalLogData,
-  render: LogRender | null
+  render: LogRender | null,
+  printed: boolean
 ) => void;
 
 export interface ShedConfig {

src/index.ts

@@ -1,4 +1,6 @@
-export { adze } from './adze';
+import { adze } from './adze';
+export { adze };
+export default adze;
 export { Label } from './label';
 export { defaults } from './_defaults';
 export {

src/log/BaseLog.ts

@@ -131,6 +131,11 @@ export class BaseLog {
    */
   private isSilent = false;
 
+  /**
+   * Flag which indicates if the log is allowed to print to the console.
+   */
+  private printed = false;
+
   /**
    * Flag which tells the log instance to add the
    * MDC context to the log render arguments.
@@ -765,41 +770,41 @@ export class BaseLog {
       // Apply modifiers in the proper order.
       this.runModifierQueue();
 
-      // Check the test modifiers.
-      if (this.evalPasses()) {
-        // Save values to this log instance for later recall
-        this.args = args;
-        this._level = def.level;
-        this.definition = def;
-        this._timestamp = timestamp();
-        this.stacktrace = this.cfg.captureStacktrace ? stacktrace() : null;
-
-        // Set this log data to a variable for type checking
-        const log_data = this.data;
-
-        if (isFinalLogData(log_data)) {
-          // Render the log if it's allowed to print
-          this._render = allowed(log_data)
-            ? new Printer(log_data)[this.printer]()
-            : null;
-
-          // Attempt to print the render to the console / terminal
-          toConsole(this._render);
+      // Save values to this log instance for later recall
+      this.args = args;
+      this._level = def.level;
+      this.definition = def;
+      this._timestamp = timestamp();
+      this.stacktrace = this.cfg.captureStacktrace ? stacktrace() : null;
+
+      // Set this log data to a variable for type checking
+      const log_data = this.data;
 
-          // Cache the log
-          this.store();
+      if (isFinalLogData(log_data)) {
+        // Render the log
+        this._render = new Printer(log_data)[this.printer]();
 
-          // Fire the log listeners
-          this.fireListeners(log_data, this._render);
+        // Evaluates if this log can print
+        this.printed = allowed(log_data) && this.evalPasses();
 
-          // Return the terminated log object with a render
-          return { log: this, render: this._render };
+        // Attempt to print the render to the console / terminal
+        if (this.printed) {
+          toConsole(this._render);
         }
+
+        // Cache the log
+        this.store();
+
+        // Fire the log listeners
+        this.fireListeners(log_data, this._render, this.printed);
+
+        // Return the terminated log object with a render
+        return { log: this, render: this._render, printed: this.printed };
       }
     }
 
     // Return the terminated log object unrendered
-    return { log: this, render: null };
+    return { log: this, render: null, printed: false };
   }
 
   /**
@@ -838,10 +843,14 @@ export class BaseLog {
   /**
    * Fires listeners for this log instance if a Shed exists.
    */
-  private fireListeners(data: FinalLogData, render: LogRender | null): void {
+  private fireListeners(
+    data: FinalLogData,
+    render: LogRender | null,
+    printed: boolean
+  ): void {
     const shed = this.env.global.$shed;
     if (shedExists(shed)) {
-      shed.fireListeners(data, render);
+      shed.fireListeners(data, render, printed);
     }
   }
 
@@ -871,6 +880,7 @@ export class BaseLog {
       expression: this.expression,
       dumpContext: this.dumpContext,
       isSilent: this.isSilent,
+      printed: this.printed,
       showTimestamp: this.showTimestamp,
       timeNow: this.timeNowVal,
       meta: { ...this.metaData },
@@ -896,6 +906,7 @@ export class BaseLog {
     this.expression = data.expression;
     this.dumpContext = data.dumpContext;
     this.isSilent = data.isSilent;
+    this.printed = data.printed;
     this.showTimestamp = data.showTimestamp;
     this.timeNowVal = data.timeNow;
     this.metaData = { ...data.meta };

src/shed/Shed.ts

@@ -204,9 +204,13 @@ export class Shed {
    * Fires any listeners that are watching the log level defined in the provided log data. The log data
    * and render object will be passed to the listener callback.
    */
-  public fireListeners(log: FinalLogData, render: LogRender | null): void {
+  public fireListeners(
+    log: FinalLogData,
+    render: LogRender | null,
+    printed: boolean
+  ): void {
     this.listeners.get(log.level)?.forEach((listener) => {
-      listener(log, render);
+      listener(log, render, printed);
     });
   }