Merge pull request #466 from fractal-analytics-platform/default-task-continuing-workflow

Workflow execution modal improvements

Author: zonia3000

CHANGELOG.md

@@ -19,6 +19,8 @@
     * supported editing of single dataset images (\#457);
     * used switches to represent boolean flags (\#457);
     * implemented continue/restart workflow (\#465);
+    * set default first task when continuing a workflow (\#466);
+    * displayed applied filters in workflow execution modal (\#466);
 
 # 0.10.2
 

__tests__/job_utilities.test.js

@@ -2,7 +2,8 @@ import { it, expect } from 'vitest';
 import {
 	extractJobErrorParts,
 	extractRelevantJobError,
-	generateNewUniqueDatasetName
+	generateNewUniqueDatasetName,
+	getFirstTaskIndexForContinuingWorkflow
 } from '$lib/common/job_utilities.js';
 
 const completeTracebackError = `TASK ERROR:Task id: 15 (Create OME-Zarr structure), e.workflow_task_order=0
@@ -237,6 +238,19 @@ it('generates new unique dataset name', () => {
 	);
 });
 
+it('get first task index for continuing workflow', () => {
+	expect(testGetFirstTaskIndexForContinuingWorkflow([null, null, null, null])).toEqual(0);
+	expect(testGetFirstTaskIndexForContinuingWorkflow(['done', 'done', null, null])).toEqual(2);
+	expect(testGetFirstTaskIndexForContinuingWorkflow(['done', 'failed', 'done', null])).toEqual(1);
+	expect(testGetFirstTaskIndexForContinuingWorkflow(['done', null, 'done', null])).toEqual(1);
+	expect(testGetFirstTaskIndexForContinuingWorkflow(['done', 'done', 'done', 'done'])).toEqual(
+		undefined
+	);
+	expect(testGetFirstTaskIndexForContinuingWorkflow(['submitted', 'failed', null, null])).toEqual(
+		undefined
+	);
+});
+
 /**
  * @param {string[]} names
  */
@@ -245,3 +259,20 @@ function getMockedDatasets(names) {
 		return { id: index + 1, name };
 	});
 }
+
+/**
+ * @param {Array<string|null>} values
+ * @returns {number|undefined}
+ */
+function testGetFirstTaskIndexForContinuingWorkflow(values) {
+	const workflowTasks = values.map((_, i) => {
+		return {
+			id: i + 1,
+			order: i
+		};
+	});
+	const statuses = Object.fromEntries(
+		values.map((v, i) => [i + 1, v]).filter((e) => e[1] !== null)
+	);
+	return getFirstTaskIndexForContinuingWorkflow(workflowTasks, statuses);
+}

__tests__/v2/RunWorkflowModal.test.js

@@ -0,0 +1,135 @@
+import { describe, it, expect, vi } from 'vitest';
+import { fireEvent, render } from '@testing-library/svelte';
+import { readable } from 'svelte/store';
+
+// Mocking fetch
+global.fetch = vi.fn();
+
+// Mocking the page store
+vi.mock('$app/stores', () => {
+	return {
+		page: readable({
+			data: {
+				userInfo: { slurm_accounts: [] }
+			}
+		})
+	};
+});
+
+// Mocking bootstrap.Modal
+class MockModal {
+	show = vi.fn();
+	hide = vi.fn();
+}
+MockModal.getInstance = vi.fn();
+
+global.window.bootstrap = {
+	Modal: MockModal
+};
+
+import RunWorkflowModal from '../../src/lib/components/v2/workflow/RunWorkflowModal.svelte';
+
+const dataset1 = {
+	id: 1,
+	filters: {
+		attributes: {
+			k1: 'dataset-value1',
+			k3: 'dataset-value3'
+		},
+		types: {
+			t1: false,
+			t3: true
+		}
+	}
+};
+
+const workflow1 = {
+	id: 1,
+	task_list: [
+		{
+			id: 1,
+			task: { name: 'task1' },
+			input_filters: {
+				attributes: { k1: 'wft-value1', k2: 'wft-value2' },
+				types: { t1: true, t2: false }
+			}
+		}
+	]
+};
+
+describe('RunWorkflowModal', () => {
+	it('When continuing a workflow, show applied filters prioritizing the first workflow task filters', async () => {
+		const result = render(RunWorkflowModal, {
+			datasets: [dataset1],
+			selectedDatasetId: 1,
+			workflow: workflow1,
+			onJobSubmitted: vi.fn(),
+			onDatasetsUpdated: vi.fn(),
+			statuses: { 1: 'failed' }
+		});
+
+		result.component.open('continue');
+		await fireEvent.click(result.getByRole('button', { name: 'Run' }));
+
+		const items = await result.findAllByRole('listitem');
+
+		expect(items.length).toEqual(6);
+		expect(result.getByText('k1:').innerHTML).toContain('wft-value1');
+		expect(result.getByText('k2:').innerHTML).toContain('wft-value2');
+		expect(result.getByText('k3:').innerHTML).toContain('dataset-value3');
+		expect(result.getByText('t1:').innerHTML).toContain('text-success');
+		expect(result.getByText('t2:').innerHTML).toContain('text-danger');
+		expect(result.getByText('t3:').innerHTML).toContain('text-success');
+	});
+
+	it('When restarting a workflow, show applied filters from workflow task only', async () => {
+		const result = render(RunWorkflowModal, {
+			datasets: [dataset1],
+			selectedDatasetId: 1,
+			workflow: workflow1,
+			onJobSubmitted: vi.fn(),
+			onDatasetsUpdated: vi.fn(),
+			statuses: { 1: 'done' }
+		});
+
+		result.component.open('restart');
+		await fireEvent.click(result.getByRole('button', { name: 'Run' }));
+
+		const items = await result.findAllByRole('listitem');
+
+		expect(items.length).toEqual(4);
+		expect(result.getByText('k1:').innerHTML).toContain('wft-value1');
+		expect(result.getByText('k2:').innerHTML).toContain('wft-value2');
+		expect(result.getByText('t1:').innerHTML).toContain('text-success');
+		expect(result.getByText('t2:').innerHTML).toContain('text-danger');
+	});
+
+	it('Handles empty filters list', async () => {
+		const result = render(RunWorkflowModal, {
+			datasets: [
+				{
+					id: 1,
+					filters: { attributes: {}, types: {} }
+				}
+			],
+			selectedDatasetId: 1,
+			workflow: {
+				id: 1,
+				task_list: [
+					{
+						id: 1,
+						task: { name: 'task1' },
+						input_filters: { attributes: {}, types: {} }
+					}
+				]
+			},
+			onJobSubmitted: vi.fn(),
+			onDatasetsUpdated: vi.fn(),
+			statuses: { 1: 'failed' }
+		});
+
+		result.component.open('continue');
+		await fireEvent.click(result.getByRole('button', { name: 'Run' }));
+		expect(result.getByText('No filters')).toBeDefined();
+	});
+});

src/lib/common/job_utilities.js

@@ -133,3 +133,16 @@ export function generateNewUniqueDatasetName(datasets, selectedDatasetName) {
 	} while (datasets.filter((d) => d.name === newDatasetName).length > 0);
 	return newDatasetName;
 }
+
+/**
+ * @param {Array<import("$lib/types-v2").WorkflowTaskV2>} workflowTasks
+ * @param {{[key: number]: import('$lib/types').JobStatus}} statuses
+ * @returns {number|undefined}
+ */
+export function getFirstTaskIndexForContinuingWorkflow(workflowTasks, statuses) {
+	if (workflowTasks.find((wft) => statuses[wft.id] === 'submitted')) {
+		// we can't re-submit while something is running
+		return undefined;
+	}
+	return workflowTasks.find((wft) => !(wft.id in statuses) || statuses[wft.id] === 'failed')?.order;
+}

src/lib/components/common/BooleanIcon.svelte

@@ -19,6 +19,6 @@
 		font-weight: bold;
 		margin: 0 -5px -5px -5px;
 		line-height: 0;
-		display: block;
+		display: inline-block;
 	}
 </style>

src/lib/components/v2/projects/datasets/DatasetFiltersModal.svelte

@@ -49,7 +49,7 @@
 				const result = await response.json();
 				if (!response.ok) {
 					console.log('Dataset update failed', result);
-					throw new AlertError(await response.json());
+					throw new AlertError(result);
 				}
 				updateDatasetCallback(result);
 			},