fix(vue-query): widen 'SkipToken' to 'symbol' so 'queryFn' type-checks as a 'computed' or inside a whole-options getter - #11427
Draft
sukvvon wants to merge 11 commits into
Draft
Conversation
Contributor
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: trueThanks 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 fa638d3 ☁️ Nx Cloud last updated this comment at |
Contributor
🚀 Changeset Version Preview3 package(s) bumped directly, 22 bumped as dependents. 🟨 Minor bumps
🟩 Patch bumps
|
Contributor
size-limit report 📦
|
5 tasks
…epts unrelated symbols
…Fn' accepts a 'computed' resolving to 'skipToken'
… 'queryKey' across 'useQuery'/'useQueries'/'useInfiniteQuery'
…'queryKey'/'queryFn' reactive
…ted 'queryFn' resolving to 'skipToken'
…yFn'/'queryKey' and 'queryOptions()' input narrowing
sukvvon
changed the title
…d'/'ref' from 'vue-demi'
…can't resolve to 'assertType'
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
useQuery/queryOptions's whole-options getter overload (useQuery(() => ({...}))/queryOptions(() => ({...}))) failed to type-check thequeryFn: cond ? fn : skipTokenpattern shown in their own JSDoc examples.Root cause:
SkipTokenis aunique symbol. When a function has more than one overload and the argument is a getter, TypeScript fails to propagate the contextual type into a ternary inside the getter's body, widening the ternary'sunique symbolbranch to plainsymbol— which no longer matches any overload. This repo already has a fix for the same issue inuseQueries.ts(SkipTokenForUseQueries = symbol).The same widening needs to apply consistently everywhere
queryFnis accepted as input, butuseQuery.tsandqueryOptions.tseach hand-wrote their own, independently-drifting mapped type for the options they accept, soqueryOptions()didn't accept acomputedqueryFnat all (onlyuseQuery's options type did), and a bare reactive getter for the wholequeryKeyarray was accepted byqueryOptions()but rejected byuseQuery()/useQueries()for no principled reason (confirmed at runtime —cloneDeepUnrefalready resolves a bare-getterqueryKey).This PR:
UseQueryOptions(previously defined ad hoc inuseQuery.ts) intoqueryOptions.ts.QueryOptionsstays the plain/output type —enabled/queryKeyreactive, everything else (includingqueryFn) plain withunique symbol— soqueryOptions()'s return value still satisfiesQueryClientmethods likefetchQuery/invalidateQueriesthat expectunique symbol, and souseQueries' type-level inference (which pattern-matches on a plainqueryFnunion) keeps working when aqueryOptions()result is spread into it.UseQueryOptions(the shared input type foruseQuery,useQueries,useBaseQuery, andqueryClient) sources itsenabled/queryKey/queryFnmappings fromQueryOptions, so the two can't drift apart again, and widensSkipTokentosymbolonly onqueryFnthere, soqueryFn: cond ? fn : skipTokentype-checks both inside a whole-options getter and as acomputed.queryOptions()keeps a narrower input thanuseQuery():enabled/queryKey/queryFnaccept aref/computed/getter, every other option stays a plain value (e.g.staleTime: ref(...)is still rejected, and so is wrapping the whole options object in aref) — the same shapequeryOptions()already had, withqueryFnadded. Both rejections are pinned with@ts-expect-errorregression tests.queryKeyarray onuseQuery/useQueries(previously@ts-expect-error'd), matching whatqueryOptions()already accepted and what the runtime already resolves.useQuery.test.ts,useQueries.test.ts,useInfiniteQuery.test.ts) confirming acomputedqueryFnthat flips toskipTokenactually skips the query and re-runs once defined — not just a type-only check.useInfiniteQuery/infiniteQueryOptionswere checked for the same issue and found already correct (their options type wraps every property, includingqueryFn, inMaybeRefDeepas a whole); added regression tests (infiniteQueryOptions.test-d.ts, a runtime test inuseInfiniteQuery.test.ts) rather than changing their types.No other runtime behavior changes.
✅ Checklist
pnpm run test:pr, or these tests do not apply to this pull request.🚀 Release Impact