-
Notifications
You must be signed in to change notification settings - Fork 8.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor, and get access control working for production webhooks as well
- Loading branch information
Showing
8 changed files
with
242 additions
and
116 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
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,142 @@ | ||
| import { type Response } from 'express'; | ||
| import { mock } from 'jest-mock-extended'; | ||
| import type { IHttpRequestMethods } from 'n8n-workflow'; | ||
| import type { IWebhookManager, WebhookCORSRequest, WebhookRequest } from '@/Interfaces'; | ||
| import { webhookRequestHandler } from '@/WebhookHelpers'; | ||
|
|
||
| describe('WebhookHelpers', () => { | ||
| describe('webhookRequestHandler', () => { | ||
| const webhookManager = mock<Required<IWebhookManager>>(); | ||
| const handler = webhookRequestHandler(webhookManager); | ||
|
|
||
| beforeEach(() => { | ||
| jest.resetAllMocks(); | ||
| }); | ||
|
|
||
| it('should throw for unsupported methods', async () => { | ||
| const req = mock<WebhookRequest | WebhookCORSRequest>({ | ||
| method: 'CONNECT' as IHttpRequestMethods, | ||
| }); | ||
| const res = mock<Response>(); | ||
| res.status.mockReturnValue(res); | ||
|
|
||
| await handler(req, res); | ||
|
|
||
| expect(res.status).toHaveBeenCalledWith(500); | ||
| expect(res.json).toHaveBeenCalledWith({ | ||
| code: 0, | ||
| message: 'The method CONNECT is not supported.', | ||
| }); | ||
| }); | ||
|
|
||
| describe('preflight requests', () => { | ||
| it('should handle missing header for requested method', async () => { | ||
| const req = mock<WebhookRequest | WebhookCORSRequest>({ | ||
| method: 'OPTIONS', | ||
| headers: { | ||
| origin: 'https://example.com', | ||
| 'access-control-request-method': undefined, | ||
| }, | ||
| params: { path: 'test' }, | ||
| }); | ||
| const res = mock<Response>(); | ||
| res.status.mockReturnValue(res); | ||
|
|
||
| webhookManager.getWebhookMethods.mockResolvedValue(['GET', 'PATCH']); | ||
|
|
||
| await handler(req, res); | ||
|
|
||
| expect(res.status).toHaveBeenCalledWith(204); | ||
| expect(res.header).toHaveBeenCalledWith( | ||
| 'Access-Control-Allow-Methods', | ||
| 'OPTIONS, GET, PATCH', | ||
| ); | ||
| }); | ||
|
|
||
| it('should handle default origin and max-age', async () => { | ||
| const req = mock<WebhookRequest | WebhookCORSRequest>({ | ||
| method: 'OPTIONS', | ||
| headers: { | ||
| origin: 'https://example.com', | ||
| 'access-control-request-method': 'GET', | ||
| }, | ||
| params: { path: 'test' }, | ||
| }); | ||
| const res = mock<Response>(); | ||
| res.status.mockReturnValue(res); | ||
|
|
||
| webhookManager.getWebhookMethods.mockResolvedValue(['GET', 'PATCH']); | ||
|
|
||
| await handler(req, res); | ||
|
|
||
| expect(res.status).toHaveBeenCalledWith(204); | ||
| expect(res.header).toHaveBeenCalledWith( | ||
| 'Access-Control-Allow-Methods', | ||
| 'OPTIONS, GET, PATCH', | ||
| ); | ||
| expect(res.header).toHaveBeenCalledWith( | ||
| 'Access-Control-Allow-Origin', | ||
| 'https://example.com', | ||
| ); | ||
| expect(res.header).toHaveBeenCalledWith('Access-Control-Max-Age', '60000'); | ||
| }); | ||
|
|
||
| it('should handle wildcard origin', async () => { | ||
| const randomOrigin = (Math.random() * 10e6).toString(16); | ||
| const req = mock<WebhookRequest | WebhookCORSRequest>({ | ||
| method: 'OPTIONS', | ||
| headers: { | ||
| origin: randomOrigin, | ||
| 'access-control-request-method': 'GET', | ||
| }, | ||
| params: { path: 'test' }, | ||
| }); | ||
| const res = mock<Response>(); | ||
| res.status.mockReturnValue(res); | ||
|
|
||
| webhookManager.getWebhookMethods.mockResolvedValue(['GET', 'PATCH']); | ||
| webhookManager.findAccessControlOptions.mockResolvedValue({ | ||
| allowedOrigins: '*', | ||
| }); | ||
|
|
||
| await handler(req, res); | ||
|
|
||
| expect(res.status).toHaveBeenCalledWith(204); | ||
| expect(res.header).toHaveBeenCalledWith( | ||
| 'Access-Control-Allow-Methods', | ||
| 'OPTIONS, GET, PATCH', | ||
| ); | ||
| expect(res.header).toHaveBeenCalledWith('Access-Control-Allow-Origin', randomOrigin); | ||
| }); | ||
|
|
||
| it('should handle custom origin and max-age', async () => { | ||
| const req = mock<WebhookRequest | WebhookCORSRequest>({ | ||
| method: 'OPTIONS', | ||
| headers: { | ||
| origin: 'https://example.com', | ||
| 'access-control-request-method': 'GET', | ||
| }, | ||
| params: { path: 'test' }, | ||
| }); | ||
| const res = mock<Response>(); | ||
| res.status.mockReturnValue(res); | ||
|
|
||
| webhookManager.getWebhookMethods.mockResolvedValue(['GET', 'PATCH']); | ||
| webhookManager.findAccessControlOptions.mockResolvedValue({ | ||
| allowedOrigins: 'https://test.com', | ||
| preflightMaxAge: 360, | ||
| }); | ||
|
|
||
| await handler(req, res); | ||
|
|
||
| expect(res.status).toHaveBeenCalledWith(204); | ||
| expect(res.header).toHaveBeenCalledWith( | ||
| 'Access-Control-Allow-Methods', | ||
| 'OPTIONS, GET, PATCH', | ||
| ); | ||
| expect(res.header).toHaveBeenCalledWith('Access-Control-Allow-Origin', 'https://test.com'); | ||
| expect(res.header).toHaveBeenCalledWith('Access-Control-Max-Age', '360000'); | ||
| }); | ||
| }); | ||
| }); | ||
| }); |
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
Oops, something went wrong.