Merge branch 'release-3.8' into return-networkstatus-from-usesuspensequery

Author: jerelmiller

.changeset/silver-radios-chew.md

@@ -0,0 +1,5 @@
+---
+'@apollo/client': patch
+---
+
+Ensure `refetch`, `fetchMore`, and `subscribeToMore` functions returned by `useSuspenseQuery` are referentially stable between renders, even as `data` is updated.

src/react/hooks/__tests__/useSuspenseQuery.test.tsx

@@ -504,6 +504,43 @@ describe('useSuspenseQuery', () => {
     expect(result.current).toBe(previousResult);
   });
 
+  it('ensures refetch, fetchMore, and subscribeToMore are referentially stable even after result data has changed', async () => {
+    const { query, mocks } = useSimpleQueryCase();
+
+    const client = new ApolloClient({
+      link: new MockLink(mocks),
+      cache: new InMemoryCache(),
+    });
+
+    const { result } = renderSuspenseHook(() => useSuspenseQuery(query), {
+      client,
+    });
+
+    await waitFor(() => {
+      expect(result.current).toMatchObject({
+        ...mocks[0].result,
+        error: undefined,
+      });
+    });
+
+    const previousResult = result.current;
+
+    client.writeQuery({
+      query,
+      data: { greeting: 'Updated cache greeting' },
+    });
+
+    await waitFor(() => {
+      expect(result.current.data).toEqual({
+        greeting: 'Updated cache greeting',
+      });
+    });
+
+    expect(result.current.fetchMore).toBe(previousResult.fetchMore);
+    expect(result.current.refetch).toBe(previousResult.refetch);
+    expect(result.current.subscribeToMore).toBe(previousResult.subscribeToMore);
+  });
+
   it('enables canonical results when canonizeResults is "true"', async () => {
     interface Result {
       __typename: string;

src/react/hooks/useSuspenseQuery.ts

@@ -37,12 +37,27 @@ export interface UseSuspenseQueryResult<
   client: ApolloClient<any>;
   data: TData;
   error: ApolloError | undefined;
-  fetchMore: ObservableQueryFields<TData, TVariables>['fetchMore'];
+  fetchMore: FetchMoreFunction<TData, TVariables>;
   networkStatus: NetworkStatus;
-  refetch: ObservableQueryFields<TData, TVariables>['refetch'];
-  subscribeToMore: ObservableQueryFields<TData, TVariables>['subscribeToMore'];
+  refetch: RefetchFunction<TData, TVariables>;
+  subscribeToMore: SubscribeToMoreFunction<TData, TVariables>;
 }
 
+type FetchMoreFunction<
+  TData,
+  TVariables extends OperationVariables
+> = ObservableQueryFields<TData, TVariables>['fetchMore'];
+
+type RefetchFunction<
+  TData,
+  TVariables extends OperationVariables
+> = ObservableQueryFields<TData, TVariables>['refetch'];
+
+type SubscribeToMoreFunction<
+  TData,
+  TVariables extends OperationVariables
+> = ObservableQueryFields<TData, TVariables>['subscribeToMore'];
+
 const SUPPORTED_FETCH_POLICIES: WatchQueryFetchPolicy[] = [
   'cache-first',
   'network-only',
@@ -148,35 +163,56 @@ export function useSuspenseQuery_experimental<
     };
   }, []);
 
+  const fetchMore: FetchMoreFunction<TData, TVariables> = useCallback(
+    (options) => {
+      const promise = observable.fetchMore(options);
+
+      suspenseCache.add(query, watchQueryOptions.variables, {
+        promise,
+        observable,
+      });
+
+      return promise;
+    },
+    [observable]
+  );
+
+  const refetch: RefetchFunction<TData, TVariables> = useCallback(
+    (variables) => {
+      const promise = observable.refetch(variables);
+
+      suspenseCache.add(query, watchQueryOptions.variables, {
+        promise,
+        observable,
+      });
+
+      return promise;
+    },
+    [observable]
+  );
+
+  const subscribeToMore: SubscribeToMoreFunction<TData, TVariables> =
+    useCallback((options) => observable.subscribeToMore(options), [observable]);
+
   return useMemo(() => {
     return {
       client,
       data: result.data,
       error: errorPolicy === 'ignore' ? void 0 : toApolloError(result),
       networkStatus: result.networkStatus,
-      fetchMore: (options) => {
-        const promise = observable.fetchMore(options);
-
-        suspenseCache.add(query, watchQueryOptions.variables, {
-          promise,
-          observable,
-        });
-
-        return promise;
-      },
-      refetch: (variables?: Partial<TVariables>) => {
-        const promise = observable.refetch(variables);
-
-        suspenseCache.add(query, watchQueryOptions.variables, {
-          promise,
-          observable,
-        });
-
-        return promise;
-      },
-      subscribeToMore: (options) => observable.subscribeToMore(options),
+      fetchMore,
+      refetch,
+      subscribeToMore,
     };
-  }, [client, result, observable, errorPolicy]);
+  }, [
+    client,
+    fetchMore,
+    refetch,
+    result,
+    observable,
+    errorPolicy,
+    subscribeToMore,
+  ]);
 }
 
 function validateOptions(options: WatchQueryOptions) {