feat(engine): Let the control plane mint the engine 2.0 execution id (#37224)

Author: tomi

packages/@n8n/constants/src/index.ts

@@ -7,6 +7,7 @@ export * from './execution';
 export * from './logstreaming';
 export * from './nodes';
 export * from './scheduler';
+export * from './uuid';
 
 export const LICENSE_FEATURES = {
 	SHARING: 'feat:sharing',

packages/@n8n/constants/src/uuid.ts

@@ -0,0 +1,6 @@
+/**
+ * Matches a uuidv7: version `7` in the third group, RFC 4122 variant in the
+ * fourth. Time-ordered ids are validated against this on the wire.
+ */
+export const UUID_V7_PATTERN =
+	/^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i;

packages/@n8n/engine/package.json

@@ -25,6 +25,7 @@
   ],
   "dependencies": {
     "@n8n/config": "workspace:*",
+    "@n8n/constants": "workspace:*",
     "@n8n/di": "workspace:*",
     "@n8n/typeorm": "workspace:*",
     "express": "catalog:",

packages/@n8n/engine/src/database/__tests__/workflow-execution.integration.test.ts

@@ -7,6 +7,7 @@ import { ExecutionNotFoundError } from '../../execution/execution-store';
 import { createDataSource } from '../data-source';
 import { WorkflowExecution } from '../entities/workflow-execution.entity';
 import { WorkflowStepExecution } from '../entities/workflow-step-execution.entity';
+import { generateId } from '../generate-id';
 import { TypeOrmExecutionViewStore } from '../typeorm-execution-view-store';
 
 describe('workflow_execution table (integration)', () => {
@@ -29,6 +30,7 @@ describe('workflow_execution table (integration)', () => {
 		const repo = dataSource.getRepository(WorkflowExecution);
 
 		const created = repo.create({
+			id: generateId(),
 			workflowId: 'wf-1',
 			status: 'running',
 			mode: 'production',
@@ -57,6 +59,7 @@ describe('workflow_execution table (integration)', () => {
 		const repo = dataSource.getRepository(WorkflowExecution);
 		const finishedAt = new Date();
 		const created = repo.create({
+			id: generateId(),
 			workflowId: 'wf-3',
 			status: 'completed',
 			mode: 'manual',
@@ -100,6 +103,7 @@ describe('workflow_execution table (integration)', () => {
 
 		await repo.save(
 			repo.create({
+				id: generateId(),
 				workflowId: 'wf-2',
 				status: 'running',
 				mode: 'production',
@@ -110,6 +114,7 @@ describe('workflow_execution table (integration)', () => {
 		);
 		await repo.save(
 			repo.create({
+				id: generateId(),
 				workflowId: 'wf-2',
 				status: 'completed',
 				mode: 'production',

packages/@n8n/engine/src/database/__tests__/workflow-step-execution.integration.test.ts

@@ -8,6 +8,7 @@ import { StepNotFoundError, type NewStepRecord } from '../../execution/step-stor
 import { createDataSource } from '../data-source';
 import { WorkflowExecution } from '../entities/workflow-execution.entity';
 import { WorkflowStepExecution } from '../entities/workflow-step-execution.entity';
+import { generateId } from '../generate-id';
 import { TypeOrmExecutionViewStore } from '../typeorm-execution-view-store';
 import { TypeOrmStepStore } from '../typeorm-step-store';
 
@@ -39,6 +40,7 @@ describe('workflow_step_execution table (integration)', () => {
 	async function createExecution(): Promise<string> {
 		const repo = dataSource.getRepository(WorkflowExecution);
 		const execution = repo.create({
+			id: generateId(),
 			workflowId: 'wf-1',
 			status: 'running',
 			mode: 'production',

packages/@n8n/engine/src/database/entities/workflow-execution.entity.ts

@@ -1,5 +1,4 @@
 import {
-	BeforeInsert,
 	Column,
 	CreateDateColumn,
 	Entity,
@@ -14,7 +13,6 @@ import type {
 	TriggerOutputs,
 } from '../../execution/execution.types';
 import type { WorkflowGraph } from '../../graph';
-import { generateId } from '../generate-id';
 
 @Entity('workflow_execution')
 @Index('idx_workflow_execution_workflow_id', ['workflowId'])
@@ -46,9 +44,4 @@ export class WorkflowExecution {
 
 	@Column({ name: 'finished_at', type: 'timestamptz', nullable: true, precision: 3 })
 	finishedAt!: Date | null;
-
-	@BeforeInsert()
-	setId(): void {
-		if (!this.id) this.id = generateId();
-	}
 }

packages/@n8n/engine/src/database/typeorm-execution-store.ts

@@ -19,13 +19,12 @@ type InsertValues = Parameters<Repository<WorkflowExecution>['insert']>[0];
 export class TypeOrmExecutionStore implements ExecutionStore {
 	constructor(private readonly repo: Repository<WorkflowExecution>) {}
 
-	async createExecution(record: NewExecutionRecord): Promise<{ id: string }> {
+	async createExecution(record: NewExecutionRecord): Promise<void> {
 		const execution = this.repo.create({ ...record, finishedAt: null });
 		// The cast is needed because the insert payload type recurses into the
 		// opaque `graph` jsonb and rejects `StepConfig`'s deliberate `unknown`.
 		// NOTE: prefer insert to save for performance reasons.
 		await this.repo.insert(execution as InsertValues);
-		return { id: execution.id };
 	}
 
 	async loadExecution(id: string): Promise<ExecutionRecord> {

packages/@n8n/engine/src/execution/__tests__/execution-start.integration.test.ts

@@ -11,6 +11,7 @@ import {
 	WorkflowExecution,
 	WorkflowStepExecution,
 } from '../../database';
+import { generateId } from '../../database/generate-id';
 import type { WorkflowGraph } from '../../graph';
 import { noopLifecycleEventPublisher } from '../../lifecycle-events';
 import {
@@ -97,6 +98,7 @@ describe('execution start (integration)', () => {
 			workflowId: 'wf-1',
 			graph,
 			triggerOutputs: [[{ json: { hello: 'world' } }]],
+			executionId: generateId(),
 		});
 		await ready;
 
@@ -134,7 +136,9 @@ describe('execution start (integration)', () => {
 			noopLifecycleEventPublisher,
 		);
 
-		const { id: executionId } = await executionStore.createExecution({
+		const executionId = generateId();
+		await executionStore.createExecution({
+			id: executionId,
 			workflowId: 'wf-2',
 			status: 'queued',
 			mode: 'production',

packages/@n8n/engine/src/execution/__tests__/start-execution.service.test.ts

@@ -17,7 +17,7 @@ function makeQueue(): WorkQueue<OrchestrationMessage> {
 
 function makeStore(overrides: Partial<ExecutionStore> = {}): ExecutionStore {
 	return {
-		createExecution: vi.fn().mockResolvedValue({ id: 'exec-id-1' }),
+		createExecution: vi.fn(),
 		loadExecution: vi.fn(),
 		transitionStatus: vi.fn().mockResolvedValue(true),
 		finishExecution: vi.fn().mockResolvedValue(true),
@@ -26,7 +26,7 @@ function makeStore(overrides: Partial<ExecutionStore> = {}): ExecutionStore {
 }
 
 describe('StartExecutionService', () => {
-	it('admits, persists a queued execution, publishes execution:enqueued, returns id', async () => {
+	it('admits, persists a queued execution under the caller-minted id, publishes execution:enqueued', async () => {
 		const admittance: AdmittanceService = {
 			evaluate: vi.fn().mockResolvedValue({ accept: true }),
 		};
@@ -38,11 +38,13 @@ describe('StartExecutionService', () => {
 			workflowId: 'wf-1',
 			graph: sampleGraph,
 			triggerOutputs: [[{ json: { hello: 'world' } }]],
+			executionId: 'exec-id-1',
 		});
 
 		expect(result.executionId).toBe('exec-id-1');
 		expect(admittance.evaluate).toHaveBeenCalledWith({ workflowId: 'wf-1' });
 		expect(store.createExecution).toHaveBeenCalledWith({
+			id: 'exec-id-1',
 			workflowId: 'wf-1',
 			status: 'queued',
 			mode: 'production',
@@ -63,7 +65,7 @@ describe('StartExecutionService', () => {
 		const queue = makeQueue();
 		const service = new StartExecutionService(admittance, store, queue);
 
-		await service.start({ workflowId: 'wf-1', graph: sampleGraph });
+		await service.start({ workflowId: 'wf-1', graph: sampleGraph, executionId: 'exec-id-1' });
 
 		expect(store.createExecution).toHaveBeenCalledWith(
 			expect.objectContaining({ mode: 'production', triggerOutputs: null }),
@@ -77,7 +79,7 @@ describe('StartExecutionService', () => {
 		const validateGraph = vi.fn();
 		const service = new StartExecutionService(admittance, makeStore(), makeQueue(), validateGraph);
 
-		await service.start({ workflowId: 'wf-1', graph: sampleGraph });
+		await service.start({ workflowId: 'wf-1', graph: sampleGraph, executionId: 'exec-id-1' });
 
 		expect(validateGraph).toHaveBeenCalledExactlyOnceWith(sampleGraph);
 	});
@@ -94,7 +96,9 @@ describe('StartExecutionService', () => {
 		});
 		const service = new StartExecutionService(admittance, store, queue, validateGraph);
 
-		await expect(service.start({ workflowId: 'wf-1', graph: sampleGraph })).rejects.toBe(rejection);
+		await expect(
+			service.start({ workflowId: 'wf-1', graph: sampleGraph, executionId: 'exec-id-1' }),
+		).rejects.toBe(rejection);
 
 		expect(store.createExecution).not.toHaveBeenCalled();
 		expect(queue.publish).not.toHaveBeenCalled();
@@ -108,9 +112,9 @@ describe('StartExecutionService', () => {
 		const queue = makeQueue();
 		const service = new StartExecutionService(admittance, store, queue);
 
-		await expect(service.start({ workflowId: 'wf-1', graph: sampleGraph })).rejects.toBeInstanceOf(
-			AdmittanceRejectedError,
-		);
+		await expect(
+			service.start({ workflowId: 'wf-1', graph: sampleGraph, executionId: 'exec-id-1' }),
+		).rejects.toBeInstanceOf(AdmittanceRejectedError);
 
 		expect(store.createExecution).not.toHaveBeenCalled();
 		expect(queue.publish).not.toHaveBeenCalled();

packages/@n8n/engine/src/execution/__tests__/step-execution.integration.test.ts

@@ -12,6 +12,7 @@ import {
 	WorkflowExecution,
 	WorkflowStepExecution,
 } from '../../database';
+import { generateId } from '../../database/generate-id';
 import type { IStepExecutor, StepExecutionRequest } from '../../dependencies';
 import type { WorkflowGraph } from '../../graph';
 import { noopLifecycleEventPublisher } from '../../lifecycle-events';
@@ -101,7 +102,7 @@ describe('step execution (integration)', () => {
 		const response = await request(runtime.app)
 			.post('/api/workflow-executions')
 			.set(authHeader())
-			.send({ workflowId, graph: workflowGraph, triggerOutputs })
+			.send({ workflowId, graph: workflowGraph, triggerOutputs, executionId: generateId() })
 			.expect(201);
 		const { executionId } = response.body as StartExecutionResult;
 		await finished;
@@ -381,7 +382,9 @@ describe('step execution (integration)', () => {
 			noopLifecycleEventPublisher,
 		);
 
-		const { id: executionId } = await executionStore.createExecution({
+		const executionId = generateId();
+		await executionStore.createExecution({
+			id: executionId,
 			workflowId: 'wf-2',
 			status: 'running',
 			mode: 'production',