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

Recover not found errors from flight data to render with proper boundary (#53703)

### What?

We change the not-found rendering strategy to the origin one which recovers the not found error from the flight data, and hit the error boundary to display the closet not found component.

For parallel `@slot` we shouldn't pass down the not-found boundary, the boundary is only for `@children`.

### Why?

We're having a lot of not-found matching issues that manually searching for not found and layout won't be accurate as we have various scenarios like `(group)` routes, dynamic routes, etc.

### How?

Only render html with empty body so that the error can recover from flight and render the proper not-found component during hydration.

One change for metadata is that we need to get the "not-found" metadata in the initial render, so we'll catch the not-found error once there first and start render the "not-found" metadata and put it in the flight data. Then when it recovers it's still preserved.

Fixes #53694
parent ea0bb977
......@@ -49,7 +49,8 @@ function runTests(harness: Harness, iframe: HTMLIFrameElement) {
)
// TODO: This test is flaky, so it needs a particularly long timeout.
it(
// TODO(WEB-980) Fix this test once we no longer throw an error when rendering a 404 page.
it.skip(
'renders a custom 404 page',
async () => {
await harness.load(iframe, '/not-found')
......
......@@ -319,6 +319,17 @@ async function createTreeCodeFromPath(
globalError = await resolver(
`${path.dirname(layoutPath)}/${GLOBAL_ERROR_FILE_TYPE}`
)
const hasNotFound = definedFilePaths.some(
([type]) => type === 'not-found'
)
// Add default not found error as root not found if not present
if (!hasNotFound) {
const notFoundPath = 'next/dist/client/components/not-found-error'
if (notFoundPath) {
definedFilePaths.push(['not-found', notFoundPath])
}
}
}
}
......
'use client'
import React from 'react'
import { usePathname } from './navigation'
......
......@@ -35,7 +35,7 @@ const styles: Record<string, React.CSSProperties> = {
},
}
export function NotFound() {
export default function NotFound() {
return (
<>
{/* <head> */}
......
......@@ -16,10 +16,11 @@ import {
AppLinksMeta,
} from './generate/opengraph'
import { IconsMetadata } from './generate/icons'
import { accumulateMetadata, resolveMetadata } from './resolve-metadata'
import { resolveMetadata } from './resolve-metadata'
import { MetaFilter } from './generate/meta'
import { ResolvedMetadata } from './types/metadata-interface'
import { createDefaultMetadata } from './default-metadata'
import { isNotFoundError } from '../../client/components/not-found'
// Use a promise to share the status of the metadata resolving,
// returning two components `MetadataTree` and `MetadataOutlet`
......@@ -55,24 +56,44 @@ export function createMetadataComponents({
async function MetadataTree() {
const defaultMetadata = createDefaultMetadata()
let metadata: ResolvedMetadata | undefined = defaultMetadata
try {
const resolvedMetadata = await resolveMetadata({
tree,
parentParams: {},
metadataItems: [],
searchParams,
getDynamicParamFromSegment,
errorConvention: errorType === 'redirect' ? undefined : errorType,
})
let error: any
const errorMetadataItem: [null, null] = [null, null]
const errorConvention = errorType === 'redirect' ? undefined : errorType
// Skip for redirect case as for the temporary redirect case we don't need the metadata on client
if (errorType === 'redirect') {
metadata = defaultMetadata
} else {
metadata = await accumulateMetadata(resolvedMetadata, metadataContext)
}
const [resolvedMetadata, resolvedError] = await resolveMetadata({
tree,
parentParams: {},
metadataItems: [],
errorMetadataItem,
searchParams,
getDynamicParamFromSegment,
errorConvention,
metadataContext,
})
if (!resolvedError) {
metadata = resolvedMetadata
resolve(undefined)
} catch (error: any) {
} else {
error = resolvedError
// If the error triggers in initial metadata resolving, re-resolve with proper error type.
// They'll be saved for flight data, when hydrates, it will replaces the SSR'd metadata with this.
// for not-found error: resolve not-found metadata
if (!errorType && isNotFoundError(resolvedError)) {
const [notFoundMetadata, notFoundMetadataError] = await resolveMetadata(
{
tree,
parentParams: {},
metadataItems: [],
errorMetadataItem,
searchParams,
getDynamicParamFromSegment,
errorConvention: 'not-found',
metadataContext,
}
)
metadata = notFoundMetadata
error = notFoundMetadataError || error
}
resolve(error)
}
......
......@@ -15,7 +15,7 @@ import { resolveTitle } from './resolvers/resolve-title'
import { resolveAsArrayOrUndefined } from './generate/utils'
import { isClientReference } from '../client-reference'
import {
getErrorOrLayoutModule,
getComponentTypeModule,
getLayoutOrPageModule,
LoaderTree,
} from '../../server/lib/app-dir-module'
......@@ -315,21 +315,26 @@ async function resolveStaticMetadata(components: ComponentsType, props: any) {
// [layout.metadata, static files metadata] -> ... -> [page.metadata, static files metadata]
export async function collectMetadata({
tree,
metadataItems: array,
metadataItems,
errorMetadataItem,
props,
route,
errorConvention,
}: {
tree: LoaderTree
metadataItems: MetadataItems
errorMetadataItem: MetadataItems[number]
props: any
route: string
errorConvention?: 'not-found'
}) {
let mod
let modType
const hasErrorConventionComponent = Boolean(
errorConvention && tree[2][errorConvention]
)
if (errorConvention) {
mod = await getErrorOrLayoutModule(tree, errorConvention)
mod = await getComponentTypeModule(tree, 'layout')
modType = errorConvention
} else {
;[mod, modType] = await getLayoutOrPageModule(tree)
......@@ -344,13 +349,23 @@ export async function collectMetadata({
? await getDefinedMetadata(mod, props, { route })
: null
array.push([metadataExport, staticFilesMetadata])
metadataItems.push([metadataExport, staticFilesMetadata])
if (hasErrorConventionComponent && errorConvention) {
const errorMod = await getComponentTypeModule(tree, errorConvention)
const errorMetadataExport = errorMod
? await getDefinedMetadata(errorMod, props, { route })
: null
errorMetadataItem[0] = errorMetadataExport
errorMetadataItem[1] = staticFilesMetadata
}
}
export async function resolveMetadata({
export async function resolveMetadataItems({
tree,
parentParams,
metadataItems,
errorMetadataItem,
treePrefix = [],
getDynamicParamFromSegment,
searchParams,
......@@ -359,6 +374,7 @@ export async function resolveMetadata({
tree: LoaderTree
parentParams: { [key: string]: any }
metadataItems: MetadataItems
errorMetadataItem: MetadataItems[number]
/** Provided tree can be nested subtree, this argument says what is the path of such subtree */
treePrefix?: string[]
getDynamicParamFromSegment: GetDynamicParamFromSegment
......@@ -392,6 +408,7 @@ export async function resolveMetadata({
await collectMetadata({
tree,
metadataItems,
errorMetadataItem,
errorConvention,
props: layerProps,
route: currentTreePrefix
......@@ -402,9 +419,10 @@ export async function resolveMetadata({
for (const key in parallelRoutes) {
const childTree = parallelRoutes[key]
await resolveMetadata({
await resolveMetadataItems({
tree: childTree,
metadataItems,
errorMetadataItem,
parentParams: currentParams,
treePrefix: currentTreePrefix,
searchParams,
......@@ -413,6 +431,12 @@ export async function resolveMetadata({
})
}
if (Object.keys(parallelRoutes).length === 0 && errorConvention) {
// If there are no parallel routes, place error metadata as the last item.
// e.g. layout -> layout -> not-found
metadataItems.push(errorMetadataItem)
}
return metadataItems
}
......@@ -543,3 +567,43 @@ export async function accumulateMetadata(
return postProcessMetadata(resolvedMetadata, titleTemplates)
}
export async function resolveMetadata({
tree,
parentParams,
metadataItems,
errorMetadataItem,
getDynamicParamFromSegment,
searchParams,
errorConvention,
metadataContext,
}: {
tree: LoaderTree
parentParams: { [key: string]: any }
metadataItems: MetadataItems
errorMetadataItem: MetadataItems[number]
/** Provided tree can be nested subtree, this argument says what is the path of such subtree */
treePrefix?: string[]
getDynamicParamFromSegment: GetDynamicParamFromSegment
searchParams: { [key: string]: any }
errorConvention: 'not-found' | undefined
metadataContext: MetadataContext
}): Promise<[ResolvedMetadata, any]> {
const resolvedMetadataItems = await resolveMetadataItems({
tree,
parentParams,
metadataItems,
errorMetadataItem,
getDynamicParamFromSegment,
searchParams,
errorConvention,
})
let metadata: ResolvedMetadata = createDefaultMetadata()
let error
try {
metadata = await accumulateMetadata(resolvedMetadataItems, metadataContext)
} catch (err: any) {
error = err
}
return [metadata, error]
}
......@@ -32,6 +32,9 @@ const {
const { preloadStyle, preloadFont, preconnect } =
require('next/dist/server/app-render/rsc/preloads') as typeof import('../../server/app-render/rsc/preloads')
const { NotFoundBoundary } =
require('next/dist/client/components/not-found-boundary') as typeof import('../../client/components/not-found-boundary')
export {
AppRouter,
LayoutRouter,
......@@ -49,4 +52,5 @@ export {
preloadFont,
preconnect,
StaticGenerationSearchParamsBailoutProvider,
NotFoundBoundary,
}
......@@ -33,16 +33,13 @@ export async function getLayoutOrPageModule(loaderTree: LoaderTree) {
return [value, modType] as const
}
// First check not-found, if it doesn't exist then pick layout
export async function getErrorOrLayoutModule(
export async function getComponentTypeModule(
loaderTree: LoaderTree,
errorType: 'not-found'
componentType: 'layout' | 'not-found'
) {
const { [errorType]: error, layout } = loaderTree[2]
if (typeof error !== 'undefined') {
return await error[0]()
} else if (typeof layout !== 'undefined') {
return await layout[0]()
const { [componentType]: component } = loaderTree[2]
if (typeof component !== 'undefined') {
return await component[0]()
}
return undefined
}
......@@ -33,12 +33,15 @@ createNextDescribe(
})
it('should match dynamic route not-found boundary correctly', async () => {
const $dynamic = await next.render$('/dynamic')
const $dynamicId = await next.render$('/dynamic/123')
// `/dynamic` display works
expect($dynamic('main').text()).toBe('dynamic')
const browserDynamic = await next.browser('/dynamic')
expect(await browserDynamic.elementByCss('main').text()).toBe('dynamic')
// `/dynamic/[id]` calling notFound() will match the same level not-found boundary
expect($dynamicId('#not-found').text()).toBe('dynamic/[id] not found')
const browserDynamicId = await next.browser('/dynamic/123')
expect(await browserDynamicId.elementByCss('#not-found').text()).toBe(
'dynamic/[id] not found'
)
})
if (isNextDev) {
......
import { notFound } from 'next/navigation'
export default function Page() {
notFound()
}
export default function Layout({ children }) {
return (
<html>
<body>
<h1>Group Layout</h1>
{children}
</body>
</html>
)
}
export default function Page() {
return <div id="not-found">Not found!</div>
}
export default function Layout({ children }) {
return (
<html>
<body>{children}</body>
</html>
)
}
import { createNextDescribe } from 'e2e-utils'
createNextDescribe(
'app dir - not-found - group route',
{
files: __dirname,
skipDeployment: true,
},
({ next }) => {
const runTests = () => {
it('should use the not-found page under group routes', async () => {
const browser = await next.browser('/blog')
expect(await browser.elementByCss('h1').text()).toContain(
'Group Layout'
)
expect(await browser.elementByCss('#not-found').text()).toContain(
'Not found!'
)
})
}
describe('with default runtime', () => {
runTests()
})
describe('with runtime = edge', () => {
let originalLayout = ''
beforeAll(async () => {
await next.stop()
originalLayout = await next.readFile('app/layout.js')
await next.patchFile(
'app/layout.js',
`export const runtime = 'edge'\n${originalLayout}`
)
await next.start()
})
afterAll(async () => {
await next.patchFile('app/layout.js', originalLayout)
})
runTests()
})
}
)
......@@ -8,6 +8,7 @@ createNextDescribe(
skipDeployment: true,
},
({ next }) => {
// TODO: revisit the error for missing parallel routes slot
it('should not render the @children slot when the @slot is not found', async () => {
const browser = await next.browser('/')
// we make sure the page is available through navigating
......
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