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(runtime-core): unwatch should be callable during SSR #11925

Merged
merged 2 commits into from
Sep 16, 2024
Merged

fix(runtime-core): unwatch should be callable during SSR #11925

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aad376c
fix(runtime-core): unwatch should be callable during SSR
deleteme Sep 13, 2024
3d993ec
chore: update test
yyx990803 Sep 16, 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
38 changes: 38 additions & 0 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 @@ -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
View file
Open in desktop
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
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I considered doing this:

return Object.assign(() => {}, {
  stop: NOOP,
  resume: NOOP,
  pause: NOOP,
})

But decided against it to avoid the temporary allocation of the object literal.

}
}

Expand Down