strong-error-handler 2.3.1 → 3.2.0

package/CHANGES.md

@@ -1,3 +1,31 @@
+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)
+
+ * run lint (shimks)
+
+ * drop node 4 from travis and update dependencies (shimks)
+
+
+2018-03-05, Version 2.3.2
+=========================
+
+ * Undefined safeFields revert to data #71 (Zak Barbuto)
+
+
 2018-01-25, Version 2.3.1
 =========================
 

package/README.md

@@ -12,6 +12,14 @@ In production mode, `strong-error-handler` omits details from error responses to
 
 In debug mode, `strong-error-handler` returns full error stack traces and internal details of any error objects to the client in the HTTP responses.
 
+## Supported versions
+
+Current|Long Term Support|Maintenance
+:-:|:-:|:-:
+3.x|2.x|1.x
+
+Learn more about our LTS plan in [docs](http://loopback.io/doc/en/contrib/Long-term-support.html).
+
 ## Installation
 
 ```bash
@@ -38,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/content-negotiation.js

@@ -64,7 +64,7 @@ function negotiateContentProducer(req, logWarning, options) {
     } else {
       debug('contentType: `%s` is not supported, ' +
         'falling back to contentType: `%s`',
-         options.defaultType, contentType);
+      options.defaultType, contentType);
     }
   }
 

package/lib/data-builder.js

@@ -8,16 +8,18 @@
 var cloneAllProperties = require('../lib/clone.js');
 var httpStatus = require('http-status');
 
-module.exports = function buildResponseData(err, options) {
+module.exports = buildResponseData;
+
+function buildResponseData(err, options) {
   // Debugging mode is disabled by default. When turned on (in dev),
   // all error properties (including) stack traces are sent in the response
-  var isDebugMode = options.debug;
+  const isDebugMode = options.debug;
 
-  if (Array.isArray(err) && isDebugMode) {
-    err = serializeArrayOfErrors(err);
+  if (Array.isArray(err)) {
+    return serializeArrayOfErrors(err, options);
   }
 
-  var data = Object.create(null);
+  const data = Object.create(null);
   fillStatusCode(data, err);
 
   if (typeof err !== 'object') {
@@ -29,35 +31,25 @@ module.exports = function buildResponseData(err, options) {
 
   if (isDebugMode) {
     fillDebugData(data, err);
-  } else if (data.statusCode >= 400 && data.statusCode <= 499) {
+    return data;
+  }
+
+  if (data.statusCode >= 400 && data.statusCode <= 499) {
     fillBadRequestError(data, err);
   } else {
     fillInternalError(data, err);
   }
 
-  var safeFields = options.safeFields || [];
+  const safeFields = options.safeFields || [];
   fillSafeFields(data, err, safeFields);
 
   return data;
 };
 
-function serializeArrayOfErrors(errors) {
-  var details = [];
-  for (var ix in errors) {
-    var err = errors[ix];
-    if (typeof err !== 'object') {
-      details.push('' + err);
-      continue;
-    }
-
-    var data = {};
-    cloneAllProperties(data, err);
-    delete data.statusCode;
-    details.push(data);
-  }
-
+function serializeArrayOfErrors(errors, options) {
+  const details = errors.map(e => buildResponseData(e, options));
   return {
-    name: 'ArrayOfErrors',
+    statusCode: 500,
     message: 'Failed with multiple errors, ' +
       'see `details` for more information.',
     details: details,
@@ -91,6 +83,8 @@ function fillSafeFields(data, err, safeFields) {
   }
 
   safeFields.forEach(function(field) {
-    data[field] = err[field];
+    if (err[field] !== undefined) {
+      data[field] = err[field];
+    }
   });
 }

package/lib/handler.js

@@ -23,7 +23,7 @@ function noop() {
  * @param {Object} options
  * @returns {Function}
  */
-exports = module.exports = function createStrongErrorHandler(options) {
+function createStrongErrorHandler(options) {
   options = options || {};
 
   debug('Initializing with options %j', options);
@@ -32,31 +32,47 @@ exports = module.exports = function createStrongErrorHandler(options) {
   var 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);
+  };
+};
+
+/**
+ * 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);
+
+  options = options || {};
 
-    if (res._header) {
-      debug('Response was already sent, closing the underlying connection');
-      return req.socket.destroy();
-    }
+  if (res._header) {
+    debug('Response was already sent, closing the underlying connection');
+    return req.socket.destroy();
+  }
 
-    // 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;
+  // 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 data = buildResponseData(err, options);
-    debug('Response status %s data %j', data.statusCode, data);
+  var data = buildResponseData(err, options);
+  debug('Response status %s data %j', data.statusCode, data);
 
-    res.setHeader('X-Content-Type-Options', 'nosniff');
-    res.statusCode = data.statusCode;
+  res.setHeader('X-Content-Type-Options', 'nosniff');
+  res.statusCode = data.statusCode;
 
-    var sendResponse = negotiateContentProducer(req, warn, options);
-    sendResponse(res, data);
+  var sendResponse = negotiateContentProducer(req, warn, options);
+  sendResponse(res, data);
 
-    function warn(msg) {
-      res.header('X-Warning', msg);
-      debug(msg);
-    }
-  };
+  function warn(msg) {
+    res.header('X-Warning', msg);
+    debug(msg);
+  }
 };
+
+exports = module.exports = createStrongErrorHandler;
+exports.writeErrorToResponse = writeErrorToResponse;

package/package.json

@@ -2,9 +2,9 @@
   "name": "strong-error-handler",
   "description": "Error handler for use in development and production environments.",
   "license": "MIT",
-  "version": "2.3.1",
+  "version": "3.2.0",
   "engines": {
-    "node": ">=4"
+    "node": ">=6"
   },
   "repository": {
     "type": "git",
@@ -17,20 +17,21 @@
     "posttest": "npm run lint"
   },
   "dependencies": {
+    "@types/express": "^4.16.0",
     "accepts": "^1.3.3",
-    "debug": "^2.2.0",
-    "ejs": "^2.5.7",
-    "http-status": "^1.0.0",
+    "debug": "^3.1.0",
+    "ejs": "^2.6.1",
+    "http-status": "^1.1.2",
     "js2xmlparser": "^3.0.0",
-    "strong-globalize": "^3.1.0"
+    "strong-globalize": "^4.1.0"
   },
   "devDependencies": {
-    "chai": "^3.5.0",
-    "eslint": "^3.14.1",
-    "eslint-config-loopback": "^8.0.0",
-    "express": "^4.13.4",
-    "mocha": "^3.2.0",
-    "supertest": "^3.0.0"
+    "chai": "^4.1.2",
+    "eslint": "^4.19.1",
+    "eslint-config-loopback": "^10.0.0",
+    "express": "^4.16.3",
+    "mocha": "^5.2.0",
+    "supertest": "^3.1.0"
   },
   "browser": {
     "strong-error-handler": false