mirror of
https://github.com/n8n-io/n8n.git
synced 2026-05-27 23:07:12 +02:00
240 lines
7.3 KiB
TypeScript
240 lines
7.3 KiB
TypeScript
import { randomBytes } from 'crypto';
|
|
import type { IHookFunctions, IWebhookFunctions } from 'n8n-workflow';
|
|
|
|
import { CalTrigger } from '../CalTrigger.node';
|
|
import { verifySignature } from '../CalTriggerHelpers';
|
|
import { calApiRequest } from '../GenericFunctions';
|
|
|
|
jest.mock('../GenericFunctions');
|
|
jest.mock('../CalTriggerHelpers');
|
|
jest.mock('crypto', () => ({
|
|
...jest.requireActual('crypto'),
|
|
randomBytes: jest.fn(),
|
|
}));
|
|
|
|
describe('CalTrigger', () => {
|
|
let trigger: CalTrigger;
|
|
let mockHookFunctions: Pick<
|
|
jest.Mocked<IHookFunctions>,
|
|
'getNodeWebhookUrl' | 'getNodeParameter' | 'getWorkflowStaticData' | 'helpers'
|
|
>;
|
|
let mockWebhookFunctions: Pick<
|
|
jest.Mocked<IWebhookFunctions>,
|
|
'getRequestObject' | 'getResponseObject' | 'helpers'
|
|
>;
|
|
|
|
beforeEach(() => {
|
|
jest.clearAllMocks();
|
|
trigger = new CalTrigger();
|
|
|
|
mockHookFunctions = {
|
|
getNodeWebhookUrl: jest.fn(),
|
|
getNodeParameter: jest.fn(),
|
|
getWorkflowStaticData: jest.fn(),
|
|
helpers: {} as any,
|
|
};
|
|
|
|
mockWebhookFunctions = {
|
|
getRequestObject: jest.fn(),
|
|
getResponseObject: jest.fn(),
|
|
helpers: {
|
|
returnJsonArray: jest.fn((data) => data),
|
|
} as any,
|
|
};
|
|
});
|
|
|
|
describe('webhookMethods.default.create', () => {
|
|
it('should create webhook with auto-generated secret on v2', async () => {
|
|
const subscriberUrl = 'https://example.com/webhook';
|
|
const events = ['BOOKING_CREATED'];
|
|
const webhookSecret = 'a'.repeat(64);
|
|
const webhookId = 'webhook-123';
|
|
|
|
mockHookFunctions.getNodeWebhookUrl.mockReturnValue(subscriberUrl);
|
|
mockHookFunctions.getNodeParameter.mockImplementation((name) => {
|
|
if (name === 'version') return 2;
|
|
if (name === 'events') return events;
|
|
if (name === 'options') return {};
|
|
return undefined;
|
|
});
|
|
|
|
const webhookData: any = {};
|
|
mockHookFunctions.getWorkflowStaticData.mockReturnValue(webhookData);
|
|
|
|
(randomBytes as jest.Mock).mockReturnValue({
|
|
toString: jest.fn().mockReturnValue(webhookSecret),
|
|
});
|
|
(calApiRequest as jest.Mock).mockResolvedValue({
|
|
webhook: { id: webhookId },
|
|
});
|
|
|
|
const result = await trigger.webhookMethods!.default.create.call(
|
|
mockHookFunctions as unknown as IHookFunctions,
|
|
);
|
|
|
|
expect(result).toBe(true);
|
|
expect(randomBytes).toHaveBeenCalledWith(32);
|
|
expect(calApiRequest).toHaveBeenCalledWith('POST', '/webhooks', {
|
|
subscriberUrl,
|
|
eventTriggers: events,
|
|
active: true,
|
|
secret: webhookSecret,
|
|
});
|
|
expect(webhookData.webhookId).toBe(webhookId);
|
|
expect(webhookData.webhookSecret).toBe(webhookSecret);
|
|
});
|
|
|
|
it('should create webhook with auto-generated secret on v1', async () => {
|
|
const subscriberUrl = 'https://example.com/webhook';
|
|
const events = ['BOOKING_CREATED'];
|
|
const webhookSecret = 'b'.repeat(64);
|
|
const webhookId = 'webhook-321';
|
|
|
|
mockHookFunctions.getNodeWebhookUrl.mockReturnValue(subscriberUrl);
|
|
mockHookFunctions.getNodeParameter.mockImplementation((name) => {
|
|
if (name === 'version') return 1;
|
|
if (name === 'events') return events;
|
|
if (name === 'options') return {};
|
|
return undefined;
|
|
});
|
|
|
|
const webhookData: any = {};
|
|
mockHookFunctions.getWorkflowStaticData.mockReturnValue(webhookData);
|
|
|
|
(randomBytes as jest.Mock).mockReturnValue({
|
|
toString: jest.fn().mockReturnValue(webhookSecret),
|
|
});
|
|
(calApiRequest as jest.Mock).mockResolvedValue({
|
|
webhook: { id: webhookId },
|
|
});
|
|
|
|
const result = await trigger.webhookMethods!.default.create.call(
|
|
mockHookFunctions as unknown as IHookFunctions,
|
|
);
|
|
|
|
expect(result).toBe(true);
|
|
expect(calApiRequest).toHaveBeenCalledWith('POST', '/hooks', {
|
|
subscriberUrl,
|
|
eventTriggers: events,
|
|
active: true,
|
|
secret: webhookSecret,
|
|
});
|
|
expect(webhookData.webhookId).toBe(webhookId);
|
|
expect(webhookData.webhookSecret).toBe(webhookSecret);
|
|
});
|
|
|
|
it('should return false when API does not return a webhook id', async () => {
|
|
mockHookFunctions.getNodeWebhookUrl.mockReturnValue('https://example.com/webhook');
|
|
mockHookFunctions.getNodeParameter.mockImplementation((name) => {
|
|
if (name === 'version') return 2;
|
|
if (name === 'events') return ['BOOKING_CREATED'];
|
|
if (name === 'options') return {};
|
|
return undefined;
|
|
});
|
|
|
|
const webhookData: any = {};
|
|
mockHookFunctions.getWorkflowStaticData.mockReturnValue(webhookData);
|
|
|
|
(randomBytes as jest.Mock).mockReturnValue({
|
|
toString: jest.fn().mockReturnValue('secret'),
|
|
});
|
|
(calApiRequest as jest.Mock).mockResolvedValue({ webhook: {} });
|
|
|
|
const result = await trigger.webhookMethods!.default.create.call(
|
|
mockHookFunctions as unknown as IHookFunctions,
|
|
);
|
|
|
|
expect(result).toBe(false);
|
|
expect(webhookData.webhookId).toBeUndefined();
|
|
expect(webhookData.webhookSecret).toBeUndefined();
|
|
});
|
|
});
|
|
|
|
describe('webhookMethods.default.delete', () => {
|
|
it('should delete webhook and clean up secret', async () => {
|
|
const webhookId = 'webhook-123';
|
|
|
|
mockHookFunctions.getNodeParameter.mockReturnValue(2);
|
|
|
|
const webhookData: any = {
|
|
webhookId,
|
|
webhookSecret: 'test-secret',
|
|
};
|
|
mockHookFunctions.getWorkflowStaticData.mockReturnValue(webhookData);
|
|
|
|
(calApiRequest as jest.Mock).mockResolvedValue({});
|
|
|
|
const result = await trigger.webhookMethods!.default.delete.call(
|
|
mockHookFunctions as unknown as IHookFunctions,
|
|
);
|
|
|
|
expect(result).toBe(true);
|
|
expect(calApiRequest).toHaveBeenCalledWith('DELETE', `/webhooks/${webhookId}`);
|
|
expect(webhookData.webhookId).toBeUndefined();
|
|
expect(webhookData.webhookSecret).toBeUndefined();
|
|
});
|
|
|
|
it('should return true when no webhookId is set', async () => {
|
|
mockHookFunctions.getNodeParameter.mockReturnValue(2);
|
|
mockHookFunctions.getWorkflowStaticData.mockReturnValue({});
|
|
|
|
const result = await trigger.webhookMethods!.default.delete.call(
|
|
mockHookFunctions as unknown as IHookFunctions,
|
|
);
|
|
|
|
expect(result).toBe(true);
|
|
expect(calApiRequest).not.toHaveBeenCalled();
|
|
});
|
|
});
|
|
|
|
describe('webhook', () => {
|
|
it('should return 401 when signature verification fails', async () => {
|
|
const mockResponse = {
|
|
status: jest.fn().mockReturnThis(),
|
|
send: jest.fn().mockReturnThis(),
|
|
end: jest.fn(),
|
|
};
|
|
|
|
(verifySignature as jest.Mock).mockReturnValue(false);
|
|
mockWebhookFunctions.getResponseObject.mockReturnValue(mockResponse as any);
|
|
|
|
const result = await trigger.webhook.call(
|
|
mockWebhookFunctions as unknown as IWebhookFunctions,
|
|
);
|
|
|
|
expect(verifySignature).toHaveBeenCalled();
|
|
expect(mockResponse.status).toHaveBeenCalledWith(401);
|
|
expect(mockResponse.send).toHaveBeenCalledWith('Unauthorized');
|
|
expect(result).toEqual({
|
|
noWebhookResponse: true,
|
|
});
|
|
});
|
|
|
|
it('should process webhook when signature verification passes', async () => {
|
|
const requestBody = {
|
|
triggerEvent: 'BOOKING_CREATED',
|
|
createdAt: '2024-01-01T00:00:00Z',
|
|
payload: { bookingId: 'abc-123' },
|
|
};
|
|
|
|
(verifySignature as jest.Mock).mockReturnValue(true);
|
|
mockWebhookFunctions.getRequestObject.mockReturnValue({
|
|
body: requestBody,
|
|
} as any);
|
|
|
|
const result = await trigger.webhook.call(
|
|
mockWebhookFunctions as unknown as IWebhookFunctions,
|
|
);
|
|
|
|
expect(verifySignature).toHaveBeenCalled();
|
|
expect(result.workflowData).toEqual([
|
|
{
|
|
triggerEvent: 'BOOKING_CREATED',
|
|
createdAt: '2024-01-01T00:00:00Z',
|
|
bookingId: 'abc-123',
|
|
},
|
|
]);
|
|
});
|
|
});
|
|
});
|