v0.1.4 - add fix for res.headerssent, serialize errors in the response so that properties like 'stack' are included in the response

Author: Jorge Calderon

README.md

@@ -52,3 +52,7 @@ module.exports = getUsers;
 
 ##### 0.1.3
   - fix circular json in response
+
+##### 0.1.4
+  - add fix for res.headerssent
+  - serialize errors in the response so that properties like 'stack' are included in the response

lib/methods/jsonResponseError.js

@@ -9,6 +9,8 @@ const HTTP_STATUS_CODE_SERVER_ERROR = 500;
 
 const stringify = require('json-stringify-safe');
 
+const serializeError = require('serialize-error');
+
 /**
  * Respond to the client with an unsuccessful JSON payload.
  * @param {Object} req
@@ -17,8 +19,10 @@ const stringify = require('json-stringify-safe');
  * @param {Object} err
  * @returns {*}
  */
-const jsonResponseError = R.curry((req, res, err) => {
-
+const jsonResponseError = R.curry((req, res, next, err) => {
+  if (res.headersSent) {
+    return next(err);
+  }
   const statusCode = R.propOr(HTTP_STATUS_CODE_SERVER_ERROR, 'statusCode', err);
 
   const response = R.mergeRight(R.apply(R.bind(makeJsonResponseBody, req), [statusCode, req.flash]), { 'data' : R.omit(['statusCode'], err) });
@@ -28,7 +32,7 @@ const jsonResponseError = R.curry((req, res, err) => {
   }
 
   res.set('Content-Type', 'application/json');
-  return res.status(statusCode).send(stringify(response));
+  return res.status(statusCode).send(stringify(serializeError(response)));
 });
 
 module.exports = jsonResponseError;

package.json

@@ -1,35 +1,36 @@
 {
-  "name"            : "alien-node-api-utils",
-  "version"         : "0.1.3",
-  "description"     : "Helper functions for API handling on NodeJS",
-  "main"            : "lib/API.js",
-  "dependencies"    : {
-    "ramda"   : "^0.x.x",
-    "aybabtu" : "*"
+  "name": "alien-node-api-utils",
+  "version": "0.1.4",
+  "description": "Helper functions for API handling on NodeJS",
+  "main": "lib/API.js",
+  "dependencies": {
+    "aybabtu": "*",
+    "ramda": "^0.x.x",
+    "serialize-error": "^4.1.0"
   },
-  "devDependencies" : {
-    "coveralls" : "^2.11.2",
-    "istanbul"  : "^0.3.13",
-    "jasmine"   : "^2.3.1"
+  "devDependencies": {
+    "coveralls": "^2.11.2",
+    "istanbul": "^0.3.13",
+    "jasmine": "^2.3.1"
   },
-  "scripts"         : {
-    "test" : "./node_modules/.bin/istanbul cover ./node_modules/.bin/jasmine"
+  "scripts": {
+    "test": "./node_modules/.bin/istanbul cover ./node_modules/.bin/jasmine"
   },
-  "repository"      : {
-    "type" : "git",
-    "url"  : "https://github.com/aliencreations/alien-node-api-utils.git"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/aliencreations/alien-node-api-utils.git"
   },
-  "keywords"        : [
+  "keywords": [
     "aliencreations",
     "api",
     "util",
     "node",
     "ramda"
   ],
-  "author"          : "Sean Cannon",
-  "license"         : "MIT",
-  "bugs"            : {
-    "url" : "https://github.com/aliencreations/alien-node-api-utils/issues"
+  "author": "Sean Cannon",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/aliencreations/alien-node-api-utils/issues"
   },
-  "homepage"        : "https://github.com/aliencreations/alien-node-api-utils"
+  "homepage": "https://github.com/aliencreations/alien-node-api-utils"
 }

spec/jsonResponseErrorSpec.js

@@ -57,13 +57,15 @@ const EXPECTED_RESPONSE_DATA_NO_SESSION   = JSON.stringify({
         data       : FAKE_ERROR_RESPONSE_TRIMMED
       });
 
+const FAKE_NEXT = jasmine.createSpy('next');
+
 describe('makeJsonResponseError without session', () => {
 
   let response = {};
 
   beforeEach(() => {
     spyOn(mockRes, 'send');
-    response = jsonResponseError(mockReqNoSession, mockRes, FAKE_ERROR_RESPONSE);
+    response = jsonResponseError(mockReqNoSession, mockRes, FAKE_NEXT, FAKE_ERROR_RESPONSE);
   });
 
   it('executes the mock res.send function', () => {
@@ -78,7 +80,7 @@ describe('makeJsonResponseError without flash', () => {
 
   beforeEach(() => {
     spyOn(mockRes, 'send');
-    response = jsonResponseError(mockReqNoFlash, mockRes, FAKE_ERROR_RESPONSE);
+    response = jsonResponseError(mockReqNoFlash, mockRes, FAKE_NEXT, FAKE_ERROR_RESPONSE);
   });
 
   it('executes the mock res.send function', () => {
@@ -93,7 +95,7 @@ describe('makeJsonResponseError with session', () => {
 
   beforeEach(() => {
     spyOn(mockRes, 'send');
-    response = jsonResponseError(mockReqWithSession, mockRes, FAKE_ERROR_RESPONSE);
+    response = jsonResponseError(mockReqWithSession, mockRes, FAKE_NEXT, FAKE_ERROR_RESPONSE);
   });
 
   it('executes the mock res.send function', () => {

yarn.lock

@@ -696,6 +696,13 @@ safer-buffer@^2.0.2, safer-buffer@^2.1.0, safer-buffer@~2.1.0:
   resolved "https://registry.businesswire.npme.io/safer-buffer/-/safer-buffer-2.1.2.tgz#44fa161b0187b9549dd84bb91802f9bd8385cd6a"
   integrity sha512-YZo3K82SD7Riyi0E1EQPojLz7kpepnSQI9IyPbHHg1XXXevb5dJI7tpyN2ADxGcQbHG7vcyRHk0cbwqcQriUtg==
 
+serialize-error@^4.1.0:
+  version "4.1.0"
+  resolved "https://registry.businesswire.npme.io/serialize-error/-/serialize-error-4.1.0.tgz#63e1e33ede20bcd89d9f0528ea4c15fbf0f2b78a"
+  integrity sha512-5j9GgyGsP9vV9Uj1S0lDCvlsd+gc2LEPVK7HHHte7IyPwOD4lVQFeaX143gx3U5AnoCi+wbcb3mvaxVysjpxEw==
+  dependencies:
+    type-fest "^0.3.0"
+
 [email protected]:
   version "1.0.9"
   resolved "https://registry.businesswire.npme.io/sntp/-/sntp-1.0.9.tgz#6541184cc90aeea6c6e7b35e2659082443c66198"
@@ -783,6 +790,11 @@ type-check@~0.3.1:
   dependencies:
     prelude-ls "~1.1.2"
 
+type-fest@^0.3.0:
+  version "0.3.1"
+  resolved "https://registry.businesswire.npme.io/type-fest/-/type-fest-0.3.1.tgz#63d00d204e059474fe5e1b7c011112bbd1dc29e1"
+  integrity sha512-cUGJnCdr4STbePCgqNFbpVNCepa+kAVohJs1sLhxzdH+gnEoOd8VhbYa7pD3zZYGiURWM2xzEII3fQcRizDkYQ==
+
 uglify-js@^3.1.4:
   version "3.6.0"
   resolved "https://registry.businesswire.npme.io/uglify-js/-/uglify-js-3.6.0.tgz#704681345c53a8b2079fb6cec294b05ead242ff5"