feat(query-core): add queryClient argument to mutation callbacks and mutationFn#9557
Closed
raymondanythings wants to merge 2 commits intoTanStack:mainfrom
Closed
feat(query-core): add queryClient argument to mutation callbacks and mutationFn#9557raymondanythings wants to merge 2 commits intoTanStack:mainfrom
raymondanythings wants to merge 2 commits intoTanStack:mainfrom
Conversation
…te related callbacks - Introduced a `client` parameter in the `MutationConfig` interface and updated the `Mutation` class to store it. - Modified mutation function signatures to accept the `client` parameter, ensuring it is passed to success, error, and settled callbacks. - Updated the `MutationCache` and `MutationObserver` classes to accommodate the new `client` parameter in their respective mutation handling logic.
…lbacks - Added `queryClient` parameter to various mutation-related tests to ensure consistency with the updated mutation function signatures. - Updated assertions in tests for `hydration`, `mutationObserver`, `mutations`, `utils`, and `useMutation` to reflect the inclusion of `queryClient` in callback invocations.
|
@raymondanythings the benefit of the other approach is that we also get access to the |
Collaborator
it does no such thing. Just like this PR, it adds a second argument to This PR: The other PR: where The other PR does not affect |
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
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.
Background
When working with mutations, most callback logic (optimistic updates, cache updates, invalidations) needs direct access to queryClient.
Currently, this requires manually calling useQueryClient() inside callbacks, or wrapping mutation logic with custom hooks, which adds boilerplate.
PR #9193 proposes passing queryClient via MutationFunctionContext, but this changes callback parameter structures and may break compatibility with existing code.
What’s Different in This PR
Instead of replacing the last argument with a context object, this PR appends queryClient as the final parameter in:
This preserves all existing parameters and their positions, making it fully backward-compatible for users who don’t use the new argument.
Example Usage
Why This Approach
Backward-compatible: Does not alter existing argument order.
Low migration cost: Existing code works without changes.
Simple mental model: queryClient is always the last argument.