strong-error-handler 3.2.0 → 4.0.0

package/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: node_js
+node_js:
+  - "10"
+  - "12"
+  - "14"

package/CHANGES.md

@@ -1,3 +1,43 @@
+2020-10-13, Version 4.0.0
+=========================
+
+ * docs: update LTS versions in README (Miroslav Bajtoš)
+
+ * [SEMVER-MAJOR] Reword log messages for clarity (Miroslav Bajtoš)
+
+
+2020-06-23, Version 3.5.0
+=========================
+
+ * feat: add options.rootProperty for json/xml (Raymond Feng)
+
+ * chore: update deps and drop Node 8.x support (Raymond Feng)
+
+
+2019-10-12, Version 3.4.0
+=========================
+
+ * chore: js2xmlparser to ^4.0.0 (Miroslav Bajtoš)
+
+ * chore: update dev-dependencies (mocha, supertest) (Miroslav Bajtoš)
+
+ * chore: update eslint & config to latest (Miroslav Bajtoš)
+
+ * chore: update strong-globalize to ^5.0.2 (Miroslav Bajtoš)
+
+ * chore: update debug to ^4.1.1 (Miroslav Bajtoš)
+
+ * feat: drop support for Node.js 6.x (Miroslav Bajtoš)
+
+
+2019-09-30, Version 3.3.0
+=========================
+
+ * fix: handle Error objects with circular properties (dkrantsberg)
+
+ * chore: update copyrights years (Agnes Lin)
+
+
 2018-08-30, Version 3.2.0
 =========================
 

package/README.md

@@ -14,11 +14,15 @@ In debug mode, `strong-error-handler` returns full error stack traces and intern
 
 ## Supported versions
 
-Current|Long Term Support|Maintenance
-:-:|:-:|:-:
-3.x|2.x|1.x
+This module adopts the [Module Long Term Support (LTS)](http://github.com/CloudNativeJS/ModuleLTS) policy, with the following End Of Life (EOL) dates:
 
-Learn more about our LTS plan in [docs](http://loopback.io/doc/en/contrib/Long-term-support.html).
+| Version    | Status          | Published | EOL                  |
+| ---------- | --------------- | --------- | -------------------- |
+| 4.x        | Current         | Oct 2020  | Apr 2023 _(minimum)_ |
+| 3.x        | Active LTS      | Jun 2018  | Dec 2022             |
+| 2.x        | End-of-life     | Mar 2017  | Oct 2020             |
+
+Learn more about our LTS plan in the [LoopBack documentation](http://loopback.io/doc/en/contrib/Long-term-support.html).
 
 ## Installation
 
@@ -108,24 +112,25 @@ The content type of the response depends on the request's `Accepts` header.
 
 ## Options
 
-| Option | Type | Default | Description |
-| ---- | ---- | ---- | ---- |
-| debug | Boolean    | `false` | If `true`, HTTP responses include all error properties, including sensitive data such as file paths, URLs and stack traces. See [Example output](#example) below. |
-| log | Boolean | `true` |  If `true`, all errors are printed via `console.error`, including an array of fields (custom error properties) that are safe to include in response messages (both 4xx and 5xx). <br/> If `false`, sends only the error back in the response. |
-| safeFields | [String] | `[]` |  Specifies property names on errors that are allowed to be passed through in 4xx and 5xx responses. See [Safe error fields](#safe-error-fields) below. |
-| defaultType | String | `"json"` | Specify the default response content type to use when the client does not provide any Accepts header.
-| negotiateContentType | Boolean | true | Negotiate the response content type via Accepts request header. When disabled, strong-error-handler will always use the default content type when producing responses. Disabling content type negotiation is useful if you want to see JSON-formatted error responses in browsers, because browsers usually prefer HTML and XML over other content types.
+| Option               | Type                      | Default   | Description                                                                                                                                                                                                                                                                                                                                               |
+| -------------------- | ------------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| debug                | Boolean&nbsp;&nbsp;&nbsp; | `false`   | If `true`, HTTP responses include all error properties, including sensitive data such as file paths, URLs and stack traces. See [Example output](#example) below.                                                                                                                                                                                         |
+| log                  | Boolean                   | `true`    | If `true`, all errors are printed via `console.error`, including an array of fields (custom error properties) that are safe to include in response messages (both 4xx and 5xx). <br/> If `false`, sends only the error back in the response.                                                                                                              |
+| safeFields           | [String]                  | `[]`      | Specifies property names on errors that are allowed to be passed through in 4xx and 5xx responses. See [Safe error fields](#safe-error-fields) below.                                                                                                                                                                                                     |
+| defaultType          | String                    | `"json"`  | Specifies the default response content type to use when the client does not provide any Accepts header.                                                                                                                                                                                                                                                   |
+| rootProperty         | String or false           | `"error"` | Specifies the root property name for json or xml. If the value is set to `false`, no wrapper will be added to the json object. The false value is ignored by XML as a root element is always required.                                                                                                                                                    |
+| negotiateContentType | Boolean                   | true      | Negotiate the response content type via Accepts request header. When disabled, strong-error-handler will always use the default content type when producing responses. Disabling content type negotiation is useful if you want to see JSON-formatted error responses in browsers, because browsers usually prefer HTML and XML over other content types. |
 
 ### Customizing log format
 
-**Express** 
+**Express**
 
-To use a different log format, add your own custom error-handling middleware then disable `errorHandler.log`. 
+To use a different log format, add your own custom error-handling middleware then disable `errorHandler.log`.
 For example, in an Express application:
 
 ```js
 app.use(myErrorLogger());
-app.use(errorHandler({ log: false }));
+app.use(errorHandler({log: false}));
 ```
 
 In general, add `strong-error-handler` as the last middleware function, just before calling `app.listen()`.
@@ -234,7 +239,7 @@ To migrate a LoopBack 2.x application to use `strong-error-handler`:
     }
 </pre>
 
-For more information, see 
+For more information, see
 [Migrating apps to LoopBack 3.0](http://loopback.io/doc/en/lb3/Migrating-to-3.0.html#update-use-of-rest-error-handler).
 
 ## Example
@@ -252,17 +257,17 @@ The same error generated when `debug: true` :
   { statusCode: 500,
   name: 'Error',
   message: 'a test error message',
-  stack: 'Error: a test error message    
-  at Context.<anonymous> (User/strong-error-handler/test/handler.test.js:220:21)    
-  at callFnAsync (User/strong-error-handler/node_modules/mocha/lib/runnable.js:349:8)    
-  at Test.Runnable.run (User/strong-error-handler/node_modules/mocha/lib/runnable.js:301:7)    
-  at Runner.runTest (User/strong-error-handler/node_modules/mocha/lib/runner.js:422:10)    
-  at User/strong-error-handler/node_modules/mocha/lib/runner.js:528:12    
-  at next (User/strong-error-handler/node_modules/mocha/lib/runner.js:342:14)    
-  at User/strong-error-handler/node_modules/mocha/lib/runner.js:352:7    
-  at next (User/strong-error-handler/node_modules/mocha/lib/runner.js:284:14)    
-  at Immediate._onImmediate (User/strong-error-handler/node_modules/mocha/lib/runner.js:320:5)    
-  at tryOnImmediate (timers.js:543:15)    
+  stack: 'Error: a test error message
+  at Context.<anonymous> (User/strong-error-handler/test/handler.test.js:220:21)
+  at callFnAsync (User/strong-error-handler/node_modules/mocha/lib/runnable.js:349:8)
+  at Test.Runnable.run (User/strong-error-handler/node_modules/mocha/lib/runnable.js:301:7)
+  at Runner.runTest (User/strong-error-handler/node_modules/mocha/lib/runner.js:422:10)
+  at User/strong-error-handler/node_modules/mocha/lib/runner.js:528:12
+  at next (User/strong-error-handler/node_modules/mocha/lib/runner.js:342:14)
+  at User/strong-error-handler/node_modules/mocha/lib/runner.js:352:7
+  at next (User/strong-error-handler/node_modules/mocha/lib/runner.js:284:14)
+  at Immediate._onImmediate (User/strong-error-handler/node_modules/mocha/lib/runner.js:320:5)
+  at tryOnImmediate (timers.js:543:15)
   at processImmediate [as _immediateCallback] (timers.js:523:5)' }}
 ```
 

package/index.d.ts

@@ -53,6 +53,7 @@ declare namespace errorHandlerFactory {
     safeFields?: string[];
     defaultType?: string;
     negotiateContentType?: boolean;
+    rootProperty?: string | false;
   }
 
   /**

package/lib/clone.js

@@ -1,3 +1,8 @@
+// Copyright IBM Corp. 2016. All Rights Reserved.
+// Node module: strong-error-handler
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
 'use strict';
 module.exports = cloneAllProperties;
 
@@ -10,10 +15,10 @@ module.exports = cloneAllProperties;
 function cloneAllProperties(data, err) {
   data.name = err.name;
   data.message = err.message;
-  for (var p in err) {
+  for (const p in err) {
     if ((p in data)) continue;
     data[p] = err[p];
   }
   // stack is appended last to ensure order is the same for response
   data.stack = err.stack;
-};
+}

package/lib/content-negotiation.js

@@ -1,15 +1,15 @@
-// Copyright IBM Corp. 2016. All Rights Reserved.
+// Copyright IBM Corp. 2016,2018. All Rights Reserved.
 // Node module: strong-error-handler
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
 'use strict';
-var accepts = require('accepts');
-var debug = require('debug')('strong-error-handler:http-response');
-var sendJson = require('./send-json');
-var sendHtml = require('./send-html');
-var sendXml = require('./send-xml');
-var util = require('util');
+const accepts = require('accepts');
+const debug = require('debug')('strong-error-handler:http-response');
+const sendJson = require('./send-json');
+const sendHtml = require('./send-html');
+const sendXml = require('./send-xml');
+const util = require('util');
 
 module.exports = negotiateContentProducer;
 
@@ -23,14 +23,14 @@ module.exports = negotiateContentProducer;
  * @returns {Function} Operation function with signature `fn(res, data)`
  */
 function negotiateContentProducer(req, logWarning, options) {
-  var SUPPORTED_TYPES = [
+  const SUPPORTED_TYPES = [
     'application/json', 'json',
     'text/html', 'html',
     'text/xml', 'xml',
   ];
 
   options = options || {};
-  var defaultType = 'json';
+  let defaultType = 'json';
 
   // checking if user provided defaultType is supported
   if (options.defaultType) {
@@ -52,9 +52,9 @@ function negotiateContentProducer(req, logWarning, options) {
   // Accepts: */*, application/json, text/html ---> will resolve as application/json
   // eg. Chrome accepts defaults to `text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*`
   // In this case `resolvedContentType` will result as: `text/html` due to the order given
-  var resolvedContentType = accepts(req).types(SUPPORTED_TYPES);
+  const resolvedContentType = accepts(req).types(SUPPORTED_TYPES);
   debug('Resolved content-type', resolvedContentType);
-  var contentType = resolvedContentType || defaultType;
+  let contentType = resolvedContentType || defaultType;
 
   if (options.negotiateContentType === false) {
     if (SUPPORTED_TYPES.indexOf(options.defaultType) > -1) {
@@ -71,13 +71,13 @@ function negotiateContentProducer(req, logWarning, options) {
   // to receive _format from user's url param to overide the content type
   // req.query (eg /api/Users/1?_format=json will overide content negotiation
   // https://github.com/strongloop/strong-remoting/blob/ac3093dcfbb787977ca0229b0f672703859e52e1/lib/http-context.js#L643-L645
-  var query = req.query || {};
+  const query = req.query || {};
   if (query._format) {
     if (SUPPORTED_TYPES.indexOf(query._format) > -1) {
       contentType = query._format;
     } else {
       // format passed through query but not supported
-      var msg = util.format('Response _format "%s" is not supported' +
+      const msg = util.format('Response _format "%s" is not supported' +
         'used "%s" instead"', query._format, defaultType);
       logWarning(msg);
     }

package/lib/data-builder.js

@@ -1,12 +1,12 @@
-// Copyright IBM Corp. 2016. All Rights Reserved.
+// Copyright IBM Corp. 2016,2018. All Rights Reserved.
 // Node module: strong-error-handler
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
 'use strict';
 
-var cloneAllProperties = require('../lib/clone.js');
-var httpStatus = require('http-status');
+const cloneAllProperties = require('../lib/clone.js');
+const httpStatus = require('http-status');
 
 module.exports = buildResponseData;
 
@@ -44,7 +44,7 @@ function buildResponseData(err, options) {
   fillSafeFields(data, err, safeFields);
 
   return data;
-};
+}
 
 function serializeArrayOfErrors(errors, options) {
   const details = errors.map(e => buildResponseData(e, options));

package/lib/handler.js

@@ -1,18 +1,17 @@
-// Copyright IBM Corp. 2016. All Rights Reserved.
+// Copyright IBM Corp. 2016,2018. All Rights Reserved.
 // Node module: strong-error-handler
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
 'use strict';
 
-var path = require('path');
-var SG = require('strong-globalize');
+const path = require('path');
+const SG = require('strong-globalize');
 SG.SetRootDir(path.resolve(__dirname, '..'));
-var buildResponseData = require('./data-builder');
-var debug = require('debug')('strong-error-handler');
-var format = require('util').format;
-var logToConsole = require('./logger');
-var negotiateContentProducer = require('./content-negotiation');
+const buildResponseData = require('./data-builder');
+const debug = require('debug')('strong-error-handler');
+const logToConsole = require('./logger');
+const negotiateContentProducer = require('./content-negotiation');
 
 function noop() {
 }
@@ -29,13 +28,13 @@ function createStrongErrorHandler(options) {
   debug('Initializing with options %j', options);
 
   // Log all errors via console.error (enabled by default)
-  var logError = options.log !== false ? logToConsole : noop;
+  const logError = options.log !== false ? logToConsole : noop;
 
   return function strongErrorHandler(err, req, res, next) {
     logError(req, err);
     writeErrorToResponse(err, req, res, options);
   };
-};
+}
 
 /**
  * Writes thrown error to response
@@ -50,7 +49,7 @@ function writeErrorToResponse(err, req, res, options) {
 
   options = options || {};
 
-  if (res._header) {
+  if (res.headersSent) {
     debug('Response was already sent, closing the underlying connection');
     return req.socket.destroy();
   }
@@ -59,20 +58,20 @@ function writeErrorToResponse(err, req, res, options) {
   if (!err.status && !err.statusCode && res.statusCode >= 400)
     err.statusCode = res.statusCode;
 
-  var data = buildResponseData(err, options);
+  const data = buildResponseData(err, options);
   debug('Response status %s data %j', data.statusCode, data);
 
   res.setHeader('X-Content-Type-Options', 'nosniff');
   res.statusCode = data.statusCode;
 
-  var sendResponse = negotiateContentProducer(req, warn, options);
-  sendResponse(res, data);
+  const sendResponse = negotiateContentProducer(req, warn, options);
+  sendResponse(res, data, options);
 
   function warn(msg) {
     res.header('X-Warning', msg);
     debug(msg);
   }
-};
+}
 
 exports = module.exports = createStrongErrorHandler;
 exports.writeErrorToResponse = writeErrorToResponse;

package/lib/logger.js

@@ -5,19 +5,19 @@
 
 'use strict';
 
-var format = require('util').format;
-var g = require('strong-globalize')();
+const format = require('util').format;
+const g = require('strong-globalize')();
 
 module.exports = function logToConsole(req, err) {
   if (!Array.isArray(err)) {
-    g.error('Unhandled error for request %s %s: %s',
+    g.error('Request %s %s failed: %s',
       req.method, req.url, err.stack || err);
     return;
   }
 
-  var errMsg = g.f('Unhandled array of errors for request %s %s\n',
+  const errMsg = g.f('Request %s %s failed with multiple errors:\n',
     req.method, req.url);
-  var errors = err.map(formatError).join('\n');
+  const errors = err.map(formatError).join('\n');
   console.error(errMsg, errors);
 };
 

package/lib/send-html.js

@@ -4,12 +4,12 @@
 // License text available at https://opensource.org/licenses/MIT
 
 'use strict';
-var ejs = require('ejs');
-var fs = require('fs');
-var path = require('path');
+const ejs = require('ejs');
+const fs = require('fs');
+const path = require('path');
 
-var assetDir = path.resolve(__dirname, '../views');
-var compiledTemplates = {
+const assetDir = path.resolve(__dirname, '../views');
+const compiledTemplates = {
   // loading default template and stylesheet
   default: loadDefaultTemplates(),
 };
@@ -17,10 +17,10 @@ var compiledTemplates = {
 module.exports = sendHtml;
 
 function sendHtml(res, data, options) {
-  var toRender = {options: {}, data: data};
+  const toRender = {options, data};
   // TODO: ability to call non-default template functions from options
-  var body = compiledTemplates.default(toRender);
-  sendReponse(res, body);
+  const body = compiledTemplates.default(toRender);
+  sendResponse(res, body);
 }
 
 /**
@@ -30,18 +30,18 @@ function sendHtml(res, data, options) {
  * @returns {Function} render function with signature fn(data);
  */
 function compileTemplate(filepath) {
-  var options = {cache: true, filename: filepath};
-  var fileContent = fs.readFileSync(filepath, 'utf8');
+  const options = {cache: true, filename: filepath};
+  const fileContent = fs.readFileSync(filepath, 'utf8');
   return ejs.compile(fileContent, options);
 }
 
 // loads and cache default error templates
 function loadDefaultTemplates() {
-  var defaultTemplate = path.resolve(assetDir, 'default-error.ejs');
+  const defaultTemplate = path.resolve(assetDir, 'default-error.ejs');
   return compileTemplate(defaultTemplate);
 }
 
-function sendReponse(res, body) {
+function sendResponse(res, body) {
   res.setHeader('Content-Type', 'text/html; charset=utf-8');
   res.end(body);
 }

package/lib/send-json.js

@@ -5,8 +5,16 @@
 
 'use strict';
 
-module.exports = function sendJson(res, data) {
-  var content = JSON.stringify({error: data});
+const safeStringify = require('fast-safe-stringify');
+
+module.exports = function sendJson(res, data, options) {
+  options = options || {};
+  // Set `options.rootProperty` to not wrap the data into an `error` object
+  const err = options.rootProperty === false ? data : {
+    // Use `options.rootProperty`, if not set, default to `error`
+    [options.rootProperty || 'error']: data,
+  };
+  const content = safeStringify(err);
   res.setHeader('Content-Type', 'application/json; charset=utf-8');
   res.end(content, 'utf-8');
 };

package/lib/send-xml.js

@@ -1,14 +1,18 @@
-// Copyright IBM Corp. 2016. All Rights Reserved.
+// Copyright IBM Corp. 2017. All Rights Reserved.
 // Node module: strong-error-handler
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
 'use strict';
 
-var js2xmlparser = require('js2xmlparser');
+const js2xmlparser = require('js2xmlparser');
 
-module.exports = function sendXml(res, data) {
-  var content = js2xmlparser.parse('error', data);
+module.exports = function sendXml(res, data, options) {
+  options = options || {};
+  // Xml always requires a root element.
+  // `options.rootProperty === false` is not honored
+  const root = options.rootProperty || 'error';
+  const content = js2xmlparser.parse(root, data);
   res.setHeader('Content-Type', 'text/xml; charset=utf-8');
   res.end(content, 'utf-8');
 };

package/package.json

@@ -2,9 +2,9 @@
   "name": "strong-error-handler",
   "description": "Error handler for use in development and production environments.",
   "license": "MIT",
-  "version": "3.2.0",
+  "version": "4.0.0",
   "engines": {
-    "node": ">=6"
+    "node": ">=10"
   },
   "repository": {
     "type": "git",
@@ -19,19 +19,20 @@
   "dependencies": {
     "@types/express": "^4.16.0",
     "accepts": "^1.3.3",
-    "debug": "^3.1.0",
-    "ejs": "^2.6.1",
+    "debug": "^4.1.1",
+    "ejs": "^3.1.3",
+    "fast-safe-stringify": "^2.0.6",
     "http-status": "^1.1.2",
-    "js2xmlparser": "^3.0.0",
-    "strong-globalize": "^4.1.0"
+    "js2xmlparser": "^4.0.0",
+    "strong-globalize": "^6.0.1"
   },
   "devDependencies": {
     "chai": "^4.1.2",
-    "eslint": "^4.19.1",
-    "eslint-config-loopback": "^10.0.0",
+    "eslint": "^7.0.0",
+    "eslint-config-loopback": "^13.1.0",
     "express": "^4.16.3",
-    "mocha": "^5.2.0",
-    "supertest": "^3.1.0"
+    "mocha": "^7.1.2",
+    "supertest": "^4.0.2"
   },
   "browser": {
     "strong-error-handler": false
@@ -40,5 +41,6 @@
     "downstreamIgnoreList": [
       "dashboard-controller"
     ]
-  }
+  },
+  "author": "IBM Corp."
 }