Backtestsvuerun-20261009-161443#12575
Vue is not catching errors on server side in SSR when using async child setup
Our patch was judged better than the merged fix.
In this judgment, Patch B = our agent, Patch A = the merged fix.
The issue has two parts: the child's template should not be rendered once its async setup has thrown, and the error should reach the parent's onErrorCaptured. Patch B fixes this at the root. Its runtime-core change re-throws from the SSR async-setup `.catch` after `handleError`, so the error still reaches errorCaptured or the app errorHandler. The server renderer then sees the rejection, sets `setupFailed`, and emits a `<!---->` placeholder instead of calling `renderComponentSubTree`. This also skips serverPrefetch on the failed instance. It matches client-side behavior, where a failed async component leaves a comment placeholder, and it never touches incomplete setup state. Its tests check the right things: the subtree is not rendered, the render function is never called, siblings still render, errorCaptured is called exactly once, and the spurious 'missing template' warnings are gone from the existing Suspense tests. Patch A treats only the symptom. It still renders the child's template with missing state, then catches the resulting TypeError in `renderComponentSubTree` and routes it through `handleError`. Its own test confirms this: two errors are captured, the real one plus a "Cannot read properties of undefined" error, and a 'Property foo was accessed during render' warning appears. That is exactly the behavior the issue complains about, now caught rather than prevented. Patch A also changes SSR render-error handling for every component (render errors now go to handleError, followed by a Promise.reject conversion), which is a broader behavior change with more risk. Patch B is the more correct, root-cause fix with better-targeted tests.
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 47s
Wall-clock time in the container
Full test suite
No new failures
1,732 passed · 1 skipped · 1,733 total
Contamination audit
Clean
No sign the agent saw the real fix
Patch size
113vs 58 merged
Changed lines, ours vs merged
The issue
View on GitHubVue version
3.5.13
Link to minimal reproduction
Steps to reproduce
Just open a link and you will see errors when SSR is ON.
When SSR is OFF everything works as expected.
Also, commeting the line with top-level await (making Comp.vue a sync component) will also work fine both with and without SSR.
What is expected?
In SSR mode the page is expected to be blank white for 1 second and then display error message from App.vue.
This works as expected with SSR turned off.
Basically onErrorCaptured should be triggered, child setup and <template> render immediately stopped and error message from parent component shown.
What is actually happening?
In SSR mode the page is blank for 1 second but then it tries to render the <template> of Comp.vue using the data that might not even exist (because it appears in setup after throwing error).
And even if it manages to render <template> correctly, it still does not trigger onErrorCaptured in App.vue and do not switch to show error message.
Any additional comments?
I am building a custom rendering package built on top of Vue and it heavily uses structures like these:
// Wrappers are supposed to catch ALL errors and throws in child <Block /> and show nice error message
<BlockWrapper>
<Block ... />
</BlockWrapper>
<BlockWrapper>
<Block ... />
</BlockWrapper>
<BlockWrapper>
<Block ... />
</BlockWrapper>
...
Because of this bug OR my misunderstanding of how to handle async errors in Vue 3, even when thrown it still tries to render child block's <template> even with missing data (because setup is stopped executing), throws on reading properties of non-existing objects and the whole Nuxt page breaks.
Please, don't tell me this is a no-fix. It would be a disaster... 😭
The two patches
packages/runtime-core/src/component.tsindex c46741bee..6a13e7e21 100644@@ -898,6 +898,9 @@ function setupStatefulComponent( }) .catch(e => { handleError(e, instance, ErrorCodes.SETUP_FUNCTION)+ // re-throw so the server-renderer knows setup failed and skips+ // rendering the component's subtree with incomplete setup state+ throw e }) } else if (__FEATURE_SUSPENSE__) { // async setup returned Promise.packages/server-renderer/__tests__/render.spec.tsindex 268c7dc1e..a37a0948b 100644@@ -935,7 +935,8 @@ function testRender(type: string, render: typeof renderToString) { } const html = await renderToString(app)- expect(html).toBe(`<div class="app"><div>asyncChildren</div></div>`)+ // the child's subtree must not be rendered after its setup failed (#12575)+ expect(html).toBe(`<div class="app"><!----></div>`) expect(fn).toHaveBeenCalledTimes(1) expect(fn).toBeCalledWith('async child error')@@ -944,6 +945,69 @@ function testRender(type: string, render: typeof renderToString) { expect(fn2).toBeCalledWith('async child error') }) + // #12575+ test('should not render subtree of component whose async setup throws', async () => {+ const captured = vi.fn()+ const childPrefetch = vi.fn()+ const Child = defineComponent({+ async setup() {+ const res = await Promise.resolve({ ok: false })+ if (!res.ok) throw new Error('async setup error')+ return { data: { msg: 'unreachable' } }+ },+ serverPrefetch: childPrefetch,+ template: `<div>{{ data.msg }}</div>`,+ })+ const Sibling = {+ async setup() {+ await Promise.resolve()+ return { msg: 'ok' }+ },+ template: `<span>{{ msg }}</span>`,+ }+ const app = createApp({+ components: { Child, Sibling },+ setup() {+ onErrorCaptured(err => {+ captured((err as Error).message)+ return false+ })+ },+ template: `<div><Child /><Sibling /></div>`,+ })+ app.config.errorHandler = () => {+ throw new Error('errorHandler should not be reached')+ }++ const html = await render(app)+ expect(html).toBe(`<div><!----><span>ok</span></div>`)+ expect(captured).toHaveBeenCalledTimes(1)+ expect(captured).toHaveBeenCalledWith('async setup error')+ expect(childPrefetch).not.toHaveBeenCalled()+ })++ // #12575+ test('should not render subtree of async setup component with render function', async () => {+ const handler = vi.fn()+ const childRender = vi.fn(() => h('div', 'child'))+ const Child = {+ async setup() {+ throw new Error('async setup error')+ },+ render: childRender,+ }+ const app = createApp({+ render: () => h('div', [h(Child), h('p', 'after')]),+ })+ app.config.errorHandler = err => handler((err as Error).message)++ const html = await render(app)+ expect(html).toBe(`<div><!----><p>after</p></div>`)+ expect(handler).toHaveBeenCalledTimes(1)+ expect(handler).toHaveBeenCalledWith('async setup error')+ expect(childRender).not.toHaveBeenCalled()+ })+ // https://github.com/vuejs/core/issues/3322 test('effect onInvalidate does not error', async () => { const noop = () => {}packages/server-renderer/__tests__/ssrSuspense.spec.tsindex 5f8cecaf9..973c80690 100644@@ -43,7 +43,7 @@ describe('SSR Suspense', () => { expect(await renderToString(createApp(Comp))).toBe(`<!---->`) expect(Comp.errorCaptured).toHaveBeenCalledTimes(1)- expect('missing template').toHaveBeenWarned()+ expect('missing template').not.toHaveBeenWarned() }) test('2 components', async () => {@@ -77,7 +77,7 @@ describe('SSR Suspense', () => { ) expect(Comp.errorCaptured).toHaveBeenCalledTimes(1)- expect('missing template or render function').toHaveBeenWarned()+ expect('missing template or render function').not.toHaveBeenWarned() }) test('failing suspense in passing suspense', async () => {@@ -102,7 +102,7 @@ describe('SSR Suspense', () => { ) expect(Comp.errorCaptured).toHaveBeenCalledTimes(1)- expect('missing template').toHaveBeenWarned()+ expect('missing template').not.toHaveBeenWarned() }) // nuxt/nuxt#28162@@ -148,6 +148,6 @@ describe('SSR Suspense', () => { `<div><!----><div><div>async</div></div></div>`, ) expect(Comp.errorCaptured).toHaveBeenCalledTimes(1)- expect('missing template').toHaveBeenWarned()+ expect('missing template').not.toHaveBeenWarned() }) })packages/server-renderer/src/render.tsindex 8fc9b0128..c20e44bc9 100644@@ -105,19 +105,35 @@ export function renderComponentVNode( const hasAsyncSetup = isPromise(res) let prefetches = instance.sp /* LifecycleHooks.SERVER_PREFETCH */ if (hasAsyncSetup || prefetches) {+ let setupFailed = false const p: Promise<unknown> = Promise.resolve(res as Promise<void>)- .then(() => {- // instance.sp may be null until an async setup resolves, so evaluate it here- if (hasAsyncSetup) prefetches = instance.sp- if (prefetches) {- return Promise.all(- prefetches.map(prefetch => prefetch.call(instance.proxy)),- )- }- })+ .then(+ () => {+ // instance.sp may be null until an async setup resolves, so evaluate it here+ if (hasAsyncSetup) prefetches = instance.sp+ if (prefetches) {+ return Promise.all(+ prefetches.map(prefetch => prefetch.call(instance.proxy)),+ )+ }+ },+ () => {+ // async setup rejected: the error has already been passed to+ // errorCaptured / app.config.errorHandler by setupComponent().+ setupFailed = true+ },+ ) // Note: error display is already done by the wrapped lifecycle hook function. .catch(NOOP)- return p.then(() => renderComponentSubTree(instance, slotScopeId))+ return p.then(() => {+ if (setupFailed) {+ // do not render the subtree since setup state is incomplete (#12575)+ const { getBuffer, push } = createBuffer()+ push(`<!---->`)+ return getBuffer()+ }+ return renderComponentSubTree(instance, slotScopeId)+ }) } else { return renderComponentSubTree(instance, slotScopeId) }
packages/server-renderer/__tests__/render.spec.tsindex 268c7dc1e..f537a6219 100644@@ -12,6 +12,7 @@ import { defineComponent, getCurrentInstance, h,+ nextTick, onErrorCaptured, onServerPrefetch, reactive,@@ -822,6 +823,9 @@ function testRender(type: string, render: typeof renderToString) { ) } catch {} expect(getCurrentInstance()).toBe(prev)+ expect(+ '[Vue warn]: Unhandled error during execution of render function',+ ).toHaveBeenWarned() }) // #7733@@ -1191,6 +1195,40 @@ function testRender(type: string, render: typeof renderToString) { expect((capturedError as unknown as Error).message).toBe('An error') }) + test('async setup throwing error', async () => {+ const capturedError: string[] = []++ const Child = {+ async setup() {+ await nextTick()+ throw new Error('An error')+ return { foo: { bar: 1 } }+ },+ template: `<span>{{ foo.bar }}</span>`,+ }++ const app = createApp({+ components: { Child },+ setup() {+ onErrorCaptured(e => {+ capturedError.push(e.message)+ return false+ })+ },+ template: `<Suspense><Child /></Suspense>`,+ })++ expect(await render(app)).toBe('')+ expect(capturedError.length).toBe(2)+ expect(capturedError).toStrictEqual([+ 'An error',+ "Cannot read properties of undefined (reading 'bar')",+ ])+ expect(+ '[Vue warn]: Property "foo" was accessed during render but is not defined on instance',+ ).toHaveBeenWarned()+ })+ test('computed reactivity during SSR with onServerPrefetch', async () => { const store = { // initial state could be hydratedpackages/server-renderer/__tests__/ssrSuspense.spec.tsindex 5f8cecaf9..2cc3da1cd 100644@@ -107,9 +107,10 @@ describe('SSR Suspense', () => { // nuxt/nuxt#28162 test('propagates sync errors from compiled ssrRenderSuspense default slot', async () => {+ const error = new TypeError('bang') const Throwing = defineComponent({ ssrRender(_ctx: any, _push: any) {- throw new TypeError('bang')+ throw error }, }) @@ -124,7 +125,10 @@ describe('SSR Suspense', () => { }, }) - await expect(renderToString(createApp(Root))).rejects.toThrow('bang')+ await expect(renderToString(createApp(Root))).rejects.toBe(error)+ expect(+ '[Vue warn]: Unhandled error during execution of render function',+ ).toHaveBeenWarnedTimes(1) }) test('passing suspense in failing suspense', async () => {packages/server-renderer/src/render.tsindex 8fc9b0128..c2bde4d1e 100644@@ -3,6 +3,7 @@ import { type Component, type ComponentInternalInstance, type DirectiveBinding,+ ErrorCodes, Fragment, type FunctionalComponent, Static,@@ -10,6 +11,7 @@ import { type VNode, type VNodeArrayChildren, type VNodeProps,+ handleError, mergeProps, ssrUtils, warn,@@ -119,7 +121,13 @@ export function renderComponentVNode( .catch(NOOP) return p.then(() => renderComponentSubTree(instance, slotScopeId)) } else {- return renderComponentSubTree(instance, slotScopeId)+ try {+ return renderComponentSubTree(instance, slotScopeId)+ } catch (err) {+ // let the SSR buffer propagate the error so parent render functions+ // don't handle the same error again+ return Promise.reject(err)+ } } } @@ -201,6 +209,8 @@ function renderComponentSubTree( instance.data, instance.ctx, )+ } catch (err) {+ handleError(err, instance, ErrorCodes.RENDER_FUNCTION) } finally { setCurrentRenderingInstance(prev) }