Don't throw on missing results with `cache.diff` and other changes #12304

jerelmiller · 2025-01-24T06:58:11Z

This PR changes cache.diff to return null instead of throwing a MissingFieldError when returnPartialData is false. This better aligns with some of the other cache read APIs, such as readFragment where incomplete results return null instead of throwing errors.

This should allow us to update some of our usages of cache.diff throughout the codebase where we set returnPartialData to true. I believe this was done to avoid having cache.diff throw in the case of missing data. Ideally we only need to set returnPartialData when specified by the user (subject to future exploration and testing).

This change better aligns with some of the other cache read operations that return null with partial results, such as cache.readFragment().

Some other changes/improvements in this PR:

Cache.DiffResult<TData> is now a bit smarter and behaves closer to useFragment where it now returns a union to handle when complete is true or false. This should give better type safety, especially when complete is false since the behavior today returns TData instead of DeepPartial<TData> in this case.
The missing property on Cache.DiffResult is now either undefined or an instance of MissingFieldError. The array was removed as this information is all embedded in the MissingFieldError instance itself.

changeset-bot · 2025-01-24T06:58:15Z

🦋 Changeset detected

Latest commit: 3313ca3

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-24T06:58:54Z

⚠️ 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: c42b4b960001813e1dc22f42

pkg-pr-new · 2025-01-24T06:59:05Z

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

commit: 3313ca3

github-actions · 2025-01-24T06:59:35Z

size-limit report 📦

Path	Size
dist/apollo-client.min.cjs	33.47 KB (+0.05% 🔺)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs"	41.41 KB (-0.01% 🔽)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" (production)	38.72 KB (-0.11% 🔽)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js"	36.15 KB (-0.06% 🔽)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" (production)	33.55 KB (-0.08% 🔽)
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.12 KB (0%)
import { useQuery } from "dist/react/index.js" (production)	4.21 KB (0%)
import { useLazyQuery } from "dist/react/index.js"	5.61 KB (0%)
import { useLazyQuery } from "dist/react/index.js" (production)	4.68 KB (0%)
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.43 KB (0%)
import { useSubscription } from "dist/react/index.js" (production)	3.48 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js"	5.51 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" (production)	4.17 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js"	5.01 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" (production)	3.66 KB (0%)
import { useLoadableQuery } from "dist/react/index.js"	5.09 KB (0%)
import { useLoadableQuery } from "dist/react/index.js" (production)	3.74 KB (0%)
import { useReadQuery } from "dist/react/index.js"	3.41 KB (0%)
import { useReadQuery } from "dist/react/index.js" (production)	3.35 KB (0%)
import { useFragment } from "dist/react/index.js"	2.01 KB (-15.16% 🔽)
import { useFragment } from "dist/react/index.js" (production)	1.95 KB (-15.47% 🔽)

netlify · 2025-01-24T06:59:54Z

✅ Deploy Preview for apollo-client-docs ready!

Name	Link
🔨 Latest commit	`3313ca3`
🔍 Latest deploy log	https://app.netlify.com/sites/apollo-client-docs/deploys/67994db4119c4e00087591e4
😎 Deploy Preview	https://deploy-preview-12304--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-24T19:36:59Z

src/core/__tests__/ObservableQuery.ts

@@ -551,7 +551,7 @@ describe("ObservableQuery", () => {
      {
        const result = await stream.takeNext();

-        expect(result.data).toEqual({});
+        expect(result.data).toEqual(undefined);


This is one great benefit of this change. We report this type as TData | undefined, yet at times we returned an empty object at runtime. With the change in place, we now properly get undefined.

…iff call

jerelmiller · 2025-01-24T23:49:19Z

src/core/__tests__/fetchPolicies.ts

@@ -710,9 +712,11 @@ describe("cache-and-network", function () {
    await observable.setVariables({ id: "2" });

    await expect(stream).toEmitValue({
-      data: {},
+      data: undefined,


Much better 🎉. It was always odd that we'd get back an empty object when returnPartialData was false.

jerelmiller · 2025-01-27T16:13:18Z

Add a doc block to cache.diff for cache implementors

src/cache/inmemory/readFromStore.ts

src/react/hooks/useFragment.ts

phryneas

Some small things, but once those have been tackled: ✅

jerelmiller added the 🍳 breaking change label Jan 24, 2025

jerelmiller requested a review from phryneas January 24, 2025 06:58

jerelmiller marked this pull request as draft January 24, 2025 06:58

jerelmiller removed the request for review from phryneas January 24, 2025 06:58

jerelmiller force-pushed the jerel/cache-diff-improvements branch from db5aea0 to 8a26e33 Compare January 24, 2025 16:42

jerelmiller commented Jan 24, 2025

View reviewed changes

jerelmiller mentioned this pull request Jan 24, 2025

Add peek to ObservableStream and use ObservableStream in an existing test #12307

Merged

jerelmiller added 18 commits January 24, 2025 15:43

Don't throw on incomplete results. Return null instead

7e37801

Update readFromStore test

e3881a0

Update policies test to check for null instead of throwing on cache.d…

80e191b

…iff call

Add custom tester for checking missing field errors

322ac84

Make the missing field a single MissingFieldError

ee232db

Update diffAgainstStore tests to fix custom matching

585504b

Update policies tests to match new behavior of diff

ead5c0e

Create smarter DiffResult type

d713041

Cast type to fix error

04d79a0

Update useFragment to match new diff behavior

fd88b98

Smarter diff result value when returnPartialData is false

8a6ef23

Undo change to set return type with returnPartialData

c62a818

Fix ts errors in data masking tests

ea95139

Fix ts error in core cache tests

818f997

Update useFragment for changes to cache.diff

2442e5c

Update watchFragment for changes to cache.diff

92149e9

Minor adjustment to cache tests to check for complete first

6c8b1ae

Fix failing test due to change in missing

2c16fe4

jerelmiller added 3 commits January 24, 2025 15:43

Add null as valid return value from read

6a2fe6e

Update refetchQueries tests to match updated behavior

b2dd1ae

Update optimistic tests to match updated behavior

5f341c1

jerelmiller force-pushed the jerel/cache-diff-improvements branch from 294f707 to 5f341c1 Compare January 24, 2025 22:43

jerelmiller added 6 commits January 24, 2025 15:43

Update client tests affected by change

dd7dfa5

Fix check for shape of diff.missing when emitting cache results

dec4657

Fix roundtrip test due to changes in behavior

81e36bc

Fix readFromStore tests

aaefe99

Extract api and update size limits

570704f

Add changeset

ac7a2df

jerelmiller marked this pull request as ready for review January 24, 2025 23:40

jerelmiller requested a review from phryneas January 24, 2025 23:40

jerelmiller commented Jan 24, 2025

View reviewed changes

jerelmiller added 2 commits January 27, 2025 12:04

Add note for third party caches in changeset

17afbe4

Add doc block

4bd34ba

phryneas reviewed Jan 28, 2025

View reviewed changes

src/cache/inmemory/readFromStore.ts Outdated Show resolved Hide resolved

phryneas reviewed Jan 28, 2025

View reviewed changes

src/react/hooks/useFragment.ts Outdated Show resolved Hide resolved

phryneas reviewed Jan 28, 2025

View reviewed changes

src/react/hooks/useFragment.ts Outdated Show resolved Hide resolved

phryneas approved these changes Jan 28, 2025

View reviewed changes

github-actions bot added the auto-cleanup 🤖 label Jan 28, 2025

jerelmiller and others added 5 commits January 28, 2025 11:01

Use Object.keys instead of equal

e70c3fc

Add todo

d9fd2e5

Run api report and size limits

251b89d

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

750ac17

Merge branch 'release-4.0' into jerel/cache-diff-improvements

3313ca3

jerelmiller merged commit 86469a2 into release-4.0 Jan 28, 2025
48 checks passed

jerelmiller deleted the jerel/cache-diff-improvements branch January 28, 2025 21:41

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

Version Packages (alpha) #12221

Open

jerelmiller mentioned this pull request Jan 31, 2025

Fix tests affected by change to cache #12330

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Don't throw on missing results with `cache.diff` and other changes #12304

Don't throw on missing results with `cache.diff` and other changes #12304

jerelmiller commented Jan 24, 2025 •

edited

Loading

changeset-bot bot commented Jan 24, 2025 •

edited

Loading

svc-apollo-docs commented Jan 24, 2025 •

edited

Loading

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

edited

Loading

github-actions bot commented Jan 24, 2025 •

edited

Loading

netlify bot commented Jan 24, 2025 •

edited

Loading

jerelmiller Jan 24, 2025

jerelmiller Jan 24, 2025 •

edited

Loading

jerelmiller commented Jan 27, 2025

phryneas left a comment

Don't throw on missing results with cache.diff and other changes #12304

Don't throw on missing results with cache.diff and other changes #12304

Conversation

jerelmiller commented Jan 24, 2025 • edited Loading

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

🦋 Changeset detected

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

⚠️ Docs preview not attached to branch

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

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

size-limit report 📦

netlify bot commented Jan 24, 2025 • edited Loading

✅ Deploy Preview for apollo-client-docs ready!

jerelmiller Jan 24, 2025

Choose a reason for hiding this comment

jerelmiller Jan 24, 2025 • edited Loading

Choose a reason for hiding this comment

jerelmiller commented Jan 27, 2025

phryneas left a comment

Choose a reason for hiding this comment

Don't throw on missing results with `cache.diff` and other changes #12304

Don't throw on missing results with `cache.diff` and other changes #12304

jerelmiller commented Jan 24, 2025 •

edited

Loading

changeset-bot bot commented Jan 24, 2025 •

edited

Loading

svc-apollo-docs commented Jan 24, 2025 •

edited

Loading

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

edited

Loading

github-actions bot commented Jan 24, 2025 •

edited

Loading

netlify bot commented Jan 24, 2025 •

edited

Loading

jerelmiller Jan 24, 2025 •

edited

Loading