fix(error): limit stack trace size

Author: sonicoder86

bin/json-logger.js

@@ -1,7 +1,8 @@
 #! /usr/bin/env node
 'use strict';
-let eventStream = require('event-stream');
-let transformLine = require('../src/output/transform/transform');
+
+const eventStream = require('event-stream');
+const transformLine = require('../src/output/transform/transform');
 
 process.stdin.setEncoding('utf8');
 process.stdin

package-lock.json

@@ -1,7 +1,8 @@
 'use strict';
-let chalk = require('chalk');
 
-let levels = {
+const chalk = require('chalk');
+
+const levels = {
   trace: {
     number: 10,
     name: 'TRACE'
@@ -28,9 +29,9 @@ let levels = {
   },
 };
 
-let availableLevels = Object.keys(levels);
+const availableLevels = Object.keys(levels);
 
-let coloredNames = {};
+const coloredNames = {};
 availableLevels.forEach((levelName) => {
   coloredNames[levels[levelName].number] = levels[levelName].name;
 });

src/config.js

@@ -3,8 +3,8 @@
 function isNamespaceEnabled(availableNamespaces, namespace) {
   availableNamespaces = availableNamespaces.split(/[\s,]+/);
   let enabled = false;
-  let adds = [];
-  let skips = [];
+  const adds = [];
+  const skips = [];
 
   availableNamespaces.forEach(function(name) {
     if (!name) {

src/enabled/enabled.js

@@ -1,5 +1,6 @@
 'use strict';
-let isNamespaceEnabled = require('./enabled');
+
+const isNamespaceEnabled = require('./enabled');
 
 describe('isNamespaceAvailable', function() {
   it('should enable when variables only contain one', function() {
@@ -21,7 +22,7 @@ describe('isNamespaceAvailable', function() {
   });
 
   it('should allow multiple available namespaces', function() {
-    let availableNamespaces = 'mongo,redis';
+    const availableNamespaces = 'mongo,redis';
 
     expect(isNamespaceEnabled(
       availableNamespaces, 'mongo'

src/enabled/enabled.spec.js

@@ -1,6 +1,7 @@
 'use strict';
-let logFactory = require('../index');
-let Logger = require('./logger/logger');
+
+const logFactory = require('../index');
+const Logger = require('./logger/logger');
 
 describe('LogFactory', function() {
   beforeEach(function() {
@@ -12,14 +13,14 @@ describe('LogFactory', function() {
   });
 
   it('should return an enabled log instance when env variable is set to same', function() {
-    let logger = logFactory('mongo');
+    const logger = logFactory('mongo');
 
     expect(logger).to.be.an.instanceOf(Logger);
     expect(logger.enabled).to.be.true;
   });
 
   it('should return a disabled log instance when different', function() {
-    let logger = logFactory('redis');
+    const logger = logFactory('redis');
 
     expect(logger).to.be.an.instanceOf(Logger);
     expect(logger.enabled).to.be.false;
@@ -28,7 +29,7 @@ describe('LogFactory', function() {
   it('should be mockable through public interface', function() {
     this.sandbox.stub(logFactory.Logger.prototype, 'info');
 
-    let logger = logFactory('mongo');
+    const logger = logFactory('mongo');
     logger.info('hello');
 
     expect(logFactory.Logger.prototype.info).to.have.been.calledWith('hello');

src/index.spec.js

@@ -1,8 +1,8 @@
 'use strict';
 
-let config = require('../config');
+const config = require('../config');
 const continuationLocalStorage = require('cls-hooked');
-
+const STACK_TRACE_LIMIT = 4000;
 
 let logMethodFactory = function(level) {
   return function(action, data) {
@@ -35,10 +35,16 @@ class Logger {
   fromError(action, error, options = {}) {
     this.error(action, Object.assign({
       error_name: error.name,
-      error_stack: error.stack,
+      error_stack: this._shortenStackTrace(error),
       error_message: error.message
     }, options));
   }
+
+  _shortenStackTrace(error) {
+    return error.stack.length > STACK_TRACE_LIMIT
+      ? error.stack.substring(0, STACK_TRACE_LIMIT) + ' ...'
+      : error.stack
+  }
 }
 
 Logger.prototype.trace = logMethodFactory('trace');

src/logger/logger.js

@@ -1,5 +1,6 @@
 'use strict';
-let Logger = require('./logger');
+
+const Logger = require('./logger');
 const continuationLocalStorage = require('cls-hooked');
 
 describe('Logger', function() {
@@ -13,21 +14,21 @@ describe('Logger', function() {
   it('should call log info method when enabled', function() {
     logger.info('wedidit', { details: 'forever' });
 
-    let logArguments = JSON.parse(console.log.args[0]);
+    const logArguments = JSON.parse(console.log.args[0]);
     expect(logArguments.name).to.eql('mongo');
     expect(logArguments.action).to.eql('wedidit');
     expect(logArguments.level).to.eql(30);
     expect(logArguments.details).to.eql('forever');
   });
 
   it('should log prequest id if there is namespace present', function() {
-    let namespace = continuationLocalStorage
+    const namespace = continuationLocalStorage
       .createNamespace('session');
 
     namespace.run(function(){
       namespace.set('request_id', 'uid');
       logger.info('wedidit');
-      let logArguments = JSON.parse(console.log.args[0]);
+      const logArguments = JSON.parse(console.log.args[0]);
       expect(logArguments.request_id).to.eql('uid');
     });
   });
@@ -41,11 +42,11 @@ describe('Logger', function() {
   });
 
   it('should log error with action', function() {
-    let error = new Error('failed');
+    const error = new Error('failed');
 
     logger.fromError('hi', error, { details: 'here' });
 
-    let logArguments = JSON.parse(console.log.args[0]);
+    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(50);

src/logger/logger.spec.js

@@ -1,9 +1,10 @@
 'use strict';
-let chalk = require('chalk');
 
-let colors = ['cyan', 'magenta', 'grey', 'blue', 'green', 'yellow', 'white', 'red'];
+const chalk = require('chalk');
+
+const colors = ['cyan', 'magenta', 'grey', 'blue', 'green', 'yellow', 'white', 'red'];
+const names = {};
 let colorCounter = 0;
-let names = {};
 
 module.exports = function colorName(name) {
   if (!names[name]) {

src/output/color-name/color-name.js

@@ -1,6 +1,6 @@
 'use strict';
 
-let colorName = require('./color-name');
+const colorName = require('./color-name');
 
 describe('colorName', function() {
   it('should pick the first color for the name', function() {
@@ -12,8 +12,8 @@ describe('colorName', function() {
   });
 
   it('should add different colors for different names', function() {
-    let firstName = colorName('mongo');
-    let secondName = colorName('redis');
+    const firstName = colorName('mongo');
+    const secondName = colorName('redis');
 
     expect(secondName.replace('redis', 'mongo')).not.to.eql(firstName);
   });