Unverified Commit 0e912cb9 authored by Josh Story's avatar Josh Story Committed by GitHub

Keep custom-route metadata outside configuration (#99508)

## Summary

Loading custom routes currently writes original redirects and rewrites
onto resolved configuration. Return the redirect metadata with the
loaded routes for client-router filtering, and remove the unused rewrite
snapshots and obsolete webpack arguments.

This removes post-load config writes as part of making completed
configuration immutable for adapters and other runtime consumers.

## Verification

- Existing configured rewrites and redirects suite: 14 tests passed in
development with both bundlers and in production with webpack.
- Existing middleware redirect test exercises client navigation through
a configured redirect with client-router filtering enabled in
development with Turbopack and production with webpack.
- Existing custom-route loader and next-types-plugin unit tests.

<!-- NEXT_JS_LLM -->
parent a7d68718
import type { LoadedEnvFiles } from '@next/env' import type { LoadedEnvFiles } from '@next/env'
import type { Rewrite, Redirect } from '../lib/load-custom-routes' import type { Rewrite } from '../lib/load-custom-routes'
import type { __ApiPreviewProps } from '../server/api-utils' import type { __ApiPreviewProps } from '../server/api-utils'
import type { NextConfigComplete } from '../server/config-shared' import type { NextConfigComplete } from '../server/config-shared'
import type { Span } from '../trace' import type { Span } from '../trace'
...@@ -64,13 +64,7 @@ export const NextBuildContext: Partial<{ ...@@ -64,13 +64,7 @@ export const NextBuildContext: Partial<{
afterFiles: Rewrite[] afterFiles: Rewrite[]
beforeFiles: Rewrite[] beforeFiles: Rewrite[]
} }
originalRewrites: {
fallback: Rewrite[]
afterFiles: Rewrite[]
beforeFiles: Rewrite[]
}
hasRewrites: boolean hasRewrites: boolean
originalRedirects: Redirect[]
loadedEnvFiles: LoadedEnvFiles loadedEnvFiles: LoadedEnvFiles
previewProps: __ApiPreviewProps previewProps: __ApiPreviewProps
mappedPages: MappedPages | undefined mappedPages: MappedPages | undefined
......
...@@ -1344,9 +1344,6 @@ export default async function build( ...@@ -1344,9 +1344,6 @@ export default async function build(
] ]
const hasRewrites = combinedRewrites.length > 0 const hasRewrites = combinedRewrites.length > 0
NextBuildContext.hasRewrites = hasRewrites NextBuildContext.hasRewrites = hasRewrites
NextBuildContext.originalRewrites = config._originalRewrites
NextBuildContext.originalRedirects = config._originalRedirects
const distDirCreated = await nextBuildSpan const distDirCreated = await nextBuildSpan
.traceChild('create-dist-dir') .traceChild('create-dist-dir')
.traceAsyncFn(async () => { .traceAsyncFn(async () => {
...@@ -1809,9 +1806,9 @@ export default async function build( ...@@ -1809,9 +1806,9 @@ export default async function build(
| ReturnType<typeof createClientRouterFilter> | ReturnType<typeof createClientRouterFilter>
if (config.experimental.clientRouterFilter) { if (config.experimental.clientRouterFilter) {
const nonInternalRedirects = (config._originalRedirects || []).filter( const nonInternalRedirects = (
(r: any) => !r.internal customRoutes.originalRedirects || []
) ).filter((r) => !r.internal)
clientRouterFilters = createClientRouterFilter( clientRouterFilters = createClientRouterFilter(
[...appPaths], [...appPaths],
config.experimental.clientRouterFilterRedirects config.experimental.clientRouterFilterRedirects
......
...@@ -152,8 +152,6 @@ export async function webpackBuildImpl( ...@@ -152,8 +152,6 @@ export async function webpackBuildImpl(
appDir: NextBuildContext.appDir!, appDir: NextBuildContext.appDir!,
pagesDir: NextBuildContext.pagesDir!, pagesDir: NextBuildContext.pagesDir!,
rewrites: NextBuildContext.rewrites!, rewrites: NextBuildContext.rewrites!,
originalRewrites: NextBuildContext.originalRewrites,
originalRedirects: NextBuildContext.originalRedirects,
noMangling: NextBuildContext.noMangling!, noMangling: NextBuildContext.noMangling!,
clientRouterFilters: NextBuildContext.clientRouterFilters!, clientRouterFilters: NextBuildContext.clientRouterFilters!,
previewProps: NextBuildContext.previewProps!, previewProps: NextBuildContext.previewProps!,
......
...@@ -338,8 +338,6 @@ export default async function getBaseWebpackConfig( ...@@ -338,8 +338,6 @@ export default async function getBaseWebpackConfig(
isDevFallback = false, isDevFallback = false,
pagesDir, pagesDir,
rewrites, rewrites,
originalRewrites,
originalRedirects,
runWebpackSpan, runWebpackSpan,
appDir, appDir,
middlewareMatchers, middlewareMatchers,
...@@ -366,8 +364,6 @@ export default async function getBaseWebpackConfig( ...@@ -366,8 +364,6 @@ export default async function getBaseWebpackConfig(
isDevFallback?: boolean isDevFallback?: boolean
pagesDir: string | undefined pagesDir: string | undefined
rewrites: CustomRoutes['rewrites'] rewrites: CustomRoutes['rewrites']
originalRewrites: CustomRoutes['rewrites'] | undefined
originalRedirects: CustomRoutes['redirects'] | undefined
runWebpackSpan: Span runWebpackSpan: Span
appDir: string | undefined appDir: string | undefined
middlewareMatchers?: ProxyMatcher[] middlewareMatchers?: ProxyMatcher[]
...@@ -2197,8 +2193,6 @@ export default async function getBaseWebpackConfig( ...@@ -2197,8 +2193,6 @@ export default async function getBaseWebpackConfig(
dev, dev,
isEdgeServer, isEdgeServer,
pageExtensions: config.pageExtensions, pageExtensions: config.pageExtensions,
originalRewrites,
originalRedirects,
}), }),
!dev && !dev &&
isClient && isClient &&
......
...@@ -11,8 +11,6 @@ describe('next-types-plugin', () => { ...@@ -11,8 +11,6 @@ describe('next-types-plugin', () => {
dev: false, dev: false,
isEdgeServer: false, isEdgeServer: false,
pageExtensions: ['tsx', 'ts', 'jsx', 'js'], pageExtensions: ['tsx', 'ts', 'jsx', 'js'],
originalRewrites: undefined,
originalRedirects: undefined,
}) })
expect( expect(
normalizeSlashes(plugin.getRelativePathFromAppTypesDir('page.tsx')) normalizeSlashes(plugin.getRelativePathFromAppTypesDir('page.tsx'))
...@@ -38,8 +36,6 @@ describe('next-types-plugin', () => { ...@@ -38,8 +36,6 @@ describe('next-types-plugin', () => {
dev: false, dev: false,
isEdgeServer: false, isEdgeServer: false,
pageExtensions: ['tsx', 'ts', 'jsx', 'js'], pageExtensions: ['tsx', 'ts', 'jsx', 'js'],
originalRewrites: undefined,
originalRedirects: undefined,
}) })
expect( expect(
normalizeSlashes(plugin.getRelativePathFromAppTypesDir('layout.tsx')) normalizeSlashes(plugin.getRelativePathFromAppTypesDir('layout.tsx'))
...@@ -57,9 +53,6 @@ describe('next-types-plugin', () => { ...@@ -57,9 +53,6 @@ describe('next-types-plugin', () => {
dev: false, dev: false,
isEdgeServer: false, isEdgeServer: false,
pageExtensions: ['tsx', 'ts', 'jsx', 'js'], pageExtensions: ['tsx', 'ts', 'jsx', 'js'],
originalRewrites: undefined,
originalRedirects: undefined,
}) })
expect( expect(
normalizeSlashes(plugin.getRelativePathFromAppTypesDir('layout.tsx')) normalizeSlashes(plugin.getRelativePathFromAppTypesDir('layout.tsx'))
......
...@@ -2,8 +2,6 @@ ...@@ -2,8 +2,6 @@
// DOING SO PREVENTS THEM FROM WORKING FOR TURBOPACK USERS. // DOING SO PREVENTS THEM FROM WORKING FOR TURBOPACK USERS.
// FOLLOW THE PATTERN OF TYPED-ROUTES AND CACHE-LIFE GENERATION // FOLLOW THE PATTERN OF TYPED-ROUTES AND CACHE-LIFE GENERATION
import type { Rewrite, Redirect } from '../../../../lib/load-custom-routes'
import fs from 'fs/promises' import fs from 'fs/promises'
import { webpack, sources } from 'next/dist/compiled/webpack/webpack' import { webpack, sources } from 'next/dist/compiled/webpack/webpack'
import path from 'path' import path from 'path'
...@@ -21,12 +19,6 @@ import { getProxiedPluginState } from '../../../build-context' ...@@ -21,12 +19,6 @@ import { getProxiedPluginState } from '../../../build-context'
const PLUGIN_NAME = 'NextTypesPlugin' const PLUGIN_NAME = 'NextTypesPlugin'
type Rewrites = {
fallback: Rewrite[]
afterFiles: Rewrite[]
beforeFiles: Rewrite[]
}
interface Options { interface Options {
dir: string dir: string
distDir: string distDir: string
...@@ -34,8 +26,6 @@ interface Options { ...@@ -34,8 +26,6 @@ interface Options {
dev: boolean dev: boolean
isEdgeServer: boolean isEdgeServer: boolean
pageExtensions: PageExtensions pageExtensions: PageExtensions
originalRewrites: Rewrites | undefined
originalRedirects: Redirect[] | undefined
} }
function createTypeGuardFile( function createTypeGuardFile(
......
...@@ -496,6 +496,7 @@ export interface CustomRoutes { ...@@ -496,6 +496,7 @@ export interface CustomRoutes {
beforeFiles: Rewrite[] beforeFiles: Rewrite[]
} }
redirects: Redirect[] redirects: Redirect[]
originalRedirects?: Redirect[]
} }
function processRoutes<T>( function processRoutes<T>(
...@@ -582,9 +583,12 @@ function processRoutes<T>( ...@@ -582,9 +583,12 @@ function processRoutes<T>(
return newRoutes as any as T return newRoutes as any as T
} }
async function loadRedirects(config: NextConfig) { async function loadRedirects(config: NextConfig): Promise<{
redirects: Redirect[]
originalRedirects: Redirect[] | undefined
}> {
if (typeof config.redirects !== 'function') { if (typeof config.redirects !== 'function') {
return [] return { redirects: [], originalRedirects: undefined }
} }
let redirects = await config.redirects() let redirects = await config.redirects()
// check before we process the routes and after to ensure // check before we process the routes and after to ensure
...@@ -592,12 +596,10 @@ async function loadRedirects(config: NextConfig) { ...@@ -592,12 +596,10 @@ async function loadRedirects(config: NextConfig) {
checkCustomRoutes(redirects, 'redirect') checkCustomRoutes(redirects, 'redirect')
// save original redirects before transforms // save original redirects before transforms
if (Array.isArray(redirects)) { const originalRedirects = redirects.map((r) => ({ ...r }))
config._originalRedirects = redirects.map((r) => ({ ...r }))
}
redirects = processRoutes(redirects, config, 'redirect') redirects = processRoutes(redirects, config, 'redirect')
checkCustomRoutes(redirects, 'redirect') checkCustomRoutes(redirects, 'redirect')
return redirects return { redirects, originalRedirects }
} }
async function loadRewrites(config: NextConfig) { async function loadRewrites(config: NextConfig) {
...@@ -661,13 +663,6 @@ async function loadRewrites(config: NextConfig) { ...@@ -661,13 +663,6 @@ async function loadRewrites(config: NextConfig) {
checkCustomRoutes(afterFiles, 'rewrite') checkCustomRoutes(afterFiles, 'rewrite')
checkCustomRoutes(fallback, 'rewrite') checkCustomRoutes(fallback, 'rewrite')
// save original rewrites before transforms
config._originalRewrites = {
beforeFiles: beforeFiles.map((r) => ({ ...r })),
afterFiles: afterFiles.map((r) => ({ ...r })),
fallback: fallback.map((r) => ({ ...r })),
}
beforeFiles = [ beforeFiles = [
...maybeAssetPrefixRewrite, ...maybeAssetPrefixRewrite,
...processRoutes(beforeFiles, config, 'rewrite'), ...processRoutes(beforeFiles, config, 'rewrite'),
...@@ -703,11 +698,12 @@ async function loadHeaders(config: NextConfig) { ...@@ -703,11 +698,12 @@ async function loadHeaders(config: NextConfig) {
export default async function loadCustomRoutes( export default async function loadCustomRoutes(
config: NextConfig config: NextConfig
): Promise<CustomRoutes> { ): Promise<CustomRoutes> {
const [headers, rewrites, redirects] = await Promise.all([ const [headers, rewrites, loadedRedirects] = await Promise.all([
loadHeaders(config), loadHeaders(config),
loadRewrites(config), loadRewrites(config),
loadRedirects(config), loadRedirects(config),
]) ])
const { redirects, originalRedirects } = loadedRedirects
const onMatchHeaders: Header[] = [] const onMatchHeaders: Header[] = []
...@@ -858,5 +854,6 @@ export default async function loadCustomRoutes( ...@@ -858,5 +854,6 @@ export default async function loadCustomRoutes(
onMatchHeaders, onMatchHeaders,
rewrites, rewrites,
redirects, redirects,
originalRedirects,
} }
} }
...@@ -2276,16 +2276,6 @@ export interface NextConfig { ...@@ -2276,16 +2276,6 @@ export interface NextConfig {
* @internal * @internal
*/ */
configOrigin?: string | undefined configOrigin?: string | undefined
/**
* @internal
*/
_originalRedirects?: any
/**
* @internal
*/
_originalRewrites?: any
} }
export const defaultConfig = Object.freeze({ export const defaultConfig = Object.freeze({
......
...@@ -762,8 +762,6 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface { ...@@ -762,8 +762,6 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface {
config: this.config, config: this.config,
pagesDir: this.pagesDir, pagesDir: this.pagesDir,
rewrites: this.rewrites, rewrites: this.rewrites,
originalRewrites: this.config._originalRewrites,
originalRedirects: this.config._originalRedirects,
runWebpackSpan: this.hotReloaderSpan, runWebpackSpan: this.hotReloaderSpan,
appDir: this.appDir, appDir: this.appDir,
previewProps: this.previewProps, previewProps: this.previewProps,
...@@ -825,12 +823,6 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface { ...@@ -825,12 +823,6 @@ export default class HotReloaderWebpack implements NextJsHotReloaderInterface {
afterFiles: [], afterFiles: [],
fallback: [], fallback: [],
}, },
originalRewrites: {
beforeFiles: [],
afterFiles: [],
fallback: [],
},
originalRedirects: [],
isDevFallback: true, isDevFallback: true,
entrypoints: ( entrypoints: (
await createEntrypoints({ await createEntrypoints({
......
...@@ -653,6 +653,7 @@ export async function setupFsCheck(opts: { ...@@ -653,6 +653,7 @@ export async function setupFsCheck(opts: {
onMatchHeaders, onMatchHeaders,
rewrites, rewrites,
redirects, redirects,
originalRedirects: customRoutes.originalRedirects,
buildId, buildId,
handleLocale, handleLocale,
......
...@@ -908,8 +908,8 @@ async function startWatcher( ...@@ -908,8 +908,8 @@ async function startWatcher(
clientRouterFilters = createClientRouterFilter( clientRouterFilters = createClientRouterFilter(
Object.keys(appPaths), Object.keys(appPaths),
nextConfig.experimental.clientRouterFilterRedirects nextConfig.experimental.clientRouterFilterRedirects
? ((nextConfig as any)._originalRedirects || []).filter( ? (opts.fsChecker.originalRedirects || []).filter(
(r: any) => !r.internal (r) => !r.internal
) )
: [], : [],
nextConfig.experimental.clientRouterFilterAllowedRate nextConfig.experimental.clientRouterFilterAllowedRate
......
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