Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 | 62x 62x 62x 62x 62x 18597x 738x 257x 481x 478x 3x 62x 5509x 5509x 5509x 18597x 735x 735x 111x 18456x 18456x 18456x 7056x 5061x 1407x 141x 1548x 141x 2115x 5507x 62x | import { IRouter, Router, Request, Response, RequestHandler } from 'express';
import { Logger } from 'lib/logger';
import { IUnleashConfig } from '../types/option';
import { NONE } from '../types/permissions';
import { handleErrors } from './util';
import NoAccessError from '../error/no-access-error';
import requireContentType from '../middleware/content_type_checker';
interface IRequestHandler<
P = any,
ResBody = any,
ReqBody = any,
ReqQuery = any,
> {
(
req: Request<P, ResBody, ReqBody, ReqQuery>,
res: Response<ResBody>,
): Promise<void> | void;
}
interface IRouteOptions {
method: 'get' | 'post' | 'put' | 'patch' | 'delete';
path: string;
permission: string;
middleware?: RequestHandler[];
handler: IRequestHandler;
acceptAnyContentType?: boolean;
acceptedContentTypes?: string[];
}
const checkPermission = (permission) => async (req, res, next) => {
if (!permission || permission === NONE) {
return next();
}
if (req.checkRbac && (await req.checkRbac(permission))) {
return next();
}
return res.status(403).json(new NoAccessError(permission)).end();
};
/**
* Base class for Controllers to standardize binding to express Router.
*
* This class will take care of the following:
* - try/catch inside RequestHandler
* - await if the RequestHandler returns a promise.
* - access control
*/
export default class Controller {
private ownLogger: Logger;
app: IRouter;
config: IUnleashConfig;
constructor(config: IUnleashConfig) {
this.ownLogger = config.getLogger(
`controller/${this.constructor.name}`,
);
this.app = Router();
this.config = config;
}
private useRouteErrorHandler(handler: IRequestHandler): IRequestHandler {
return async (req: Request, res: Response) => {
try {
await handler(req, res);
} catch (error) {
handleErrors(res, this.ownLogger, error);
}
};
}
private useContentTypeMiddleware(options: IRouteOptions): RequestHandler[] {
const { middleware = [], acceptedContentTypes = [] } = options;
return options.acceptAnyContentType
? middleware
: [requireContentType(...acceptedContentTypes), ...middleware];
}
route(options: IRouteOptions): void {
this.app[options.method](
options.path,
checkPermission(options.permission),
this.useContentTypeMiddleware(options),
this.useRouteErrorHandler(options.handler.bind(this)),
);
}
get(path: string, handler: IRequestHandler, permission?: string): void {
this.route({
method: 'get',
path,
handler,
permission,
acceptAnyContentType: true,
});
}
post(
path: string,
handler: IRequestHandler,
permission: string,
...acceptedContentTypes: string[]
): void {
this.route({
method: 'post',
path,
handler,
permission,
acceptedContentTypes,
});
}
put(
path: string,
handler: IRequestHandler,
permission: string,
...acceptedContentTypes: string[]
): void {
this.route({
method: 'put',
path,
handler,
permission,
acceptedContentTypes,
});
}
patch(
path: string,
handler: IRequestHandler,
permission: string,
...acceptedContentTypes: string[]
): void {
this.route({
method: 'patch',
path,
handler,
permission,
acceptedContentTypes,
});
}
delete(path: string, handler: IRequestHandler, permission: string): void {
this.route({
method: 'delete',
path,
handler,
permission,
acceptAnyContentType: true,
});
}
fileupload(
path: string,
filehandler: IRequestHandler,
handler: Function,
permission: string,
): void {
this.app.post(
path,
checkPermission(permission),
filehandler.bind(this),
this.useRouteErrorHandler(handler.bind(this)),
);
}
use(path: string, router: IRouter): void {
this.app.use(path, router);
}
get router(): any {
return this.app;
}
}
module.exports = Controller;
|