fix unhandled runtime error when notFound() triggered in generateMetadata w/ parallel routes

[ztanner]

What

When a page throws a notFound() error in generateMetadata, and the page contains parallel route(s), an unhandled runtime error would be thrown rather than displaying the not found page.

Why

We use the <MetadataOutlet /> component to throw any errors caught during metadata resolution once the metadata is rendered by React so that it can be caught by an error boundary, so that it doesn't throw during metadata resolution. A promise is tracked & resolved with an error once the metadata tree is rendered. Once the promise resolves, the outlet component will throw.

However, every __PAGE__ segment that would be rendered as part of the page the user is on will render this <MetadataOutlet /> component. We only need a single outlet per segment as only a single error needs to be thrown & caught.

How

This will only render a MetadataOutlet for the first parallel route that is encountered at each segment depth, as we only need a single handler to throw the error.

Fixes #65013
Closes NEXT-3222

[ztanner]

• fix unhandled runtime error when notFound() triggered in generateMetadata w/ parallel routes #65102 👈
• canary

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @ztanner and the rest of your teammates on Graphite

[ijjk]

Stats from current PR

Default Build

General Overall increase ⚠️

	vercel/next.js canary	vercel/next.js 04-26-fix_unhandled_runtime_error_when_notFound_triggered_in_page_w/_parallel_routes	Change
buildDuration	18.9s	17.5s	N/A
buildDurationCached	10.5s	9.2s	N/A
nodeModulesSize	359 MB	360 MB	⚠️ +12.2 kB
nextStartRea..uration (ms)	449ms	465ms	N/A

Client Bundles (main, webpack)

	vercel/next.js canary	vercel/next.js 04-26-fix_unhandled_runtime_error_when_notFound_triggered_in_page_w/_parallel_routes	Change
1103-HASH.js gzip	31.8 kB	31.8 kB	N/A
1a9f679d-HASH.js gzip	53.5 kB	53.5 kB	N/A
335-HASH.js gzip	5.09 kB	5.09 kB	N/A
7953.HASH.js gzip	169 B	169 B	✓
framework-HASH.js gzip	45.2 kB	45.2 kB	✓
main-app-HASH.js gzip	230 B	230 B	✓
main-HASH.js gzip	31.5 kB	31.5 kB	N/A
webpack-HASH.js gzip	1.65 kB	1.65 kB	N/A
Overall change	45.6 kB	45.6 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	vercel/next.js 04-26-fix_unhandled_runtime_error_when_notFound_triggered_in_page_w/_parallel_routes	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	vercel/next.js 04-26-fix_unhandled_runtime_error_when_notFound_triggered_in_page_w/_parallel_routes	Change
_app-HASH.js gzip	192 B	193 B	N/A
_error-HASH.js gzip	192 B	193 B	N/A
amp-HASH.js gzip	507 B	511 B	N/A
css-HASH.js gzip	341 B	343 B	N/A
dynamic-HASH.js gzip	2.52 kB	2.52 kB	✓
edge-ssr-HASH.js gzip	266 B	265 B	N/A
head-HASH.js gzip	362 B	365 B	N/A
hooks-HASH.js gzip	392 B	392 B	✓
image-HASH.js gzip	4.32 kB	4.32 kB	N/A
index-HASH.js gzip	268 B	268 B	✓
link-HASH.js gzip	2.69 kB	2.7 kB	N/A
routerDirect..HASH.js gzip	329 B	328 B	N/A
script-HASH.js gzip	397 B	397 B	✓
withRouter-HASH.js gzip	324 B	324 B	✓
1afbb74e6ecf..834.css gzip	106 B	106 B	✓
Overall change	4 kB	4 kB	✓

Client Build Manifests

	vercel/next.js canary	vercel/next.js 04-26-fix_unhandled_runtime_error_when_notFound_triggered_in_page_w/_parallel_routes	Change
_buildManifest.js gzip	483 B	484 B	N/A
Overall change	0 B	0 B	✓

Rendered Page Sizes

	vercel/next.js canary	vercel/next.js 04-26-fix_unhandled_runtime_error_when_notFound_triggered_in_page_w/_parallel_routes	Change
index.html gzip	528 B	528 B	✓
link.html gzip	542 B	540 B	N/A
withRouter.html gzip	523 B	523 B	✓
Overall change	1.05 kB	1.05 kB	✓

Edge SSR bundle Size

	vercel/next.js canary	vercel/next.js 04-26-fix_unhandled_runtime_error_when_notFound_triggered_in_page_w/_parallel_routes	Change
edge-ssr.js gzip	94.7 kB	94.7 kB	N/A
page.js gzip	181 kB	181 kB	N/A
Overall change	0 B	0 B	✓

Middleware size

	vercel/next.js canary	vercel/next.js 04-26-fix_unhandled_runtime_error_when_notFound_triggered_in_page_w/_parallel_routes	Change
middleware-b..fest.js gzip	620 B	624 B	N/A
middleware-r..fest.js gzip	156 B	156 B	✓
middleware.js gzip	25.7 kB	25.7 kB	N/A
edge-runtime..pack.js gzip	839 B	839 B	✓
Overall change	995 B	995 B	✓

Next Runtimes

	vercel/next.js canary	vercel/next.js 04-26-fix_unhandled_runtime_error_when_notFound_triggered_in_page_w/_parallel_routes	Change
app-page-exp...dev.js gzip	171 kB	171 kB	N/A
app-page-exp..prod.js gzip	98.4 kB	98.5 kB	N/A
app-page-tur..prod.js gzip	99.9 kB	100 kB	N/A
app-page-tur..prod.js gzip	94.3 kB	94.3 kB	N/A
app-page.run...dev.js gzip	157 kB	157 kB	N/A
app-page.run..prod.js gzip	93 kB	93 kB	N/A
app-route-ex...dev.js gzip	21.5 kB	21.5 kB	✓
app-route-ex..prod.js gzip	15.2 kB	15.2 kB	✓
app-route-tu..prod.js gzip	15.2 kB	15.2 kB	✓
app-route-tu..prod.js gzip	15 kB	15 kB	✓
app-route.ru...dev.js gzip	21.3 kB	21.3 kB	✓
app-route.ru..prod.js gzip	15 kB	15 kB	✓
pages-api-tu..prod.js gzip	9.55 kB	9.55 kB	✓
pages-api.ru...dev.js gzip	9.82 kB	9.82 kB	✓
pages-api.ru..prod.js gzip	9.55 kB	9.55 kB	✓
pages-turbo...prod.js gzip	21.5 kB	21.5 kB	✓
pages.runtim...dev.js gzip	22.1 kB	22.1 kB	✓
pages.runtim..prod.js gzip	21.5 kB	21.5 kB	✓
server.runti..prod.js gzip	51.6 kB	51.6 kB	✓
Overall change	249 kB	249 kB	✓

build cache

	vercel/next.js canary	vercel/next.js 04-26-fix_unhandled_runtime_error_when_notFound_triggered_in_page_w/_parallel_routes	Change
0.pack gzip	1.62 MB	1.61 MB	N/A
index.pack gzip	112 kB	112 kB	N/A
Overall change	0 B	0 B	✓

Diff details

Diff for edge-ssr.js

Diff too large to display

Diff for app-page-exp..ntime.dev.js

Diff too large to display

Diff for app-page-exp..time.prod.js

Diff too large to display

Diff for app-page-tur..time.prod.js

Diff too large to display

Diff for app-page-tur..time.prod.js

Diff too large to display

Diff for app-page.runtime.dev.js

Diff too large to display

Diff for app-page.runtime.prod.js

Diff too large to display

Commit: e4b7f6f

[ijjk]

Tests Passed