Update packages, refactor, add serializers, fields disabling, new interface

Author: Michal Vlasák

.eslintignore

@@ -0,0 +1 @@
+coverage

.lintstagedrc

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

index.js

@@ -3,15 +3,38 @@
 // https://news.ycombinator.com/item?id=14209168
 // https://tools.ietf.org/html/rfc5424
 
+const _ = require('lodash');
 const pino = require('pino');
 const multistream = require('pino-multi-stream').multistream;
+const serializers = require('./serializers');
 
-const pretty = pino.pretty();
-pretty.pipe(process.stdout);
-const prettyErr = pino.pretty();
-prettyErr.pipe(process.stderr);
+// options.disableFields = ['error.stack'];
+
+const defaultLogger = (options = {}) => {
+    const pretty = pino.pretty();
+    pretty.pipe(process.stdout);
+    const prettyErr = pino.pretty();
+    prettyErr.pipe(process.stderr);
+
+    if (options.disableFields) {
+        _.forEach(serializers, (value, key) => {
+            const matcher = new RegExp(`^${key}.(.*)`);
+            const affectedFields = [];
+            options.disableFields.forEach(field => {
+                field.replace(matcher, (match, p1) => {
+                    affectedFields.push(p1);
+                });
+            });
+
+            if (affectedFields.length > 0) {
+                const newSerializer = obj => {
+                    return _.omit(value(obj), affectedFields);
+                };
+                serializers[key] = newSerializer;
+            }
+        });
+    }
 
-const loggerFactory = (moduleName, options = {}) => {
     const isProduction = process.env.NODE_ENV === 'production';
     const isTesting = process.env.NODE_ENV === 'test';
     let defaultLevel = 'debug';
@@ -36,12 +59,38 @@ const loggerFactory = (moduleName, options = {}) => {
         streams = options.streams;
     }
 
-    const logger = pino({ level: defaultLevel, timestamp: false, base: {} }, multistream(streams));
+    const logger = pino({ level: defaultLevel, timestamp: false, base: {}, serializers }, multistream(streams));
     logger.warning = logger.warn;
+
+    return logger;
+};
+
+let logger;
+
+const loggerFactory = data => {
+    let moduleName;
+    let options;
+    if (data) {
+        if (_.isString(data)) {
+            moduleName = data;
+        } else if (_.isObject(data)) {
+            options = data;
+        } else {
+            throw new TypeError(`Invalid argument of type ${typeof data}`);
+        }
+    }
+
+    if (!logger) {
+        logger = defaultLogger(options);
+    }
     if (!moduleName) {
         return logger;
     }
     return logger.child({ name: moduleName });
 };
 
-module.exports = loggerFactory;
+const factoryProxy = new Proxy(loggerFactory, {
+    get: (target, key) => target()[key],
+});
+
+module.exports = factoryProxy;

package.json

@@ -9,21 +9,24 @@
     "test-watch": "jest --watch --coverage",
     "lint": "eslint .",
     "pretty": "prettier --write '*.js'",
-    "precommit": "lint-staged && npm test"
+    "precommit": "lint-staged && npm test",
+    "check": "npm-check -i components -i config -i controllers -i enums -i errors -i middleware -i routes -i repositories -i services -i husky & exit 0"
   },
   "author": "Michal Vlasák <michal.vlasak@ackee.cz>",
   "license": "ISC",
   "dependencies": {
+    "lodash": "^4.17.5",
     "pino": "^4.13.0",
     "pino-multi-stream": "^3.1.2"
   },
   "devDependencies": {
-    "eslint": "4.17.0",
+    "eslint": "^4.18.2",
     "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",
+    "npm-check": "^5.5.2",
     "prettier": "^1.11.0",
     "split2": "^2.2.0"
   }

serializers.js

@@ -0,0 +1,57 @@
+const _ = require('lodash');
+
+/**
+ * Gets full URL from express Req object
+ * @param {Req} req
+ * @return {!string}
+ */
+const fullUrlFromReq = req => (req.get ? `${req.protocol}://${req.get('host')}${req.originalUrl}` : '');
+
+module.exports = {
+    error(obj) {
+        return {
+            message: _.get(obj, 'message'),
+            code: _.get(obj, 'code'),
+            stack: _.get(obj, 'stack'),
+            data: _.get(obj, 'data'),
+        };
+    },
+    processEnv(obj) {
+        return {
+            nodePath: _.get(obj, 'NODE_PATH'),
+            nodeEnv: _.get(obj, 'NODE_ENV'),
+        };
+    },
+    req(obj) {
+        const body = _.cloneDeep(_.get(obj, 'body'));
+        const query = _.cloneDeep(_.get(obj, 'query'));
+
+        if (_.get(body, 'password')) {
+            delete body.password;
+        }
+
+        if (_.get(query, 'password')) {
+            delete query.password;
+        }
+
+        if (_.get(body, 'passwordCheck')) {
+            delete body.passwordCheck;
+        }
+
+        if (_.get(query, 'passwordCheck')) {
+            delete query.passwordCheck;
+        }
+
+        return {
+            body,
+            query,
+            url: fullUrlFromReq(obj),
+            method: _.get(obj, 'method'),
+        };
+    },
+    res(obj) {
+        return {
+            out: _.get(obj, 'out'),
+        };
+    },
+};