feat(error debug) #125 - Return a debug key containing the stack when an unknown error occured if debug is enabled

Signed-off-by: Jeremy Trufier <[email protected]>

Author: Tronix117

README.md

@@ -118,6 +118,7 @@ Example:
     "host": "https://www.mydomain.com",
     "enable": true,
     "handleErrors": true,
+    "errorStackInResponse": false,
     "exclude": [
       {"model": "comment"},
       {"methods": "find"},
@@ -201,6 +202,25 @@ out of the box with EmberJS.
 - Type: `boolean`
 - Default: `true`
 
+### errorStackInResponse
+Along handleErrors, When true, this option will send the error stack if available within the error
+reponse. It will be stored under the `source.stack` key.
+
+**Be careful, this option should never be enabled in production environment. It can propagate some
+sensitive datas.**
+
+#### example
+```js
+{
+  ...
+  "errorStackInResponse": NODE_ENV === 'development',
+  ...
+}
+```
+
+- Type: `boolean`
+- Default: `false`
+
 ### exclude
 Allows blacklisting of models and methods.
 Define an array of blacklist objects. Blacklist objects can contain "model" key

lib/errors.js

@@ -1,10 +1,12 @@
 'use strict'
 
 var debug
+var errorStackInResponse
 var statusCodes = require('http-status-codes')
 
 module.exports = function (app, options) {
   debug = options.debug
+  errorStackInResponse = options.errorStackInResponse
 
   if (options.handleErrors !== false) {
     debug(
@@ -80,7 +82,7 @@ function JSONAPIErrorHandler (err, req, res, next) {
     }
 
     errors.push(
-      buildErrorResponse(statusCode, err.message, err.code, err.name)
+      buildErrorResponse(statusCode, err.message, err.code, err.name, null, err.stack)
     )
   } else {
     debug(
@@ -112,20 +114,28 @@ function JSONAPIErrorHandler (err, req, res, next) {
  * @param {String} errorCode internal system error code
  * @param {String} errorName error title for the user, human readable
  * @param {String} propertyName for validation errors, name of property validation refers to
+ * @param {String} errorStack Some debbuging informations
  * @return {Object}
  */
 function buildErrorResponse (
   httpStatusCode,
   errorDetail,
   errorCode,
   errorName,
-  propertyName
+  propertyName,
+  errorStack
 ) {
-  return {
+  var out = {
     status: httpStatusCode || statusCodes.INTERNAL_SERVER_ERROR,
-    source: propertyName ? { pointer: 'data/attributes/' + propertyName } : '',
+    source: propertyName ? { pointer: 'data/attributes/' + propertyName } : {},
     title: errorName || '',
     code: errorCode || '',
     detail: errorDetail || ''
   }
+
+  if (errorStackInResponse && errorStack) {
+    out.source.stack = errorStack
+  }
+
+  return out
 }

test/errors.test.js

@@ -2,6 +2,7 @@
 
 var request = require('supertest')
 var loopback = require('loopback')
+var _ = require('lodash')
 var expect = require('chai').expect
 var JSONAPIComponent = require('../')
 var app
@@ -24,7 +25,7 @@ describe('disabling loopback-component-jsonapi error handler', function () {
     request(app).get('/posts/100').end(function (err, res) {
       expect(err).to.equal(null)
       expect(res.body).to.have.keys('error')
-      expect(res.body.error).to.have.keys('name', 'message', 'statusCode')
+      expect(res.body.error).to.have.keys('name', 'message', 'statusCode', 'code')
       done()
     })
   })
@@ -87,7 +88,7 @@ describe('loopback json api errors', function () {
           status: 404,
           code: 'MODEL_NOT_FOUND',
           detail: 'Unknown "post" id "100".',
-          source: '',
+          source: {},
           title: 'Error'
         })
         done()
@@ -129,7 +130,7 @@ describe('loopback json api errors', function () {
               status: 422,
               code: 'presence',
               detail: 'JSON API resource object must contain `data.type` property',
-              source: '',
+              source: {},
               title: 'ValidationError'
             })
             done()
@@ -178,3 +179,49 @@ describe('loopback json api errors', function () {
     )
   })
 })
+
+describe('loopback json api errors with `errorStackInResponse` enabled', function () {
+  beforeEach(function () {
+    app = loopback()
+    app.set('legacyExplorer', false)
+    var ds = loopback.createDataSource('memory')
+    Post = ds.createModel('post', {
+      id: { type: Number, id: true },
+      title: String,
+      content: String
+    })
+    app.model(Post)
+    app.use(loopback.rest())
+    JSONAPIComponent(app, { restApiRoot: '', errorStackInResponse: true })
+  })
+
+  it(
+    'POST /models should return a more specific 422 status code on the error object if type key is not present',
+    function (done) {
+      request(app)
+        .post('/posts')
+        .send({
+          data: {
+            attributes: { title: 'my post', content: 'my post content' }
+          }
+        })
+        .set('Content-Type', 'application/json')
+        .end(function (err, res) {
+          expect(err).to.equal(null)
+          expect(res.body).to.have.keys('errors')
+          expect(res.body.errors.length).to.equal(1)
+
+          expect(res.body.errors[0].source).to.haveOwnProperty('stack')
+          expect(res.body.errors[0].source.stack.length).to.be.above(100)
+
+          expect(_.omit(res.body.errors[0], 'source')).to.deep.equal({
+            status: 422,
+            code: 'presence',
+            detail: 'JSON API resource object must contain `data.type` property',
+            title: 'ValidationError'
+          })
+          done()
+        })
+    }
+  )
+})