import type { FunctionsConfigManifest, ManifestRoute, PrerenderManifest, RoutesManifest, } from '../../../build' import type { NextConfigComplete } from '../../config-shared' import type { MiddlewareManifest } from '../../../build/webpack/plugins/middleware-plugin' import type { UnwrapPromise } from '../../../lib/coalesced-function' import type { PatchMatcher } from '../../../shared/lib/router/utils/path-match' import type { MiddlewareRouteMatch } from '../../../shared/lib/router/utils/middleware-route-matcher' import path from 'path' import fs from 'fs/promises' import * as Log from '../../../build/output/log' import setupDebug from 'next/dist/compiled/debug' import { LRUCache } from '../lru-cache' import loadCustomRoutes, { type Rewrite } from '../../../lib/load-custom-routes' import { modifyRouteRegex } from '../../../lib/redirect-status' import { FileType, fileExists } from '../../../lib/file-exists' import { recursiveReadDir } from '../../../lib/recursive-readdir' import { isDynamicRoute } from '../../../shared/lib/router/utils' import { escapeStringRegexp } from '../../../shared/lib/escape-regexp' import { getPathMatch } from '../../../shared/lib/router/utils/path-match' import { getRouteRegex } from '../../../shared/lib/router/utils/route-regex' import { getRouteMatcher } from '../../../shared/lib/router/utils/route-matcher' import { pathHasPrefix } from '../../../shared/lib/router/utils/path-has-prefix' import { normalizeLocalePath } from '../../../shared/lib/i18n/normalize-locale-path' import { removePathPrefix } from '../../../shared/lib/router/utils/remove-path-prefix' import { getMiddlewareRouteMatcher } from '../../../shared/lib/router/utils/middleware-route-matcher' import { APP_PATH_ROUTES_MANIFEST, BUILD_ID_FILE, FUNCTIONS_CONFIG_MANIFEST, MIDDLEWARE_MANIFEST, PAGES_MANIFEST, PRERENDER_MANIFEST, ROUTES_MANIFEST, } from '../../../shared/lib/constants' import { normalizePathSep } from '../../../shared/lib/page-path/normalize-path-sep' import { normalizeMetadataRoute } from '../../../lib/metadata/get-metadata-route' import { RSCPathnameNormalizer } from '../../normalizers/request/rsc' import { PrefetchRSCPathnameNormalizer } from '../../normalizers/request/prefetch-rsc' import { encodeURIPath } from '../../../shared/lib/encode-uri-path' export type FsOutput = { type: | 'appFile' | 'pageFile' | 'nextImage' | 'publicFolder' | 'nextStaticFolder' | 'legacyStaticFolder' | 'devVirtualFsItem' itemPath: string fsPath?: string itemsRoot?: string locale?: string } const debug = setupDebug('next:router-server:filesystem') export type FilesystemDynamicRoute = ManifestRoute & { /** * The path matcher that can be used to match paths against this route. */ match: PatchMatcher } export const buildCustomRoute = ( type: 'redirect' | 'header' | 'rewrite' | 'before_files_rewrite', item: T & { source: string }, basePath?: string, caseSensitive?: boolean ): T & { match: PatchMatcher; check?: boolean; regex: string } => { const restrictedRedirectPaths = ['/_next'].map((p) => basePath ? `${basePath}${p}` : p ) let builtRegex = '' const match = getPathMatch(item.source, { strict: true, removeUnnamedParams: true, regexModifier: (regex: string) => { if (!(item as any).internal) { regex = modifyRouteRegex( regex, type === 'redirect' ? restrictedRedirectPaths : undefined ) } builtRegex = regex return builtRegex }, sensitive: caseSensitive, }) return { ...item, regex: builtRegex, ...(type === 'rewrite' ? { check: true } : {}), match, } } export async function setupFsCheck(opts: { dir: string dev: boolean minimalMode?: boolean config: NextConfigComplete }) { const getItemsLru = !opts.dev ? new LRUCache(1024 * 1024, function length(value) { if (!value) return 0 return ( (value.fsPath || '').length + value.itemPath.length + value.type.length ) }) : undefined // routes that have _next/data endpoints (SSG/SSP) const nextDataRoutes = new Set() const publicFolderItems = new Set() const nextStaticFolderItems = new Set() const legacyStaticFolderItems = new Set() const appFiles = new Set() const pageFiles = new Set() let dynamicRoutes: FilesystemDynamicRoute[] = [] let middlewareMatcher: | ReturnType | undefined = () => false const distDir = path.join(opts.dir, opts.config.distDir) const publicFolderPath = path.join(opts.dir, 'public') const nextStaticFolderPath = path.join(distDir, 'static') const legacyStaticFolderPath = path.join(opts.dir, 'static') let customRoutes: UnwrapPromise> = { redirects: [], rewrites: { beforeFiles: [], afterFiles: [], fallback: [], }, headers: [], } let buildId = 'development' let prerenderManifest: PrerenderManifest if (!opts.dev) { const buildIdPath = path.join(opts.dir, opts.config.distDir, BUILD_ID_FILE) try { buildId = await fs.readFile(buildIdPath, 'utf8') } catch (err: any) { if (err.code !== 'ENOENT') throw err throw new Error( `Could not find a production build in the '${opts.config.distDir}' directory. Try building your app with 'next build' before starting the production server. https://nextjs.org/docs/messages/production-start-no-build-id` ) } try { for (const file of await recursiveReadDir(publicFolderPath)) { // Ensure filename is encoded and normalized. publicFolderItems.add(encodeURIPath(normalizePathSep(file))) } } catch (err: any) { if (err.code !== 'ENOENT') { throw err } } try { for (const file of await recursiveReadDir(legacyStaticFolderPath)) { // Ensure filename is encoded and normalized. legacyStaticFolderItems.add(encodeURIPath(normalizePathSep(file))) } Log.warn( `The static directory has been deprecated in favor of the public directory. https://nextjs.org/docs/messages/static-dir-deprecated` ) } catch (err: any) { if (err.code !== 'ENOENT') { throw err } } try { for (const file of await recursiveReadDir(nextStaticFolderPath)) { // Ensure filename is encoded and normalized. nextStaticFolderItems.add( path.posix.join( '/_next/static', encodeURIPath(normalizePathSep(file)) ) ) } } catch (err) { if (opts.config.output !== 'standalone') throw err } const routesManifestPath = path.join(distDir, ROUTES_MANIFEST) const prerenderManifestPath = path.join(distDir, PRERENDER_MANIFEST) const middlewareManifestPath = path.join( distDir, 'server', MIDDLEWARE_MANIFEST ) const functionsConfigManifestPath = path.join( distDir, 'server', FUNCTIONS_CONFIG_MANIFEST ) const pagesManifestPath = path.join(distDir, 'server', PAGES_MANIFEST) const appRoutesManifestPath = path.join(distDir, APP_PATH_ROUTES_MANIFEST) const routesManifest = JSON.parse( await fs.readFile(routesManifestPath, 'utf8') ) as RoutesManifest prerenderManifest = JSON.parse( await fs.readFile(prerenderManifestPath, 'utf8') ) as PrerenderManifest const middlewareManifest = JSON.parse( await fs.readFile(middlewareManifestPath, 'utf8').catch(() => '{}') ) as MiddlewareManifest const functionsConfigManifest = JSON.parse( await fs.readFile(functionsConfigManifestPath, 'utf8').catch(() => '{}') ) as FunctionsConfigManifest const pagesManifest = JSON.parse( await fs.readFile(pagesManifestPath, 'utf8') ) const appRoutesManifest = JSON.parse( await fs.readFile(appRoutesManifestPath, 'utf8').catch(() => '{}') ) for (const key of Object.keys(pagesManifest)) { // ensure the non-locale version is in the set if (opts.config.i18n) { pageFiles.add( normalizeLocalePath(key, opts.config.i18n.locales).pathname ) } else { pageFiles.add(key) } } for (const key of Object.keys(appRoutesManifest)) { appFiles.add(appRoutesManifest[key]) } const escapedBuildId = escapeStringRegexp(buildId) for (const route of routesManifest.dataRoutes) { if (isDynamicRoute(route.page)) { const routeRegex = getRouteRegex(route.page) dynamicRoutes.push({ ...route, regex: routeRegex.re.toString(), match: getRouteMatcher({ // TODO: fix this in the manifest itself, must also be fixed in // upstream builder that relies on this re: opts.config.i18n ? new RegExp( route.dataRouteRegex.replace( `/${escapedBuildId}/`, `/${escapedBuildId}/(?[^/]+?)/` ) ) : new RegExp(route.dataRouteRegex), groups: routeRegex.groups, }), }) } nextDataRoutes.add(route.page) } for (const route of routesManifest.dynamicRoutes) { // If a route is marked as skipInternalRouting, it's not for the internal // router, and instead has been added to support external routers. if (route.skipInternalRouting) { continue } dynamicRoutes.push({ ...route, match: getRouteMatcher(getRouteRegex(route.page)), }) } if (middlewareManifest.middleware?.['/']?.matchers) { middlewareMatcher = getMiddlewareRouteMatcher( middlewareManifest.middleware?.['/']?.matchers ) } else if (functionsConfigManifest?.functions['/_middleware']) { middlewareMatcher = getMiddlewareRouteMatcher( functionsConfigManifest.functions['/_middleware'].matchers ?? [ { regexp: '.*', originalSource: '/:path*' }, ] ) } customRoutes = { redirects: routesManifest.redirects, rewrites: routesManifest.rewrites ? Array.isArray(routesManifest.rewrites) ? { beforeFiles: [], afterFiles: routesManifest.rewrites, fallback: [], } : routesManifest.rewrites : { beforeFiles: [], afterFiles: [], fallback: [], }, headers: routesManifest.headers, } } else { // dev handling customRoutes = await loadCustomRoutes(opts.config) prerenderManifest = { version: 4, routes: {}, dynamicRoutes: {}, notFoundRoutes: [], preview: { previewModeId: (require('crypto') as typeof import('crypto')) .randomBytes(16) .toString('hex'), previewModeSigningKey: (require('crypto') as typeof import('crypto')) .randomBytes(32) .toString('hex'), previewModeEncryptionKey: (require('crypto') as typeof import('crypto')) .randomBytes(32) .toString('hex'), }, } } const headers = customRoutes.headers.map((item) => buildCustomRoute( 'header', item, opts.config.basePath, opts.config.experimental.caseSensitiveRoutes ) ) const redirects = customRoutes.redirects.map((item) => buildCustomRoute( 'redirect', item, opts.config.basePath, opts.config.experimental.caseSensitiveRoutes ) ) const rewrites = { beforeFiles: customRoutes.rewrites.beforeFiles.map((item) => buildCustomRoute('before_files_rewrite', item) ), afterFiles: customRoutes.rewrites.afterFiles.map((item) => buildCustomRoute( 'rewrite', item, opts.config.basePath, opts.config.experimental.caseSensitiveRoutes ) ), fallback: customRoutes.rewrites.fallback.map((item) => buildCustomRoute( 'rewrite', item, opts.config.basePath, opts.config.experimental.caseSensitiveRoutes ) ), } const { i18n } = opts.config const handleLocale = (pathname: string, locales?: string[]) => { let locale: string | undefined if (i18n) { const i18nResult = normalizeLocalePath(pathname, locales || i18n.locales) pathname = i18nResult.pathname locale = i18nResult.detectedLocale } return { locale, pathname } } debug('nextDataRoutes', nextDataRoutes) debug('dynamicRoutes', dynamicRoutes) debug('customRoutes', customRoutes) debug('publicFolderItems', publicFolderItems) debug('nextStaticFolderItems', nextStaticFolderItems) debug('pageFiles', pageFiles) debug('appFiles', appFiles) let ensureFn: (item: FsOutput) => Promise | undefined const normalizers = { // Because we can't know if the app directory is enabled or not at this // stage, we assume that it is. rsc: new RSCPathnameNormalizer(), prefetchRSC: opts.config.experimental.ppr ? new PrefetchRSCPathnameNormalizer() : undefined, } return { headers, rewrites, redirects, buildId, handleLocale, appFiles, pageFiles, dynamicRoutes, nextDataRoutes, exportPathMapRoutes: undefined as | undefined | ReturnType>[], devVirtualFsItems: new Set(), prerenderManifest, middlewareMatcher: middlewareMatcher as MiddlewareRouteMatch | undefined, ensureCallback(fn: typeof ensureFn) { ensureFn = fn }, async getItem(itemPath: string): Promise { const originalItemPath = itemPath const itemKey = originalItemPath const lruResult = getItemsLru?.get(itemKey) if (lruResult) { return lruResult } const { basePath } = opts.config const hasBasePath = pathHasPrefix(itemPath, basePath) // Return null if path doesn't start with basePath if (basePath && !hasBasePath) { return null } // Remove basePath if it exists. if (basePath && hasBasePath) { itemPath = removePathPrefix(itemPath, basePath) || '/' } // Simulate minimal mode requests by normalizing RSC and postponed // requests. if (opts.minimalMode) { if (normalizers.prefetchRSC?.match(itemPath)) { itemPath = normalizers.prefetchRSC.normalize(itemPath, true) } else if (normalizers.rsc.match(itemPath)) { itemPath = normalizers.rsc.normalize(itemPath, true) } } if (itemPath !== '/' && itemPath.endsWith('/')) { itemPath = itemPath.substring(0, itemPath.length - 1) } let decodedItemPath = itemPath try { decodedItemPath = decodeURIComponent(itemPath) } catch {} if (itemPath === '/_next/image') { return { itemPath, type: 'nextImage', } } const itemsToCheck: Array<[Set, FsOutput['type']]> = [ [this.devVirtualFsItems, 'devVirtualFsItem'], [nextStaticFolderItems, 'nextStaticFolder'], [legacyStaticFolderItems, 'legacyStaticFolder'], [publicFolderItems, 'publicFolder'], [appFiles, 'appFile'], [pageFiles, 'pageFile'], ] for (let [items, type] of itemsToCheck) { let locale: string | undefined let curItemPath = itemPath let curDecodedItemPath = decodedItemPath const isDynamicOutput = type === 'pageFile' || type === 'appFile' if (i18n) { const localeResult = handleLocale( itemPath, // legacy behavior allows visiting static assets under // default locale but no other locale isDynamicOutput ? undefined : [ i18n?.defaultLocale, // default locales from domains need to be matched too ...(i18n.domains?.map((item) => item.defaultLocale) || []), ] ) if (localeResult.pathname !== curItemPath) { curItemPath = localeResult.pathname locale = localeResult.locale try { curDecodedItemPath = decodeURIComponent(curItemPath) } catch {} } } if (type === 'legacyStaticFolder') { if (!pathHasPrefix(curItemPath, '/static')) { continue } curItemPath = curItemPath.substring('/static'.length) try { curDecodedItemPath = decodeURIComponent(curItemPath) } catch {} } if ( type === 'nextStaticFolder' && !pathHasPrefix(curItemPath, '/_next/static') ) { continue } const nextDataPrefix = `/_next/data/${buildId}/` if ( type === 'pageFile' && curItemPath.startsWith(nextDataPrefix) && curItemPath.endsWith('.json') ) { items = nextDataRoutes // remove _next/data/ prefix curItemPath = curItemPath.substring(nextDataPrefix.length - 1) // remove .json postfix curItemPath = curItemPath.substring( 0, curItemPath.length - '.json'.length ) const curLocaleResult = handleLocale(curItemPath) curItemPath = curLocaleResult.pathname === '/index' ? '/' : curLocaleResult.pathname locale = curLocaleResult.locale try { curDecodedItemPath = decodeURIComponent(curItemPath) } catch {} } let matchedItem = items.has(curItemPath) // check decoded variant as well if (!matchedItem && !opts.dev) { matchedItem = items.has(curDecodedItemPath) if (matchedItem) curItemPath = curDecodedItemPath else { // x-ref: https://github.com/vercel/next.js/issues/54008 // There're cases that urls get decoded before requests, we should support both encoded and decoded ones. // e.g. nginx could decode the proxy urls, the below ones should be treated as the same: // decoded version: `/_next/static/chunks/pages/blog/[slug]-d4858831b91b69f6.js` // encoded version: `/_next/static/chunks/pages/blog/%5Bslug%5D-d4858831b91b69f6.js` try { // encode the special characters in the path and retrieve again to determine if path exists. const encodedCurItemPath = encodeURIPath(curItemPath) matchedItem = items.has(encodedCurItemPath) } catch {} } } if (matchedItem || opts.dev) { let fsPath: string | undefined let itemsRoot: string | undefined switch (type) { case 'nextStaticFolder': { itemsRoot = nextStaticFolderPath curItemPath = curItemPath.substring('/_next/static'.length) break } case 'legacyStaticFolder': { itemsRoot = legacyStaticFolderPath break } case 'publicFolder': { itemsRoot = publicFolderPath break } case 'appFile': case 'pageFile': case 'nextImage': case 'devVirtualFsItem': { break } default: { ;(type) satisfies never } } if (itemsRoot && curItemPath) { fsPath = path.posix.join(itemsRoot, curItemPath) } // dynamically check fs in development so we don't // have to wait on the watcher if (!matchedItem && opts.dev) { const isStaticAsset = ( [ 'nextStaticFolder', 'publicFolder', 'legacyStaticFolder', ] as (typeof type)[] ).includes(type) if (isStaticAsset && itemsRoot) { let found = fsPath && (await fileExists(fsPath, FileType.File)) if (!found) { try { // In dev, we ensure encoded paths match // decoded paths on the filesystem so check // that variation as well const tempItemPath = decodeURIComponent(curItemPath) fsPath = path.posix.join(itemsRoot, tempItemPath) found = await fileExists(fsPath, FileType.File) } catch {} if (!found) { continue } } } else if (type === 'pageFile' || type === 'appFile') { const isAppFile = type === 'appFile' // Attempt to ensure the page/app file is compiled and ready if (ensureFn) { const ensureItemPath = isAppFile ? normalizeMetadataRoute(curItemPath) : curItemPath try { await ensureFn({ type, itemPath: ensureItemPath }) } catch (error) { // If ensure failed, skip this item and continue to the next one continue } } } else { continue } } // i18n locales aren't matched for app dir if (type === 'appFile' && locale && locale !== i18n?.defaultLocale) { continue } const itemResult = { type, fsPath, locale, itemsRoot, itemPath: curItemPath, } getItemsLru?.set(itemKey, itemResult) return itemResult } } getItemsLru?.set(itemKey, null) return null }, getDynamicRoutes() { // this should include data routes return this.dynamicRoutes }, getMiddlewareMatchers() { return this.middlewareMatcher }, } }