mirror of
https://github.com/gristlabs/grist-core.git
synced 2024-09-28 10:20:48 +00:00
0cadb93d25
Summary: Changes the minimum version of Node to 18, and updates the Docker images and GitHub workflows to build Grist with Node 18. Also updates various dependencies and scripts to support building running tests with arm64 builds of Node. Test Plan: Existing tests. Reviewers: paulfitz Reviewed By: paulfitz Differential Revision: https://phab.getgrist.com/D3968
88 lines
3.0 KiB
TypeScript
88 lines
3.0 KiB
TypeScript
import {RequestWithLogin} from 'app/server/lib/Authorizer';
|
|
import log from 'app/server/lib/log';
|
|
import * as express from 'express';
|
|
|
|
export type AsyncRequestHandler = (
|
|
req: express.Request,
|
|
res: express.Response,
|
|
next: express.NextFunction
|
|
) => any | Promise<any>;
|
|
|
|
/**
|
|
* Wrapper for async express endpoints to catch errors and forward them to the error handler.
|
|
*/
|
|
export function expressWrap(callback: AsyncRequestHandler): express.RequestHandler {
|
|
return async (req, res, next) => {
|
|
try {
|
|
await callback(req, res, next);
|
|
} catch (err) {
|
|
next(err);
|
|
}
|
|
};
|
|
}
|
|
|
|
interface JsonErrorHandlerOptions {
|
|
shouldLogBody?: boolean;
|
|
shouldLogParams?: boolean;
|
|
}
|
|
|
|
/**
|
|
* Returns a custom error-handling middleware that responds to errors in json.
|
|
*
|
|
* Currently allows for toggling of logging request bodies and params.
|
|
*/
|
|
const buildJsonErrorHandler = (options: JsonErrorHandlerOptions = {}): express.ErrorRequestHandler => {
|
|
const {shouldLogBody, shouldLogParams} = options;
|
|
return (err, req, res, _next) => {
|
|
const mreq = req as RequestWithLogin;
|
|
const meta = {
|
|
path: mreq.path,
|
|
userId: mreq.userId,
|
|
altSessionId: mreq.altSessionId,
|
|
body: shouldLogBody !== false ? req.body : undefined,
|
|
params: shouldLogParams !== false ? req.params : undefined,
|
|
};
|
|
const headersNote = res.headersSent ? " (headersSent)" : "";
|
|
log.rawWarn(`Error during api call to ${meta.path}${headersNote}: ${err.message}`, meta);
|
|
let details = err.details && {...err.details};
|
|
const status = details?.status || err.status || 500;
|
|
if (details) {
|
|
// Remove some details exposed for websocket API only.
|
|
delete details.accessMode;
|
|
delete details.status; // TODO: reconcile err.status and details.status, no need for both.
|
|
if (Object.keys(details).length === 0) { details = undefined; }
|
|
}
|
|
if (res.headersSent) {
|
|
// If we've already sent headers, attempt to set them to something else will fail. E.g. this
|
|
// can happen with downloads if a request gets aborted. If so, just close the response; we
|
|
// already reported the error above.
|
|
res.end();
|
|
} else {
|
|
res.status(status).json({error: err.message || 'internal error', details});
|
|
}
|
|
};
|
|
};
|
|
|
|
/**
|
|
* Error-handling middleware that responds to errors in json. The status code is taken from
|
|
* error.status property (for which ApiError is convenient), and defaults to 500.
|
|
*/
|
|
export const jsonErrorHandler: express.ErrorRequestHandler = buildJsonErrorHandler();
|
|
|
|
/**
|
|
* Variant of `jsonErrorHandler` that skips logging request bodies and params.
|
|
*
|
|
* Should be used for sensitive routes, such as those under '/api/auth/'.
|
|
*/
|
|
export const secureJsonErrorHandler: express.ErrorRequestHandler = buildJsonErrorHandler({
|
|
shouldLogBody: false,
|
|
shouldLogParams: false,
|
|
});
|
|
|
|
/**
|
|
* Middleware that responds with a 404 status and a json error object.
|
|
*/
|
|
export const jsonNotFoundHandler: express.RequestHandler = (req, res, next) => {
|
|
res.status(404).json({error: `not found: ${req.url}`});
|
|
};
|