Skip to content

Commit

Permalink
fix(watch): unwatch should be callable during SSR (#11925)
Browse files Browse the repository at this point in the history
close #11924
  • Loading branch information
deleteme authored Sep 16, 2024
1 parent bc3ddca commit 2d6adf7
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 5 deletions.
38 changes: 38 additions & 0 deletions packages/runtime-core/__tests__/apiWatch.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ import {
toRef,
triggerRef,
} from '@vue/reactivity'
import { renderToString } from '@vue/server-renderer'

describe('api: watch', () => {
it('effect', async () => {
Expand Down Expand Up @@ -373,6 +374,43 @@ describe('api: watch', () => {
expect(dummy).toBe(0)
})

it('stopping the watcher (SSR)', async () => {
let dummy = 0
const count = ref<number>(1)
const captureValue = (value: number) => {
dummy = value
}
const watchCallback = vi.fn(newValue => {
captureValue(newValue)
})
const Comp = defineComponent({
created() {
const getter = () => this.count
captureValue(getter()) // sets dummy to 1
const stop = this.$watch(getter, watchCallback)
stop()
this.count = 2 // shouldn't trigger side effect
},
render() {
return h('div', this.count)
},
setup() {
return { count }
},
})
let html
html = await renderToString(h(Comp))
// should not throw here
expect(html).toBe(`<div>2</div>`)
expect(watchCallback).not.toHaveBeenCalled()
expect(dummy).toBe(1)
await nextTick()
count.value = 3 // shouldn't trigger side effect
await nextTick()
expect(watchCallback).not.toHaveBeenCalled()
expect(dummy).toBe(1)
})

it('stopping the watcher (with source)', async () => {
const state = reactive({ count: 0 })
let dummy
Expand Down
10 changes: 5 additions & 5 deletions packages/runtime-core/src/apiWatch.ts
Original file line number Diff line number Diff line change
Expand Up @@ -179,11 +179,11 @@ function doWatch(
// immediately watch or watchEffect
baseWatchOptions.once = true
} else {
return {
stop: NOOP,
resume: NOOP,
pause: NOOP,
} as WatchHandle
const watchStopHandle = () => {}
watchStopHandle.stop = NOOP
watchStopHandle.resume = NOOP
watchStopHandle.pause = NOOP
return watchStopHandle
}
}

Expand Down

0 comments on commit 2d6adf7

Please sign in to comment.