[Refactor] Move tracking of `networkStatus` into `ObservableQuery` #12407

jerelmiller · 2025-03-06T04:33:58Z

networkStatus is really only useful for ObservableQuery as all other promise-based APIs will have a final networkStatus of either ready or error. As such, the fine-grained tracking of networkStatus has been moved to ObservableQuery. This helps us reduce the reliance on QueryInfo some more in an effort to one day eliminate it.

changeset-bot · 2025-03-06T04:34:02Z

🦋 Changeset detected

Latest commit: 1485c05

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-06T04:34:03Z

⚠️ 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: 5c9d2b4eaa91bec4024124a6

jerelmiller · 2025-03-06T04:34:48Z

src/__tests__/optimistic.ts

@@ -1312,7 +1312,6 @@ describe("optimistic mutation results", () => {
    });

    it("will handle dependent updates", async () => {
-      expect.assertions(1);


There is not an assertion hidden in a callback so there is no way the assertion will be missed. This was fairly useless so I removed it.

pkg-pr-new · 2025-03-06T04:35:19Z

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

commit: 67eb2aa

jerelmiller · 2025-03-06T04:41:45Z

src/core/__tests__/ObservableQuery.ts

@@ -284,7 +284,7 @@ describe("ObservableQuery", () => {
      await expect(stream).toEmitApolloQueryResult({
        data: undefined,
        loading: true,
-        networkStatus: NetworkStatus.setVariables,
+        networkStatus: NetworkStatus.refetch,


We should figure out if we like this change. When calling refetch with new variables, the networkStatus would get reported as setVariables rather than refetch, even though refetch was the explicitly requested networkStatus passed to reobserve.

I suppose it depends on whether we view the setVariables status as more specific than refetch in the case of changing variables via refetch.

I think this would be fine, at least it reflects better which method you called.

phryneas

Looks good!

phryneas · 2025-03-11T15:47:16Z

src/core/QueryManager.ts

    });

    const readCache = () => queryInfo.getDiff();

    const resultsFromCache = (
      diff: Cache.DiffResult<TData>,
-      networkStatus = queryInfo.networkStatus || NetworkStatus.loading
+      networkStatus = newNetworkStatus


Note to self: investigate if this ever can cause a race condition now that this is static and doesn't track external mutations.

…assed

netlify · 2025-03-11T17:51:40Z

✅ Deploy Preview for apollo-client-docs ready!

Name	Link
🔨 Latest commit	`1485c05`
🔍 Latest deploy log	https://app.netlify.com/sites/apollo-client-docs/deploys/67d07b5256de80000949df79
😎 Deploy Preview	https://deploy-preview-12407--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-11T17:51:50Z

size-limit report 📦

Path	Size
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (CJS)	42.09 KB (-0.12% 🔽)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (production) (CJS)	37.68 KB (-0.2% 🔽)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client"	32.66 KB (-0.12% 🔽)
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client" (production)	28.22 KB (-0.07% 🔽)
import { ApolloProvider } from "@apollo/client/react"	5.14 KB (0%)
import { ApolloProvider } from "@apollo/client/react" (production)	1.05 KB (0%)
import { useQuery } from "@apollo/client/react"	7.26 KB (0%)
import { useQuery } from "@apollo/client/react" (production)	3.19 KB (0%)
import { useLazyQuery } from "@apollo/client/react"	7.6 KB (0%)
import { useLazyQuery } from "@apollo/client/react" (production)	3.5 KB (0%)
import { useMutation } from "@apollo/client/react"	6.51 KB (0%)
import { useMutation } from "@apollo/client/react" (production)	2.41 KB (0%)
import { useSubscription } from "@apollo/client/react"	6.93 KB (0%)
import { useSubscription } from "@apollo/client/react" (production)	2.85 KB (0%)
import { useSuspenseQuery } from "@apollo/client/react"	8.19 KB (0%)
import { useSuspenseQuery } from "@apollo/client/react" (production)	4.12 KB (0%)
import { useBackgroundQuery } from "@apollo/client/react"	8.03 KB (0%)
import { useBackgroundQuery } from "@apollo/client/react" (production)	3.96 KB (0%)
import { useLoadableQuery } from "@apollo/client/react"	8.08 KB (0%)
import { useLoadableQuery } from "@apollo/client/react" (production)	4.02 KB (0%)
import { useReadQuery } from "@apollo/client/react"	5.73 KB (0%)
import { useReadQuery } from "@apollo/client/react" (production)	1.63 KB (0%)
import { useFragment } from "@apollo/client/react"	5.78 KB (0%)
import { useFragment } from "@apollo/client/react" (production)	1.68 KB (0%)

jerelmiller added the 👩‍🏭 refactor label Mar 6, 2025

jerelmiller requested a review from phryneas March 6, 2025 04:33

jerelmiller commented Mar 6, 2025

View reviewed changes

jerelmiller force-pushed the jerel/rxjs branch from a440d00 to 1dbb17e Compare March 7, 2025 22:39

jerelmiller force-pushed the jerel/network-status-refactor branch from b7cdc81 to 3e3585f Compare March 10, 2025 17:12

phryneas approved these changes Mar 11, 2025

View reviewed changes

Base automatically changed from jerel/rxjs to release-4.0 March 11, 2025 17:14

jerelmiller added 19 commits March 11, 2025 11:46

Track networkStatus in ObservableQuery

cd1b766

Update tests with incorrect networkStatus

d327832

Always pass networkStatus to resultsFromCache

f42c39b

Pass through oldNetworkStatus

57d9340

Set networkStatus to refetch when refetching with new vars

94c9f06

Remove unneeded check on assertions

f895989

Update condition on shouldNotify

1f80bf3

Update network status in fetchPolicies tests

102a4ac

Update networkStatus on observableQuery

1613d1f

Remove networkStatus from QueryInfo

19eb49a

Remove markReady

87c76d8

Inline implementation of markError

52a0c39

Don't pass networkStatus to queryInfo

829f8aa

Use refetch network status

c855cbe

Infer networkStatus as setVariables if no explicit networkStatus is p…

535cf9e

…assed

Rerun api report

6c64ca5

Default to new networkStatus if not passed

a0dd00f

Require argument

8ad7af0

Don't handle default network status in multiple places

10a55e8

jerelmiller added 4 commits March 11, 2025 11:49

Pass whether loading state should be emitted

a1057c2

Use boolean passed to logic to determine whether to emit loading state

f8e0805

Rerun api report

f30172c

Fix failing useQuery test

25a7177

jerelmiller force-pushed the jerel/network-status-refactor branch from 3e3585f to 25a7177 Compare March 11, 2025 17:49

jerelmiller added the auto-cleanup 🤖 label Mar 11, 2025

Add changeset

67eb2aa

jerelmiller force-pushed the jerel/network-status-refactor branch from c087aa9 to 67eb2aa Compare March 11, 2025 18:02

Clean up Prettier, Size-limit, and Api-Extractor

1485c05

jerelmiller merged commit 8b1390b into release-4.0 Mar 11, 2025
37 checks passed

jerelmiller deleted the jerel/network-status-refactor branch March 11, 2025 18:10

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

Version Packages (alpha) #12221

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Refactor] Move tracking of `networkStatus` into `ObservableQuery` #12407

[Refactor] Move tracking of `networkStatus` into `ObservableQuery` #12407

jerelmiller commented Mar 6, 2025

changeset-bot bot commented Mar 6, 2025 •

edited

Loading

svc-apollo-docs commented Mar 6, 2025 •

edited

Loading

jerelmiller Mar 6, 2025 •

edited

Loading

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

edited

Loading

jerelmiller Mar 6, 2025

phryneas Mar 11, 2025

phryneas left a comment

phryneas Mar 11, 2025

netlify bot commented Mar 11, 2025 •

edited

Loading

github-actions bot commented Mar 11, 2025 •

edited

Loading

[Refactor] Move tracking of networkStatus into ObservableQuery #12407

[Refactor] Move tracking of networkStatus into ObservableQuery #12407

Conversation

jerelmiller commented Mar 6, 2025

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

🦋 Changeset detected

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

⚠️ Docs preview not attached to branch

jerelmiller Mar 6, 2025 • edited Loading

Choose a reason for hiding this comment

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

jerelmiller Mar 6, 2025

Choose a reason for hiding this comment

phryneas Mar 11, 2025

Choose a reason for hiding this comment

phryneas left a comment

Choose a reason for hiding this comment

phryneas Mar 11, 2025

Choose a reason for hiding this comment

netlify bot commented Mar 11, 2025 • edited Loading

✅ Deploy Preview for apollo-client-docs ready!

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

size-limit report 📦

[Refactor] Move tracking of `networkStatus` into `ObservableQuery` #12407

[Refactor] Move tracking of `networkStatus` into `ObservableQuery` #12407

changeset-bot bot commented Mar 6, 2025 •

edited

Loading

svc-apollo-docs commented Mar 6, 2025 •

edited

Loading

jerelmiller Mar 6, 2025 •

edited

Loading

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

edited

Loading

netlify bot commented Mar 11, 2025 •

edited

Loading

github-actions bot commented Mar 11, 2025 •

edited

Loading