Skip to content

fix(types): return void promises from the express receiver middleware parser #2141

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
zimeg merged 2 commits into from
Jun 19, 2024
+15 −12
Merged

fix(types): return void promises from the express receiver middleware parser #2141

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d13efb8
fix: return a void promise from middleware parsing
zimeg Jun 19, 2024
03e3321
style: format indentation
zimeg Jun 19, 2024
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
27 changes: 15 additions & 12 deletions src/receivers/ExpressReceiver.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,9 +221,9 @@ export default class ExpressReceiver implements Receiver {
if (
clientId !== undefined &&
clientSecret !== undefined &&
(installerOptions.stateVerification === false || // state store not needed
stateSecret !== undefined ||
installerOptions.stateStore !== undefined) // user provided state store
(installerOptions.stateVerification === false || // state store not needed
stateSecret !== undefined ||
installerOptions.stateStore !== undefined) // user provided state store
) {
this.installer = new InstallProvider({
clientId,
Expand Down Expand Up @@ -355,8 +355,8 @@ export default class ExpressReceiver implements Receiver {
serverOptions: ServerOptions | HTTPSServerOptions = {},
): Promise<Server | HTTPSServer> {
let createServerFn:
typeof createServer<typeof IncomingMessage, typeof ServerResponse> |
typeof createHttpsServer<typeof IncomingMessage, typeof ServerResponse> = createServer;
typeof createServer<typeof IncomingMessage, typeof ServerResponse> |
typeof createHttpsServer<typeof IncomingMessage, typeof ServerResponse> = createServer;

// Look for HTTPS-specific serverOptions to determine which factory function to use
if (Object.keys(serverOptions).filter((k) => httpsOptionKeys.includes(k)).length > 0) {
Expand Down Expand Up @@ -443,7 +443,7 @@ function buildVerificationBodyParserMiddleware(
logger: Logger,
signingSecret: string | (() => PromiseLike<string>),
): RequestHandler {
return async (req, res, next) => {
return async (req, res, next): Promise<void> => {
let stringBody: string;
// On some environments like GCP (Google Cloud Platform),
// req.body can be pre-parsed and be passed as req.rawBody here
Expand All @@ -470,15 +470,17 @@ function buildVerificationBodyParserMiddleware(
if (error) {
if (error instanceof ReceiverAuthenticityError) {
logError(logger, 'Request verification failed', error);
return res.status(401).send();
res.status(401).send();
return;
}

logError(logger, 'Parsing request body failed', error);
return res.status(400).send();
res.status(400).send();
return;
}
}

return next();
Copy link
Copy Markdown
Member Author

@zimeg zimeg Jun 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is somewhat questionable to me but it raises this type error for me:

return next();     ■ Async arrow function expected no return value.

next();
};
}

Expand Down Expand Up @@ -545,7 +547,7 @@ export function verifySignatureAndParseBody(
}

export function buildBodyParserMiddleware(logger: Logger): RequestHandler {
return async (req, res, next) => {
return async (req, res, next): Promise<void> => {
let stringBody: string;
// On some environments like GCP (Google Cloud Platform),
// req.body can be pre-parsed and be passed as req.rawBody here
Expand All @@ -561,10 +563,11 @@ export function buildBodyParserMiddleware(logger: Logger): RequestHandler {
} catch (error) {
if (error) {
logError(logger, 'Parsing request body failed', error);
return res.status(400).send();
res.status(400).send();
return;
}
}
return next();
next();
};
}

Expand Down