fix(n8n Form Trigger Node): Update error in validateResponseModeConfiguration (no-changelog) (#13162)

This commit is contained in:
Michael Kret 2025-02-11 14:52:21 +02:00 committed by GitHub
parent 78644b0ec7
commit 6abb1f9374
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 74 additions and 3 deletions

View file

@ -190,8 +190,9 @@ describe('FormTrigger', () => {
); );
await expect( await expect(
testVersionedWebhookTriggerNode(FormTrigger, 2, { testVersionedWebhookTriggerNode(FormTrigger, 2.1, {
node: { node: {
typeVersion: 2.1,
parameters: { parameters: {
responseMode: 'onReceived', responseMode: 'onReceived',
}, },

View file

@ -16,6 +16,7 @@ import {
resolveRawData, resolveRawData,
isFormConnected, isFormConnected,
sanitizeHtml, sanitizeHtml,
validateResponseModeConfiguration,
} from '../utils'; } from '../utils';
describe('FormTrigger, parseFormDescription', () => { describe('FormTrigger, parseFormDescription', () => {
@ -939,3 +940,58 @@ describe('FormTrigger, isFormConnected', () => {
expect(result).toBe(true); expect(result).toBe(true);
}); });
}); });
describe('validateResponseModeConfiguration', () => {
let webhookFunctions: ReturnType<typeof mock<IWebhookFunctions>>;
beforeEach(() => {
webhookFunctions = mock<IWebhookFunctions>();
webhookFunctions.getNode.mockReturnValue({
name: 'TestNode',
typeVersion: 2.2,
} as INode);
webhookFunctions.getChildNodes.mockReturnValue([]);
});
test('throws error if responseMode is "responseNode" but no Respond to Webhook node is connected', () => {
webhookFunctions.getNodeParameter.mockReturnValue('responseNode');
expect(() => validateResponseModeConfiguration(webhookFunctions)).toThrow(
'No Respond to Webhook node found in the workflow',
);
});
test('throws error if "Respond to Webhook" node is connected but "responseMode" is not "responseNode" in typeVersion <= 2.1', () => {
webhookFunctions.getNodeParameter.mockReturnValue('onReceived');
webhookFunctions.getNode.mockReturnValue({
name: 'TestNode',
typeVersion: 2.1,
} as INode);
webhookFunctions.getChildNodes.mockReturnValue([
{ type: 'n8n-nodes-base.respondToWebhook' } as NodeTypeAndVersion,
]);
expect(() => validateResponseModeConfiguration(webhookFunctions)).toThrow(
'TestNode node not correctly configured',
);
});
test('throws error if "Respond to Webhook" node is connected, version >= 2.2', () => {
webhookFunctions.getNodeParameter.mockReturnValue('responseNode');
webhookFunctions.getChildNodes.mockReturnValue([
{ type: 'n8n-nodes-base.respondToWebhook' } as NodeTypeAndVersion,
]);
expect(() => validateResponseModeConfiguration(webhookFunctions)).toThrow(
'The "Respond to Webhook" node is not supported in workflows initiated by the "n8n Form Trigger"',
);
});
test('does not throw an error mode in not "responseNode" and no "Respond to Webhook" node is connected', () => {
webhookFunctions.getNodeParameter.mockReturnValue('onReceived');
expect(() => validateResponseModeConfiguration(webhookFunctions)).not.toThrow();
});
});

View file

@ -187,9 +187,10 @@ export function prepareFormData({
return formData; return formData;
} }
const validateResponseModeConfiguration = (context: IWebhookFunctions) => { export const validateResponseModeConfiguration = (context: IWebhookFunctions) => {
const responseMode = context.getNodeParameter('responseMode', 'onReceived') as string; const responseMode = context.getNodeParameter('responseMode', 'onReceived') as string;
const connectedNodes = context.getChildNodes(context.getNode().name); const connectedNodes = context.getChildNodes(context.getNode().name);
const nodeVersion = context.getNode().typeVersion;
const isRespondToWebhookConnected = connectedNodes.some( const isRespondToWebhookConnected = connectedNodes.some(
(node) => node.type === 'n8n-nodes-base.respondToWebhook', (node) => node.type === 'n8n-nodes-base.respondToWebhook',
@ -206,7 +207,7 @@ const validateResponseModeConfiguration = (context: IWebhookFunctions) => {
); );
} }
if (isRespondToWebhookConnected && responseMode !== 'responseNode') { if (isRespondToWebhookConnected && responseMode !== 'responseNode' && nodeVersion <= 2.1) {
throw new NodeOperationError( throw new NodeOperationError(
context.getNode(), context.getNode(),
new Error(`${context.getNode().name} node not correctly configured`), new Error(`${context.getNode().name} node not correctly configured`),
@ -216,6 +217,19 @@ const validateResponseModeConfiguration = (context: IWebhookFunctions) => {
}, },
); );
} }
if (isRespondToWebhookConnected && nodeVersion > 2.1) {
throw new NodeOperationError(
context.getNode(),
new Error(
'The "Respond to Webhook" node is not supported in workflows initiated by the "n8n Form Trigger"',
),
{
description:
'To configure your response, add an "n8n Form" node and set the "Page Type" to "Form Ending"',
},
);
}
}; };
export async function prepareFormReturnItem( export async function prepareFormReturnItem(