/* eslint-disable @typescript-eslint/prefer-optional-chain */ /* eslint-disable @typescript-eslint/no-unsafe-member-access */ /* eslint-disable @typescript-eslint/no-unsafe-assignment */ /* eslint-disable @typescript-eslint/prefer-nullish-coalescing */ import { isAxiosError } from '@n8n/backend-network'; import { TOOL_EXECUTOR_NODE_NAME } from '@n8n/constants'; import { Container } from '@n8n/di'; import { sleep } from '@n8n/utils/sleep'; import * as assert from 'assert/strict'; import { setMaxListeners } from 'events'; import get from 'lodash/get'; import type { ExecutionBaseError, ExecutionStatus, ExecutionStorageLocation, ExecutionError, GenericValue, IConnection, IDataObject, IExecuteData, INode, INodeExecutionData, IPairedItemData, IPinData, IRun, IRunData, ITaskData, ITaskDataConnections, ITaskDataConnectionsSource, ITaskMetadata, NodeOperationError, Workflow, IRunExecutionData, IWorkflowExecuteAdditionalData, WorkflowExecuteMode, CloseFunction, IRunNodeResponse, IWorkflowIssues, INodeIssues, INodeType, ITaskStartedData, JsonObject, AiAgentRequest, IWorkflowExecutionDataProcess, EngineRequest, EngineResponse, IDestinationNode, } from 'n8n-workflow'; import { LoggerProxy as Logger, NodeHelpers, NodeConnectionTypes, ApplicationError, BaseError, isNodeClassInstance, UnexpectedError, UserError, OperationalError, NodeApiError, TimeoutExecutionCancelledError, ManualExecutionCancelledError, createRunExecutionData, applyDynamicCredentialsUsage, } from 'n8n-workflow'; import PCancelable, { type OnCancelFunction } from 'p-cancelable'; import { ErrorReporter } from '@/errors/error-reporter'; import { WorkflowHasIssuesError } from '@/errors/workflow-has-issues.error'; import * as NodeExecuteFunctions from '@/node-execute-functions'; import { assertExecutionDataExists } from '@/utils/assertions'; import { establishExecutionContext } from './execution-context'; import type { ExecutionLifecycleHooks } from './execution-lifecycle-hooks'; import { ExecuteContext, getAdditionalKeys, PollContext, resolveSourceOverwrite, } from './node-execution-context'; import { DirectedGraph, findStartNodes, findSubgraph, findTriggerForPartialExecution, cleanRunData, recreateNodeExecutionStack, handleCycles, filterDisabledNodes, rewireGraph, getNextExecutionIndex, } from './partial-execution-utils'; import { handleRequest, isEngineRequest, makeEngineResponse } from './requests-response'; import { RoutingNode } from './routing-node'; import { TriggersAndPollers } from './triggers-and-pollers'; import { convertBinaryData } from '../utils/convert-binary-data'; interface RunWorkflowOptions { workflow: Workflow; startNode?: INode; destinationNode?: IDestinationNode; pinData?: IPinData; triggerToStartFrom?: IWorkflowExecutionDataProcess['triggerToStartFrom']; /** * Nodes to include in the run filter, so that the workflow can execute them * By default run() executes only destinationNode and its parents, others are not allowed to run */ additionalRunFilterNodes?: string[]; } function normalizeUnhandledAxiosError(error: unknown, node: INode): ExecutionBaseError { // oxlint-disable-next-line typescript/no-deprecated if (isAxiosError(error)) { return new NodeApiError(node, error as JsonObject); } return error as ExecutionBaseError; } export class WorkflowExecute { private status: ExecutionStatus = 'new'; private readonly abortController = new AbortController(); timedOut: boolean = false; private suspensionRequested = false; /** * Ask the engine to stop at the next node boundary and park the execution as * 'waiting', so another process can resume it from the persisted state. The * node currently executing runs to completion. Safe to call at any time; * no-ops if the run finishes, waits, or is canceled first. */ suspend(): void { if (this.status !== 'running') return; this.suspensionRequested = true; } /** * A cancel or error can land after a suspension already stamped the run * data; clear the markers so the persisted state is not treated as * resumable. A genuine Wait-node waitTill is never cleared here. */ private clearSuspensionMarkers(): void { if (!this.suspensionRequested) return; this.runExecutionData.waitTill = undefined; this.runExecutionData.waitReason = undefined; } constructor( private readonly additionalData: IWorkflowExecuteAdditionalData, private readonly mode: WorkflowExecuteMode, private runExecutionData: IRunExecutionData = createRunExecutionData(), private readonly storedAt: ExecutionStorageLocation = 'db', ) {} /** * Executes the given workflow. * * @param {Workflow} workflow The workflow to execute * @param {INode[]} [startNode] Node to start execution from * @param {string} [destinationNode] Node to stop execution at */ // IMPORTANT: Do not add "async" to this function, it will then convert the // PCancelable to a regular Promise and does so not allow canceling // active executions anymore // eslint-disable-next-line @typescript-eslint/promise-function-async run({ workflow, startNode, destinationNode, pinData, triggerToStartFrom, additionalRunFilterNodes, }: RunWorkflowOptions): PCancelable { this.status = 'running'; // Get the nodes to start workflow execution from startNode = startNode || workflow.getStartNode(destinationNode?.nodeName); if (startNode === undefined) { throw new UserError('No node to start the workflow from could be found'); } // Include non-main parents for the destination and each main ancestor. // Agents use the engine to run tools through non-main connections. let runNodeFilter: string[] | undefined; if (destinationNode) { const parentNodes = workflow.getParentNodes(destinationNode.nodeName); runNodeFilter = [ ...parentNodes, ...[destinationNode.nodeName, ...parentNodes].flatMap((nodeName) => workflow.getParentNodes(nodeName, 'ALL_NON_MAIN'), ), ]; if (destinationNode.mode === 'inclusive') { runNodeFilter.push(destinationNode.nodeName); } if (additionalRunFilterNodes) { runNodeFilter.push.apply(runNodeFilter, additionalRunFilterNodes); } runNodeFilter = Array.from(new Set(runNodeFilter)); } // Initialize the data of the start nodes const nodeExecutionStack: IExecuteData[] = [ { node: startNode, data: triggerToStartFrom?.data?.data ?? { main: [ [ { json: {}, }, ], ], }, source: null, }, ]; this.runExecutionData = createRunExecutionData({ startData: { destinationNode, runNodeFilter, }, executionData: { nodeExecutionStack, }, resultData: { pinData, }, resumeToken: this.runExecutionData.resumeToken, }); return this.processRunExecutionData(workflow); } isLegacyExecutionOrder(workflow: Workflow): boolean { return workflow.settings.executionOrder !== 'v1'; } // IMPORTANT: Do not add "async" to this function, it will then convert the // PCancelable to a regular Promise and does so not allow canceling // active executions anymore // eslint-disable-next-line @typescript-eslint/promise-function-async runPartialWorkflow2( workflow: Workflow, runData: IRunData, pinData: IPinData = {}, dirtyNodeNames: string[] = [], destinationNode: IDestinationNode, agentRequest?: AiAgentRequest, ): PCancelable { const originalDestination = { ...destinationNode }; let destination = workflow.getNode(destinationNode.nodeName); assert.ok( destination, `Could not find a node with the name ${destinationNode.nodeName} in the workflow.`, ); let graph = DirectedGraph.fromWorkflow(workflow); const destinationNodeType = workflow.nodeTypes.getByNameAndVersion( destination.type, destination.typeVersion, ); // Partial execution of nodes as tools if (NodeHelpers.isTool(destinationNodeType.description, destination.parameters)) { graph = rewireGraph(destination, graph, agentRequest); workflow = graph.toWorkflow({ ...workflow }); // Rewire destination node to the virtual agent const toolExecutorNode = workflow.getNode(TOOL_EXECUTOR_NODE_NAME); if (!toolExecutorNode) { throw new OperationalError('ToolExecutor can not be found'); } destination = toolExecutorNode; // TODO(CAT-1265): Verify that this functionality works as expected. destinationNode = { nodeName: toolExecutorNode.name, mode: 'inclusive' }; } // 1. Find the Trigger let trigger = findTriggerForPartialExecution(workflow, destinationNode.nodeName, runData); if (trigger === undefined) { // destination has parents but none of them are triggers, so find the closest // parent node that has run data, and treat that parent as starting point let startNode; const parentNodes = workflow.getParentNodes(destinationNode.nodeName); for (const nodeName of parentNodes) { const parentNode = workflow.getNode(nodeName); // Skip disabled nodes: they are removed from the execution subgraph, so a // disabled node can never serve as a start node. if (parentNode && !parentNode.disabled && runData[nodeName]) { startNode = parentNode; break; } } if (!startNode) { throw new UserError("Connect a trigger and make sure it's enabled to run this node"); } trigger = startNode; } // 2. Find the Subgraph const filteredGraph = filterDisabledNodes(graph); // A disabled destination is removed by filterDisabledNodes, which would make the // subgraph search below fail an internal membership assertion. Raise a clear user // error instead. The trigger is always enabled here (both findTriggerForPartialExecution // and the fallback above skip disabled nodes), so only the destination needs checking. if (destination.disabled) { throw new UserError('Cannot execute a disabled node'); } graph = findSubgraph({ graph: filteredGraph, destination, trigger }); const filteredNodes = graph.getNodes(); // 3. Find the Start Nodes const dirtyNodes = graph.getNodesByNames(dirtyNodeNames); runData = cleanRunData(runData, graph, dirtyNodes); let startNodes = findStartNodes({ graph, trigger, destination, runData, pinData }); // 4. Detect Cycles // 5. Handle Cycles startNodes = handleCycles(graph, startNodes, trigger); // 6. Clean Run Data runData = cleanRunData(runData, graph, startNodes); // 7. Recreate Execution Stack const { nodeExecutionStack, waitingExecution, waitingExecutionSource } = recreateNodeExecutionStack(graph, startNodes, runData, pinData ?? {}); // 8. Execute // Increment currentExecutionIndex based on previous run this.additionalData.currentNodeExecutionIndex = getNextExecutionIndex(runData); this.status = 'running'; this.runExecutionData = createRunExecutionData({ startData: { destinationNode, originalDestinationNode: originalDestination, runNodeFilter: Array.from(filteredNodes.values()).map((node) => node.name), }, resultData: { runData, pinData, }, executionData: { nodeExecutionStack, waitingExecution, waitingExecutionSource, }, resumeToken: this.runExecutionData.resumeToken, }); // Still passing the original workflow here, because the WorkflowDataProxy // needs it to create more useful error messages, e.g. differentiate // between a node not being connected to the node referencing it or a node // not existing in the workflow. return this.processRunExecutionData(workflow); } /** * Merges temporary execution metadata into the final runData structure. * During workflow execution, metadata is collected in a temporary location * (executionData.metadata). This method moves that metadata to its final * location in the resultData.runData for each node. * * @remarks * - Metadata from multiple runs is preserved using run indices * - Existing metadata in runData is preserved and merged with new metadata * - If no metadata exists, the operation is a no-op */ moveNodeMetadata(): void { const metadata = get(this.runExecutionData, 'executionData.metadata'); if (metadata) { const runData = get(this.runExecutionData, 'resultData.runData'); let index: number; let metaRunData: ITaskMetadata; for (const nodeName of Object.keys(metadata)) { for ([index, metaRunData] of metadata[nodeName].entries()) { const taskData = runData[nodeName]?.[index]; if (taskData) { taskData.metadata = { ...taskData.metadata, ...metaRunData }; } else { Container.get(ErrorReporter).error( new UnexpectedError('Task data missing at the end of an execution'), { extra: { nodeName, index } }, ); } } } } } /** * Checks if all incoming connections to a node are empty (have no data). * This is used to determine if a node should be executed or skipped. * * @param runData - The execution data from all nodes in the workflow * @param inputConnections - Array of connections to check * @param runIndex - Index of the current execution run (nodes can execute multiple times) * * @returns `true` if all connections are empty (no data), `false` if any connection has data * * @remarks * A connection is considered empty when: * - The source node doesn't exist in runData * - The source node's data is undefined * - The source node's output array is empty * - The specified output index contains no items */ incomingConnectionIsEmpty( runData: IRunData, inputConnections: IConnection[], runIndex: number, ): boolean { for (const inputConnection of inputConnections) { const nodeIncomingData = get(runData, [ inputConnection.node, runIndex, 'data', 'main', inputConnection.index, ]); if (nodeIncomingData !== undefined && (nodeIncomingData as object[]).length !== 0) { return false; } } return true; } /** * Prepares the waiting execution data structure for a node that needs to wait for data before it can execute. * This function initializes arrays to store data and metadata for each connection of the node. * * @param nodeName - The name of the node to prepare waiting execution for * @param numberOfConnections - Number of input connections the node has * @param runIndex - The index of the current run (for nodes that may run multiple times) */ prepareWaitingToExecution(nodeName: string, numberOfConnections: number, runIndex: number) { const executionData = this.runExecutionData.executionData!; executionData.waitingExecution ??= {}; executionData.waitingExecutionSource ??= {}; const nodeWaiting = (executionData.waitingExecution[nodeName] ??= []); const nodeWaitingSource = (executionData.waitingExecutionSource[nodeName] ??= []); nodeWaiting[runIndex] = { main: [] }; nodeWaitingSource[runIndex] = { main: [] }; for (let i = 0; i < numberOfConnections; i++) { nodeWaiting[runIndex].main.push(null); nodeWaitingSource[runIndex].main.push(null); } } // eslint-disable-next-line complexity addNodeToBeExecuted( workflow: Workflow, connectionData: IConnection, outputIndex: number, parentNodeName: string, nodeSuccessData: INodeExecutionData[][], runIndex: number, newRunIndex?: number, metadata?: ITaskMetadata, ): void { let stillDataMissing = false; const enqueueFn = workflow.settings.executionOrder === 'v1' ? 'unshift' : 'push'; let waitingNodeIndex: number | undefined; // Check if node has multiple inputs as then we have to wait for all input data // to be present before we can add it to the node-execution-stack const numberOfInputs = workflow.connectionsByDestinationNode[connectionData.node]?.main?.length ?? 0; if (numberOfInputs > 1) { // Node has multiple inputs let nodeWasWaiting = true; if (!this.runExecutionData.executionData!.waitingExecutionSource) { this.runExecutionData.executionData!.waitingExecutionSource = {}; } // Check if there is already data for the node if ( this.runExecutionData.executionData!.waitingExecution[connectionData.node] === undefined ) { // Node does not have data yet so create a new empty one this.runExecutionData.executionData!.waitingExecution[connectionData.node] = {}; this.runExecutionData.executionData!.waitingExecutionSource[connectionData.node] = {}; nodeWasWaiting = false; } // Figure out if the node is already waiting with partial data to which to add the // data to or if a new entry has to get created let createNewWaitingEntry = true; if ( Object.keys(this.runExecutionData.executionData!.waitingExecution[connectionData.node]) .length > 0 ) { // Check if there is already data for the input on all of the waiting nodes for (const index of Object.keys( this.runExecutionData.executionData!.waitingExecution[connectionData.node], )) { if ( !this.runExecutionData.executionData!.waitingExecution[connectionData.node][ parseInt(index) ].main[connectionData.index] ) { // Data for the input is missing so we can add it to the existing entry createNewWaitingEntry = false; waitingNodeIndex = parseInt(index); break; } } } if (waitingNodeIndex === undefined) { waitingNodeIndex = Object.values( this.runExecutionData.executionData!.waitingExecution[connectionData.node], ).length; } if (createNewWaitingEntry) { // There is currently no node waiting that does not already have data for // the given input, so create a new entry this.prepareWaitingToExecution( connectionData.node, workflow.connectionsByDestinationNode[connectionData.node].main.length, waitingNodeIndex, ); } // Add the new data if (nodeSuccessData === null) { this.runExecutionData.executionData!.waitingExecution[connectionData.node][ waitingNodeIndex ].main[connectionData.index] = null; this.runExecutionData.executionData!.waitingExecutionSource[connectionData.node][ waitingNodeIndex ].main[connectionData.index] = null; } else { this.runExecutionData.executionData!.waitingExecution[connectionData.node][ waitingNodeIndex ].main[connectionData.index] = nodeSuccessData[outputIndex]; this.runExecutionData.executionData!.waitingExecutionSource[connectionData.node][ waitingNodeIndex ].main[connectionData.index] = { previousNode: parentNodeName, previousNodeOutput: outputIndex ?? undefined, previousNodeRun: runIndex ?? undefined, }; } // Check if all data exists now let thisExecutionData: INodeExecutionData[] | null; let allDataFound = true; for ( let i = 0; i < this.runExecutionData.executionData!.waitingExecution[connectionData.node][waitingNodeIndex] .main.length; i++ ) { thisExecutionData = this.runExecutionData.executionData!.waitingExecution[connectionData.node][ waitingNodeIndex ].main[i]; if (thisExecutionData === null) { allDataFound = false; break; } } if (allDataFound) { // All data exists for node to be executed // So add it to the execution stack const executionStackItem = { node: workflow.nodes[connectionData.node], data: this.runExecutionData.executionData!.waitingExecution[connectionData.node][ waitingNodeIndex ], source: this.runExecutionData.executionData!.waitingExecutionSource[connectionData.node][ waitingNodeIndex ], } as IExecuteData; if ( this.runExecutionData.executionData!.waitingExecutionSource !== null && this.runExecutionData.executionData!.waitingExecutionSource !== undefined ) { executionStackItem.source = this.runExecutionData.executionData!.waitingExecutionSource[connectionData.node][ waitingNodeIndex ]; } this.runExecutionData.executionData!.nodeExecutionStack[enqueueFn](executionStackItem); // Remove the data from waiting delete this.runExecutionData.executionData!.waitingExecution[connectionData.node][ waitingNodeIndex ]; delete this.runExecutionData.executionData!.waitingExecutionSource[connectionData.node][ waitingNodeIndex ]; if ( Object.keys(this.runExecutionData.executionData!.waitingExecution[connectionData.node]) .length === 0 ) { // No more data left for the node so also delete that one delete this.runExecutionData.executionData!.waitingExecution[connectionData.node]; delete this.runExecutionData.executionData!.waitingExecutionSource[connectionData.node]; } return; } stillDataMissing = true; if (!nodeWasWaiting) { // Get a list of all the output nodes that we can check for siblings easier const checkOutputNodes = []; // eslint-disable-next-line @typescript-eslint/no-for-in-array for (const outputIndexParent in workflow.connectionsBySourceNode[parentNodeName].main) { if ( !Object.hasOwn(workflow.connectionsBySourceNode[parentNodeName].main, outputIndexParent) ) { continue; } for (const connectionDataCheck of workflow.connectionsBySourceNode[parentNodeName].main[ outputIndexParent ] ?? []) { checkOutputNodes.push(connectionDataCheck.node); } } // Node was not on "waitingExecution" so it is the first time it gets // checked. So we have to go through all the inputs and check if they // are already on the list to be processed. // If that is not the case add it. for ( let inputIndex = 0; inputIndex < workflow.connectionsByDestinationNode[connectionData.node].main.length; inputIndex++ ) { for (const inputData of workflow.connectionsByDestinationNode[connectionData.node].main[ inputIndex ] ?? []) { if (inputData.node === parentNodeName) { // Is the node we come from so its data will be available for sure continue; } const executionStackNodes = this.runExecutionData.executionData!.nodeExecutionStack.map( (stackData) => stackData.node.name, ); // Check if that node is also an output connection of the // previously processed one if (inputData.node !== parentNodeName && checkOutputNodes.includes(inputData.node)) { // So the parent node will be added anyway which // will then process this node next. So nothing to do // unless the incoming data of the node is empty // because then it would not be executed if ( !this.incomingConnectionIsEmpty( this.runExecutionData.resultData.runData, workflow.connectionsByDestinationNode[inputData.node].main[0] ?? [], runIndex, ) ) { continue; } } // Check if it is already in the execution stack if (executionStackNodes.includes(inputData.node)) { // Node is already on the list to be executed // so there is nothing to do continue; } // Check if node got processed already if (this.runExecutionData.resultData.runData[inputData.node] !== undefined) { // Node got processed already so no need to add it continue; } if (!this.isLegacyExecutionOrder(workflow)) { // Do not automatically follow all incoming nodes and force them // to execute continue; } // Check if any of the parent nodes does not have any inputs. That // would mean that it has to get added to the list of nodes to process. const parentNodes = workflow.getParentNodes( inputData.node, NodeConnectionTypes.Main, -1, ); let nodeToAdd: string | undefined = inputData.node; parentNodes.push(inputData.node); parentNodes.reverse(); for (const parentNode of parentNodes) { // Check if that node is also an output connection of the // previously processed one if (inputData.node !== parentNode && checkOutputNodes.includes(parentNode)) { // So the parent node will be added anyway which // will then process this node next. So nothing to do. nodeToAdd = undefined; break; } // Check if it is already in the execution stack if (executionStackNodes.includes(parentNode)) { // Node is already on the list to be executed // so there is nothing to do nodeToAdd = undefined; break; } // Check if node got processed already if (this.runExecutionData.resultData.runData[parentNode] !== undefined) { // Node got processed already so we can use the // output data as input of this node break; } nodeToAdd = parentNode; } const parentNodesNodeToAdd = workflow.getParentNodes(nodeToAdd as string); if ( parentNodesNodeToAdd.includes(parentNodeName) && nodeSuccessData[outputIndex].length === 0 ) { // We do not add the node if there is no input data and the node that should be connected // is a child of the parent node. Because else it would run a node even though it should be // specifically not run, as it did not receive any data. nodeToAdd = undefined; } if (nodeToAdd === undefined) { // No node has to get added so process continue; } let addEmptyItem = false; if (workflow.connectionsByDestinationNode[nodeToAdd] === undefined) { // Add empty item if the node does not have any input connections addEmptyItem = true; } else if ( this.incomingConnectionIsEmpty( this.runExecutionData.resultData.runData, workflow.connectionsByDestinationNode[nodeToAdd].main[0] ?? [], runIndex, ) ) { // Add empty item also if the input data is empty addEmptyItem = true; } if (addEmptyItem) { // Add only node if it does not have any inputs because else it will // be added by its input node later anyway. this.runExecutionData.executionData!.nodeExecutionStack[enqueueFn]({ node: workflow.getNode(nodeToAdd) as INode, data: { main: [ [ { json: {}, }, ], ], }, source: { main: [ { previousNode: parentNodeName, previousNodeOutput: outputIndex ?? undefined, previousNodeRun: runIndex ?? undefined, }, ], }, }); } } } } } let connectionDataArray: Array = get( this.runExecutionData, [ 'executionData', 'waitingExecution', connectionData.node, waitingNodeIndex!, NodeConnectionTypes.Main, ], null, ); if (connectionDataArray === null) { connectionDataArray = []; for (let i: number = connectionData.index; i >= 0; i--) { connectionDataArray[i] = null; } } // Add the data of the current execution if (nodeSuccessData === null) { connectionDataArray[connectionData.index] = null; } else { connectionDataArray[connectionData.index] = nodeSuccessData[outputIndex]; } if (stillDataMissing) { waitingNodeIndex = waitingNodeIndex!; const waitingExecutionSource = this.runExecutionData.executionData!.waitingExecutionSource![connectionData.node][ waitingNodeIndex ].main; // Additional data is needed to run node so add it to waiting this.prepareWaitingToExecution( connectionData.node, workflow.connectionsByDestinationNode[connectionData.node].main.length, waitingNodeIndex, ); this.runExecutionData.executionData!.waitingExecution[connectionData.node][waitingNodeIndex] = { main: connectionDataArray, }; this.runExecutionData.executionData!.waitingExecutionSource![connectionData.node][ waitingNodeIndex ].main = waitingExecutionSource; } else if (workflow.nodes[connectionData.node]) { // All data is there so add it directly to stack this.runExecutionData.executionData!.nodeExecutionStack[enqueueFn]({ node: workflow.nodes[connectionData.node], data: { main: connectionDataArray, }, source: { main: [ { previousNode: parentNodeName, previousNodeOutput: outputIndex ?? undefined, previousNodeRun: runIndex ?? undefined, }, ], }, runIndex: newRunIndex, metadata, }); } } /** * Checks if everything in the workflow is complete * and ready to be executed. If it returns null everything * is fine. If there are issues it returns the issues * which have been found for the different nodes. * TODO: Does currently not check for credential issues! */ checkReadyForExecution( workflow: Workflow, inputData: { startNode?: string; destinationNode?: IDestinationNode; pinDataNodeNames?: string[]; } = {}, ): IWorkflowIssues | null { const workflowIssues: IWorkflowIssues = {}; let checkNodes: string[] = []; if (inputData.destinationNode) { // If a destination node is given we have to check all the nodes // leading up to it checkNodes = workflow.getParentNodes(inputData.destinationNode.nodeName); if (inputData.destinationNode.mode === 'inclusive') { checkNodes.push(inputData.destinationNode.nodeName); } } else if (inputData.startNode) { // If a start node is given we have to check all nodes which // come after it checkNodes = workflow.getChildNodes(inputData.startNode); checkNodes.push(inputData.startNode); } for (const nodeName of checkNodes) { let nodeIssues: INodeIssues | null = null; const node = workflow.nodes[nodeName]; if (!node && nodeName === TOOL_EXECUTOR_NODE_NAME) { // ToolExecutor is added dynamically during test executions and isn't saved in the workflow // Skip checks for it because the node can't be accessed continue; } if (!node || node.disabled === true) { continue; } const nodeType = workflow.nodeTypes.getByNameAndVersion(node.type, node.typeVersion); if (nodeType === undefined) { // Node type is not known nodeIssues = { typeUnknown: true, }; } else { nodeIssues = NodeHelpers.getNodeParametersIssues( nodeType.description.properties, node, nodeType.description, inputData.pinDataNodeNames, ); } if (nodeIssues !== null) { workflowIssues[node.name] = nodeIssues; } } if (Object.keys(workflowIssues).length === 0) { return null; } return workflowIssues; } private getCustomOperation(node: INode, type: INodeType) { if (!type.customOperations) return undefined; if (!node.parameters && !node.forceCustomOperation) return undefined; const { customOperations } = type; const { resource, operation } = node.forceCustomOperation ?? node.parameters; if (typeof resource !== 'string' || typeof operation !== 'string') return undefined; if (!customOperations[resource] || !customOperations[resource][operation]) return undefined; const customOperation = customOperations[resource][operation]; return customOperation; } /** * Handles execution of disabled nodes by passing through input data */ private handleDisabledNode( inputData: ITaskDataConnections, forwardAllOutputs = false, ): IRunNodeResponse { if (Object.hasOwn(inputData, 'main') && inputData.main.length > 0) { // Resumed waiting webhook nodes are flagged as disabled so the wait does not // start over, but their `main` already holds the full set of output branches // returned by `webhook()`. Forward all of them so items routed to outputs // other than the first are not silently dropped. // See https://github.com/n8n-io/n8n/issues/12823 if (forwardAllOutputs) { return { data: inputData.main as INodeExecutionData[][] }; } // If the node is disabled simply return the data from the first main input if (inputData.main[0] === null) { return { data: undefined }; } return { data: [inputData.main[0]] }; } return { data: undefined }; } private prepareConnectionInputData( workflow: Workflow, nodeType: INodeType, customOperation: ReturnType, node: INode, inputData: ITaskDataConnections, source: ITaskDataConnectionsSource | null, ): INodeExecutionData[] | null { if ( nodeType.execute || customOperation || (!nodeType.poll && !nodeType.trigger && !nodeType.webhook) ) { if (!inputData.main?.length) { return null; } // We always use the data of main input and the first input for execute let connectionInputData = inputData.main[0]; const forceInputNodeExecution = workflow.settings.executionOrder !== 'v1'; if (!forceInputNodeExecution) { // If the nodes do not get force executed data of some inputs may be missing // for that reason do we use the data of the first one that contains any for (const mainData of inputData.main) { if (mainData?.length) { connectionInputData = mainData; break; } } } else if (!connectionInputData?.length && source?.main?.[0] === null) { // The first input is empty and can no longer receive data. If another // input got its data from a node further down the workflow (a loop // back to this node), use that data so the loop keeps running. Data // from anywhere else keeps the old behavior: skip this node run. const descendants = workflow.getChildNodes(node.name); for (let inputIndex = 0; inputIndex < inputData.main.length; inputIndex++) { const mainData = inputData.main[inputIndex]; const previousNode = source.main[inputIndex]?.previousNode; if ( mainData?.length && previousNode !== undefined && // getChildNodes never lists the node itself, so a direct // self-edge counts as a loop back too (previousNode === node.name || descendants.includes(previousNode)) ) { connectionInputData = mainData; break; } } } if (!connectionInputData || connectionInputData.length === 0) { return null; } return connectionInputData; } // For poll, trigger, and webhook nodes, we don't need to process input data return []; } /** Whether the node is configured to continue when it errors. */ private continuesOnError(node: INode): boolean { return ( node.continueOnFail === true || ['continueRegularOutput', 'continueErrorOutput'].includes(node.onError ?? '') ); } /** * Rethrows an already-failed node's error so it logs and displays correctly. * Structured node errors are thrown as-is; anything else (e.g. a DB-deserialized * error that is no longer a real `Error`) is wrapped so its stack and * `instanceof Error` behave like a normally-thrown node failure. */ private rethrowNodeError(error: ExecutionError): never { if (error.name === 'NodeOperationError' || error.name === 'NodeApiError') { throw error; } const wrapped = new Error(error.message); wrapped.stack = error.stack; throw wrapped; } /** Handles re-throwing errors from previous node execution attempts */ private rethrowLastNodeError(runExecutionData: IRunExecutionData, node: INode): void { if ( runExecutionData.resultData.lastNodeExecuted === node.name && runExecutionData.resultData.error !== undefined ) { // The node did already fail. So throw an error here that it displays and logs it correctly. // Does get used by webhook and trigger nodes in case they throw an error that it is possible // to log the error and display in Editor-UI. this.rethrowNodeError(runExecutionData.resultData.error); } } /** * Handles executeOnce logic by limiting input data to first item only */ private handleExecuteOnce(node: INode, inputData: ITaskDataConnections): ITaskDataConnections { if (node.executeOnce === true) { // If node should be executed only once so use only the first input item const newInputData: ITaskDataConnections = {}; for (const connectionType of Object.keys(inputData)) { newInputData[connectionType] = inputData[connectionType].map((input) => { return input && input.slice(0, 1); }); } return newInputData; } return inputData; } private async executeNode( workflow: Workflow, node: INode, nodeType: INodeType, customOperation: ReturnType, additionalData: IWorkflowExecuteAdditionalData, mode: WorkflowExecuteMode, runExecutionData: IRunExecutionData, runIndex: number, connectionInputData: INodeExecutionData[], inputData: ITaskDataConnections, executionData: IExecuteData, abortSignal?: AbortSignal, subNodeExecutionResults?: EngineResponse, ): Promise { const closeFunctions: CloseFunction[] = []; const context = new ExecuteContext( workflow, node, additionalData, mode, runExecutionData, runIndex, connectionInputData, inputData, executionData, closeFunctions, abortSignal, subNodeExecutionResults, ); let data: INodeExecutionData[][] | EngineRequest | null; let executionSucceeded = false; let closingError: Error | undefined; try { if (customOperation) { data = await customOperation.call(context); } else if (nodeType.execute) { data = isNodeClassInstance(nodeType) ? await nodeType.execute(context, subNodeExecutionResults) : await nodeType.execute.call(context, subNodeExecutionResults); } else { throw new UnexpectedError( "Can't execute node. There is no custom operation and the node has not execute function.", ); } executionSucceeded = true; } finally { if (closeFunctions.length > 0) { const closeFunctionsResults = await Promise.allSettled( closeFunctions.map(async (fn) => await fn()), ); // Only throw close function errors if the execution itself succeeded, // to avoid masking the original execution error. if (executionSucceeded) { const closingErrors = closeFunctionsResults .filter((result): result is PromiseRejectedResult => result.status === 'rejected') // eslint-disable-next-line @typescript-eslint/no-unsafe-return .map((result) => result.reason); if (closingErrors.length > 0) { closingError = closingErrors[0] instanceof Error ? closingErrors[0] : new UnexpectedError("Error on execution node's close function(s)", { extra: { nodeName: node.name }, tags: { nodeType: node.type }, cause: closingErrors, }); } } } } if (closingError) throw closingError; if (isEngineRequest(data)) { return data; } return { data, hints: context.hints }; } private buildCustomTelemetryTracing( workflow: Workflow, node: INode, additionalData: IWorkflowExecuteAdditionalData, mode: WorkflowExecuteMode, runExecutionData: IRunExecutionData, runIndex: number, connectionInputData: INodeExecutionData[], executionData: IExecuteData, ): NonNullable | undefined { const tags = node.customTelemetryTags?.tag; if (!tags?.length) return; const additionalKeys = getAdditionalKeys(additionalData, mode, runExecutionData); const tracing: NonNullable = {}; for (const { key, value } of tags) { const trimmedKey = key?.trim(); if (!trimmedKey) continue; try { const evaluated = workflow.expression.getParameterValue( value, runExecutionData, runIndex, 0, node.name, connectionInputData, mode, additionalKeys, executionData, false, {}, ); if (evaluated === undefined || evaluated === null) continue; if ( typeof evaluated !== 'string' && typeof evaluated !== 'number' && typeof evaluated !== 'boolean' ) { Logger.warn( 'customTelemetryTags expression resolved to a non-primitive value; skipping', { nodeName: node.name, tagKey: trimmedKey, }, ); continue; } tracing[trimmedKey] = evaluated; } catch (error) { // failing to evaluate a tag expression is not a critical error and should not block the execution Logger.warn('Failed to evaluate customTelemetryTags expression', { nodeName: node.name, tagKey: trimmedKey, error: error instanceof Error ? error.message : String(error), }); } } if (Object.keys(tracing).length === 0) return; return tracing; } /** * Executes a poll node */ private async executePollNode( workflow: Workflow, node: INode, nodeType: INodeType, additionalData: IWorkflowExecuteAdditionalData, mode: WorkflowExecuteMode, inputData: ITaskDataConnections, ): Promise { if (mode === 'manual') { // In manual mode run the poll function const context = new PollContext(workflow, node, additionalData, mode, 'manual'); return { data: await nodeType.poll!.call(context) }; } // In any other mode pass data through as it already contains the result of the poll return { data: inputData.main as INodeExecutionData[][] }; } /** * Executes a trigger node */ private async executeTriggerNode( workflow: Workflow, node: INode, additionalData: IWorkflowExecuteAdditionalData, mode: WorkflowExecuteMode, inputData: ITaskDataConnections, abortSignal?: AbortSignal, ): Promise { if (mode === 'manual') { // In manual mode start the trigger const triggerResponse = await Container.get(TriggersAndPollers).runTriggerFunction( workflow, node, NodeExecuteFunctions.getExecuteTriggerFunctions, additionalData, mode, 'manual', ); if (triggerResponse === undefined) { return { data: null }; } let closeFunction; if (triggerResponse.closeFunction) { // In manual mode we return the trigger closeFunction. That allows it to be called directly // but we do not have to wait for it to finish. That is important for things like queue-nodes. // There the full close will may be delayed till a message gets acknowledged after the execution. // If we would not be able to wait for it to close would it cause problems with "own" mode as the // process would be killed directly after it and so the acknowledge would not have been finished yet. closeFunction = triggerResponse.closeFunction; // Manual testing of Trigger nodes creates an execution. If the execution is cancelled, `closeFunction` should be called to cleanup any open connections/consumers abortSignal?.addEventListener('abort', closeFunction); } if (triggerResponse.manualTriggerFunction !== undefined) { // If a manual trigger function is defined call it and wait till it did run await triggerResponse.manualTriggerFunction(); } const response = await triggerResponse.manualTriggerResponse!; if (response.length === 0) { return { data: null, closeFunction }; } return { data: response, closeFunction }; } // For trigger nodes in any mode except "manual" do we simply pass the data through return { data: inputData.main as INodeExecutionData[][] }; } private async executeDeclarativeNodeInTest( workflow: Workflow, node: INode, nodeType: INodeType, additionalData: IWorkflowExecuteAdditionalData, mode: WorkflowExecuteMode, runExecutionData: IRunExecutionData, runIndex: number, connectionInputData: INodeExecutionData[], inputData: ITaskDataConnections, executionData: IExecuteData, ): Promise { // NOTE: This block is only called by nodes tests. // In the application, declarative nodes get assigned a `.execute` method in NodeTypes. const context = new ExecuteContext( workflow, node, additionalData, mode, runExecutionData, runIndex, connectionInputData, inputData, executionData, [], ); const routingNode = new RoutingNode(context, nodeType); const data = await routingNode.runNode(); return { data }; } /** * Figures out the node type and state and calls the right execution * implementation. */ async runNode( workflow: Workflow, executionData: IExecuteData, runExecutionData: IRunExecutionData, runIndex: number, additionalData: IWorkflowExecuteAdditionalData, mode: WorkflowExecuteMode, abortSignal?: AbortSignal, subNodeExecutionResults?: EngineResponse, ): Promise { const { node } = executionData; let inputData = executionData.data; if (executionData.metadata?.resumeError) { const { resumeError, subExecution } = executionData.metadata; if (this.continuesOnError(node)) { // Mirror the node's own live whole-node-failure item shape: pair the error // item with every input item (the sub-workflow ran for all of them), and // link the failed child execution so the UI can navigate to it. const pairedItem = (inputData.main?.[0] ?? []).map((_, item) => ({ item })); return { data: [ [ { json: { error: resumeError.message }, pairedItem, ...(subExecution && { metadata: { subExecution } }), }, ], ], }; } // Route the resumed sub-workflow error like a live node failure would be // (see the onError handling in `processRunExecutionData`). this.rethrowNodeError(resumeError); } if (node.disabled === true) { return this.handleDisabledNode(inputData, executionData.metadata?.forwardAllOutputs); } const nodeType = workflow.nodeTypes.getByNameAndVersion(node.type, node.typeVersion); const customOperation = this.getCustomOperation(node, nodeType); const connectionInputData = this.prepareConnectionInputData( workflow, nodeType, customOperation, node, inputData, executionData.source, ); if (connectionInputData === null) { return { data: undefined }; } this.rethrowLastNodeError(runExecutionData, node); inputData = this.handleExecuteOnce(node, inputData); const tracingFromTags = this.buildCustomTelemetryTracing( workflow, node, additionalData, mode, runExecutionData, runIndex, connectionInputData, executionData, ); if (tracingFromTags !== undefined) { executionData.metadata = { ...(executionData.metadata ?? {}), tracing: { ...tracingFromTags, ...(executionData.metadata?.tracing ?? {}) }, }; } if (nodeType.execute || customOperation) { return await this.executeNode( workflow, node, nodeType, customOperation, additionalData, mode, runExecutionData, runIndex, connectionInputData, inputData, executionData, abortSignal, subNodeExecutionResults, ); } if (nodeType.poll) { return await this.executePollNode(workflow, node, nodeType, additionalData, mode, inputData); } if (nodeType.trigger) { return await this.executeTriggerNode( workflow, node, additionalData, mode, inputData, abortSignal, ); } if (nodeType.supplyData) { throw new UnexpectedError( `The node "${node.type}" has a "supplyData" method but no "execute" method.`, ); } const isDeclarativeNode = nodeType.description.requestDefaults !== undefined; if (nodeType.webhook && !isDeclarativeNode) { // Check if the node have requestDefaults(Declarative Node), // else for webhook nodes always simply pass the data through // as webhook method would be called by WebhookService return { data: inputData.main as INodeExecutionData[][] }; } return await this.executeDeclarativeNodeInTest( workflow, node, nodeType, additionalData, mode, runExecutionData, runIndex, connectionInputData, inputData, executionData, ); } /** * Handles executions that have been waiting by * 1. unsetting the `waitTill` * 2. disabling the currently executing node (which should be the node that * put the execution into waiting) making sure it won't be executed again * 3. Removing the last run for the last executed node (which also should be * the node that put the execution into waiting) to make sure the node * does not show up as having run twice */ private handleWaitingState(workflow: Workflow) { if (this.runExecutionData.waitTill) { this.runExecutionData.waitTill = undefined; assertExecutionDataExists( this.runExecutionData.executionData, workflow, this.additionalData, this.mode, ); if (this.runExecutionData.waitReason === 'suspended') { // The engine was suspended at a node boundary, so the stack head has // not executed yet: run it normally instead of passing it through. this.runExecutionData.waitReason = undefined; return; } const executionStackEntry = this.runExecutionData.executionData.nodeExecutionStack[0]; // Error reporting itself does not depend on this: `runNode` checks // `metadata.resumeError` before `node.disabled`, so the entry carrying the // error fails either way. This guard only matters when ANOTHER stack entry // shares this node object (legacy `executionOrder: 'v0'` with multiple wires // into the node): keeping the node enabled lets those later entries execute // normally instead of passing their input through in disabled mode. if (!executionStackEntry.metadata?.resumeError) { executionStackEntry.node.disabled = true; } const lastNodeExecuted = this.runExecutionData.resultData.lastNodeExecuted as string; this.runExecutionData.resultData.runData[lastNodeExecuted].pop(); } } private checkForWorkflowIssues(workflow: Workflow): void { assertExecutionDataExists( this.runExecutionData.executionData, workflow, this.additionalData, this.mode, ); // Node execution stack will be empty for an execution containing only Chat // Trigger. const startNode = this.runExecutionData.executionData.nodeExecutionStack.at(0)?.node.name; let destinationNode: IDestinationNode | undefined; if (this.runExecutionData.startData?.destinationNode) { destinationNode = this.runExecutionData.startData.destinationNode; } const pinDataNodeNames = Object.keys(this.runExecutionData.resultData.pinData ?? {}); const workflowIssues = this.checkReadyForExecution(workflow, { startNode, destinationNode, pinDataNodeNames, }); if (workflowIssues !== null) { throw new WorkflowHasIssuesError(workflowIssues, workflow.nodes); } } private setupExecution(): { startedAt: Date; hooks: ExecutionLifecycleHooks; } { this.status = 'running'; const { hooks } = this.additionalData; assert.ok(hooks, 'Failed to run workflow due to missing execution lifecycle hooks'); // NOTE: As far as I can tell this code is dead. // FIXME: Fix the types to make sure startData is always set and remove the // code. if (this.runExecutionData.startData === undefined) { this.runExecutionData.startData = {}; } return { startedAt: new Date(), hooks }; } /** * Prepares all data necessary to handle `ExecuteNodeAction`s and schedules * the node executions on the stack, including re-executing the node that * made the request. * * Make sure to continue the execution loop after calling this function. */ private handleEngineRequest({ workflow, currentNode, request, runIndex, executionData, runData, }: { workflow: Workflow; currentNode: INode; request: EngineRequest; runIndex: number; executionData: IExecuteData; runData: IRunData; }) { const { nodesToBeExecuted } = handleRequest({ workflow, currentNode, request, runIndex, executionData, runData, }); for (const nodeData of nodesToBeExecuted) { this.addNodeToBeExecuted( workflow, nodeData.inputConnectionData, nodeData.parentOutputIndex, nodeData.parentNode, nodeData.parentOutputData, nodeData.runIndex, nodeData.nodeRunIndex, nodeData.metadata, ); } } /** * Connect the PCancelable cancellation callback. On cancellation it aborts the * running nodes and reports the run so far through the lifecycle hooks. */ private setupCancellation( onCancel: OnCancelFunction, hooks: ExecutionLifecycleHooks, startedAt: Date, ): void { // Let as many nodes listen to the abort signal, without getting the MaxListenersExceededWarning setMaxListeners(Infinity, this.abortController.signal); onCancel.shouldReject = false; onCancel(() => { this.status = 'canceled'; this.clearSuspensionMarkers(); this.updateTaskStatusesToCancelled(); this.abortController.abort(); const fullRunData = this.getFullRunData(startedAt); void hooks.runHook('workflowExecuteAfter', [fullRunData]); }); } /** * Acquire the expression isolate, establish the execution context and run the first * lifecycle hook. If any of that fails, record the error on the first node of the * stack so it is saved correctly, then rethrow. */ private async initializeExecution( workflow: Workflow, hooks: ExecutionLifecycleHooks, ): Promise { try { await workflow.expression.acquireIsolate(); // Establish the execution context await establishExecutionContext( workflow, this.runExecutionData, this.additionalData, this.mode, ); if (!this.additionalData.restartExecutionId) { await hooks.runHook('workflowExecuteBefore', [workflow, this.runExecutionData]); } else { await hooks.runHook('workflowExecuteResume', [workflow, this.runExecutionData]); } } catch (error) { const e = error as unknown as ExecutionBaseError; // Set the error that it can be saved correctly const executionError: ExecutionBaseError = { ...e, message: e.message, stack: e.stack, }; // Set the incoming data of the node that it can be saved correctly. // A Chat Trigger-only workflow has an empty stack, so there may be no node to // blame — recording the error alone beats throwing over the top of it. const startItem = this.runExecutionData.executionData!.nodeExecutionStack.at(0); if (startItem) { const taskData: ITaskData = { startTime: Date.now(), executionIndex: 0, executionTime: 0, data: { main: startItem.data.main, }, source: [], executionStatus: 'error', hints: [], }; this.runExecutionData.resultData = { runData: { [startItem.node.name]: [taskData], }, lastNodeExecuted: startItem.node.name, error: executionError, }; } else { this.runExecutionData.resultData.error = executionError; } throw error; } } /** * Prepare the dynamic-credential bookkeeping for the node that is about to run. * * A sub-execution that finished while this execution was waiting reported its * private-credential usage on the resumed stack entry (the node re-runs disabled, * so `executeWorkflow` never reports again). Restore it so the new task and * `runtimeData.executedByUserId` still inherit the flags. The stash is * transport-only, so consume it to keep it out of the persisted task metadata. */ private resetDynamicCredentialsUsage(executionData: IExecuteData): void { this.additionalData.currentNodeUsedDynamicCredentials = false; this.additionalData.currentNodeAttemptedDynamicCredentials = false; const reportedUsage = executionData.metadata?.dynamicCredentialsUsage; if (reportedUsage) { applyDynamicCredentialsUsage(this.additionalData, reportedUsage); delete executionData.metadata?.dynamicCredentialsUsage; } } /** Create the task metadata that is known before the node runs. */ private createTaskStartedData(executionData: IExecuteData): ITaskStartedData { return { startTime: Date.now(), executionIndex: this.additionalData.currentNodeExecutionIndex++, source: !executionData.source ? [] : executionData.source.main, hints: [], }; } /** * Stamp every input item with its `pairedItem` lineage, so an item can be traced back * to the item it came from. */ private addPairedItemLineage(executionData: IExecuteData): ITaskDataConnections { const newTaskDataConnections: ITaskDataConnections = {}; for (const connectionType of Object.keys(executionData.data)) { newTaskDataConnections[connectionType] = executionData.data[connectionType].map( (input, inputIndex) => { if (input === null) { return input; } return input.map((item, itemIndex) => { // Preserve any existing sourceOverwrite from the pairedItem // for tool executions. Tool calls don't have a main // connection to the agent's input, so the data proxy needs // the sourceOverwrite information to know where to look up // paired items. This is necessary because the workflow data // proxy works on input data which normally scrubs paired // item information before executing the node. const sourceOverwrite = resolveSourceOverwrite(item, executionData); if (sourceOverwrite) { return { ...item, pairedItem: { item: itemIndex, input: inputIndex || undefined, sourceOverwrite, }, }; } return { ...item, pairedItem: { item: itemIndex, input: inputIndex || undefined, }, }; }); }, ); } return newTaskDataConnections; } /** * The run index of this node execution. Engine requests set it explicitly. Otherwise * it is the number of times the node already ran. */ private computeRunIndex(executionData: IExecuteData): number { if (executionData.runIndex !== undefined) { return executionData.runIndex; } const { runData } = this.runExecutionData.resultData; const nodeName = executionData.node.name; return Object.hasOwn(runData, nodeName) ? runData[nodeName].length : 0; } /** * The retry budget for a node, as `[maxTries, waitBetweenTries]`. * * A node resuming with a sub-workflow error has already failed in the sub-workflow; * there is nothing to re-run, so don't apply retryOnFail (it would just re-throw the * same error after pointless waits without re-executing anything). */ private getRetryParams(executionData: IExecuteData): [number, number] { const isResumedError = executionData.metadata?.resumeError !== undefined; if (executionData.node.retryOnFail !== true || isResumedError) { return [1, 0]; } // TODO: Remove the hardcoded default-values here and also in NodeSettings.vue return [ Math.min(5, Math.max(2, executionData.node.maxTries || 3)), Math.min(5000, Math.max(0, executionData.node.waitBetweenTries || 1000)), ]; } /** The pinned output of a node, or undefined if the node has none. */ private getPinnedOutput(node: INode): INodeExecutionData[][] | undefined { const { pinData } = this.runExecutionData.resultData; if (!pinData || node.disabled || pinData[node.name] === undefined) { return undefined; } return [pinData[node.name]]; // always zeroth runIndex } /** * Collect the results of the sub-nodes an AI agent asked for, so the agent can * resume with them. Does nothing if the node is not resuming from a tool call. */ private collectSubNodeResults( executionData: IExecuteData, subNodeExecutionResults: EngineResponse, ): void { const { subNodeExecutionData } = executionData.metadata ?? {}; if (!subNodeExecutionData) return; subNodeExecutionResults.metadata = subNodeExecutionData.metadata; for (const subNode of subNodeExecutionData.actions) { const nodeRunData = this.runExecutionData.resultData.runData[subNode.nodeName]; if (nodeRunData?.[subNode.runIndex]) { subNodeExecutionResults.actionResponses.push({ data: nodeRunData[subNode.runIndex], action: subNode.action, }); } } } /** * Post-process the raw output of a node: move binary data to the configured storage, * collect the hints it reported and route items to the error output if it is enabled. * Returns the output data and the close function the node asked to run at the end. */ private async processNodeOutput( runNodeData: IRunNodeResponse, workflow: Workflow, executionData: IExecuteData, taskStartedData: ITaskStartedData, runIndex: number, ): Promise<{ nodeSuccessData: INodeExecutionData[][] | null | undefined; closeFunction: Promise | undefined; }> { const converted = await convertBinaryData( workflow.id, this.additionalData.executionId, runNodeData, workflow.settings.binaryMode, ); const nodeSuccessData = converted.data; if (converted.hints?.length) { taskStartedData.hints!.push(...converted.hints); } if (nodeSuccessData && executionData.node.onError === 'continueErrorOutput') { this.handleNodeErrorOutput(workflow, executionData, nodeSuccessData, runIndex); } // Explanation why we do this can be found in n8n-workflow/Workflow.ts -> runNode const closeFunction = converted.closeFunction?.(); return { nodeSuccessData, closeFunction }; } /** * The error to send to the error reporter, or undefined if this error must not be * reported. Errors of our own classes report their cause. Other errors report only * their class and call frames, because their message can hold user data. */ private buildErrorReport(error: unknown): Error | undefined { if (error instanceof ApplicationError) { // Report any unhandled errors that were wrapped in by one of our error classes return error.cause instanceof Error ? error.cause : undefined; } if (error instanceof BaseError) { // BaseError subclasses specify shouldReport and level // so always report and let beforeSend decide return error; } // oxlint-disable-next-line typescript/no-deprecated if (!(error instanceof Error) || isAxiosError(error)) { // Axios errors are suppressed in ErrorReporter's beforeSend via the // `isAxiosError` brand, which sanitizing below would strip - so skip them here return undefined; } // Non-BaseError errors only report their class and call frames // The full error is still stored in the execution resultData // Stack frames are in the format `: \n` // they can span multiple lines, so we drop everything except call frame lines const errorClass = error.name || 'Error'; const sanitized = new Error(errorClass); sanitized.name = errorClass; const frames = (error.stack ?? '').split('\n').filter((line) => /^\s+at\s/.test(line)); sanitized.stack = [errorClass, ...frames].join('\n'); return sanitized; } /** * Handle an error a node threw: mark the node as the last one executed, report the * error and return it in the serializable shape the run data stores. */ private reportNodeExecutionError( error: unknown, executionNode: INode, workflow: Workflow, ): ExecutionBaseError { this.runExecutionData.resultData.lastNodeExecuted = executionNode.name; const toReport = this.buildErrorReport(error); if (toReport) { const { executionId, instanceBaseUrl } = this.additionalData; Container.get(ErrorReporter).error(toReport, { extra: { nodeName: executionNode.name, nodeType: executionNode.type, nodeVersion: executionNode.typeVersion, workflowId: workflow.id, executionId, executionUrl: instanceBaseUrl && executionId ? `${instanceBaseUrl}workflow/${workflow.id}/executions/${executionId}` : undefined, }, }); } Logger.debug(`Running node "${executionNode.name}" finished with error`, { node: executionNode.name, workflowId: workflow.id, }); const e = normalizeUnhandledAxiosError(error, executionNode); return { ...e, message: e.message, stack: e.stack }; } /** * A node with `alwaysOutputData` that returned nothing gets one empty item, so the * nodes after it still run. The item keeps the lineage of all input items. */ private ensureAlwaysOutputData( nodeSuccessData: INodeExecutionData[][] | null | undefined, executionData: IExecuteData, ): INodeExecutionData[][] | null | undefined { if (nodeSuccessData?.[0]?.[0]) return nodeSuccessData; if (executionData.node.alwaysOutputData !== true) return nodeSuccessData; // Get pairedItem from all input items const pairedItem: IPairedItemData[] = []; executionData.data.main.forEach((inputData, inputIndex) => { if (!inputData) { return; } inputData.forEach((_item, itemIndex) => { pairedItem.push({ item: itemIndex, input: inputIndex }); }); }); nodeSuccessData ??= []; nodeSuccessData[0] = [{ json: {}, pairedItem }]; return nodeSuccessData; } /** Build the task record for a finished node run. */ private createTaskData( taskStartedData: ITaskStartedData, executionData: IExecuteData, ): ITaskData { return { ...taskStartedData, executionTime: Date.now() - taskStartedData.startTime, metadata: executionData.metadata, executionStatus: this.runExecutionData.waitTill ? 'waiting' : 'success', usedDynamicCredentials: this.additionalData.currentNodeUsedDynamicCredentials || undefined, attemptedDynamicCredentials: this.additionalData.currentNodeAttemptedDynamicCredentials || undefined, }; } /** * Record the n8n user a dynamically-resolved private credential belongs to onto the * execution context, so the redaction layer can grant that user access to their own * data. The identity is execution-scoped, so this is the same value across nodes. */ private recordDynamicCredentialsUser(): void { if ( this.additionalData.currentNodeUsedDynamicCredentials && this.additionalData.dynamicCredentialsResolvedUserId && this.runExecutionData.executionData?.runtimeData ) { this.runExecutionData.executionData.runtimeData.executedByUserId = this.additionalData.dynamicCredentialsResolvedUserId; } } /** * Record a node error on the task data and decide how the execution goes on. * * If the node continues on error, its input data passes through to the next node and * the loop continues. Otherwise the task data is stored, the node is pushed back onto * the stack so it can be restarted, and the loop must stop. */ private async handleNodeExecutionError({ executionNode, executionData, taskData, executionError, nodeSuccessData, runIndex, hooks, }: { executionNode: INode; executionData: IExecuteData; taskData: ITaskData; executionError: ExecutionBaseError; nodeSuccessData: INodeExecutionData[][] | null | undefined; runIndex: number; hooks: ExecutionLifecycleHooks; }): Promise<{ continueExecution: boolean; nodeSuccessData: INodeExecutionData[][] | null | undefined; }> { taskData.error = executionError; taskData.executionStatus = 'error'; // Send error to the response if necessary await hooks?.runHook('sendChunk', [ { type: 'error', content: executionError.description, metadata: { nodeId: executionNode.id, nodeName: executionNode.name, runIndex, itemIndex: 0, }, }, ]); // AI tools default to continue-on-fail so the agent receives the // error as a tool response. Explicit `onError: 'stopWorkflow'` // still wins. const isAiToolExecution = executionNode.rewireOutputLogTo === NodeConnectionTypes.AiTool; const aiToolDefaultsToContinue = isAiToolExecution && executionData.node.onError !== 'stopWorkflow'; if (this.continuesOnError(executionData.node) || aiToolDefaultsToContinue) { // Workflow should continue running even if node errors if (isAiToolExecution) { // Surface the error on the ai_tool channel so the agent receives it nodeSuccessData = [[{ json: { error: executionError.message } }]]; } else if (Object.hasOwn(executionData.data, 'main') && executionData.data.main.length > 0) { // Simply get the input data of the node if it has any and pass it through // to the next node if (executionData.data.main[0] !== null) { nodeSuccessData = [executionData.data.main[0]]; } } return { continueExecution: true, nodeSuccessData }; } // Node execution did fail so add error and stop execution // TODO: Remove when AI-723 lands. // For AI tool nodes with rewireOutputLogTo, preserve inputOverride and set correct output type if (executionNode.rewireOutputLogTo) { taskData.inputOverride = this.runExecutionData.resultData.runData[executionNode.name][runIndex]?.inputOverride || {}; taskData.data = { [executionNode.rewireOutputLogTo]: [[{ json: { error: executionError.message } }]], }; } this.upsertTaskData(executionNode.name, runIndex, taskData); // Add the execution data again so that it can get restarted this.pushExecutionStack(executionData); // Only execute the nodeExecuteAfter hook if the node did not get aborted if (!this.isCancelled) { await hooks.runHook('nodeExecuteAfter', [ executionNode.name, taskData, this.runExecutionData, ]); } return { continueExecution: false, nodeSuccessData }; } /** * Store the task data for a node run. * * TODO: Remove when AI-723 lands. There is no need to merge anymore, because the only * reason to have this entry already is because of `inputOverride`. */ private upsertTaskData(nodeName: string, runIndex: number, taskData: ITaskData): void { const nodeRunData = this.runExecutionData.resultData.runData[nodeName]; if (nodeRunData[runIndex]) { Object.assign(nodeRunData[runIndex], taskData); } else { nodeRunData.push(taskData); } } /** * Move the error a node reported in `$error` onto the standard `error` and `json` * fields of the item, so all nodes report errors the same way. */ private normalizeNodeErrors(nodeSuccessData: INodeExecutionData[][]): void { for (const execution of nodeSuccessData) { for (const lineResult of execution) { if ( lineResult.json !== undefined && lineResult.json.$error !== undefined && lineResult.json.$json !== undefined ) { lineResult.error = lineResult.json.$error as NodeApiError | NodeOperationError; lineResult.json = { error: lineResult.error.message }; } else if (lineResult.error !== undefined) { lineResult.json = { error: lineResult.error.message }; } } } } /** * Log the output of an AI tool node on its own connection type instead of `main`. * TODO: Remove when AI-723 lands. */ private rewireOutputLog( executionNode: INode, taskData: ITaskData, nodeSuccessData: INodeExecutionData[][], runIndex: number, ): void { if (!executionNode.rewireOutputLogTo) return; // Try to get inputOverride from existing run data taskData.inputOverride = this.runExecutionData.resultData.runData[executionNode.name]?.[runIndex]?.inputOverride || {}; taskData.data = { [executionNode.rewireOutputLogTo]: nodeSuccessData, }; } /** True while there are nodes queued for execution. */ private isExecutionStackNotEmpty(): boolean { return this.runExecutionData.executionData!.nodeExecutionStack.length !== 0; } /** Dequeue the next node to execute from the front of the execution stack. */ private popExecutionStack(): IExecuteData { return this.runExecutionData.executionData!.nodeExecutionStack.shift() as IExecuteData; } /** Push a node back to the front of the execution stack, so it runs again next. */ private pushExecutionStack(executionData: IExecuteData): void { this.runExecutionData.executionData!.nodeExecutionStack.unshift(executionData); } /** True if the execution has passed its configured timeout. */ private hasExecutionTimedOut(): boolean { return ( this.additionalData.executionTimeoutTimestamp !== undefined && Date.now() >= this.additionalData.executionTimeoutTimestamp ); } /** * True if the loop must stop now. Marks the execution as timed-out first if its * timeout has passed, so a timeout is reported as a cancellation. */ private shouldStopExecuting(): boolean { if (this.hasExecutionTimedOut()) { this.status = 'canceled'; this.timedOut = true; } return this.status === 'canceled'; } /** * True if a node filter is set and this node is not in it. The filter holds only the * nodes on the path to the destination node. Skipping the others avoids execution of * leaves that are parallel to the destination node. Normally they would execute, * because they have the same parent and all child nodes of a parent execute. */ private isNodeFilteredOut(nodeName: string): boolean { const { runNodeFilter } = this.runExecutionData.startData!; return runNodeFilter !== undefined && !runNodeFilter.includes(nodeName); } /** * Runs the given execution data. * */ // IMPORTANT: Do not add "async" to this function, it will then convert the // PCancelable to a regular Promise and does so not allow canceling // active executions anymore // eslint-disable-next-line @typescript-eslint/promise-function-async processRunExecutionData(workflow: Workflow): PCancelable { Logger.debug('Workflow execution started', { workflowId: workflow.id }); const { startedAt, hooks } = this.setupExecution(); this.checkForWorkflowIssues(workflow); this.handleWaitingState(workflow); // Variables which hold temporary data for each node-execution let executionData: IExecuteData; let subNodeExecutionResults: EngineResponse = makeEngineResponse(); let executionError: ExecutionBaseError | undefined; let executionNode: INode; let runIndex: number; let currentExecutionTry = ''; let lastExecutionTry = ''; let closeFunction: Promise | undefined; return new PCancelable(async (resolve, _reject, onCancel) => { this.setupCancellation(onCancel, hooks, startedAt); // eslint-disable-next-line complexity const returnPromise = (async () => { await this.initializeExecution(workflow, hooks); executionLoop: while (this.isExecutionStackNotEmpty()) { if (this.shouldStopExecuting()) { return; } // Suspension exits before popping, so the stack head is the next // not-yet-executed node and the persisted state resumes by running it. // The cancel check above must win over suspension. if (this.suspensionRequested) { this.runExecutionData.waitTill = new Date(); this.runExecutionData.waitReason = 'suspended'; this.additionalData.setExecutionStatus?.('waiting'); return; } subNodeExecutionResults = makeEngineResponse(); let nodeSuccessData: INodeExecutionData[][] | null | undefined = null; executionError = undefined; executionData = this.popExecutionStack(); executionNode = executionData.node; this.resetDynamicCredentialsUsage(executionData); const taskStartedData = this.createTaskStartedData(executionData); // Update the pairedItem information on items executionData.data = this.addPairedItemLineage(executionData); runIndex = this.computeRunIndex(executionData); currentExecutionTry = `${executionNode.name}:${runIndex}`; if (currentExecutionTry === lastExecutionTry) { throw new UserError('Stopped execution because it seems to be in an endless loop'); } if (this.isNodeFilteredOut(executionNode.name)) { continue; } const hasInputData = this.ensureInputData(workflow, executionNode, executionData); if (!hasInputData) { lastExecutionTry = currentExecutionTry; continue executionLoop; } Logger.debug(`Start executing node "${executionNode.name}"`, { node: executionNode.name, workflowId: workflow.id, }); // Skip nodeExecuteBefore for resumed agent nodes to prevent duplicate event emission. // Context: AI agents pause execution to run tools, then resume with tool results. // Without this check, the agent would emit nodeExecuteBefore twice (initial + resume) // but only one nodeExecuteAfter, causing frontend spinner state to become stuck. // See: AI-1414 // Future: May introduce dedicated nodeExecutionPaused/nodeExecutionResumed events // if we need finer-grained visibility into the pause/resume cycle. if (!executionData.metadata?.nodeWasResumed) { await hooks.runHook('nodeExecuteBefore', [executionNode.name, taskStartedData]); } const isErrorValue = (v: unknown) => v !== undefined && v !== null && v !== false; const checkFailure = (data: IRunNodeResponse | EngineRequest) => !isEngineRequest(data) && isErrorValue(data.data?.[0]?.[0]?.json?.error); const [maxTries, waitBetweenTries] = this.getRetryParams(executionData); for (let tryIndex = 0; tryIndex < maxTries; tryIndex++) { try { if (tryIndex !== 0) { // Reset executionError from previous error try executionError = undefined; if (waitBetweenTries !== 0) { // TODO: Improve that in the future and check if other nodes can // be executed in the meantime await new Promise((resolve) => { setTimeout(() => { resolve(undefined); }, waitBetweenTries); }); } } const pinnedOutput = this.getPinnedOutput(executionNode); if (pinnedOutput) { nodeSuccessData = pinnedOutput; } else { this.collectSubNodeResults(executionData, subNodeExecutionResults); Logger.debug(`Running node "${executionNode.name}" started`, { node: executionNode.name, workflowId: workflow.id, }); let runNodeData = await this.runNode( workflow, executionData, this.runExecutionData, runIndex, this.additionalData, this.mode, this.abortController.signal, subNodeExecutionResults, ); let nodeFailed = checkFailure(runNodeData); while (nodeFailed && tryIndex !== maxTries - 1) { await sleep(waitBetweenTries); runNodeData = await this.runNode( workflow, executionData, this.runExecutionData, runIndex, this.additionalData, this.mode, this.abortController.signal, ); nodeFailed = checkFailure(runNodeData); tryIndex++; } // if runNodeData is Request if (isEngineRequest(runNodeData)) { this.handleEngineRequest({ workflow, currentNode: executionNode, request: runNodeData, runIndex, executionData, runData: this.runExecutionData.resultData.runData, }); continue executionLoop; } const nodeOutput = await this.processNodeOutput( runNodeData, workflow, executionData, taskStartedData, runIndex, ); nodeSuccessData = nodeOutput.nodeSuccessData; // Keep the close function of an earlier node if this one registered none closeFunction = nodeOutput.closeFunction ?? closeFunction; } Logger.debug(`Running node "${executionNode.name}" finished successfully`, { node: executionNode.name, workflowId: workflow.id, }); nodeSuccessData = this.assignPairedItems(nodeSuccessData, executionData); if (nodeSuccessData) { this.runExecutionData.resultData.lastNodeExecuted = executionData.node.name; } nodeSuccessData = this.ensureAlwaysOutputData(nodeSuccessData, executionData); if (nodeSuccessData === null && !this.runExecutionData.waitTill) { // If null gets returned it means that the node did succeed // but did not have any data. So the branch should end // (meaning the nodes afterwards should not be processed) continue executionLoop; } break; } catch (error) { executionError = this.reportNodeExecutionError(error, executionNode, workflow); } } // Add the data to return to the user // (currently does not get cloned as data does not get changed, maybe later we should do that?!?!) if (!Object.hasOwn(this.runExecutionData.resultData.runData, executionNode.name)) { this.runExecutionData.resultData.runData[executionNode.name] = []; } const taskData = this.createTaskData(taskStartedData, executionData); this.recordDynamicCredentialsUser(); if (executionError !== undefined) { const outcome = await this.handleNodeExecutionError({ executionNode, executionData, taskData, executionError, nodeSuccessData, runIndex, hooks, }); nodeSuccessData = outcome.nodeSuccessData; if (!outcome.continueExecution) { break; } } this.normalizeNodeErrors(nodeSuccessData!); // Node executed successfully. So add data and go on. taskData.data = { main: nodeSuccessData, } as ITaskDataConnections; // Rewire output data log to the given connectionType this.rewireOutputLog(executionNode, taskData, nodeSuccessData!, runIndex); this.upsertTaskData(executionNode.name, runIndex, taskData); if (this.runExecutionData.waitTill) { await hooks.runHook('nodeExecuteAfter', [ executionNode.name, taskData, this.runExecutionData, ]); // Add the node back to the stack that the workflow can start to execute again from that node this.pushExecutionStack(executionData); break; } if (this.runExecutionData?.startData?.destinationNode?.nodeName === executionNode.name) { // Before stopping, make sure we are executing hooks so // That frontend is notified for example for manual executions. await hooks.runHook('nodeExecuteAfter', [ executionNode.name, taskData, this.runExecutionData, ]); // If destination node is defined and got executed stop execution continue; } // Add the nodes to which the current node has an output connection to that they can // be executed next if (Object.hasOwn(workflow.connectionsBySourceNode, executionNode.name)) { if (Object.hasOwn(workflow.connectionsBySourceNode[executionNode.name], 'main')) { let outputIndex: string; let connectionData: IConnection; // Iterate over all the outputs const nodesToAdd: Array<{ position: [number, number]; connection: IConnection; outputIndex: number; }> = []; // Add the nodes to be executed // eslint-disable-next-line @typescript-eslint/no-for-in-array for (outputIndex in workflow.connectionsBySourceNode[executionNode.name].main) { if ( !Object.hasOwn( workflow.connectionsBySourceNode[executionNode.name].main, outputIndex, ) ) { continue; } // Iterate over all the different connections of this output for (connectionData of workflow.connectionsBySourceNode[executionNode.name].main[ outputIndex ] ?? []) { if (!Object.hasOwn(workflow.nodes, connectionData.node)) { throw new UnexpectedError('Destination node not found', { extra: { sourceNodeName: executionNode.name, destinationNodeName: connectionData.node, }, }); } if ( nodeSuccessData![outputIndex] && (nodeSuccessData![outputIndex].length !== 0 || (connectionData.index > 0 && this.isLegacyExecutionOrder(workflow))) ) { // Add the node only if it did execute or if connected to second "optional" input if (workflow.settings.executionOrder === 'v1') { const nodeToAdd = workflow.getNode(connectionData.node); nodesToAdd.push({ position: nodeToAdd?.position || [0, 0], connection: connectionData, outputIndex: parseInt(outputIndex, 10), }); } else { this.addNodeToBeExecuted( workflow, connectionData, parseInt(outputIndex, 10), executionNode.name, nodeSuccessData!, runIndex, ); } } } } if (workflow.settings.executionOrder === 'v1') { // Always execute the node that is more to the top-left first nodesToAdd.sort((a, b) => { if (a.position[1] < b.position[1]) { return 1; } if (a.position[1] > b.position[1]) { return -1; } if (a.position[0] > b.position[0]) { return -1; } return 0; }); for (const nodeData of nodesToAdd) { this.addNodeToBeExecuted( workflow, nodeData.connection, nodeData.outputIndex, executionNode.name, nodeSuccessData!, runIndex, ); } } } } // If we got here, it means that we did not stop executing from manual executions / destination. // Execute hooks now to make sure that all hooks are executed properly // Await is needed to make sure that we don't fall into concurrency problems // When saving node execution data await hooks.runHook('nodeExecuteAfter', [ executionNode.name, taskData, this.runExecutionData, ]); let waitingNodes: string[] = Object.keys( this.runExecutionData.executionData!.waitingExecution, ); if ( this.runExecutionData.executionData!.nodeExecutionStack.length === 0 && waitingNodes.length ) { // There are no more nodes in the execution stack. Check if there are // waiting nodes that do not require data on all inputs and execute them, // one by one. // TODO: Should this also care about workflow position (top-left first?) for (let i = 0; i < waitingNodes.length; i++) { const nodeName = waitingNodes[i]; const checkNode = workflow.getNode(nodeName); if (!checkNode) { continue; } const nodeType = workflow.nodeTypes.getByNameAndVersion( checkNode.type, checkNode.typeVersion, ); // Check if the node is only allowed execute if all inputs received data let requiredInputs = workflow.settings.executionOrder === 'v1' ? nodeType.description.requiredInputs : undefined; if (requiredInputs !== undefined) { if (typeof requiredInputs === 'string') { requiredInputs = workflow.expression.getSimpleParameterValue( checkNode, requiredInputs, this.mode, { $version: checkNode.typeVersion }, undefined, [], ) as number[]; } if ( (requiredInputs !== undefined && Array.isArray(requiredInputs) && requiredInputs.length === nodeType.description.inputs.length) || requiredInputs === nodeType.description.inputs.length ) { // All inputs are required, but not all have data so do not continue continue; } } const parentNodes = workflow.getParentNodes(nodeName); // Check if input nodes (of same run) got already executed const parentIsWaiting = parentNodes.some((value) => waitingNodes.includes(value)); if (parentIsWaiting) { // Execute node later as one of its dependencies is still outstanding continue; } const runIndexes = Object.keys( this.runExecutionData.executionData!.waitingExecution[nodeName], ).sort(); // The run-index of the earliest outstanding one const firstRunIndex = parseInt(runIndexes[0]); // Find all the inputs which received any kind of data, even if it was an empty // array as this shows that the parent nodes executed but they did not have any // data to pass on. const inputsWithData = this.runExecutionData .executionData!.waitingExecution[nodeName][firstRunIndex].main.map((data, index) => data === null ? null : index, ) .filter((data) => data !== null); if (requiredInputs !== undefined) { // Certain inputs are required that the node can execute if (Array.isArray(requiredInputs)) { // Specific inputs are required (array of input indexes) let inputDataMissing = false; for (const requiredInput of requiredInputs) { if (!inputsWithData.includes(requiredInput)) { inputDataMissing = true; break; } } if (inputDataMissing) { continue; } } else { // A certain amount of inputs are required (amount of inputs) if (inputsWithData.length < requiredInputs) { continue; } } } const taskDataMain = this.runExecutionData.executionData!.waitingExecution[nodeName][ firstRunIndex ].main.map((data) => { // For the inputs for which never any data got received set it to an empty array return data === null ? [] : data; }); if (taskDataMain.filter((data) => data.length).length !== 0) { // Add the node to be executed // Make sure that each input at least receives an empty array if (taskDataMain.length < nodeType.description.inputs.length) { for (; taskDataMain.length < nodeType.description.inputs.length; ) { taskDataMain.push([]); } } this.runExecutionData.executionData!.nodeExecutionStack.push({ node: workflow.nodes[nodeName], data: { main: taskDataMain, }, source: this.runExecutionData.executionData!.waitingExecutionSource![nodeName][ firstRunIndex ], }); } // Remove the node from waiting delete this.runExecutionData.executionData!.waitingExecution[nodeName][firstRunIndex]; delete this.runExecutionData.executionData!.waitingExecutionSource![nodeName][ firstRunIndex ]; if ( Object.keys(this.runExecutionData.executionData!.waitingExecution[nodeName]) .length === 0 ) { // No more data left for the node so also delete that one delete this.runExecutionData.executionData!.waitingExecution[nodeName]; delete this.runExecutionData.executionData!.waitingExecutionSource![nodeName]; } if (taskDataMain.filter((data) => data.length).length !== 0) { // Node to execute got found and added to stop break; } else { // Node to add did not get found, rather an empty one removed so continue with search waitingNodes = Object.keys(this.runExecutionData.executionData!.waitingExecution); // Set counter to start again from the beginning. Set it to -1 as it auto increments // after run. So only like that will we end up again at 0. i = -1; } } } } return; })() .then(async () => { if (this.status === 'canceled' && executionError === undefined) { return await this.processSuccessExecution( startedAt, workflow, this.timedOut ? new TimeoutExecutionCancelledError(this.additionalData.executionId ?? 'unknown') : new ManualExecutionCancelledError(this.additionalData.executionId ?? 'unknown'), closeFunction, ); } return await this.processSuccessExecution( startedAt, workflow, executionError, closeFunction, ); }) .catch(async (error) => { const fullRunData = this.getFullRunData(startedAt); fullRunData.data.resultData.error = { ...error, message: error.message, stack: error.stack, }; // Check if static data changed let newStaticData: IDataObject | undefined; if (workflow.staticData.__dataChanged === true) { // Static data of workflow changed newStaticData = workflow.staticData; } this.moveNodeMetadata(); await hooks .runHook('workflowExecuteAfter', [fullRunData, newStaticData]) .catch((error) => { console.error('There was a problem running hook "workflowExecuteAfter"', error); }); if (closeFunction) { try { await closeFunction; } catch (errorClose) { Logger.error( `There was a problem deactivating trigger of workflow "${workflow.id}": "${errorClose.message}"`, { workflowId: workflow.id, }, ); } } return fullRunData; }) .finally(async () => { try { await workflow.expression.releaseIsolate(); } catch (error) { Container.get(ErrorReporter).error(error); } }); return await returnPromise.then(resolve); }); } /** * This method determines if a specific node has incoming connections and verifies if execution data is available for all required inputs. * If any required input data is missing, the node execution is deferred by pushing it back onto the execution stack. * * @param workflow - The workflow containing the node and connections. * @param executionNode - The node being checked. * @param executionData - The data available for executing the node. * @returns `true` if the node has the required input data and can execute immediately, otherwise `false`. */ ensureInputData(workflow: Workflow, executionNode: INode, executionData: IExecuteData): boolean { const inputConnections = workflow.connectionsByDestinationNode[executionNode.name]?.main ?? []; for (let connectionIndex = 0; connectionIndex < inputConnections.length; connectionIndex++) { const highestNodes = workflow.getHighestNode(executionNode.name, connectionIndex); if (highestNodes.length === 0) { // If there is no valid incoming node (if all are disabled) // then ignore that it has inputs and simply execute it as it is without // any data return true; } if (!Object.hasOwn(executionData.data, 'main')) { // ExecutionData does not even have the connection set up so can // not have that data, so add it again to be executed later this.runExecutionData.executionData!.nodeExecutionStack.push(executionData); return false; } if (this.isLegacyExecutionOrder(workflow)) { // Check if it has the data for all the inputs // The most nodes just have one but merge node for example has two and data // of both inputs has to be available to be able to process the node. if ( executionData.data.main.length < connectionIndex || executionData.data.main[connectionIndex] === null ) { // Does not have the data of the connections so add back to stack this.runExecutionData.executionData!.nodeExecutionStack.push(executionData); return false; } } } return true; } /** * Processes the final state of a workflow execution and prepares the execution result. * This method handles different completion scenarios: success, waiting, error, and canceled states. * It also manages cleanup tasks like static data updates and trigger deactivation. * * @param startedAt - The timestamp when the workflow execution started * @param workflow - The workflow being executed * @param executionError - Optional error that occurred during execution * @param closeFunction - Optional promise that handles cleanup of triggers/webhooks * * @returns A promise that resolves to the complete workflow execution data (IRun) * * @remarks * The function performs these tasks in order: * 1. Generates full execution data * 2. Sets appropriate status based on execution outcome * 3. Handles any static data changes * 4. Moves node metadata to its final location * 5. Executes the 'workflowExecuteAfter' hook * 6. Performs cleanup via closeFunction if provided */ async processSuccessExecution( startedAt: Date, workflow: Workflow, executionError?: ExecutionBaseError, closeFunction?: Promise, ): Promise { // Set status before creating fullRunData if (executionError !== undefined) { this.clearSuspensionMarkers(); Logger.debug('Workflow execution finished with error', { error: executionError, workflowId: workflow.id, }); if ( executionError.message?.includes('canceled') || executionError.name?.includes('Cancelled') ) { this.status = 'canceled'; } else { this.status = 'error'; } } else if (this.runExecutionData.waitTill) { // eslint-disable-next-line @typescript-eslint/restrict-template-expressions Logger.debug(`Workflow execution will wait until ${this.runExecutionData.waitTill}`, { workflowId: workflow.id, }); this.status = 'waiting'; } else { Logger.debug('Workflow execution finished successfully', { workflowId: workflow.id }); this.status = 'success'; } // Check if static data changed let newStaticData: IDataObject | undefined; if (workflow.staticData.__dataChanged === true) { // Static data of workflow changed newStaticData = workflow.staticData; } this.moveNodeMetadata(); if (closeFunction) { try { await closeFunction; } catch (error) { Logger.error( `There was a problem deactivating trigger of workflow "${workflow.id}": "${error.message}"`, { workflowId: workflow.id, }, ); } } // Capture stoppedAt timestamp after all processing is complete const stoppedAt = new Date(); const fullRunData = this.getFullRunData(startedAt, stoppedAt); if (executionError !== undefined) { fullRunData.data.resultData.error = { ...executionError, message: executionError.message, stack: executionError.stack, } satisfies ExecutionBaseError; } else if (this.runExecutionData.waitTill) { fullRunData.waitTill = this.runExecutionData.waitTill; } else { // oxlint-disable-next-line typescript/no-deprecated fullRunData.finished = true; } // Prevent from running the hook if the error is an abort error as it was already handled if (!this.isCancelled) { await this.additionalData.hooks?.runHook('workflowExecuteAfter', [ fullRunData, newStaticData, ]); } return fullRunData; } getFullRunData(startedAt: Date, stoppedAt?: Date): IRun { return { data: this.runExecutionData, mode: this.mode, startedAt, stoppedAt: stoppedAt ?? new Date(), storedAt: this.storedAt, status: this.status, }; } handleNodeErrorOutput( workflow: Workflow, executionData: IExecuteData, nodeSuccessData: INodeExecutionData[][], runIndex: number, ): void { const nodeType = workflow.nodeTypes.getByNameAndVersion( executionData.node.type, executionData.node.typeVersion, ); const outputs = NodeHelpers.getNodeOutputs(workflow, executionData.node, nodeType.description); const outputTypes = NodeHelpers.getConnectionTypes(outputs); const mainOutputTypes = outputTypes.filter((output) => output === NodeConnectionTypes.Main); const errorItems: INodeExecutionData[] = []; const closeFunctions: CloseFunction[] = []; // Create a WorkflowDataProxy instance that we can get the data of the // item which did error const executeFunctions = new ExecuteContext( workflow, executionData.node, this.additionalData, this.mode, this.runExecutionData, runIndex, [], executionData.data, executionData, closeFunctions, this.abortController.signal, ); const dataProxy = executeFunctions.getWorkflowDataProxy(0); // Loop over all outputs except the error output as it would not contain data by default for (let outputIndex = 0; outputIndex < mainOutputTypes.length - 1; outputIndex++) { const successItems: INodeExecutionData[] = []; const items = nodeSuccessData[outputIndex]?.length ? nodeSuccessData[outputIndex] : []; while (items.length) { const item = items.shift(); if (item === undefined) { continue; } let errorData: GenericValue | undefined; if (item.error) { errorData = item.error; } else if ( item.json.error && Object.keys(item.json).every((key) => ['error', 'message', 'details'].includes(key)) ) { errorData = item.json.error; } if (errorData) { const pairedItemData = item.pairedItem && typeof item.pairedItem === 'object' ? Array.isArray(item.pairedItem) ? item.pairedItem[0] : item.pairedItem : undefined; if (executionData.source === null || pairedItemData === undefined) { // Source data is missing for some reason so we can not figure out the item errorItems.push(item); } else { const pairedItemInputIndex = pairedItemData.input || 0; const sourceData = executionData.source[NodeConnectionTypes.Main][pairedItemInputIndex]; const constPairedItem = dataProxy.$getPairedItem( sourceData!.previousNode, sourceData, pairedItemData, ); if (constPairedItem === null) { errorItems.push(item); } else { errorItems.push({ ...item, json: { ...constPairedItem.json, ...item.json, }, }); } } } else { successItems.push(item); } } nodeSuccessData[outputIndex] = successItems; } nodeSuccessData[mainOutputTypes.length - 1] = errorItems; } /** * Assigns pairedItem information to node output items by matching them with input items. * PairedItem data is used to track which output items were derived from which input items. * * @param nodeSuccessData - The output data from a node execution * @param executionData - The execution data containing input information * * @returns The node output data with pairedItem information assigned where possible * * @remarks * Auto-assignment of pairedItem happens in two scenarios: * 1. Single input/output: When node has exactly one input item and produces output(s), * all outputs are marked as derived from that single input (item: 0) * 2. Matching items count: When number of input and output items match exactly, * each output item is paired with the input item at the same index * * In all other cases, if pairedItem is missing, it remains undefined as automatic * assignment cannot be done reliably. */ assignPairedItems( nodeSuccessData: INodeExecutionData[][] | null | undefined, executionData: IExecuteData, ) { if (nodeSuccessData?.length) { // Check if the output data contains pairedItem data and if not try // to automatically fix it const isSingleInputAndOutput = executionData.data.main.length === 1 && executionData.data.main[0]?.length === 1; const isSameNumberOfItems = nodeSuccessData.length === 1 && executionData.data.main.length === 1 && executionData.data.main[0]?.length === nodeSuccessData[0].length; // Multiple inputs → single output (e.g., aggregating items into one) const isSingleOutput = nodeSuccessData.length === 1 && nodeSuccessData[0]?.length === 1 && executionData.data.main.length === 1 && (executionData.data.main[0]?.length ?? 0) > 1; checkOutputData: for (const outputData of nodeSuccessData) { if (outputData === null) { continue; } for (const [index, item] of outputData.entries()) { if (item.pairedItem === undefined) { // The pairedItem data is missing, so check if it can get automatically fixed if (isSingleInputAndOutput) { // The node has one input and one incoming item, so we know // that all items must originate from that single item.pairedItem = { item: 0, }; } else if (isSameNumberOfItems) { // The number of incoming and outgoing items is identical so we can // make the reasonable assumption that each of the input items // is the origin of the corresponding output items item.pairedItem = { item: index, }; } else if (isSingleOutput) { // Multiple inputs were aggregated into a single output, pair to first input item.pairedItem = { item: 0, }; } else { // In all other cases autofixing is not possible break checkOutputData; } } } } } return nodeSuccessData ?? null; } private updateTaskStatusesToCancelled(): void { Object.keys(this.runExecutionData.resultData.runData).forEach((nodeName) => { const taskDataArray = this.runExecutionData.resultData.runData[nodeName]; taskDataArray.forEach((taskData) => { if (taskData.executionStatus === 'running') { taskData.executionStatus = 'canceled'; } }); }); } private get isCancelled() { return this.abortController.signal.aborted; } }