feat(logger): add customError function

resolve EDITOR-1577

Author: Valetudox

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');
       }
     });
   }
@@ -39,6 +39,10 @@ class Logger {
     this.warn(action, Object.assign(this._getErrorDetails(error), data));
   }
 
+  customError(severity, action, error, data = {}) {
+    logMethodFactory(severity).bind(this)(action, Object.assign(this._getErrorDetails(error), data));
+  }
+
   timer() {
     return new Timer(this);
   }
@@ -67,7 +71,7 @@ class Logger {
       error_stack: this._shortenStackTrace(error.stack),
       error_message: error.message,
       error_data: this._shortenData(error.data)
-    }
+    };
   }
 }
 

src/logger/logger.spec.js

@@ -120,6 +120,61 @@ describe('Logger', function() {
     expect(logArguments.error_data.length).to.eql(3004);
   });
 
+  describe('#customError', function() {
+    it('should log error as the given severity with action', function() {
+      const error = new Error('failed');
+      error.data = { test: 'data' };
+
+      logger.customError('info', '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(30);
+      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).to.eql(JSON.stringify(error.data));
+    });
+
+    it('should not log error data when it is undefined', function() {
+      const error = new Error('failed');
+
+      logger.customError('warn', '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.customError('error', '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(50);
+      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() {
     it('should change format method', function() {
       const formattedOutput = '{"my":"method"}';