-
Notifications
You must be signed in to change notification settings - Fork 10.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor(core): Extract webhook request handler to own file
Builds on top of #10296. Move webhook request handler to own class.
- Loading branch information
Showing
5 changed files
with
352 additions
and
251 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| import type express from 'express'; | ||
| import type { IHttpRequestMethods } from 'n8n-workflow'; | ||
| import type { IWebhookManager, WebhookCORSRequest, WebhookRequest } from '@/webhooks/webhook.types'; | ||
| import * as ResponseHelper from '@/ResponseHelper'; | ||
|
|
||
| export const WEBHOOK_METHODS: IHttpRequestMethods[] = [ | ||
| 'DELETE', | ||
| 'GET', | ||
| 'HEAD', | ||
| 'PATCH', | ||
| 'POST', | ||
| 'PUT', | ||
| ]; | ||
|
|
||
| class WebhookRequestHandler { | ||
| constructor(private readonly webhookManager: IWebhookManager) {} | ||
|
|
||
| /** | ||
| * Handles an incoming webhook requests. Handles CORS and delegates the | ||
| * request to the webhook manager to execute the webhook. | ||
| */ | ||
| async handleRequest(req: WebhookRequest | WebhookCORSRequest, res: express.Response) { | ||
| const method = req.method; | ||
|
|
||
| if (method !== 'OPTIONS' && !WEBHOOK_METHODS.includes(method)) { | ||
| return ResponseHelper.sendErrorResponse( | ||
| res, | ||
| new Error(`The method ${method} is not supported.`), | ||
| ); | ||
| } | ||
|
|
||
| // Setup CORS headers only if the incoming request has an `origin` header | ||
| if ('origin' in req.headers) { | ||
| const corsSetupError = await this.setupCorsHeaders(req, res); | ||
| if (corsSetupError) { | ||
| return ResponseHelper.sendErrorResponse(res, corsSetupError); | ||
| } | ||
| } | ||
|
|
||
| if (method === 'OPTIONS') { | ||
| return ResponseHelper.sendSuccessResponse(res, {}, true, 204); | ||
| } | ||
|
|
||
| try { | ||
| const response = await this.webhookManager.executeWebhook(req, res); | ||
|
|
||
| // Don't respond, if already responded | ||
| if (response.noWebhookResponse !== true) { | ||
| ResponseHelper.sendSuccessResponse( | ||
| res, | ||
| response.data, | ||
| true, | ||
| response.responseCode, | ||
| response.headers, | ||
| ); | ||
| } | ||
| } catch (error) { | ||
| return ResponseHelper.sendErrorResponse(res, error as Error); | ||
| } | ||
| } | ||
|
|
||
| private async setupCorsHeaders( | ||
| req: WebhookRequest | WebhookCORSRequest, | ||
| res: express.Response, | ||
| ): Promise<Error | null> { | ||
| const method = req.method; | ||
| const { path } = req.params; | ||
|
|
||
| if (this.webhookManager.getWebhookMethods) { | ||
| try { | ||
| const allowedMethods = await this.webhookManager.getWebhookMethods(path); | ||
| res.header('Access-Control-Allow-Methods', ['OPTIONS', ...allowedMethods].join(', ')); | ||
| } catch (error) { | ||
| return error as Error; | ||
| } | ||
| } | ||
|
|
||
| const requestedMethod = | ||
| method === 'OPTIONS' | ||
| ? (req.headers['access-control-request-method'] as IHttpRequestMethods) | ||
| : method; | ||
| if (this.webhookManager.findAccessControlOptions && requestedMethod) { | ||
| const options = await this.webhookManager.findAccessControlOptions(path, requestedMethod); | ||
| const { allowedOrigins } = options ?? {}; | ||
|
|
||
| if (allowedOrigins && allowedOrigins !== '*' && allowedOrigins !== req.headers.origin) { | ||
| const originsList = allowedOrigins.split(','); | ||
| const defaultOrigin = originsList[0]; | ||
|
|
||
| if (originsList.length === 1) { | ||
| res.header('Access-Control-Allow-Origin', defaultOrigin); | ||
| } | ||
|
|
||
| if (originsList.includes(req.headers.origin as string)) { | ||
| res.header('Access-Control-Allow-Origin', req.headers.origin); | ||
| } else { | ||
| res.header('Access-Control-Allow-Origin', defaultOrigin); | ||
| } | ||
| } else { | ||
| res.header('Access-Control-Allow-Origin', req.headers.origin); | ||
| } | ||
|
|
||
| if (method === 'OPTIONS') { | ||
| res.header('Access-Control-Max-Age', '300'); | ||
| const requestedHeaders = req.headers['access-control-request-headers']; | ||
| if (requestedHeaders?.length) { | ||
| res.header('Access-Control-Allow-Headers', requestedHeaders); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
| } | ||
|
|
||
| export function createWebhookHandlerFor(webhookManager: IWebhookManager) { | ||
| const handler = new WebhookRequestHandler(webhookManager); | ||
|
|
||
| return async (req: WebhookRequest | WebhookCORSRequest, res: express.Response) => { | ||
| await handler.handleRequest(req, res); | ||
| }; | ||
| } |
Oops, something went wrong.