feat(middleware): added a default logging middleware

Author: Nicklas Utgaard

src/middleware-utils.ts

@@ -39,4 +39,29 @@ export default class MiddlewareUtils {
       });
     };
   }
+
+  static loggingMiddleware(): Middleware {
+    return (request, response) => {
+      // tslint:disable
+      console.groupCollapsed(`${request.method} ${request.url}`);
+      console.groupCollapsed('config');
+      console.log('queryParams', request.queryParams);
+      console.log('pathParams', request.pathParams);
+      console.log('body', request.body);
+      if (request.init) {
+        console.log('header', request.init.headers);
+      }
+      console.groupEnd();
+
+      try {
+        console.log('response', JSON.parse(response.body));
+      } catch (e) {
+        console.log('response', response);
+      }
+
+      console.groupEnd();
+      // tslint:enable
+      return response;
+    };
+  }
 }

test/console-mock.ts

@@ -0,0 +1,21 @@
+export default class ConsoleMock {
+  private static oldConsole = global.console;
+  private static newConsole = Object.create(ConsoleMock.oldConsole);
+
+  static setup() {
+    ConsoleMock.newConsole.trace = jest.fn();
+    ConsoleMock.newConsole.debug = jest.fn();
+    ConsoleMock.newConsole.log = jest.fn();
+    ConsoleMock.newConsole.warn = jest.fn();
+    ConsoleMock.newConsole.error = jest.fn();
+    ConsoleMock.newConsole.group = jest.fn();
+    ConsoleMock.newConsole.groupCollapsed = jest.fn();
+    ConsoleMock.newConsole.groupEnd = jest.fn();
+
+    global.console = ConsoleMock.newConsole;
+  }
+
+  static teardown() {
+    global.console = ConsoleMock.oldConsole;
+  }
+}

test/middleware-utils.test.ts

@@ -2,10 +2,18 @@ import { HandlerArgument, ResponseData } from '../src/types';
 import MathMock from './math-mock';
 import { JSONValue } from '../src/yet-another-fetch-mock';
 import MiddlewareUtils from '../src/middleware-utils';
+import ConsoleMock from './console-mock';
 
 describe('middleware-utils', () => {
-  beforeAll(MathMock.setup);
-  afterAll(MathMock.teardown);
+  beforeAll(() => {
+    MathMock.setup();
+    ConsoleMock.setup();
+  });
+
+  afterAll(() => {
+    MathMock.teardown();
+    ConsoleMock.teardown();
+  });
 
   it('should combine middlewares', done => {
     MathMock.fixRandom(0.2);
@@ -78,4 +86,11 @@ describe('middleware-utils', () => {
     const value: JSONValue = { data: null };
     done();
   });
+
+  it('should should log the request', () => {
+    const logging = MiddlewareUtils.loggingMiddleware();
+    logging({ init: { headers: {} } } as HandlerArgument, 'resp' as ResponseData);
+
+    expect(console.log).toBeCalledTimes(5);
+  });
 });