Skip to content

Commit

Permalink
fix(reactivity): onCleanup also needs to be cleaned (#8655)
Browse files Browse the repository at this point in the history
close #5151
close #7695
  • Loading branch information
花果山大圣 authored Nov 10, 2023
1 parent 3227e50 commit 73fd810
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 1 deletion.
35 changes: 35 additions & 0 deletions packages/runtime-core/__tests__/apiWatch.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1205,4 +1205,39 @@ describe('api: watch', () => {
expect(countWE).toBe(3)
expect(countW).toBe(2)
})

// #5151
test('OnCleanup also needs to be cleaned,', async () => {
const spy1 = vi.fn()
const spy2 = vi.fn()
const num = ref(0)

watch(num, (value, oldValue, onCleanup) => {
if (value > 1) {
return
}
spy1()
onCleanup(() => {
// OnCleanup also needs to be cleaned
spy2()
})
})

num.value++
await nextTick()
expect(spy1).toHaveBeenCalledTimes(1)
expect(spy2).toHaveBeenCalledTimes(0)

num.value++
await nextTick()

expect(spy1).toHaveBeenCalledTimes(1)
expect(spy2).toHaveBeenCalledTimes(1)

num.value++
await nextTick()
// would not be calld when value>1
expect(spy1).toHaveBeenCalledTimes(1)
expect(spy2).toHaveBeenCalledTimes(1)
})
})
3 changes: 2 additions & 1 deletion packages/runtime-core/src/apiWatch.ts
Original file line number Diff line number Diff line change
Expand Up @@ -273,10 +273,11 @@ function doWatch(
getter = () => traverse(baseGetter())
}

let cleanup: () => void
let cleanup: (() => void) | undefined
let onCleanup: OnCleanup = (fn: () => void) => {
cleanup = effect.onStop = () => {
callWithErrorHandling(fn, instance, ErrorCodes.WATCH_CLEANUP)
cleanup = effect.onStop = undefined
}
}

Expand Down

0 comments on commit 73fd810

Please sign in to comment.