lint: format eggspress.js

It's about time to do this now. This file will for the first time (in...
ever?) be indented with 4 spaces instead of 2.
This commit is contained in:
KernelDeimos
2025-11-20 21:34:21 -05:00
committed by Eric Dubé
parent 71a26156bd
commit 2ae2d3c9af
+193 -195
View File
@@ -17,8 +17,6 @@
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/* eslint-disable @stylistic/indent */
const express = require('express');
const multer = require('multer');
const multest = require('@heyputer/multest');
@@ -43,229 +41,229 @@ const config = require('../../../config.js');
* @param {*} handler the handler for the router
* @returns {express.Router} the router
*/
module.exports = function eggspress(route, settings, handler) {
const router = express.Router();
const mw = [];
const afterMW = [];
module.exports = function eggspress (route, settings, handler) {
const router = express.Router();
const mw = [];
const afterMW = [];
const _defaultJsonOptions = {};
if ( settings.jsonCanBeLarge ) {
_defaultJsonOptions.limit = '10mb';
}
// These flags enable specific middleware.
if ( settings.abuse ) mw.push(require('../../../middleware/abuse')(settings.abuse));
if ( settings.verified ) mw.push(require('../../../middleware/verified'));
// if json explicitly set false, don't use it
if ( settings.json !== false ) {
if ( settings.json ) mw.push(express.json(_defaultJsonOptions));
// A hack so plain text is parsed as JSON in methods which need to be lower latency/avoid the cors roundtrip
if ( settings.noReallyItsJson ) mw.push(express.json({ ..._defaultJsonOptions, type: '*/*' }));
mw.push(express.json({
..._defaultJsonOptions,
type: (req) => req.headers['content-type'] === 'text/plain;actually=json',
}));
}
if ( settings.auth ) mw.push(require('../../../middleware/auth'));
if ( settings.auth2 ) mw.push(require('../../../middleware/auth2'));
// The `files` setting is an array of strings. Each string is the name
// of a multipart field that contains files. `multer` is used to parse
// the multipart request and store the files in `req.files`.
if ( settings.files ) {
for ( const key of settings.files ) {
mw.push(multer().array(key));
const _defaultJsonOptions = {};
if ( settings.jsonCanBeLarge ) {
_defaultJsonOptions.limit = '10mb';
}
}
if ( settings.multest ) {
mw.push(multest());
}
// These flags enable specific middleware.
if ( settings.abuse ) mw.push(require('../../../middleware/abuse')(settings.abuse));
if ( settings.verified ) mw.push(require('../../../middleware/verified'));
// The `multipart_jsons` setting is an array of strings. Each string
// is the name of a multipart field that contains JSON. This middleware
// parses the JSON in each field and stores the result in `req.body`.
if ( settings.multipart_jsons ) {
for ( const key of settings.multipart_jsons ) {
mw.push((req, res, next) => {
try {
if ( !Array.isArray(req.body[key]) ) {
req.body[key] = [JSON.parse(req.body[key])];
} else {
req.body[key] = req.body[key].map(JSON.parse);
}
} catch ( _e ) {
return res.status(400).send({
error: {
message: `Invalid JSON in multipart field ${key}`,
},
});
// if json explicitly set false, don't use it
if ( settings.json !== false ) {
if ( settings.json ) mw.push(express.json(_defaultJsonOptions));
// A hack so plain text is parsed as JSON in methods which need to be lower latency/avoid the cors roundtrip
if ( settings.noReallyItsJson ) mw.push(express.json({ ..._defaultJsonOptions, type: '*/*' }));
mw.push(express.json({
..._defaultJsonOptions,
type: (req) => req.headers['content-type'] === 'text/plain;actually=json',
}));
}
if ( settings.auth ) mw.push(require('../../../middleware/auth'));
if ( settings.auth2 ) mw.push(require('../../../middleware/auth2'));
// The `files` setting is an array of strings. Each string is the name
// of a multipart field that contains files. `multer` is used to parse
// the multipart request and store the files in `req.files`.
if ( settings.files ) {
for ( const key of settings.files ) {
mw.push(multer().array(key));
}
next();
});
}
}
// The `alias` setting is an object. Each key is the name of a
// parameter. Each value is the name of a parameter that should
// be aliased to the key.
if ( settings.alias ) {
for ( const alias in settings.alias ) {
const target = settings.alias[alias];
mw.push((req, res, next) => {
const values = req.method === 'GET' ? req.query : req.body;
if ( values[alias] ) {
values[target] = values[alias];
if ( settings.multest ) {
mw.push(multest());
}
// The `multipart_jsons` setting is an array of strings. Each string
// is the name of a multipart field that contains JSON. This middleware
// parses the JSON in each field and stores the result in `req.body`.
if ( settings.multipart_jsons ) {
for ( const key of settings.multipart_jsons ) {
mw.push((req, res, next) => {
try {
if ( ! Array.isArray(req.body[key]) ) {
req.body[key] = [JSON.parse(req.body[key])];
} else {
req.body[key] = req.body[key].map(JSON.parse);
}
} catch ( _e ) {
return res.status(400).send({
error: {
message: `Invalid JSON in multipart field ${key}`,
},
});
}
next();
});
}
next();
});
}
}
// The `parameters` setting is an object. Each key is the name of a
// parameter. Each value is a `Param` object. The `Param` object
// specifies how to validate the parameter.
if ( settings.parameters ) {
for ( const key in settings.parameters ) {
const param = settings.parameters[key];
mw.push(async (req, res, next) => {
if ( !req.values ) req.values = {};
const values = req.method === 'GET' ? req.query : req.body;
const getParam = (key) => values[key];
try {
const result = await param.consolidate({ req, getParam });
req.values[key] = result;
} catch (e) {
api_error_handler(e, req, res, next);
return;
// The `alias` setting is an object. Each key is the name of a
// parameter. Each value is the name of a parameter that should
// be aliased to the key.
if ( settings.alias ) {
for ( const alias in settings.alias ) {
const target = settings.alias[alias];
mw.push((req, res, next) => {
const values = req.method === 'GET' ? req.query : req.body;
if ( values[alias] ) {
values[target] = values[alias];
}
next();
});
}
next();
});
}
}
// what if I wanted to pass arguments to, for example, `json`?
if ( settings.customArgs ) mw.push(settings.customArgs);
// The `parameters` setting is an object. Each key is the name of a
// parameter. Each value is a `Param` object. The `Param` object
// specifies how to validate the parameter.
if ( settings.parameters ) {
for ( const key in settings.parameters ) {
const param = settings.parameters[key];
mw.push(async (req, res, next) => {
if ( ! req.values ) req.values = {};
if ( settings.alarm_timeout ) {
mw.push((req, res, next) => {
setTimeout(() => {
if ( !res.headersSent ) {
const log = req.services.get('log-service').create('eggspress:timeout');
const errors = req.services.get('error-service').create(log);
let id = Array.isArray(route) ? route[0] : route;
id = id.replace(/\//g, '_');
errors.report(id, {
source: new Error('Response timed out.'),
message: 'Response timed out.',
trace: true,
alarm: true,
});
const values = req.method === 'GET' ? req.query : req.body;
const getParam = (key) => values[key];
try {
const result = await param.consolidate({ req, getParam });
req.values[key] = result;
} catch (e) {
api_error_handler(e, req, res, next);
return;
}
next();
});
}
}, settings.alarm_timeout);
next();
});
}
if ( settings.response_timeout ) {
mw.push((req, res, next) => {
setTimeout(() => {
if ( !res.headersSent ) {
api_error_handler(APIError.create('response_timeout'), req, res, next);
}
}, settings.response_timeout);
next();
});
}
if ( settings.mw ) {
mw.push(...settings.mw);
}
const errorHandledHandler = async function(req, res, next) {
if ( settings.subdomain ) {
if ( subdomain(req) !== settings.subdomain ) {
return next();
}
}
if ( config.env === 'dev' && process.env.DEBUG ) {
console.log(`request url: ${req.url}, body: ${JSON.stringify(req.body)}`);
}
try {
const expected_ctx = res.locals.ctx;
const received_ctx = Context.get(undefined, { allow_fallback: true });
if ( expected_ctx != received_ctx ) {
await expected_ctx.arun(async () => {
await handler(req, res, next);
// what if I wanted to pass arguments to, for example, `json`?
if ( settings.customArgs ) mw.push(settings.customArgs);
if ( settings.alarm_timeout ) {
mw.push((req, res, next) => {
setTimeout(() => {
if ( ! res.headersSent ) {
const log = req.services.get('log-service').create('eggspress:timeout');
const errors = req.services.get('error-service').create(log);
let id = Array.isArray(route) ? route[0] : route;
id = id.replace(/\//g, '_');
errors.report(id, {
source: new Error('Response timed out.'),
message: 'Response timed out.',
trace: true,
alarm: true,
});
}
}, settings.alarm_timeout);
next();
});
} else await handler(req, res, next);
} catch (e) {
if ( config.env === 'dev' ) {
if ( !(e instanceof APIError) ) {
// Any non-APIError indicates an unhandled error (i.e. a bug) from the backend.
// We add a dedicated branch to facilitate debugging.
console.error(e);
}
}
api_error_handler(e, req, res, next);
}
};
if ( settings.allowedMethods.includes('GET') ) {
router.get(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('HEAD') ) {
router.head(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.response_timeout ) {
mw.push((req, res, next) => {
setTimeout(() => {
if ( ! res.headersSent ) {
api_error_handler(APIError.create('response_timeout'), req, res, next);
}
}, settings.response_timeout);
next();
});
}
if ( settings.allowedMethods.includes('POST') ) {
router.post(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.mw ) {
mw.push(...settings.mw);
}
if ( settings.allowedMethods.includes('PUT') ) {
router.put(route, ...mw, errorHandledHandler, ...afterMW);
}
const errorHandledHandler = async function (req, res, next) {
if ( settings.subdomain ) {
if ( subdomain(req) !== settings.subdomain ) {
return next();
}
}
if ( config.env === 'dev' && process.env.DEBUG ) {
console.log(`request url: ${req.url}, body: ${JSON.stringify(req.body)}`);
}
try {
const expected_ctx = res.locals.ctx;
const received_ctx = Context.get(undefined, { allow_fallback: true });
if ( settings.allowedMethods.includes('DELETE') ) {
router.delete(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( expected_ctx != received_ctx ) {
await expected_ctx.arun(async () => {
await handler(req, res, next);
});
} else await handler(req, res, next);
} catch (e) {
if ( config.env === 'dev' ) {
if ( ! (e instanceof APIError) ) {
// Any non-APIError indicates an unhandled error (i.e. a bug) from the backend.
// We add a dedicated branch to facilitate debugging.
console.error(e);
}
}
api_error_handler(e, req, res, next);
}
};
if ( settings.allowedMethods.includes('GET') ) {
router.get(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('PROPFIND') ) {
router.propfind(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('HEAD') ) {
router.head(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('PROPPATCH') ) {
router.proppatch(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('POST') ) {
router.post(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('MKCOL') ) {
router.mkcol(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('PUT') ) {
router.put(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('COPY') ) {
router.copy(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('DELETE') ) {
router.delete(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('MOVE') ) {
router.move(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('PROPFIND') ) {
router.propfind(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('LOCK') ) {
router.lock(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('PROPPATCH') ) {
router.proppatch(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('UNLOCK') ) {
router.unlock(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('MKCOL') ) {
router.mkcol(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('OPTIONS') ) {
router.options(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('COPY') ) {
router.copy(route, ...mw, errorHandledHandler, ...afterMW);
}
return router;
if ( settings.allowedMethods.includes('MOVE') ) {
router.move(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('LOCK') ) {
router.lock(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('UNLOCK') ) {
router.unlock(route, ...mw, errorHandledHandler, ...afterMW);
}
if ( settings.allowedMethods.includes('OPTIONS') ) {
router.options(route, ...mw, errorHandledHandler, ...afterMW);
}
return router;
};