fix(logger): do not stub console.log in tests (mocha uses it)

Author: bankyadam

src/logger/logger.js

@@ -22,7 +22,7 @@ class Logger {
   static _validate(options) {
     Object.keys(options).forEach(key => {
       if (!allowedKeys.includes(key)) {
-        throw new Error('Only the following keys are allowed: formatter, output')
+        throw new Error('Only the following keys are allowed: formatter, output');
       }
     });
   }
@@ -46,7 +46,7 @@ class Logger {
   _shortenStackTrace(stack) {
     return stack.length > STACK_TRACE_LIMIT
       ? stack.substring(0, STACK_TRACE_LIMIT) + ' ...'
-      : stack
+      : stack;
   }
 
   _shortenData(data) {
@@ -58,7 +58,7 @@ class Logger {
 
     return stringifiedData.length > DATA_LIMIT
       ? stringifiedData.substring(0, DATA_LIMIT) + ' ...'
-      : stringifiedData
+      : stringifiedData;
   }
 
   _getErrorDetails(error) {
@@ -67,7 +67,7 @@ class Logger {
       error_stack: this._shortenStackTrace(error.stack),
       error_message: error.message,
       error_data: this._shortenData(error.data)
-    }
+    };
   }
 }
 
@@ -94,13 +94,13 @@ const logMethodFactory = function(level) {
     );
 
     Logger.config.transformers.forEach((transform) => {
-      dataToLog = transform(dataToLog)
+      dataToLog = transform(dataToLog);
     });
 
     Logger.config.output(
       Logger.config.formatter(dataToLog)
     );
-  }
+  };
 };
 
 Logger.prototype.trace = logMethodFactory('trace');

src/logger/logger.spec.js

@@ -6,10 +6,11 @@ const consoleOutput = require('../output/console');
 
 describe('Logger', function() {
   let logger;
+  let outputStub;
 
   beforeEach(function() {
     logger = new Logger('mongo', true);
-    this.sandbox.stub(console, 'log');
+    outputStub = this.sandbox.stub(Logger.config, 'output');
   });
 
   afterEach(function() {
@@ -23,7 +24,7 @@ describe('Logger', function() {
   it('should call log info method when enabled', function() {
     logger.info('wedidit', { details: 'forever' });
 
-    const logArguments = JSON.parse(console.log.args[0]);
+    const logArguments = JSON.parse(Logger.config.output.args[0]);
     expect(logArguments.name).to.eql('mongo');
     expect(logArguments.action).to.eql('wedidit');
     expect(logArguments.level).to.eql(30);
@@ -35,7 +36,7 @@ describe('Logger', function() {
 
     logger.info('hi');
 
-    expect(console.log).not.to.have.been.called;
+    expect(Logger.config.output).not.to.have.been.called;
   });
 
   it('should not call log info method when disabled', function() {
@@ -55,7 +56,7 @@ describe('Logger', function() {
 
     logger.fromError('hi', error, { details: 'here' });
 
-    const logArguments = JSON.parse(console.log.args[0]);
+    const logArguments = JSON.parse(Logger.config.output.args[0]);
     expect(logArguments.name).to.eql('mongo');
     expect(logArguments.action).to.eql('hi');
     expect(logArguments.level).to.eql(50);
@@ -73,7 +74,7 @@ describe('Logger', function() {
 
     logger.warnFromError('hi', error, { details: 'here' });
 
-    const logArguments = JSON.parse(console.log.args[0]);
+    const logArguments = JSON.parse(Logger.config.output.args[0]);
     expect(logArguments.name).to.eql('mongo');
     expect(logArguments.action).to.eql('hi');
     expect(logArguments.level).to.eql(40);
@@ -90,7 +91,7 @@ describe('Logger', function() {
 
     logger.warnFromError('hi', error, { details: 'here' });
 
-    const logArguments = JSON.parse(console.log.args[0]);
+    const logArguments = JSON.parse(Logger.config.output.args[0]);
     expect(logArguments.name).to.eql('mongo');
     expect(logArguments.action).to.eql('hi');
     expect(logArguments.level).to.eql(40);
@@ -108,7 +109,7 @@ describe('Logger', function() {
 
     logger.warnFromError('hi', error, { details: 'here' });
 
-    const logArguments = JSON.parse(console.log.args[0]);
+    const logArguments = JSON.parse(Logger.config.output.args[0]);
     expect(logArguments.name).to.eql('mongo');
     expect(logArguments.action).to.eql('hi');
     expect(logArguments.level).to.eql(40);
@@ -132,7 +133,7 @@ describe('Logger', function() {
       logger.info('hi');
 
       expect(formatterStub).to.have.been.called;
-      expect(console.log).to.have.been.calledWith(formattedOutput);
+      expect(Logger.config.output).to.have.been.calledWith(formattedOutput);
     });
 
     it('should change output method', function() {
@@ -151,7 +152,7 @@ describe('Logger', function() {
           invalid: true
         });
         throw new Error('should throw');
-      } catch(e) {
+      } catch (e) {
         expect(e.message).to.eql('Only the following keys are allowed: formatter, output');
       }
     });
@@ -165,7 +166,7 @@ describe('Logger', function() {
 
       logger.info('hi');
 
-      const logArguments = JSON.parse(console.log.args[0]);
+      const logArguments = JSON.parse(Logger.config.output.args[0]);
       expect(logArguments.action).to.eql('hi');
       expect(logArguments.debug).to.eql(true);
     });