Unverified Commit c7a5a095 authored by Tim Neutkens's avatar Tim Neutkens Committed by GitHub

Revert "Revert "refactor: write pages router export files directly to server/pages/"" (#93409)

Re-apply #92735

Before re-landing we need to investigate why the pages router middleware
i18n test fails when deployed.

Update: Investigation/fix:
https://github.com/vercel/next.js/pull/92735#issuecomment-4242978559

Reverts vercel/next.js#92733

---

Cursor plan based on the investigation Claude did:

# Fix i18n export orphan HTML files in server/pages/

## Problem

When i18n is configured, the export path map in `build/index.ts` creates
locale-prefixed entries for every page (e.g., `/en/home/a`,
`/fr/home/a`), but only deletes the non-locale entry from `defaultMap`
for SSG pages. For non-SSG static pages, the non-locale entry (e.g.,
`/home/a`) remains, causing the export worker to render and write orphan
HTML files directly to `server/pages/`.

These orphan files interfere with routing on deployment platforms (e.g.,
a `[teamId]/[slug].html` orphan matches rewritten paths that should
404).

## Root Cause

In [packages/next/src/build/index.ts](packages/next/src/build/index.ts)
at line 2988:

```2988:2991:packages/next/src/build/index.ts
                  if (isSsg) {
                    // remove non-locale prefixed variant from defaultMap
                    delete defaultMap[page]
                  }
```

The `if (isSsg)` guard means non-SSG pages keep their non-locale entry,
which gets rendered and written to `server/pages/` as an orphan file.

## Fix

**Single-line change** in
[packages/next/src/build/index.ts](packages/next/src/build/index.ts):
Remove the `if (isSsg)` guard so `delete defaultMap[page]` always runs
when i18n is enabled.

The locale-prefixed entries are already created in the loop above (line
2981), and they capture the original `page` value via
`defaultMap[page]?.page || page`. The non-locale entry is not needed
after that -- in the old staging-directory flow (`moveExportedPage`), it
was rendered but never moved to the final output directory.

**Safety verification:**

- `updatePagesManifestForExportedPage` (line 3754) is called based on
`combinedPages`, not the export map -- it still correctly replaces
non-locale manifest entries with locale-prefixed ones
- `pageDuration` tracking (line 3745) may return `undefined` for the
non-locale path, but this is typed `number | undefined` and used with
`|| 0` fallback at line 375 of `build/utils.ts` -- purely cosmetic
- SSG pages already have this exact behavior (delete from defaultMap),
so this change makes non-SSG consistent with SSG
- The `ssgPageDurations` invariant check (line 3737-3738) only runs for
SSG pages, which are unaffected

## Test

Add assertions to the existing i18n integration test at
[test/integration/i18n-support/test/index.test.ts](test/integration/i18n-support/test/index.test.ts)
to verify that non-locale-prefixed HTML orphans do not exist in
`server/pages/` after build. The test already has production mode
assertions checking locale-prefixed file existence and manifest
correctness (lines 81-99).
parent 0f35dab6
This diff is collapsed.
...@@ -345,8 +345,10 @@ async function exportAppImpl( ...@@ -345,8 +345,10 @@ async function exportAppImpl(
) )
} }
if (!options.buildExport) {
await fs.rm(outDir, { recursive: true, force: true }) await fs.rm(outDir, { recursive: true, force: true })
await fs.mkdir(join(outDir, '_next', buildId), { recursive: true }) await fs.mkdir(join(outDir, '_next', buildId), { recursive: true })
}
await fs.writeFile( await fs.writeFile(
join(distDir, EXPORT_DETAIL), join(distDir, EXPORT_DETAIL),
...@@ -653,7 +655,7 @@ async function exportAppImpl( ...@@ -653,7 +655,7 @@ async function exportAppImpl(
} }
const pagesDataDir = options.buildExport const pagesDataDir = options.buildExport
? outDir ? join(distDir, 'server', 'pages')
: join(outDir, '_next/data', buildId) : join(outDir, '_next/data', buildId)
const publicDir = join(dir, CLIENT_PUBLIC_FILES_PATH) const publicDir = join(dir, CLIENT_PUBLIC_FILES_PATH)
...@@ -720,7 +722,9 @@ async function exportAppImpl( ...@@ -720,7 +722,9 @@ async function exportAppImpl(
options, options,
dir, dir,
distDir, distDir,
outDir, outDir: options.buildExport
? join(distDir, 'server', 'pages')
: outDir,
nextConfig, nextConfig,
cacheHandler: nextConfig.cacheHandler, cacheHandler: nextConfig.cacheHandler,
cacheMaxMemorySize: nextConfig.cacheMaxMemorySize, cacheMaxMemorySize: nextConfig.cacheMaxMemorySize,
...@@ -937,6 +941,8 @@ async function exportAppImpl( ...@@ -937,6 +941,8 @@ async function exportAppImpl(
// realizing the implications. // realizing the implications.
const route = normalizePagePath(unnormalizedRoute) const route = normalizePagePath(unnormalizedRoute)
let orig: string
if (isAppPath) {
const pagePath = getPagePath(pageName, distDir, undefined, isAppPath) const pagePath = getPagePath(pageName, distDir, undefined, isAppPath)
const distPagesDir = join( const distPagesDir = join(
pagePath, pagePath,
...@@ -948,8 +954,12 @@ async function exportAppImpl( ...@@ -948,8 +954,12 @@ async function exportAppImpl(
.map(() => '..') .map(() => '..')
.join('/') .join('/')
) )
orig = join(distPagesDir, route)
const orig = join(distPagesDir, route) } else {
// Pages router files are written directly to server/pages/
// by the export worker during build, so read from there.
orig = join(distDir, 'server', 'pages', route)
}
const handlerSrc = `${orig}.body` const handlerSrc = `${orig}.body`
const handlerDest = join(outDir, route) const handlerDest = join(outDir, route)
......
...@@ -113,7 +113,7 @@ export async function exportPagesPage( ...@@ -113,7 +113,7 @@ export async function exportPagesPage(
renderResult && !renderResult.isNull ? renderResult.toUnchunkedString() : '' renderResult && !renderResult.isNull ? renderResult.toUnchunkedString() : ''
const metadata = renderResult?.metadata || {} const metadata = renderResult?.metadata || {}
if (metadata.pageData) { if (metadata.pageData && !ssgNotFound) {
const dataFile = join( const dataFile = join(
pagesDataDir, pagesDataDir,
htmlFilename.replace(/\.html$/, NEXT_DATA_SUFFIX) htmlFilename.replace(/\.html$/, NEXT_DATA_SUFFIX)
......
...@@ -1635,7 +1635,7 @@ export function runTests(ctx: { ...@@ -1635,7 +1635,7 @@ export function runTests(ctx: {
"/catchall-dash/[...hello-world]": "pages/catchall-dash/[...hello-world].html", "/catchall-dash/[...hello-world]": "pages/catchall-dash/[...hello-world].html",
"/d/[id]": "pages/d/[id].html", "/d/[id]": "pages/d/[id].html",
"/dash/[hello-world]": "pages/dash/[hello-world].html", "/dash/[hello-world]": "pages/dash/[hello-world].html",
"/index/[...slug]": "pages/index/index/[...slug].html", "/index/[...slug]": "pages/index/[...slug].html",
"/on-mount/[post]": "pages/on-mount/[post].html", "/on-mount/[post]": "pages/on-mount/[post].html",
"/p1/p2/all-ssg/[...rest]": "pages/p1/p2/all-ssg/[...rest].js", "/p1/p2/all-ssg/[...rest]": "pages/p1/p2/all-ssg/[...rest].js",
"/p1/p2/all-ssr/[...rest]": "pages/p1/p2/all-ssr/[...rest].js", "/p1/p2/all-ssr/[...rest]": "pages/p1/p2/all-ssr/[...rest].js",
......
import { nextTestSetup, isNextDev } from 'e2e-utils'
;(isNextDev ? describe.skip : describe)('i18n-beforefiles-rewrite', () => {
const { next } = nextTestSetup({
files: __dirname,
})
const locales = ['en', 'fr']
const autoStaticRoutes = [
{ pathname: '', content: 'index' },
{ pathname: '/home/a', content: 'Home A' },
{ pathname: '/home/b', content: 'Home B' },
{ pathname: '/dynamic/static', content: 'static route' },
{ pathname: '/dynamic/first', content: 'dynamic route' },
{ pathname: '/team/slug', content: '/[teamId]/[slug]' },
]
it('should serve locale-prefixed auto-static pages', async () => {
for (const { pathname, content } of autoStaticRoutes) {
for (const locale of locales) {
const url = `/${locale}${pathname}`
const res = await next.fetch(url)
const html = await res.text()
expect({ url, status: res.status }).toEqual({ url, status: 200 })
expect(html).toContain(content)
}
}
})
it.each(['', '/en', '/fr'])(
'should 404 for %s/rewrite-before-files',
async (localePrefix) => {
// beforeFiles rewrites /rewrite-before-files to /somewhere.
// /somewhere does not match any page, so this should 404.
// Before the fix, orphan dynamic HTML output could incorrectly match.
const res = await next.fetch(`${localePrefix}/rewrite-before-files`)
expect(res.status).toBe(404)
}
)
})
import { NextResponse } from 'next/server'
export function middleware(request) {
return NextResponse.next()
}
module.exports = {
i18n: {
locales: ['en', 'fr'],
defaultLocale: 'en',
},
rewrites() {
return {
beforeFiles: [
{
source: '/rewrite-before-files',
destination: '/somewhere',
},
],
afterFiles: [],
}
},
}
export default function Page() {
return <p>/[teamId]/[slug]</p>
}
export default function Page() {
return <p>dynamic route</p>
}
export default function Page() {
return <p>static route</p>
}
export default function Page() {
return <p>Home A</p>
}
export default function Page() {
return <p>Home B</p>
}
export default function Page() {
return <p>index</p>
}
...@@ -77,6 +77,30 @@ describe('i18n Support', () => { ...@@ -77,6 +77,30 @@ describe('i18n Support', () => {
expect(content).toMatch(/Internal Server Error/i) expect(content).toMatch(/Internal Server Error/i)
} }
}) })
it('should have locale-prefixed pages-manifest entries for default 500', async () => {
const manifest = await fs.readJSON(
join(next.testDir, '.next/server/pages-manifest.json')
)
for (const locale of locales) {
expect(manifest[`/${locale}/500`]).toBe(`pages/${locale}/500.html`)
}
})
it('should not have non-locale-prefixed HTML files for auto-static pages', async () => {
const pagesDir = join(next.testDir, '.next/server/pages')
// auto-export is a non-SSG auto-static page; only locale-prefixed
// variants should exist in server/pages/ (e.g. en-US/auto-export.html).
// A bare auto-export.html would be an orphan that can interfere with routing.
expect(await fs.pathExists(join(pagesDir, 'auto-export.html'))).toBe(
false
)
for (const locale of locales) {
expect(
await fs.pathExists(join(pagesDir, locale, 'auto-export.html'))
).toBe(true)
}
})
} }
describe('with localeDetection disabled', () => { describe('with localeDetection disabled', () => {
......
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