fix: 1702: integrate fast-safe-stringify

Integrate fast-safe stringify library to also gracefully handles circular structures instead of throwing in most cases Closes: #1702 Signed-off-by: Michael Courtin <[email protected]>
hyperledger-cacti · Jan 14, 2022 · 3bf237d · 3bf237d
1 parent f514b32
commit 3bf237d
Show file tree

Hide file tree

Showing 3 changed files with 209 additions and 28 deletions.
diff --git a/packages/cactus-common/package.json b/packages/cactus-common/package.json
@@ -52,6 +52,11 @@
       "name": "Peter Somogyvari",
       "email": "[email protected]",
       "url": "https://accenture.com"
+    },
+    {
+      "name": "Michael Courtin",
+      "email": "[email protected]",
+      "url": "https://accenture.com"
     }
   ],
   "license": "Apache-2.0",
@@ -60,6 +65,7 @@
   },
   "homepage": "https://github.com/hyperledger/cactus#readme",
   "dependencies": {
+    "fast-safe-stringify": "2.1.1",
     "json-stable-stringify": "1.0.1",
     "key-encoder": "2.0.3",
     "loglevel": "1.7.1",

diff --git a/packages/cactus-common/src/main/typescript/logging/log-helper.ts b/packages/cactus-common/src/main/typescript/logging/log-helper.ts
@@ -1,4 +1,5 @@
 import { RuntimeError } from "run-time-error";
+import stringify from "fast-safe-stringify";
 
 export class LogHelper {
   public static getExceptionStack(exception: unknown): string {
@@ -101,9 +102,10 @@ export class LogHelper {
     let message = "";
 
     try {
-      message = JSON.stringify(input);
+      // use fast-safe-stringify to also handle gracefully circular structures
+      message = stringify(input);
     } catch (error) {
-      // stringify failed maybe due to cyclic dependency
+      // fast and safe stringify failed
       message = catchMessage;
     }
     return message;