Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(react-query): add missing subscribed option to UseInfiniteQueryOp… #8546

Merged
merged 2 commits into from
Jan 19, 2025
Merged

fix(react-query): add missing subscribed option to UseInfiniteQueryOp… #8546

merged 2 commits into from
Jan 19, 2025

Conversation

SMhdAsadi
Copy link
Contributor

This pull request adds the missing subscribed option to the UseInfiniteQueryOptions type, as discussed in #8538.

Context

Both useQuery and useInfiniteQuery rely on useBaseQuery under the hood, and the subscription logic resides in useBaseQuery. However, the options type for useInfiniteQuery does not currently extend UseBaseQueryOptions, which would seem logical given their shared base.

Approach

Initially, I attempted to make UseInfiniteQueryOptions extend UseBaseQueryOptions. To achieve this, I broadened UseBaseQueryOptions to accept an additional generic parameter, TPageParam, required for infinite queries. However, this caused a lot of type breaks throughout the codebase, as UseBaseQueryOptions appears to have been designed specifically for useQuery.

To avoid widespread changes and potential compatibility issues, I decided to stick with the existing approach. Instead, I directly added the subscribed field to UseInfiniteQueryOptions. This resolves the issue for now without disrupting other parts of the type system.

TkDodo
TkDodo approved these changes Jan 19, 2025
View reviewed changes
Copy link
Collaborator

@TkDodo TkDodo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fair enough, thanks for trying ❤️

@nx-cloud Nx Cloud
Copy link

nx-cloud bot commented Jan 19, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 03c603c.

Command Status Duration Result
nx affected --targets=test:sherif,test:knip,tes... ✅ Succeeded 3m 8s View ↗
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 20s View ↗

☁️ Nx Cloud last updated this comment at 2025-01-19 08:31:13 UTC

@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented Jan 19, 2025

Open in Stackblitz

More templates

@tanstack/angular-query-devtools-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-devtools-experimental@8546

@tanstack/angular-query-experimental

npm i https://pkg.pr.new/@tanstack/angular-query-experimental@8546

@tanstack/eslint-plugin-query

npm i https://pkg.pr.new/@tanstack/eslint-plugin-query@8546

@tanstack/query-async-storage-persister

npm i https://pkg.pr.new/@tanstack/query-async-storage-persister@8546

@tanstack/query-broadcast-client-experimental

npm i https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@8546

@tanstack/query-core

npm i https://pkg.pr.new/@tanstack/query-core@8546

@tanstack/query-devtools

npm i https://pkg.pr.new/@tanstack/query-devtools@8546

@tanstack/query-persist-client-core

npm i https://pkg.pr.new/@tanstack/query-persist-client-core@8546

@tanstack/query-sync-storage-persister

npm i https://pkg.pr.new/@tanstack/query-sync-storage-persister@8546

@tanstack/react-query

npm i https://pkg.pr.new/@tanstack/react-query@8546

@tanstack/react-query-devtools

npm i https://pkg.pr.new/@tanstack/react-query-devtools@8546

@tanstack/react-query-next-experimental

npm i https://pkg.pr.new/@tanstack/react-query-next-experimental@8546

@tanstack/react-query-persist-client

npm i https://pkg.pr.new/@tanstack/react-query-persist-client@8546

@tanstack/solid-query

npm i https://pkg.pr.new/@tanstack/solid-query@8546

@tanstack/solid-query-devtools

npm i https://pkg.pr.new/@tanstack/solid-query-devtools@8546

@tanstack/solid-query-persist-client

npm i https://pkg.pr.new/@tanstack/solid-query-persist-client@8546

@tanstack/svelte-query-devtools

npm i https://pkg.pr.new/@tanstack/svelte-query-devtools@8546

@tanstack/svelte-query

npm i https://pkg.pr.new/@tanstack/svelte-query@8546

@tanstack/svelte-query-persist-client

npm i https://pkg.pr.new/@tanstack/svelte-query-persist-client@8546

@tanstack/vue-query

npm i https://pkg.pr.new/@tanstack/vue-query@8546

@tanstack/vue-query-devtools

npm i https://pkg.pr.new/@tanstack/vue-query-devtools@8546

commit: 03c603c

@codecov Codecov
Copy link

codecov bot commented Jan 19, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.29%. Comparing base (f04dd19) to head (03c603c).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #8546       +/-   ##
===========================================
+ Coverage   46.28%   84.29%   +38.01%     
===========================================
  Files         199       26      -173     
  Lines        7538      363     -7175     
  Branches     1721      102     -1619     
===========================================
- Hits         3489      306     -3183     
+ Misses       3670       48     -3622     
+ Partials      379        9      -370
Components Coverage Δ
@tanstack/angular-query-devtools-experimental ∅ <ø> (∅)
@tanstack/angular-query-experimental ∅ <ø> (∅)
@tanstack/eslint-plugin-query ∅ <ø> (∅)
@tanstack/query-async-storage-persister ∅ <ø> (∅)
@tanstack/query-broadcast-client-experimental ∅ <ø> (∅)
@tanstack/query-codemods ∅ <ø> (∅)
@tanstack/query-core ∅ <ø> (∅)
@tanstack/query-devtools ∅ <ø> (∅)
@tanstack/query-persist-client-core ∅ <ø> (∅)
@tanstack/query-sync-storage-persister ∅ <ø> (∅)
@tanstack/react-query 95.94% <ø> (ø)
@tanstack/react-query-devtools 10.00% <ø> (ø)
@tanstack/react-query-next-experimental ∅ <ø> (∅)
@tanstack/react-query-persist-client 100.00% <ø> (ø)
@tanstack/solid-query ∅ <ø> (∅)
@tanstack/solid-query-devtools ∅ <ø> (∅)
@tanstack/solid-query-persist-client ∅ <ø> (∅)
@tanstack/svelte-query ∅ <ø> (∅)
@tanstack/svelte-query-devtools ∅ <ø> (∅)
@tanstack/svelte-query-persist-client ∅ <ø> (∅)
@tanstack/vue-query ∅ <ø> (∅)
@tanstack/vue-query-devtools ∅ <ø> (∅)

@TkDodo TkDodo merged commit 3e3fba9 into TanStack:main Jan 19, 2025
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@TkDodo TkDodo TkDodo approved these changes

Assignees
No one assigned
Labels
package: react-query
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@SMhdAsadi @TkDodo