Add workflow publish history

CharlieKolb · dariacodes · commit f0883c15adb6 · 2025-11-24T14:42:28.000+02:00
diff --git a/packages/@n8n/db/src/entities/index.ts b/packages/@n8n/db/src/entities/index.ts
@@ -29,6 +29,7 @@ import { WebhookEntity } from './webhook-entity';
 import { WorkflowDependency } from './workflow-dependency-entity';
 import { WorkflowEntity } from './workflow-entity';
 import { WorkflowHistory } from './workflow-history';
+import { WorkflowPublishHistory } from './workflow-publish-history';
 import { WorkflowStatistics } from './workflow-statistics';
 import { WorkflowTagMapping } from './workflow-tag-mapping';
 
@@ -58,6 +59,7 @@ export {
 	FolderTagMapping,
 	AuthProviderSyncHistory,
 	WorkflowHistory,
+	WorkflowPublishHistory,
 	ExecutionData,
 	ExecutionMetadata,
 	AnnotationTagEntity,
@@ -93,6 +95,7 @@ export const entities = {
 	FolderTagMapping,
 	AuthProviderSyncHistory,
 	WorkflowHistory,
+	WorkflowPublishHistory,
 	ExecutionData,
 	ExecutionMetadata,
 	AnnotationTagEntity,
diff --git a/packages/@n8n/db/src/entities/workflow-publish-history.ts b/packages/@n8n/db/src/entities/workflow-publish-history.ts
@@ -0,0 +1,37 @@
+import { Column, Entity, Index, JoinColumn, OneToOne, PrimaryGeneratedColumn } from '@n8n/typeorm';
+import { WorkflowActivateMode } from 'n8n-workflow';
+
+import { WithCreatedAt } from './abstract-entity';
+import { User } from './user';
+
+@Entity()
+@Index(['workflowId', 'versionId'])
+export class WorkflowPublishHistory extends WithCreatedAt {
+	@PrimaryGeneratedColumn()
+	id: number;
+
+	@Column({ type: 'varchar' })
+	@Index()
+	workflowId: string;
+
+	@Column({ type: 'varchar' })
+	versionId: string | null;
+
+	@Column()
+	status: 'activated' | 'deactivated';
+
+	// We only expect 'activate', 'update' and 'init' from WorkflowActivateMode
+	// But this makes usage wrt typings easier.
+	// If you ever see other values here this would be unexpected though
+	@Column({ type: 'varchar' })
+	mode: WorkflowActivateMode | 'deactivate' | null;
+
+	@Column({ type: 'varchar' })
+	userId: string | null;
+
+	@OneToOne('User', 'id', {
+		onDelete: 'SET NULL',
+	})
+	@JoinColumn({ name: 'userId' })
+	user: User;
+}
diff --git a/packages/@n8n/db/src/migrations/common/1763387043735-CreateWorkflowPublishHistoryTable.ts b/packages/@n8n/db/src/migrations/common/1763387043735-CreateWorkflowPublishHistoryTable.ts
@@ -0,0 +1,37 @@
+import type { MigrationContext, ReversibleMigration } from '../migration-types';
+
+const workflowPublishHistoryTableName = 'workflow_publish_history';
+
+export class CreateWorkflowPublishHistoryTable1763387043735 implements ReversibleMigration {
+	async up({ schemaBuilder: { createTable, column } }: MigrationContext) {
+		await createTable(workflowPublishHistoryTableName)
+			.withColumns(
+				column('id').int.primary.autoGenerate2,
+				column('workflowId').varchar(36).notNull,
+				column('versionId').varchar(36),
+				column('status').varchar(36).notNull,
+				column('mode').varchar(36),
+				column('userId').varchar(36),
+			)
+			.withCreatedAt.withForeignKey('workflowId', {
+				tableName: 'workflow_entity',
+				columnName: 'id',
+				onDelete: 'CASCADE',
+			})
+			.withForeignKey('versionId', {
+				tableName: 'workflow_history',
+				columnName: 'versionId',
+				onDelete: 'SET NULL',
+			})
+			.withForeignKey('userId', {
+				tableName: 'user',
+				columnName: 'id',
+				onDelete: 'SET NULL',
+			})
+			.withIndexOn(['workflowId', 'versionId']);
+	}
+
+	async down({ schemaBuilder: { dropTable } }: MigrationContext) {
+		await dropTable(workflowPublishHistoryTableName);
+	}
+}
diff --git a/packages/@n8n/db/src/migrations/mysqldb/index.ts b/packages/@n8n/db/src/migrations/mysqldb/index.ts
@@ -116,6 +116,7 @@ import { BackfillMissingWorkflowHistoryRecords1762763704614 } from '../common/17
 import { AddIsGlobalColumnToCredentialsTable1762771954619 } from '../common/1762771954619-IsGlobalGlobalColumnToCredentialsTable';
 import { AddWorkflowHistoryAutoSaveFields1762847206508 } from '../common/1762847206508-AddWorkflowHistoryAutoSaveFields';
 import { AddActiveVersionIdColumn1763047800000 } from '../common/1763047800000-AddActiveVersionIdColumn';
+import { CreateWorkflowPublishHistoryTable1763387043735 } from '../common/1763387043735-CreateWorkflowPublishHistoryTable';
 import { ChangeOAuthStateColumnToUnboundedVarchar1763572724000 } from '../common/1763572724000-ChangeOAuthStateColumnToUnboundedVarchar';
 import { CreateBinaryDataTable1763716655000 } from '../common/1763716655000-CreateBinaryDataTable';
 import type { Migration } from '../migration-types';
@@ -241,4 +242,5 @@ export const mysqlMigrations: Migration[] = [
 	AddAttachmentsToChatHubMessages1761773155024,
 	AddActiveVersionIdColumn1763047800000,
 	CreateBinaryDataTable1763716655000,
+	CreateWorkflowPublishHistoryTable1763387043735,
 ];
diff --git a/packages/@n8n/db/src/migrations/postgresdb/index.ts b/packages/@n8n/db/src/migrations/postgresdb/index.ts
@@ -116,6 +116,7 @@ import { BackfillMissingWorkflowHistoryRecords1762763704614 } from '../common/17
 import { AddIsGlobalColumnToCredentialsTable1762771954619 } from '../common/1762771954619-IsGlobalGlobalColumnToCredentialsTable';
 import { AddWorkflowHistoryAutoSaveFields1762847206508 } from '../common/1762847206508-AddWorkflowHistoryAutoSaveFields';
 import { AddActiveVersionIdColumn1763047800000 } from '../common/1763047800000-AddActiveVersionIdColumn';
+import { CreateWorkflowPublishHistoryTable1763387043735 } from '../common/1763387043735-CreateWorkflowPublishHistoryTable';
 import { ChangeOAuthStateColumnToUnboundedVarchar1763572724000 } from '../common/1763572724000-ChangeOAuthStateColumnToUnboundedVarchar';
 import { CreateBinaryDataTable1763716655000 } from '../common/1763716655000-CreateBinaryDataTable';
 import type { Migration } from '../migration-types';
@@ -241,4 +242,5 @@ export const postgresMigrations: Migration[] = [
 	AddAttachmentsToChatHubMessages1761773155024,
 	AddActiveVersionIdColumn1763047800000,
 	CreateBinaryDataTable1763716655000,
+	CreateWorkflowPublishHistoryTable1763387043735,
 ];
diff --git a/packages/@n8n/db/src/migrations/sqlite/index.ts b/packages/@n8n/db/src/migrations/sqlite/index.ts
@@ -112,6 +112,7 @@ import { BackfillMissingWorkflowHistoryRecords1762763704614 } from '../common/17
 import { AddIsGlobalColumnToCredentialsTable1762771954619 } from '../common/1762771954619-IsGlobalGlobalColumnToCredentialsTable';
 import { AddWorkflowHistoryAutoSaveFields1762847206508 } from '../common/1762847206508-AddWorkflowHistoryAutoSaveFields';
 import { AddActiveVersionIdColumn1763047800000 } from '../common/1763047800000-AddActiveVersionIdColumn';
+import { CreateWorkflowPublishHistoryTable1763387043735 } from '../common/1763387043735-CreateWorkflowPublishHistoryTable';
 import { ChangeOAuthStateColumnToUnboundedVarchar1763572724000 } from '../common/1763572724000-ChangeOAuthStateColumnToUnboundedVarchar';
 import { CreateBinaryDataTable1763716655000 } from '../common/1763716655000-CreateBinaryDataTable';
 import type { Migration } from '../migration-types';
@@ -233,6 +234,7 @@ const sqliteMigrations: Migration[] = [
 	AddAttachmentsToChatHubMessages1761773155024,
 	AddActiveVersionIdColumn1763047800000,
 	CreateBinaryDataTable1763716655000,
+	CreateWorkflowPublishHistoryTable1763387043735,
 ];
 
 export { sqliteMigrations };
diff --git a/packages/@n8n/db/src/repositories/index.ts b/packages/@n8n/db/src/repositories/index.ts
@@ -29,6 +29,7 @@ export { WorkflowTagMappingRepository } from './workflow-tag-mapping.repository'
 export { SharedWorkflowRepository } from './shared-workflow.repository';
 export { SharedCredentialsRepository } from './shared-credentials.repository';
 export { WorkflowRepository } from './workflow.repository';
+export { WorkflowPublishHistoryRepository } from './workflow-publish-history.repository';
 export {
 	WorkflowDependencyRepository,
 	WorkflowDependencies,
diff --git a/packages/@n8n/db/src/repositories/workflow-publish-history.repository.ts b/packages/@n8n/db/src/repositories/workflow-publish-history.repository.ts
@@ -0,0 +1,56 @@
+import { Service } from '@n8n/di';
+import { DataSource, Equal, Or, Repository } from '@n8n/typeorm';
+
+import { WorkflowPublishHistory } from '../entities';
+
+@Service()
+export class WorkflowPublishHistoryRepository extends Repository<WorkflowPublishHistory> {
+	constructor(dataSource: DataSource) {
+		super(WorkflowPublishHistory, dataSource.manager);
+	}
+
+	async addRecord({
+		workflowId,
+		versionId,
+		status,
+		mode,
+		userId,
+	}: Pick<WorkflowPublishHistory, 'status' | 'workflowId' | 'versionId' | 'mode' | 'userId'>) {
+		return await this.insert({
+			workflowId,
+			versionId,
+			status,
+			mode,
+			userId,
+		});
+	}
+
+	async getLastActivatedVersion(workflowId: string) {
+		return await this.findOne({
+			select: ['versionId'],
+			where: {
+				workflowId,
+				status: 'activated',
+				mode: 'activate',
+			},
+			order: { createdAt: 'DESC' },
+		});
+	}
+
+	async getPublishedVersions(workflowId: string, includeUser?: boolean) {
+		const select: Array<keyof WorkflowPublishHistory> = ['versionId', 'createdAt'];
+		if (includeUser) {
+			select.push('user');
+		}
+		const result = await this.find({
+			select,
+			where: {
+				workflowId,
+				status: 'activated',
+				mode: Or(Equal('activate'), Equal('update')),
+			},
+		});
+
+		return result;
+	}
+}
diff --git a/packages/cli/src/__tests__/active-workflow-manager.test.ts b/packages/cli/src/__tests__/active-workflow-manager.test.ts
@@ -36,6 +36,7 @@ describe('ActiveWorkflowManager', () => {
 			mock(),
 			mock(),
 			mock(),
+			mock(),
 			instanceSettings,
 			mock(),
 			mock(),
diff --git a/packages/cli/src/active-workflow-manager.ts b/packages/cli/src/active-workflow-manager.ts
@@ -7,7 +7,7 @@ import {
 import { Logger } from '@n8n/backend-common';
 import { WorkflowsConfig } from '@n8n/config';
 import type { WorkflowEntity, IWorkflowDb } from '@n8n/db';
-import { WorkflowRepository } from '@n8n/db';
+import { WorkflowRepository, WorkflowPublishHistoryRepository } from '@n8n/db';
 import { OnLeaderStepdown, OnLeaderTakeover, OnPubSubEvent, OnShutdown } from '@n8n/decorators';
 import { Service } from '@n8n/di';
 import chunk from 'lodash/chunk';
@@ -59,6 +59,8 @@ import * as WorkflowExecuteAdditionalData from '@/workflow-execute-additional-da
 import { WorkflowExecutionService } from '@/workflows/workflow-execution.service';
 import { WorkflowStaticDataService } from '@/workflows/workflow-static-data.service';
 import { formatWorkflow } from '@/workflows/workflow.formatter';
+import { PubSubCommandMap } from './scaling/pubsub/pubsub.event-map';
+import { User } from '@n8n/api-types';
 
 interface QueuedActivation {
 	activationMode: WorkflowActivateMode;
@@ -80,6 +82,7 @@ export class ActiveWorkflowManager {
 		private readonly nodeTypes: NodeTypes,
 		private readonly webhookService: WebhookService,
 		private readonly workflowRepository: WorkflowRepository,
+		private readonly workflowPublishHistoryRepository: WorkflowPublishHistoryRepository,
 		private readonly activationErrorsService: ActivationErrorsService,
 		private readonly executionService: ExecutionService,
 		private readonly workflowStaticDataService: WorkflowStaticDataService,
@@ -561,6 +564,7 @@ export class ActiveWorkflowManager {
 		activationMode: WorkflowActivateMode,
 		existingWorkflow?: WorkflowEntity,
 		{ shouldPublish } = { shouldPublish: true },
+		userId: string | null = null,
 	) {
 		const added = { webhooks: false, triggersAndPollers: false };
 
@@ -655,6 +659,13 @@ export class ActiveWorkflowManager {
 
 			const triggerCount = this.countTriggers(workflow, additionalData);
 			await this.workflowRepository.updateWorkflowTriggerCount(workflow.id, triggerCount);
+			await this.workflowPublishHistoryRepository.addRecord({
+				workflowId,
+				versionId: dbWorkflow.versionId,
+				status: 'activated',
+				mode: activationMode,
+				userId,
+			});
 		} catch (e) {
 			const error = e instanceof Error ? e : new Error(`${e}`);
 			await this.activationErrorsService.register(workflowId, error.message);
@@ -670,7 +681,7 @@ export class ActiveWorkflowManager {
 	}
 
 	@OnPubSubEvent('display-workflow-activation', { instanceType: 'main' })
-	handleDisplayWorkflowActivation({ workflowId }: { workflowId: string }) {
+	handleDisplayWorkflowActivation({ workflowId }: PubSubCommandMap['display-workflow-activation']) {
 		this.push.broadcast({ type: 'workflowActivated', data: { workflowId } });
 	}
 
@@ -697,7 +708,9 @@ export class ActiveWorkflowManager {
 		instanceType: 'main',
 		instanceRole: 'leader',
 	})
-	async handleAddWebhooksTriggersAndPollers({ workflowId }: { workflowId: string }) {
+	async handleAddWebhooksTriggersAndPollers({
+		workflowId,
+	}: PubSubCommandMap['add-webhooks-triggers-and-pollers']) {
 		try {
 			await this.add(workflowId, 'activate', undefined, {
 				shouldPublish: false, // prevent leader from re-publishing message
@@ -881,7 +894,7 @@ export class ActiveWorkflowManager {
 	 */
 	// TODO: this should happen in a transaction
 	// maybe, see: https://github.com/n8n-io/n8n/pull/8904#discussion_r1530150510
-	async remove(workflowId: WorkflowId) {
+	async remove(workflowId: WorkflowId, userId?: User['id'], reason?: 'update' | 'deactivate') {
 		if (this.instanceSettings.isMultiMain) {
 			try {
 				await this.clearWebhooks(workflowId);
@@ -918,6 +931,14 @@ export class ActiveWorkflowManager {
 		// if it's active in memory then it's a trigger
 		// so remove from list of actives workflows
 		await this.removeWorkflowTriggersAndPollers(workflowId);
+
+		await this.workflowPublishHistoryRepository.addRecord({
+			workflowId,
+			versionId: null,
+			status: 'deactivated',
+			mode: reason ?? null,
+			userId: userId ?? null,
+		});
 	}
 
 	@OnPubSubEvent('remove-triggers-and-pollers', { instanceType: 'main', instanceRole: 'leader' })
diff --git a/packages/cli/src/environments.ee/source-control/source-control-import.service.ee.ts b/packages/cli/src/environments.ee/source-control/source-control-import.service.ee.ts
@@ -707,7 +707,7 @@ export class SourceControlImportService {
 			});
 
 			if (existingWorkflow?.activeVersionId) {
-				await this.activateImportedWorkflow({ existingWorkflow, importedWorkflow });
+				await this.activateImportedWorkflow({ existingWorkflow, importedWorkflow }, userId);
 			}
 
 			importWorkflowsResult.push({
@@ -735,19 +735,22 @@ export class SourceControlImportService {
 		}
 	}
 
-	private async activateImportedWorkflow({
-		existingWorkflow,
-		importedWorkflow,
-	}: { existingWorkflow: WorkflowEntity; importedWorkflow: IWorkflowToImport }) {
+	private async activateImportedWorkflow(
+		{
+			existingWorkflow,
+			importedWorkflow,
+		}: { existingWorkflow: WorkflowEntity; importedWorkflow: IWorkflowToImport },
+		userId: string,
+	) {
 		try {
 			// remove active pre-import workflow
 			this.logger.debug(`Deactivating workflow id ${existingWorkflow.id}`);
-			await this.activeWorkflowManager.remove(existingWorkflow.id);
+			await this.activeWorkflowManager.remove(existingWorkflow.id, userId, 'update');
 
 			if (importedWorkflow.activeVersionId) {
 				// try activating the imported workflow
 				this.logger.debug(`Reactivating workflow id ${existingWorkflow.id}`);
-				await this.activeWorkflowManager.add(existingWorkflow.id, 'activate');
+				await this.activeWorkflowManager.add(existingWorkflow.id, 'update');
 			}
 		} catch (e) {
 			const error = ensureError(e);
diff --git a/packages/cli/src/public-api/v1/handlers/workflows/workflows.handler.ts b/packages/cli/src/public-api/v1/handlers/workflows/workflows.handler.ts
@@ -312,7 +312,7 @@ export = {
 			if (workflow.activeVersionId !== null) {
 				// When workflow gets saved always remove it as the triggers could have been
 				// changed and so the changes would not take effect
-				await workflowManager.remove(id);
+				await workflowManager.remove(id, req.user.id, 'update');
 			}
 
 			try {
@@ -443,7 +443,7 @@ export = {
 			const activeWorkflowManager = Container.get(ActiveWorkflowManager);
 
 			if (workflow.activeVersionId) {
-				await activeWorkflowManager.remove(workflow.id);
+				await activeWorkflowManager.remove(workflow.id, req.user.id, 'deactivate');
 
 				await setWorkflowAsInactive(workflow.id);
 
diff --git a/packages/cli/src/services/import.service.ts b/packages/cli/src/services/import.service.ts
@@ -79,7 +79,7 @@ export class ImportService {
 
 			// Remove workflows from ActiveWorkflowManager BEFORE transaction to prevent orphaned trigger listeners
 			if (workflow.id) {
-				await this.activeWorkflowManager.remove(workflow.id);
+				await this.activeWorkflowManager.remove(workflow.id, undefined, 'deactivate');
 			}
 		}
 
diff --git a/packages/cli/src/workflows/workflow.service.ee.ts b/packages/cli/src/workflows/workflow.service.ee.ts
diff --git a/packages/cli/src/workflows/workflow.service.ts b/packages/cli/src/workflows/workflow.service.ts
diff --git a/packages/cli/test/integration/import.service.test.ts b/packages/cli/test/integration/import.service.test.ts
diff --git a/packages/cli/test/integration/workflows/workflows.controller.ee.test.ts b/packages/cli/test/integration/workflows/workflows.controller.ee.test.ts
diff --git a/packages/cli/test/integration/workflows/workflows.controller.test.ts b/packages/cli/test/integration/workflows/workflows.controller.test.ts

-Original file line number
+Diff line change
 			mock(),
 			mock(),
 			mock(),
 +			mock(),
 			instanceSettings,
 			mock(),
 			mock(),