test(core): Move unit tests closer to testable components (no-changelog) (#10287)

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

@@ -0,0 +1,90 @@
+import type SuperAgentTest from 'supertest/lib/agent';
+import { agent as testAgent } from 'supertest';
+import { mock } from 'jest-mock-extended';
+
+import { AbstractServer } from '@/AbstractServer';
+import { ActiveWebhooks } from '@/ActiveWebhooks';
+import { ExternalHooks } from '@/ExternalHooks';
+import { InternalHooks } from '@/InternalHooks';
+import { TestWebhooks } from '@/TestWebhooks';
+import { WaitingWebhooks } from '@/WaitingWebhooks';
+import { WaitingForms } from '@/WaitingForms';
+import type { IResponseCallbackData } from '@/Interfaces';
+
+import { mockInstance } from '@test/mocking';
+import { GlobalConfig } from '@n8n/config';
+import Container from 'typedi';
+
+let agent: SuperAgentTest;
+
+describe('WebhookServer', () => {
+	mockInstance(ExternalHooks);
+	mockInstance(InternalHooks);
+
+	describe('CORS', () => {
+		const corsOrigin = 'https://example.com';
+		const activeWebhooks = mockInstance(ActiveWebhooks);
+		const testWebhooks = mockInstance(TestWebhooks);
+		mockInstance(WaitingWebhooks);
+		mockInstance(WaitingForms);
+
+		beforeAll(async () => {
+			const server = new (class extends AbstractServer {
+				testWebhooksEnabled = true;
+			})();
+			await server.start();
+			agent = testAgent(server.app);
+		});
+
+		const tests = [
+			['webhook', activeWebhooks],
+			['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}`, () => {
+				it('should handle preflight requests', async () => {
+					const pathPrefix = Container.get(GlobalConfig).endpoints[key];
+					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 () => {
+					const pathPrefix = Container.get(GlobalConfig).endpoints[key];
+					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');
+				});
+			});
+		}
+
+		const mockResponse = (data = {}, headers = {}, status = 200) => {
+			const response = mock<IResponseCallbackData>();
+			response.responseCode = status;
+			response.data = data;
+			response.headers = headers;
+			return response;
+		};
+	});
+});