fix(logs): safely serialize objects with cyclic refs

botpress · Jul 29, 2018 · 270a7e4 · 270a7e4
1 parent 62b9ba6
commit 270a7e4
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/packages/core/botpress/src/logger/db-transport.js b/packages/core/botpress/src/logger/db-transport.js
@@ -1,10 +1,10 @@
 import winston from 'winston'
 import ms from 'ms'
-import Promise from 'bluebird'
 
 import { isEmpty } from 'lodash'
 
 import helpers from '../database/helpers'
+import { safeStringify } from '../util'
 
 const LOGS_FLUSH_INTERVAL = ms('2s')
 const LOGS_CHUNK_SIZE = 1000
@@ -57,7 +57,7 @@ export default class DbTransport extends winston.Transport {
 
   log(level, message, meta, callback) {
     if (!isEmpty(meta)) {
-      message += ` (meta=${JSON.stringify(meta)})`
+      message += ` (meta=${safeStringify(meta)})`
     }
 
     this.db

diff --git a/packages/core/botpress/src/util.js b/packages/core/botpress/src/util.js
@@ -123,6 +123,21 @@ const getPackageName = pkg => {
   }
 }
 
+const getCircularReplacer = () => {
+  const seen = new WeakSet()
+  return (key, value) => {
+    if (typeof value === 'object' && value !== null) {
+      if (seen.has(value)) {
+        return '[cyclic reference]'
+      }
+      seen.add(value)
+    }
+    return value
+  }
+}
+
+const safeStringify = o => JSON.stringify(o, getCircularReplacer())
+
 module.exports = {
   print,
   resolveFromDir,
@@ -136,5 +151,6 @@ module.exports = {
   getInMemoryDb,
   safeId,
   isBotpressPackage,
-  getModuleShortname
+  getModuleShortname,
+  safeStringify
 }