mirror of
https://github.com/n8n-io/n8n.git
synced 2025-03-05 20:50:17 -08:00
feat(core): Fix partial workflow execution with specific trigger data (#13505)
Co-authored-by: Danny Martini <danny@n8n.io>
This commit is contained in:
parent
ac3b388d18
commit
9029dace5c
|
@ -1,8 +1,24 @@
|
|||
import { mock } from 'jest-mock-extended';
|
||||
import type { Workflow, IWorkflowExecutionDataProcess } from 'n8n-workflow';
|
||||
import * as core from 'n8n-core';
|
||||
import { DirectedGraph, recreateNodeExecutionStack, WorkflowExecute } from 'n8n-core';
|
||||
import type {
|
||||
Workflow,
|
||||
IWorkflowExecutionDataProcess,
|
||||
IWorkflowExecuteAdditionalData,
|
||||
IPinData,
|
||||
ITaskData,
|
||||
INode,
|
||||
IRun,
|
||||
IExecuteData,
|
||||
IWaitingForExecution,
|
||||
IWaitingForExecutionSource,
|
||||
} from 'n8n-workflow';
|
||||
import type PCancelable from 'p-cancelable';
|
||||
|
||||
import { ManualExecutionService } from '@/manual-execution.service';
|
||||
|
||||
jest.mock('n8n-core');
|
||||
|
||||
describe('ManualExecutionService', () => {
|
||||
const manualExecutionService = new ManualExecutionService(mock());
|
||||
|
||||
|
@ -68,4 +84,365 @@ describe('ManualExecutionService', () => {
|
|||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('runManually', () => {
|
||||
const nodeExecutionStack = mock<IExecuteData[]>();
|
||||
const waitingExecution = mock<IWaitingForExecution>();
|
||||
const waitingExecutionSource = mock<IWaitingForExecutionSource>();
|
||||
const mockFilteredGraph = mock<DirectedGraph>();
|
||||
|
||||
beforeEach(() => {
|
||||
jest.spyOn(DirectedGraph, 'fromWorkflow').mockReturnValue(mock<DirectedGraph>());
|
||||
jest.spyOn(core, 'WorkflowExecute').mockReturnValue(
|
||||
mock<WorkflowExecute>({
|
||||
processRunExecutionData: jest.fn().mockReturnValue(mock<PCancelable<IRun>>()),
|
||||
}),
|
||||
);
|
||||
jest.spyOn(core, 'recreateNodeExecutionStack').mockReturnValue({
|
||||
nodeExecutionStack,
|
||||
waitingExecution,
|
||||
waitingExecutionSource,
|
||||
});
|
||||
jest.spyOn(core, 'filterDisabledNodes').mockReturnValue(mockFilteredGraph);
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
jest.resetAllMocks();
|
||||
});
|
||||
|
||||
it('should correctly process triggerToStartFrom data when data.triggerToStartFrom.data is present', async () => {
|
||||
const mockTriggerData = mock<ITaskData>();
|
||||
const startNodeName = 'startNode';
|
||||
const triggerNodeName = 'triggerNode';
|
||||
const data = mock<IWorkflowExecutionDataProcess>({
|
||||
triggerToStartFrom: {
|
||||
name: triggerNodeName,
|
||||
data: mockTriggerData,
|
||||
},
|
||||
startNodes: [{ name: startNodeName }],
|
||||
executionMode: 'manual',
|
||||
pinData: undefined,
|
||||
});
|
||||
|
||||
const startNode = mock<INode>({ name: startNodeName });
|
||||
const workflow = mock<Workflow>({
|
||||
getNode: jest.fn((name) => {
|
||||
if (name === startNodeName) return startNode;
|
||||
return null;
|
||||
}),
|
||||
});
|
||||
|
||||
const additionalData = mock<IWorkflowExecuteAdditionalData>();
|
||||
const executionId = 'test-execution-id';
|
||||
const pinData: IPinData = {};
|
||||
|
||||
await manualExecutionService.runManually(
|
||||
data,
|
||||
workflow,
|
||||
additionalData,
|
||||
executionId,
|
||||
pinData,
|
||||
);
|
||||
|
||||
expect(DirectedGraph.fromWorkflow).toHaveBeenCalledWith(workflow);
|
||||
|
||||
expect(recreateNodeExecutionStack).toHaveBeenCalledWith(
|
||||
mockFilteredGraph,
|
||||
new Set([startNode]),
|
||||
{ [triggerNodeName]: [mockTriggerData] },
|
||||
{},
|
||||
);
|
||||
|
||||
expect(WorkflowExecute).toHaveBeenCalledWith(
|
||||
additionalData,
|
||||
data.executionMode,
|
||||
expect.objectContaining({
|
||||
resultData: {
|
||||
runData: { [triggerNodeName]: [mockTriggerData] },
|
||||
pinData,
|
||||
},
|
||||
executionData: {
|
||||
contextData: {},
|
||||
metadata: {},
|
||||
nodeExecutionStack,
|
||||
waitingExecution,
|
||||
waitingExecutionSource,
|
||||
},
|
||||
}),
|
||||
);
|
||||
});
|
||||
|
||||
it('should correctly include destinationNode in executionData when provided', async () => {
|
||||
const mockTriggerData = mock<ITaskData>();
|
||||
const startNodeName = 'startNode';
|
||||
const triggerNodeName = 'triggerNode';
|
||||
const destinationNodeName = 'destinationNode';
|
||||
|
||||
const data = mock<IWorkflowExecutionDataProcess>({
|
||||
triggerToStartFrom: {
|
||||
name: triggerNodeName,
|
||||
data: mockTriggerData,
|
||||
},
|
||||
startNodes: [{ name: startNodeName }],
|
||||
executionMode: 'manual',
|
||||
destinationNode: destinationNodeName,
|
||||
});
|
||||
|
||||
const startNode = mock<INode>({ name: startNodeName });
|
||||
const workflow = mock<Workflow>({
|
||||
getNode: jest.fn((name) => {
|
||||
if (name === startNodeName) return startNode;
|
||||
return null;
|
||||
}),
|
||||
});
|
||||
|
||||
const additionalData = mock<IWorkflowExecuteAdditionalData>();
|
||||
const executionId = 'test-execution-id';
|
||||
const pinData: IPinData = {};
|
||||
|
||||
await manualExecutionService.runManually(
|
||||
data,
|
||||
workflow,
|
||||
additionalData,
|
||||
executionId,
|
||||
pinData,
|
||||
);
|
||||
|
||||
expect(WorkflowExecute).toHaveBeenCalledWith(
|
||||
additionalData,
|
||||
data.executionMode,
|
||||
expect.objectContaining({
|
||||
startData: {
|
||||
destinationNode: destinationNodeName,
|
||||
},
|
||||
resultData: expect.any(Object),
|
||||
executionData: expect.any(Object),
|
||||
}),
|
||||
);
|
||||
});
|
||||
|
||||
it('should call workflowExecute.run for full execution when no runData or startNodes', async () => {
|
||||
const data = mock<IWorkflowExecutionDataProcess>({
|
||||
executionMode: 'manual',
|
||||
destinationNode: undefined,
|
||||
pinData: undefined,
|
||||
});
|
||||
|
||||
const workflow = mock<Workflow>({
|
||||
getNode: jest.fn().mockReturnValue(null),
|
||||
});
|
||||
|
||||
const additionalData = mock<IWorkflowExecuteAdditionalData>();
|
||||
const executionId = 'test-execution-id';
|
||||
|
||||
const mockRun = jest.fn().mockReturnValue('mockRunReturn');
|
||||
require('n8n-core').WorkflowExecute.mockImplementationOnce(() => ({
|
||||
run: mockRun,
|
||||
processRunExecutionData: jest.fn(),
|
||||
}));
|
||||
|
||||
await manualExecutionService.runManually(data, workflow, additionalData, executionId);
|
||||
|
||||
expect(mockRun).toHaveBeenCalledWith(
|
||||
workflow,
|
||||
undefined, // startNode
|
||||
undefined, // destinationNode
|
||||
undefined, // pinData
|
||||
);
|
||||
});
|
||||
|
||||
it('should use execution start node when available for full execution', async () => {
|
||||
const data = mock<IWorkflowExecutionDataProcess>({
|
||||
executionMode: 'manual',
|
||||
pinData: {},
|
||||
startNodes: [],
|
||||
destinationNode: undefined,
|
||||
});
|
||||
|
||||
const startNode = mock<INode>({ name: 'startNode' });
|
||||
const workflow = mock<Workflow>({
|
||||
getNode: jest.fn().mockReturnValue(startNode),
|
||||
});
|
||||
|
||||
const additionalData = mock<IWorkflowExecuteAdditionalData>();
|
||||
const executionId = 'test-execution-id';
|
||||
const emptyPinData = {};
|
||||
|
||||
jest.spyOn(manualExecutionService, 'getExecutionStartNode').mockReturnValue(startNode);
|
||||
|
||||
const mockRun = jest.fn().mockReturnValue('mockRunReturn');
|
||||
require('n8n-core').WorkflowExecute.mockImplementationOnce(() => ({
|
||||
run: mockRun,
|
||||
processRunExecutionData: jest.fn(),
|
||||
}));
|
||||
|
||||
await manualExecutionService.runManually(
|
||||
data,
|
||||
workflow,
|
||||
additionalData,
|
||||
executionId,
|
||||
emptyPinData,
|
||||
);
|
||||
|
||||
expect(manualExecutionService.getExecutionStartNode).toHaveBeenCalledWith(data, workflow);
|
||||
|
||||
expect(mockRun).toHaveBeenCalledWith(
|
||||
workflow,
|
||||
startNode, // startNode
|
||||
undefined, // destinationNode
|
||||
data.pinData, // pinData
|
||||
);
|
||||
});
|
||||
|
||||
it('should handle partial execution with provided runData, startNodes and no destinationNode', async () => {
|
||||
const mockRunData = { node1: [{ data: { main: [[{ json: {} }]] } }] };
|
||||
const startNodeName = 'node1';
|
||||
const data = mock<IWorkflowExecutionDataProcess>({
|
||||
executionMode: 'manual',
|
||||
runData: mockRunData,
|
||||
startNodes: [{ name: startNodeName }],
|
||||
destinationNode: undefined,
|
||||
pinData: undefined,
|
||||
});
|
||||
|
||||
const workflow = mock<Workflow>({
|
||||
getNode: jest.fn((name) => {
|
||||
if (name === startNodeName) return mock<INode>({ name: startNodeName });
|
||||
return null;
|
||||
}),
|
||||
});
|
||||
|
||||
const additionalData = mock<IWorkflowExecuteAdditionalData>();
|
||||
const executionId = 'test-execution-id';
|
||||
|
||||
const mockRunPartialWorkflow = jest.fn().mockReturnValue('mockPartialReturn');
|
||||
require('n8n-core').WorkflowExecute.mockImplementationOnce(() => ({
|
||||
runPartialWorkflow: mockRunPartialWorkflow,
|
||||
processRunExecutionData: jest.fn(),
|
||||
}));
|
||||
|
||||
await manualExecutionService.runManually(data, workflow, additionalData, executionId);
|
||||
|
||||
expect(mockRunPartialWorkflow).toHaveBeenCalledWith(
|
||||
workflow,
|
||||
mockRunData,
|
||||
data.startNodes,
|
||||
undefined, // destinationNode
|
||||
undefined, // pinData
|
||||
);
|
||||
});
|
||||
|
||||
it('should handle partial execution with partialExecutionVersion=2', async () => {
|
||||
const mockRunData = { node1: [{ data: { main: [[{ json: {} }]] } }] };
|
||||
const dirtyNodeNames = ['node2', 'node3'];
|
||||
const destinationNodeName = 'destinationNode';
|
||||
const data = mock<IWorkflowExecutionDataProcess>({
|
||||
executionMode: 'manual',
|
||||
runData: mockRunData,
|
||||
startNodes: [{ name: 'node1' }],
|
||||
partialExecutionVersion: 2,
|
||||
dirtyNodeNames,
|
||||
destinationNode: destinationNodeName,
|
||||
});
|
||||
|
||||
const workflow = mock<Workflow>({
|
||||
getNode: jest.fn((name) => mock<INode>({ name })),
|
||||
});
|
||||
|
||||
const additionalData = mock<IWorkflowExecuteAdditionalData>();
|
||||
const executionId = 'test-execution-id';
|
||||
const pinData: IPinData = { node1: [{ json: { pinned: true } }] };
|
||||
|
||||
const mockRunPartialWorkflow2 = jest.fn().mockReturnValue('mockPartial2Return');
|
||||
require('n8n-core').WorkflowExecute.mockImplementationOnce(() => ({
|
||||
runPartialWorkflow2: mockRunPartialWorkflow2,
|
||||
processRunExecutionData: jest.fn(),
|
||||
}));
|
||||
|
||||
await manualExecutionService.runManually(
|
||||
data,
|
||||
workflow,
|
||||
additionalData,
|
||||
executionId,
|
||||
pinData,
|
||||
);
|
||||
|
||||
expect(mockRunPartialWorkflow2).toHaveBeenCalled();
|
||||
expect(mockRunPartialWorkflow2.mock.calls[0][0]).toBe(workflow);
|
||||
expect(mockRunPartialWorkflow2.mock.calls[0][4]).toBe(destinationNodeName);
|
||||
});
|
||||
|
||||
it('should validate nodes exist before execution', async () => {
|
||||
const startNodeName = 'existingNode';
|
||||
const data = mock<IWorkflowExecutionDataProcess>({
|
||||
triggerToStartFrom: {
|
||||
name: 'triggerNode',
|
||||
data: mock<ITaskData>(),
|
||||
},
|
||||
startNodes: [{ name: startNodeName }],
|
||||
executionMode: 'manual',
|
||||
});
|
||||
|
||||
const workflow = mock<Workflow>({
|
||||
getNode: jest.fn((name) => {
|
||||
if (name === startNodeName) return mock<INode>({ name: startNodeName });
|
||||
return null;
|
||||
}),
|
||||
});
|
||||
|
||||
const additionalData = mock<IWorkflowExecuteAdditionalData>();
|
||||
const executionId = 'test-execution-id';
|
||||
|
||||
await manualExecutionService.runManually(data, workflow, additionalData, executionId);
|
||||
|
||||
expect(workflow.getNode).toHaveBeenCalledWith(startNodeName);
|
||||
});
|
||||
|
||||
it('should handle pinData correctly when provided', async () => {
|
||||
const startNodeName = 'startNode';
|
||||
const triggerNodeName = 'triggerNode';
|
||||
const mockTriggerData = mock<ITaskData>();
|
||||
const mockPinData: IPinData = {
|
||||
[startNodeName]: [{ json: { pinned: true } }],
|
||||
};
|
||||
|
||||
const data = mock<IWorkflowExecutionDataProcess>({
|
||||
triggerToStartFrom: {
|
||||
name: triggerNodeName,
|
||||
data: mockTriggerData,
|
||||
},
|
||||
startNodes: [{ name: startNodeName }],
|
||||
executionMode: 'manual',
|
||||
});
|
||||
|
||||
const startNode = mock<INode>({ name: startNodeName });
|
||||
const workflow = mock<Workflow>({
|
||||
getNode: jest.fn((name) => {
|
||||
if (name === startNodeName) return startNode;
|
||||
return null;
|
||||
}),
|
||||
});
|
||||
|
||||
const additionalData = mock<IWorkflowExecuteAdditionalData>();
|
||||
const executionId = 'test-execution-id';
|
||||
|
||||
await manualExecutionService.runManually(
|
||||
data,
|
||||
workflow,
|
||||
additionalData,
|
||||
executionId,
|
||||
mockPinData,
|
||||
);
|
||||
|
||||
expect(WorkflowExecute).toHaveBeenCalledWith(
|
||||
additionalData,
|
||||
data.executionMode,
|
||||
expect.objectContaining({
|
||||
resultData: expect.objectContaining({
|
||||
pinData: mockPinData,
|
||||
}),
|
||||
}),
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
|
@ -48,7 +48,7 @@ export class ManualExecutionService {
|
|||
executionId: string,
|
||||
pinData?: IPinData,
|
||||
): PCancelable<IRun> {
|
||||
if (data.triggerToStartFrom?.data && data.startNodes && !data.destinationNode) {
|
||||
if (data.triggerToStartFrom?.data && data.startNodes) {
|
||||
this.logger.debug(
|
||||
`Execution ID ${executionId} had triggerToStartFrom. Starting from that trigger.`,
|
||||
{ executionId },
|
||||
|
@ -78,6 +78,10 @@ export class ManualExecutionService {
|
|||
},
|
||||
};
|
||||
|
||||
if (data.destinationNode) {
|
||||
executionData.startData = { destinationNode: data.destinationNode };
|
||||
}
|
||||
|
||||
const workflowExecute = new WorkflowExecute(
|
||||
additionalData,
|
||||
data.executionMode,
|
||||
|
@ -105,6 +109,7 @@ export class ManualExecutionService {
|
|||
|
||||
// Can execute without webhook so go on
|
||||
const workflowExecute = new WorkflowExecute(additionalData, data.executionMode);
|
||||
|
||||
return workflowExecute.run(workflow, startNode, data.destinationNode, data.pinData);
|
||||
} else {
|
||||
// Partial Execution
|
||||
|
|
Loading…
Reference in a new issue