Merge pull request invisible-tech#48 from invisible-tech/pv/serialize…

…-logs

chore(devops): added serialization to logger for objects with circular deps

.gitignore

@@ -61,3 +61,6 @@ typings/
 ignore
 
 *.sublime-*
+
+# vscode history extension
+.history/

CHANGELOG.md

@@ -1,3 +1,6 @@
+*v2.3.0*
+> Fix: Improve performance by serializing objects that contain circular references
+
 *v2.1.2*
 > Internal: remove unneeded files
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@invisible/logger",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Invisible Logging Wrapper",
   "main": "index.js",
   "scripts": {

transports/console.js

@@ -3,6 +3,7 @@
 const moment = require('moment')
 const winston = require('winston')
 const assertLevel = require('./helpers/assertLevel')
+const serialize = require('./helpers/serialize')
 
 const {
   LOGGER_LEVEL = 'info',
@@ -18,6 +19,8 @@ module.exports = new (winston.transports.Console)({
   timestamp: () => moment().format(),
   formatter: options => {
     const { message } = options
+    // serialize objects such as SQL models by checking for toJSON
+    options.meta = serialize(options.meta)
     const meta = (options.meta && Object.keys(options.meta).length)
       ? `\n${JSON.stringify(options.meta, null, 2)}`
       : ''

transports/helpers/serialize.js

@@ -0,0 +1,11 @@
+'use strict'
+
+const serialize = meta => {
+  if (! meta || typeof meta === 'string') return meta
+  if (meta.toJSON) return JSON.parse(meta.toJSON())
+  Object.keys(meta).forEach(key => {
+    meta[key] = serialize(meta[key])
+  })
+  return meta
+}
+module.exports = serialize

transports/timber.js

@@ -5,6 +5,7 @@ const serializeError = require('serialize-error')
 const timber = require('timber')
 
 const assertLevel = require('./helpers/assertLevel')
+const serialize = require('./helpers/serialize')
 
 const {
   TIMBER_LEVEL = 'info',
@@ -22,6 +23,8 @@ module.exports = new (winston.transports.Console)({
   name: 'timber',
   level: TIMBER_LEVEL,
   formatter: options => {
+    // serialize objects such as SQL models by checking for toJSON
+    options.meta = serialize(options.meta)
     // When we log errors, options.message comes as blank and it causes errors
     const message = options.message || options.meta.message || 'No message'
     // Serialize eventual error objecs