feat(tanstack-query): allow to pass in a custom callback for computing optimistic data

[ymc9]

Fixes #1142

Summary by CodeRabbit

• New Features
  • Introduced optimistic data handling capabilities, allowing for more responsive UI updates.
• Tests
  • Added a new test case for verifying optimistic data updates with a custom provider.

[coderabbitai]

Walkthrough

Walkthrough

The recent update introduces the concept of optimistic data handling in the Tanstack Query library, specifically focusing on the ability to compute and manage optimistic updates more effectively. This is achieved through the introduction of a new type and function dedicated to optimistic data provision, along with enhancements in existing functions to support this feature. Additionally, the update includes a test case to validate the functionality of optimistic mutations using a custom provider, ensuring the library handles cache updates correctly after mocking API calls.

Changes

Files	Summary
packages/.../common.ts	Introduced OptimisticDataProviderResult and OptimisticDataProvider for optimistic data handling. Added optimisticDataProvider to ExtraMutationOptions. Updated setupOptimisticUpdate and optimisticUpdate functions.
packages/.../react-hooks-v5.test.tsx	Added a test case for verifying cache updates through optimistic mutations with a custom provider.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• 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 tests 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between bab5195 and 111c672.

Files selected for processing (2)

• packages/plugins/tanstack-query/src/runtime/common.ts (6 hunks)
• packages/plugins/tanstack-query/tests/react-hooks-v5.test.tsx (1 hunks)

Additional comments: 5

packages/plugins/tanstack-query/src/runtime/common.ts (4)

• 46-63: The OptimisticDataProviderResult type is well-defined, covering all possible outcomes for optimistic updates. However, consider documenting the expected behavior when data is provided but kind is not 'Update', as this might lead to confusion.
• 75-81: The OptimisticDataProvider type is correctly defined to accept necessary arguments for computing optimistic data. Ensure that the documentation clearly explains how to use this callback, especially the significance of each argument, to aid developers in implementing their custom logic effectively.
• 100-100: Adding the optimisticDataProvider callback to ExtraMutationOptions is a significant enhancement. It's important to document examples of how to use this new option, including scenarios where it's beneficial. This will help users understand its value and how to integrate it into their applications.
• 392-434: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [322-427]

The updates to setupOptimisticUpdate and optimisticUpdate functions to handle the optimisticDataProvider callback are correctly implemented. However, ensure thorough testing, especially edge cases where the callback might return unexpected results. Consider adding more inline documentation explaining the flow, especially around the handling of different kind values from OptimisticDataProviderResult.

packages/plugins/tanstack-query/tests/react-hooks-v5.test.tsx (1)

• 622-715: The new test case for optimistic updates with a custom provider is well-implemented and covers the scenario of using a custom provider for optimistic updates. However, consider adding more assertions to verify the state of the cache before and after the mutation in both test scenarios. This will ensure the test is robust and accurately reflects the expected behavior of the library when handling optimistic updates with custom logic.