first commit

packages/cli/test/integration/webhooks.test.ts

@@ -0,0 +1,119 @@
+import { mockInstance } from '@n8n/backend-test-utils';
+import { GlobalConfig } from '@n8n/config';
+import { Container } from '@n8n/di';
+import { mock } from 'jest-mock-extended';
+import { agent as testAgent } from 'supertest';
+import type SuperAgentTest from 'supertest/lib/agent';
+
+import { ExternalHooks } from '@/external-hooks';
+import { LiveWebhooks } from '@/webhooks/live-webhooks';
+import { TestWebhooks } from '@/webhooks/test-webhooks';
+import { WaitingForms } from '@/webhooks/waiting-forms';
+import { WaitingWebhooks } from '@/webhooks/waiting-webhooks';
+import { WebhookServer } from '@/webhooks/webhook-server';
+import type { IWebhookResponseCallbackData } from '@/webhooks/webhook.types';
+
+let agent: SuperAgentTest;
+
+describe('WebhookServer', () => {
+	const liveWebhooks = mockInstance(LiveWebhooks);
+	const testWebhooks = mockInstance(TestWebhooks);
+	const waitingWebhooks = mockInstance(WaitingWebhooks);
+	mockInstance(WaitingForms);
+	mockInstance(ExternalHooks);
+	const globalConfig = Container.get(GlobalConfig);
+
+	const mockResponse = (data = {}, headers = {}, status = 200) => {
+		const response = mock<IWebhookResponseCallbackData>();
+		response.responseCode = status;
+		response.data = data;
+		response.headers = headers;
+		return response;
+	};
+
+	beforeAll(async () => {
+		const server = new WebhookServer();
+		// @ts-expect-error: testWebhooksEnabled is private
+		server.testWebhooksEnabled = true;
+		await server.start();
+		agent = testAgent(server.app);
+	});
+
+	describe('CORS', () => {
+		const corsOrigin = 'https://example.com';
+		const tests = [
+			['webhook', liveWebhooks],
+			['webhookTest', testWebhooks],
+			// TODO: enable webhookWaiting & waitingForms after CORS support is added
+			// ['webhookWaiting', waitingWebhooks],
+			// ['formWaiting', waitingForms],
+		] as const;
+
+		for (const [key, manager] of tests) {
+			describe(`for ${key}`, () => {
+				const pathPrefix = globalConfig.endpoints[key];
+
+				it('should handle preflight requests', async () => {
+					manager.getWebhookMethods.mockResolvedValueOnce(['GET']);
+
+					const response = await agent
+						.options(`/${pathPrefix}/abcd`)
+						.set('origin', corsOrigin)
+						.set('access-control-request-method', 'GET');
+					expect(response.statusCode).toEqual(204);
+					expect(response.body).toEqual({});
+					expect(response.headers['access-control-allow-origin']).toEqual(corsOrigin);
+					expect(response.headers['access-control-allow-methods']).toEqual('OPTIONS, GET');
+				});
+
+				it('should handle regular requests', async () => {
+					manager.getWebhookMethods.mockResolvedValueOnce(['GET']);
+					manager.executeWebhook.mockResolvedValueOnce(
+						mockResponse({ test: true }, { key: 'value ' }),
+					);
+
+					const response = await agent
+						.get(`/${pathPrefix}/abcd`)
+						.set('origin', corsOrigin)
+						.set('access-control-request-method', 'GET');
+					expect(response.statusCode).toEqual(200);
+					expect(response.body).toEqual({ test: true });
+					expect(response.headers['access-control-allow-origin']).toEqual(corsOrigin);
+					expect(response.headers.key).toEqual('value');
+				});
+			});
+		}
+	});
+
+	describe('Routing for Waiting Webhooks', () => {
+		const pathPrefix = globalConfig.endpoints.webhookWaiting;
+
+		waitingWebhooks.executeWebhook.mockImplementation(async (req) => {
+			return {
+				noWebhookResponse: false,
+				responseCode: 200,
+				data: {
+					params: req.params,
+				},
+			};
+		});
+
+		it('should handle URLs without suffix', async () => {
+			const response = await agent.get(`/${pathPrefix}/12345`);
+
+			expect(response.statusCode).toEqual(200);
+			expect(response.body).toEqual({
+				params: { path: '12345' },
+			});
+		});
+
+		it('should handle URLs with suffix', async () => {
+			const response = await agent.get(`/${pathPrefix}/12345/suffix`);
+
+			expect(response.statusCode).toEqual(200);
+			expect(response.body).toEqual({
+				params: { path: '12345', suffix: 'suffix' },
+			});
+		});
+	});
+});