Merge branch 'bugfix/simple-tests' into 'master'

Fix tests and add serializer tests

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

Author: smoliji

index.js

@@ -2,18 +2,9 @@ const _ = require('lodash');
 const pino = require('pino');
 const multistream = require('pino-multi-stream').multistream;
 const serializers = require('./serializers');
+const levels = require('./levels');
 const { expressMiddleware, expressErrorMiddleware } = require('./express');
 
-const levels = {
-    silent: Infinity,
-    fatal: 60,
-    error: 50,
-    warn: 40,
-    info: 30,
-    debug: 20,
-    trace: 10,
-};
-
 // This is a custom slightly edited version of pino-multistream's wirte method, whch adds support for maximum log level
 // The original version was pino-multistream 3.1.2 (commit 71d98ae) - https://github.com/pinojs/pino-multi-stream/blob/71d98ae191e02c56e39e849d2c30d59c8c6db1b9/multistream.js#L43
 const maxLevelWrite = function(data) {

levels.js

@@ -0,0 +1,13 @@
+const levels = {
+    silent: Infinity,
+    fatal: 60,
+    error: 50,
+    warn: 40,
+    info: 30,
+    debug: 20,
+    trace: 10,
+};
+
+module.exports = {
+    levels,
+};

tests/helper.js

@@ -1,7 +1,14 @@
-const loggerFactory = require('..');
-const { redirect } = require('./helper');
 const express = require('express');
 const supertest = require('supertest');
+const stream = require('stream');
+const { levels } = require('../levels');
+
+let loggerFactory;
+
+beforeEach(() => {
+    jest.resetModules();
+    loggerFactory = require('..'); // eslint-disable-line global-require
+});
 
 test('can create default logger', () => {
     const logger = loggerFactory();
@@ -14,12 +21,15 @@ test('can create named logger', () => {
 });
 
 test('can use custom stream', () => {
-    const logger = loggerFactory('', {
+    const logger = loggerFactory({
         streams: [
             {
-                stream: redirect((chunk, enc, cb) => {
-                    expect(chunk.msg).toBe('Hello');
-                    cb();
+                stream: new stream.Writable({
+                    write: (chunk, encoding, next) => {
+                        const json = JSON.parse(chunk);
+                        expect(json.message).toBe('Hello');
+                        next();
+                    },
                 }),
             },
         ],
@@ -29,12 +39,16 @@ test('can use custom stream', () => {
 });
 
 test('can use warning level', () => {
-    const logger = loggerFactory('', {
+    const logger = loggerFactory({
         streams: [
             {
-                stream: redirect((chunk, enc, cb) => {
-                    expect(chunk.msg).toBe('Hello');
-                    cb();
+                stream: new stream.Writable({
+                    write: (chunk, encoding, next) => {
+                        const json = JSON.parse(chunk);
+                        expect(json.message).toBe('Hello');
+                        expect(json.level).toBe(levels.warn);
+                        next();
+                    },
                 }),
             },
         ],

tests/index.test.js

@@ -0,0 +1,132 @@
+const _ = require('lodash');
+const stream = require('stream');
+
+let loggerFactory;
+
+beforeEach(() => {
+    jest.resetModules();
+    loggerFactory = require('..'); // eslint-disable-line global-require
+});
+
+test('Default serializers', () => {
+    const error = {
+        message: 'Bad error',
+        code: 400,
+        stack: 'Detailed stack',
+        data: { user: 1 },
+        devInfo: 'Lorem',
+        userInfo: 'Ipsum',
+    };
+    const processEnv = {
+        NODE_PATH: 'app:config',
+        NODE_ENV: 'local',
+        PATH: '.',
+        USER: 'root',
+    };
+    const res = {
+        out: 'Lorem ipsum',
+        time: 14,
+        noteToSelf: 'Send to user',
+    };
+    const req = {
+        query: {
+            password: '1234',
+            passwordCheck: '1234',
+            search: 'my cat',
+        },
+        body: {
+            password: '1234',
+            passwordCheck: '1234',
+            catName: 'Cersei',
+        },
+        url: 'www.example.com',
+        method: 'GET',
+        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(_.pick(error, ['message', 'code', 'stack', 'data']));
+                        expect(json.processEnv).toEqual({
+                            nodePath: processEnv.NODE_PATH,
+                            nodeEnv: processEnv.NODE_ENV,
+                        });
+                        expect(json.req).toEqual(
+                            _.pick(
+                                _.omit(req, [
+                                    'body.password',
+                                    'body.passwordCheck',
+                                    'query.password',
+                                    'query.passwordCheck',
+                                ]),
+                                ['url', 'body', 'query', 'method']
+                            )
+                        );
+                        expect(json.res).toEqual(_.pick(res, ['out', 'time']));
+                        next();
+                    },
+                }),
+            },
+        ],
+    });
+
+    logger.info({ error, processEnv, req, res });
+});
+
+test('Disable custom path', () => {
+    const req = {
+        body: {},
+        query: {},
+        url: 'www.example.com',
+        method: 'GET',
+        extraData: 'Some server data',
+    };
+
+    const logger = loggerFactory({
+        disableFields: ['req.url'],
+        streams: [
+            {
+                stream: new stream.Writable({
+                    write: (chunk, encoding, next) => {
+                        const json = JSON.parse(chunk);
+                        expect(json.req).toEqual(_.pick(req, ['body', 'query', 'method']));
+                        next();
+                    },
+                }),
+            },
+        ],
+    });
+
+    logger.info({ req });
+});
+
+test('Enable custom path', () => {
+    const req = {
+        body: {},
+        query: {},
+        url: 'www.example.com',
+        method: 'GET',
+        extraData: 'Some server data',
+    };
+
+    const logger = loggerFactory({
+        enableFields: ['req.extraData'],
+        streams: [
+            {
+                stream: new stream.Writable({
+                    write: (chunk, encoding, next) => {
+                        const json = JSON.parse(chunk);
+                        expect(json.req).toEqual(_.pick(req, ['body', 'query', 'method', 'url', 'extraData']));
+                        next();
+                    },
+                }),
+            },
+        ],
+    });
+
+    logger.info({ req });
+});