import { IWebhookData, WebhookHttpMethod, Workflow, WorkflowActivateMode, WorkflowExecuteMode, } from 'n8n-workflow'; import { NodeExecuteFunctions, } from './'; export class ActiveWebhooks { private workflowWebhooks: { [key: string]: IWebhookData[]; } = {}; private webhookUrls: { [key: string]: IWebhookData[]; } = {}; testWebhooks = false; /** * Adds a new webhook * * @param {IWebhookData} webhookData * @param {WorkflowExecuteMode} mode * @returns {Promise} * @memberof ActiveWebhooks */ async add(workflow: Workflow, webhookData: IWebhookData, mode: WorkflowExecuteMode, activation: WorkflowActivateMode): Promise { if (workflow.id === undefined) { throw new Error('Webhooks can only be added for saved workflows as an id is needed!'); } if (webhookData.path.endsWith('/')) { webhookData.path = webhookData.path.slice(0, -1); } const webhookKey = this.getWebhookKey(webhookData.httpMethod, webhookData.path, webhookData.webhookId); //check that there is not a webhook already registed with that path/method if (this.webhookUrls[webhookKey] && !webhookData.webhookId) { throw new Error(`Test-Webhook can not be activated because another one with the same method "${webhookData.httpMethod}" and path "${webhookData.path}" is already active!`); } if (this.workflowWebhooks[webhookData.workflowId] === undefined) { this.workflowWebhooks[webhookData.workflowId] = []; } // Make the webhook available directly because sometimes to create it successfully // it gets called if (!this.webhookUrls[webhookKey]) { this.webhookUrls[webhookKey] = []; } this.webhookUrls[webhookKey].push(webhookData); try { const webhookExists = await workflow.runWebhookMethod('checkExists', webhookData, NodeExecuteFunctions, mode, activation, this.testWebhooks); if (webhookExists !== true) { // If webhook does not exist yet create it await workflow.runWebhookMethod('create', webhookData, NodeExecuteFunctions, mode, activation, this.testWebhooks); } } catch (error) { // If there was a problem unregister the webhook again if (this.webhookUrls[webhookKey].length <= 1) { delete this.webhookUrls[webhookKey]; } else { this.webhookUrls[webhookKey] = this.webhookUrls[webhookKey].filter(webhook => webhook.path !== webhookData.path); } throw error; } this.workflowWebhooks[webhookData.workflowId].push(webhookData); } /** * Returns webhookData if a webhook with matches is currently registered * * @param {WebhookHttpMethod} httpMethod * @param {string} path * @param {(string | undefined)} webhookId * @returns {(IWebhookData | undefined)} * @memberof ActiveWebhooks */ get(httpMethod: WebhookHttpMethod, path: string, webhookId?: string): IWebhookData | undefined { const webhookKey = this.getWebhookKey(httpMethod, path, webhookId); if (this.webhookUrls[webhookKey] === undefined) { return undefined; } let webhook: IWebhookData | undefined; let maxMatches = 0; const pathElementsSet = new Set(path.split('/')); // check if static elements match in path // if more results have been returned choose the one with the most static-route matches this.webhookUrls[webhookKey].forEach(dynamicWebhook => { const staticElements = dynamicWebhook.path.split('/').filter(ele => !ele.startsWith(':')); const allStaticExist = staticElements.every(staticEle => pathElementsSet.has(staticEle)); if (allStaticExist && staticElements.length > maxMatches) { maxMatches = staticElements.length; webhook = dynamicWebhook; } // handle routes with no static elements else if (staticElements.length === 0 && !webhook) { webhook = dynamicWebhook; } }); return webhook; } /** * Gets all request methods associated with a single webhook * @param path */ getWebhookMethods(path: string): string[] { const methods : string[] = []; Object.keys(this.webhookUrls) .filter(key => key.includes(path)) .map(key => { methods.push(key.split('|')[0]); }); return methods; } /** * Returns the ids of all the workflows which have active webhooks * * @returns {string[]} * @memberof ActiveWebhooks */ getWorkflowIds(): string[] { return Object.keys(this.workflowWebhooks); } /** * Returns key to uniquely identify a webhook * * @param {WebhookHttpMethod} httpMethod * @param {string} path * @param {(string | undefined)} webhookId * @returns {string} * @memberof ActiveWebhooks */ getWebhookKey(httpMethod: WebhookHttpMethod, path: string, webhookId?: string): string { if (webhookId) { if (path.startsWith(webhookId)) { const cutFromIndex = path.indexOf('/') + 1; path = path.slice(cutFromIndex); } return `${httpMethod}|${webhookId}|${path.split('/').length}`; } return `${httpMethod}|${path}`; } /** * Removes all webhooks of a workflow * * @param {Workflow} workflow * @returns {boolean} * @memberof ActiveWebhooks */ async removeWorkflow(workflow: Workflow): Promise { const workflowId = workflow.id!.toString(); if (this.workflowWebhooks[workflowId] === undefined) { // If it did not exist then there is nothing to remove return false; } const webhooks = this.workflowWebhooks[workflowId]; const mode = 'internal'; // Go through all the registered webhooks of the workflow and remove them for (const webhookData of webhooks) { await workflow.runWebhookMethod('delete', webhookData, NodeExecuteFunctions, mode, 'update', this.testWebhooks); delete this.webhookUrls[this.getWebhookKey(webhookData.httpMethod, webhookData.path, webhookData.webhookId)]; } // Remove also the workflow-webhook entry delete this.workflowWebhooks[workflowId]; return true; } /** * Removes all the webhooks of the given workflows */ async removeAll(workflows: Workflow[]): Promise { const removePromises = []; for (const workflow of workflows) { removePromises.push(this.removeWorkflow(workflow)); } await Promise.all(removePromises); return; } }