feat(editor): Add workflow evaluation edit and list views (no-changelog)

packages/cli/src/databases/entities/test-definition.ee.ts

@@ -35,6 +35,9 @@ export class TestDefinition extends WithTimestamps {
 	})
 	name: string;
 
+	@Column('text')
+	description: string;
+
 	/**
 	 * Relation to the workflow under test
 	 */

packages/cli/src/databases/migrations/common/1731404028106-AddDescriptionToTestDefinition.ts

@@ -0,0 +1,11 @@
+import type { MigrationContext, ReversibleMigration } from '@/databases/types';
+
+export class AddDescriptionToTestDefinition1731404028106 implements ReversibleMigration {
+	async up({ schemaBuilder: { addColumns, column } }: MigrationContext) {
+		await addColumns('test_definition', [column('description').text]);
+	}
+
+	async down({ schemaBuilder: { dropColumns } }: MigrationContext) {
+		await dropColumns('test_definition', ['description']);
+	}
+}

packages/cli/src/databases/migrations/mysqldb/index.ts

@@ -69,6 +69,7 @@ import { SeparateExecutionCreationFromStart1727427440136 } from '../common/17274
 import { AddMissingPrimaryKeyOnAnnotationTagMapping1728659839644 } from '../common/1728659839644-AddMissingPrimaryKeyOnAnnotationTagMapping';
 import { UpdateProcessedDataValueColumnToText1729607673464 } from '../common/1729607673464-UpdateProcessedDataValueColumnToText';
 import { CreateTestDefinitionTable1730386903556 } from '../common/1730386903556-CreateTestDefinitionTable';
+import { AddDescriptionToTestDefinition1731404028106 } from '../common/1731404028106-AddDescriptionToTestDefinition';
 
 export const mysqlMigrations: Migration[] = [
 	InitialMigration1588157391238,
@@ -140,4 +141,5 @@ export const mysqlMigrations: Migration[] = [
 	AddMissingPrimaryKeyOnAnnotationTagMapping1728659839644,
 	UpdateProcessedDataValueColumnToText1729607673464,
 	CreateTestDefinitionTable1730386903556,
+	AddDescriptionToTestDefinition1731404028106,
 ];

packages/cli/src/databases/migrations/postgresdb/index.ts

@@ -69,6 +69,7 @@ import { SeparateExecutionCreationFromStart1727427440136 } from '../common/17274
 import { AddMissingPrimaryKeyOnAnnotationTagMapping1728659839644 } from '../common/1728659839644-AddMissingPrimaryKeyOnAnnotationTagMapping';
 import { UpdateProcessedDataValueColumnToText1729607673464 } from '../common/1729607673464-UpdateProcessedDataValueColumnToText';
 import { CreateTestDefinitionTable1730386903556 } from '../common/1730386903556-CreateTestDefinitionTable';
+import { AddDescriptionToTestDefinition1731404028106 } from '../common/1731404028106-AddDescriptionToTestDefinition';
 
 export const postgresMigrations: Migration[] = [
 	InitialMigration1587669153312,
@@ -140,4 +141,5 @@ export const postgresMigrations: Migration[] = [
 	AddMissingPrimaryKeyOnAnnotationTagMapping1728659839644,
 	UpdateProcessedDataValueColumnToText1729607673464,
 	CreateTestDefinitionTable1730386903556,
+	AddDescriptionToTestDefinition1731404028106,
 ];

packages/cli/src/databases/migrations/sqlite/index.ts

@@ -66,6 +66,7 @@ import { CreateProcessedDataTable1726606152711 } from '../common/1726606152711-C
 import { SeparateExecutionCreationFromStart1727427440136 } from '../common/1727427440136-SeparateExecutionCreationFromStart';
 import { UpdateProcessedDataValueColumnToText1729607673464 } from '../common/1729607673464-UpdateProcessedDataValueColumnToText';
 import { CreateTestDefinitionTable1730386903556 } from '../common/1730386903556-CreateTestDefinitionTable';
+import { AddDescriptionToTestDefinition1731404028106 } from '../common/1731404028106-AddDescriptionToTestDefinition';
 
 const sqliteMigrations: Migration[] = [
 	InitialMigration1588102412422,
@@ -134,6 +135,7 @@ const sqliteMigrations: Migration[] = [
 	AddMissingPrimaryKeyOnAnnotationTagMapping1728659839644,
 	UpdateProcessedDataValueColumnToText1729607673464,
 	CreateTestDefinitionTable1730386903556,
+	AddDescriptionToTestDefinition1731404028106,
 ];
 
 export { sqliteMigrations };

packages/cli/src/evaluation/test-definition.schema.ts

@@ -4,13 +4,16 @@ export const testDefinitionCreateRequestBodySchema = z
 	.object({
 		name: z.string().min(1).max(255),
 		workflowId: z.string().min(1),
+		description: z.string().optional(),
 		evaluationWorkflowId: z.string().min(1).optional(),
+		annotationTagId: z.string().min(1).optional(),
 	})
 	.strict();
 
 export const testDefinitionPatchRequestBodySchema = z
 	.object({
 		name: z.string().min(1).max(255).optional(),
+		description: z.string().optional(),
 		evaluationWorkflowId: z.string().min(1).optional(),
 		annotationTagId: z.string().min(1).optional(),
 	})

packages/cli/src/evaluation/test-definition.service.ee.ts

@@ -26,6 +26,7 @@ export class TestDefinitionService {
 
 	private toEntityLike(attrs: {
 		name?: string;
+		description?: string;
 		workflowId?: string;
 		evaluationWorkflowId?: string;
 		annotationTagId?: string;
@@ -41,6 +42,10 @@ export class TestDefinitionService {
 			entity.name = attrs.name?.trim();
 		}
 
+		if (attrs.description) {
+			entity.description = attrs.description.trim();
+		}
+
 		if (attrs.workflowId) {
 			entity.workflow = {
 				id: attrs.workflowId,

packages/cli/test/integration/evaluation/test-definitions.api.test.ts

@@ -163,9 +163,36 @@ describe('POST /evaluation/test-definitions', () => {
 		});
 
 		expect(resp.statusCode).toBe(200);
-		expect(resp.body.data.name).toBe('test');
-		expect(resp.body.data.workflowId).toBe(workflowUnderTest.id);
-		expect(resp.body.data.evaluationWorkflowId).toBe(evaluationWorkflow.id);
+		expect(resp.body.data).toEqual(
+			expect.objectContaining({
+				name: 'test',
+				workflowId: workflowUnderTest.id,
+				evaluationWorkflowId: evaluationWorkflow.id,
+			}),
+		);
+	});
+
+	test('should create test definition with all fields', async () => {
+		const resp = await authOwnerAgent.post('/evaluation/test-definitions').send({
+			name: 'test',
+			description: 'test description',
+			workflowId: workflowUnderTest.id,
+			evaluationWorkflowId: evaluationWorkflow.id,
+			annotationTagId: annotationTag.id,
+		});
+
+		expect(resp.statusCode).toBe(200);
+		expect(resp.body.data).toEqual(
+			expect.objectContaining({
+				name: 'test',
+				description: 'test description',
+				workflowId: workflowUnderTest.id,
+				evaluationWorkflowId: evaluationWorkflow.id,
+				annotationTag: expect.objectContaining({
+					id: annotationTag.id,
+				}),
+			}),
+		);
 	});
 
 	test('should return error if name is empty', async () => {

packages/editor-ui/src/api/evaluations.ee.ts

@@ -0,0 +1,82 @@
+import type { IRestApiContext } from '@/Interface';
+import { makeRestApiRequest } from '@/utils/apiUtils';
+
+// Base interface for common properties
+export interface ITestDefinitionBase {
+	name: string;
+	workflowId: string;
+	evaluationWorkflowId?: string;
+	description?: string;
+	annotationTagId?: string;
+}
+
+export interface ITestDefinition extends ITestDefinitionBase {
+	id: number;
+}
+
+export type CreateTestDefinitionParams = Pick<
+	ITestDefinitionBase,
+	'name' | 'workflowId' | 'description' | 'evaluationWorkflowId'
+>;
+
+export type UpdateTestDefinitionParams = Partial<ITestDefinitionBase>;
+
+// Query options type
+export interface ITestDefinitionsQueryOptions {
+	includeScopes?: boolean;
+}
+
+export interface ITestDefinitionsApi {
+	getTestDefinitions: (
+		context: IRestApiContext,
+		options?: ITestDefinitionsQueryOptions,
+	) => Promise<{ count: number; testDefinitions: ITestDefinition[] }>;
+
+	getTestDefinition: (context: IRestApiContext, id: number) => Promise<ITestDefinition>;
+
+	createTestDefinition: (
+		context: IRestApiContext,
+		params: CreateTestDefinitionParams,
+	) => Promise<ITestDefinition>;
+
+	updateTestDefinition: (
+		context: IRestApiContext,
+		id: number,
+		params: UpdateTestDefinitionParams,
+	) => Promise<ITestDefinition>;
+
+	deleteTestDefinition: (context: IRestApiContext, id: number) => Promise<{ success: boolean }>;
+}
+
+export function createTestDefinitionsApi(): ITestDefinitionsApi {
+	const endpoint = '/evaluation/test-definitions';
+
+	return {
+		getTestDefinitions: async (
+			context: IRestApiContext,
+			options?: ITestDefinitionsQueryOptions,
+		) => {
+			return await makeRestApiRequest(context, 'GET', endpoint, options);
+		},
+
+		getTestDefinition: async (context: IRestApiContext, id: number) => {
+			return await makeRestApiRequest(context, 'GET', `${endpoint}/${id}`);
+		},
+
+		createTestDefinition: async (context: IRestApiContext, params: CreateTestDefinitionParams) => {
+			return await makeRestApiRequest(context, 'POST', endpoint, params);
+		},
+
+		updateTestDefinition: async (
+			context: IRestApiContext,
+			id: number,
+			params: UpdateTestDefinitionParams,
+		) => {
+			return await makeRestApiRequest(context, 'PATCH', `${endpoint}/${id}`, params);
+		},
+
+		deleteTestDefinition: async (context: IRestApiContext, id: number) => {
+			return await makeRestApiRequest(context, 'DELETE', `${endpoint}/${id}`);
+		},
+	};
+}

packages/editor-ui/src/components/MainHeader/MainHeader.vue

@@ -9,6 +9,7 @@ import {
 	PLACEHOLDER_EMPTY_WORKFLOW_ID,
 	STICKY_NODE_TYPE,
 	VIEWS,
+	WORKFLOW_EVALUATION_EXPERIMENT,
 } from '@/constants';
 import { useI18n } from '@/composables/useI18n';
 import { useNDVStore } from '@/stores/ndv.store';
@@ -17,6 +18,7 @@ import { useUIStore } from '@/stores/ui.store';
 import { useWorkflowsStore } from '@/stores/workflows.store';
 import { useExecutionsStore } from '@/stores/executions.store';
 import { usePushConnection } from '@/composables/usePushConnection';
+import { usePostHog } from '@/stores/posthog.store';
 
 const router = useRouter();
 const route = useRoute();
@@ -27,16 +29,24 @@ const uiStore = useUIStore();
 const sourceControlStore = useSourceControlStore();
 const workflowsStore = useWorkflowsStore();
 const executionsStore = useExecutionsStore();
+const posthogStore = usePostHog();
 
 const activeHeaderTab = ref(MAIN_HEADER_TABS.WORKFLOW);
 const workflowToReturnTo = ref('');
 const executionToReturnTo = ref('');
 const dirtyState = ref(false);
 
-const tabBarItems = computed(() => [
-	{ value: MAIN_HEADER_TABS.WORKFLOW, label: locale.baseText('generic.editor') },
-	{ value: MAIN_HEADER_TABS.EXECUTIONS, label: locale.baseText('generic.executions') },
-]);
+const tabBarItems = computed(() => {
+	const items = [
+		{ value: MAIN_HEADER_TABS.WORKFLOW, label: locale.baseText('generic.editor') },
+		{ value: MAIN_HEADER_TABS.EXECUTIONS, label: locale.baseText('generic.executions') },
+	];
+
+	if (posthogStore.isFeatureEnabled(WORKFLOW_EVALUATION_EXPERIMENT)) {
+		items.push({ value: MAIN_HEADER_TABS.EVALUATION, label: locale.baseText('generic.tests') });
+	}
+	return items;
+});
 
 const activeNode = computed(() => ndvStore.activeNode);
 const hideMenuBar = computed(() =>
@@ -67,6 +77,9 @@ onMounted(async () => {
 });
 
 function syncTabsWithRoute(to: RouteLocation, from?: RouteLocation): void {
+	if (to.matched.some((record) => record.name === VIEWS.WORKFLOW_EVALUATION)) {
+		activeHeaderTab.value = MAIN_HEADER_TABS.EVALUATION;
+	}
 	if (
 		to.name === VIEWS.EXECUTION_HOME ||
 		to.name === VIEWS.WORKFLOW_EXECUTIONS ||
@@ -106,6 +119,11 @@ function onTabSelected(tab: MAIN_HEADER_TABS, event: MouseEvent) {
 			void navigateToExecutionsView(openInNewTab);
 			break;
 
+		case MAIN_HEADER_TABS.EVALUATION:
+			activeHeaderTab.value = MAIN_HEADER_TABS.EVALUATION;
+			void router.push({ name: VIEWS.WORKFLOW_EVALUATION });
+			break;
+
 		default:
 			break;
 	}

packages/editor-ui/src/components/TagsDropdown.vue

@@ -12,11 +12,11 @@ import { useToast } from '@/composables/useToast';
 interface TagsDropdownProps {
 	placeholder: string;
 	modelValue: string[];
-	createTag: (name: string) => Promise<ITag>;
 	eventBus: EventBus | null;
 	allTags: ITag[];
 	isLoading: boolean;
 	tagsById: Record<string, ITag>;
+	createTag?: (name: string) => Promise<ITag>;
 }
 
 const i18n = useI18n();
@@ -109,6 +109,8 @@ function filterOptions(value = '') {
 }
 
 async function onCreate() {
+	if (!props.createTag) return;
+
 	const name = filter.value;
 	try {
 		const newTag = await props.createTag(name);

packages/editor-ui/src/components/WorkflowEvaluation/EditEvaluation/DescriptionInput.vue

@@ -0,0 +1,39 @@
+<script setup lang="ts">
+interface Props {
+	modelValue: string;
+}
+
+withDefaults(defineProps<Props>(), {
+	modelValue: '',
+});
+
+defineEmits<{ 'update:modelValue': [value: string] }>();
+</script>
+
+<template>
+	<div :class="[$style.formGroup, $style.description]">
+		<n8n-input-label label="Description" :bold="false" size="small" :class="$style.field">
+			<N8nInput
+				:model-value="modelValue"
+				type="textarea"
+				:placeholder="$locale.baseText('workflowEvaluation.edit.descriptionPlaceholder')"
+				@update:model-value="$emit('update:modelValue', $event)"
+			/>
+		</n8n-input-label>
+	</div>
+</template>
+
+<style module lang="scss">
+.formGroup {
+	margin-bottom: var(--spacing-l);
+
+	:global(.n8n-input-label) {
+		margin-bottom: var(--spacing-2xs);
+	}
+}
+
+.field {
+	width: 100%;
+	margin-top: var(--spacing-xs);
+}
+</style>