refactor: implement ConsoleCatcher class for improved console log handling in Catcher

Author: Dobrunia

src/addons/consoleCatcher.ts

@@ -15,15 +15,37 @@ const MAX_LOGS = 20;
 const CONSOLE_METHODS: string[] = ['log', 'warn', 'error', 'info', 'debug'];
 
 /**
- * Creates a console interceptor that captures and formats console output
+ * Console catcher class for intercepting and capturing console logs
  */
-function createConsoleCatcher(): {
-  initConsoleCatcher: () => void;
-  addErrorEvent: (event: ErrorEvent | PromiseRejectionEvent) => void;
-  getConsoleLogStack: () => ConsoleLogEvent[];
-} {
-  const consoleOutput: ConsoleLogEvent[] = [];
-  let isInitialized = false;
+export class ConsoleCatcher {
+  /**
+   * Singleton instance
+   */
+  private static instance: ConsoleCatcher | null = null;
+
+  /**
+   * Console output buffer
+   */
+  private readonly consoleOutput: ConsoleLogEvent[] = [];
+
+  /**
+   * Initialization flag
+   */
+  private isInitialized = false;
+
+  /**
+   * Private constructor to enforce singleton pattern
+   */
+  private constructor() {}
+
+  /**
+   * Get singleton instance
+   */
+  public static getInstance(): ConsoleCatcher {
+    ConsoleCatcher.instance ??= new ConsoleCatcher();
+
+    return ConsoleCatcher.instance;
+  }
 
   /**
    * Converts any argument to its string representation
@@ -32,7 +54,7 @@ function createConsoleCatcher(): {
    * @throws Error if the argument can not be stringified, for example by such reason:
    *  SecurityError: Failed to read a named property 'toJSON' from 'Window': Blocked a frame with origin "https://codex.so" from accessing a cross-origin frame.
    */
-  function stringifyArg(arg: unknown): string {
+  private stringifyArg(arg: unknown): string {
     if (typeof arg === 'string') {
       return arg;
     }
@@ -54,7 +76,7 @@ function createConsoleCatcher(): {
    *
    * @param args - Console arguments that may include style directives
    */
-  function formatConsoleArgs(args: unknown[]): {
+  private formatConsoleArgs(args: unknown[]): {
     message: string;
     styles: string[];
   } {
@@ -71,7 +93,7 @@ function createConsoleCatcher(): {
       return {
         message: args.map(arg => {
           try {
-            return stringifyArg(arg);
+            return this.stringifyArg(arg);
           } catch (error) {
             return '[Error stringifying argument: ' + (error instanceof Error ? error.message : String(error)) + ']';
           }
@@ -101,7 +123,7 @@ function createConsoleCatcher(): {
       .slice(styles.length + 1)
       .map(arg => {
         try {
-          return stringifyArg(arg);
+          return this.stringifyArg(arg);
         } catch (error) {
           return '[Error stringifying argument: ' + (error instanceof Error ? error.message : String(error)) + ']';
         }
@@ -119,21 +141,19 @@ function createConsoleCatcher(): {
    *
    * @param logEvent - The console log event to be added to the output buffer
    */
-  function addToConsoleOutput(logEvent: ConsoleLogEvent): void {
-    if (consoleOutput.length >= MAX_LOGS) {
-      consoleOutput.shift();
+  private addToConsoleOutput(logEvent: ConsoleLogEvent): void {
+    if (this.consoleOutput.length >= MAX_LOGS) {
+      this.consoleOutput.shift();
     }
-    consoleOutput.push(logEvent);
+    this.consoleOutput.push(logEvent);
   }
 
   /**
    * Creates a console log event from an error or promise rejection
    *
    * @param event - The error event or promise rejection event to convert
    */
-  function createConsoleEventFromError(
-    event: ErrorEvent | PromiseRejectionEvent
-  ): ConsoleLogEvent {
+  private createConsoleEventFromError(event: ErrorEvent | PromiseRejectionEvent): ConsoleLogEvent {
     if (event instanceof ErrorEvent) {
       return {
         method: 'error',
@@ -160,24 +180,23 @@ function createConsoleCatcher(): {
   /**
    * Initializes the console interceptor by overriding default console methods
    */
-  function initConsoleCatcher(): void {
-    if (isInitialized) {
+  public init(): void {
+    if (this.isInitialized) {
       return;
     }
 
-    isInitialized = true;
+    this.isInitialized = true;
 
-    CONSOLE_METHODS.forEach(function overrideConsoleMethod(method) {
-      if (typeof window.console[method] !== 'function') {
+    CONSOLE_METHODS.forEach((method) => {
+      if (typeof globalThis.console[method] !== 'function') {
         return;
       }
 
       const oldFunction = window.console[method].bind(window.console);
 
-      window.console[method] = function (...args: unknown[]): void {
-        const stack = new Error().stack?.split('\n').slice(2)
-          .join('\n') || '';
-        const { message, styles } = formatConsoleArgs(args);
+      window.console[method] = (...args: unknown[]): void => {
+        const stack = new Error().stack?.split('\n').slice(2).join('\n') || '';
+        const { message, styles } = this.formatConsoleArgs(args);
 
         const logEvent: ConsoleLogEvent = {
           method,
@@ -189,7 +208,7 @@ function createConsoleCatcher(): {
           styles,
         };
 
-        addToConsoleOutput(logEvent);
+        this.addToConsoleOutput(logEvent);
         oldFunction(...args);
       };
     });
@@ -200,28 +219,16 @@ function createConsoleCatcher(): {
    *
    * @param event - The error or promise rejection event to handle
    */
-  function addErrorEvent(event: ErrorEvent | PromiseRejectionEvent): void {
-    const logEvent = createConsoleEventFromError(event);
+  public addErrorEvent(event: ErrorEvent | PromiseRejectionEvent): void {
+    const logEvent = this.createConsoleEventFromError(event);
 
-    addToConsoleOutput(logEvent);
+    this.addToConsoleOutput(logEvent);
   }
 
   /**
    * Returns the current console output buffer
    */
-  function getConsoleLogStack(): ConsoleLogEvent[] {
-    return [ ...consoleOutput ];
+  public getConsoleLogStack(): ConsoleLogEvent[] {
+    return [...this.consoleOutput];
   }
-
-  return {
-    initConsoleCatcher,
-    addErrorEvent,
-    getConsoleLogStack,
-  };
 }
-
-const consoleCatcher = createConsoleCatcher();
-
-export const { initConsoleCatcher, getConsoleLogStack, addErrorEvent } =
-  consoleCatcher;
-

src/catcher.ts

@@ -16,7 +16,7 @@ import type { JavaScriptCatcherIntegrations } from './types/integrations';
 import { EventRejectedError } from './errors';
 import type { HawkJavaScriptEvent } from './types';
 import { isErrorProcessed, markErrorAsProcessed } from './utils/event';
-import { addErrorEvent, getConsoleLogStack, initConsoleCatcher } from './addons/consoleCatcher';
+import { ConsoleCatcher } from './addons/consoleCatcher';
 import { validateUser, validateContext } from './utils/validation';
 
 /**
@@ -98,6 +98,11 @@ export default class Catcher {
    */
   private readonly consoleTracking: boolean;
 
+  /**
+   * Console catcher instance
+   */
+  private readonly consoleCatcher: ConsoleCatcher;
+
   /**
    * Catcher constructor
    *
@@ -116,8 +121,15 @@ export default class Catcher {
     this.setUser(settings.user || Catcher.getGeneratedUser());
     this.setContext(settings.context || undefined);
     this.beforeSend = settings.beforeSend;
-    this.disableVueErrorHandler = settings.disableVueErrorHandler !== null && settings.disableVueErrorHandler !== undefined ? settings.disableVueErrorHandler : false;
-    this.consoleTracking = settings.consoleTracking !== null && settings.consoleTracking !== undefined ? settings.consoleTracking : true;
+    this.disableVueErrorHandler =
+      settings.disableVueErrorHandler !== null && settings.disableVueErrorHandler !== undefined
+        ? settings.disableVueErrorHandler
+        : false;
+    this.consoleTracking =
+      settings.consoleTracking !== null && settings.consoleTracking !== undefined
+        ? settings.consoleTracking
+        : true;
+    this.consoleCatcher = ConsoleCatcher.getInstance();
 
     if (!this.token) {
       log(
@@ -144,7 +156,7 @@ export default class Catcher {
     });
 
     if (this.consoleTracking) {
-      initConsoleCatcher();
+      this.consoleCatcher.init();
     }
 
     /**
@@ -284,7 +296,7 @@ export default class Catcher {
      */
 
     if (this.consoleTracking) {
-      addErrorEvent(event);
+      this.consoleCatcher.addErrorEvent(event);
     }
 
     /**
@@ -551,7 +563,7 @@ export default class Catcher {
     const userAgent = window.navigator.userAgent;
     const location = window.location.href;
     const getParams = this.getGetParams();
-    const consoleLogs = this.consoleTracking && getConsoleLogStack();
+    const consoleLogs = this.consoleTracking && this.consoleCatcher.getConsoleLogStack();
 
     const addons: JavaScriptAddons = {
       window: {