Backtestsvuerun-20261013-093701#15113
SSR memory leak - options API watchers are created and never stopped with async setup()
Our patch was judged better than the merged fix.
In this judgment, Patch B = our agent, Patch A = the merged fix.
The production code changes are functionally identical. Both wrap handleSetupResult in the async `.then` with setInSSRSetupState(true)/false inside a try/finally. That restores SSR setup state while applyOptions runs, so options API watchers follow the same SSR path as with sync setup. Both fix the root cause equally. The difference is in the tests. Patch A adds the issue's reproduction plus a GC-based retention test, which is meaningful but skipped unless global.gc is available. Patch B adds the reproduction plus tests for immediate and sync-flush options watchers, including a check that the immediate watcher's handle is registered in ctx.__watcherHandles for cleanup, and a this.$watch-in-created() case. These would all fail before the fix and cover more of the affected code paths (immediate handling, flush:'sync', $watch) that run through applyOptions after async setup. B also adds a short comment explaining why SSR setup state is restored, which helps maintainers. A's GC test does verify the memory-leak symptom directly, but it runs conditionally. B's broader deterministic coverage gives it the edge.
The judge saw only the two patches, labelled A and B in random order, with issue links and version numbers removed. The reasoning above is shown verbatim.
Solve
5m
Wall-clock time in the container
Full test suite
No new failures
1,739 passed · 1 skipped · 1,740 total
Contamination audit
Clean
No sign the agent saw the real fix
Patch size
98vs 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
packages/runtime-core/src/component.tsindex c46741bee..e4e7af42b 100644@@ -894,7 +894,15 @@ function setupStatefulComponent( // return the promise so server-renderer can wait on it return setupResult .then((resolvedResult: unknown) => {- handleSetupResult(instance, resolvedResult, isSSR)+ // restore SSR setup state so that options API (watch, computed,+ // lifecycle hooks) applied after async setup behaves the same as+ // with sync setup (e.g. watchers are not left active)+ 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..0923a9bdc 100644@@ -352,3 +352,91 @@ describe.skipIf(!global.gc)('ssr: watch gc', () => { expect(weakRefs.filter(ref => ref.deref()).length).toBe(0) }) })++describe('ssr: options API watch with async setup', () => {+ test('options API watchers should not be active after render with async setup', 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('options API immediate/sync watchers should be stopped after render with async setup', async () => {+ const source = ref(0)+ const immediateSpy = vi.fn()+ const syncSpy = vi.fn()++ const App = defineComponent({+ setup: () => Promise.resolve({}),+ computed: {+ value() {+ return source.value+ },+ },+ watch: {+ value: [+ { handler: immediateSpy, immediate: true },+ { handler: syncSpy, flush: 'sync' },+ ],+ },+ render() {+ return h('div', String(this.value))+ },+ })++ const ctx: SSRContext = {}+ const html = await renderToString(createSSRApp(App), ctx)+ expect(html).toBe('<div>0</div>')+ expect(immediateSpy).toHaveBeenCalledTimes(1)+ expect(syncSpy).not.toHaveBeenCalled()+ expect(ctx.__watcherHandles!.length).toBe(1)++ source.value+++ await nextTick()+ expect(immediateSpy).toHaveBeenCalledTimes(1)+ expect(syncSpy).not.toHaveBeenCalled()+ })++ test('this.$watch in created() should not be active after render with async setup', async () => {+ const source = ref(0)+ const spy = vi.fn()++ const App = defineComponent({+ setup: () => Promise.resolve({}),+ created() {+ this.$watch(() => source.value, spy)+ },+ render() {+ return h('div', String(source.value))+ },+ })++ const html = await renderToString(createSSRApp(App))+ expect(html).toBe('<div>0</div>')++ source.value+++ await nextTick()+ expect(spy).not.toHaveBeenCalled()+ })+})
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)+ }) })