Skip to content

pass mutation key to on sucess override #6716

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
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

pass mutation key to on sucess override #6716

wants to merge 2 commits into from

Conversation

DawidWraga
Copy link

@DawidWraga DawidWraga commented Apr 21, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • New Features
    • The mutation success handler now includes the mutation key, enabling users to identify the specific mutation that triggered the callback.

@DawidWraga DawidWraga requested a review from a team as a code owner April 21, 2025 11:12
@vercel Vercel
Copy link

vercel bot commented Apr 21, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
www ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 21, 2025 11:18am

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 21, 2025 •
edited
Loading

Walkthrough

The changes introduce the mutationKey property into the mutation success handler's metadata for React Query TRPC integrations. Specifically, the UseMutationOverride interface's onSuccess callback parameter now includes mutationKey, and the implementation in the mutation options ensures this property is populated and passed to the override handler. No other logic or public API signatures are modified.

Changes

File(s) Change Summary
packages/react-query/src/shared/types.ts Extended the UseMutationOverride interface's onSuccess parameter object to include mutationKey.
packages/tanstack-react-query/src/internals/mutationOptions.ts Updated the mutation success override to include the mutationKey property in the handler's argument.

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant MutationHandler
    participant QueryClient

    Caller->>MutationHandler: Initiate mutation
    MutationHandler->>QueryClient: Execute mutation
    QueryClient-->>MutationHandler: Return result
    MutationHandler->>Caller: Call onSuccess({ originalFn, queryClient, meta, mutationKey })
Loading

Poem

In the garden of code where mutations play,
A key now travels on success’s way.
With metadata richer, the handler can see,
Which mutation unlocked the victory.
Hopping forward, the rabbit’s delight—
Typed and tracked, everything’s right!
🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0e4f6df and 4d719e9.

📒 Files selected for processing (2)
  • packages/react-query/src/shared/types.ts (2 hunks)
  • packages/tanstack-react-query/src/internals/mutationOptions.ts (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • packages/tanstack-react-query/src/internals/mutationOptions.ts
  • packages/react-query/src/shared/types.ts
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: test
  • GitHub Check: build
  • GitHub Check: Lint and auto-fix
  • GitHub Check: Analyze (typescript)
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@vercel Vercel
Copy link

vercel bot commented Apr 21, 2025

@DawidWraga is attempting to deploy a commit to the trpc Team on Vercel.

A member of the Team first needs to authorize it.

@DawidWraga
Copy link
Author

Solves #6715

@DawidWraga DawidWraga mentioned this pull request Apr 21, 2025
Open
1 task
@pkg-pr-new pkg.pr.new
Copy link

pkg-pr-new bot commented Apr 21, 2025 •
edited
Loading

Open in StackBlitz

@trpc/client

npm i https://pkg.pr.new/trpc/trpc/@trpc/client@6716

@trpc/next

npm i https://pkg.pr.new/trpc/trpc/@trpc/next@6716

@trpc/server

npm i https://pkg.pr.new/trpc/trpc/@trpc/server@6716

@trpc/react-query

npm i https://pkg.pr.new/trpc/trpc/@trpc/react-query@6716

@trpc/tanstack-react-query

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

@trpc/upgrade

npm i https://pkg.pr.new/trpc/trpc/@trpc/upgrade@6716

commit: 4d719e9

KATT
KATT requested changes Apr 24, 2025
View reviewed changes
Copy link
Member

@KATT KATT left a comment

Choose a reason for hiding this comment

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

Thanks for this.

It fails CI right now


[1] src/internals/mutationOptions.ts:126:9 - error TS2353: Object literal may only specify known properties, and 'mutationKey' does not exist in type '{ originalFn: () => unknown; queryClient: QueryClient; meta: Record<string, unknown>; }'.
[1] 
[1] 126         mutationKey,
[1]             ~~~~~~~~~~~
[1]

Also, it would be good to add a test for this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@KATT KATT KATT requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@DawidWraga @KATT
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy