test(Schedule Trigger Node): Add tests and extract trigger test helper (no-changelog) (#10625)

packages/nodes-base/nodes/Schedule/test/ScheduleTrigger.node.test.ts

@@ -0,0 +1,156 @@
+import * as n8nWorkflow from 'n8n-workflow';
+
+import { createTestTriggerNode } from '@test/nodes/TriggerHelpers';
+
+import { ScheduleTrigger } from '../ScheduleTrigger.node';
+
+describe('ScheduleTrigger', () => {
+	Object.defineProperty(n8nWorkflow, 'randomInt', {
+		value: (min: number, max: number) => Math.floor((min + max) / 2),
+	});
+
+	const HOUR = 60 * 60 * 1000;
+	const mockDate = new Date('2023-12-28 12:34:56.789Z');
+	const timezone = 'Europe/Berlin';
+
+	beforeEach(() => {
+		jest.clearAllMocks();
+		jest.useFakeTimers();
+		jest.setSystemTime(mockDate);
+	});
+
+	describe('trigger', () => {
+		it('should emit on defined schedule', async () => {
+			const { emit } = await createTestTriggerNode(ScheduleTrigger).trigger({
+				timezone,
+				node: { parameters: { rule: { interval: [{ field: 'hours', hoursInterval: 3 }] } } },
+				workflowStaticData: { recurrenceRules: [] },
+			});
+
+			expect(emit).not.toHaveBeenCalled();
+
+			jest.advanceTimersByTime(HOUR);
+			expect(emit).not.toHaveBeenCalled();
+
+			jest.advanceTimersByTime(2 * HOUR);
+			expect(emit).toHaveBeenCalledTimes(1);
+
+			const firstTriggerData = emit.mock.calls[0][0][0][0];
+			expect(firstTriggerData.json).toEqual({
+				'Day of month': '28',
+				'Day of week': 'Thursday',
+				Hour: '15',
+				Minute: '30',
+				Month: 'December',
+				'Readable date': 'December 28th 2023, 3:30:30 pm',
+				'Readable time': '3:30:30 pm',
+				Second: '30',
+				Timezone: 'Europe/Berlin (UTC+01:00)',
+				Year: '2023',
+				timestamp: '2023-12-28T15:30:30.000+01:00',
+			});
+
+			jest.setSystemTime(new Date(firstTriggerData.json.timestamp as string));
+
+			jest.advanceTimersByTime(2 * HOUR);
+			expect(emit).toHaveBeenCalledTimes(1);
+
+			jest.advanceTimersByTime(HOUR);
+			expect(emit).toHaveBeenCalledTimes(2);
+		});
+
+		it('should emit on schedule defined as a cron expression', async () => {
+			const { emit } = await createTestTriggerNode(ScheduleTrigger).trigger({
+				timezone,
+				node: {
+					parameters: {
+						rule: {
+							interval: [
+								{
+									field: 'cronExpression',
+									expression: '0 */2 * * *', // every 2 hours
+								},
+							],
+						},
+					},
+				},
+				workflowStaticData: {},
+			});
+
+			expect(emit).not.toHaveBeenCalled();
+
+			jest.advanceTimersByTime(2 * HOUR);
+			expect(emit).toHaveBeenCalledTimes(1);
+
+			jest.advanceTimersByTime(2 * HOUR);
+			expect(emit).toHaveBeenCalledTimes(2);
+		});
+
+		it('should throw on invalid cron expressions', async () => {
+			await expect(
+				createTestTriggerNode(ScheduleTrigger).trigger({
+					timezone,
+					node: {
+						parameters: {
+							rule: {
+								interval: [
+									{
+										field: 'cronExpression',
+										expression: '100 * * * *', // minute should be 0-59 -> invalid
+									},
+								],
+							},
+						},
+					},
+					workflowStaticData: {},
+				}),
+			).rejects.toBeInstanceOf(n8nWorkflow.NodeOperationError);
+		});
+
+		it('should emit when manually executed', async () => {
+			const { emit } = await createTestTriggerNode(ScheduleTrigger).triggerManual({
+				timezone,
+				node: { parameters: { rule: { interval: [{ field: 'hours', hoursInterval: 3 }] } } },
+				workflowStaticData: { recurrenceRules: [] },
+			});
+
+			expect(emit).toHaveBeenCalledTimes(1);
+
+			const firstTriggerData = emit.mock.calls[0][0][0][0];
+			expect(firstTriggerData.json).toEqual({
+				'Day of month': '28',
+				'Day of week': 'Thursday',
+				Hour: '13',
+				Minute: '34',
+				Month: 'December',
+				'Readable date': 'December 28th 2023, 1:34:56 pm',
+				'Readable time': '1:34:56 pm',
+				Second: '56',
+				Timezone: 'Europe/Berlin (UTC+01:00)',
+				Year: '2023',
+				timestamp: '2023-12-28T13:34:56.789+01:00',
+			});
+		});
+
+		it('should throw on invalid cron expressions in manual mode', async () => {
+			await expect(
+				createTestTriggerNode(ScheduleTrigger).triggerManual({
+					timezone,
+					node: {
+						parameters: {
+							rule: {
+								interval: [
+									{
+										field: 'cronExpression',
+										expression: '@daily *', // adding extra fields to shorthand not allowed -> invalid
+									},
+								],
+							},
+						},
+					},
+					workflowStaticData: {},
+				}),
+			).rejects.toBeInstanceOf(n8nWorkflow.NodeOperationError);
+		});
+	});
+});