fix(lit-query): brand infiniteQueryOptions queryKey with DataTag - #11167
Open
vedantchalke36 wants to merge 1 commit into
Open
fix(lit-query): brand infiniteQueryOptions queryKey with DataTag#11167vedantchalke36 wants to merge 1 commit into
vedantchalke36 wants to merge 1 commit into
Conversation
infiniteQueryOptions was the only helper not tagging its queryKey, so setQueryData/getQueryData could not infer the InfiniteData type from a tagged query key. Add the same DataTag enrichment queryOptions and the other adapters (react-query, vue-query, solid-query) already ship. Closes TanStack#11142
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 (3)
📝 WalkthroughWalkthroughThe PR brands Changeslit-query infinite query key branding
| Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
🚥 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 |
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
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.
Fix [lit-query]
infiniteQueryOptionsmissingDataTagonqueryKey(#11142).Problem
infiniteQueryOptionswas the only*QueryOptionshelper not branding itsqueryKeywithDataTag. As a result,queryClient.setQueryData(infiniteQuerySlugType, ...)/getQueryDatacould not infer theInfiniteDatatype from a tagged key — the updater'solddata fell back tounknown, and caching through a shared options object lost its type safety.queryOptionsalready brands the key (with type tests), and react-query, vue-query and solid-query all brand it in theirinfiniteQueryOptions— lit-query was the outlier.Changes
packages/lit-query/src/infiniteQueryOptions.ts: return type now intersects{ queryKey: DataTag<TQueryKey, InfiniteData<TQueryFnData>, TError> }— same shape as react-query/vue-query.packages/lit-query/src/tests/type-inference.test.ts: regression tests mirroring the existingqueryOptionschecks —queryKey[dataTagSymbol]isInfiniteData<{ page: number }>, andgetQueryData/setQueryDatainfer the tagged data (the exact scenario from the issue)..changeset/quiet-mice-invent.md:patchfor@tanstack/lit-query.Test
The lit-query
test:libsuite (type-inference tests run undervitest+tsc) is exercised by CI on this PR; could not run locally without installing the monorepo.Closes #11142
Summary by CodeRabbit
Bug Fixes
getQueryDataandsetQueryDatanow correctly infer infinite query data types from associated query keys.Tests