Fix useSubscription restart was not cached (#12044)

Co-authored-by: Lenz Weber-Tronic <[email protected]>
apollographql · Sep 3, 2024 · 04462a2 · 04462a2
1 parent a67727e
commit 04462a2
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 17 deletions.
diff --git a/.api-reports/api-report-react.api.md b/.api-reports/api-report-react.api.md
@@ -2228,7 +2228,7 @@ export interface UseReadQueryResult<TData = unknown> {
 
 // @public
 export function useSubscription<TData = any, TVariables extends OperationVariables = OperationVariables>(subscription: DocumentNode | TypedDocumentNode<TData, TVariables>, options?: SubscriptionHookOptions<NoInfer_2<TData>, NoInfer_2<TVariables>>): {
-    restart(): void;
+    restart: () => void;
     loading: boolean;
     data?: TData | undefined;
     error?: ApolloError;

diff --git a/.api-reports/api-report-react_hooks.api.md b/.api-reports/api-report-react_hooks.api.md
@@ -2061,7 +2061,7 @@ export interface UseReadQueryResult<TData = unknown> {
 //
 // @public
 export function useSubscription<TData = any, TVariables extends OperationVariables = OperationVariables>(subscription: DocumentNode | TypedDocumentNode<TData, TVariables>, options?: SubscriptionHookOptions<NoInfer_2<TData>, NoInfer_2<TVariables>>): {
-    restart(): void;
+    restart: () => void;
     loading: boolean;
     data?: TData | undefined;
     error?: ApolloError;

diff --git a/.api-reports/api-report.api.md b/.api-reports/api-report.api.md
@@ -2889,7 +2889,7 @@ export interface UseReadQueryResult<TData = unknown> {
 
 // @public
 export function useSubscription<TData = any, TVariables extends OperationVariables = OperationVariables>(subscription: DocumentNode | TypedDocumentNode<TData, TVariables>, options?: SubscriptionHookOptions<NoInfer_2<TData>, NoInfer_2<TVariables>>): {
-    restart(): void;
+    restart: () => void;
     loading: boolean;
     data?: TData | undefined;
     error?: ApolloError;

diff --git a/.changeset/old-ghosts-agree.md b/.changeset/old-ghosts-agree.md
@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Cache the `useSubscription` hook's `restart` function definition between re-renders.
diff --git a/.size-limits.json b/.size-limits.json
@@ -1,4 +1,4 @@
 {
-  "dist/apollo-client.min.cjs": 40242,
+  "dist/apollo-client.min.cjs": 40249,
   "import { ApolloClient, InMemoryCache, HttpLink } from \"dist/index.js\" (production)": 33058
 }
diff --git a/src/react/hooks/useSubscription.ts b/src/react/hooks/useSubscription.ts
@@ -304,19 +304,16 @@ export function useSubscription<
       : fallbackResult,
     () => fallbackResult
   );
-  return React.useMemo(
-    () => ({
-      ...ret,
-      restart() {
-        invariant(
-          !optionsRef.current.skip,
-          "A subscription that is skipped cannot be restarted."
-        );
-        setObservable(recreateRef.current());
-      },
-    }),
-    [ret]
-  );
+
+  const restart = React.useCallback(() => {
+    invariant(
+      !optionsRef.current.skip,
+      "A subscription that is skipped cannot be restarted."
+    );
+    setObservable(recreateRef.current());
+  }, [optionsRef, recreateRef]);
+
+  return React.useMemo(() => ({ ...ret, restart }), [ret, restart]);
 }
 
 function createSubscription<