Remove `setOptions` and tweak `reobserve` #12463

jerelmiller · 2025-03-19T23:15:19Z

Make reobserve a public, documented API in ObservableQuery. Removes setOptions as this was pretty much an alias for reobserve without the networkStatus option.

This PR also makes setting the networkStatus in a private way. We didn't like that reobserve let you set whatever you wanted if this was made public, so that argument has been removed. There is now a private way to set this value inside ObservableQuery for the internal functions.

changeset-bot · 2025-03-19T23:15:23Z

🦋 Changeset detected

Latest commit: f15b031

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

This PR includes changesets to release 1 package

Name	Type
@apollo/client	Major

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

svc-apollo-docs · 2025-03-19T23:15:23Z

⚠️ Docs preview not attached to branch

The preview was not built because the PR's base branch release-4.0 is not in the list of sources.

An Apollo team member can comment one of the following commands to dictate which branch to attach the preview to:

!docs set-base-branch version-2.6
!docs set-base-branch main

Build ID: 2f41a13d53e820e738af2532

pkg-pr-new · 2025-03-19T23:16:34Z

npm i https://pkg.pr.new/@apollo/client@12463

commit: f15b031

netlify · 2025-03-19T23:17:11Z

✅ Deploy Preview for apollo-client-docs ready!

Name	Link
🔨 Latest commit	`f15b031`
🔍 Latest deploy log	https://app.netlify.com/sites/apollo-client-docs/deploys/67e1afce8c071900085416fa
😎 Deploy Preview	https://deploy-preview-12463--apollo-client-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

github-actions · 2025-03-19T23:17:14Z

size-limit report 📦

Path	Size
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (CJS)	41.26 KB (+0.36% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (production) (CJS)	36.66 KB (-0.04% 🔽)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client"	31.86 KB (+0.2% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (production)	26.84 KB (+0.01% 🔺)
import { ApolloProvider } from "@apollo/client/react"	5.17 KB (0%)
import { ApolloProvider } from "@apollo/client/react" (production)	960 B (0%)
import { useQuery } from "@apollo/client/react"	7.22 KB (-0.1% 🔽)
import { useQuery } from "@apollo/client/react" (production)	3 KB (-0.23% 🔽)
import { useLazyQuery } from "@apollo/client/react"	6.39 KB (+0.1% 🔺)
import { useLazyQuery } from "@apollo/client/react" (production)	2.17 KB (+0.05% 🔺)
import { useMutation } from "@apollo/client/react"	6.46 KB (0%)
import { useMutation } from "@apollo/client/react" (production)	2.23 KB (0%)
import { useSubscription } from "@apollo/client/react"	6.83 KB (0%)
import { useSubscription } from "@apollo/client/react" (production)	2.62 KB (0%)
import { useSuspenseQuery } from "@apollo/client/react"	8.18 KB (0%)
import { useSuspenseQuery } from "@apollo/client/react" (production)	3.97 KB (0%)
import { useBackgroundQuery } from "@apollo/client/react"	8.02 KB (0%)
import { useBackgroundQuery } from "@apollo/client/react" (production)	3.81 KB (0%)
import { useLoadableQuery } from "@apollo/client/react"	8.06 KB (0%)
import { useLoadableQuery } from "@apollo/client/react" (production)	3.87 KB (0%)
import { useReadQuery } from "@apollo/client/react"	5.82 KB (0%)
import { useReadQuery } from "@apollo/client/react" (production)	1.58 KB (0%)
import { useFragment } from "@apollo/client/react"	5.86 KB (0%)
import { useFragment } from "@apollo/client/react" (production)	1.65 KB (0%)

jerelmiller · 2025-03-19T23:18:20Z

src/core/ObservableQuery.ts

+  /**
+   * Reevaulate the query against the current set of options.
+   */
+  public rerun() {


I called this rerun, but am open to other names. Other names I considered:

reevaluate/evaluate

reexecute/execute

We use reobserve without options in a decent amount of tests and call this in reobserveCacheFirst so I figured there might be a use case for just trying to run the query again against the current set of options. I'm open to hearing otherwise and updating existing tests to observable['reobserve'] if need be, but I'm trying to avoid that. Calling setOptions({}) or refetch doesn't have the same intent as this.

At the same time, introducing a public api that does kinda the same as before feels a bit moot.

Do we think this will be used in userland?

Maybe at that point, it might be better to rename reobserve to rerun and remove setOptions?

jerelmiller · 2025-03-19T23:36:00Z

src/core/ObservableQuery.ts

@@ -669,12 +669,22 @@ Did you mean to call refetch(variables) instead of refetch({ variables })?`,
    };
  }

+  /**
+   * Reevaluate against a new set of options which might cause a fetch.
+   */
  public setOptions(


We should consider if setOptions works the way we'd like it to. The way its implemented is a big reason why I don't like the way setVariables works where it just resolves with the current value if there are no observers.

setVariables({ id: 2 }) with no observers will not call reobserve, but setOptions({ variables: { id: 2 } }) will which could result in a fetch.

I'd prefer some symmetry here if possible. In my mind, either we have all reobserve-based methods execute against reobserve, or we should require an active subscription to run all of them. Otherwise its difficult to know which ones might or might not fetch.

Thoughts?

I agree, this feels like it should behave more like setVariables.

jerelmiller · 2025-03-20T17:07:32Z

Discussed in person. We are going to do a few changes:

Keep reobserve, but remove the newNetworkStatus option. This will be managed by the higher-level calls that call reobserve
Get rid of setOptions. This is just a call to reobserve with new options
Remove rerun. This is just a call to reobserve with no argument

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

jerelmiller · 2025-03-20T18:43:09Z

@phryneas this should be good to look at again as I've made the changes we discussed in our call.

docs/source/api/core/ObservableQuery.mdx

…bserve. Make it public

jerelmiller requested a review from phryneas March 19, 2025 23:15

jerelmiller commented Mar 19, 2025

View reviewed changes

jerelmiller added auto-cleanup 🤖 and removed auto-cleanup 🤖 labels Mar 19, 2025

jerelmiller commented Mar 19, 2025

View reviewed changes

jerelmiller force-pushed the jerel/private-reobserve branch from 30cb465 to 833f899 Compare March 20, 2025 18:35

jerelmiller requested a review from a team as a code owner March 20, 2025 18:35

jerelmiller commented Mar 20, 2025

View reviewed changes

src/react/hooks/__tests__/useQuery.test.tsx Outdated Show resolved Hide resolved

jerelmiller removed the request for review from a team March 20, 2025 18:42

jerelmiller changed the title ~~Make reobserve private~~ Remove setOptions and tweak reobserve Mar 20, 2025

jerelmiller force-pushed the jerel/private-reobserve branch from b2d8c43 to aa91ec6 Compare March 24, 2025 15:19

phryneas approved these changes Mar 24, 2025

View reviewed changes

docs/source/api/core/ObservableQuery.mdx Show resolved Hide resolved

github-actions bot added the auto-cleanup 🤖 label Mar 24, 2025

jerelmiller added 10 commits March 24, 2025 13:11

Mark reobserve as private

49b50ad

Use setOptions/private access in reobserveCacheFirst

2199963

Don't return reobserve from useQuery

66d17e7

Use setOptions in QueryReference and useQuery

77230f9

Use setOptions in tests that used reobserve

f59476d

Add rerun

eae7c4b

Add tsdoc

e05ca97

Use rerun in reobserveCacheFirst

f6f7a2c

Rerun api report

3c7fb20

Add changeset

44b6c69

jerelmiller added 13 commits March 24, 2025 13:12

Mark silentSetOptions as internal

46f8891

Pass newNetworkStatus in a symbol and remove from the argument to reo…

98b7cd2

…bserve. Make it public

Remove setOptions and rerun methods

2e94caf

Use reobserve everywhere that setOptions is used

ada5226

Remove setOptions from ObservableQuery docs

bb7aa18

Rerun api report

49a1699

Use plain symbol

0a9535c

Update size limits

4ab2e32

Update changeset

39ffd3d

Add another changeset

4fdb52a

Rerun api report

d746fc5

Update incorrect comment

6e05950

Add reobserve to ObservableQuery docs

f15b031

jerelmiller force-pushed the jerel/private-reobserve branch from aa91ec6 to f15b031 Compare March 24, 2025 19:17

jerelmiller merged commit 3868df8 into release-4.0 Mar 24, 2025
47 checks passed

jerelmiller deleted the jerel/private-reobserve branch March 24, 2025 19:22

github-actions bot mentioned this pull request Mar 24, 2025

Version Packages (alpha) #12473

Merged

jerelmiller mentioned this pull request Mar 24, 2025

[4.0] Make reobserve a private API #12447

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove `setOptions` and tweak `reobserve` #12463

Remove `setOptions` and tweak `reobserve` #12463

jerelmiller commented Mar 19, 2025 •

edited

Loading

changeset-bot bot commented Mar 19, 2025 •

edited

Loading

svc-apollo-docs commented Mar 19, 2025 •

edited

Loading

pkg-pr-new bot commented Mar 19, 2025 •

edited

Loading

netlify bot commented Mar 19, 2025 •

edited

Loading

github-actions bot commented Mar 19, 2025 •

edited

Loading

jerelmiller Mar 19, 2025 •

edited

Loading

phryneas Mar 20, 2025

jerelmiller Mar 19, 2025

phryneas Mar 20, 2025

jerelmiller commented Mar 20, 2025

jerelmiller commented Mar 20, 2025

Remove setOptions and tweak reobserve #12463

Remove setOptions and tweak reobserve #12463

Conversation

jerelmiller commented Mar 19, 2025 • edited Loading

changeset-bot bot commented Mar 19, 2025 • edited Loading

🦋 Changeset detected

svc-apollo-docs commented Mar 19, 2025 • edited Loading

⚠️ Docs preview not attached to branch

pkg-pr-new bot commented Mar 19, 2025 • edited Loading

netlify bot commented Mar 19, 2025 • edited Loading

✅ Deploy Preview for apollo-client-docs ready!

github-actions bot commented Mar 19, 2025 • edited Loading

size-limit report 📦

jerelmiller Mar 19, 2025 • edited Loading

Choose a reason for hiding this comment

phryneas Mar 20, 2025

Choose a reason for hiding this comment

jerelmiller Mar 19, 2025

Choose a reason for hiding this comment

phryneas Mar 20, 2025

Choose a reason for hiding this comment

jerelmiller commented Mar 20, 2025

jerelmiller commented Mar 20, 2025

Remove `setOptions` and tweak `reobserve` #12463

Remove `setOptions` and tweak `reobserve` #12463

jerelmiller commented Mar 19, 2025 •

edited

Loading

changeset-bot bot commented Mar 19, 2025 •

edited

Loading

svc-apollo-docs commented Mar 19, 2025 •

edited

Loading

pkg-pr-new bot commented Mar 19, 2025 •

edited

Loading

netlify bot commented Mar 19, 2025 •

edited

Loading

github-actions bot commented Mar 19, 2025 •

edited

Loading

jerelmiller Mar 19, 2025 •

edited

Loading