feat(logger): log data if exists with proper limit

Author: tt1991

src/logger/logger.js

@@ -2,7 +2,8 @@
 
 const config = require('../config');
 const continuationLocalStorage = require('cls-hooked');
-const STACK_TRACE_LIMIT = 4000;
+const STACK_TRACE_LIMIT = 3000;
+const DATA_LIMIT = 3000;
 const Timer = require('../timer/timer');
 const jsonFormatter = require('../formatter/json');
 const consoleOutput = require('../output/console');
@@ -44,27 +45,41 @@ class Logger {
   fromError(action, error, data = {}) {
     this.error(action, Object.assign({
       error_name: error.name,
-      error_stack: this._shortenStackTrace(error),
-      error_message: error.message
+      error_stack: this._shortenStackTrace(error.stack),
+      error_message: error.message,
+      error_data: this._shortenData(error.data)
     }, data));
   }
 
   warnFromError(action, error, data = {}) {
     this.warn(action, Object.assign({
       error_name: error.name,
-      error_stack: this._shortenStackTrace(error),
-      error_message: error.message
+      error_stack: this._shortenStackTrace(error.stack),
+      error_message: error.message,
+      error_data: this._shortenData(error.data)
     }, data));
   }
 
   timer() {
     return new Timer(this);
   }
 
-  _shortenStackTrace(error) {
-    return error.stack.length > STACK_TRACE_LIMIT
-      ? error.stack.substring(0, STACK_TRACE_LIMIT) + ' ...'
-      : error.stack
+  _shortenStackTrace(stack) {
+    return stack.length > STACK_TRACE_LIMIT
+      ? stack.substring(0, STACK_TRACE_LIMIT) + ' ...'
+      : stack
+  }
+
+  _shortenData(data) {
+    if (typeof data === 'undefined') {
+      return;
+    }
+
+    const stringifiedData = typeof data === 'object' ? JSON.stringify(data) : data;
+
+    return stringifiedData.length > DATA_LIMIT
+      ? stringifiedData.substring(0, DATA_LIMIT) + ' ...'
+      : stringifiedData
   }
 }
 

src/logger/logger.spec.js

@@ -63,6 +63,7 @@ describe('Logger', function() {
 
   it('should log error with action', function() {
     const error = new Error('failed');
+    error.data = { test: 'data' };
 
     logger.fromError('hi', error, { details: 'here' });
 
@@ -75,10 +76,12 @@ describe('Logger', function() {
     expect(logArguments.error_name).to.eql(error.name);
     expect(logArguments.error_stack).to.eql(error.stack);
     expect(logArguments.error_message).to.eql(error.message);
+    expect(logArguments.error_data).to.eql(JSON.stringify(error.data));
   });
 
   it('should log error as warning with action', function() {
     const error = new Error('failed');
+    error.data = { test: 'data' };
 
     logger.warnFromError('hi', error, { details: 'here' });
 
@@ -91,6 +94,42 @@ describe('Logger', function() {
     expect(logArguments.error_name).to.eql(error.name);
     expect(logArguments.error_stack).to.eql(error.stack);
     expect(logArguments.error_message).to.eql(error.message);
+    expect(logArguments.error_data).to.eql(JSON.stringify(error.data));
+  });
+
+  it('should not log error data when it is undefined', function() {
+    const error = new Error('failed');
+
+    logger.warnFromError('hi', error, { details: 'here' });
+
+    const logArguments = JSON.parse(console.log.args[0]);
+    expect(logArguments.name).to.eql('mongo');
+    expect(logArguments.action).to.eql('hi');
+    expect(logArguments.level).to.eql(40);
+    expect(logArguments.details).to.eql('here');
+
+    expect(logArguments.error_name).to.eql(error.name);
+    expect(logArguments.error_stack).to.eql(error.stack);
+    expect(logArguments.error_message).to.eql(error.message);
+    expect(logArguments).to.not.have.any.keys('error_data');
+  });
+
+  it('should log only 3000 character of data', function() {
+    const error = new Error('failed');
+    error.data = 'exactlyTen'.repeat(400);
+
+    logger.warnFromError('hi', error, { details: 'here' });
+
+    const logArguments = JSON.parse(console.log.args[0]);
+    expect(logArguments.name).to.eql('mongo');
+    expect(logArguments.action).to.eql('hi');
+    expect(logArguments.level).to.eql(40);
+    expect(logArguments.details).to.eql('here');
+
+    expect(logArguments.error_name).to.eql(error.name);
+    expect(logArguments.error_stack).to.eql(error.stack);
+    expect(logArguments.error_message).to.eql(error.message);
+    expect(logArguments.error_data.length).to.eql(3004);
   });
 
   describe('#configure', function() {