test(vue-query): add regression tests for suspense release on programmatic 'setQueryData' - #11249
Merged
Merged
Conversation
…matic 'setQueryData'
|
View your CI Pipeline Execution ↗ for commit b019312
☁️ Nx Cloud last updated this comment at |
Contributor
|
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 (1)
Included review availability: Your plan provides up to 10 included reviews per hour; 6 remain after this review. 📝 WalkthroughWalkthroughAdded Vue suspense tests that use Vitest fake timers. The tests verify resolution after ChangesVue suspense behavior
Estimated code review effort: 3 (Moderate) | ~15 minutes Merge Risk: ⚪ Minimal · up to This PR adds localized regression coverage without changing published runtime behavior, and no actionable merge-blocking risk remains beyond normal checks and review. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 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 |
Contributor
🚀 Changeset Version Preview10 package(s) bumped directly, 15 bumped as dependents. 🟨 Minor bumps
🟩 Patch bumps
|
Contributor
size-limit report 📦
|
4 tasks
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.
🎯 Changes
Port the vue-query counterpart of the regression tests added in #11036 (react-query). The underlying fix lives in
packages/query-core/src/queryObserver.ts(fetchOptimistic), andvue-query's.suspense()helper (useBaseQuery.ts) callsobserver.fetchOptimistic(...)directly, so it already gets the runtime behavior for free — this PR only adds test coverage:should release suspense when setQueryData is called while fetch is in-flightshould release suspense when streamedQuery receives first chunkTwo scenarios from the react-query version were deliberately not ported:
.suspense()only callsfetchOptimisticwhenoptimisticResult.isStaleis true; with data already cached and fresh, it resolves via a different branch and never reaches the fixed code path, so the test would pass regardless of the fix.query.state.data !== undefinedguard removed fromfetchOptimistic, i.e. it doesn't actually exercise the guard in vue's.suspense()shape. Left out rather than shipping a test that doesn't test anything.Both included tests were verified against a reverted (pre-#11036)
fetchOptimisticlocally and failed as expected (timeout) before being confirmed passing against the current code.✅ Checklist
pnpm run test:pr.🚀 Release Impact
Summary by CodeRabbit