Merge pull request #115 from AthennaIO/develop

chore: add circular replacer to json stringify

Author: jlenon7

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/logger",
-  "version": "5.5.0",
+  "version": "5.6.0",
   "description": "The Athenna logging solution. Log in stdout, files and buckets.",
   "license": "MIT",
   "author": "João Lenon <[email protected]>",

package.json

@@ -7,9 +7,9 @@
  * file that was distributed with this source code.
  */
 
+import { debug } from '#src/debug'
 import { File } from '@athenna/common'
 import { Driver } from '#src/drivers/Driver'
-import { debug } from '#src/debug'
 
 export class FileDriver extends Driver {
   public async transport(level: string, message: any): Promise<any> {

src/drivers/FileDriver.ts

@@ -76,6 +76,32 @@ export abstract class Formatter {
     return new Date(Date.now()).toLocaleString(undefined, localeStringOptions)
   }
 
+  /**
+   * Get the circular replacer function to be used in
+   * JSON.stringify().
+   */
+  public getCircularReplacer() {
+    const ancestors = []
+
+    return function (key, value) {
+      if (!Is.Object(value) || value === null) {
+        return value
+      }
+
+      while (ancestors.length > 0 && ancestors.at(-1) !== this) {
+        ancestors.pop()
+      }
+
+      if (ancestors.includes(value)) {
+        return '[Circular]'
+      }
+
+      ancestors.push(value)
+
+      return value
+    }
+  }
+
   /**
    * Transform the message to string.
    */
@@ -85,7 +111,7 @@ export abstract class Formatter {
     }
 
     if (Is.Object(message)) {
-      message = JSON.stringify(message)
+      message = JSON.stringify(message, this.getCircularReplacer())
     }
 
     return `${message}`

src/formatters/Formatter.ts

@@ -23,9 +23,9 @@ export class JsonFormatter extends Formatter {
     if (Is.String(message)) {
       base.msg = message
 
-      return JSON.stringify(base)
+      return JSON.stringify(base, this.getCircularReplacer())
     }
 
-    return JSON.stringify({ ...base, ...message })
+    return JSON.stringify({ ...base, ...message }, this.getCircularReplacer())
   }
 }

src/formatters/JsonFormatter.ts

@@ -54,6 +54,9 @@ export class RequestFormatter extends Formatter {
       headers: ctx.response.headers
     }
 
-    return JSON.stringify({ request, response, metadata })
+    return JSON.stringify(
+      { request, response, metadata },
+      this.getCircularReplacer()
+    )
   }
 }