Add config for environments, simple tests, simplify logs

Author: Michal Vlasák

.gitignore

@@ -1 +1,2 @@
 node_modules
+coverage

.lintstagedrc

@@ -1,4 +1,5 @@
 {
+  "ignore": ['**/coverage/**/*.js'],
   "linters": {
     "*.js": [
       "npm run pretty",

index.js

@@ -11,13 +11,33 @@ pretty.pipe(process.stdout);
 const prettyErr = pino.pretty();
 prettyErr.pipe(process.stderr);
 
-const simpleStreams = [{ level: 'trace', stream: pretty }, { level: 'error', stream: prettyErr }];
+const loggerFactory = (moduleName, options = {}) => {
+    const isProduction = process.env.NODE_ENV === 'production';
+    const isTesting = process.env.NODE_ENV === 'test';
+    let defaultLevel = 'debug';
 
-const logger = pino({ level: 'trace' }, multistream(simpleStreams));
+    if (isTesting) {
+        defaultLevel = 'silent';
+    }
+
+    if (options.defaultLevel) {
+        defaultLevel = options.defaultLevel;
+    }
 
-logger.warning = logger.warn;
+    let streams;
+    if (isProduction) {
+        streams = [{ level: defaultLevel, stream: process.stdout }, { level: 'warn', stream: process.stderr }];
+    } else {
+        // dev behavior = default
+        streams = [{ level: defaultLevel, stream: pretty }, { level: 'warn', stream: prettyErr }];
+    }
+
+    if (options.streams) {
+        streams = options.streams;
+    }
 
-const loggerFactory = moduleName => {
+    const logger = pino({ level: defaultLevel, timestamp: false, base: {} }, multistream(streams));
+    logger.warning = logger.warn;
     if (!moduleName) {
         return logger;
     }

package.json

@@ -5,8 +5,8 @@
   "main": "index.js",
   "scripts": {
     "lint-staged": "lint-staged",
-    "test": "jest",
-    "test-watch": "jest --watch",
+    "test": "jest --coverage",
+    "test-watch": "jest --watch --coverage",
     "lint": "eslint .",
     "pretty": "prettier --write '*.js'",
     "precommit": "lint-staged && npm test"
@@ -20,9 +20,11 @@
   "devDependencies": {
     "eslint": "4.17.0",
     "eslint-config-ackee": "^0.8.1",
+    "flush-write-stream": "^1.0.2",
     "husky": "^0.14.3",
     "jest": "^22.4.2",
     "lint-staged": "^7.0.0",
-    "prettier": "^1.11.0"
+    "prettier": "^1.11.0",
+    "split2": "^2.2.0"
   }
 }

tests/helper.js

@@ -0,0 +1,10 @@
+const split = require('split2');
+const writer = require('flush-write-stream');
+
+function redirect(func) {
+    const result = split(JSON.parse);
+    result.pipe(writer.obj(func));
+    return result;
+}
+
+exports.redirect = redirect;

tests/index.test.js

@@ -1,3 +1,42 @@
-test('empty', () => {
-    expect(true).toBe(true);
+const loggerFactory = require('..');
+const { redirect } = require('./helper');
+
+test('can create default logger', () => {
+    const logger = loggerFactory();
+    expect(logger).toBeDefined();
+});
+
+test('can create named logger', () => {
+    const logger = loggerFactory('myApp');
+    expect(logger).toBeDefined();
+});
+
+test('can use custom stream', () => {
+    const logger = loggerFactory('', {
+        streams: [
+            {
+                stream: redirect((chunk, enc, cb) => {
+                    expect(chunk.msg).toBe('Hello');
+                    cb();
+                }),
+            },
+        ],
+    });
+
+    logger.info('Hello');
+});
+
+test('can use warning level', () => {
+    const logger = loggerFactory('', {
+        streams: [
+            {
+                stream: redirect((chunk, enc, cb) => {
+                    expect(chunk.msg).toBe('Hello');
+                    cb();
+                }),
+            },
+        ],
+    });
+
+    logger.warning('Hello');
 });