Used AlertError to handle all error responses

zonia3000 · zonia3000 · commit 76d8368d83bd · 2024-07-12T14:59:51.000+02:00
diff --git a/__tests__/StandardErrorAlert.test.js b/__tests__/StandardErrorAlert.test.js
@@ -12,7 +12,7 @@ describe('StandardErrorAlert', () => {
 		expect(result.container.textContent).toContain('error message');
 	});
 
-	it('AlertError with detail message', async () => {
+	it('AlertError with string detail', async () => {
 		const result = render(StandardErrorAlert, {
 			error: new AlertError({ detail: 'error message' })
 		});
@@ -21,6 +21,26 @@ describe('StandardErrorAlert', () => {
 		expect(result.container.textContent).not.toContain('There has been an error');
 	});
 
+	it('AlertError with object detail and __root__ loc', async () => {
+		const result = render(StandardErrorAlert, {
+			error: new AlertError(
+				{
+					detail: [
+						{
+							loc: ['body', '__root__'],
+							msg: 'error message',
+							type: 'value_error'
+						}
+					]
+				},
+				422
+			)
+		});
+		expect(result.container.textContent).toContain('error message');
+		expect(result.container.textContent).not.toContain('detail');
+		expect(result.container.textContent).not.toContain('There has been an error');
+	});
+
 	it('AlertError with generic object message', async () => {
 		const result = render(StandardErrorAlert, {
 			error: new AlertError({ foo: 'bar' })
diff --git a/src/lib/common/errors.js b/src/lib/common/errors.js
@@ -73,8 +73,9 @@ function getSimpleValidationMessage(reason, statusCode) {
 	if (!isValueError(err)) {
 		return null;
 	}
+	const loc = err.loc.length > 1 && err.loc[0] === 'body' ? err.loc.slice(1) : err.loc;
 	return {
-		loc: err.loc.length > 1 && err.loc[0] === 'body' ? err.loc.slice(1) : err.loc,
+		loc: loc.length === 1 && loc[0] === '__root__' ? [] : loc,
 		msg: err.msg
 	};
 }
diff --git a/src/lib/components/common/StandardErrorAlert.svelte b/src/lib/components/common/StandardErrorAlert.svelte
@@ -12,11 +12,15 @@
 
 	function updateErrorMessage() {
 		if (error instanceof AlertError) {
-			if (typeof error.reason === 'string') {
+			const simpleMessage = error.getSimpleValidationMessage();
+			if (simpleMessage) {
+				errorString = simpleMessage;
+				formatAsPre = false;
+			} else if (typeof error.reason === 'string') {
 				errorString = error.reason;
 				formatAsPre = false;
-			} else if ('detail' in error.reason) {
-				errorString = /** @type {string}*/ (error.reason.detail);
+			} else if ('detail' in error.reason && typeof error.reason.detail === 'string') {
+				errorString = error.reason.detail;
 				formatAsPre = false;
 			} else {
 				errorString = JSON.stringify(error.reason, undefined, 2);
@@ -25,7 +29,7 @@
 		} else if (error instanceof Error) {
 			errorString = error.message;
 			formatAsPre = false;
-		} else if (typeof error === 'object' && 'detail' in error) {
+		} else if (typeof error === 'object' && 'detail' in error && typeof error.detail === 'string') {
 			errorString = error.detail;
 			formatAsPre = false;
 		} else {
diff --git a/src/lib/components/v2/admin/UserEditor.svelte b/src/lib/components/v2/admin/UserEditor.svelte
@@ -3,6 +3,7 @@
 	import { page } from '$app/stores';
 	import { nullifyEmptyStrings, removeNullValues } from '$lib/common/component_utilities';
 	import {
+		AlertError,
 		displayStandardErrorAlert,
 		getValidationMessagesMap,
 		validateErrorMapKeys
@@ -75,7 +76,10 @@
 				if (errorsMap && validateErrorMapKeys(errorsMap, handledErrorKeys)) {
 					validationErrors = errorsMap;
 				} else {
-					genericErrorAlert = displayStandardErrorAlert(result, 'genericError');
+					genericErrorAlert = displayStandardErrorAlert(
+						new AlertError(result, response.status),
+						'genericError'
+					);
 				}
 				return;
 			}
diff --git a/src/lib/components/v2/jobs/JobInfoModal.svelte b/src/lib/components/v2/jobs/JobInfoModal.svelte
@@ -1,6 +1,6 @@
 <script>
 	import StatusBadge from '$lib/components/jobs/StatusBadge.svelte';
-	import { displayStandardErrorAlert } from '$lib/common/errors';
+	import { AlertError, displayStandardErrorAlert } from '$lib/common/errors';
 	import { page } from '$app/stores';
 	import Modal from '../../common/Modal.svelte';
 
@@ -37,7 +37,10 @@
 		if (response.ok) {
 			job = result;
 		} else {
-			errorAlert = displayStandardErrorAlert(result, 'workflowJobError');
+			errorAlert = displayStandardErrorAlert(
+				new AlertError(result, response.status),
+				'workflowJobError'
+			);
 		}
 	}
 </script>
diff --git a/src/lib/components/v2/jobs/JobsList.svelte b/src/lib/components/v2/jobs/JobsList.svelte
@@ -6,7 +6,7 @@
 	import JobInfoModal from '$lib/components/v2/jobs/JobInfoModal.svelte';
 	import JobLogsModal from '$lib/components/v2/jobs/JobLogsModal.svelte';
 	import Th from '$lib/components/common/filterable/Th.svelte';
-	import { displayStandardErrorAlert } from '$lib/common/errors';
+	import { AlertError, displayStandardErrorAlert } from '$lib/common/errors';
 	import { onDestroy, onMount } from 'svelte';
 	import { removeDuplicatedItems } from '$lib/common/component_utilities';
 	import StandardDismissableAlert from '../../common/StandardDismissableAlert.svelte';
@@ -63,11 +63,7 @@
 	$: tableHandler.filter(statusFilter, 'status', check.isEqualTo);
 	$: tableHandler.filter(projectFilter, (row) => row.project_dump.id.toString(), check.isEqualTo);
 	$: tableHandler.filter(workflowFilter, (row) => row.workflow_dump.id.toString(), check.isEqualTo);
-	$: tableHandler.filter(
-		datasetFilter,
-		(row) => row.dataset_dump.id.toString(),
-		check.isEqualTo
-	);
+	$: tableHandler.filter(datasetFilter, (row) => row.dataset_dump.id.toString(), check.isEqualTo);
 
 	$: rebuildSlimSelectOptions($rows);
 
@@ -123,8 +119,11 @@
 			jobCancelledMessage = 'Job cancellation request received. The job will stop in a few seconds';
 		} else {
 			console.error('Error stopping job');
-			const errorResponse = await response.json();
-			errorAlert = displayStandardErrorAlert(errorResponse, 'jobUpdatesError');
+			const result = await response.json();
+			errorAlert = displayStandardErrorAlert(
+				new AlertError(result, response.status),
+				'jobUpdatesError'
+			);
 		}
 	}
 
diff --git a/src/lib/components/v2/projects/ProjectInfoModal.svelte b/src/lib/components/v2/projects/ProjectInfoModal.svelte
@@ -1,5 +1,5 @@
 <script>
-	import { displayStandardErrorAlert } from '$lib/common/errors';
+	import { AlertError, displayStandardErrorAlert } from '$lib/common/errors';
 
 	// ProjectInfoModal component
 	import { projectInfoModalV2 } from '$lib/stores/projectStores';
@@ -30,14 +30,14 @@
 				method: 'GET',
 				credentials: 'include'
 			});
+			const result = await response.json();
 			if (response.ok) {
 				/** @type {import('$lib/types-v2.js').DatasetV2[]} */
-				const result = await response.json();
 				result.sort((a, b) => (a.name < b.name ? -1 : a.name > b.name ? 1 : 0));
 				datasets = result;
 			} else {
 				datasetErrorAlert = displayStandardErrorAlert(
-					await response.json(),
+					new AlertError(result, response.status),
 					'errorAlert-projectInfoModal'
 				);
 			}
diff --git a/src/lib/components/v2/tasks/AddSingleTask.svelte b/src/lib/components/v2/tasks/AddSingleTask.svelte
@@ -2,6 +2,7 @@
 	import Ajv from 'ajv';
 	import { replaceEmptyStrings } from '$lib/common/component_utilities';
 	import {
+		AlertError,
 		displayStandardErrorAlert,
 		getValidationMessagesMap,
 		validateErrorMapKeys
@@ -147,7 +148,10 @@
 			if (errorsMap && validateErrorMapKeys(errorsMap, handledErrorKeys)) {
 				validationErrors = errorsMap;
 			} else {
-				errorAlert = displayStandardErrorAlert(result, 'errorAlert-createTask');
+				errorAlert = displayStandardErrorAlert(
+					new AlertError(result, response.status),
+					'errorAlert-createTask'
+				);
 			}
 		}
 	}
diff --git a/src/lib/components/v2/tasks/CustomEnvTask.svelte b/src/lib/components/v2/tasks/CustomEnvTask.svelte
@@ -4,6 +4,7 @@
 	import manifestSchema from './manifest_v2.json';
 	import { replaceEmptyStrings } from '$lib/common/component_utilities';
 	import {
+		AlertError,
 		displayStandardErrorAlert,
 		getValidationMessagesMap,
 		validateErrorMapKeys
@@ -124,7 +125,10 @@
 				if (errorsMap && validateErrorMapKeys(errorsMap, handledErrorKeys)) {
 					validationErrors = errorsMap;
 				} else {
-					errorAlert = displayStandardErrorAlert(result, 'errorAlert-customEnvTask');
+					errorAlert = displayStandardErrorAlert(
+						new AlertError(result, response.status),
+						'errorAlert-customEnvTask'
+					);
 				}
 			}
 		} finally {
diff --git a/src/lib/components/v2/tasks/TaskCollectionLogsModal.svelte b/src/lib/components/v2/tasks/TaskCollectionLogsModal.svelte
@@ -1,5 +1,5 @@
 <script>
-	import { displayStandardErrorAlert } from '$lib/common/errors';
+	import { AlertError, displayStandardErrorAlert } from '$lib/common/errors';
 	import { modalTaskCollectionId } from '$lib/stores/taskStores';
 	import { onDestroy } from 'svelte';
 	import Modal from '../../common/Modal.svelte';
@@ -25,7 +25,10 @@
 				logs = result.data.log;
 			} else {
 				console.error('Failed to fetch collection logs', result);
-				errorAlert = displayStandardErrorAlert(result, 'collectionTaskLogsError');
+				errorAlert = displayStandardErrorAlert(
+					new AlertError(result, response.status),
+					'collectionTaskLogsError'
+				);
 			}
 		}
 	});
diff --git a/src/lib/components/v2/workflow/ArgumentsSchema.svelte b/src/lib/components/v2/workflow/ArgumentsSchema.svelte
@@ -181,7 +181,10 @@
 			unsavedChangesNonParallel = false;
 			onWorkflowTaskUpdated(result);
 		} else {
-			displayStandardErrorAlert(await result, 'task-args-validation-errors');
+			displayStandardErrorAlert(
+				new AlertError(result, response.status),
+				'task-args-validation-errors'
+			);
 		}
 		savingChanges = false;
 	}
diff --git a/src/lib/components/v2/workflow/InputFiltersTab.svelte b/src/lib/components/v2/workflow/InputFiltersTab.svelte
@@ -1,7 +1,7 @@
 <script>
 	import { onMount } from 'svelte';
 	import AttributesTypesForm from '../projects/datasets/AttributesTypesForm.svelte';
-	import { displayStandardErrorAlert } from '$lib/common/errors';
+	import { AlertError, displayStandardErrorAlert } from '$lib/common/errors';
 	import Modal from '$lib/components/common/Modal.svelte';
 
 	/** @type {import("$lib/types-v2").WorkflowV2} */
@@ -65,7 +65,10 @@
 				datasetAttributes = imagePage.attributes;
 				datasetTypes = imagePage.types;
 			} else {
-				errorAlert = displayStandardErrorAlert(result, `errorAlert-inputFilters`);
+				errorAlert = displayStandardErrorAlert(
+					new AlertError(result, response.status),
+					`errorAlert-inputFilters`
+				);
 			}
 			loadingDatasetFilters = false;
 		}
@@ -99,15 +102,19 @@
 				})
 			}
 		);
+		const result = await response.json();
 		if (response.ok) {
 			successfullySaved = true;
 			setTimeout(() => {
 				successfullySaved = false;
 			}, 3000);
 			form.save();
-			updateWorkflowTaskCallback(await response.json());
+			updateWorkflowTaskCallback(result);
 		} else {
-			errorAlert = displayStandardErrorAlert(await response.json(), `errorAlert-inputFilters`);
+			errorAlert = displayStandardErrorAlert(
+				new AlertError(result, response.status),
+				`errorAlert-inputFilters`
+			);
 		}
 		saving = false;
 	}
diff --git a/src/lib/components/v2/workflow/MetaPropertiesForm.svelte b/src/lib/components/v2/workflow/MetaPropertiesForm.svelte
@@ -8,7 +8,7 @@
 	// The form should be structured in multiple levels of depth, and support complex structure.
 	import { page } from '$app/stores';
 	import FormBuilder from '$lib/components/v2/workflow/FormBuilder.svelte';
-	import { displayStandardErrorAlert } from '$lib/common/errors';
+	import { AlertError, displayStandardErrorAlert } from '$lib/common/errors';
 
 	/** @type {import('$lib/types-v2').WorkflowTaskV2} */
 	export let workflowTask;
@@ -76,7 +76,7 @@
 		if (response.ok) {
 			onWorkflowTaskUpdated(result);
 		} else {
-			displayStandardErrorAlert(result, 'metaPropertiesFormError');
+			displayStandardErrorAlert(new AlertError(result, response.status), 'metaPropertiesFormError');
 		}
 	}
 
diff --git a/src/lib/components/v2/workflow/VersionUpdate.svelte b/src/lib/components/v2/workflow/VersionUpdate.svelte
@@ -1,5 +1,5 @@
 <script>
-	import { displayStandardErrorAlert } from '$lib/common/errors';
+	import { AlertError, displayStandardErrorAlert } from '$lib/common/errors';
 	import { page } from '$app/stores';
 	import VersionUpdateFixArgs from './VersionUpdateFixArgs.svelte';
 	import { tick } from 'svelte';
@@ -150,7 +150,11 @@
 		);
 
 		if (!response.ok) {
-			errorAlert = displayStandardErrorAlert(await response.json(), 'versionUpdateError');
+			const result = await response.json();
+			errorAlert = displayStandardErrorAlert(
+				new AlertError(result, response.status),
+				'versionUpdateError'
+			);
 			return;
 		}
 
@@ -169,7 +173,8 @@
 					order: workflowTask.order,
 					meta_non_parallel: workflowTask.meta_non_parallel,
 					meta_parallel: workflowTask.meta_parallel,
-					args_non_parallel: fixArgsComponentNonParallel?.getNewArgs() || workflowTask.args_non_parallel,
+					args_non_parallel:
+						fixArgsComponentNonParallel?.getNewArgs() || workflowTask.args_non_parallel,
 					args_parallel: fixArgsComponentParallel?.getNewArgs() || workflowTask.args_parallel,
 					is_legacy_task: workflowTask.is_legacy_task
 				})
@@ -178,7 +183,10 @@
 
 		const result = await response.json();
 		if (!response.ok) {
-			errorAlert = displayStandardErrorAlert(result, 'versionUpdateError');
+			errorAlert = displayStandardErrorAlert(
+				new AlertError(result, response.status),
+				'versionUpdateError'
+			);
 			return;
 		}
 		updateWorkflowCallback(result);
diff --git a/src/routes/auth/login/+page.svelte b/src/routes/auth/login/+page.svelte
@@ -1,6 +1,6 @@
 <script>
 	import { page } from '$app/stores';
-	import { displayStandardErrorAlert } from '$lib/common/errors.js';
+	import { AlertError, displayStandardErrorAlert } from '$lib/common/errors.js';
 	import { env } from '$env/dynamic/public';
 	import { onMount } from 'svelte';
 	import { invalidateAll } from '$app/navigation';
@@ -26,7 +26,10 @@
 		const response = await fetch(`/api/auth/${oauth2Provider}/authorize`);
 		const result = await response.json();
 		if (!response.ok) {
-			externalLoginErrorAlert = displayStandardErrorAlert(result, 'externalLoginError');
+			externalLoginErrorAlert = displayStandardErrorAlert(
+				new AlertError(result, response.status),
+				'externalLoginError'
+			);
 			return;
 		}
 		window.location.replace(result.authorization_url);
diff --git a/src/routes/profile/+page.svelte b/src/routes/profile/+page.svelte
diff --git a/src/routes/v1/admin/jobs/+page.svelte b/src/routes/v1/admin/jobs/+page.svelte
diff --git a/src/routes/v2/admin/jobs/+page.svelte b/src/routes/v2/admin/jobs/+page.svelte
diff --git a/src/routes/v2/admin/tasks-compatibility/+page.svelte b/src/routes/v2/admin/tasks-compatibility/+page.svelte
diff --git a/src/routes/v2/admin/tasks/+page.svelte b/src/routes/v2/admin/tasks/+page.svelte
diff --git a/src/routes/v2/projects/[projectId]/datasets/[datasetId]/+page.svelte b/src/routes/v2/projects/[projectId]/datasets/[datasetId]/+page.svelte
diff --git a/src/routes/v2/projects/[projectId]/workflows/[workflowId]/+page.svelte b/src/routes/v2/projects/[projectId]/workflows/[workflowId]/+page.svelte

Original file line number	Diff line number	Diff line change
`@@ -73,8 +73,9 @@ function getSimpleValidationMessage(reason, statusCode) {`
`73`	`73`	`if (!isValueError(err)) {`
`74`	`74`	`return null;`
`75`	`75`	`}`
	`76`	`+ const loc = err.loc.length > 1 && err.loc[0] === 'body' ? err.loc.slice(1) : err.loc;`
`76`	`77`	`return {`
`77`		`- loc: err.loc.length > 1 && err.loc[0] === 'body' ? err.loc.slice(1) : err.loc,`
	`78`	`+ loc: loc.length === 1 && loc[0] === '__root__' ? [] : loc,`
`78`	`79`	`msg: err.msg`
`79`	`80`	`};`
`80`	`81`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`	`import Ajv from 'ajv';`
`3`	`3`	`import { replaceEmptyStrings } from '$lib/common/component_utilities';`
`4`	`4`	`import {`
	`5`	`+ AlertError,`
`5`	`6`	`displayStandardErrorAlert,`
`6`	`7`	`getValidationMessagesMap,`
`7`	`8`	`validateErrorMapKeys`
`@@ -147,7 +148,10 @@`
`147`	`148`	`if (errorsMap && validateErrorMapKeys(errorsMap, handledErrorKeys)) {`
`148`	`149`	`validationErrors = errorsMap;`
`149`	`150`	`} else {`
`150`		`- errorAlert = displayStandardErrorAlert(result, 'errorAlert-createTask');`
	`151`	`+ errorAlert = displayStandardErrorAlert(`
	`152`	`+ new AlertError(result, response.status),`
	`153`	`+ 'errorAlert-createTask'`
	`154`	`+ );`
`151`	`155`	`}`
`152`	`156`	`}`
`153`	`157`	`}`