strong-error-handler 2.2.0 → 3.0.0

package/.github/ISSUE_TEMPLATE.md

@@ -1,36 +1,37 @@
 <!--
-- Please ask questions at https://groups.google.com/forum/#!forum/loopbackjs or
+Questions:
+  https://groups.google.com/forum/#!forum/loopbackjs
   https://gitter.im/strongloop/loopback
-
-- Immediate support is available through our subscription plans, see
+Immediate support:
   https://strongloop.com/api-connect-faqs/
+  https://strongloop.com/node-js/subscription-plans/
 -->
 
-### Bug or feature request
+# Description/Steps to reproduce
 
 <!--
-Mark your choice with an "x" (eg. [x], NOT [*]).
+If feature: A description of the feature
+If bug: Steps to reproduce
 -->
 
-- [ ] Bug
-- [ ] Feature request
-
-### Description of feature (or steps to reproduce if bug)
-
-
-
-### Link to sample repo to reproduce issue (if bug)
-
-
-
-### Expected result
+# Link to reproduction sandbox
 
+<!--
+Link to an app sandbox for reproduction
 
+Note: Failure to provide a sandbox application for reproduction purposes will result in the issue being closed.
+-->
 
-### Actual result (if bug)
-
-
+# Expected result
 
-### Additional information (Node.js version, LoopBack version, etc)
+<!--
+Also include actual results if bug
+-->
 
+# Additional information
 
+<!--
+Copy+paste the output of these two commands:
+  node -e 'console.log(process.platform, process.arch, process.versions.node)'
+  npm ls --prod --depth 0 | grep loopback
+-->

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -6,17 +6,18 @@
 <!--
 Please use the following link syntaxes:
 
-- #49 (to reference issues in the current repository)
-- strongloop/loopback#49 (to reference issues in another repository)
+- connect to #49 (to reference issues in the current repository)
+- connect to strongloop/loopback#49 (to reference issues in another repository)
 -->
 
-- None
+- connect to <link_to_referenced_issue>
 
 ### Checklist
 
 <!--
-Please mark your choice with an "x" (i.e. [x], see
+- Please mark your choice with an "x" (i.e. [x], see
 https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments)
+- PR's without test coverage will be closed.
 -->
 
 - [ ] New tests added or existing tests modified to cover all changes

package/CHANGES.md

@@ -1,3 +1,41 @@
+2018-06-12, 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
+=========================
+
+ * Escape strings in HTML output (XSS fix) (Zachery Metcalf)
+
+ * Update LICENSE.md (Diana Lau)
+
+
+2017-10-13, Version 2.3.0
+=========================
+
+ * update strong-globalize to 3.1.0 (shimks)
+
+ * CODEOWNERS: add zbarbuto (Miroslav Bajtoš)
+
+ * Update Issue and PR Templates (#59) (Sakib Hasan)
+
+ * fixed json typo of server/middleware.json (karanssj4)
+
+ * Add CODEOWNER file (Diana Lau)
+
+
 2017-07-20, Version 2.2.0
 =========================
 

package/CODEOWNERS

@@ -0,0 +1,5 @@
+# Lines starting with '#' are comments.
+# Each line is a file pattern followed by one or more owners,
+# the last matching pattern has the most precendence.
+
+* @bajtos @zbarbuto

package/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) IBM Corp. 2016. All Rights Reserved.
+Copyright (c) IBM Corp. 2016,2017. All Rights Reserved.
 Node module: strong-error-handler
 This project is licensed under the MIT License, full text below.
 

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
@@ -121,7 +129,7 @@ Then in `server/middleware.json`, specify your custom error logging function as
     "./middleware/error-logger": {},
     "strong-error-handler": {
       "params": {
-        log: false
+        "log": false
       }
     }
 }

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/package.json

@@ -2,9 +2,9 @@
   "name": "strong-error-handler",
   "description": "Error handler for use in development and production environments.",
   "license": "MIT",
-  "version": "2.2.0",
+  "version": "3.0.0",
   "engines": {
-    "node": ">=4"
+    "node": ">=6"
   },
   "repository": {
     "type": "git",
@@ -18,19 +18,19 @@
   },
   "dependencies": {
     "accepts": "^1.3.3",
-    "debug": "^2.2.0",
-    "ejs": "^2.4.2",
-    "http-status": "^1.0.0",
+    "debug": "^3.1.0",
+    "ejs": "^2.6.1",
+    "http-status": "^1.1.2",
     "js2xmlparser": "^3.0.0",
-    "strong-globalize": "^2.6.7"
+    "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

package/views/default-error.ejs

@@ -1,19 +1,19 @@
 <html>
   <head>
     <meta charset='utf-8'>
-    <title><%- data.name || data.message %></title>
+    <title><%= data.name || data.message %></title>
     <style><%- include style.css %></style>
   </head>
   <body>
     <div id="wrapper">
-      <h1><%- data.name %></h1>
-      <h2><em><%- data.statusCode %></em> <%- data.message %></h2>
+      <h1><%= data.name %></h1>
+      <h2><em><%= data.statusCode %></em> <%= data.message %></h2>
       <%
         // display all the non-standard properties
         var standardProps = ['name', 'statusCode', 'message', 'stack'];
         for (var prop in data) {
           if (standardProps.indexOf(prop) == -1 && data[prop]) { %>
-            <div><b><%- prop %></b>: <%- data[prop] %></div>
+            <div><b><%= prop %></b>: <%= data[prop] %></div>
           <% }
         }
         if (data.stack) { %>