Backtestsvuerun-20261002-115633#15113
SSR memory leak - options API watchers are created and never stopped with async setup()
The harness couldn't finish this ticket.
The solver produced no patch.. No judgment was produced for this ticket. It counts as an error in the run total.
Solve
6m 58s
Wall-clock time in the container
Full test suite
Not run
The harness did not reach the test stage
Contamination audit
Clean
No sign the agent saw the real fix
Patch size
0vs 76 merged
Changed lines, ours vs merged
The issue
View on GitHubVue version
3.5.40
Steps to reproduce
originally reported in https://github.com/nuxt/nuxt/issues/30782
- create an options API component with an
async setup(), acomputedproperty that reads shared module-level state, and awatchon that - render it on the server and then mutate the shared state after the render is done
- see that the watcher is still active on the server
Reproduction
test('options-api watchers should not be created for async setup components', async () => {
const open = ref(true)
const spy = vi.fn()
const App = defineComponent({
setup: () => Promise.resolve({}),
computed: {
isOpen() {
return open.value
},
},
watch: {
isOpen: spy,
},
render() {
return h('div', String(this.isOpen))
},
})
const html = await renderToString(createSSRApp(App))
expect(html).toBe('<div>true</div>')
// mutating the state after the request is done should not trigger the watcher
open.value = false
await nextTick()
expect(spy).not.toHaveBeenCalled()
})
What is expected?
the same behavior as with a synchronous setup: regular watchers declared via the watch option don't run during SSR and don't survive the render
mutating the shared state after renderToString resolves should not trigger anything
What is actually happening?
when setup() returns a Promise, the watch option creates a live watcher on the server that is never stopped
if this subscribes to state that outlives the request, it keeps the entire component instance (and app) reachable forever
System Info
Any additional comments?
_No response_
The two patches
No patch was produced.packages/runtime-core/src/component.tsindex c46741bee..162a6ad44 100644@@ -894,7 +894,12 @@ function setupStatefulComponent( // return the promise so server-renderer can wait on it return setupResult .then((resolvedResult: unknown) => {- handleSetupResult(instance, resolvedResult, isSSR)+ setInSSRSetupState(true)+ try {+ handleSetupResult(instance, resolvedResult, isSSR)+ } finally {+ setInSSRSetupState(false)+ } }) .catch(e => { handleError(e, instance, ErrorCodes.SETUP_FUNCTION)packages/server-renderer/__tests__/ssrWatch.spec.tsindex 2b1ad98d2..2dad83cd2 100644@@ -130,6 +130,35 @@ describe('ssr: watch', () => { expect(msg).toBe('start') }) + // #15113+ test('options-api watchers should not be created for async setup components', async () => {+ const open = ref(true)+ const spy = vi.fn()++ const App = defineComponent({+ setup: () => Promise.resolve({}),+ computed: {+ isOpen() {+ return open.value+ },+ },+ watch: {+ isOpen: spy,+ },+ render() {+ return h('div', String(this.isOpen))+ },+ })++ const html = await renderToString(createSSRApp(App))+ expect(html).toBe('<div>true</div>')++ // mutating the state after the request is done should not trigger the watcher+ open.value = false+ await nextTick()+ expect(spy).not.toHaveBeenCalled()+ })+ test('should not run non-immediate watchers registered after async context restore', async () => { const text = ref('start') let beforeAwaitTriggered = false@@ -351,4 +380,44 @@ describe.skipIf(!global.gc)('ssr: watch gc', () => { expect(weakRefs.filter(ref => ref.deref()).length).toBe(0) })++ // #15113+ test('options-api should not retain apps with async setup + watcher on global state', async () => {+ const weakRefs: { deref(): unknown | undefined }[] = []++ const open = ref(true)++ const App = defineComponent({+ setup: () => Promise.resolve({}),+ computed: {+ isOpen() {+ return open.value+ },+ },+ watch: {+ isOpen() {},+ },+ render() {+ return h('div', String(this.isOpen))+ },+ })++ async function renderOnce() {+ const app = createSSRApp(App)+ // @ts-expect-error ES2021 API+ weakRefs.push(new WeakRef(app))+ const html = await renderToString(app)+ expect(html).toBe('<div>true</div>')+ }++ for (let i = 0; i < 10; i++) {+ await renderOnce()+ }++ for (let i = 0; i < 5; i++) {+ await gc()+ }++ expect(weakRefs.filter(ref => ref.deref()).length).toBe(0)+ }) })