diff --git a/Framework/Backend/http/server.js b/Framework/Backend/http/server.js index f55090bb8..dacda56b5 100644 --- a/Framework/Backend/http/server.js +++ b/Framework/Backend/http/server.js @@ -233,21 +233,41 @@ class HttpServer { res.status(404).sendFile(path.join(__dirname, '../../Frontend/404.html')); }); + /** + * Ensures important information is saved in an error. + * @param {*} err - The error to serialize. + */ + function serializeError(err) { + if (err && typeof err === 'object') { + return { + ...err, // Keeps any custom enumerable properties + name: err.name, + message: err.message, + stack: err.stack, + }; + } + return { message: String(err) }; + } + // Error handler when an API controller crashes this.app.use('/api', (err, req, res, next) => { this.logger.errorMessage(`Request ${this._parseOriginalUrl(req)} failed: ${err.message || err}`); this.logger.trace(err); + if (res.headersSent) { + return next(err); + } + if (process.env.NODE_ENV === 'development') { - res.status(500).json({ - error: err, - }); - } else { - res.status(500).json({ - error: '500 - Server error', - message: 'Something went wrong, please try again or contact an administrator.', + return res.status(500).json({ + error: serializeError(err), }); } + + res.status(500).json({ + error: '500 - Server error', + message: 'Something went wrong, please try again or contact an administrator.', + }); }); // Error handler when a controller crashes diff --git a/Framework/Backend/test/mocha-http.js b/Framework/Backend/test/mocha-http.js index 859080466..5cb31deb3 100644 --- a/Framework/Backend/test/mocha-http.js +++ b/Framework/Backend/test/mocha-http.js @@ -117,6 +117,24 @@ describe('REST API', () => { }, done); }); + it('Error route should respond with message and stack when NODE_ENV = development', async () => { + const prevNodeEnv = process.env.NODE_ENV; + process.env.NODE_ENV = 'development'; + try { + httpServer.get('/get-error', (req, res, next) => next(new Error('Some unexpected error'))); + const { body } = await request(httpServer) + .get(`/api/get-error?token=${token}`) + .expect('Content-Type', /json/) + .expect(500); + + assert.strictEqual(body.error.name, 'Error'); + assert.strictEqual(body.error.message, 'Some unexpected error'); + assert.ok(body.error.stack.includes('Some unexpected error')); + } finally { + process.env.NODE_ENV = prevNodeEnv; + } + }); + it('GET with token should respond 200/JSON', (done) => { request(httpServer) .get(`/api/get-request?token=${token}`)