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.

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

fix(query-core): fix to show type error when queryKey is a wrong type in invalidateQueries #8691

Closed
wants to merge 2 commits into from

Conversation

gs18004
Copy link
Contributor

@gs18004 gs18004 commented Feb 23, 2025

closes #8684

Now, the type error is shown when queryKey is a wrong type in invalidateQueries.

Copy link

nx-cloud bot commented Feb 23, 2025

View your CI Pipeline Execution ↗ for commit 475d1e2.

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

☁️ Nx Cloud last updated this comment at 2025-02-24 01:58:38 UTC

Copy link

pkg-pr-new bot commented Feb 23, 2025

Open in Stackblitz

More templates

@tanstack/angular-query-devtools-experimental

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

@tanstack/angular-query-experimental

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

@tanstack/query-async-storage-persister

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

@tanstack/eslint-plugin-query

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

@tanstack/query-broadcast-client-experimental

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

@tanstack/query-core

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

@tanstack/query-devtools

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

@tanstack/query-persist-client-core

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

@tanstack/query-sync-storage-persister

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

@tanstack/react-query

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

@tanstack/react-query-devtools

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

@tanstack/react-query-next-experimental

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

@tanstack/react-query-persist-client

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

@tanstack/solid-query

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

@tanstack/solid-query-devtools

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

@tanstack/solid-query-persist-client

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

@tanstack/svelte-query

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

@tanstack/svelte-query-devtools

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

@tanstack/svelte-query-persist-client

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

@tanstack/vue-query

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

@tanstack/vue-query-devtools

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

commit: 475d1e2

Copy link

codecov bot commented Feb 23, 2025

Codecov Report

Attention: Patch coverage is 75.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 63.06%. Comparing base (389ac8e) to head (475d1e2).
Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #8691       +/-   ##
===========================================
+ Coverage   46.28%   63.06%   +16.78%     
===========================================
  Files         199      135       -64     
  Lines        7549     4852     -2697     
  Branches     1727     1370      -357     
===========================================
- Hits         3494     3060      -434     
+ Misses       3675     1547     -2128     
+ Partials      380      245      -135     
Components Coverage Δ
@tanstack/angular-query-devtools-experimental ∅ <ø> (∅)
@tanstack/angular-query-experimental 88.65% <ø> (ø)
@tanstack/eslint-plugin-query ∅ <ø> (∅)
@tanstack/query-async-storage-persister 43.85% <ø> (ø)
@tanstack/query-broadcast-client-experimental ∅ <ø> (∅)
@tanstack/query-codemods ∅ <ø> (∅)
@tanstack/query-core 93.95% <100.00%> (ø)
@tanstack/query-devtools 4.78% <ø> (ø)
@tanstack/query-persist-client-core 57.73% <ø> (ø)
@tanstack/query-sync-storage-persister 84.61% <ø> (ø)
@tanstack/react-query 95.37% <ø> (ø)
@tanstack/react-query-devtools 10.00% <ø> (ø)
@tanstack/react-query-next-experimental ∅ <ø> (∅)
@tanstack/react-query-persist-client 100.00% <ø> (ø)
@tanstack/solid-query 78.20% <ø> (ø)
@tanstack/solid-query-devtools ∅ <ø> (∅)
@tanstack/solid-query-persist-client 100.00% <ø> (ø)
@tanstack/svelte-query 87.33% <ø> (ø)
@tanstack/svelte-query-devtools ∅ <ø> (∅)
@tanstack/svelte-query-persist-client 100.00% <ø> (ø)
@tanstack/vue-query 71.01% <50.00%> (ø)
@tanstack/vue-query-devtools ∅ <ø> (∅)

Comment on lines +500 to +518
it('shows type error when queryKey is a wrong type in invalidateQueries', () => {
const queryClient = new QueryClient()

queryClient.invalidateQueries()

queryClient.invalidateQueries({
queryKey: ['1'],
})

queryClient.invalidateQueries({
// @ts-expect-error
queryKey: '1',
})

queryClient.invalidateQueries({
// @ts-expect-error
queryKey: {},
})
})
Copy link
Collaborator

Choose a reason for hiding this comment

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

I’ve added this test to:

where I’m also re-writing the types for invalidateQueries and other methods.

the test passes there as well, so I’ll close this PR to avoid the conflicts.

@TkDodo TkDodo closed this Feb 25, 2025
TkDodo added a commit that referenced this pull request Feb 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Dangerous missing type validation on invalidateQueries queryKey
2 participants