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(toRefs): don't trigger unwanted watchEffects #3260

Merged
merged 2 commits into from Jul 30, 2023

Conversation

wvffle
Copy link
Contributor

@wvffle wvffle commented Jul 27, 2023

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.
⚠️ Slowing down new functions

Warning: Slowing down new functions

As the VueUse audience continues to grow, we have been inundated with an overwhelming number of feature requests and pull requests. As a result, maintaining the project has become increasingly challenging and has stretched our capacity to its limits. As such, in the near future, we may need to slow down our acceptance of new features and prioritize the stability and quality of existing functions. Please note that new features for VueUse may not be accepted at this time. If you have any new ideas, we suggest that you first incorporate them into your own codebase, iterate on them to suit your needs, and assess their generalizability. If you strongly believe that your ideas are beneficial to the community, you may submit a pull request along with your use cases, and we would be happy to review and discuss them. Thank you for your understanding.


Description

This one is hard to tackle because of #885. The functionality here is kind of exclusive with the bug that this PR aims to fix.

This PR introduces ToRefsOptions property with a replaceRef boolean flag. By default, the flag is set to true to prevent breaking changes. If replaceRef is true, and one of the returned toRefs ref is changed, the original ref object is replaced by a copy. If the flag is set to false, only a key of the original ref is updated.

fixes #3258

Additional context

I couldn't come up with a better name. Maybe deep would better resemble that.

Another solution that I thought of would be to check if objectRef.constructor.name === 'RefImpl' and if so, update only the key. Vue has no system (that I know of) of distinguishing between Ref, ComputedRef and CustomRef, so that solution seems a bit hacky and is prone to changes of Vue internals. Also it makes toRefs kind of unpredictable when used with other composables.


🤖 Generated by Copilot at 59632ac

Added a new feature to the toRefs function to optionally replace the original ref with a copy on property update. This can help avoid unwanted side effects when using toRefs with reactive objects. Updated the tests and the documentation accordingly.

🤖 Generated by Copilot at 59632ac

  • Add ToRefsOptions interface to define the type of the optional parameter for the toRefs function (link)
  • Modify toRefs function signature to accept an options parameter with a default value of an empty object (link)
  • Destructure the options parameter and assign a default value of true to the replaceRef variable (link)
  • Change the set function of the computed property to check the value of the replaceRef variable and either replace the original ref with a copy or mutate it directly on property update (link)
  • Import watchSyncEffect function from vue-demi in toRefs/index.test.ts (link)
  • Add two new tests to check the behavior of the toRefs function with different values of the replaceRef option (link)

@antfu antfu added this pull request to the merge queue Jul 30, 2023
Merged via the queue into vueuse:main with commit 5309c26 Jul 30, 2023
3 checks passed
@wvffle wvffle deleted the wvffle/fix-3258 branch July 30, 2023 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Updates one toRefs returned ref causes a trigger of another
2 participants