fix(useRouteHash, useRouteParams, useRouteQuery): fix effect triggering multiple times#4113
Merged
antfu merged 1 commit intovueuse:mainfrom Aug 13, 2024
aethr:4112-fix-useRouteQuery-multiple-effect
Merged
fix(useRouteHash, useRouteParams, useRouteQuery): fix effect triggering multiple times#4113antfu merged 1 commit intovueuse:mainfrom aethr:4112-fix-useRouteQuery-multiple-effect
antfu merged 1 commit intovueuse:mainfrom
aethr:4112-fix-useRouteQuery-multiple-effect
Conversation
…ng twice on change (#4112)
dosubot
bot
added
the
size:M
aethr
commented
Jul 23, 2024
|
|
||
| it('should trigger effects only once', async () => { | ||
| const route = getRoute() | ||
| const router = { replace: (r: any) => Object.assign(route, r) } as any |
Contributor
Author
There was a problem hiding this comment.
This mock router implementation is different from other tests in this file, which use:
const router = { replace: (r: any) => route = r } as anyUsing basic assignment to replace the value of route (ie route = r) doesn't trigger watchers on route, so this mock behaves closer to the real vue-router.
I don't think it would be a bad idea to update the other tests in this file to use the same method, or even create a more realistic mock router that the tests can all use. However, I didn't feel that change would be in the scope of this PR.
antfu
approved these changes
Aug 13, 2024
This was referenced Sep 7, 2024
7 tasks
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
2 participants
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.
Resolves #4112.
Before submitting the PR, please make sure you do the following
fixes #123).Description
When a ref is created with
useRouteQuery, assigning a new value to the ref callstriggertwice for each change. It is called once immediately by thesetoperation, and the route is updated in anextTick. When the route updates in the following tick, it triggers a watcher on the route query, which callstriggeragain.The extra call to
triggermeans that effects on the ref are triggered multiple times for the same value in different ticks.More details are available in #4112.
Additional context
This behavior was probably introduced in d525244.
Previously, the setter would only update the route, and we would rely on the route watcher to update the value and trigger the effect. This commit introduced a
triggercall into thesetmethod, but didn't add a guard against thetriggerbeing called again in the subsequent tick.