Unverified Commit b9760b29 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Support global-error for ssr fallback (#52573)

Previously `global-error` only caught the error on client side, this PR adds the support for catching the errors thrown during client components SSR or server components RSC rendering.

Closes #46572
Closes #50119
Closes #50723
parent bcd9136b
...@@ -666,9 +666,15 @@ const nextAppLoader: AppLoader = async function nextAppLoader() { ...@@ -666,9 +666,15 @@ const nextAppLoader: AppLoader = async function nextAppLoader() {
const result = ` const result = `
export ${treeCodeResult.treeCode} export ${treeCodeResult.treeCode}
export ${treeCodeResult.pages} export ${treeCodeResult.pages}
export { default as GlobalError } from ${JSON.stringify(
treeCodeResult.globalError || 'next/dist/client/components/error-boundary' ${
)} treeCodeResult.globalError
? `export { default as GlobalError } from ${JSON.stringify(
treeCodeResult.globalError
)}`
: `export { GlobalError } from 'next/dist/client/components/error-boundary'`
}
export const originalPathname = ${JSON.stringify(page)} export const originalPathname = ${JSON.stringify(page)}
export const __next_app__ = { export const __next_app__ = {
require: __webpack_require__, require: __webpack_require__,
......
...@@ -99,10 +99,10 @@ export class ErrorBoundaryHandler extends React.Component< ...@@ -99,10 +99,10 @@ export class ErrorBoundaryHandler extends React.Component<
} }
} }
export default function GlobalError({ error }: { error: any }) { export function GlobalError({ error }: { error: any }) {
const digest: string | undefined = error?.digest const digest: string | undefined = error?.digest
return ( return (
<html> <html id="__next_error__">
<head></head> <head></head>
<body> <body>
<div style={styles.error}> <div style={styles.error}>
......
...@@ -1224,13 +1224,18 @@ export async function renderToHTMLOrFlight( ...@@ -1224,13 +1224,18 @@ export async function renderToHTMLOrFlight(
const GlobalError = const GlobalError =
/** GlobalError can be either the default error boundary or the overwritten app/global-error.js **/ /** GlobalError can be either the default error boundary or the overwritten app/global-error.js **/
ComponentMod.GlobalError as typeof import('../../client/components/error-boundary').default ComponentMod.GlobalError as typeof import('../../client/components/error-boundary').GlobalError
let serverComponentsInlinedTransformStream: TransformStream< let serverComponentsInlinedTransformStream: TransformStream<
Uint8Array, Uint8Array,
Uint8Array Uint8Array
> = new TransformStream() > = new TransformStream()
let serverErrorComponentsInlinedTransformStream: TransformStream<
Uint8Array,
Uint8Array
> = new TransformStream()
// Get the nonce from the incoming request if it has one. // Get the nonce from the incoming request if it has one.
const csp = req.headers['content-security-policy'] const csp = req.headers['content-security-policy']
let nonce: string | undefined let nonce: string | undefined
...@@ -1245,8 +1250,11 @@ export async function renderToHTMLOrFlight( ...@@ -1245,8 +1250,11 @@ export async function renderToHTMLOrFlight(
rscChunks: [], rscChunks: [],
} }
if (!clientReferenceManifest) { const serverErrorComponentsRenderOpts = {
console.log(req.url) transformStream: serverErrorComponentsInlinedTransformStream,
clientReferenceManifest,
serverContexts,
rscChunks: [],
} }
const validateRootLayout = dev const validateRootLayout = dev
...@@ -1511,7 +1519,7 @@ export async function renderToHTMLOrFlight( ...@@ -1511,7 +1519,7 @@ export async function renderToHTMLOrFlight(
}) })
const result = await continueFromInitialStream(renderStream, { const result = await continueFromInitialStream(renderStream, {
dataStream: serverComponentsInlinedTransformStream?.readable, dataStream: serverComponentsInlinedTransformStream.readable,
generateStaticHTML: generateStaticHTML:
staticGenerationStore.isStaticGeneration || generateStaticHTML, staticGenerationStore.isStaticGeneration || generateStaticHTML,
getServerInsertedHTML, getServerInsertedHTML,
...@@ -1553,24 +1561,61 @@ export async function renderToHTMLOrFlight( ...@@ -1553,24 +1561,61 @@ export async function renderToHTMLOrFlight(
res.setHeader('Location', getURLFromRedirectError(err)) res.setHeader('Location', getURLFromRedirectError(err))
} }
const defaultErrorComponent = (
<html id="__next_error__">
<head>
{/* @ts-expect-error allow to use async server component */}
<MetadataTree
key={requestId}
tree={emptyLoaderTree}
pathname={pathname}
searchParams={providedSearchParams}
getDynamicParamFromSegment={getDynamicParamFromSegment}
/>
{appUsingSizeAdjust ? <meta name="next-size-adjust" /> : null}
</head>
<body></body>
</html>
)
const useDefaultError =
res.statusCode < 400 ||
res.statusCode === 404 ||
res.statusCode === 307
const serverErrorElement = useDefaultError
? defaultErrorComponent
: React.createElement(
createServerComponentRenderer(
async () => {
// only pass plain object to client
return (
<>
{/* @ts-expect-error allow to use async server component */}
<MetadataTree
key={requestId}
tree={emptyLoaderTree}
pathname={pathname}
searchParams={providedSearchParams}
getDynamicParamFromSegment={
getDynamicParamFromSegment
}
/>
<GlobalError
error={{ message: err?.message, digest: err?.digest }}
/>
</>
)
},
ComponentMod,
serverErrorComponentsRenderOpts,
serverComponentsErrorHandler,
nonce
)
)
const renderStream = await renderToInitialStream({ const renderStream = await renderToInitialStream({
ReactDOMServer: require('react-dom/server.edge'), ReactDOMServer: require('react-dom/server.edge'),
element: ( element: serverErrorElement,
<html id="__next_error__">
<head>
{/* @ts-expect-error allow to use async server component */}
<MetadataTree
key={requestId}
tree={emptyLoaderTree}
pathname={pathname}
searchParams={providedSearchParams}
getDynamicParamFromSegment={getDynamicParamFromSegment}
/>
{appUsingSizeAdjust ? <meta name="next-size-adjust" /> : null}
</head>
<body></body>
</html>
),
streamOptions: { streamOptions: {
nonce, nonce,
// Include hydration scripts in the HTML // Include hydration scripts in the HTML
...@@ -1590,7 +1635,10 @@ export async function renderToHTMLOrFlight( ...@@ -1590,7 +1635,10 @@ export async function renderToHTMLOrFlight(
}) })
return await continueFromInitialStream(renderStream, { return await continueFromInitialStream(renderStream, {
dataStream: serverComponentsInlinedTransformStream?.readable, dataStream: (useDefaultError
? serverComponentsInlinedTransformStream
: serverErrorComponentsInlinedTransformStream
).readable,
generateStaticHTML: staticGenerationStore.isStaticGeneration, generateStaticHTML: staticGenerationStore.isStaticGeneration,
getServerInsertedHTML, getServerInsertedHTML,
serverInsertedHTMLToHead: true, serverInsertedHTMLToHead: true,
......
...@@ -59,7 +59,13 @@ export function useFlightResponse( ...@@ -59,7 +59,13 @@ export function useFlightResponse(
) )
} }
if (done) { if (done) {
flightResponseRef.current = null // Add a setTimeout here because the error component is too small, the first forwardReader.read() read will return the full chunk
// and then it immediately set flightResponseRef.current as null.
// react renders the component twice, the second render will run into the state with useFlightResponse where flightResponseRef.current is null,
// so it tries to render the flight payload again
setTimeout(() => {
flightResponseRef.current = null
})
writer.close() writer.close()
} else { } else {
const responsePartial = decodeText(value, textDecoder) const responsePartial = decodeText(value, textDecoder)
......
...@@ -5,7 +5,9 @@ export default function GlobalError({ error }) { ...@@ -5,7 +5,9 @@ export default function GlobalError({ error }) {
<html> <html>
<head></head> <head></head>
<body> <body>
<div id="error">{`Error message: ${error?.message}`}</div> <h1>Global Error</h1>
<p id="error">{`Global error: ${error?.message}`}</p>
{error?.digest && <p id="digest">{error?.digest}</p>}
</body> </body>
</html> </html>
) )
......
...@@ -6,3 +6,5 @@ export default function Layout({ children }) { ...@@ -6,3 +6,5 @@ export default function Layout({ children }) {
</html> </html>
) )
} }
export const revalidate = 0
'use client'
export default function page() {
throw new Error('client page error')
}
export default function page() {
throw new Error('server page error')
}
import { getRedboxHeader, hasRedbox } from 'next-test-utils'
import { createNextDescribe } from 'e2e-utils'
createNextDescribe(
'app dir - global error',
{
files: __dirname,
},
({ next, isNextDev }) => {
it('should trigger error component when an error happens during rendering', async () => {
const browser = await next.browser('/throw')
await browser
.waitForElementByCss('#error-trigger-button')
.elementByCss('#error-trigger-button')
.click()
if (isNextDev) {
expect(await hasRedbox(browser, true)).toBe(true)
expect(await getRedboxHeader(browser)).toMatch(/Error: Client error/)
} else {
await browser
expect(await browser.elementByCss('#error').text()).toBe(
'Error message: Client error'
)
}
})
}
)
import { getRedboxHeader, hasRedbox } from 'next-test-utils'
import { createNextDescribe } from 'e2e-utils'
async function testDev(browser, errorRegex) {
expect(await hasRedbox(browser, true)).toBe(true)
expect(await getRedboxHeader(browser)).toMatch(errorRegex)
}
createNextDescribe(
'app dir - global error',
{
files: __dirname,
},
({ next, isNextDev }) => {
it('should trigger error component when an error happens during rendering', async () => {
const browser = await next.browser('/client')
await browser
.waitForElementByCss('#error-trigger-button')
.elementByCss('#error-trigger-button')
.click()
if (isNextDev) {
await testDev(browser, /Error: Client error/)
} else {
await browser
expect(await browser.elementByCss('#error').text()).toBe(
'Global error: Client error'
)
}
})
it('should render global error for error in server components', async () => {
const browser = await next.browser('/ssr/server')
if (isNextDev) {
await testDev(browser, /Error: server page error/)
} else {
expect(await browser.elementByCss('h1').text()).toBe('Global Error')
expect(await browser.elementByCss('#error').text()).toBe(
'Global error: An error occurred in the Server Components render. The specific message is omitted in production builds to avoid leaking sensitive details. A digest property is included on this error instance which may provide additional details about the nature of the error.'
)
expect(await browser.elementByCss('#digest').text()).toMatch(/\w+/)
}
})
it('should render global error for error in client components', async () => {
const browser = await next.browser('/ssr/client')
if (isNextDev) {
await testDev(browser, /Error: client page error/)
} else {
expect(await browser.elementByCss('h1').text()).toBe('Global Error')
expect(await browser.elementByCss('#error').text()).toBe(
'Global error: client page error'
)
expect(await browser.hasElementByCssSelector('#digest')).toBeFalsy()
}
})
}
)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment