Merge branch 'main' into dev-1.17

Author: zonia3000

CHANGELOG.md

@@ -1,5 +1,9 @@
 *Note: Numbers like (\#123) point to closed Pull Requests on the fractal-web repository.*
 
+# 1.16.1
+
+* Improved handling of new default values in task version update (\#731);
+
 # 1.16.0
 
 * Used `FRACTAL_BACKEND_RUNNER=local` instead of `local_experimental` (\#713);

__tests__/v2/VersionUpdate.test.js

@@ -1,4 +1,4 @@
-import { describe, it, expect, vi } from 'vitest';
+import { beforeEach, describe, it, expect, vi } from 'vitest';
 import { fireEvent, render, screen } from '@testing-library/svelte';
 import { readable } from 'svelte/store';
 
@@ -169,6 +169,66 @@ const taskGroups = /** @type {import('fractal-components/types/api').TaskGroupV2
 			}
 		],
 		active: true
+	},
+	{
+		id: 9,
+		pkg_name: 'default_values',
+		version: '0.0.1',
+		task_list: [
+			{
+				id: 9,
+				name: 'task_default_values',
+				type: 'non_parallel',
+				args_schema_non_parallel: {
+					title: 'task_default_values',
+					type: 'object',
+					properties: {
+						default_boolean1: {
+							type: 'boolean',
+							default: false
+						}
+					},
+					additionalProperties: false
+				},
+				args_schema_parallel: null,
+				taskgroupv2_id: 9
+			}
+		],
+		active: true
+	},
+	{
+		id: 10,
+		pkg_name: 'default_values',
+		version: '0.0.2',
+		task_list: [
+			{
+				id: 10,
+				name: 'task_default_values',
+				type: 'non_parallel',
+				args_schema_non_parallel: {
+					title: 'task_default_values',
+					type: 'object',
+					properties: {
+						default_boolean1: {
+							type: 'boolean',
+							default: false
+						},
+						default_boolean2: {
+							type: 'boolean',
+							default: true
+						},
+						default_string: {
+							type: 'string',
+							default: 'foo'
+						}
+					},
+					additionalProperties: false
+				},
+				args_schema_parallel: null,
+				taskgroupv2_id: 10
+			}
+		],
+		active: true
 	}
 ]);
 
@@ -202,6 +262,10 @@ function getMockedWorkflowTask() {
 }
 
 describe('VersionUpdate', () => {
+	beforeEach(() => {
+		fetch.mockClear();
+	});
+	
 	it('update task without changing the arguments', async () => {
 		const task = getTask('My Task', '1.2.3');
 		const versions = /** @type {string[]} */ (
@@ -340,6 +404,64 @@ describe('VersionUpdate', () => {
 			)
 		).toBeDefined();
 	});
+
+	it('update task with default parameters and no previous values', async () => {
+		const task = getTask('task_default_values', '0.0.1');
+		const versions = await checkVersions(task, 1);
+		expect(versions[0]).toBe('0.0.2');
+
+		await fireEvent.change(screen.getByRole('combobox'), { target: { value: '0.0.2' } });
+
+		const btn = screen.getByRole('button', { name: 'Update' });
+		expect(btn.disabled).eq(false);
+		await fireEvent.click(btn);
+
+		expect(fetch).toHaveBeenNthCalledWith(
+			2,
+			expect.stringContaining('/wftask/replace-task'),
+			expect.objectContaining({
+				body: JSON.stringify({
+					args_non_parallel: {
+						default_boolean1: false,
+						default_boolean2: true,
+						default_string: 'foo',
+					},
+					args_parallel: null
+				})
+			})
+		);
+	});
+
+	it('update task with default parameters and previous values', async () => {
+		const task = getTask('task_default_values', '0.0.1');
+		const versions = await checkVersions(task, 1, {
+			args_non_parallel: {
+				default_boolean1: true,
+			}, args_parallel: null
+		});
+		expect(versions[0]).toBe('0.0.2');
+
+		await fireEvent.change(screen.getByRole('combobox'), { target: { value: '0.0.2' } });
+
+		const btn = screen.getByRole('button', { name: 'Update' });
+		expect(btn.disabled).eq(false);
+		await fireEvent.click(btn);
+
+		expect(fetch).toHaveBeenNthCalledWith(
+			2,
+			expect.stringContaining('/wftask/replace-task'),
+			expect.objectContaining({
+				body: JSON.stringify({
+					args_non_parallel: {
+						default_boolean1: true,
+						default_boolean2: true,
+						default_string: 'foo',
+					},
+					args_parallel: null
+				})
+			})
+		);
+	});
 });
 
 /**

docs/version-compatibility.md

@@ -4,6 +4,7 @@ The following table shows which `fractal-server` versions are compatible with wh
 
 | fractal-web | fractal-server |
 |-------------|----------------|
+| 1.16.1      | 2.13.1         |
 | 1.16.0      | 2.13.1         |
 | 1.15.0      | 2.11.0         |
 | 1.14.0      | 2.10.1         |

package-lock.json

@@ -1,6 +1,6 @@
 {
 	"name": "fractal-web",
-	"version": "1.16.0",
+	"version": "1.16.1",
 	"private": true,
 	"scripts": {
 		"dev": "vite dev",

package.json

@@ -159,7 +159,7 @@
 		headers.set('Content-Type', 'application/json');
 
 		const response = await fetch(
-			`/api/v2/project/${$page.params.projectId}/workflow/${workflowTask.workflow_id}/wftask/replace-task/?workflow_task_id=${workflowTask.id}&task_id=${newTaskId}`,
+			`/api/v2/project/${$page.params.projectId}/workflow/${workflowTask.workflow_id}/wftask/replace-task?workflow_task_id=${workflowTask.id}&task_id=${newTaskId}`,
 			{
 				method: 'POST',
 				credentials: 'include',

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

@@ -1,7 +1,13 @@
 <script>
 	import { deepCopy } from '$lib/common/component_utilities';
 	import { AlertError } from '$lib/common/errors';
-	import { stripIgnoredProperties, getPropertiesToIgnore, SchemaValidator } from 'fractal-components';
+	import {
+		stripIgnoredProperties,
+		getPropertiesToIgnore,
+		SchemaValidator,
+		stripNullAndEmptyObjectsAndArrays
+	} from 'fractal-components';
+	import { getJsonSchemaData } from 'fractal-components/jschema/jschema_initial_data';
 
 	/** @type {import('fractal-components/types/api').WorkflowTaskV2} */
 	export let workflowTask;
@@ -53,34 +59,32 @@
 	export function checkArgumentsWithNewSchema() {
 		const oldArgs = (parallel ? workflowTask.args_parallel : workflowTask.args_non_parallel) || {};
 		originalArgs = JSON.stringify(oldArgs, null, 2);
-		validateArguments(oldArgs);
+		const newArgs = { ...getDefaultValues(), ...oldArgs };
+		validateArguments(newArgs);
 		return displayTextarea;
 	}
 
 	export function getNewArgs() {
-		argsToBeFixed !== ''
-			? JSON.parse(argsToBeFixed)
-			: (parallel ? workflowTask.args_parallel : workflowTask.args_non_parallel) || {};
+		if (argsToBeFixed !== '') {
+			return JSON.parse(argsToBeFixed);
+		}
+		const args = (parallel ? workflowTask.args_parallel : workflowTask.args_non_parallel) || {};
+		return { ...getDefaultValues(), ...args };
+	}
+
+	function getDefaultValues() {
+		const newSchema = getNewSchema();
+		const schemaDefaultData = getJsonSchemaData(newSchema, updateCandidate.args_schema_version);
+		return stripNullAndEmptyObjectsAndArrays(schemaDefaultData || {});
 	}
 
 	/**
 	 * @param {object} args
 	 */
 	function validateArguments(args) {
-		let newSchema =
-			/** @type {import('fractal-components/types/jschema').JSONSchemaObjectProperty} */ (
-				'args_schema' in updateCandidate
-					? updateCandidate.args_schema
-					: parallel
-					? updateCandidate.args_schema_parallel
-					: updateCandidate.args_schema_non_parallel
-			);
+		const newSchema = getNewSchema();
 		const validator = new SchemaValidator(updateCandidate.args_schema_version, true);
-		if ('properties' in newSchema) {
-			newSchema = stripIgnoredProperties(newSchema, getPropertiesToIgnore(false));
-		}
-		const parsedSchema = deepCopy(newSchema);
-		const isSchemaValid = validator.loadSchema(parsedSchema);
+		const isSchemaValid = validator.loadSchema(newSchema);
 		if (!isSchemaValid) {
 			throw new AlertError('Invalid JSON schema');
 		}
@@ -94,6 +98,21 @@
 		}
 	}
 
+	function getNewSchema() {
+		let newSchema =
+			/** @type {import('fractal-components/types/jschema').JSONSchemaObjectProperty} */ (
+				'args_schema' in updateCandidate
+					? updateCandidate.args_schema
+					: parallel
+					? updateCandidate.args_schema_parallel
+					: updateCandidate.args_schema_non_parallel
+			);
+		if ('properties' in newSchema) {
+			newSchema = stripIgnoredProperties(newSchema, getPropertiesToIgnore(false));
+		}
+		return deepCopy(newSchema);
+	}
+
 	export function hasValidationErrors() {
 		return (validationErrors?.length || 0) > 0;
 	}