Merge branch 'change/no-undefined-serializers' into 'master'

Do not flatten process variable,

Closes #1

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

Author: smoliji

CHANGELOG.md

@@ -1,3 +1,10 @@
+### Added
+- log version of `ackee-node-logger` package being used to `pkgVersion` field
+
+### Changed
+- change default serializer for `process` object
+- do not log undefined and empty objects in default serializers
+
 ## [0.2.5] - 2018-09-10
 
 ### Added

serializers.js

@@ -9,22 +9,27 @@ const serializers = {
             data: _.get(obj, 'data'),
         };
     },
-    processEnv(obj) {
-        return {
-            nodePath: _.get(obj, 'NODE_PATH'),
-            nodeEnv: _.get(obj, 'NODE_ENV'),
-        };
+    process(obj) {
+        const nodePath = _.get(obj.env, 'NODE_PATH');
+        const nodeEnv = _.get(obj.env, 'NODE_ENV');
+        return _.omitBy(
+            _.defaultsDeep({ env: _.omitBy({ nodePath, nodeEnv }, _.isUndefined) }, _.omit(obj, 'env')),
+            val => _.isUndefined(val) || _.isEmpty(val)
+        );
     },
     req(obj) {
         const omitFields = ['password', 'passwordCheck'];
         const [body, query] = ['body', 'query'].map(name => _.omit(_.get(obj, name), omitFields));
 
-        return {
-            body,
-            query,
-            url: obj.originalUrl || obj.url,
-            method: _.get(obj, 'method'),
-        };
+        return _.omitBy(
+            {
+                body,
+                query,
+                url: obj.originalUrl || obj.url,
+                method: _.get(obj, 'method'),
+            },
+            val => _.isUndefined(val) || _.isEmpty(val)
+        );
     },
     res(obj) {
         return {

tests/serializers.test.js

@@ -9,6 +9,7 @@ beforeEach(() => {
 });
 
 test('Default serializers', () => {
+    const loggerWrites = jest.fn();
     const error = {
         message: 'Bad error',
         code: 400,
@@ -17,11 +18,13 @@ test('Default serializers', () => {
         devInfo: 'Lorem',
         userInfo: 'Ipsum',
     };
-    const processEnv = {
-        NODE_PATH: 'app:config',
-        NODE_ENV: 'local',
-        PATH: '.',
-        USER: 'root',
+    const process = {
+        env: {
+            NODE_PATH: 'app:config',
+            NODE_ENV: 'local',
+            PATH: '.',
+            USER: 'root',
+        },
     };
     const res = {
         out: 'Lorem ipsum',
@@ -51,9 +54,9 @@ test('Default serializers', () => {
                     write: (chunk, encoding, next) => {
                         const json = JSON.parse(chunk);
                         expect(json.error).toEqual(_.pick(error, ['message', 'code', 'stack', 'data']));
-                        expect(json.processEnv).toEqual({
-                            nodePath: processEnv.NODE_PATH,
-                            nodeEnv: processEnv.NODE_ENV,
+                        expect(json.process.env).toEqual({
+                            nodePath: process.env.NODE_PATH,
+                            nodeEnv: process.env.NODE_ENV,
                         });
                         expect(json.req).toEqual(
                             _.pick(
@@ -67,20 +70,64 @@ test('Default serializers', () => {
                             )
                         );
                         expect(json.res).toEqual(_.pick(res, ['out', 'time']));
+                        loggerWrites();
+                        next();
+                    },
+                }),
+            },
+        ],
+    });
+
+    logger.info({ error, process, req, res });
+    expect(loggerWrites).toBeCalled();
+});
+
+test('No extra fields are added in default serializers', () => {
+    const loggerWrites = jest.fn();
+    const error = {
+        devInfo: 'Lorem',
+        userInfo: 'Ipsum',
+    };
+    const process = {
+        stuff: {
+            NODE_PATH: 'app:config',
+            NODE_ENV: 'local',
+            PATH: '.',
+            USER: 'root',
+        },
+    };
+    const res = {
+        noteToSelf: 'Send to user',
+    };
+    const req = {
+        extraData: 'Some server data',
+    };
+
+    const logger = loggerFactory({
+        streams: [
+            {
+                stream: new stream.Writable({
+                    write: (chunk, encoding, next) => {
+                        const json = JSON.parse(chunk);
+                        expect(json.error).toEqual({});
+                        expect(json.res).toEqual({});
+                        expect(json.req).toEqual({});
+                        expect(json.process).toEqual(process);
+                        loggerWrites();
                         next();
                     },
                 }),
             },
         ],
     });
 
-    logger.info({ error, processEnv, req, res });
+    logger.info({ error, process, req, res });
+    expect(loggerWrites).toBeCalled();
 });
 
 test('Disable custom path', () => {
+    const loggerWrites = jest.fn();
     const req = {
-        body: {},
-        query: {},
         url: 'www.example.com',
         method: 'GET',
         extraData: 'Some server data',
@@ -94,6 +141,7 @@ test('Disable custom path', () => {
                     write: (chunk, encoding, next) => {
                         const json = JSON.parse(chunk);
                         expect(json.req).toEqual(_.pick(req, ['body', 'query', 'method']));
+                        loggerWrites();
                         next();
                     },
                 }),
@@ -102,12 +150,12 @@ test('Disable custom path', () => {
     });
 
     logger.info({ req });
+    expect(loggerWrites).toBeCalled();
 });
 
 test('Enable custom path', () => {
+    const loggerWrites = jest.fn();
     const req = {
-        body: {},
-        query: {},
         url: 'www.example.com',
         method: 'GET',
         extraData: 'Some server data',
@@ -121,6 +169,7 @@ test('Enable custom path', () => {
                     write: (chunk, encoding, next) => {
                         const json = JSON.parse(chunk);
                         expect(json.req).toEqual(_.pick(req, ['body', 'query', 'method', 'url', 'extraData']));
+                        loggerWrites();
                         next();
                     },
                 }),
@@ -129,4 +178,5 @@ test('Enable custom path', () => {
     });
 
     logger.info({ req });
+    expect(loggerWrites).toBeCalled();
 });