[WIP] Add list support to `useFragment` #12971

jerelmiller · 2025-10-13T19:42:59Z

WIP support for lists with useFragment

const results = useFragment({
  fragment,
  from: [item1, item2]
});

console.log(results); // [{ data: {...}, complete: true }, { data: {...}, complete: true }}]

changeset-bot · 2025-10-13T19:43:03Z

⚠️ No Changeset found

Latest commit: 1bb3371

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

apollo-librarian · 2025-10-13T19:43:59Z

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 10 changed, 0 removed

* (developer-tools)/react/(latest)/caching/cache-configuration.mdx
* (developer-tools)/react/(latest)/data/fragments.mdx
* (developer-tools)/react/(latest)/data/mutations.mdx
* (developer-tools)/react/(latest)/data/persisted-queries.mdx
* (developer-tools)/react/(latest)/data/queries.mdx
* (developer-tools)/react/(latest)/integrations/react-native.mdx
* (developer-tools)/react/(latest)/migrating/apollo-client-4-migration.mdx
* (developer-tools)/react/(latest)/performance/server-side-rendering.mdx
* (developer-tools)/react/(latest)/VERSIONING_POLICY.md
* (developer-tools)/react/(latest)/versioning-policy.md

Build ID: 744dea42ff35373e23f62728
Build Logs: View logs

URL: https://www.apollographql.com/docs/deploy-preview/744dea42ff35373e23f62728

pkg-pr-new · 2025-10-13T19:44:33Z

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

commit: 1bb3371

src/react/hooks/useFragment.ts

phryneas · 2025-10-14T08:14:58Z

src/cache/core/cache.ts

+    }) as Observable<any>;
+
+    return Object.assign(observable, {
+      getCurrentResult: () => {


Could we return something with a changeTargets property here? That way we wouldn't need to unwatch/rewatch 999 unrelated elements if one id changed.

Yes! I was planning to do that next 🙂.

This is now implemented with reobserve which will only watch new ids and keep ids that haven't changed around 🙂

…and reobserve

jerelmiller added 6 commits October 13, 2025 12:54

Add failing tests for useFragment with lists

8d2d4a6

Add initial pass implementation for useFragment with list

566eb28

Update type test

8a65236

Remove unneeded null return

1322fdd

Fix incorrect assertions

879f07f

Ensure array changes identities to rerender updated data

fb43f23

jerelmiller commented Oct 13, 2025

View reviewed changes

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

jerelmiller added 17 commits October 13, 2025 15:28

Add overloads for client/cache.watchFragment

94fd342

Handle masking

4bb6333

Add failing list tests for watchFragment

929245e

Add first implementation in core

f81070c

Don't allow for reobserve

c20b95e

Fix incorrect application of data masking in client.watchFragment

813b786

Warn on invalid id sooner

b2efcbe

Allow from as null internally in client.watchFragment

bed75a9

Switch to client.watchFragment with from array in useFragment

fd4b378

Add tests for getCurrentResult

be3de16

Add getCurrentResult to watchFragment result

91eeb9b

Update test

a18b304

Move comment down

f56c8b8

Use observable.getCurrentResult in useFragment

d1fb6dd

Emit stable value to maintain referential equality

02717e6

Move observable to useMemo

0ad39f2

Combine useDeepMemos

44237c6

phryneas reviewed Oct 14, 2025

View reviewed changes

jerelmiller added 2 commits October 14, 2025 12:27

Rename lastResult to currentResult

6846095

Cast to any for now

6dbaf61

jerelmiller added 29 commits October 15, 2025 18:34

Ensure observable doesn't complete with empty array

129a558

Handle state for getCurrentResult

728bdd8

Update test for checking warnings

803db36

Fix some types and remove some unneeded code in getCurrentResult

90a3753

Extract toResult

e692989

Fix more types

f07ede4

Ensure object identity remains the same

e840864

Remove unneeded setting of current result

f856327

Make ids an observable

1200755

Fix assertion

f21de3c

Handle changing ids with reobserve

6342d97

Add check to ensure change to item in list is picked up

e63790d

Add waits when checking watch size

e071b9d

Only unsubscribe from watches that are dropped between reobserve

4116dce

Extract helper

3ace3de

Combine functions

70769be

Combine functions

f356b22

Allow null in from when its a list and change return to null

5935f00

Fix comment

c47ff9d

Fix type issue

1703dcf

Add test to getCurrentResult to make sure it works with subscription …

dd75d07

…and reobserve

Use reobserve in useFragment

3db1e7f

Better handle changing options

5fa7080

Update changing options test with better assertions

2de10bd

Add back test for change of from value

e2c12a2

Allow null in reobserve

7cb6e23

Fix missing type on partial result

306a6fc

Add reobserve test with null

bb40a4a

Update useSuspenseFragment to handle timing of watch cleanup

1bb3371

jerelmiller force-pushed the jerel/use-fragment-list branch from 567a907 to 1bb3371 Compare October 16, 2025 22:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[WIP] Add list support to `useFragment` #12971

[WIP] Add list support to `useFragment` #12971

jerelmiller commented Oct 13, 2025

Uh oh!

changeset-bot bot commented Oct 13, 2025 •

edited

Loading

Uh oh!

apollo-librarian bot commented Oct 13, 2025 •

edited

Loading

Uh oh!

pkg-pr-new bot commented Oct 13, 2025 •

edited

Loading

Uh oh!

Uh oh!

phryneas Oct 14, 2025

Uh oh!

jerelmiller Oct 14, 2025

Uh oh!

jerelmiller Oct 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

[WIP] Add list support to useFragment #12971

Are you sure you want to change the base?

[WIP] Add list support to useFragment #12971

Conversation

jerelmiller commented Oct 13, 2025

Uh oh!

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

Uh oh!

⚠️ No Changeset found

Uh oh!

apollo-librarian bot commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Docs preview ready

Uh oh!

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

Uh oh!

Uh oh!

Uh oh!

phryneas Oct 14, 2025

Choose a reason for hiding this comment

Uh oh!

jerelmiller Oct 14, 2025

Choose a reason for hiding this comment

Uh oh!

jerelmiller Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

[WIP] Add list support to `useFragment` #12971

[WIP] Add list support to `useFragment` #12971

changeset-bot bot commented Oct 13, 2025 •

edited

Loading

apollo-librarian bot commented Oct 13, 2025 •

edited

Loading

pkg-pr-new bot commented Oct 13, 2025 •

edited

Loading