fix: Move axios error processing in LoggerService

src/Service/Logger.service.js

@@ -109,6 +109,54 @@ export default class LoggerService extends DependencyAwareClass {
     return this.winston;
   }
 
+  /**
+   * While handling an error, lambda wrapper should
+   * recognise axios errors and trim down the information.
+   *
+   * Keep the following keys:
+   * - message.config
+   * - message.message
+   * - message.response?.status
+   * - message.response?.data
+   *
+   * @param {object} error
+   */
+  static processAxiosError(error) {
+    const processed = {
+      config: error.config,
+      message: error.message,
+    };
+
+    // It's pretty common for axios errors
+    // to not have.response e.g.when there's
+    // a network error or timeout.
+    // These errors will have .request but not .response.
+    if (error.response) {
+      processed.response = {
+        status: error.response.status,
+        data: error.response.data,
+      };
+    }
+
+    return processed;
+  }
+
+  /**
+   * Transform the original message
+   * before it is passed to the winston logger
+   *
+   * @param {string|object} message
+   */
+  processMessage(message = '') {
+    let processed = message;
+
+    if (processed && processed.isAxiosError) {
+      processed = this.constructor.processAxiosError(processed);
+    }
+
+    return processed;
+  }
+
   /**
    * Log Error Message
    *
@@ -130,7 +178,7 @@ export default class LoggerService extends DependencyAwareClass {
       Epsagon.setError(error);
     }
 
-    this.logger.log('error', message, { error });
+    this.logger.log('error', message, { error: this.processMessage(error) });
     this.label('error', true);
     this.metric('error', 'error', true);
   }
@@ -150,7 +198,7 @@ export default class LoggerService extends DependencyAwareClass {
    * @param message string
    */
   info(message) {
-    this.logger.log('info', message);
+    this.logger.log('info', this.processMessage(message));
   }
 
   /**

src/Wrapper/LambdaWrapper.js

@@ -25,33 +25,10 @@ import ResponseModel from '../Model/Response.model';
 export const handleError = (di, error) => {
   const logger = di.get(DEFINITIONS.LOGGER);
 
-  let errorBody = error;
-
-  // While handling an error, lambda wrapper should
-  // recognise axios errors and trim down the information
-  if (errorBody.isAxiosError) {
-    // only keep error.config, error.response.status, error.response.data
-    errorBody = {
-      config: error.config,
-      message: error.message,
-    };
-
-    // It's pretty common for axios errors
-    // to not have.response e.g.when there's
-    // a network error or timeout.
-    // These errors will have .request but not .response.
-    if (error.response) {
-      errorBody.response = {
-        status: error.response.status,
-        data: error.response.data,
-      };
-    }
-  }
-
   if (error.raiseOnEpsagon || !error.code || error.code >= 500) {
-    logger.error(errorBody);
+    logger.error(error);
   } else {
-    logger.info(errorBody);
+    logger.info(error);
   }
 
   const responseDetails = {

tests/unit/Service/Logger.service.test.js

@@ -13,6 +13,16 @@ const getLogger = (event = getEvent, context = getContext) => new LoggerService(
 describe('Service/LoggerService', () => {
   const context = { invokedFunctionArn: 'my-function' };
 
+  const axiosResponses = {
+    UNDEFINED: undefined,
+    EMPTY: {},
+    HTTP_417: {
+      status: 417,
+      data: { data: 1 },
+      extra: 2,
+    },
+  };
+
   afterEach(() => jest.clearAllMocks());
 
   describe('constructor', () => {
@@ -55,4 +65,72 @@ describe('Service/LoggerService', () => {
       expect(Winston.createLogger).toHaveBeenCalledTimes(1);
     });
   });
+
+  describe('error', () => {
+    Object.entries(axiosResponses).forEach(([key, axiosResponse]) => {
+      it(`Trims down the axios error: ${key}`, () => {
+        const logger = getLogger();
+        const log = jest.fn();
+
+        jest.spyOn(logger, 'logger', 'get').mockReturnValue({ log });
+
+        const error = {
+          isAxiosError: true,
+          raiseOnEpsagon: true,
+          config: {
+            url: 'http://localhost:9999',
+            method: 'get',
+          },
+          extra: 1,
+          response: axiosResponse,
+          message: 'some-message',
+        };
+
+        logger.error(error);
+
+        const loggerCall = log.mock.calls[0][2].error;
+
+        expect(loggerCall).toMatchSnapshot();
+        expect('extra' in loggerCall).toEqual(false);
+
+        if (axiosResponse) {
+          expect('extra' in loggerCall.response).toEqual(false);
+        }
+      });
+    });
+  });
+
+  describe('info', () => {
+    Object.entries(axiosResponses).forEach(([key, axiosResponse]) => {
+      it(`Trims down the axios error: ${key}`, () => {
+        const logger = getLogger();
+        const log = jest.fn();
+
+        jest.spyOn(logger, 'logger', 'get').mockReturnValue({ log });
+
+        const error = {
+          isAxiosError: true,
+          raiseOnEpsagon: true,
+          config: {
+            url: 'http://localhost:9999',
+            method: 'get',
+          },
+          extra: 1,
+          response: axiosResponse,
+          message: 'some-message',
+        };
+
+        logger.info(error);
+
+        const loggerCall = log.mock.calls[0][1];
+
+        expect(loggerCall).toMatchSnapshot();
+        expect('extra' in loggerCall).toEqual(false);
+
+        if (axiosResponse) {
+          expect('extra' in loggerCall.response).toEqual(false);
+        }
+      });
+    });
+  });
 });

tests/unit/Service/__snapshots__/Logger.service.test.js.snap

@@ -0,0 +1,81 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Service/LoggerService error Trims down the axios error: EMPTY 1`] = `
+Object {
+  "config": Object {
+    "method": "get",
+    "url": "http://localhost:9999",
+  },
+  "message": "some-message",
+  "response": Object {
+    "data": undefined,
+    "status": undefined,
+  },
+}
+`;
+
+exports[`Service/LoggerService error Trims down the axios error: HTTP_417 1`] = `
+Object {
+  "config": Object {
+    "method": "get",
+    "url": "http://localhost:9999",
+  },
+  "message": "some-message",
+  "response": Object {
+    "data": Object {
+      "data": 1,
+    },
+    "status": 417,
+  },
+}
+`;
+
+exports[`Service/LoggerService error Trims down the axios error: UNDEFINED 1`] = `
+Object {
+  "config": Object {
+    "method": "get",
+    "url": "http://localhost:9999",
+  },
+  "message": "some-message",
+}
+`;
+
+exports[`Service/LoggerService info Trims down the axios error: EMPTY 1`] = `
+Object {
+  "config": Object {
+    "method": "get",
+    "url": "http://localhost:9999",
+  },
+  "message": "some-message",
+  "response": Object {
+    "data": undefined,
+    "status": undefined,
+  },
+}
+`;
+
+exports[`Service/LoggerService info Trims down the axios error: HTTP_417 1`] = `
+Object {
+  "config": Object {
+    "method": "get",
+    "url": "http://localhost:9999",
+  },
+  "message": "some-message",
+  "response": Object {
+    "data": Object {
+      "data": 1,
+    },
+    "status": 417,
+  },
+}
+`;
+
+exports[`Service/LoggerService info Trims down the axios error: UNDEFINED 1`] = `
+Object {
+  "config": Object {
+    "method": "get",
+    "url": "http://localhost:9999",
+  },
+  "message": "some-message",
+}
+`;

tests/unit/Wrapper/LambdaWrapper.test.js

@@ -58,48 +58,6 @@ describe('Wrapper/LambdaWrapper', () => {
         });
       });
     });
-
-    describe('Axios Errors', () => {
-      const axiosResponses = {
-        UNDEFINED: undefined,
-        EMPTY: {},
-        HTTP_417: {
-          status: 417,
-          data: { data: 1 },
-          extra: 2,
-        },
-      };
-
-      Object.entries(axiosResponses).forEach(([key, axiosResponse]) => {
-        it(`Trims down the axios error: ${key}`, () => {
-          const di = getMockedDi();
-          const logger = di.get(DEFINITIONS.LOGGER);
-
-          const error = {
-            isAxiosError: true,
-            raiseOnEpsagon: true,
-            config: {
-              url: 'http://localhost:9999',
-              method: 'get',
-            },
-            extra: 1,
-            response: axiosResponse,
-            message: 'some-message',
-          };
-
-          handleError(di, error);
-
-          const loggerCall = logger.error.mock.calls[0][0];
-
-          expect(loggerCall).toMatchSnapshot();
-          expect('extra' in loggerCall).toEqual(false);
-
-          if (axiosResponse) {
-            expect('extra' in loggerCall.response).toEqual(false);
-          }
-        });
-      });
-    });
   });
 
   describe('LambdaWrapper', () => {

tests/unit/Wrapper/__snapshots__/LambdaWrapper.test.js.snap

@@ -1,45 +1,5 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`Wrapper/LambdaWrapper handleError Axios Errors Trims down the axios error: EMPTY 1`] = `
-Object {
-  "config": Object {
-    "method": "get",
-    "url": "http://localhost:9999",
-  },
-  "message": "some-message",
-  "response": Object {
-    "data": undefined,
-    "status": undefined,
-  },
-}
-`;
-
-exports[`Wrapper/LambdaWrapper handleError Axios Errors Trims down the axios error: HTTP_417 1`] = `
-Object {
-  "config": Object {
-    "method": "get",
-    "url": "http://localhost:9999",
-  },
-  "message": "some-message",
-  "response": Object {
-    "data": Object {
-      "data": 1,
-    },
-    "status": 417,
-  },
-}
-`;
-
-exports[`Wrapper/LambdaWrapper handleError Axios Errors Trims down the axios error: UNDEFINED 1`] = `
-Object {
-  "config": Object {
-    "method": "get",
-    "url": "http://localhost:9999",
-  },
-  "message": "some-message",
-}
-`;
-
 exports[`Wrapper/LambdaWrapper handleError Generates a response object 1`] = `
 Object {
   "body": "{\\"data\\":{},\\"message\\":\\"unknown error\\"}",