Unverified Commit 79227ee7 authored by Jiachi Liu's avatar Jiachi Liu Committed by GitHub

Catch layout error in global-error (#52654)

When there's a runtime error showing in root layout (server components), it should be able to catch by `global-error`.

For server components, we caught it and gonna render the error fallback components (either not-found or error page), and the response status is `200`, and since we'll display error dev overlay in developmenet mode so we only render `global-error` for production.

So that you can catch more errors with `global-error` and maybe do potential error tracking on client side.

Follow up of #52573
Closes NEXT-1442

minor refactor: move `appUsingSizeAdjust` into `Metadata` component so that we can just tune the flag as prop
parent 3cde104d
...@@ -25,11 +25,13 @@ export async function MetadataTree({ ...@@ -25,11 +25,13 @@ export async function MetadataTree({
pathname, pathname,
searchParams, searchParams,
getDynamicParamFromSegment, getDynamicParamFromSegment,
appUsingSizeAdjust,
}: { }: {
tree: LoaderTree tree: LoaderTree
pathname: string pathname: string
searchParams: { [key: string]: any } searchParams: { [key: string]: any }
getDynamicParamFromSegment: GetDynamicParamFromSegment getDynamicParamFromSegment: GetDynamicParamFromSegment
appUsingSizeAdjust: boolean
}) { }) {
const metadataContext = { const metadataContext = {
pathname, pathname,
...@@ -56,6 +58,8 @@ export async function MetadataTree({ ...@@ -56,6 +58,8 @@ export async function MetadataTree({
IconsMetadata({ icons: metadata.icons }), IconsMetadata({ icons: metadata.icons }),
]) ])
if (appUsingSizeAdjust) elements.push(<meta name="next-size-adjust" />)
return ( return (
<> <>
{elements.map((el, index) => { {elements.map((el, index) => {
......
...@@ -17,7 +17,10 @@ import type { RequestAsyncStorage } from '../../client/components/request-async- ...@@ -17,7 +17,10 @@ import type { RequestAsyncStorage } from '../../client/components/request-async-
import React from 'react' import React from 'react'
import { NotFound as DefaultNotFound } from '../../client/components/error' import { NotFound as DefaultNotFound } from '../../client/components/error'
import { createServerComponentRenderer } from './create-server-components-renderer' import {
createServerComponentRenderer,
ErrorHtml,
} from './create-server-components-renderer'
import { ParsedUrlQuery } from 'querystring' import { ParsedUrlQuery } from 'querystring'
import { NextParsedUrlQuery } from '../request-meta' import { NextParsedUrlQuery } from '../request-meta'
...@@ -195,7 +198,7 @@ export async function renderToHTMLOrFlight( ...@@ -195,7 +198,7 @@ export async function renderToHTMLOrFlight(
serverActionsBodySizeLimit, serverActionsBodySizeLimit,
} = renderOpts } = renderOpts
const appUsingSizeAdjust = nextFontManifest?.appUsingSizeAdjust const appUsingSizeAdjust = !!nextFontManifest?.appUsingSizeAdjust
const clientReferenceManifest = renderOpts.clientReferenceManifest! const clientReferenceManifest = renderOpts.clientReferenceManifest!
...@@ -1216,8 +1219,8 @@ export async function renderToHTMLOrFlight( ...@@ -1216,8 +1219,8 @@ export async function renderToHTMLOrFlight(
pathname={pathname} pathname={pathname}
searchParams={providedSearchParams} searchParams={providedSearchParams}
getDynamicParamFromSegment={getDynamicParamFromSegment} getDynamicParamFromSegment={getDynamicParamFromSegment}
appUsingSizeAdjust={appUsingSizeAdjust}
/> />
{appUsingSizeAdjust ? <meta name="next-size-adjust" /> : null}
</> </>
), ),
injectedCSS: new Set(), injectedCSS: new Set(),
...@@ -1259,12 +1262,12 @@ export async function renderToHTMLOrFlight( ...@@ -1259,12 +1262,12 @@ export async function renderToHTMLOrFlight(
/** 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').GlobalError ComponentMod.GlobalError as typeof import('../../client/components/error-boundary').GlobalError
let serverComponentsInlinedTransformStream: TransformStream< const serverComponentsInlinedTransformStream: TransformStream<
Uint8Array, Uint8Array,
Uint8Array Uint8Array
> = new TransformStream() > = new TransformStream()
let serverErrorComponentsInlinedTransformStream: TransformStream< const serverErrorComponentsInlinedTransformStream: TransformStream<
Uint8Array, Uint8Array,
Uint8Array Uint8Array
> = new TransformStream() > = new TransformStream()
...@@ -1367,6 +1370,7 @@ export async function renderToHTMLOrFlight( ...@@ -1367,6 +1370,7 @@ export async function renderToHTMLOrFlight(
pathname={pathname} pathname={pathname}
searchParams={providedSearchParams} searchParams={providedSearchParams}
getDynamicParamFromSegment={getDynamicParamFromSegment} getDynamicParamFromSegment={getDynamicParamFromSegment}
appUsingSizeAdjust={appUsingSizeAdjust}
/> />
) )
...@@ -1384,22 +1388,15 @@ export async function renderToHTMLOrFlight( ...@@ -1384,22 +1388,15 @@ export async function renderToHTMLOrFlight(
assetPrefix={assetPrefix} assetPrefix={assetPrefix}
initialCanonicalUrl={pathname} initialCanonicalUrl={pathname}
initialTree={initialTree} initialTree={initialTree}
initialHead={ initialHead={<>{createMetadata(loaderTree)}</>}
<>
{createMetadata(loaderTree)}
{appUsingSizeAdjust ? <meta name="next-size-adjust" /> : null}
</>
}
globalErrorComponent={GlobalError} globalErrorComponent={GlobalError}
notFound={ notFound={
NotFound ? ( NotFound ? (
<html id="__next_error__"> <ErrorHtml>
<body> {createMetadata(loaderTree)}
{createMetadata(loaderTree)} {notFoundStyles}
{notFoundStyles} <NotFound />
<NotFound /> </ErrorHtml>
</body>
</html>
) : undefined ) : undefined
} }
asNotFound={props.asNotFound} asNotFound={props.asNotFound}
...@@ -1480,16 +1477,16 @@ export async function renderToHTMLOrFlight( ...@@ -1480,16 +1477,16 @@ export async function renderToHTMLOrFlight(
let polyfillsFlushed = false let polyfillsFlushed = false
let flushedErrorMetaTagsUntilIndex = 0 let flushedErrorMetaTagsUntilIndex = 0
const getServerInsertedHTML = () => { const getServerInsertedHTML = (serverCapturedErrors: Error[]) => {
// Loop through all the errors that have been captured but not yet // Loop through all the errors that have been captured but not yet
// flushed. // flushed.
const errorMetaTags = [] const errorMetaTags = []
for ( for (
; ;
flushedErrorMetaTagsUntilIndex < allCapturedErrors.length; flushedErrorMetaTagsUntilIndex < serverCapturedErrors.length;
flushedErrorMetaTagsUntilIndex++ flushedErrorMetaTagsUntilIndex++
) { ) {
const error = allCapturedErrors[flushedErrorMetaTagsUntilIndex] const error = serverCapturedErrors[flushedErrorMetaTagsUntilIndex]
if (isNotFoundError(error)) { if (isNotFoundError(error)) {
errorMetaTags.push( errorMetaTags.push(
<meta name="robots" content="noindex" key={error.digest} /> <meta name="robots" content="noindex" key={error.digest} />
...@@ -1571,7 +1568,8 @@ export async function renderToHTMLOrFlight( ...@@ -1571,7 +1568,8 @@ export async function renderToHTMLOrFlight(
dataStream: serverComponentsInlinedTransformStream.readable, dataStream: serverComponentsInlinedTransformStream.readable,
generateStaticHTML: generateStaticHTML:
staticGenerationStore.isStaticGeneration || generateStaticHTML, staticGenerationStore.isStaticGeneration || generateStaticHTML,
getServerInsertedHTML, getServerInsertedHTML: () =>
getServerInsertedHTML(allCapturedErrors),
serverInsertedHTMLToHead: true, serverInsertedHTMLToHead: true,
...validateRootLayout, ...validateRootLayout,
}) })
...@@ -1610,23 +1608,6 @@ export async function renderToHTMLOrFlight( ...@@ -1610,23 +1608,6 @@ 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 use404Error = res.statusCode === 404 const use404Error = res.statusCode === 404
const useDefaultError = res.statusCode < 400 || res.statusCode === 307 const useDefaultError = res.statusCode < 400 || res.statusCode === 307
...@@ -1643,48 +1624,45 @@ export async function renderToHTMLOrFlight( ...@@ -1643,48 +1624,45 @@ export async function renderToHTMLOrFlight(
? interopDefault(await rootLayoutModule()) ? interopDefault(await rootLayoutModule())
: null : null
const serverErrorElement = useDefaultError const serverErrorElement = (
? defaultErrorComponent <ErrorHtml
: React.createElement( head={
createServerComponentRenderer( // @ts-expect-error allow to use async server component
async () => { <MetadataTree
// only pass plain object to client key={requestId}
return ( tree={emptyLoaderTree}
<> pathname={pathname}
{/* @ts-expect-error allow to use async server component */} searchParams={providedSearchParams}
<MetadataTree getDynamicParamFromSegment={getDynamicParamFromSegment}
key={requestId} appUsingSizeAdjust={appUsingSizeAdjust}
tree={emptyLoaderTree} />
pathname={pathname} }
searchParams={providedSearchParams} >
getDynamicParamFromSegment={ {useDefaultError
getDynamicParamFromSegment ? null
} : React.createElement(
/> createServerComponentRenderer(
{use404Error ? ( async () => {
return (
<> <>
<RootLayout params={{}}> {use404Error ? (
{notFoundStyles} <RootLayout params={{}}>
<NotFound /> {notFoundStyles}
</RootLayout> <meta name="robots" content="noindex" />
<NotFound />
</RootLayout>
) : undefined}
</> </>
) : ( )
<GlobalError },
error={{ ComponentMod,
message: err?.message, serverErrorComponentsRenderOpts,
digest: err?.digest, serverComponentsErrorHandler,
}} nonce
/>
)}
</>
) )
}, )}
ComponentMod, </ErrorHtml>
serverErrorComponentsRenderOpts, )
serverComponentsErrorHandler,
nonce
)
)
const renderStream = await renderToInitialStream({ const renderStream = await renderToInitialStream({
ReactDOMServer: require('react-dom/server.edge'), ReactDOMServer: require('react-dom/server.edge'),
...@@ -1713,7 +1691,7 @@ export async function renderToHTMLOrFlight( ...@@ -1713,7 +1691,7 @@ export async function renderToHTMLOrFlight(
: serverErrorComponentsInlinedTransformStream : serverErrorComponentsInlinedTransformStream
).readable, ).readable,
generateStaticHTML: staticGenerationStore.isStaticGeneration, generateStaticHTML: staticGenerationStore.isStaticGeneration,
getServerInsertedHTML, getServerInsertedHTML: () => getServerInsertedHTML([]),
serverInsertedHTMLToHead: true, serverInsertedHTMLToHead: true,
...validateRootLayout, ...validateRootLayout,
}) })
......
...@@ -75,3 +75,18 @@ export function createServerComponentRenderer<Props>( ...@@ -75,3 +75,18 @@ export function createServerComponentRenderer<Props>(
return use(response) return use(response)
} }
} }
export function ErrorHtml({
head,
children,
}: {
head?: React.ReactNode
children?: React.ReactNode
}) {
return (
<html id="__next_error__">
<head>{head}</head>
<body>{children}</body>
</html>
)
}
'use client'
export default function GlobalError({ error }) {
return (
<html>
<head></head>
<body>
<h1>Global Error</h1>
<p id="error">{`Global error: ${error?.message}`}</p>
{error?.digest && <p id="digest">{error?.digest}</p>}
</body>
</html>
)
}
export default function layout() {
throw new Error('Global error: layout error')
}
export const revalidate = 0
export default function page() {
return <div>Page</div>
}
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 - layout error',
{
files: __dirname,
skipDeployment: true,
},
({ next, isNextDev }) => {
it('should render global error for error in server components', async () => {
const browser = await next.browser('/')
if (isNextDev) {
await testDev(browser, /Global error: layout 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+/)
}
})
}
)
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