Deprecate `partial` and ensure its correctness. Fix type of `data` in `ApolloQueryResult` #12333

jerelmiller · 2025-01-31T21:33:05Z

Closes #12332

This change aims to bring more consistency to the emitted results from the core API with the following changes:

Makes the partial flag a non-optional property that is now emitted with every ApolloQueryResult
Deprecates the partial flag. A followup solution will be provided with [4.0] Add a new status enum to ApolloQueryResult that describes the state of data #12344
Always sets a data property on the emitted result instead of omitting it when it would otherwise be undefined. This aligns the runtime behavior with the TypeScript type which specifies data as a non-optional property.
Updates ApolloQueryResult to specify data as TData | undefined to align it with the runtime behavior where an undefined result can be emitted from the core API.

changeset-bot · 2025-01-31T21:33:09Z

🦋 Changeset detected

Latest commit: a8da500

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-01-31T21:33:44Z

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

pkg-pr-new · 2025-01-31T21:34:01Z

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

commit: c7189bb

github-actions · 2025-01-31T21:34:17Z

size-limit report 📦

Path	Size
dist/apollo-client.min.cjs	33.47 KB (+0.02% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs"	41.42 KB (+0.01% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" (production)	38.72 KB (+0.02% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js"	36.14 KB (-0.02% 🔽)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" (production)	33.56 KB (+0.02% 🔺)
import { ApolloProvider } from "dist/react/index.js"	1.26 KB (0%)
import { ApolloProvider } from "dist/react/index.js" (production)	1.24 KB (0%)
import { useQuery } from "dist/react/index.js"	5.13 KB (+0.27% 🔺)
import { useQuery } from "dist/react/index.js" (production)	4.22 KB (+0.31% 🔺)
import { useLazyQuery } from "dist/react/index.js"	5.62 KB (+0.21% 🔺)
import { useLazyQuery } from "dist/react/index.js" (production)	4.7 KB (+0.34% 🔺)
import { useMutation } from "dist/react/index.js"	3.62 KB (0%)
import { useMutation } from "dist/react/index.js" (production)	2.84 KB (0%)
import { useSubscription } from "dist/react/index.js"	4.44 KB (+0.16% 🔺)
import { useSubscription } from "dist/react/index.js" (production)	3.49 KB (+0.23% 🔺)
import { useSuspenseQuery } from "dist/react/index.js"	5.52 KB (+0.2% 🔺)
import { useSuspenseQuery } from "dist/react/index.js" (production)	4.18 KB (+0.22% 🔺)
import { useBackgroundQuery } from "dist/react/index.js"	5 KB (-0.2% 🔽)
import { useBackgroundQuery } from "dist/react/index.js" (production)	3.65 KB (-0.33% 🔽)
import { useLoadableQuery } from "dist/react/index.js"	5.08 KB (-0.25% 🔽)
import { useLoadableQuery } from "dist/react/index.js" (production)	3.73 KB (-0.29% 🔽)
import { useReadQuery } from "dist/react/index.js"	3.4 KB (-0.38% 🔽)
import { useReadQuery } from "dist/react/index.js" (production)	3.34 KB (-0.44% 🔽)
import { useFragment } from "dist/react/index.js"	2.01 KB (0%)
import { useFragment } from "dist/react/index.js" (production)	1.95 KB (0%)

jerelmiller · 2025-01-31T21:34:17Z

src/core/ObservableQuery.ts

@@ -1081,9 +1080,7 @@ Did you mean to call refetch(variables) instead of refetch({ variables })?`,
    // because the query may be using the @nonreactive directive, and we want to
    // save the the latest version of any nonreactive subtrees (in case
    // getCurrentResult is called), even though we skip broadcasting changes.
-    if (lastError || !result.partial || this.options.returnPartialData) {


Now that cache.diff is returning null for empty results or incomplete data, we no longer need this check as the value reported to this function is the correct value.

netlify · 2025-01-31T21:34:44Z

✅ Deploy Preview for apollo-client-docs ready!

Name	Link
🔨 Latest commit	`a8da500`
🔍 Latest deploy log	https://app.netlify.com/sites/apollo-client-docs/deploys/67a3ae0922528d0008b86365
😎 Deploy Preview	https://deploy-preview-12333--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.

jerelmiller · 2025-01-31T21:35:20Z

src/react/internal/cache/QueryReference.ts

@@ -517,10 +517,7 @@ export class InternalQueryReference<TData = unknown> {

    this.result = result;
    this.promise =
-      (
-        result.data &&
-        (!result.partial || this.watchQueryOptions.returnPartialData)


Similarly, we don't need this check anymore since result.data will always be null if there is no data to report.

jerelmiller · 2025-01-31T21:48:18Z

src/core/types.ts

@@ -141,7 +141,7 @@ export type { QueryOptions as PureQueryOptions };
 export type OperationVariables = Record<string, any>;

 export interface ApolloQueryResult<T> {


Eventually I'd like to make this type a bit smarter so that we can handle DeepPartial<TData> when complete is false, but I'll leave that to a separate PR.

phryneas · 2025-02-05T14:37:27Z

src/__tests__/dataMasking.ts

@@ -1345,7 +1345,7 @@ describe("client.watchQuery", () => {
    const { data } = await queryStream.takeNext();
    const fragmentObservable = client.watchFragment({
      fragment,
-      from: data.currentUser,
+      from: data!.currentUser,


I know it's the correct thing to do, but this will be so annoying for our users :sad:

phryneas · 2025-02-05T14:40:21Z

.changeset/rich-kids-carry.md

+"@apollo/client": major
+---
+
+Fix type of `data` property on `ApolloQueryResult`. Previously this field was non-optional, non-null `TData`, however at runtime this value could be set to `undefined`. This field is now reported as `TData | undefined`.


Maybe we should call out here that this might need quite a lot of code adjustments?

yeah, this will be a huge pain, and somehow counter-intuitive at first glance. But ultimately it is the way to go. I just wish we had a way to tell Apollo "I pinky-promise I will never use partial result in my entire project", and then the typing (and actual value) can never be undefined

@PowerKiKi I'm hoping that we can get #12350 in there which would help this situation a lot since we can narrow the type of data based on whether its empty, partial, or complete. We are bike shedding on the name, but will likely get this in there.

phryneas · 2025-02-05T14:49:14Z

src/core/types.ts

@@ -141,7 +141,7 @@ export type { QueryOptions as PureQueryOptions };
 export type OperationVariables = Record<string, any>;

 export interface ApolloQueryResult<T> {


phryneas · 2025-02-05T14:52:24Z

src/core/__tests__/ObservableQuery.ts

+        complete: true,
+        partial: false,


This feels like a blocker for a 4.0 release to me.

Do we track somewhere that this has to be done as a follow-up before we can release a 4.0?

Created #12345 to call this out

phryneas · 2025-02-05T15:07:13Z

src/react/hooks/useQuery.ts

@@ -733,7 +736,7 @@ export function toQueryResult<TData, TVariables extends OperationVariables>(
  observable: ObservableQuery<TData, TVariables>,
  client: ApolloClient<object>
 ): InternalQueryResult<TData, TVariables> {
-  const { data, partial, ...resultWithoutPartial } = result;
+  const { data, complete, partial, ...resultWithoutPartial } = result;


I'm actually a bit confused here (unrelated to this PR) - why do we have a returnPartialData option, but neither complete nor partial on the useQuery result?

Agreed. As discussed in person, this will be done in a separate PR so we can add it to all the hooks.

jerelmiller added 20 commits January 31, 2025 13:15

Allow undefined for data in ApolloQueryResult.

4f2b333

Switch partial flag to complete

5b8c46e

Update fromData to only set complete flag for returnPartialData

11280e1

Only set complete in getCurrentResult if returnPartialData is used

ae96d61

Add todo

9d11289

Set complete flag on link results if returnPartialData is true

aa21470

Ensure data property is set on result from getCurrentResult

1e2cc1f

Use toEqualApolloQueryResult

4f3e575

Fix failing ObservableQuery tests with change to partial flag

b533d29

Inline validateWarnings in each test

c2c2c92

Fix ApolloClient/general tests affected by change to partial flag

9377877

Fix fetchPolicies tests affected by change

98e7199

Fix type tests in ApolloClient

3e07fad

Switch destructure of partial to complete in useQuery

7b830a9

Use non null assertion in data masking tests

8693db0

Use non null assertion in fetch more tests

9b42ecc

Use toEmitApolloQueryResult in client test

2a763df

Fix type issues in useQuery tests

a0268c5

Fix additional types

a8dbcbb

Remove unneeded conditional on ObservableQuery and QueryReference

206d741

jerelmiller added this to the Release 4.0 milestone Jan 31, 2025

jerelmiller commented Jan 31, 2025

View reviewed changes

Add changeset

0b0ffad

jerelmiller commented Jan 31, 2025

View reviewed changes

jerelmiller added 16 commits February 4, 2025 17:33

Check for complete/partial flags in local-state/resolvers tests

6ab04c8

Check for complete/partial flags in fetchPolicies tests

c3a30d5

Check for complete/partial flags in useQuery tests

2cc598c

Don't set partial in toQueryResult

9e26035

Fix ts issues in useQuery

c310320

Fix ts issue in useSuspenseQuery

3f6c4f3

Update useSuspenseQuery tests affected by change

3c266b8

Update useLazyQuery tests affected by change

b94949e

Update useMutation tests affected by change

275b687

Update failing local-state/general tests

682b04b

Update failing fetchMore tests

1395838

Fix failing subscribeToMore tests

756c330

Update failing refetchQueries tests

667a7d4

Update api report and size limits

5f97142

Update failing fragmentRegistry tests

7c6a9d7

Update failing policies tests

6519a65

phryneas approved these changes Feb 5, 2025

View reviewed changes

github-actions bot added the auto-cleanup 🤖 label Feb 5, 2025

jerelmiller mentioned this pull request Feb 5, 2025

[4.0] Add a new status enum to ApolloQueryResult that describes the state of data #12344

Open

jerelmiller and others added 5 commits February 5, 2025 10:54

Remove complete flag

23e42eb

Remove complete checks in all tests

05548d9

Update changeset

96c8a87

Update changeset

c7189bb

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

a8da500

jerelmiller changed the title ~~Change partial to complete and only set it when returnPartialData is true~~ Deprecate partial and ensure its correctness. Fix type of data in ApolloQueryResult Feb 5, 2025

jerelmiller merged commit 3e4beaa into release-4.0 Feb 5, 2025
40 checks passed

jerelmiller deleted the jerel/partial-flag branch February 5, 2025 18:53

github-actions bot mentioned this pull request Jan 31, 2025

Version Packages (alpha) #12221

Merged

jerelmiller mentioned this pull request Feb 5, 2025

[4.0] Only set the partial flag if returnPartialData is set on query options. #12332

Closed

github-actions bot locked as resolved and limited conversation to collaborators Apr 5, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Deprecate `partial` and ensure its correctness. Fix type of `data` in `ApolloQueryResult` #12333

Deprecate `partial` and ensure its correctness. Fix type of `data` in `ApolloQueryResult` #12333

jerelmiller commented Jan 31, 2025 •

edited

Loading

changeset-bot bot commented Jan 31, 2025 •

edited

Loading

svc-apollo-docs commented Jan 31, 2025 •

edited

Loading

pkg-pr-new bot commented Jan 31, 2025 •

edited

Loading

github-actions bot commented Jan 31, 2025 •

edited

Loading

jerelmiller Jan 31, 2025

netlify bot commented Jan 31, 2025 •

edited

Loading

jerelmiller Jan 31, 2025

jerelmiller Jan 31, 2025

phryneas Feb 5, 2025

phryneas Feb 5, 2025

phryneas Feb 5, 2025

PowerKiKi Mar 5, 2025 •

edited

Loading

jerelmiller Mar 6, 2025

phryneas Feb 5, 2025

phryneas Feb 5, 2025

jerelmiller Feb 5, 2025

phryneas Feb 5, 2025

jerelmiller Feb 5, 2025

		@@ -141,7 +141,7 @@ export type { QueryOptions as PureQueryOptions };
		export type OperationVariables = Record<string, any>;

		export interface ApolloQueryResult<T> {

Deprecate partial and ensure its correctness. Fix type of data in ApolloQueryResult #12333

Deprecate partial and ensure its correctness. Fix type of data in ApolloQueryResult #12333

Conversation

jerelmiller commented Jan 31, 2025 • edited Loading

changeset-bot bot commented Jan 31, 2025 • edited Loading

🦋 Changeset detected

svc-apollo-docs commented Jan 31, 2025 • edited Loading

⚠️ Docs preview not attached to branch

pkg-pr-new bot commented Jan 31, 2025 • edited Loading

github-actions bot commented Jan 31, 2025 • edited Loading

size-limit report 📦

Choose a reason for hiding this comment

netlify bot commented Jan 31, 2025 • edited Loading

✅ Deploy Preview for apollo-client-docs ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PowerKiKi Mar 5, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Deprecate `partial` and ensure its correctness. Fix type of `data` in `ApolloQueryResult` #12333

Deprecate `partial` and ensure its correctness. Fix type of `data` in `ApolloQueryResult` #12333

jerelmiller commented Jan 31, 2025 •

edited

Loading

changeset-bot bot commented Jan 31, 2025 •

edited

Loading

svc-apollo-docs commented Jan 31, 2025 •

edited

Loading

pkg-pr-new bot commented Jan 31, 2025 •

edited

Loading

github-actions bot commented Jan 31, 2025 •

edited

Loading

netlify bot commented Jan 31, 2025 •

edited

Loading

PowerKiKi Mar 5, 2025 •

edited

Loading