Files
next.js/test/e2e/app-dir/metadata-static-file/metadata-static-file-parallel-route.test.ts
Tim NeutkensandGitHub 7873aeaa51 Perf: Simplify static metadata handling (#92630)
### What?

Avoid running the generic `fillMetadataSegment(..., true)` path for
static metadata routes.

This PR adds a dedicated static metadata URL resolver, uses it from the
existing TypeScript static call sites, and precomputes static metadata
URLs in Turbopack loader tree codegen instead of waiting on
`props.params` at runtime.

### Why?

Static metadata files like `favicon.ico`, `icon.png`, and other static
metadata images do not need request-time dynamic path interpolation.

The old path reused logic that was designed to also support dynamic
metadata routes, which meant extra route-regex work even when the final
URL was already statically known apart from the existing `-` placeholder
and route-group / parallel-route suffix semantics.

### How?

- Added a static-only metadata URL helper in `get-metadata-route.ts`
that:
  - normalizes app path segments,
  - replaces dynamic and catch-all segments with `-`,
- preserves the existing metadata filename suffix logic for route groups
and parallel routes.
- Kept `fillMetadataSegment()` for dynamic metadata routes, but
short-circuited the `isStatic` path to the new helper.
- Switched TypeScript static metadata call sites to use the static
helper directly:
  - build tree display path generation,
  - dev bundler static metadata mapping,
  - webpack static metadata image loader output.
- Updated Turbopack static metadata codegen to emit the final static URL
string instead of calling `fillMetadataSegment(..., true)` with `await
props.params`.
- Added focused coverage for:
  - root favicon,
  - static metadata under dynamic parents,
  - route-group / parallel-route suffix behavior,
  - unchanged dynamic metadata interpolation.

Closes NEXT-
Fixes #

<!-- NEXT_JS_LLM_PR -->
2026-04-17 10:26:19 +02:00

148 lines
4.2 KiB
TypeScript

import { nextTestSetup } from 'e2e-utils'
import { getCommonMetadataHeadTags } from './utils'
describe('metadata-files-static-output-parallel-route', () => {
if (process.env.__NEXT_CACHE_COMPONENTS) {
// Cache Components build fails when metadata files are inside a dynamic route.
//
// Route "/dynamic/[id]" has a `generateMetadata` that depends on Request data (`cookies()`, etc...)
// or uncached external data (`fetch(...)`, etc...) when the rest of the route does not.
// See more info here: https://nextjs.org/docs/messages/next-prerender-dynamic-metadata
// Error occurred prerendering page "/dynamic/[id]". Read more: https://nextjs.org/docs/messages/prerender-error
// Export encountered an error on /dynamic/[id]/page: /dynamic/[id], exiting the build.
//
// TODO: Remove this skip when metadata files are supported in dynamic routes for Cache Components.
it.skip('should skip test for Cache Components', () => {})
return
}
const { next, skipped } = nextTestSetup({
files: __dirname,
skipDeployment: true,
})
if (skipped) {
return
}
it('should have correct link tags for parallel slot page', async () => {
const browser = await next.browser('/parallel')
expect(await getCommonMetadataHeadTags(browser)).toMatchInlineSnapshot(`
{
"links": [
{
"href": "/favicon.ico",
"rel": "icon",
"type": "image/x-icon",
},
{
"href": "/manifest.json",
"rel": "manifest",
},
{
"href": "/parallel/apple-icon-kzjltp.png",
"rel": "apple-touch-icon",
"type": "image/png",
},
{
"href": "/parallel/icon-kzjltp.png",
"rel": "icon",
"type": "image/png",
},
],
"metas": [
{
"name": "twitter:card",
},
{
"name": "twitter:image",
},
{
"name": "twitter:image:height",
},
{
"name": "twitter:image:type",
},
{
"name": "twitter:image:width",
},
{
"name": "viewport",
},
{
"property": "og:image",
},
{
"property": "og:image:height",
},
{
"property": "og:image:type",
},
{
"property": "og:image:width",
},
],
}
`)
})
it('should serve static files when requested to its route for parallel slot page', async () => {
const [
appleIconRes,
iconRes,
opengraphImageRes,
twitterImageRes,
sitemapRes,
] = await Promise.all([
next.fetch('/parallel/apple-icon-kzjltp.png'),
next.fetch('/parallel/icon-kzjltp.png'),
next.fetch('/parallel/opengraph-image-kzjltp.png'),
next.fetch('/parallel/twitter-image-kzjltp.png'),
next.fetch(`/parallel/sitemap.xml`),
])
// Compare response content with actual files
const [
actualAppleIcon,
actualIcon,
actualOpengraphImage,
actualTwitterImage,
actualSitemap,
] = await Promise.all([
next.readFileBuffer('app/parallel/@parallel/apple-icon.png'),
next.readFileBuffer('app/parallel/@parallel/icon.png'),
next.readFileBuffer('app/parallel/@parallel/opengraph-image.png'),
next.readFileBuffer('app/parallel/@parallel/twitter-image.png'),
next.readFile('app/parallel/@parallel/sitemap.xml'),
])
expect({
appleIcon: Buffer.compare(
Buffer.from(await appleIconRes.arrayBuffer()),
actualAppleIcon
),
icon: Buffer.compare(
Buffer.from(await iconRes.arrayBuffer()),
actualIcon
),
opengraphImage: Buffer.compare(
Buffer.from(await opengraphImageRes.arrayBuffer()),
actualOpengraphImage
),
twitterImage: Buffer.compare(
Buffer.from(await twitterImageRes.arrayBuffer()),
actualTwitterImage
),
sitemap: await sitemapRes.text(),
}).toEqual({
// Buffer comparison returns 0 for equal
appleIcon: 0,
icon: 0,
opengraphImage: 0,
twitterImage: 0,
sitemap: actualSitemap,
})
})
})