Merge pull request #131 from codex-team/fix-infinity-loop

fix(console-tracker): resolve infinity loop issue

Author: neSpecc

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hawk.so/javascript",
   "type": "commonjs",
-  "version": "3.2.8",
+  "version": "3.2.9",
   "description": "JavaScript errors tracking for Hawk.so",
   "files": [
     "dist"
@@ -47,9 +47,8 @@
     "vue": "^2"
   },
   "dependencies": {
-    "@hawk.so/types": "^0.1.20",
+    "@hawk.so/types": "^0.1.35",
     "error-stack-parser": "^2.1.4",
-    "safe-stringify": "^1.1.1",
     "vite-plugin-dts": "^4.2.4"
   }
 }

src/addons/consoleCatcher.ts

@@ -1,8 +1,8 @@
 /**
  * @file Module for intercepting console logs with stack trace capture
  */
-import safeStringify from 'safe-stringify';
 import type { ConsoleLogEvent } from '@hawk.so/types';
+import Sanitizer from '../modules/sanitizer';
 
 /**
  * Creates a console interceptor that captures and formats console output
@@ -31,7 +31,13 @@ function createConsoleCatcher(): {
       return String(arg);
     }
 
-    return safeStringify(arg);
+    /**
+     * Sanitize the argument before stringifying to handle circular references, deep objects, etc
+     * And then it can be stringified safely
+     */
+    const sanitized = Sanitizer.sanitize(arg);
+
+    return JSON.stringify(sanitized);
   }
 
   /**

src/modules/sanitizer.ts

@@ -33,13 +33,24 @@ export default class Sanitizer {
    *
    * @param data - any object to sanitize
    * @param depth - current depth of recursion
+   * @param seen - Set of already seen objects to prevent circular references
    */
-  public static sanitize(data: any, depth = 0): any {
+  public static sanitize(data: any, depth = 0, seen = new WeakSet<object>()): any {
+    /**
+     * Check for circular references on objects and arrays
+     */
+    if (data !== null && typeof data === 'object') {
+      if (seen.has(data)) {
+        return '<circular>';
+      }
+      seen.add(data);
+    }
+
     /**
      * If value is an Array, apply sanitizing for each element
      */
     if (Sanitizer.isArray(data)) {
-      return this.sanitizeArray(data, depth + 1);
+      return this.sanitizeArray(data, depth + 1, seen);
 
       /**
        * If value is an Element, format it as string with outer HTML
@@ -66,7 +77,7 @@ export default class Sanitizer {
        * If values is an object, do recursive call
        */
     } else if (Sanitizer.isObject(data)) {
-      return Sanitizer.sanitizeObject(data, depth + 1);
+      return Sanitizer.sanitizeObject(data, depth + 1, seen);
 
       /**
        * If values is a string, trim it for max-length
@@ -86,8 +97,9 @@ export default class Sanitizer {
    *
    * @param arr - array to sanitize
    * @param depth - current depth of recursion
+   * @param seen - Set of already seen objects to prevent circular references
    */
-  private static sanitizeArray(arr: any[], depth: number): any[] {
+  private static sanitizeArray(arr: any[], depth: number, seen: WeakSet<object>): any[] {
     /**
      * If the maximum length is reached, slice array to max length and add a placeholder
      */
@@ -99,7 +111,7 @@ export default class Sanitizer {
     }
 
     return arr.map((item: any) => {
-      return Sanitizer.sanitize(item, depth);
+      return Sanitizer.sanitize(item, depth, seen);
     });
   }
 
@@ -108,8 +120,9 @@ export default class Sanitizer {
    *
    * @param data - object to beautify
    * @param depth - current depth of recursion
+   * @param seen - Set of already seen objects to prevent circular references
    */
-  private static sanitizeObject(data: { [key: string]: any }, depth: number): Record<string, any> | '<deep object>' | '<big object>' {
+  private static sanitizeObject(data: { [key: string]: any }, depth: number, seen: WeakSet<object>): Record<string, any> | '<deep object>' | '<big object>' {
     /**
      * If the maximum depth is reached, return a placeholder
      */
@@ -128,7 +141,7 @@ export default class Sanitizer {
 
     for (const key in data) {
       if (Object.prototype.hasOwnProperty.call(data, key)) {
-        result[key] = Sanitizer.sanitize(data[key], depth);
+        result[key] = Sanitizer.sanitize(data[key], depth, seen);
       }
     }
 
@@ -268,7 +281,7 @@ export default class Sanitizer {
   private static formatClassPrototype(target: any): string {
     const className = Sanitizer.getClassNameByPrototype(target);
 
-    return `<instance of ${className}>`;
+    return `<class ${className}>`;
   }
 
   /**
@@ -279,6 +292,6 @@ export default class Sanitizer {
   private static formatClassInstance(target: any): string {
     const className = Sanitizer.getClassNameByInstance(target);
 
-    return `<class ${className}>`;
+    return `<instance of ${className}>`;
   }
 }

yarn.lock

@@ -316,10 +316,10 @@
     minimatch "^3.0.4"
     strip-json-comments "^3.1.1"
 
-"@hawk.so/types@^0.1.20":
-  version "0.1.20"
-  resolved "https://registry.yarnpkg.com/@hawk.so/types/-/types-0.1.20.tgz#90f4b3998ef5f025f5b99dae31da264d5bbe3450"
-  integrity sha512-3a07TekmgqOT9OKeMkqcV73NxzK1dS06pG66VaHO0f5DEEH2+SNfZErqe1v8hkLQIk+GkgZVZLtHqnskjQabuw==
+"@hawk.so/types@^0.1.35":
+  version "0.1.35"
+  resolved "https://registry.yarnpkg.com/@hawk.so/types/-/types-0.1.35.tgz#6afd416dced1cc3282d721ca5621bf452b27aea1"
+  integrity sha512-uMTAeu6DlRlk+oputJBjTlrm1GzOkIwlMfGhpdOp3sRWe/YPGD6nMYlb9MZoVN6Yee7RIpYD7It+DPeUPAyIFw==
   dependencies:
     "@types/mongodb" "^3.5.34"
 
@@ -2619,11 +2619,6 @@ safe-regex-test@^1.0.3:
     es-errors "^1.3.0"
     is-regex "^1.1.4"
 
-safe-stringify@^1.1.1:
-  version "1.1.1"
-  resolved "https://registry.yarnpkg.com/safe-stringify/-/safe-stringify-1.1.1.tgz#f4240f506d041f58374d6106e2a5850f6b1ce576"
-  integrity sha512-YSzQLuwp06fuvJD1h6+vVNFYZoXmDs5UUNPUbTvQK7Ap+L0qD4Vp+sN434C+pdS3prVVlUfQdNeiEIgxox/kUQ==
-
 semver@^6.3.1:
   version "6.3.1"
   resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.1.tgz#556d2ef8689146e46dcea4bfdd095f3434dffcb4"