Protect: Update use fixers query error prop handling

projects/plugins/protect/changelog/update-protect-use-fixers-response-error-prop-handling

@@ -0,0 +1,4 @@
+Significance: patch
+Type: changed
+
+Adds handling for FixerStatus error props

projects/plugins/protect/src/js/data/scan/use-fixers-mutation.ts

@@ -16,6 +16,20 @@ export default function useFixersMutation(): UseMutationResult {
 	return useMutation( {
 		mutationFn: API.fixThreats,
 		onSuccess: data => {
+			// Handle a top level error
+			if ( data?.error ) {
+				throw new Error( data.error );
+			}
+
+			const isThreatLevelError = Object.values( data?.threats ).every(
+				( threat: { error?: string } ) => Boolean( threat?.error )
+			);
+
+			// Handle a threat level error
+			if ( isThreatLevelError ) {
+				throw new Error();
+			}
+
 			// The data returned from the API is the same as the data we need to update the cache.
 			queryClient.setQueryData( [ QUERY_FIXERS_KEY ], data );
 

projects/plugins/protect/src/js/data/scan/use-fixers-query.ts

@@ -74,16 +74,21 @@ export default function useFixersQuery( {
 				| FixersStatus
 				| undefined;
 
+			// Handle a top level error
+			if ( data?.error ) {
+				throw new Error( data?.error );
+			}
+
 			const successes: string[] = [];
 			const failures: string[] = [];
 
 			Object.keys( data?.threats || {} ).forEach( threatId => {
-				const threat = data.threats[ threatId ];
+				const threat = data?.threats[ threatId ];
 				const cachedThreat = cachedData?.threats?.[ threatId ];
 
 				if ( cachedThreat?.status === 'in_progress' ) {
 					// If still in progress
-					if ( threat.status === 'in_progress' ) {
+					if ( threat?.status === 'in_progress' ) {
 						if (
 							! fixerTimestampIsStale( cachedThreat.last_updated ) &&
 							fixerTimestampIsStale( threat.last_updated )
@@ -93,13 +98,14 @@ export default function useFixersQuery( {
 					}
 
 					// Handle completion of fixers
-					if ( threat.status !== 'in_progress' ) {
+					if ( threat?.status !== 'in_progress' ) {
 						queryClient.invalidateQueries( { queryKey: [ QUERY_SCAN_STATUS_KEY ] } );
 						queryClient.invalidateQueries( { queryKey: [ QUERY_HISTORY_KEY ] } );
 
-						if ( threat.status === 'fixed' ) {
+						if ( threat?.status === 'fixed' ) {
 							successes.push( threatId );
 						} else {
+							// Handle unsuccessful statuses and threat level errors
 							failures.push( threatId );
 						}
 					}
@@ -117,8 +123,8 @@ export default function useFixersQuery( {
 				return false;
 			}
 
-			const inProgressNotStale = Object.values( query.state.data.threats ).some(
-				( threat: { status: string; last_updated: string } ) =>
+			const inProgressNotStale = Object.values( query.state.data?.threats ).some(
+				( threat: { status?: string; last_updated?: string } ) =>
 					threat.status === 'in_progress' && ! fixerTimestampIsStale( threat.last_updated )
 			);
 

projects/plugins/protect/src/js/types/fixers.ts

@@ -2,12 +2,14 @@ export type FixerStatus = 'not_started' | 'in_progress' | 'fixed' | 'not_fixed';
 
 export type FixersStatus = {
 	ok: boolean;
-	threats: {
+	error?: string;
+	threats?: {
 		[ key: number ]: ThreatFixStatus;
 	};
 };
 
 export type ThreatFixStatus = {
-	status: FixerStatus;
-	last_updated: string;
+	error?: string;
+	status?: FixerStatus;
+	last_updated?: string;
 };