Skip to content

fix: allow to load dynamic rest endpoint #35715

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ggazzo merged 3 commits into from
Apr 8, 2025
Merged

fix: allow to load dynamic rest endpoint #35715

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7262cdb
allow to load dynamic rest endpoint
ggazzo Apr 7, 2025
6e8a971
Add cs
gabriellsh Apr 7, 2025
70f5639
review
ggazzo Apr 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/serious-grapes-smell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@rocket.chat/meteor": patch
---

Fixes an issue with dynamic API routes requiring a server restart to be operable.
158 changes: 72 additions & 86 deletions apps/meteor/app/api/server/router.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,17 @@ export class Router<
[x: string]: unknown;
} = NonNullable<unknown>,
> {
private middleware: (router: express.Router) => void = () => void 0;
public router;

constructor(readonly base: TBasePath) {}
private innerRouter: express.Router;

constructor(readonly base: TBasePath) {
// eslint-disable-next-line new-cap
this.router = express.Router();
// eslint-disable-next-line new-cap
this.innerRouter = express.Router();
this.router.use(this.base, this.innerRouter);
}

public typedRoutes: Record<string, Record<string, Route>> = {};

Expand Down Expand Up @@ -131,79 +139,75 @@ export class Router<
> {
const [middlewares, action] = splitArray(actions);

const prev = this.middleware;
this.middleware = (router: express.Router) => {
prev(router);
router[method.toLowerCase() as Lowercase<Method>](`/${subpath}`.replace('//', '/'), ...middlewares, async (req, res) => {
if (options.query) {
const validatorFn = options.query;
if (typeof options.query === 'function' && !validatorFn(req.query)) {
return res.status(400).json({
success: false,
errorType: 'error-invalid-params',
error: validatorFn.errors?.map((error: any) => error.message).join('\n '),
});
}
this.innerRouter[method.toLowerCase() as Lowercase<Method>](`/${subpath}`.replace('//', '/'), ...middlewares, async (req, res) => {
if (options.query) {
const validatorFn = options.query;
if (typeof options.query === 'function' && !validatorFn(req.query)) {
return res.status(400).json({
success: false,
errorType: 'error-invalid-params',
error: validatorFn.errors?.map((error: any) => error.message).join('\n '),
});
}
}

if (options.body) {
const validatorFn = options.body;
if (typeof options.body === 'function' && !validatorFn((req as any).bodyParams || req.body)) {
return res.status(400).json({
success: false,
errorType: 'error-invalid-params',
error: validatorFn.errors?.map((error: any) => error.message).join('\n '),
});
}
if (options.body) {
const validatorFn = options.body;
if (typeof options.body === 'function' && !validatorFn((req as any).bodyParams || req.body)) {
return res.status(400).json({
success: false,
errorType: 'error-invalid-params',
error: validatorFn.errors?.map((error: any) => error.message).join('\n '),
});
}
}

const {
body,
statusCode = 200,
headers = {},
} = await action.apply(
{
urlParams: req.params,
queryParams: req.query,
bodyParams: (req as any).bodyParams || req.body,
request: req,
response: res,
} as any,
[req],
);
if (process.env.NODE_ENV === 'test' || process.env.TEST_MODE) {
const responseValidatorFn = options?.response?.[statusCode];
if (!responseValidatorFn && options.typed) {
throw new Error(`Missing response validator for endpoint ${req.method} - ${req.url} with status code ${statusCode}`);
}
if (responseValidatorFn && !responseValidatorFn(body) && options.typed) {
throw new Error(
`Invalid response for endpoint ${req.method} - ${req.url}. Error: ${responseValidatorFn.errors?.map((error: any) => error.message).join('\n ')}`,
);
}
const {
body,
statusCode = 200,
headers = {},
} = await action.apply(
{
urlParams: req.params,
queryParams: req.query,
bodyParams: (req as any).bodyParams || req.body,
request: req,
response: res,
} as any,
[req],
);
if (process.env.NODE_ENV === 'test' || process.env.TEST_MODE) {
const responseValidatorFn = options?.response?.[statusCode];
if (!responseValidatorFn && options.typed) {
throw new Error(`Missing response validator for endpoint ${req.method} - ${req.url} with status code ${statusCode}`);
}
if (responseValidatorFn && !responseValidatorFn(body) && options.typed) {
throw new Error(
`Invalid response for endpoint ${req.method} - ${req.url}. Error: ${responseValidatorFn.errors?.map((error: any) => error.message).join('\n ')}`,
);
}
}

const responseHeaders = Object.fromEntries(
Object.entries({
...res.header,
'Content-Type': 'application/json',
'Cache-Control': 'no-store',
'Pragma': 'no-cache',
...headers,
}).map(([key, value]) => [key.toLowerCase(), value]),
);
const responseHeaders = Object.fromEntries(
Object.entries({
...res.header,
'Content-Type': 'application/json',
'Cache-Control': 'no-store',
'Pragma': 'no-cache',
...headers,
}).map(([key, value]) => [key.toLowerCase(), value]),
);

res.writeHead(statusCode, responseHeaders);
res.writeHead(statusCode, responseHeaders);

if (responseHeaders['content-type']?.match(/json|javascript/) !== null) {
body !== undefined && res.write(JSON.stringify(body));
} else {
body !== undefined && res.write(body);
}
if (responseHeaders['content-type']?.match(/json|javascript/) !== null) {
body !== undefined && res.write(JSON.stringify(body));
} else {
body !== undefined && res.write(body);
}

res.end();
});
};
res.end();
});
this.registerTypedRoutes(method, subpath, options);
return this;
}
Expand Down Expand Up @@ -281,31 +285,13 @@ export class Router<
...Object.fromEntries(Object.entries(innerRouter.typedRoutes).map(([path, routes]) => [`${this.base}${path}`, routes])),
};

const prev = this.middleware;
this.middleware = (router: express.Router) => {
prev(router);
router.use(innerRouter.router);
};
this.innerRouter.use(innerRouter.router);
}
if (typeof innerRouter === 'function') {
const prev = this.middleware;
this.middleware = (router: express.Router) => {
prev(router);
router.use(innerRouter);
};
this.innerRouter.use(innerRouter);
}
return this as any;
}

get router(): express.Router {
// eslint-disable-next-line new-cap
const router = express.Router();
// eslint-disable-next-line new-cap
const innerRouter = express.Router();
this.middleware(innerRouter);
router.use(this.base, innerRouter);
return router;
}
}

type Prettify<T> = {
Expand Down
Loading