Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Do not trigger sendAndWait response on bot visit if response type is approval #13792

Merged
merged 5 commits into from
Mar 11, 2025
Merged

fix: Do not trigger sendAndWait response on bot visit if response type is approval #13792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e3adba9
do not trigger wait response on bot visit if response type approval
michael-radency Mar 10, 2025
6bbce46
test
michael-radency Mar 11, 2025
286883e
Merge branch 'master' of https://github.com/n8n-io/n8n into node-2485…
michael-radency Mar 11, 2025
b747357
Merge branch 'master' of https://github.com/n8n-io/n8n into node-2485…
michael-radency Mar 11, 2025
49d3d77
test send called with ''
michael-radency Mar 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions packages/nodes-base/utils/sendAndWait/test/util.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,34 @@ describe('Send and Wait utils tests', () => {

expect(result.workflowData).toEqual([[{ json: { data: { 'test 1': 'test value' } } }]]);
});

it('should return noWebhookResponse if method GET and user-agent is bot', async () => {
mockWebhookFunctions.getRequestObject.mockReturnValue({
method: 'GET',
headers: {
'user-agent': 'Mozilla/5.0 (compatible; Googlebot/2.1; +http://www.google.com/bot.html)',
},
query: { approved: 'false' },
} as any);

const send = jest.fn();

mockWebhookFunctions.getResponseObject.mockReturnValue({
send,
} as any);

mockWebhookFunctions.getNodeParameter.mockImplementation((parameterName: string) => {
const params: { [key: string]: any } = {
responseType: 'approval',
};
return params[parameterName];
});

const result = await sendAndWaitWebhook.call(mockWebhookFunctions);

expect(send).toHaveBeenCalledWith('');
expect(result).toEqual({ noWebhookResponse: true });
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also add a test for testing that res.send gets called with ''? :)

});
});
});

Expand Down
10 changes: 9 additions & 1 deletion packages/nodes-base/utils/sendAndWait/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import isbot from 'isbot';
import {
NodeOperationError,
SEND_AND_WAIT_OPERATION,
Expand Down Expand Up @@ -324,11 +325,18 @@ const getFormResponseCustomizations = (context: IWebhookFunctions) => {
export async function sendAndWaitWebhook(this: IWebhookFunctions) {
const method = this.getRequestObject().method;
const res = this.getResponseObject();
const req = this.getRequestObject();

const responseType = this.getNodeParameter('responseType', 'approval') as
| 'approval'
| 'freeText'
| 'customForm';

if (responseType === 'approval' && isbot(req.headers['user-agent'])) {
res.send('');
return { noWebhookResponse: true };
}

if (responseType === 'freeText') {
if (method === 'GET') {
const { formTitle, formDescription, buttonLabel } = getFormResponseCustomizations(this);
Expand Down Expand Up @@ -424,7 +432,7 @@ export async function sendAndWaitWebhook(this: IWebhookFunctions) {
}
}

const query = this.getRequestObject().query as { approved: 'false' | 'true' };
const query = req.query as { approved: 'false' | 'true' };
const approved = query.approved === 'true';
return {
webhookResponse: ACTION_RECORDED_PAGE,
Expand Down
Loading