Merge branch 'feature/ignore-http-methods' into 'master'

Add option to ignore certain HTTP methods

See merge request Backend/ackee-node-logger!4

Author: smoliji

CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.2.4] - 2018-09-06
+
+### Added
+- `options.ignoredHttpMethods` to ignore certain HTTP requests in express middleware
+
 ## [0.2.3] - 2018-09-06
 
 ### Fixed

README.md

@@ -97,6 +97,7 @@ Options override both default logger configuration and environment-specific conf
 - `defaultLevel` - set logger's minimal loglevel (default is `debug`)
 - `disableFields` - list of paths which will be omitted from the objects being logged (if any)
 - `enableFields` - list of paths which will not be omitted by default serializers from objects being logged
+- `ignoredHttpMethods` - list of HTTP methods which will not be logged by express logging middleware at all. Defaults to `['OPTIONS']`
 - `streams` - list of stream objects, which will be passed directly to [pino-multistream's multistream function](https://github.com/pinojs/pino-multi-stream#pinomsmultistreamstreams) instead of default `ackee-node-logger` stream
 - `pretty` - if set to `true`, logger will use [pino pretty human-readable logs](https://github.com/pinojs/pino/blob/master/docs/API.md#pretty). This option can be overriden by `streams`
 - `config` - object, which will be passed to underlying logger object. Right now, underlying logger is [pino](https://github.com/pinojs/pino), so for available options see [pino API docs](https://github.com/pinojs/pino/blob/master/docs/API.md#pinooptions-stream)

express.js

@@ -14,6 +14,9 @@ const expressMiddleware = function(req, response, next) {
     });
     onFinished(response, (err, res) => {
         const error = res[Symbol.for('error')];
+        if (this.options.ignoredHttpMethods.includes(req.method)) {
+            return;
+        }
         if (error) {
             this.error({ error, req, res, ackId: req.ackId }, `${reqInfo} - Error handler at the end of app`);
         } else if (res.out) {

index.js

@@ -69,6 +69,10 @@ const defaultLogger = (options = {}) => {
         ];
     }
 
+    if (!options.ignoredHttpMethods) {
+        options.ignoredHttpMethods = ['OPTIONS'];
+    }
+
     const logger = pino(
         _.merge(
             {
@@ -83,6 +87,7 @@ const defaultLogger = (options = {}) => {
         multistream(streams)
     );
     logger.warning = logger.warn;
+    logger.options = options;
 
     // Add maxLevel support to pino-multi-stream
     // This could be replaced with custom pass-through stream being passed to multistream, which would filter the messages

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ackee-node-logger",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "Ackee Node Logger",
   "main": "index.js",
   "scripts": {

tests/index.test.js

@@ -21,13 +21,15 @@ test('can create named logger', () => {
 });
 
 test('can use custom stream', () => {
+    const loggerWrites = jest.fn();
     const logger = loggerFactory({
         streams: [
             {
                 stream: new stream.Writable({
                     write: (chunk, encoding, next) => {
                         const json = JSON.parse(chunk);
                         expect(json.message).toBe('Hello');
+                        loggerWrites();
                         next();
                     },
                 }),
@@ -36,9 +38,11 @@ test('can use custom stream', () => {
     });
 
     logger.info('Hello');
+    expect(loggerWrites).toBeCalled();
 });
 
 test('can use warning level', () => {
+    const loggerWrites = jest.fn();
     const logger = loggerFactory({
         streams: [
             {
@@ -47,6 +51,7 @@ test('can use warning level', () => {
                         const json = JSON.parse(chunk);
                         expect(json.message).toBe('Hello');
                         expect(json.level).toBe(levels.warn);
+                        loggerWrites();
                         next();
                     },
                 }),
@@ -55,6 +60,7 @@ test('can use warning level', () => {
     });
 
     logger.warning('Hello');
+    expect(loggerWrites).toBeCalled();
 });
 
 test('express binds', () => {
@@ -64,3 +70,74 @@ test('express binds', () => {
     app.use(logger.express);
     return request.get('/');
 });
+
+test('GET requests are logged by default', () => {
+    const loggerWrites = jest.fn();
+    const logger = loggerFactory({
+        streams: [
+            {
+                stream: new stream.Writable({
+                    write: (chunk, encoding, next) => {
+                        const json = JSON.parse(chunk);
+                        expect(json.req.method).toBe('GET');
+                        loggerWrites();
+                        next();
+                    },
+                }),
+            },
+        ],
+    });
+    const app = express();
+    const request = supertest(app);
+    app.use(logger.express);
+    return request.get('/').then(() => {
+        expect(loggerWrites).toBeCalled();
+    });
+});
+
+test('OPTIONS requests are ignored by default', () => {
+    const loggerWrites = jest.fn();
+    const logger = loggerFactory({
+        streams: [
+            {
+                stream: new stream.Writable({
+                    write: (chunk, encoding, next) => {
+                        loggerWrites();
+                        next();
+                    },
+                }),
+            },
+        ],
+    });
+    const app = express();
+    const request = supertest(app);
+    app.use(logger.express);
+    return request.options('/').then(() => {
+        expect(loggerWrites).not.toBeCalled();
+    });
+});
+
+['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS', 'HEAD'].forEach(method => {
+    test(`${method} HTTP method can be ignored by options`, () => {
+        const loggerWrites = jest.fn();
+        const logger = loggerFactory({
+            streams: [
+                {
+                    stream: new stream.Writable({
+                        write: (chunk, encoding, next) => {
+                            loggerWrites();
+                            next();
+                        },
+                    }),
+                },
+            ],
+            ignoredHttpMethods: [method],
+        });
+        const app = express();
+        const request = supertest(app);
+        app.use(logger.express);
+        return request[method.toLowerCase()]('/').then(() => {
+            expect(loggerWrites).not.toBeCalled();
+        });
+    });
+});