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

refactor: closes #10509

Browse Source 
deprecate third param(middleware) to setupPageRoute/setupAdminPageRoute
make middlewares optional on all 3 helpers
This commit is contained in:
Barış Soner Uşaklı
2022-04-22 15:22:08 -04:00
parent 976914e71f
commit 7f241dbbe6
1 changed files with 31 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
src/routes/helpers.js
View File

@@ -1,17 +1,18 @@
'use strict'; 'use strict';
const helpers = module.exports; const helpers = module.exports;
const winston = require('winston');
const middleware = require('../middleware'); const middleware = require('../middleware');
const controllerHelpers = require('../controllers/helpers'); const controllerHelpers = require('../controllers/helpers');
function _handleArgs(middleware, middlewares, controller) { // router, name, middleware(deprecated), middlewares(optional), controller
if (typeof middlewares === 'function') { helpers.setupPageRoute = function (...args) {
if (controller) { const [router, name] = args;
middlewares = [middlewares]; let middlewares = args.length > 3 ? args[args.length - 2] : [];
} else { const controller = args[args.length - 1];
controller = middlewares;
middlewares = []; if (args.length === 5) {
} winston.warn('[helpers.setupPageRotue] passing middleware as third param is deprecated');
} }
middlewares = [ middlewares = [
@@ -20,15 +21,9 @@ function _handleArgs(middleware, middlewares, controller) {
middleware.registrationComplete, middleware.registrationComplete,
middleware.pluginHooks, middleware.pluginHooks,
...middlewares, ...middlewares,
middleware.pageView,
]; ];
return { middlewares, controller };
}
helpers.setupPageRoute = function (router, name, middleware, middlewares, controller) {
({ middlewares, controller } = _handleArgs(middleware, middlewares, controller));
middlewares.push(middleware.pageView);
router.get( router.get(
name, name,
middleware.busyCheck, middleware.busyCheck,
@@ -39,13 +34,31 @@ helpers.setupPageRoute = function (router, name, middleware, middlewares, contro
router.get(`/api${name}`, middlewares, helpers.tryRoute(controller)); router.get(`/api${name}`, middlewares, helpers.tryRoute(controller));
}; };
helpers.setupAdminPageRoute = function (router, name, middleware, middlewares, controller) { // router, name, middleware(deprecated), middlewares(optional), controller
helpers.setupAdminPageRoute = function (...args) {
const [router, name] = args;
const middlewares = args.length > 3 ? args[args.length - 2] : [];
const controller = args[args.length - 1];
if (args.length === 5) {
winston.warn('[helpers.setupAdminPageRoute] passing middleware as third param is deprecated');
}
router.get(name, middleware.admin.buildHeader, middlewares, helpers.tryRoute(controller)); router.get(name, middleware.admin.buildHeader, middlewares, helpers.tryRoute(controller));
router.get(`/api${name}`, middlewares, helpers.tryRoute(controller)); router.get(`/api${name}`, middlewares, helpers.tryRoute(controller));
}; };
helpers.setupApiRoute = function (router, verb, name, middlewares, controller) { // router, verb, name, middlewares(optional), controller
({ middlewares, controller } = _handleArgs(middleware, middlewares, controller)); helpers.setupApiRoute = function (...args) {
const [router, verb, name] = args;
let middlewares = args.length > 4 ? args[args.length - 2] : [];
const controller = args[args.length - 1];
middlewares = [
middleware.authenticateRequest,
middleware.maintenanceMode,
middleware.registrationComplete,
middleware.pluginHooks,
...middlewares,
];
router[verb](name, middlewares, helpers.tryRoute(controller, (err, res) => { router[verb](name, middlewares, helpers.tryRoute(controller, (err, res) => {
controllerHelpers.formatApiResponse(400, res, err); controllerHelpers.formatApiResponse(400, res, err);