From f4bf55f0d8278ff954344cf6397c10d8261b39a4 Mon Sep 17 00:00:00 2001 From: Michael Kret <88898367+michael-radency@users.noreply.github.com> Date: Thu, 23 Jan 2025 18:38:24 +0200 Subject: [PATCH] feat(Microsoft Outlook Node): New operation sendAndWait (#12795) --- .../test/v2/node/message/sendAndWait.test.ts | 73 +++++++++++++++++++ .../Outlook/v2/MicrosoftOutlookV2.node.ts | 3 + .../Outlook/v2/actions/message/index.ts | 12 ++- .../actions/message/sendAndWait.operation.ts | 55 ++++++++++++++ .../Outlook/v2/actions/node.description.ts | 20 +++++ .../Microsoft/Outlook/v2/actions/node.type.ts | 2 +- .../Microsoft/Outlook/v2/actions/router.ts | 17 ++++- .../nodes-base/utils/sendAndWait/utils.ts | 2 +- 8 files changed, 179 insertions(+), 5 deletions(-) create mode 100644 packages/nodes-base/nodes/Microsoft/Outlook/test/v2/node/message/sendAndWait.test.ts create mode 100644 packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/message/sendAndWait.operation.ts diff --git a/packages/nodes-base/nodes/Microsoft/Outlook/test/v2/node/message/sendAndWait.test.ts b/packages/nodes-base/nodes/Microsoft/Outlook/test/v2/node/message/sendAndWait.test.ts new file mode 100644 index 0000000000000..7446118275619 --- /dev/null +++ b/packages/nodes-base/nodes/Microsoft/Outlook/test/v2/node/message/sendAndWait.test.ts @@ -0,0 +1,73 @@ +import type { MockProxy } from 'jest-mock-extended'; +import { mock } from 'jest-mock-extended'; +import { SEND_AND_WAIT_OPERATION, type IExecuteFunctions } from 'n8n-workflow'; + +import { description } from '../../../../v2/actions/node.description'; +import { MicrosoftOutlookV2 } from '../../../../v2/MicrosoftOutlookV2.node'; +import * as transport from '../../../../v2/transport'; + +jest.mock('../../../../v2/transport', () => { + const originalModule = jest.requireActual('../../../../v2/transport'); + return { + ...originalModule, + microsoftApiRequest: jest.fn(async function (method: string) { + if (method === 'POST') { + return {}; + } + }), + }; +}); + +describe('Test MicrosoftOutlookV2, message => sendAndWait', () => { + let microsoftOutlook: MicrosoftOutlookV2; + let mockExecuteFunctions: MockProxy; + + beforeEach(() => { + microsoftOutlook = new MicrosoftOutlookV2(description); + mockExecuteFunctions = mock(); + }); + + afterEach(() => { + jest.clearAllMocks(); + }); + + it('should send message and put execution to wait', async () => { + const items = [{ json: { data: 'test' } }]; + //router + mockExecuteFunctions.getInputData.mockReturnValue(items); + mockExecuteFunctions.getNodeParameter.mockReturnValueOnce('message'); + mockExecuteFunctions.getNodeParameter.mockReturnValueOnce(SEND_AND_WAIT_OPERATION); + mockExecuteFunctions.putExecutionToWait.mockImplementation(); + + //operation + mockExecuteFunctions.getNodeParameter.mockReturnValueOnce('my@outlook.com'); + mockExecuteFunctions.getInstanceId.mockReturnValue('instanceId'); + + //getSendAndWaitConfig + mockExecuteFunctions.getNodeParameter.mockReturnValueOnce('my message'); + mockExecuteFunctions.getNodeParameter.mockReturnValueOnce('my subject'); + mockExecuteFunctions.evaluateExpression.mockReturnValueOnce('http://localhost/waiting-webhook'); + mockExecuteFunctions.evaluateExpression.mockReturnValueOnce('nodeID'); + mockExecuteFunctions.getNodeParameter.mockReturnValueOnce({}); + mockExecuteFunctions.getNodeParameter.mockReturnValueOnce('approval'); + + const result = await microsoftOutlook.execute.call(mockExecuteFunctions); + + expect(result).toEqual([items]); + expect(transport.microsoftApiRequest).toHaveBeenCalledTimes(1); + expect(mockExecuteFunctions.putExecutionToWait).toHaveBeenCalledTimes(1); + + expect(transport.microsoftApiRequest).toHaveBeenCalledWith('POST', '/sendMail', { + message: { + body: { + content: expect.stringContaining( + 'href="http://localhost/waiting-webhook/nodeID?approved=true"', + ), + contentType: 'html', + }, + subject: 'my subject', + toRecipients: [{ emailAddress: { address: 'my@outlook.com' } }], + }, + }); + }); +}); diff --git a/packages/nodes-base/nodes/Microsoft/Outlook/v2/MicrosoftOutlookV2.node.ts b/packages/nodes-base/nodes/Microsoft/Outlook/v2/MicrosoftOutlookV2.node.ts index 481c868b3593e..a40671d722568 100644 --- a/packages/nodes-base/nodes/Microsoft/Outlook/v2/MicrosoftOutlookV2.node.ts +++ b/packages/nodes-base/nodes/Microsoft/Outlook/v2/MicrosoftOutlookV2.node.ts @@ -8,6 +8,7 @@ import type { import { description } from './actions/node.description'; import { router } from './actions/router'; import { loadOptions, listSearch } from './methods'; +import { sendAndWaitWebhook } from '../../../../utils/sendAndWait/utils'; export class MicrosoftOutlookV2 implements INodeType { description: INodeTypeDescription; @@ -21,6 +22,8 @@ export class MicrosoftOutlookV2 implements INodeType { methods = { loadOptions, listSearch }; + webhook = sendAndWaitWebhook; + async execute(this: IExecuteFunctions) { return await router.call(this); } diff --git a/packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/message/index.ts b/packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/message/index.ts index 4002ed6538f4d..b36da52f38f40 100644 --- a/packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/message/index.ts +++ b/packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/message/index.ts @@ -1,4 +1,4 @@ -import type { INodeProperties } from 'n8n-workflow'; +import { SEND_AND_WAIT_OPERATION, type INodeProperties } from 'n8n-workflow'; import * as del from './delete.operation'; import * as get from './get.operation'; @@ -6,9 +6,10 @@ import * as getAll from './getAll.operation'; import * as move from './move.operation'; import * as reply from './reply.operation'; import * as send from './send.operation'; +import * as sendAndWait from './sendAndWait.operation'; import * as update from './update.operation'; -export { del as delete, get, getAll, move, reply, send, update }; +export { del as delete, get, getAll, move, reply, send, sendAndWait, update }; export const description: INodeProperties[] = [ { @@ -58,6 +59,12 @@ export const description: INodeProperties[] = [ description: 'Send a message', action: 'Send a message', }, + { + name: 'Send and Wait for Response', + value: SEND_AND_WAIT_OPERATION, + description: 'Send a message and wait for response', + action: 'Send message and wait for response', + }, { name: 'Update', value: 'update', @@ -74,5 +81,6 @@ export const description: INodeProperties[] = [ ...move.description, ...reply.description, ...send.description, + ...sendAndWait.description, ...update.description, ]; diff --git a/packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/message/sendAndWait.operation.ts b/packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/message/sendAndWait.operation.ts new file mode 100644 index 0000000000000..53985249dcea5 --- /dev/null +++ b/packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/message/sendAndWait.operation.ts @@ -0,0 +1,55 @@ +import type { + IDataObject, + IExecuteFunctions, + INodeExecutionData, + INodeProperties, +} from 'n8n-workflow'; + +import { createEmailBody } from '../../../../../../utils/sendAndWait/email-templates'; +import { + getSendAndWaitConfig, + getSendAndWaitProperties, + createButton, +} from '../../../../../../utils/sendAndWait/utils'; +import { createMessage } from '../../helpers/utils'; +import { microsoftApiRequest } from '../../transport'; + +export const description: INodeProperties[] = getSendAndWaitProperties([ + { + displayName: 'To', + name: 'toRecipients', + description: 'Comma-separated list of email addresses of recipients', + type: 'string', + required: true, + default: '', + }, +]); + +export async function execute(this: IExecuteFunctions, index: number, items: INodeExecutionData[]) { + const toRecipients = this.getNodeParameter('toRecipients', index) as string; + + const config = getSendAndWaitConfig(this); + const buttons: string[] = []; + for (const option of config.options) { + buttons.push(createButton(config.url, option.label, option.value, option.style)); + } + + const instanceId = this.getInstanceId(); + + const bodyContent = createEmailBody(config.message, buttons.join('\n'), instanceId); + + const fields: IDataObject = { + subject: config.title, + bodyContent, + toRecipients, + bodyContentType: 'html', + }; + + const message: IDataObject = createMessage(fields); + + const body: IDataObject = { message }; + + await microsoftApiRequest.call(this, 'POST', '/sendMail', body); + + return items; +} diff --git a/packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/node.description.ts b/packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/node.description.ts index 50d034968374a..2224ea673eae8 100644 --- a/packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/node.description.ts +++ b/packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/node.description.ts @@ -30,6 +30,26 @@ export const description: INodeTypeDescription = { required: true, }, ], + webhooks: [ + { + name: 'default', + httpMethod: 'GET', + responseMode: 'onReceived', + responseData: '', + path: '={{ $nodeId }}', + restartWebhook: true, + isFullPath: true, + }, + { + name: 'default', + httpMethod: 'POST', + responseMode: 'onReceived', + responseData: '', + path: '={{ $nodeId }}', + restartWebhook: true, + isFullPath: true, + }, + ], properties: [ { displayName: 'Resource', diff --git a/packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/node.type.ts b/packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/node.type.ts index 19b6f02b5616c..358498d0fb2d1 100644 --- a/packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/node.type.ts +++ b/packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/node.type.ts @@ -7,7 +7,7 @@ type NodeMap = { event: 'create' | 'delete' | 'get' | 'getAll' | 'update'; folder: 'create' | 'delete' | 'get' | 'getAll' | 'update'; folderMessage: 'getAll'; - message: 'delete' | 'get' | 'getAll' | 'move' | 'update' | 'send' | 'reply'; + message: 'delete' | 'get' | 'getAll' | 'move' | 'update' | 'send' | 'reply' | 'sendAndWait'; messageAttachment: 'add' | 'download' | 'getAll' | 'get'; }; diff --git a/packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/router.ts b/packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/router.ts index 7fd67db228047..64b1bffc65e31 100644 --- a/packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/router.ts +++ b/packages/nodes-base/nodes/Microsoft/Outlook/v2/actions/router.ts @@ -1,5 +1,10 @@ import type { IExecuteFunctions, INodeExecutionData } from 'n8n-workflow'; -import { NodeApiError, NodeOperationError } from 'n8n-workflow'; +import { + NodeApiError, + NodeOperationError, + SEND_AND_WAIT_OPERATION, + WAIT_INDEFINITELY, +} from 'n8n-workflow'; import * as calendar from './calendar'; import * as contact from './contact'; @@ -25,6 +30,16 @@ export async function router(this: IExecuteFunctions) { operation, } as MicrosoftOutlook; + if ( + microsoftOutlook.resource === 'message' && + microsoftOutlook.operation === SEND_AND_WAIT_OPERATION + ) { + await message[microsoftOutlook.operation].execute.call(this, 0, items); + + await this.putExecutionToWait(WAIT_INDEFINITELY); + return [items]; + } + for (let i = 0; i < items.length; i++) { try { switch (microsoftOutlook.resource) { diff --git a/packages/nodes-base/utils/sendAndWait/utils.ts b/packages/nodes-base/utils/sendAndWait/utils.ts index 4f79a5918e2b4..2135f92a84af7 100644 --- a/packages/nodes-base/utils/sendAndWait/utils.ts +++ b/packages/nodes-base/utils/sendAndWait/utils.ts @@ -554,7 +554,7 @@ export function getSendAndWaitConfig(context: IExecuteFunctions): SendAndWaitCon return config; } -function createButton(url: string, label: string, approved: string, style: string) { +export function createButton(url: string, label: string, approved: string, style: string) { let buttonStyle = BUTTON_STYLE_PRIMARY; if (style === 'secondary') { buttonStyle = BUTTON_STYLE_SECONDARY;