fix(solid-query): don't trigger Suspense when data is already cached#10592
Open
ousamabenyounes wants to merge 1 commit intoTanStack:mainfrom
Open
fix(solid-query): don't trigger Suspense when data is already cached#10592ousamabenyounes wants to merge 1 commit intoTanStack:mainfrom
ousamabenyounes wants to merge 1 commit intoTanStack:mainfrom
Conversation
When data was preloaded via `ensureQueryData` (e.g. from a router loader), the proxy `data` getter read `queryResource.latest`, which falls back to a suspending read while the resource is in its initial pending state, even though the fetcher had already synchronously resolved with cached data. If the store already has data and no fetch is in-flight, return `state.data` directly. `state.isFetching` is read via `untrack` so it doesn't widen the data subscriber's reactive deps. Fixes TanStack#9955
Contributor
📝 WalkthroughWalkthroughThis PR fixes a Suspense issue in Solid Query where Suspense was unnecessarily triggered when accessing preloaded query data via Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
View your CI Pipeline Execution ↗ for commit fe12586
☁️ Nx Cloud last updated this comment at |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #9955.
When data was preloaded via
ensureQueryData(e.g. from a TanStack Router loader), accessingstate.datain a Suspense boundary would re-trigger the Suspense fallback even though the data was already in cache andisSuccesswastrue.Root cause
In
useBaseQuery.ts, the proxydatagetter readsqueryResource.latest?.datawheneverstate.data !== undefined. Per Solid's docs,.latestfalls back to aread()-equivalent (and therefore triggers Suspense) when the resource has no prior resolved value.In the preloaded-cache case, the resource's fetcher synchronously calls
resolve(...)because!observerResult.isLoading, but the resource doesn't transition out of the initialpendingstate until the next microtask. Reading.latestinside that microtask gap suspends the component even thoughstate.dataalready holds the cached value.Fix
If the store already has
dataand no fetch is in-flight (!state.isFetching), returnstate.datadirectly without going throughqueryResource.state.isFetchingis read viauntrackso it doesn't widen the data subscriber's reactive deps (preserves existing reconcile / memo-churn tests).When a fetch is in-flight, the existing
queryResource.latest?.datapath is preserved so background-refresh and re-mount semantics are unchanged.Verification
packages/solid-query/src/__tests__/suspense.test.tsxthat pre-populates the cache viaqueryClient.ensureQueryData(...), renders inside<Suspense>, and asserts the fallback never mounts. Test fails onmain(Suspense fires), passes with the fix.pnpm exec nx run @tanstack/solid-query:test:lib— all 310 tests pass.pnpm exec nx run @tanstack/solid-query:test:types— all TS versions pass.pnpm exec nx run @tanstack/solid-query:test:eslint— clean.patchfor@tanstack/solid-query).Test plan
🤖 Generated with Claude Code
Generated by Ora Studio
Vibe coded by ousamabenyounes
Summary by CodeRabbit
Bug Fixes
Tests
Generated by Ora Studio (with Claude Code)
Vibe coded by Ben Younes Ousama