@prismicio/react 2.0.0-beta.8 → 2.0.2

package/src/useStatefulPrismicClientMethod.ts

@@ -71,24 +71,6 @@ export type HookOnlyParameters = {
 	skip?: boolean;
 };
 
-const getParamHookDependencies = (
-	params: NonNullable<ClientMethodParameters<"get">[0]>,
-) => {
-	return [
-		params.ref,
-		params.lang,
-		params.page,
-		params.after,
-		params.fetch,
-		params.pageSize,
-		params.orderings,
-		params.fetchLinks,
-		params.graphQuery,
-		params.predicates,
-		params.accessToken,
-	];
-};
-
 /**
  * Determines if a value is a `@prismicio/client` params object.
  *
@@ -157,8 +139,13 @@ export const useStatefulPrismicClientMethod = <
 
 	React.useEffect(
 		() => {
+			// Used to prevent dispatching an action if the hook was cleaned up.
+			let didCancel = false;
+
 			if (!skip) {
-				dispatch(["start"]);
+				if (!didCancel) {
+					dispatch(["start"]);
+				}
 
 				client[methodName]
 					.call(
@@ -167,20 +154,35 @@ export const useStatefulPrismicClientMethod = <
 						...argsWithoutParams,
 						params,
 					)
-					.then((result) => dispatch(["succeed", result as TData]))
-					.catch((error) => dispatch(["fail", error]));
+					.then((result) => {
+						if (!didCancel) {
+							dispatch(["succeed", result as TData]);
+						}
+					})
+					.catch((error) => {
+						if (!didCancel) {
+							dispatch(["fail", error]);
+						}
+					});
 			}
+
+			// Ensure we don't dispatch an action if the hook is cleaned up.
+			() => {
+				didCancel = true;
+			};
 		},
-		// We must disable exhaustive-deps to optimize providing `params` deps.
+		// We must disable exhaustive-deps since we are using
+		// JSON.stringify on params (effectively a deep equality check).
+		// We want this effect to run again anytime params change.
 		// eslint-disable-next-line react-hooks/exhaustive-deps
 		[
 			client,
-			skip,
 			methodName,
+			skip,
 			// eslint-disable-next-line react-hooks/exhaustive-deps
-			...argsWithoutParams,
+			JSON.stringify(argsWithoutParams),
 			// eslint-disable-next-line react-hooks/exhaustive-deps
-			...getParamHookDependencies(params),
+			JSON.stringify(params),
 		],
 	);