fix(angular-query-experimental): widen 'SkipToken' to 'symbol' so it type-checks inside a whole-options getter - #11434
Draft
sukvvon wants to merge 2 commits into
Draft
Conversation
…type-checks inside a whole-options getter
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 80dd43b
☁️ 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 📦
|
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
Same root cause as #11427 (vue-query):
injectQuery's whole-options getter overload (injectQuery(() => ({...}))) failed to type-check thequeryFn: cond ? fn : skipTokenpattern, becauseSkipTokenis aunique symboland TypeScript fails to propagate the contextual type into a ternary inside a getter's body when the function has multiple overloads — widening the ternary'sunique symbolbranch to plainsymbol, which then matches no overload.Applies the same fix verified in #11427: widen
CreateQueryOptions'squeryFnto acceptsymbol(parameter position), following the existingSkipTokenForUseQueriesprecedent in@tanstack/vue-query'suseQueries.ts. SinceCreateQueryOptionsis also the basis ofqueryOptions()'s return type, thequeryOptions()overload that could leak the widenedsymbolnarrowsqueryFnback withOmitKeyof.UnusedSkipTokenOptions(which already existed here, unlike vue) is changed fromExclude<..., SkipToken | undefined>to a directQueryFunction<...>type, sinceExcludeno longer filters out the widenedsymbol— verified with a new regression test that it still rejectsskipToken.injectQuery's implementation signature needed an explicit cast toCreateBaseQueryOptionswhen callingcreateBaseQuery, since that internal helper still expects the narrow (un-widened) type.No runtime behavior changes — this is a type-only fix. Added a runtime test (
should not fetch when queryFn is skipToken, and fetch once it is replaced) and a type test toinject-query.test.ts/inject-query.test-d.ts, matching the shape already used forinjectInfiniteQuery's skipToken test.injectInfiniteQuery's separateTPageParaminference gap (falls back tounknownwithskipToken) is a related but distinct issue, not addressed here.✅ Checklist
pnpm run test:pr, or these tests do not apply to this pull request.🚀 Release Impact