mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2025-03-05 20:50:17 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix(n8n Form Node): Remove dependence on static data from the form completion page (no-changelog) (#12445)

Browse source
This commit is contained in:
Michael Kret 2025-01-07 11:39:59 +02:00 committed by GitHub
parent e234756457
commit 7df5eb1e4d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 57 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
packages/nodes-base/nodes/Form/Form.node.ts
View file

@ -19,7 +19,6 @@ import {
WAIT_INDEFINITELY, WAIT_INDEFINITELY,
} from 'n8n-workflow'; } from 'n8n-workflow';
import { type CompletionPageConfig } from './interfaces';
import { formDescription, formFields, formTitle } from '../Form/common.descriptions'; import { formDescription, formFields, formTitle } from '../Form/common.descriptions';
import { prepareFormReturnItem, renderForm, resolveRawData } from '../Form/utils'; import { prepareFormReturnItem, renderForm, resolveRawData } from '../Form/utils';
@ -273,19 +272,19 @@ export class Form extends Node {
const method = context.getRequestObject().method; const method = context.getRequestObject().method;
if (operation === 'completion' && method === 'GET') { if (operation === 'completion' && method === 'GET') {
const staticData = context.getWorkflowStaticData('node'); const completionTitle = context.getNodeParameter('completionTitle', '') as string;
const id = `${context.getExecutionId()}-${context.getNode().name}`; const completionMessage = context.getNodeParameter('completionMessage', '') as string;
const config = staticData?.[id] as CompletionPageConfig; const redirectUrl = context.getNodeParameter('redirectUrl', '') as string;
delete staticData[id]; const options = context.getNodeParameter('options', {}) as { formTitle: string };
if (config.redirectUrl) { if (redirectUrl) {
res.send( res.send(
`<html><head><meta http-equiv="refresh" content="0; url=${config.redirectUrl}"></head></html>`, `<html><head><meta http-equiv="refresh" content="0; url=${redirectUrl}"></head></html>`,
); );
return { noWebhookResponse: true }; return { noWebhookResponse: true };
} }
let title = config.pageTitle; let title = options.formTitle;
if (!title) { if (!title) {
title = context.evaluateExpression( title = context.evaluateExpression(
`{{ $('${trigger?.name}').params.formTitle }}`, `{{ $('${trigger?.name}').params.formTitle }}`,
@ -296,8 +295,8 @@ export class Form extends Node {
) as boolean; ) as boolean;
res.render('form-trigger-completion', { res.render('form-trigger-completion', {
title: config.completionTitle, title: completionTitle,
message: config.completionMessage, message: completionMessage,
formTitle: title, formTitle: title,
appendAttribution, appendAttribution,
}); });
@ -419,28 +418,7 @@ export class Form extends Node {
); );
} }
if (operation !== 'completion') { await context.putExecutionToWait(WAIT_INDEFINITELY);
await context.putExecutionToWait(WAIT_INDEFINITELY);
} else {
const staticData = context.getWorkflowStaticData('node');
const completionTitle = context.getNodeParameter('completionTitle', 0, '') as string;
const completionMessage = context.getNodeParameter('completionMessage', 0, '') as string;
const redirectUrl = context.getNodeParameter('redirectUrl', 0, '') as string;
const options = context.getNodeParameter('options', 0, {}) as { formTitle: string };
const id = `${context.getExecutionId()}-${context.getNode().name}`;
const config: CompletionPageConfig = {
completionTitle,
completionMessage,
redirectUrl,
pageTitle: options.formTitle,
};
staticData[id] = config;
const waitTill = new Date(WAIT_INDEFINITELY);
await context.putExecutionToWait(waitTill);
}
return [context.getInputData()]; return [context.getInputData()];
} }

7
packages/nodes-base/nodes/Form/interfaces.ts
View file

@ -32,11 +32,4 @@ export type FormTriggerData = {
buttonLabel?: string; buttonLabel?: string;
}; };
export type CompletionPageConfig = {
pageTitle?: string;
completionMessage?: string;
completionTitle?: string;
redirectUrl?: string;
};
export const FORM_TRIGGER_AUTHENTICATION_PROPERTY = 'authentication'; export const FORM_TRIGGER_AUTHENTICATION_PROPERTY = 'authentication';

54
packages/nodes-base/nodes/Form/test/Form.node.test.ts
View file

@ -172,7 +172,7 @@ describe('Form Node', () => {
]); ]);
}); });
it('should handle completion operation', async () => { it('should handle completion operation and render completion page', async () => {
mockWebhookFunctions.getRequestObject.mockReturnValue({ method: 'GET' } as Request); mockWebhookFunctions.getRequestObject.mockReturnValue({ method: 'GET' } as Request);
mockWebhookFunctions.getNodeParameter.mockImplementation((paramName) => { mockWebhookFunctions.getNodeParameter.mockImplementation((paramName) => {
if (paramName === 'operation') return 'completion'; if (paramName === 'operation') return 'completion';
@ -181,6 +181,7 @@ describe('Form Node', () => {
if (paramName === 'respondWith') return 'text'; if (paramName === 'respondWith') return 'text';
if (paramName === 'completionTitle') return 'Test Title'; if (paramName === 'completionTitle') return 'Test Title';
if (paramName === 'completionMessage') return 'Test Message'; if (paramName === 'completionMessage') return 'Test Message';
if (paramName === 'redirectUrl') return '';
return {}; return {};
}); });
mockWebhookFunctions.getParentNodes.mockReturnValue([ mockWebhookFunctions.getParentNodes.mockReturnValue([
@ -202,16 +203,55 @@ describe('Form Node', () => {
); );
mockWebhookFunctions.getNode.mockReturnValue(mock<INode>({ name: formCompletionNodeName })); mockWebhookFunctions.getNode.mockReturnValue(mock<INode>({ name: formCompletionNodeName }));
mockWebhookFunctions.getExecutionId.mockReturnValue(testExecutionId); mockWebhookFunctions.getExecutionId.mockReturnValue(testExecutionId);
mockWebhookFunctions.getWorkflowStaticData.mockReturnValue({
[`${testExecutionId}-${formCompletionNodeName}`]: { redirectUrl: '' },
});
const result = await form.webhook(mockWebhookFunctions); const result = await form.webhook(mockWebhookFunctions);
expect(result).toEqual({ noWebhookResponse: true }); expect(result).toEqual({ noWebhookResponse: true });
expect(mockResponseObject.render).toHaveBeenCalledWith( expect(mockResponseObject.render).toHaveBeenCalledWith('form-trigger-completion', {
'form-trigger-completion', appendAttribution: 'test',
expect.any(Object), formTitle: 'test',
message: 'Test Message',
title: 'Test Title',
});
});
it('should handle completion operation and redirect', async () => {
mockWebhookFunctions.getRequestObject.mockReturnValue({ method: 'GET' } as Request);
mockWebhookFunctions.getNodeParameter.mockImplementation((paramName) => {
if (paramName === 'operation') return 'completion';
if (paramName === 'useJson') return false;
if (paramName === 'jsonOutput') return '[]';
if (paramName === 'respondWith') return 'text';
if (paramName === 'completionTitle') return 'Test Title';
if (paramName === 'completionMessage') return 'Test Message';
if (paramName === 'redirectUrl') return 'https://n8n.io';
return {};
});
mockWebhookFunctions.getParentNodes.mockReturnValue([
{
type: 'n8n-nodes-base.formTrigger',
name: 'Form Trigger',
typeVersion: 2.1,
disabled: false,
},
]);
mockWebhookFunctions.evaluateExpression.mockReturnValue('test');
const mockResponseObject = {
render: jest.fn(),
redirect: jest.fn(),
send: jest.fn(),
};
mockWebhookFunctions.getResponseObject.mockReturnValue(
mockResponseObject as unknown as Response,
);
mockWebhookFunctions.getNode.mockReturnValue(mock<INode>({ name: formCompletionNodeName }));
const result = await form.webhook(mockWebhookFunctions);
expect(result).toEqual({ noWebhookResponse: true });
expect(mockResponseObject.send).toHaveBeenCalledWith(
'<html><head><meta http-equiv="refresh" content="0; url=https://n8n.io"></head></html>',
); );
}); });
}); });