winston-middleware 1.3.1 → 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,28 @@
+## 2.0.0
+#### Breaking changes
+* Make winston a peer dependency. `npm install --save winston` if you haven't already.
+* `expressFormat` has no color by default. Add `colorize: true` to winston-middleware
+  options to enable the previous colorized output. ([#86](https://github.com/bithavoc/winston-middleware/issues/86))
+* Drop support for inherited properties on the object provided to the `baseMeta` option. This is unlikely to actually break anyone's real-world setup.
+
+## 1.4.2
+* Upgrade winston to 1.1 ([#114](https://github.com/bithavoc/winston-middleware/issues/114))
+
+## 1.4.1
+* Don't throw exception on invalid JSON in response body ([#112](https://github.com/bithavoc/winston-middleware/issues/112))
+
+## 1.4.0
+* Allow custom log level for error logger ([#111](https://github.com/bithavoc/winston-middleware/pull/111))
+
+## 1.3.1
+* underscore -> lodash ([#88](https://github.com/bithavoc/winston-middleware/issues/88))
+
+## 1.3.0
+* Allow custom status levels ([#102](https://github.com/bithavoc/winston-middleware/pull/102))
+* Add per-instance equivalents of all global white/blacklists ([#105](https://github.com/bithavoc/winston-middleware/pull/105))
+* Allow user to override module-level whitelists and functions without having to worry about using the right object reference ([#92](https://github.com/bithavoc/winston-middleware/issues/92))
+
+## 1.2.0
+* Add `baseMeta` and `metaField` options ([#91](https://github.com/bithavoc/winston-middleware/pull/91))
+* Document `requestFilter` and `responseFilter` options
+* Drop support for node 0.6 and 0.8

package/Readme.md

@@ -5,13 +5,9 @@
 
 ## Installation
 
-Newcomers should start with the latest branch which makes use of winston 1.x.x and supports node >= 0.10:
+    npm install winston winston-middleware
 
-    npm install winston-middleware
-
-If you're already using winston-middleware, and want to stick with the stable version based on winston 0.9.x, you should instead do:
-
-    npm install winston-middleware@0.x.x --save
+(supports node >= 0.10)
 
 ## Usage
 
@@ -25,8 +21,8 @@ In `package.json`:
 {
   "dependencies": {
     "...": "...",
-    "winston": "0.6.x",
-    "winston-middleware": "0.2.x",
+    "winston": "^2.0.0",
+    "winston-middleware": "^2.0.0",
     "...": "..."
   }
 }
@@ -55,8 +51,8 @@ Use `expressWinston.logger(options)` to create a middleware to log your HTTP req
       ],
       meta: true, // optional: control whether you want to log the meta data about the request (default to true)
       msg: "HTTP {{req.method}} {{req.url}}", // optional: customize the default logging message. E.g. "{{res.statusCode}} {{req.method}} {{res.responseTime}}ms {{req.url}}"
-      expressFormat: true, // Use the default Express/morgan request formatting, with the same colors. Enabling this will override any msg and colorStatus if true. Will only output colors on transports with colorize set to true
-      colorStatus: true, // Color the status code, using the Express/morgan color palette (default green, 3XX cyan, 4XX yellow, 5XX red). Will not be recognized if expressFormat is true
+      expressFormat: true, // Use the default Express/morgan request formatting. Enabling this will override any msg if true. Will only output colors with colorize set to true
+      colorize: true, // Color the text and status code, using the Express/morgan color palette (text: gray, status: default green, 3XX cyan, 4XX yellow, 5XX red).
       ignoreRoute: function (req, res) { return false; } // optional: allows to skip some log messages based on request and/or response
     }));
 
@@ -70,8 +66,8 @@ Use `expressWinston.logger(options)` to create a middleware to log your HTTP req
     winstonInstance: <WinstonLogger>, // a winston logger instance. If this is provided the transports option is ignored.
     level: String, // log level to use, the default is "info".
     msg: String // customize the default logging message. E.g. "{{res.statusCode}} {{req.method}} {{res.responseTime}}ms {{req.url}}", "HTTP {{req.method}} {{req.url}}".
-    expressFormat: Boolean, // Use the default Express/morgan request formatting, with the same colors. Enabling this will override any msg and colorStatus if true. Will only output colors on transports with colorize set to true
-    colorStatus: Boolean, // Color the status code, using the Express/morgan color palette (default green, 3XX cyan, 4XX yellow, 5XX red). Will not be recognized if expressFormat is true
+    expressFormat: Boolean, // Use the default Express/morgan request formatting. Enabling this will override any msg if true. Will only output colors when colorize set to true
+    colorize: Boolean, // Color the text and status code, using the Express/morgan color palette (text: gray, status: default green, 3XX cyan, 4XX yellow, 5XX red).
     meta: Boolean, // control whether you want to log the meta data about the request (default to true).
     baseMeta: Object, // default meta data to be added to log, this will be merged with the meta data.
     metaField: String, // if defined, the meta data will be added in this field instead of the meta root object.
@@ -118,6 +114,7 @@ The logger needs to be added AFTER the express router(`app.router)`) and BEFORE
     metaField: String, // if defined, the meta data will be added in this field instead of the meta root object.
     requestFilter: function (req, propName) { return req[propName]; } // A function to filter/return request values, defaults to returning all values allowed by whitelist. If the function returns undefined, the key/value will not be included in the meta.
     requestWhitelist: [String] // Array of request properties to log. Overrides global requestWhitelist for this instance
+    level: String // custom log level for errors (default is 'error')
 ```
 
 To use winston's existing transports, set `transports` to the values (as in key-value) of the `winston.default.transports` object. This may be done, for example, by using underscorejs: `transports: _.values(winston.default.transports)`.

package/index.js

@@ -121,6 +121,7 @@ exports.errorLogger = function errorLogger(options) {
     options.msg = options.msg || 'middlewareError';
     options.baseMeta = options.baseMeta || {};
     options.metaField = options.metaField || null;
+    options.level = options.level || 'error';
 
     // Using mustache style templating
     var template = _.template(options.msg, {
@@ -139,10 +140,10 @@ exports.errorLogger = function errorLogger(options) {
             exceptionMeta = newMeta;
         }
 
-        exceptionMeta = _.extend(exceptionMeta, options.baseMeta);
+        exceptionMeta = _.assign(exceptionMeta, options.baseMeta);
 
         // This is fire and forget, we don't want logging to hold up the request so don't wait for the callback
-        options.winstonInstance.log('error', template({err: err, req: req, res: res}), exceptionMeta);
+        options.winstonInstance.log(options.level, template({err: err, req: req, res: res}), exceptionMeta);
 
         next(err);
     };
@@ -172,16 +173,11 @@ exports.logger = function logger(options) {
     options.msg = options.msg || "HTTP {{req.method}} {{req.url}}";
     options.baseMeta = options.baseMeta || {};
     options.metaField = options.metaField || null;
-    options.colorStatus = options.colorStatus || false;
+    options.colorize = options.colorize || false;
     options.expressFormat = options.expressFormat || false;
     options.ignoreRoute = options.ignoreRoute || function () { return false; };
     options.skip = options.skip || exports.defaultSkip;
 
-    // Using mustache style templating
-    var template = _.template(options.msg, {
-      interpolate: /\{\{(.+?)\}\}/g
-    });
-
     return function (req, res, next) {
         var currentUrl = req.originalUrl || req.url;
         if (currentUrl && _.includes(options.ignoredRoutes, currentUrl)) return next();
@@ -215,15 +211,6 @@ exports.logger = function logger(options) {
               if (res.statusCode >= 500) { options.level = options.statusLevels.error || "error"; }
             };
 
-            if (options.colorStatus || options.expressFormat) {
-              // Palette from https://github.com/expressjs/morgan/blob/master/index.js#L205
-              var statusColor = 'green';
-              if (res.statusCode >= 500) statusColor = 'red';
-              else if (res.statusCode >= 400) statusColor = 'yellow';
-              else if (res.statusCode >= 300) statusColor = 'cyan';
-              var coloredStatusCode = chalk[statusColor](res.statusCode);
-            }
-
             var meta = {};
 
             if(options.meta !== false) {
@@ -239,7 +226,7 @@ exports.logger = function logger(options) {
                   var isJson = (res._headers && res._headers['content-type']
                     && res._headers['content-type'].indexOf('json') >= 0);
 
-                  logData.res.body =  isJson ? JSON.parse(chunk) : chunk.toString();
+                  logData.res.body = bodyToString(chunk, isJson);
                 }
               }
 
@@ -269,18 +256,32 @@ exports.logger = function logger(options) {
                   newMeta[options.metaField] = logData;
                   logData = newMeta;
               }
-              meta = _.extend(meta, logData);
+              meta = _.assign(meta, logData);
             }
 
-            meta = _.extend(meta, options.baseMeta);
+            meta = _.assign(meta, options.baseMeta);
 
-            if(options.expressFormat) {
-              var msg = chalk.grey(req.method + " " + req.url || req.url)
-                + " " + chalk[statusColor](res.statusCode)
-                + " " + chalk.grey(res.responseTime+"ms");
-            } else {
-              var msg = template({req: req, res: res});
+            var expressMsgFormat = "{{req.method}} {{req.url}} {{res.statusCode}} {{res.responseTime}}ms";
+            if (options.colorize) {
+              // Palette from https://github.com/expressjs/morgan/blob/master/index.js#L205
+              var statusColor = 'green';
+              if (res.statusCode >= 500) statusColor = 'red';
+              else if (res.statusCode >= 400) statusColor = 'yellow';
+              else if (res.statusCode >= 300) statusColor = 'cyan';
+
+              expressMsgFormat = chalk.grey("{{req.method}} {{req.url}}") +
+                " " + chalk[statusColor]("{{res.statusCode}}") + " " +
+                chalk.grey("{{res.responseTime}}ms");
             }
+            var msgFormat = !options.expressFormat ? options.msg : expressMsgFormat;
+
+            // Using mustache style templating
+            var template = _.template(msgFormat, {
+              interpolate: /\{\{(.+?)\}\}/g
+            });
+
+            var msg = template({req: req, res: res});
+
             // This is fire and forget, we don't want logging to hold up the request so don't wait for the callback
             if (!options.skip(req, res)) {
               options.winstonInstance.log(options.level, msg, meta);
@@ -291,6 +292,22 @@ exports.logger = function logger(options) {
     };
 };
 
+function safeJSONParse(string) {
+    try {
+        return JSON.parse(string);
+    } catch (e) {
+        return undefined;
+    }
+}
+
+function bodyToString(body, isJSON) {
+    var stringBody = body && body.toString();
+    if (isJSON) {
+        return (safeJSONParse(body) || stringBody);
+    }
+    return stringBody;
+}
+
 function ensureValidOptions(options) {
     if(!options) throw new Error("options are required by winston-middleware middleware");
     if(!((options.transports && (options.transports.length > 0)) || options.winstonInstance))

package/package.json

@@ -17,7 +17,7 @@
     "middleware",
     "colors"
   ],
-  "version": "1.3.1",
+  "version": "2.0.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/bithavoc/winston-middleware.git"
@@ -48,8 +48,7 @@
   },
   "dependencies": {
     "chalk": "~0.4.0",
-    "lodash": "~4.11.1",
-    "winston": "~1.0.0"
+    "lodash": "~4.11.1"
   },
   "devDependencies": {
     "blanket": "^1.2.2",
@@ -57,7 +56,11 @@
     "node-mocks-http": "^1.5.1",
     "promise": "^7.1.1",
     "should": "^8.2.2",
-    "travis-cov": "^0.2.5"
+    "travis-cov": "^0.2.5",
+    "winston": ">=1.x"
+  },
+  "peerDependencies": {
+    "winston": ">=1.x"
   },
   "engines": {
     "node": ">=0.10.0"

package/test/test.js

@@ -189,12 +189,19 @@ describe('winston-middleware', function () {
         });
       });
 
-      it('should find an error level of "error"', function () {
+      it('should find the default level of "error"', function () {
         return errorLoggerTestHelper().then(function (result) {
           result.log.level.should.eql('error');
         });
       });
 
+      it('should find a custom level of "warn"', function () {
+        var testHelperOptions = {loggerOptions: {level:'warn'}};
+        return errorLoggerTestHelper(testHelperOptions).then(function (result) {
+          result.log.level.should.eql('warn');
+        });
+      });
+
       it('should find a message of "middlewareError"', function () {
         return errorLoggerTestHelper().then(function (result) {
           result.log.msg.should.eql('middlewareError');
@@ -528,6 +535,35 @@ describe('winston-middleware', function () {
       });
     });
 
+    describe('when middleware function is invoked on a route that returns JSON', function() {
+      it('should parse JSON in response body', function() {
+        var bodyObject = { "message": "Hi!  I\'m a chunk!" };
+        function next(req, res, next) {
+          // Set Content-Type in a couple different case types, just in case.
+          // Seems like the mock response doesn't quite handle the case
+          // translation on these right.
+          res.setHeader('Content-Type', 'application/json');
+          res.setHeader('content-type', 'application/json');
+          res.end(JSON.stringify(bodyObject));
+        }
+        return loggerTestHelper({next: next}).then(function(result) {
+            result.log.meta.res.body.should.eql(bodyObject);
+        });
+      });
+
+      it('should not blow up when response body is invalid JSON', function() {
+        function next(req, res, next) {
+          // Set Content-Type in a couple different case types, just in case.
+          // Seems like the mock response doesn't quite handle the case
+          // translation on these right.
+          res.setHeader('Content-Type', 'application/json');
+          res.setHeader('content-type', 'application/json');
+          res.end('}');
+        }
+        return loggerTestHelper({next: next});
+      });
+    });
+
     describe('when middleware function is invoked on a route that should be ignored (by .ignoredRoutes)', function () {
       var testHelperOptions = {
         req: {url: '/ignored'}
@@ -550,6 +586,7 @@ describe('winston-middleware', function () {
       it('should match the Express format when logging', function () {
         var testHelperOptions = {
           loggerOptions: {
+            colorize: true,
             expressFormat: true
           },
           req: {
@@ -562,6 +599,40 @@ describe('winston-middleware', function () {
           resultMsg.should.endWith('ms\u001b[39m');
         });
       });
+
+      it('should not emit colors when colorize option is false', function() {
+        var testHelperOptions = {
+          loggerOptions: {
+            colorize: false,
+            expressFormat: true
+          },
+          req: {
+            url: '/all-the-things'
+          }
+        };
+        return loggerTestHelper(testHelperOptions).then(function (result) {
+          var resultMsg = result.log.msg;
+          resultMsg.should.startWith('GET /all-the-things 200 ');
+          resultMsg.should.endWith('ms');
+        });
+      });
+
+      it('should not emit colors when colorize option is not present', function() {
+        var testHelperOptions = {
+          loggerOptions: {
+            colorize: false,
+            expressFormat: true
+          },
+          req: {
+            url: '/all-the-things'
+          }
+        };
+        return loggerTestHelper(testHelperOptions).then(function (result) {
+          var resultMsg = result.log.msg;
+          resultMsg.should.startWith('GET /all-the-things 200 ');
+          resultMsg.should.endWith('ms');
+        });
+      });
     });
 
     describe('msg option', function () {