Merge pull request #4 from emartech/axios

feat(logger): display request/response details for Axios errors

Author: Valetudox

README.md

@@ -89,7 +89,7 @@ Same as info with fatal log level.
 ##### JsonLogger.prototype.fromError(action, data)
 
 Displays an error object which formatted to fit into one line.
-The displayed line contains the stack trace, the name and the message of the error.
+The displayed line contains the stack trace, the name and the message of the error (for Axios errors, also request and response details).
 The log level defaults to error.
 
 ```javascript
@@ -157,7 +157,7 @@ You need to use the middlewares of `@emartech/cls-adapter` and add its transform
 This way it will log the request identifier coming from the header field (`X-Request-Id`) to every log line 
 where the called function is originating from the route handler.
 
-For automatting 
+For automating 
 
 ```javascript
 const Koa = require('koa');

src/logger/logger.js

@@ -66,12 +66,22 @@ class Logger {
   }
 
   _getErrorDetails(error) {
-    return {
+    const details = {
       error_name: error.name,
       error_stack: this._shortenStackTrace(error.stack),
       error_message: error.message,
       error_data: this._shortenData(error.data)
     };
+
+    if (error.isAxiosError) {
+      details.request_method = error.config.method;
+      details.request_url = error.config.url;
+      details.response_status = error.response.status;
+      details.response_status_text = error.response.statusText;
+      details.response_data = this._shortenData(error.response.data);
+    }
+
+    return details;
   }
 }
 

src/logger/logger.spec.js

@@ -121,6 +121,36 @@ describe('Logger', function() {
     expect(logArguments.error_data.length).to.eql(3004);
   });
 
+  it('should log request/response details for Axios-like error objects', function() {
+    const error = new Error('Request failed with status code 500');
+    error.isAxiosError = true;
+    error.response = {
+      status: 500,
+      statusText: 'Something horrible happened',
+      data: { useful_detail: 'important info' }
+    };
+    error.config = {
+      url: 'http://amazinghost.com/beautiful-path',
+      method: 'get'
+    };
+
+    logger.fromError('hi', error, { details: 'here' });
+
+    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);
+
+    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.request_method).to.eql(error.config.method);
+    expect(logArguments.request_url).to.eql(error.config.url);
+    expect(logArguments.response_status).to.eql(error.response.status);
+    expect(logArguments.response_status_text).to.eql(error.response.statusText);
+    expect(logArguments.response_data).to.eql(JSON.stringify(error.response.data));
+  });
+
   describe('#customError', function() {
     it('should log error as the given severity with action', function() {
       const error = new Error('failed');