fix(svelte-query): activate createQueries initialized with an empty array - #11127
Conversation
createQueries stayed permanently inactive when it was initialized with an empty queries array. Reads of an absent index have no $state.raw field to subscribe to, and length is a plain array property, so a consumer that observed the result while it was empty registered no reactive dependency and never re-ran once queries were added. Track those reads through a key version that update() bumps whenever the key set changes.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (3)
Included review availability: Your plan provides up to 10 included reviews per hour; 8 remain after this review. 📝 WalkthroughWalkthrough
ChangescreateQueries reactivity
Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to The change restores reactivity for queries added after an initially empty list and includes targeted regression coverage with passing checks. No actionable merge-blocking risk remains beyond normal review. Sequence Diagram(s)sequenceDiagram
participant QueriesArray
participant createRawRef
participant createQueries
QueriesArray->>createRawRef: Add a query
createRawRef->>createRawRef: Increment keyVersion
createRawRef->>createQueries: Notify the tracked key
createQueries->>QueriesArray: Read the populated array
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
|
Note GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer. |
|
View your CI Pipeline Execution ↗ for commit 80e0e44
☁️ Nx Cloud last updated this comment at |
3 participants
🎯 Changes
Fixes #10681.
createQueriesstayed permanently inactive when it was initialized with an emptyqueriesarray. Adding entries later never revived any slot, while the same component worked if the initial array had at least one entry.The results object comes from
createRawRef, which turns each key into a$state.rawfield as that key appears. Two reads have nothing to subscribe to:results[0]while the ref is still empty) has no field yetlengthis a plain array property on the proxy targetSo a consumer that observes the result while it is empty registers no reactive dependency at all, and never re-runs once the queries are added. The data does arrive on the observer, which is why reading
results[0].datadirectly returns the right value while the rendered output stays pending forever.This adds a key version that
update()bumps whenever the key set changes, and tracks it from the proxygettrap for absent keys, hidden keys, and arraylength.createBaseQuerypasses an object whose shape is stable, so it never bumps the version and its behavior is unchanged.For reference, #10696 targeted this issue by restructuring the
QueriesObserverlifecycle and was closed by its author without review. The test below shows the observer itself is already doing the right thing onmain, so the remaining defect is in how the results ref is tracked.Heads up that the open #10892 adds a line to the same
update()function for an unrelated defect (#10341). The two changes are independent, but they are adjacent enough to conflict textually if both land.✅ Verification
Added a regression test that starts
createQuerieswithqueries: [], then adds one query and asserts that the tracked results reachsuccess. It fails onmainwithexpected [] to match object [ { data: 'data1', status: 'success' } ], and reverting onlycontainers.svelte.tson this branch reproduces the same failure. In that failing state the precedingexpect(result[0]?.data).toBe('data1')still passes, which is what isolates the problem to reactivity rather than fetching.nx affected --targets=test:sherif,test:knip,test:docs,test:eslint,test:lib,test:types,test:build,buildpasses locally across the 13 affected projects.@tanstack/svelte-queryis 23 files / 169 tests, and@tanstack/svelte-query-devtoolsand@tanstack/svelte-query-persist-clientare green as well.✅ Checklist
pnpm run test:pr.🚀 Release Impact
Summary by CodeRabbit
Bug Fixes
Tests