feat: Human in the loop (#10675)

Co-authored-by: Giulio Andreini <g.andreini@gmail.com>

packages/nodes-base/utils/sendAndWait/test/util.test.ts

@@ -0,0 +1,212 @@
+import { type MockProxy, mock } from 'jest-mock-extended';
+import type { IExecuteFunctions, INodeProperties, IWebhookFunctions } from 'n8n-workflow';
+import { NodeOperationError } from 'n8n-workflow';
+import {
+	getSendAndWaitProperties,
+	getSendAndWaitConfig,
+	createEmail,
+	sendAndWaitWebhook,
+	MESSAGE_PREFIX,
+} from '../utils';
+
+describe('Send and Wait utils tests', () => {
+	let mockExecuteFunctions: MockProxy<IExecuteFunctions>;
+	let mockWebhookFunctions: MockProxy<IWebhookFunctions>;
+
+	beforeEach(() => {
+		mockExecuteFunctions = mock<IExecuteFunctions>();
+		mockWebhookFunctions = mock<IWebhookFunctions>();
+	});
+
+	describe('getSendAndWaitProperties', () => {
+		it('should return properties with correct display options', () => {
+			const targetProperties: INodeProperties[] = [
+				{
+					displayName: 'Test Property',
+					name: 'testProperty',
+					type: 'string',
+					default: '',
+				},
+			];
+
+			const result = getSendAndWaitProperties(targetProperties);
+
+			expect(result).toEqual(
+				expect.arrayContaining([
+					expect.objectContaining({
+						displayOptions: {
+							show: {
+								resource: ['message'],
+								operation: ['sendAndWait'],
+							},
+						},
+					}),
+				]),
+			);
+		});
+	});
+
+	describe('getSendAndWaitConfig', () => {
+		it('should return correct config for single approval', () => {
+			mockExecuteFunctions.getNodeParameter.mockImplementation((parameterName: string) => {
+				const params: { [key: string]: any } = {
+					message: 'Test message',
+					subject: 'Test subject',
+					'approvalOptions.values': {
+						approvalType: 'single',
+						approveLabel: 'Approve',
+						buttonApprovalStyle: 'primary',
+					},
+				};
+				return params[parameterName];
+			});
+
+			mockExecuteFunctions.evaluateExpression.mockImplementation((expression: string) => {
+				const expressions: { [key: string]: string } = {
+					'{{ $execution?.resumeUrl }}': 'http://localhost',
+					'{{ $nodeId }}': 'testNodeId',
+				};
+				return expressions[expression];
+			});
+
+			const config = getSendAndWaitConfig(mockExecuteFunctions);
+
+			expect(config).toEqual({
+				title: 'Test subject',
+				message: 'Test message',
+				url: 'http://localhost/testNodeId',
+				options: [
+					{
+						label: 'Approve',
+						value: 'true',
+						style: 'primary',
+					},
+				],
+			});
+		});
+
+		it('should return correct config for double approval', () => {
+			mockExecuteFunctions.getNodeParameter.mockImplementation((parameterName: string) => {
+				const params: { [key: string]: any } = {
+					message: 'Test message',
+					subject: 'Test subject',
+					'approvalOptions.values': {
+						approvalType: 'double',
+						approveLabel: 'Approve',
+						buttonApprovalStyle: 'primary',
+						disapproveLabel: 'Reject',
+						buttonDisapprovalStyle: 'secondary',
+					},
+				};
+				return params[parameterName];
+			});
+
+			mockExecuteFunctions.evaluateExpression.mockImplementation((expression: string) => {
+				const expressions: { [key: string]: string } = {
+					'{{ $execution?.resumeUrl }}': 'http://localhost',
+					'{{ $nodeId }}': 'testNodeId',
+				};
+				return expressions[expression];
+			});
+
+			const config = getSendAndWaitConfig(mockExecuteFunctions);
+
+			expect(config.options).toHaveLength(2);
+			expect(config.options).toEqual(
+				expect.arrayContaining([
+					{
+						label: 'Reject',
+						value: 'false',
+						style: 'secondary',
+					},
+					{
+						label: 'Approve',
+						value: 'true',
+						style: 'primary',
+					},
+				]),
+			);
+		});
+	});
+
+	describe('createEmail', () => {
+		beforeEach(() => {
+			mockExecuteFunctions.getNodeParameter.mockImplementation((parameterName: string) => {
+				const params: { [key: string]: any } = {
+					sendTo: 'test@example.com',
+					message: 'Test message',
+					subject: 'Test subject',
+					'approvalOptions.values': {
+						approvalType: 'single',
+						approveLabel: 'Approve',
+						buttonApprovalStyle: 'primary',
+					},
+				};
+				return params[parameterName];
+			});
+
+			mockExecuteFunctions.evaluateExpression.mockImplementation((expression: string) => {
+				const expressions: { [key: string]: string } = {
+					'{{ $execution?.resumeUrl }}': 'http://localhost',
+					'{{ $nodeId }}': 'testNodeId',
+				};
+				return expressions[expression];
+			});
+		});
+
+		it('should create a valid email object', () => {
+			const email = createEmail(mockExecuteFunctions);
+
+			expect(email).toEqual({
+				to: 'test@example.com',
+				subject: `${MESSAGE_PREFIX}Test subject`,
+				body: '',
+				htmlBody: expect.stringContaining('Test message'),
+			});
+		});
+
+		it('should throw NodeOperationError for invalid email address', () => {
+			mockExecuteFunctions.getNodeParameter.mockImplementation((parameterName: string) => {
+				const params: { [key: string]: any } = {
+					sendTo: 'invalid@@email.com',
+					message: 'Test message',
+					subject: 'Test subject',
+					'approvalOptions.values': {
+						approvalType: 'single',
+					},
+				};
+				return params[parameterName];
+			});
+
+			expect(() => createEmail(mockExecuteFunctions)).toThrow(NodeOperationError);
+		});
+	});
+
+	describe('sendAndWaitWebhook', () => {
+		it('should handle approved webhook', async () => {
+			mockWebhookFunctions.getRequestObject.mockReturnValue({
+				query: { approved: 'true' },
+			} as any);
+
+			const result = await sendAndWaitWebhook.call(mockWebhookFunctions);
+
+			expect(result).toEqual({
+				webhookResponse: expect.any(String),
+				workflowData: [[{ json: { data: { approved: true } } }]],
+			});
+		});
+
+		it('should handle disapproved webhook', async () => {
+			mockWebhookFunctions.getRequestObject.mockReturnValue({
+				query: { approved: 'false' },
+			} as any);
+
+			const result = await sendAndWaitWebhook.call(mockWebhookFunctions);
+
+			expect(result).toEqual({
+				webhookResponse: expect.any(String),
+				workflowData: [[{ json: { data: { approved: false } } }]],
+			});
+		});
+	});
+});