Don't allow `fetchMore` or updates to polling for `cache-only` queries and exclude from `client.refetchQueries` #12712

jerelmiller · 2025-06-18T06:57:16Z

Fixes #11997

Throws an error when fetchMore is called on a cache-only query. Additionally a warning will be emitted when setting a poll interval on a cache-only query and polling will be cancelled.

cache-only queries are now excluded from refetchQueries when using include: 'all' | 'active' and when listed as a query in include.

cache-only queries are also excluded from client.reFetchObservableQueries when includeStandby is true.

changeset-bot · 2025-06-18T06:57:20Z

🦋 Changeset detected

Latest commit: 0d15e5a

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

pkg-pr-new · 2025-06-18T06:58:42Z

npm i https://pkg.pr.new/apollographql/apollo-client/@apollo/client@12712

commit: 0d15e5a

github-actions · 2025-06-18T06:59:14Z

size-limit report 📦

Path	Size
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (CJS)	42.67 KB (+0.17% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (production) (CJS)	37.75 KB (+0.01% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client"	32.64 KB (+0.32% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (production)	27.01 KB (+0.27% 🔺)
import { ApolloProvider } from "@apollo/client/react"	5.72 KB (+0.68% 🔺)
import { ApolloProvider } from "@apollo/client/react" (production)	963 B (0%)
import { useQuery } from "@apollo/client/react"	7.5 KB (+0.79% 🔺)
import { useQuery } from "@apollo/client/react" (production)	2.7 KB (0%)
import { useLazyQuery } from "@apollo/client/react"	6.97 KB (+0.46% 🔺)
import { useLazyQuery } from "@apollo/client/react" (production)	2.19 KB (-0.09% 🔽)
import { useMutation } from "@apollo/client/react"	6.55 KB (+0.5% 🔺)
import { useMutation } from "@apollo/client/react" (production)	1.76 KB (0%)
import { useSubscription } from "@apollo/client/react"	6.66 KB (+0.65% 🔺)
import { useSubscription } from "@apollo/client/react" (production)	1.86 KB (0%)
import { useSuspenseQuery } from "@apollo/client/react"	8.51 KB (+0.79% 🔺)
import { useSuspenseQuery } from "@apollo/client/react" (production)	3.74 KB (0%)
import { useBackgroundQuery } from "@apollo/client/react"	8.25 KB (+0.55% 🔺)
import { useBackgroundQuery } from "@apollo/client/react" (production)	3.5 KB (0%)
import { useLoadableQuery } from "@apollo/client/react"	8.57 KB (+0.59% 🔺)
import { useLoadableQuery } from "@apollo/client/react" (production)	3.82 KB (0%)
import { useReadQuery } from "@apollo/client/react"	6.46 KB (+0.41% 🔺)
import { useReadQuery } from "@apollo/client/react" (production)	1.69 KB (0%)
import { useFragment } from "@apollo/client/react"	6.51 KB (+0.58% 🔺)
import { useFragment } from "@apollo/client/react" (production)	1.74 KB (0%)

phryneas · 2025-06-18T14:00:44Z

src/__tests__/refetchQueries.ts

+    ).rejects.toEqual(
+      new InvariantError(
+        "Cannot execute `refetch` for 'cache-only' query 'C'. Please use a different fetch policy."
+      )
+    );


What if you have 10 ObservableQuery instances with the same query, but different variables and fetchPolicies and a single one with cache-only?

I think this shouldn't error. It should just be skipped.

Fair enough. Should we at least warn if you provide a specific query to include that is a cache-only query? Or just silently not include it?

phryneas · 2025-06-18T14:04:07Z

src/core/ObservableQuery.ts

+      if (pollInterval && fetchPolicy === "cache-only") {
+        invariant.warn(
+          "Cannot poll on 'cache-only' query '%s' and as such, polling is disabled. Please use a different fetch policy.",
+          getOperationName(this.query, "(anonymous)")
+        );
+      }


reobserve, and as a result updatePolling can be called quite often - this shouldn't warn every time. Maybe only once per ObservableQuery instance?

phryneas · 2025-06-18T14:09:44Z

src/core/QueryManager.ts

+        ) {
+          return;
+        }
+


Suggested change

) {

return;

}

if (oq.options.fetchPolicy === "cache-only") {

return;

}

As a result of my previous comment, this should probably do it.

phryneas

One follow-up question might be if we should also disallow it for standby queries.

jerelmiller · 2025-06-18T14:58:09Z

I started doing this for standby queries but quickly abandoned it because we allow client.refetchQueries({ include: 'all' }) which specifically fetches standby queries. That and client.reFetchObservableQueries(true) also fetches standby queries.

I think limiting it to just cache-only makes sense given the other functionality, otherwise we'd need to rethink refetchQueries with include: 'all' vs active since that list becomes the same and I'm not sure we care to do that right now.

jerelmiller · 2025-06-18T15:55:16Z

src/core/ObservableQuery.ts

+      );
+
+      this.setError(error);
+      return Promise.reject(error);


Let's just throw and avoid emitting an error for fetchMore.

jerelmiller · 2025-06-18T15:55:25Z

src/core/ObservableQuery.ts

@@ -1683,6 +1716,18 @@ Did you mean to call refetch(variables) instead of refetch({ variables })?`,
    });
  }

+  private setError(error: ErrorLike) {


This can go away

jerelmiller · 2025-06-18T15:55:41Z

src/core/ObservableQuery.ts

@@ -660,6 +665,23 @@ export class ObservableQuery<
  public refetch(
    variables?: Partial<TVariables>
  ): ObservableQuery.ResultPromise<QueryResult<TData>> {
+    const { fetchPolicy } = this.options;
+
+    if (fetchPolicy === "cache-only") {


Remove this. We will allow refetch with cache-only queries.

jerelmiller · 2025-06-18T15:56:28Z

src/core/__tests__/ObservableQuery.ts

@@ -1954,6 +2139,44 @@ describe("ObservableQuery", () => {
      expect(observable.options.fetchPolicy).toBe("no-cache");
    });

+    it("does not allow refetch on cache-only query", async () => {


Update to allow this

jerelmiller · 2025-06-18T15:56:51Z

src/core/__tests__/fetchPolicies.ts

@@ -599,7 +600,7 @@ describe("cache-first", () => {
 });

 describe("cache-only", () => {
-  it("allows explicit refetch to happen", async () => {
+  it("does not allow refetch", async () => {


Revert back

jerelmiller · 2025-06-18T15:57:04Z

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

@@ -6080,6 +6080,80 @@ test("rerenders with data: undefined when changing variables and an error is ret
  await expect(takeSnapshot).not.toRerender();
 });

+test("throws when calling `refetch` on a cache-only query", async () => {


jerelmiller · 2025-06-18T15:58:05Z

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

@@ -6418,6 +6464,64 @@ describe("useQuery Hook", () => {
      await expect(takeSnapshot).not.toRerender();
    });

+    it("does not allow refetch on a cache-only query", async () => {


Reverse this

…y query

.changeset/lemon-pans-sit.md

src/core/ObservableQuery.ts

Co-authored-by: Lenz Weber-Tronic <lorenz.weber-tronic@apollographql.com>

…ch-standby-cache-only

jerelmiller requested a review from phryneas June 18, 2025 06:57

This comment was marked as resolved.

Sign in to view

phryneas reviewed Jun 18, 2025

View reviewed changes

jerelmiller commented Jun 18, 2025

View reviewed changes

jerelmiller added 13 commits June 18, 2025 12:43

Don't allow refetch, fetchMore, or polling for a cache-only or standb…

154924c

…y query

Allow refetch on standby query but not cache-only

0c9456a

Add test to ObservableQuery

cec2e4e

Inline helper

99c2e5c

Throw when calling fetchMore on a cache-only query

fc2d209

Use setError in refetch

07b0008

Force emit in setError

100ab5f

Remove invariant in updatePolling for now

ea2eae1

Remove unneeded invariant check

5202ac1

Use optional chaining

982f586

Warn and cancel polling when using a cache-only fetch policy

0fee5b9

Catch on refetch in test

be0940b

Add missing await call

284bf4f

jerelmiller added 10 commits June 18, 2025 13:33

Update useLazyQuery test to allow refetch on cache-only query

036cf2e

Revert change to fetchPolicies tests

584e154

Revert changes to it.each tests

21baae6

Update cache-only refetch ObservableQuery test

70a140d

Synchronously throw and dont' emit result when calling fetchMore

1301fab

Remove setError

9d113ba

Update refetchQueries test when cache-only query listed in include

8951f27

Remove unused imports

8ae8612

Update changesets

4e536fe

Update size limits

de875bc

jerelmiller changed the title ~~Don't allow refetch, fetchMore or updates to polling for cache-only queries~~ Don't allow fetchMore or updates to polling for cache-only queries and exclude from client.refetchQueries Jun 18, 2025

jerelmiller added 2 commits June 18, 2025 14:04

Only warn once

38dd66a

Update size limits

811b2d5

jerelmiller requested a review from phryneas June 18, 2025 20:05

jerelmiller added 2 commits June 18, 2025 14:08

Remove unused imports

2cf00c3

Rerun api report

e616795

phryneas reviewed Jun 18, 2025

View reviewed changes

.changeset/lemon-pans-sit.md Outdated Show resolved Hide resolved

phryneas reviewed Jun 18, 2025

View reviewed changes

src/core/ObservableQuery.ts Outdated Show resolved Hide resolved

jerelmiller and others added 5 commits June 18, 2025 14:37

Tweak changeset

2c95424

Co-authored-by: Lenz Weber-Tronic <lorenz.weber-tronic@apollographql.com>

Only warn in dev

d03869a

Co-authored-by: Lenz Weber-Tronic <lorenz.weber-tronic@apollographql.com>

Fix bad commit

4990b7b

Update size limits

c88c0b6

Merge branch 'release-4.0' into jerel/no-refetch-standby-cache-only

cd8d6d1

jerelmiller added the auto-cleanup 🤖 label Jun 18, 2025

phryneas linked an issue Jun 18, 2025 that may be closed by this pull request

cache-only fetchPolicy results in network request after deleting cached data #11997

Closed

phryneas approved these changes Jun 18, 2025

View reviewed changes

Merge remote-tracking branch 'origin/release-4.0' into jerel/no-refet…

0d15e5a

…ch-standby-cache-only

jerelmiller merged commit bbb2b61 into release-4.0 Jun 18, 2025
42 of 43 checks passed

jerelmiller deleted the jerel/no-refetch-standby-cache-only branch June 18, 2025 21:14

github-actions bot mentioned this pull request Jun 18, 2025

Version Packages (alpha) #12710

Merged

-        ) {
-          return;
-        }
+        if (oq.options.fetchPolicy === "cache-only") {
+          return;
+        }

Don't allow fetchMore or updates to polling for cache-only queries and exclude from client.refetchQueries #12712

Don't allow fetchMore or updates to polling for cache-only queries and exclude from client.refetchQueries #12712

Conversation

jerelmiller commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

pkg-pr-new bot commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

size-limit report 📦

Uh oh!

This comment was marked as resolved.

phryneas Jun 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

phryneas left a comment

Choose a reason for hiding this comment

Uh oh!

jerelmiller commented Jun 18, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Don't allow `fetchMore` or updates to polling for `cache-only` queries and exclude from `client.refetchQueries` #12712

Don't allow `fetchMore` or updates to polling for `cache-only` queries and exclude from `client.refetchQueries` #12712

jerelmiller commented Jun 18, 2025 •

edited

Loading

changeset-bot bot commented Jun 18, 2025 •

edited

Loading

pkg-pr-new bot commented Jun 18, 2025 •

edited

Loading

github-actions bot commented Jun 18, 2025 •

edited

Loading

phryneas Jun 18, 2025 •

edited

Loading