update errorHandler template

3.0-RELEASE-NOTES.md

@@ -127,3 +127,29 @@ removed properties together with the middleware module name to use instead:
 We have also removed `loopback.mime`, which was always set to `undefined`.
 
 See [loopback#2349](https://github.com/strongloop/loopback/pull/2394).
+
+## Remove `loopback#errorhandler`
+
+We have removed `loopback#errorhandler` middleware, users should use `strong-error-handler` directly.
+
+```js
+// server/middleware.json
+{
+  // ...
+  "final:after": {
+    "strong-error-handler": {}
+  }
+}
+
+// server/middleware.development.json
+{
+  "final:after": {
+    "strong-error-handler": {
+      "params": {
+        "debug": true
+      }
+  }
+}
+```
+
+See also strong-error-handler's [options](https://github.com/strongloop/strong-error-handler#options) and the [related code change](https://github.com/strongloop/loopback/pull/2411).

package.json

@@ -44,7 +44,6 @@
     "debug": "^2.1.2",
     "depd": "^1.0.0",
     "ejs": "^2.3.1",
-    "errorhandler": "^1.3.4",
     "express": "^4.12.2",
     "inflection": "^1.6.0",
     "loopback-connector-remote": "^1.0.3",
@@ -59,6 +58,7 @@
     "underscore.string": "^3.0.3"
   },
   "devDependencies": {
+    "strong-error-handler": "^1.0.1",
     "browserify": "^10.0.0",
     "chai": "^2.1.1",
     "cookie-parser": "^1.3.4",

server/middleware/error-handler.js

@@ -3,19 +3,7 @@
 // This file is licensed under the MIT License.
 // License text available at https://opensource.org/licenses/MIT
 
-var expressErrorHandler = require('errorhandler');
-expressErrorHandler.title = 'Loopback';
-
-module.exports = errorHandler;
-
-function errorHandler(options) {
-  if (!options || options.includeStack !== false) {
-    return expressErrorHandler(options);
-  } else {
-    var baseHandler = expressErrorHandler(options);
-    return function errorHandler(err, req, res, next) {
-      delete err.stack;
-      return baseHandler(err, req, res, next);
-    };
-  }
-}
+module.exports = function(options) {
+  throw new Error('loopback.errorHandler is no longer available.' +
+  ' Please use the module "strong-error-handler" instead.');
+};

test/error-handler.test.js

@@ -7,61 +7,19 @@ var loopback = require('../');
 var app;
 var assert = require('assert');
 var request = require('supertest');
+var expect = require('chai').expect;
 
 describe('loopback.errorHandler(options)', function() {
-  it('should return default middleware when options object is not present', function(done) {
+  it('should throw a descriptive error', function(done) {
+    try {
   //arrange
       var app = loopback();
       app.use(loopback.urlNotFound());
       app.use(loopback.errorHandler({ log: false }));
-
-    //act/assert
-    request(app)
-      .get('/url-does-not-exist')
-      .end(function(err, res) {
-        assert.ok(res.error.text.match(/<ul id="stacktrace"><li> &nbsp; &nbsp;at raiseUrlNotFoundError/));
-
+    } catch (e) {
+      expect(function() { loopback.errorHandler(); })
+      .to.throw(/no longer available.*strong-error-handler/);
       done();
-      });
-  });
-
-  it('should delete stack when options.includeStack is false', function(done) {
-    //arrange
-    var app = loopback();
-    app.use(loopback.urlNotFound());
-    app.use(loopback.errorHandler({ includeStack: false, log: false }));
-
-    //act/assert
-    request(app)
-      .get('/url-does-not-exist')
-      .end(function(err, res) {
-        assert.ok(res.error.text.match(/<ul id="stacktrace"><\/ul>/));
-
-        done();
-      });
-  });
-
-  it('should pass options on to error handler module', function(done) {
-    //arrange
-    var app = loopback();
-    app.use(loopback.urlNotFound());
-
-    var errorLogged;
-    app.use(loopback.errorHandler({
-      includeStack: false,
-      log: function customLogger(err, str, req) {
-        errorLogged = err;
-      },
-    }));
-
-    //act
-    request(app).get('/url-does-not-exist').end(function(err) {
-      if (err) return done(err);
-      //assert
-      expect(errorLogged)
-        .to.have.property('message', 'Cannot GET /url-does-not-exist');
-
-      done();
-    });
+    }
   });
 });

test/fixtures/access-control/server/server.js

@@ -6,7 +6,7 @@
 var loopback = require('../../../..');
 var boot = require('loopback-boot');
 var app = module.exports = loopback();
-
+var errorHandler = require('strong-error-handler');
 boot(app, __dirname);
 
 var apiPath = '/api';
@@ -14,5 +14,5 @@ app.use(loopback.token({ model: app.models.accessToken }));
 app.use(apiPath, loopback.rest());
 
 app.use(loopback.urlNotFound());
-app.use(loopback.errorHandler());
+app.use(errorHandler());
 app.enableAuth();

test/fixtures/simple-integration-app/server/server.js

@@ -6,9 +6,10 @@
 var loopback = require('../../../../index');
 var boot = require('loopback-boot');
 var app = module.exports = loopback();
+var errorHandler = require('strong-error-handler');
 
 boot(app, __dirname);
 var apiPath = '/api';
 app.use(apiPath, loopback.rest());
 app.use(loopback.urlNotFound());
-app.use(loopback.errorHandler());
+app.use(errorHandler());

test/fixtures/user-integration-app/server/server.js

@@ -6,10 +6,11 @@
 var loopback = require('../../../../index');
 var boot = require('loopback-boot');
 var app = module.exports = loopback();
+var errorHandler = require('strong-error-handler');
 app.enableAuth();
 boot(app, __dirname);
 app.use(loopback.token({ model: app.models.AccessToken }));
 var apiPath = '/api';
 app.use(apiPath, loopback.rest());
 app.use(loopback.urlNotFound());
-app.use(loopback.errorHandler());
+app.use(errorHandler());