Nemcio/NodeBB
1
0
Fork 0
mirror of https://github.com/NodeBB/NodeBB.git synced 2025-10-26 16:46:12 +01:00
Code Issues Packages Projects Releases Wiki Activity

fix: return proper API-style response if exception caught by error handler on v3 routes [breaking]

Browse Source
This commit is contained in:
Julian Lam
2021-07-09 10:30:46 -04:00
parent ae14016efc
commit a54a3ee1ca
2 changed files with 12 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/controllers/errors.js
View File

@@ -5,7 +5,8 @@ const winston = require('winston');
const validator = require('validator'); const validator = require('validator');
const plugins = require('../plugins'); const plugins = require('../plugins');
const middleware = require('../middleware'); const middleware = require('../middleware');
const helpers = require('../middleware/helpers'); const middlewareHelpers = require('../middleware/helpers');
const helpers = require('./helpers');
exports.handleURIErrors = async function handleURIErrors(err, req, res, next) { exports.handleURIErrors = async function handleURIErrors(err, req, res, next) {
// Handle cases where malformed URIs are passed in // Handle cases where malformed URIs are passed in
@@ -53,15 +54,18 @@ exports.handleErrors = function handleErrors(err, req, res, next) { // eslint-di
return res.locals.isAPI ? res.set('X-Redirect', err.path).status(200).json(err.path) : res.redirect(nconf.get('relative_path') + err.path); return res.locals.isAPI ? res.set('X-Redirect', err.path).status(200).json(err.path) : res.redirect(nconf.get('relative_path') + err.path);
} }
winston.error(`${req.path}\n${err.stack}`);
res.status(status || 500);
const path = String(req.path || ''); const path = String(req.path || '');
if (path.startsWith(`${nconf.get('relative_path')}/api/v3`)) {
return helpers.formatApiResponse(err.message.startsWith('[[') ? 400 : 500, res, err);
}
winston.error(`${req.path}\n${err.stack}`);
res.status(status || 500);
const data = { const data = {
path: validator.escape(path), path: validator.escape(path),
error: validator.escape(String(err.message)), error: validator.escape(String(err.message)),
bodyClass: helpers.buildBodyClass(req, res), bodyClass: middlewareHelpers.buildBodyClass(req, res),
}; };
if (res.locals.isAPI) { if (res.locals.isAPI) {
res.json(data); res.json(data);

3
src/middleware/user.js
View File

@@ -65,7 +65,7 @@ module.exports = function (middleware) {
return true; return true;
} }
throw new Error('A master token was received without a corresponding `_uid` in the request body'); throw new Error('[[errors:api.master-token-no-uid]]');
} else { } else {
winston.warn('[api/authenticate] Unable to find user after verifying token'); winston.warn('[api/authenticate] Unable to find user after verifying token');
return true; return true;
@@ -84,6 +84,7 @@ module.exports = function (middleware) {
return !res.headersSent; return !res.headersSent;
} }
// TODO: Remove in v1.18.0
middleware.authenticate = helpers.try(async (req, res, next) => { middleware.authenticate = helpers.try(async (req, res, next) => {
winston.warn(`[middleware] middleware.authenticate has been deprecated, page and API routes are now automatically authenticated via setup(Page|API)Route. Use middleware.authenticateRequest (if not using route helper) and middleware.ensureLoggedIn instead. (request path: ${req.path})`); winston.warn(`[middleware] middleware.authenticate has been deprecated, page and API routes are now automatically authenticated via setup(Page|API)Route. Use middleware.authenticateRequest (if not using route helper) and middleware.ensureLoggedIn instead. (request path: ${req.path})`);
if (!await authenticate(req, res)) { if (!await authenticate(req, res)) {