feat: Add type to react-query query key - Attempt round 2! #3170
Conversation
This file contains 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
I've started to change across the react-query query keys to use an
object that now also distinguishes between `query` and `infinite` query
types in all the appropriate methods.
Initially I am trying a `[{path, input, type}]` structured key!
JonParton
requested review from
a team,
KATT,
trpc-bot and
sachinraja
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
github-actions
bot
added
@trpc/react-query
🕸 www
3 tasks
|
KATT
approved these changes
Nov 14, 2022
| @@ -499,7 +502,7 @@ export const appRouter = router({ | |||
| The query key used for `trpc.user.byId.useQuery({ id: 10 })` would change: | |||
|
|
|||
| - Key in V9: `["user.byId", { id: 10 }]` | |||
| - Key in v10:`[["user", "byId"],{ id:10 }]` | |||
| - Key in v10:`[["user", "byId"],{ input: { id:10 }, type: 'query' }]` | |||
| @@ -301,7 +301,7 @@ export function createHooksInternal< | |||
| (...args: any[]) => { | |||
| const [queryKey, ...rest] = args; | |||
| return queryClient.invalidateQueries( | |||
| getArrayQueryKey(queryKey), | |||
| getArrayQueryKey(queryKey, 'any'), | |||
There was a problem hiding this comment.
I think this is prefect and that we don't need to allow granular invalidation for now, I don't see why anyone would not want to invalidate the same query across both methods of fetching it.
| @@ -312,23 +312,25 @@ export function createHooksInternal< | |||
| const [queryKey, ...rest] = args; | |||
|
|
|||
| return queryClient.refetchQueries( | |||
| getArrayQueryKey(queryKey), | |||
| getArrayQueryKey(queryKey, 'any'), | |||
There was a problem hiding this comment.
I think this is prefect and that we don't need to allow granular invalidation for now, I don't see why anyone would not want to refetch the same query across both methods of fetching it.
| ...rest, | ||
| ); | ||
| }, | ||
| [queryClient], | ||
| ), | ||
| cancelQuery: useCallback( | ||
| (pathAndInput) => { | ||
| return queryClient.cancelQueries(getArrayQueryKey(pathAndInput)); | ||
| return queryClient.cancelQueries( |
There was a problem hiding this comment.
I think this is prefect and that we don't need to allow granular invalidation for now, I don't see why anyone would not want to cancel the same query across both methods of fetching it.
1 task
KATT
added a commit
that referenced
this pull request
Nov 18, 2022
KATT
added a commit
that referenced
this pull request
Nov 26, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Closes #3128
transferred from #3165
🎯 Changes
This pull request alters the react-query
queryKeyto also include thetypeof the query (queryorinfinite) as well as placing the input within an object alongside it.New key Structure:
Example:
This change will mean that an
infinitequery and aqueryof the same endpoint will have different entries within the cache, which is required as the data structures are different!!This key structure also maintains the ability to invalidate specifically
query's orinfinite's across entire routers as well as filtering queries using their input when interacting with the react-queryqueryClientdirectly (Escape Hatch! 👨🚒).🔨 Possible improvements
Currently the exposed
invalidate()function on a router or on a leaf node will invalidate bothqueriesandinfiniteQuerieswith no way to filter. The ability to specify onlyqueriesorinfiniteQueriescould be added at a later date but I think for now this should be fine and in line with the philosophy of being indiscriminate added in #3124✅ Checklist