Merge pull request #796 from fractal-analytics-platform/task_run_schema_update

Handled args schema changes in workflow task runs

Author: zonia3000

CHANGELOG.md

@@ -3,6 +3,7 @@
 # Unreleased
 
 * Used new API endpoint to detect task version upgrade (\#792);
+* Handled arguments schema changes in workflow task runs (\#796);
 
 # 1.18.0
 

__tests__/errors.test.js

@@ -1,5 +1,5 @@
 import { describe, it, expect } from 'vitest';
-import { getFieldValidationError } from '../src/lib/common/errors';
+import { getFieldValidationError, getValidationMessagesMap } from '../src/lib/common/errors';
 
 describe('Error utility functions', () => {
 	it('get field validation error without specifying loc', () => {
@@ -17,4 +17,41 @@ describe('Error utility functions', () => {
 		);
 		expect(error).eq('value is not a valid list');
 	});
+
+	it('get validation errors array', () => {
+		const errorMap = getValidationMessagesMap(
+			{
+				detail: [
+					{
+						type: 'string_too_short',
+						loc: ['body', 'viewer_paths', 1],
+						msg: 'String should have at least 1 character',
+						input: '',
+						ctx: {
+							min_length: 1
+						}
+					},
+					{
+						type: 'value_error',
+						loc: ['body', 'viewer_paths', 3],
+						msg: "Value error, String must be an absolute path (given 'foobar').",
+						input: 'foobar',
+						ctx: {
+							error: {}
+						}
+					}
+				]
+			},
+			422
+		);
+
+		/** @type {string[]} */
+		const errors = /** @type {string[]} */ ((errorMap && errorMap['viewer_paths']) || []);
+
+		expect(errors.length).toEqual(4);
+		expect(errors[0]).toBeUndefined();
+		expect(errors[1]).toEqual('String should have at least 1 character');
+		expect(errors[2]).toBeUndefined();
+		expect(errors[3]).toEqual("Value error, String must be an absolute path (given 'foobar').");
+	});
 });

__tests__/v2/AddSingleTask.test.js

@@ -47,6 +47,7 @@ describe('AddSingleTask', () => {
 			expect.objectContaining({
 				body: JSON.stringify({
 					name: 'test-task',
+					type: 'non_parallel',
 					command_non_parallel: 'command',
 					input_types: {},
 					output_types: {}
@@ -81,6 +82,7 @@ describe('AddSingleTask', () => {
 			expect.objectContaining({
 				body: JSON.stringify({
 					name: 'test-task',
+					type: 'non_parallel',
 					command_non_parallel: 'command',
 					input_types: {},
 					output_types: {}

components/src/lib/types/api.d.ts

@@ -311,8 +311,12 @@ export type HistoryUnit = {
 
 export type HistoryRunAggregated = {
 	id: number;
+	timestamp_started: string;
+	version: string | null;
 	workflowtask_dump: WorkflowTaskV2;
 	num_submitted_units: number;
 	num_done_units: number;
 	num_failed_units: number;
+	args_schema_parallel: JSONSchemaObjectProperty | null;
+	args_schema_non_parallel: JSONSchemaObjectProperty | null;
 };

src/lib/common/errors.js

@@ -154,7 +154,7 @@ function extractFieldValidationError(simpleValidationMessage, loc) {
 /**
  * @param {any} reason
  * @param {number | null} statusCode
- * @returns {null | { [key: string]: string }}
+ * @returns {null | { [key: string]: string | string[] }}
  */
 export function getValidationMessagesMap(reason, statusCode) {
 	if (!isValidationError(reason, statusCode)) {
@@ -163,16 +163,25 @@ export function getValidationMessagesMap(reason, statusCode) {
 	if (!Array.isArray(reason.detail) || reason.detail.length === 0) {
 		return null;
 	}
-	/** @type {{[key: string]: string}} */
+	/** @type {{[key: string]: string | string[]}} */
 	const map = {};
 	for (const error of reason.detail) {
 		if (!hasValidationErrorPayload(error)) {
 			return null;
 		}
-		if (error.loc.length !== 2 || error.loc[0] !== 'body') {
+		if (error.loc[0] !== 'body') {
+			return null;
+		}
+		if (error.loc.length === 2) {
+			map[error.loc[1]] = error.msg;
+		} else if (error.loc.length === 3 && typeof error.loc[2] === 'number') {
+			if (!(error.loc[1] in map)) {
+				map[error.loc[1]] = [];
+			}
+			/** @type {string[]} */ (map[error.loc[1]])[error.loc[2]] = error.msg;
+		} else {
 			return null;
 		}
-		map[error.loc[1]] = error.msg;
 	}
 	return map;
 }
@@ -294,7 +303,7 @@ export class FormErrorHandler {
 	 * Returns true if all the keys of the error map are handled by the current page or component.
 	 * Used to decide if it possible to show user friendly validation messages
 	 * or if it is necessary to display a generic error message.
-	 * @param {{[key:string]: string}} errorsMap
+	 * @param {{[key:string]: string | string[] }} errorsMap
 	 * @return {boolean}
 	 */
 	validateErrorMapKeys(errorsMap) {

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

@@ -48,7 +48,7 @@
 		extraButtons
 	} = $props();
 
-	let imagesStatusFilter = '';
+	let imagesStatusFilter = $state('');
 
 	let showTable = $state(false);
 	let firstLoad = true;
@@ -711,8 +711,8 @@
 								<div class="row">
 									<div class="col">
 										<div class="attribute-select-wrapper mb-1">
-											<select id="attribute-{getIdFromValue(attributeKey)}" class="invisible"
-											></select>
+											<select id="attribute-{getIdFromValue(attributeKey)}" class="invisible">
+											</select>
 										</div>
 									</div>
 								</div>
@@ -734,8 +734,8 @@
 								class:btn-secondary={!applyBtnActive}
 							>
 								{#if searching}
-									<span class="spinner-border spinner-border-sm" role="status" aria-hidden="true"
-									></span>
+									<span class="spinner-border spinner-border-sm" role="status" aria-hidden="true">
+									</span>
 								{/if}
 								Apply
 							</button>
@@ -747,8 +747,8 @@
 								class:btn-secondary={!resetBtnActive}
 							>
 								{#if resetting}
-									<span class="spinner-border spinner-border-sm" role="status" aria-hidden="true"
-									></span>
+									<span class="spinner-border spinner-border-sm" role="status" aria-hidden="true">
+									</span>
 								{/if}
 								Reset
 							</button>

src/lib/components/v2/tasks/AddSingleTask.svelte

@@ -4,7 +4,13 @@
 	import StandardDismissableAlert from '../../common/StandardDismissableAlert.svelte';
 	import TaskGroupSelector from './TaskGroupSelector.svelte';
 	import TypesEditor from './TypesEditor.svelte';
-	import { detectSchemaVersion, SchemaValidator } from 'fractal-components';
+	import {
+		detectSchemaVersion,
+		isCompoundType,
+		isNonParallelType,
+		isParallelType,
+		SchemaValidator
+	} from 'fractal-components';
 
 	/**
 	 * @typedef {Object} Props
@@ -36,6 +42,7 @@
 
 	const formErrorHandler = new FormErrorHandler('errorAlert-createTask', [
 		'name',
+		'type',
 		'command_non_parallel',
 		'command_parallel',
 		'version',
@@ -94,6 +101,7 @@
 
 		const bodyData = {
 			name,
+			type: taskType,
 			command_non_parallel,
 			command_parallel,
 			version,
@@ -350,40 +358,22 @@
 	}}
 >
 	<div class="row mb-1">
-		<div class="col-xl-1 col-lg-2 col-3">Task type</div>
-		<div class="col-xl-11 col-lg-8 col-9">
-			<div class="form-check form-check-inline">
-				<input
-					class="form-check-input"
-					type="radio"
-					name="taskType"
-					id="non_parallel"
-					value="non_parallel"
-					bind:group={taskType}
-				/>
-				<label class="form-check-label" for="non_parallel"> Non parallel </label>
-			</div>
-			<div class="form-check form-check-inline">
-				<input
-					class="form-check-input"
-					type="radio"
-					name="taskType"
-					id="parallel"
-					value="parallel"
-					bind:group={taskType}
-				/>
-				<label class="form-check-label" for="parallel">Parallel</label>
-			</div>
-			<div class="form-check form-check-inline">
-				<input
-					class="form-check-input"
-					type="radio"
-					name="taskType"
-					id="compound"
-					value="compound"
-					bind:group={taskType}
-				/>
-				<label class="form-check-label" for="compound">Compound</label>
+		<div class="col-md-6 mb-2">
+			<div class="input-group has-validation">
+				<label for="task_type" class="input-group-text">Task type</label>
+				<select
+					class="form-select"
+					bind:value={taskType}
+					class:is-invalid={$validationErrors['type']}
+					id="task_type"
+				>
+					<option value="non_parallel">Non parallel</option>
+					<option value="parallel">Parallel</option>
+					<option value="compound">Compound</option>
+					<option value="converter_non_parallel">Converter Non Parallel</option>
+					<option value="converter_compound">Converter Compound</option>
+				</select>
+				<span class="invalid-feedback">{$validationErrors['type']}</span>
 			</div>
 		</div>
 	</div>
@@ -404,7 +394,7 @@
 			</div>
 		</div>
 	</div>
-	{#if taskType === 'non_parallel' || taskType === 'compound'}
+	{#if isNonParallelType(taskType) || isCompoundType(taskType)}
 		<div class="row">
 			<div class="col-12 mb-2">
 				<div class="input-group has-validation">
@@ -423,7 +413,7 @@
 			</div>
 		</div>
 	{/if}
-	{#if taskType === 'parallel' || taskType === 'compound'}
+	{#if isParallelType(taskType) || isCompoundType(taskType)}
 		<div class="row">
 			<div class="col-12 mb-2">
 				<div class="input-group has-validation">
@@ -468,7 +458,7 @@
 			</div>
 		</div>
 	</div>
-	{#if taskType === 'non_parallel' || taskType === 'compound'}
+	{#if isNonParallelType(taskType) || isCompoundType(taskType)}
 		<div class="row">
 			<div class="col-lg-6 mb-2">
 				<div class="input-group has-validation">
@@ -526,7 +516,7 @@
 			</div>
 		</div>
 	{/if}
-	{#if taskType === 'parallel' || taskType === 'compound'}
+	{#if isParallelType(taskType) || isCompoundType(taskType)}
 		<div class="row">
 			<div class="col-lg-6 mb-2">
 				<div class="input-group has-validation">

src/lib/components/v2/workflow/AddWorkflowTaskModal.svelte

@@ -6,6 +6,8 @@
 	import { removeIdenticalTaskGroups } from 'fractal-components/tasks/task_group_utilities';
 	import { formatMarkdown } from '$lib/common/component_utilities';
 	import { tick } from 'svelte';
+	import { getJsonSchemaData } from 'fractal-components/jschema/jschema_initial_data';
+	import { stripNullAndEmptyObjectsAndArrays } from 'fractal-components';
 
 	/**
 	 * @typedef {Object} Props
@@ -57,17 +59,33 @@
 			async () => {
 				addingTask = true;
 
+				const task = await getTask(taskId);
+
 				const headers = new Headers();
 				headers.set('Content-Type', 'application/json');
 
 				// Creating workflow task
+				const defaultData = {};
+
+				if (task.args_schema_parallel) {
+					defaultData.args_parallel = stripNullAndEmptyObjectsAndArrays(
+						getJsonSchemaData(task.args_schema_parallel, 'pydantic_v2')
+					);
+				}
+
+				if (task.args_schema_non_parallel) {
+					defaultData.args_non_parallel = stripNullAndEmptyObjectsAndArrays(
+						getJsonSchemaData(task.args_schema_non_parallel, 'pydantic_v2')
+					);
+				}
+
 				const workflowTaskResponse = await fetch(
-					`/api/v2/project/${workflow.project_id}/workflow/${workflow.id}/wftask?task_id=${taskId}`,
+					`/api/v2/project/${workflow.project_id}/workflow/${workflow.id}/wftask?task_id=${task.id}`,
 					{
 						method: 'POST',
 						credentials: 'include',
 						headers,
-						body: JSON.stringify({})
+						body: JSON.stringify(defaultData)
 					}
 				);
 
@@ -99,6 +117,23 @@
 		);
 	}
 
+	/**
+	 * @param {number} taskId
+	 * @returns {Promise<import('fractal-components/types/api').TaskV2>}
+	 */
+	async function getTask(taskId) {
+		const response = await fetch(`/api/v2/task/${taskId}`, {
+			method: 'GET',
+			credentials: 'include'
+		});
+
+		if (!response.ok) {
+			throw await getAlertErrorFromResponse(response);
+		}
+
+		return await response.json();
+	}
+
 	/**
 	 * @param {import('fractal-components/types/api').TasksTableRow} taskRow
 	 */

src/lib/components/v2/workflow/ArgumentsSchema.svelte

@@ -35,6 +35,8 @@
 	 * @property {import('fractal-components/types/api').WorkflowTaskV2} workflowTask
 	 * @property {(wft: import('fractal-components/types/api').WorkflowTaskV2) => void} onWorkflowTaskUpdated
 	 * @property {boolean} [editable]
+	 * @property {import('fractal-components/types/jschema').JSONSchemaObjectProperty|null} argsSchemaNonParallel
+	 * @property {import('fractal-components/types/jschema').JSONSchemaObjectProperty|null} argsSchemaParallel
 	 * @property {object|undefined} [argsNonParallel]
 	 * @property {object|undefined} [argsParallel]
 	 */
@@ -44,6 +46,8 @@
 		workflowTask = $bindable(),
 		onWorkflowTaskUpdated,
 		editable = true,
+		argsSchemaNonParallel = null,
+		argsSchemaParallel = null,
 		argsNonParallel = undefined,
 		argsParallel = undefined
 	} = $props();
@@ -206,8 +210,6 @@
 			unsavedChangesFormBuilderNonParallel
 	);
 	let isSchemaValid = $derived(argsSchemaVersionValid(workflowTask.task.args_schema_version));
-	let argsSchemaNonParallel = $derived(workflowTask.task.args_schema_non_parallel);
-	let argsSchemaParallel = $derived(workflowTask.task.args_schema_parallel);
 	let schemaVersion = $derived(workflowTask.task.args_schema_version);
 	let propertiesToIgnore = $derived(getPropertiesToIgnore(false));
 </script>