Use deep version of pick, add header picking and tests

Author: Michal Vlasák

package-lock.json

@@ -23,10 +23,10 @@
     "lodash.isempty": "^4.4.0",
     "lodash.isobject": "^3.0.2",
     "lodash.isstring": "^4.0.1",
-    "lodash.pick": "^4.4.0",
     "omit-deep": "^0.3.0",
     "on-finished": "^2.3.0",
     "on-headers": "^1.0.1",
+    "pick-deep": "^1.0.0",
     "pino": "^4.13.0",
     "pino-multi-stream": "3.1.2"
   },
@@ -37,10 +37,14 @@
     "flush-write-stream": "^1.0.2",
     "husky": "^0.14.3",
     "jest": "^22.4.2",
+    "jest-expect-message": "^1.0.1",
     "lint-staged": "^7.0.0",
     "npm-check": "^5.5.2",
     "prettier": "^1.11.0",
     "split2": "^2.2.0",
     "supertest": "^3.1.0"
+  },
+  "jest": {
+    "setupTestFrameworkScriptFile": "jest-expect-message"
   }
 }

package.json

@@ -1,5 +1,5 @@
 const forEach = require('lodash.foreach');
-const pick = require('lodash.pick');
+const pick = require('pick-deep');
 const { removeEmpty } = require('./utils');
 const omit = require('omit-deep');
 
@@ -24,6 +24,7 @@ const serializers = {
         return removeEmpty(Object.assign({}, filteredEnv, rest));
     },
     req(obj) {
+        const pickHeaders = ['x-deviceid', 'authorization', 'user-agent'];
         const [body, query] = ['body', 'query'].map(name => {
             const source = obj[name];
             if (source) {
@@ -39,6 +40,7 @@ const serializers = {
             query,
             url: obj.originalUrl || obj.url,
             method: obj.method,
+            headers: pick(obj.headers, pickHeaders),
         });
     },
     res(obj) {

serializers.js

@@ -1,6 +1,8 @@
-const pick = require('lodash.pick');
+const pick = require('pick-deep');
 const omitDeep = require('omit-deep');
 const stream = require('stream');
+const express = require('express');
+const supertest = require('supertest');
 
 let loggerFactory;
 
@@ -172,3 +174,68 @@ test('Enable custom path', () => {
     logger.info({ req });
     expect(loggerWrites).toBeCalled();
 });
+
+test.only('Some express headers are enabled by default', () => {
+    const loggerWrites = jest.fn();
+    const logger = loggerFactory({
+        streams: [
+            {
+                stream: new stream.Writable({
+                    write: (chunk, encoding, next) => {
+                        const json = JSON.parse(chunk);
+                        const validHeaders = ['x-deviceid', 'authorization', 'user-agent'];
+                        validHeaders.forEach(header =>
+                            expect(json.req.headers[header], `${header} header should be defined`).toBeDefined()
+                        );
+                        Object.keys(json.req.headers).forEach(header =>
+                            expect(validHeaders.includes(header), `${header} header should not be defined`).toBe(true)
+                        );
+                        loggerWrites();
+                        next();
+                    },
+                }),
+            },
+        ],
+    });
+    const app = express();
+    const request = supertest(app);
+    app.use(logger.express);
+    return request
+        .get('/')
+        .set('x-deviceid', '12345abcde')
+        .set('Authorization', 'Basic pass')
+        .set('User-Agent', 'Jest tests')
+        .set('Age', 100)
+        .then(() => {
+            expect(loggerWrites).toBeCalled();
+        });
+});
+
+test.only('Express fields and headers can be enabled', () => {
+    const loggerWrites = jest.fn();
+    const logger = loggerFactory({
+        enableFields: ['req.protocol', 'req.headers.host'],
+        streams: [
+            {
+                stream: new stream.Writable({
+                    write: (chunk, encoding, next) => {
+                        const json = JSON.parse(chunk);
+                        expect(json.req.protocol).toBe('http');
+                        expect(json.req.headers.host).toBe('localhost');
+                        loggerWrites();
+                        next();
+                    },
+                }),
+            },
+        ],
+    });
+    const app = express();
+    const request = supertest(app);
+    app.use(logger.express);
+    return request
+        .get('/')
+        .set('host', 'localhost')
+        .then(() => {
+            expect(loggerWrites).toBeCalled();
+        });
+});