[N8N-4339] Unify all Cron-specific code. Improve typing, and add tests. (#3887)

packages/workflow/src/Cron.ts

@@ -0,0 +1,68 @@
+interface BaseTriggerTime<T extends string> {
+	mode: T;
+}
+
+type CronExpression = string;
+interface CustomTrigger extends BaseTriggerTime<'custom'> {
+	cronExpression: CronExpression;
+}
+
+interface EveryX<U extends string> extends BaseTriggerTime<'everyX'> {
+	unit: U;
+	value: number;
+}
+
+type EveryMinute = BaseTriggerTime<'everyMinute'>;
+type EveryXMinutes = EveryX<'minutes'>;
+
+interface EveryHour extends BaseTriggerTime<'everyHour'> {
+	minute: number; // 0 - 59
+}
+type EveryXHours = EveryX<'hours'>;
+
+interface EveryDay extends BaseTriggerTime<'everyDay'> {
+	hour: number; // 0 - 23
+	minute: number; // 0 - 59
+}
+
+interface EveryWeek extends BaseTriggerTime<'everyWeek'> {
+	hour: number; // 0 - 23
+	minute: number; // 0 - 59
+	weekday: number; // 0 - 6(Sun - Sat)
+}
+
+interface EveryMonth extends BaseTriggerTime<'everyMonth'> {
+	hour: number; // 0 - 23
+	minute: number; // 0 - 59
+	dayOfMonth: number; // 1 - 31
+}
+
+export type TriggerTime =
+	| CustomTrigger
+	| EveryMinute
+	| EveryXMinutes
+	| EveryHour
+	| EveryXHours
+	| EveryDay
+	| EveryWeek
+	| EveryMonth;
+
+const randomSecond = () => Math.floor(Math.random() * 60).toString();
+
+export const toCronExpression = (item: TriggerTime): CronExpression => {
+	if (item.mode === 'everyMinute') return `${randomSecond()} * * * * *`;
+	if (item.mode === 'everyHour') return `${randomSecond()} ${item.minute} * * * *`;
+
+	if (item.mode === 'everyX') {
+		if (item.unit === 'minutes') return `${randomSecond()} */${item.value} * * * *`;
+		if (item.unit === 'hours') return `${randomSecond()} 0 */${item.value} * * *`;
+	}
+	if (item.mode === 'everyDay') return `${randomSecond()} ${item.minute} ${item.hour} * * *`;
+	if (item.mode === 'everyWeek')
+		return `${randomSecond()} ${item.minute} ${item.hour} * * ${item.weekday}`;
+
+	if (item.mode === 'everyMonth')
+		return `${randomSecond()} ${item.minute} ${item.hour} ${item.dayOfMonth} * *`;
+
+	return item.cronExpression.trim();
+};

packages/workflow/src/NodeHelpers.ts

@@ -38,6 +38,193 @@ import {
 
 import { Workflow } from './Workflow';
 
+export const cronNodeOptions: INodePropertyCollection[] = [
+	{
+		name: 'item',
+		displayName: 'Item',
+		values: [
+			{
+				displayName: 'Mode',
+				name: 'mode',
+				type: 'options',
+				options: [
+					{
+						name: 'Every Minute',
+						value: 'everyMinute',
+					},
+					{
+						name: 'Every Hour',
+						value: 'everyHour',
+					},
+					{
+						name: 'Every Day',
+						value: 'everyDay',
+					},
+					{
+						name: 'Every Week',
+						value: 'everyWeek',
+					},
+					{
+						name: 'Every Month',
+						value: 'everyMonth',
+					},
+					{
+						name: 'Every X',
+						value: 'everyX',
+					},
+					{
+						name: 'Custom',
+						value: 'custom',
+					},
+				],
+				default: 'everyDay',
+				description: 'How often to trigger.',
+			},
+			{
+				displayName: 'Hour',
+				name: 'hour',
+				type: 'number',
+				typeOptions: {
+					minValue: 0,
+					maxValue: 23,
+				},
+				displayOptions: {
+					hide: {
+						mode: ['custom', 'everyHour', 'everyMinute', 'everyX'],
+					},
+				},
+				default: 14,
+				description: 'The hour of the day to trigger (24h format)',
+			},
+			{
+				displayName: 'Minute',
+				name: 'minute',
+				type: 'number',
+				typeOptions: {
+					minValue: 0,
+					maxValue: 59,
+				},
+				displayOptions: {
+					hide: {
+						mode: ['custom', 'everyMinute', 'everyX'],
+					},
+				},
+				default: 0,
+				description: 'The minute of the day to trigger',
+			},
+			{
+				displayName: 'Day of Month',
+				name: 'dayOfMonth',
+				type: 'number',
+				displayOptions: {
+					show: {
+						mode: ['everyMonth'],
+					},
+				},
+				typeOptions: {
+					minValue: 1,
+					maxValue: 31,
+				},
+				default: 1,
+				description: 'The day of the month to trigger',
+			},
+			{
+				displayName: 'Weekday',
+				name: 'weekday',
+				type: 'options',
+				displayOptions: {
+					show: {
+						mode: ['everyWeek'],
+					},
+				},
+				options: [
+					{
+						name: 'Monday',
+						value: '1',
+					},
+					{
+						name: 'Tuesday',
+						value: '2',
+					},
+					{
+						name: 'Wednesday',
+						value: '3',
+					},
+					{
+						name: 'Thursday',
+						value: '4',
+					},
+					{
+						name: 'Friday',
+						value: '5',
+					},
+					{
+						name: 'Saturday',
+						value: '6',
+					},
+					{
+						name: 'Sunday',
+						value: '0',
+					},
+				],
+				default: '1',
+				description: 'The weekday to trigger',
+			},
+			{
+				displayName: 'Cron Expression',
+				name: 'cronExpression',
+				type: 'string',
+				displayOptions: {
+					show: {
+						mode: ['custom'],
+					},
+				},
+				default: '* * * * * *',
+				description:
+					'Use custom cron expression. Values and ranges as follows:<ul><li>Seconds: 0-59</li><li>Minutes: 0 - 59</li><li>Hours: 0 - 23</li><li>Day of Month: 1 - 31</li><li>Months: 0 - 11 (Jan - Dec)</li><li>Day of Week: 0 - 6 (Sun - Sat)</li></ul>',
+			},
+			{
+				displayName: 'Value',
+				name: 'value',
+				type: 'number',
+				typeOptions: {
+					minValue: 0,
+					maxValue: 1000,
+				},
+				displayOptions: {
+					show: {
+						mode: ['everyX'],
+					},
+				},
+				default: 2,
+				description: 'All how many X minutes/hours it should trigger',
+			},
+			{
+				displayName: 'Unit',
+				name: 'unit',
+				type: 'options',
+				displayOptions: {
+					show: {
+						mode: ['everyX'],
+					},
+				},
+				options: [
+					{
+						name: 'Minutes',
+						value: 'minutes',
+					},
+					{
+						name: 'Hours',
+						value: 'hours',
+					},
+				],
+				default: 'hours',
+				description: 'If it should trigger all X minutes or hours',
+			},
+		],
+	},
+];
+
 /**
  * Gets special parameters which should be added to nodeTypes depending
  * on their type or configuration
@@ -60,192 +247,7 @@ export function getSpecialNodeParameters(nodeType: INodeType): INodeProperties[]
 				default: { item: [{ mode: 'everyMinute' }] },
 				description: 'Time at which polling should occur',
 				placeholder: 'Add Poll Time',
-				options: [
-					{
-						name: 'item',
-						displayName: 'Item',
-						values: [
-							{
-								displayName: 'Mode',
-								name: 'mode',
-								type: 'options',
-								options: [
-									{
-										name: 'Every Minute',
-										value: 'everyMinute',
-									},
-									{
-										name: 'Every Hour',
-										value: 'everyHour',
-									},
-									{
-										name: 'Every Day',
-										value: 'everyDay',
-									},
-									{
-										name: 'Every Week',
-										value: 'everyWeek',
-									},
-									{
-										name: 'Every Month',
-										value: 'everyMonth',
-									},
-									{
-										name: 'Every X',
-										value: 'everyX',
-									},
-									{
-										name: 'Custom',
-										value: 'custom',
-									},
-								],
-								default: 'everyDay',
-								description: 'How often to trigger.',
-							},
-							{
-								displayName: 'Hour',
-								name: 'hour',
-								type: 'number',
-								typeOptions: {
-									minValue: 0,
-									maxValue: 23,
-								},
-								displayOptions: {
-									hide: {
-										mode: ['custom', 'everyHour', 'everyMinute', 'everyX'],
-									},
-								},
-								default: 14,
-								description: 'The hour of the day to trigger (24h format)',
-							},
-							{
-								displayName: 'Minute',
-								name: 'minute',
-								type: 'number',
-								typeOptions: {
-									minValue: 0,
-									maxValue: 59,
-								},
-								displayOptions: {
-									hide: {
-										mode: ['custom', 'everyMinute', 'everyX'],
-									},
-								},
-								default: 0,
-								description: 'The minute of the day to trigger',
-							},
-							{
-								displayName: 'Day of Month',
-								name: 'dayOfMonth',
-								type: 'number',
-								displayOptions: {
-									show: {
-										mode: ['everyMonth'],
-									},
-								},
-								typeOptions: {
-									minValue: 1,
-									maxValue: 31,
-								},
-								default: 1,
-								description: 'The day of the month to trigger',
-							},
-							{
-								displayName: 'Weekday',
-								name: 'weekday',
-								type: 'options',
-								displayOptions: {
-									show: {
-										mode: ['everyWeek'],
-									},
-								},
-								options: [
-									{
-										name: 'Monday',
-										value: '1',
-									},
-									{
-										name: 'Tuesday',
-										value: '2',
-									},
-									{
-										name: 'Wednesday',
-										value: '3',
-									},
-									{
-										name: 'Thursday',
-										value: '4',
-									},
-									{
-										name: 'Friday',
-										value: '5',
-									},
-									{
-										name: 'Saturday',
-										value: '6',
-									},
-									{
-										name: 'Sunday',
-										value: '0',
-									},
-								],
-								default: '1',
-								description: 'The weekday to trigger',
-							},
-							{
-								displayName: 'Cron Expression',
-								name: 'cronExpression',
-								type: 'string',
-								displayOptions: {
-									show: {
-										mode: ['custom'],
-									},
-								},
-								default: '* * * * * *',
-								description:
-									'Use custom cron expression. Values and ranges as follows:<ul><li>Seconds: 0-59</li><li>Minutes: 0 - 59</li><li>Hours: 0 - 23</li><li>Day of Month: 1 - 31</li><li>Months: 0 - 11 (Jan - Dec)</li><li>Day of Week: 0 - 6 (Sun - Sat)</li></ul>',
-							},
-							{
-								displayName: 'Value',
-								name: 'value',
-								type: 'number',
-								typeOptions: {
-									minValue: 0,
-									maxValue: 1000,
-								},
-								displayOptions: {
-									show: {
-										mode: ['everyX'],
-									},
-								},
-								default: 2,
-								description: 'All how many X minutes/hours it should trigger',
-							},
-							{
-								displayName: 'Unit',
-								name: 'unit',
-								type: 'options',
-								displayOptions: {
-									show: {
-										mode: ['everyX'],
-									},
-								},
-								options: [
-									{
-										name: 'Minutes',
-										value: 'minutes',
-									},
-									{
-										name: 'Hours',
-										value: 'hours',
-									},
-								],
-								default: 'hours',
-								description: 'If it should trigger all X minutes or hours',
-							},
-						],
-					},
-				],
+				options: cronNodeOptions,
 			},
 		];
 	}

packages/workflow/src/index.ts

@@ -3,6 +3,7 @@ import * as LoggerProxy from './LoggerProxy';
 import * as NodeHelpers from './NodeHelpers';
 import * as ObservableObject from './ObservableObject';
 
+export * from './Cron';
 export * from './DeferredPromise';
 export * from './Interfaces';
 export * from './Expression';

packages/workflow/test/Cron.test.ts

@@ -0,0 +1,75 @@
+import { toCronExpression } from "../src/Cron"
+
+describe('Cron', () => {
+  describe('toCronExpression', () => {
+    test('should generate a valid cron for `everyMinute` triggers', () => {
+      const expression = toCronExpression({
+        mode: 'everyMinute',
+      })
+      expect(expression).toMatch(/^[1-6]?[0-9] \* \* \* \* \*$/)
+    })
+
+    test('should generate a valid cron for `everyHour` triggers', () => {
+      const expression = toCronExpression({
+        mode: 'everyHour',
+        minute: 11,
+      })
+      expect(expression).toMatch(/^[1-6]?[0-9] 11 \* \* \* \*$/)
+    })
+
+    test('should generate a valid cron for `everyX[minutes]` triggers', () => {
+      const expression = toCronExpression({
+        mode: 'everyX',
+        unit: 'minutes',
+        value: 42,
+      })
+      expect(expression).toMatch(/^[1-6]?[0-9] \*\/42 \* \* \* \*$/)
+    })
+
+    test('should generate a valid cron for `everyX[hours]` triggers', () => {
+      const expression = toCronExpression({
+        mode: 'everyX',
+        unit: 'hours',
+        value: 3,
+      })
+      expect(expression).toMatch(/^[1-6]?[0-9] 0 \*\/3 \* \* \*$/)
+    })
+
+    test('should generate a valid cron for `everyDay` triggers', () => {
+      const expression = toCronExpression({
+        mode: 'everyDay',
+        hour: 13,
+        minute: 17,
+      })
+      expect(expression).toMatch(/^[1-6]?[0-9] 17 13 \* \* \*$/)
+    })
+
+    test('should generate a valid cron for `everyWeek` triggers', () => {
+      const expression = toCronExpression({
+        mode: 'everyWeek',
+        hour: 13,
+        minute: 17,
+        weekday: 4,
+      })
+      expect(expression).toMatch(/^[1-6]?[0-9] 17 13 \* \* 4$/)
+    })
+
+    test('should generate a valid cron for `everyMonth` triggers', () => {
+      const expression = toCronExpression({
+        mode: 'everyMonth',
+        hour: 13,
+        minute: 17,
+        dayOfMonth: 12,
+      })
+      expect(expression).toMatch(/^[1-6]?[0-9] 17 13 12 \* \*$/)
+    })
+
+    test('should trim custom cron expressions', () => {
+      const expression = toCronExpression({
+        mode: 'custom',
+        cronExpression: ' 0 9-17 * * * ',
+      })
+      expect(expression).toEqual('0 9-17 * * *')
+    })
+  })
+})