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.

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

fix(reactivity): ensure watch cleanup on effect scope stop #12373

Merged
merged 7 commits into from
Nov 14, 2024
+14 −5
Merged

fix(reactivity): ensure watch cleanup on effect scope stop #12373

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
68a7c5f
fix(reactivity): ensure watch cleanup on effect stop
edison1105 Nov 13, 2024
c090c5e
test: add test
edison1105 Nov 13, 2024
0c97724
test: add test
edison1105 Nov 13, 2024
1cb6981
chore: update
edison1105 Nov 13, 2024
d05ea4a
chore: update
edison1105 Nov 13, 2024
d2fd005
chore: update test
edison1105 Nov 13, 2024
0073a01
chore: update test
edison1105 Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion packages/reactivity/__tests__/effectScope.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ describe('reactivity/effect/scope', () => {

expect('[Vue warn] cannot run an inactive effect scope.').toHaveBeenWarned()

expect(scope.effects.length).toBe(1)
expect(scope.effects.length).toBe(0)

counter.num = 7
expect(dummy).toBe(0)
Expand Down Expand Up @@ -358,5 +358,8 @@ describe('reactivity/effect/scope', () => {
await nextTick()
expect(watcherCalls).toBe(3)
expect(cleanupCalls).toBe(1)

expect(scope.effects.length).toBe(0)
expect(scope.cleanups.length).toBe(0)
})
})
11 changes: 9 additions & 2 deletions packages/reactivity/src/effectScope.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,17 +119,24 @@ export class EffectScope {
if (this._active) {
this._active = false
let i, l
for (i = 0, l = this.effects.length; i < l; i++) {
this.effects[i].stop()
const effects = this.effects.slice()
Copy link

Choose a reason for hiding this comment

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

for what reason do you need to make this slice?

Copy link
Member Author

Choose a reason for hiding this comment

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

this change was for #5783. it's not necessary since #5783 fixed via 2193284

for (i = 0, l = effects.length; i < l; i++) {
effects[i].stop()
}
this.effects.length = 0

for (i = 0, l = this.cleanups.length; i < l; i++) {
this.cleanups[i]()
}
this.cleanups.length = 0

if (this.scopes) {
for (i = 0, l = this.scopes.length; i < l; i++) {
this.scopes[i].stop(true)
}
this.scopes.length = 0
}

// nested scope, dereference from parent to avoid memory leaks
if (!this.detached && this.parent && !fromParent) {
// optimized O(1) removal
Expand Down
3 changes: 1 addition & 2 deletions packages/runtime-core/__tests__/apiWatch.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ import {
} from '@vue/runtime-test'
import {
type DebuggerEvent,
EffectFlags,
ITERATE_KEY,
type Ref,
type ShallowRef,
Expand Down Expand Up @@ -1341,7 +1340,7 @@ describe('api: watch', () => {
await nextTick()
await nextTick()

expect(instance!.scope.effects[0].flags & EffectFlags.ACTIVE).toBeFalsy()
expect(instance!.scope.effects.length).toBe(0)
})

test('this.$watch should pass `this.proxy` to watch source as the first argument ', () => {
Expand Down