strong-error-handler 3.0.0 → 3.4.0

package/.travis.yml

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

package/CHANGES.md

@@ -1,4 +1,40 @@
-2018-06-12, Version 3.0.0
+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
+=========================
+
+ * Add type definition and writeErrorToResponse (shimks)
+
+
+2018-07-16, Version 3.1.0
+=========================
+
+ * [WebFM] cs/pl/ru translation (candytangnb)
+
+
+2018-06-11, Version 3.0.0
 =========================
 
  * Allow safeFields to work with arrays (shimks)

package/README.md

@@ -46,6 +46,29 @@ app.use(errorHandler({
 app.listen(3000);
 ```
 
+The module also exports `writeErrorToResponse`, a non-middleware flavor of the
+error handler:
+
+```js
+const http = require('http');
+const writeErrorToResponse = require('strong-error-handler')
+  .writeErrorToResponse;
+const errHandlingOptions = {debug: process.env.NODE_ENV === 'development'}
+
+http
+  .createServer((req, res) => {
+    if (errShouldBeThrown) {
+      writeErrorToResponse(
+        new Error('something went wrong'),
+        req,
+        res,
+        errHandlingOptions,
+      );
+    }
+  })
+  .listen(3000);
+```
+
 In LoopBack applications, add the following entry to `server/middleware.json`:
 
 ```json

package/index.d.ts

@@ -0,0 +1,64 @@
+// Copyright IBM Corp. 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
+
+// Type definitions for strong-error-handler 3.x
+// Project: https://github.com/strongloop/strong-error-handler
+// Definitions by: Kyusung Shim <https://github.com/shimks>
+// TypeScript Version: 3.0
+
+import * as Express from 'express';
+
+export = errorHandlerFactory;
+
+/**
+ * Creates a middleware function for error-handling
+ * @param options Options for error handler settings
+ */
+declare function errorHandlerFactory(
+  options?: errorHandlerFactory.ErrorHandlerOptions
+): errorHandlerFactory.StrongErrorHandler;
+
+declare namespace errorHandlerFactory {
+  /**
+   * Writes thrown error to response
+   * @param err Error to handle
+   * @param req Incoming request
+   * @param res Response
+   * @param options Options for error handler settings
+   */
+  function writeErrorToResponse(
+    err: Error,
+    req: Express.Request,
+    res: Express.Response,
+    options?: ErrorWriterOptions
+  ): void;
+
+  /**
+   * Error-handling middleware function. Includes server-side logging
+   */
+  type StrongErrorHandler = (
+    err: Error,
+    req: Express.Request,
+    res: Express.Response,
+    next: (err?: any) => void
+  ) => void;
+
+  /**
+   * Options for writing errors to the response
+   */
+  interface ErrorWriterOptions {
+    debug?: boolean;
+    safeFields?: string[];
+    defaultType?: string;
+    negotiateContentType?: boolean;
+  }
+
+  /**
+   * Options for error-handling
+   */
+  interface ErrorHandlerOptions extends ErrorWriterOptions {
+    log?: boolean;
+  }
+}

package/intl/cs/messages.json

@@ -0,0 +1,5 @@
+{
+  "85312d2b987e2e44001db3d6963a1364": "Neošetřené pole chyb pro požadavek {0} {1}\n",
+  "adcbd4c562b19f45fb5d3427619646d5": "Neošetřená chyba pro požadavek {0} {1}: {2}"
+}
+

package/intl/pl/messages.json

@@ -0,0 +1,5 @@
+{
+  "85312d2b987e2e44001db3d6963a1364": "Nieobsługiwana tablica błędów dla żądania {0} {1}\n",
+  "adcbd4c562b19f45fb5d3427619646d5": "Nieobsługiwany błąd dla żądania {0} {1}: {2}"
+}
+

package/intl/ru/messages.json

@@ -0,0 +1,5 @@
+{
+  "85312d2b987e2e44001db3d6963a1364": "Необработанный массив ошибок для запроса {0} {1}\n",
+  "adcbd4c562b19f45fb5d3427619646d5": "Необработанная ошибка для запроса {0} {1}: {2}"
+}
+

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,18 @@
-// 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 format = require('util').format;
+const logToConsole = require('./logger');
+const negotiateContentProducer = require('./content-negotiation');
 
 function noop() {
 }
@@ -23,40 +23,56 @@ function noop() {
  * @param {Object} options
  * @returns {Function}
  */
-exports = module.exports = function createStrongErrorHandler(options) {
+function createStrongErrorHandler(options) {
   options = 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) {
-    debug('Handling %s', err.stack || err);
-
     logError(req, err);
+    writeErrorToResponse(err, req, res, options);
+  };
+}
 
-    if (res._header) {
-      debug('Response was already sent, closing the underlying connection');
-      return req.socket.destroy();
-    }
+/**
+ * Writes thrown error to response
+ *
+ * @param {Error} err
+ * @param {Express.Request} req
+ * @param {Express.Response} res
+ * @param {Object} options
+ */
+function writeErrorToResponse(err, req, res, options) {
+  debug('Handling %s', err.stack || err);
 
-    // this will alter the err object, to handle when res.statusCode is an error
-    if (!err.status && !err.statusCode && res.statusCode >= 400)
-      err.statusCode = res.statusCode;
+  options = options || {};
 
-    var data = buildResponseData(err, options);
-    debug('Response status %s data %j', data.statusCode, data);
+  if (res._header) {
+    debug('Response was already sent, closing the underlying connection');
+    return req.socket.destroy();
+  }
 
-    res.setHeader('X-Content-Type-Options', 'nosniff');
-    res.statusCode = data.statusCode;
+  // this will alter the err object, to handle when res.statusCode is an error
+  if (!err.status && !err.statusCode && res.statusCode >= 400)
+    err.statusCode = res.statusCode;
 
-    var sendResponse = negotiateContentProducer(req, warn, options);
-    sendResponse(res, data);
+  const data = buildResponseData(err, options);
+  debug('Response status %s data %j', data.statusCode, data);
 
-    function warn(msg) {
-      res.header('X-Warning', msg);
-      debug(msg);
-    }
-  };
-};
+  res.setHeader('X-Content-Type-Options', 'nosniff');
+  res.statusCode = data.statusCode;
+
+  const sendResponse = negotiateContentProducer(req, warn, options);
+  sendResponse(res, data);
+
+  function warn(msg) {
+    res.header('X-Warning', msg);
+    debug(msg);
+  }
+}
+
+exports = module.exports = createStrongErrorHandler;
+exports.writeErrorToResponse = writeErrorToResponse;

package/lib/logger.js

@@ -5,8 +5,8 @@
 
 '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)) {
@@ -15,9 +15,9 @@ module.exports = function logToConsole(req, err) {
     return;
   }
 
-  var errMsg = g.f('Unhandled array of errors for request %s %s\n',
+  const errMsg = g.f('Unhandled array of errors for request %s %s\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,9 +17,9 @@ var compiledTemplates = {
 module.exports = sendHtml;
 
 function sendHtml(res, data, options) {
-  var toRender = {options: {}, data: data};
+  const toRender = {options: {}, data: data};
   // TODO: ability to call non-default template functions from options
-  var body = compiledTemplates.default(toRender);
+  const body = compiledTemplates.default(toRender);
   sendReponse(res, body);
 }
 
@@ -30,14 +30,14 @@ 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);
 }
 

package/lib/send-json.js

@@ -5,8 +5,10 @@
 
 'use strict';
 
+const safeStringify = require('fast-safe-stringify');
+
 module.exports = function sendJson(res, data) {
-  var content = JSON.stringify({error: data});
+  const content = safeStringify({error: data});
   res.setHeader('Content-Type', 'application/json; charset=utf-8');
   res.end(content, 'utf-8');
 };

package/lib/send-xml.js

@@ -1,14 +1,14 @@
-// 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);
+  const content = js2xmlparser.parse('error', 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.0.0",
+  "version": "3.4.0",
   "engines": {
-    "node": ">=6"
+    "node": ">=8"
   },
   "repository": {
     "type": "git",
@@ -17,20 +17,22 @@
     "posttest": "npm run lint"
   },
   "dependencies": {
+    "@types/express": "^4.16.0",
     "accepts": "^1.3.3",
-    "debug": "^3.1.0",
+    "debug": "^4.1.1",
     "ejs": "^2.6.1",
+    "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": "^5.0.2"
   },
   "devDependencies": {
     "chai": "^4.1.2",
-    "eslint": "^4.19.1",
-    "eslint-config-loopback": "^10.0.0",
+    "eslint": "^6.5.1",
+    "eslint-config-loopback": "^13.1.0",
     "express": "^4.16.3",
-    "mocha": "^5.2.0",
-    "supertest": "^3.1.0"
+    "mocha": "^6.2.1",
+    "supertest": "^4.0.2"
   },
   "browser": {
     "strong-error-handler": false
@@ -39,5 +41,6 @@
     "downstreamIgnoreList": [
       "dashboard-controller"
     ]
-  }
+  },
+  "author": "IBM Corp."
 }