Unverified Commit c90fc093 authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Externalize manifest loading in pages-api (#78358)

Co-authored-by: 's avatarNiklas Mischkulnig <4586894+mischnic@users.noreply.github.com>
parent a15b48c7
...@@ -387,9 +387,7 @@ export type RoutesManifest = { ...@@ -387,9 +387,7 @@ export type RoutesManifest = {
pages404: boolean pages404: boolean
basePath: string basePath: string
redirects: Array<Redirect> redirects: Array<Redirect>
rewrites?: rewrites: {
| Array<ManifestRewriteRoute>
| {
beforeFiles: Array<ManifestRewriteRoute> beforeFiles: Array<ManifestRewriteRoute>
afterFiles: Array<ManifestRewriteRoute> afterFiles: Array<ManifestRewriteRoute>
fallback: Array<ManifestRewriteRoute> fallback: Array<ManifestRewriteRoute>
...@@ -1345,6 +1343,11 @@ export default async function build( ...@@ -1345,6 +1343,11 @@ export default async function build(
pathHeader: NEXT_REWRITTEN_PATH_HEADER, pathHeader: NEXT_REWRITTEN_PATH_HEADER,
queryHeader: NEXT_REWRITTEN_QUERY_HEADER, queryHeader: NEXT_REWRITTEN_QUERY_HEADER,
}, },
rewrites: {
beforeFiles: [],
afterFiles: [],
fallback: [],
},
skipMiddlewareUrlNormalize: config.skipMiddlewareUrlNormalize, skipMiddlewareUrlNormalize: config.skipMiddlewareUrlNormalize,
ppr: isAppPPREnabled ppr: isAppPPREnabled
? { ? {
...@@ -1358,11 +1361,6 @@ export default async function build( ...@@ -1358,11 +1361,6 @@ export default async function build(
} satisfies RoutesManifest } satisfies RoutesManifest
}) })
if (rewrites.beforeFiles.length === 0 && rewrites.fallback.length === 0) {
routesManifest.rewrites = rewrites.afterFiles.map((r) =>
buildCustomRoute('rewrite', r)
)
} else {
routesManifest.rewrites = { routesManifest.rewrites = {
beforeFiles: rewrites.beforeFiles.map((r) => beforeFiles: rewrites.beforeFiles.map((r) =>
buildCustomRoute('rewrite', r) buildCustomRoute('rewrite', r)
...@@ -1370,11 +1368,9 @@ export default async function build( ...@@ -1370,11 +1368,9 @@ export default async function build(
afterFiles: rewrites.afterFiles.map((r) => afterFiles: rewrites.afterFiles.map((r) =>
buildCustomRoute('rewrite', r) buildCustomRoute('rewrite', r)
), ),
fallback: rewrites.fallback.map((r) => fallback: rewrites.fallback.map((r) => buildCustomRoute('rewrite', r)),
buildCustomRoute('rewrite', r)
),
}
} }
let clientRouterFilters: let clientRouterFilters:
| undefined | undefined
| ReturnType<typeof createClientRouterFilter> | ReturnType<typeof createClientRouterFilter>
......
import type { NextApiResponse } from '../../types' import type { NextApiResponse } from '../../types'
import type { IncomingMessage, ServerResponse } from 'node:http' import type { IncomingMessage, ServerResponse } from 'node:http'
import { parse } from 'node:url'
import { RouteKind } from '../../server/route-kind' import { RouteKind } from '../../server/route-kind'
import { sendError } from '../../server/api-utils' import { sendError } from '../../server/api-utils'
import { PagesAPIRouteModule } from '../../server/route-modules/pages-api/module.compiled' import { PagesAPIRouteModule } from '../../server/route-modules/pages-api/module.compiled'
import fs from 'node:fs'
import path from 'node:path'
import { parse } from 'node:url'
import { hoist } from './helpers' import { hoist } from './helpers'
...@@ -31,6 +29,7 @@ import { ...@@ -31,6 +29,7 @@ import {
import { removePathPrefix } from '../../shared/lib/router/utils/remove-path-prefix' import { removePathPrefix } from '../../shared/lib/router/utils/remove-path-prefix'
import { normalizeLocalePath } from '../../shared/lib/i18n/normalize-locale-path' import { normalizeLocalePath } from '../../shared/lib/i18n/normalize-locale-path'
import type { PrerenderManifest, RoutesManifest } from '..' import type { PrerenderManifest, RoutesManifest } from '..'
import { loadManifestFromRelativePath } from '../../server/load-manifest.external'
// Re-export the handler (should be the default export). // Re-export the handler (should be the default export).
export default hoist(userland, 'default') export default hoist(userland, 'default')
...@@ -51,19 +50,6 @@ const routeModule = new PagesAPIRouteModule({ ...@@ -51,19 +50,6 @@ const routeModule = new PagesAPIRouteModule({
userland, userland,
}) })
const loadedManifests = new Map<string, any>()
async function loadManifest(key: string, loader: () => Promise<any>) {
const cached = loadedManifests.get(key)
if (cached) {
return cached
}
const currentManifest = await loader()
loadedManifests.set(key, currentManifest)
return currentManifest
}
export async function handler( export async function handler(
req: IncomingMessage, req: IncomingMessage,
res: ServerResponse, res: ServerResponse,
...@@ -71,30 +57,21 @@ export async function handler( ...@@ -71,30 +57,21 @@ export async function handler(
waitUntil?: (prom: Promise<void>) => void waitUntil?: (prom: Promise<void>) => void
} }
): Promise<void> { ): Promise<void> {
const dir = const projectDir =
routerServerGlobal[RouterServerContextSymbol]?.dir || process.cwd() routerServerGlobal[RouterServerContextSymbol]?.dir || process.cwd()
const distDir = process.env.__NEXT_RELATIVE_DIST_DIR || '' const distDir = process.env.__NEXT_RELATIVE_DIST_DIR || ''
const isDev = process.env.NODE_ENV === 'development' const isDev = process.env.NODE_ENV === 'development'
const routesManifest: RoutesManifest = await loadManifest( const routesManifest = await loadManifestFromRelativePath<RoutesManifest>(
ROUTES_MANIFEST, projectDir,
async () => distDir,
JSON.parse( ROUTES_MANIFEST
await fs.promises.readFile(
path.join(dir, distDir, ROUTES_MANIFEST),
'utf8'
)
)
)
const prerenderManifest: PrerenderManifest = await loadManifest(
PRERENDER_MANIFEST,
async () =>
JSON.parse(
await fs.promises.readFile(
path.join(dir, distDir, PRERENDER_MANIFEST),
'utf8'
)
) )
const prerenderManifest =
await loadManifestFromRelativePath<PrerenderManifest>(
projectDir,
distDir,
PRERENDER_MANIFEST
) )
let srcPage = 'VAR_DEFINITION_PAGE' let srcPage = 'VAR_DEFINITION_PAGE'
...@@ -131,13 +108,7 @@ export async function handler( ...@@ -131,13 +108,7 @@ export async function handler(
page: srcPage, page: srcPage,
i18n, i18n,
basePath, basePath,
rewrites: Array.isArray(rewrites) rewrites,
? { beforeFiles: [], afterFiles: rewrites, fallback: [] }
: rewrites || {
beforeFiles: [],
afterFiles: [],
fallback: [],
},
pageIsDynamic, pageIsDynamic,
trailingSlash: process.env.__NEXT_TRAILING_SLASH as any as boolean, trailingSlash: process.env.__NEXT_TRAILING_SLASH as any as boolean,
caseSensitive: Boolean(routesManifest.caseSensitive), caseSensitive: Boolean(routesManifest.caseSensitive),
...@@ -171,8 +142,7 @@ export async function handler( ...@@ -171,8 +142,7 @@ export async function handler(
// ensure instrumentation is registered and pass // ensure instrumentation is registered and pass
// onRequestError below // onRequestError below
const absoluteDistDir = path.join(dir, distDir) await ensureInstrumentationRegistered(projectDir, distDir)
await ensureInstrumentationRegistered(absoluteDistDir)
try { try {
const method = req.method || 'GET' const method = req.method || 'GET'
...@@ -198,7 +168,7 @@ export async function handler( ...@@ -198,7 +168,7 @@ export async function handler(
page: 'VAR_DEFINITION_PAGE', page: 'VAR_DEFINITION_PAGE',
onError: (...args: Parameters<InstrumentationOnRequestError>) => onError: (...args: Parameters<InstrumentationOnRequestError>) =>
instrumentationOnRequestError(absoluteDistDir, ...args), instrumentationOnRequestError(projectDir, distDir, ...args),
}) })
.finally(() => { .finally(() => {
if (!span) return if (!span) return
......
import isError from '../../lib/is-error' import isError from '../../lib/is-error'
import { realpathSync } from '../../lib/realpath' import { realpathSync } from '../../lib/realpath'
import { clearManifestCache } from '../load-manifest' import { clearManifestCache } from '../load-manifest.external'
export function deleteFromRequireCache(filePath: string) { export function deleteFromRequireCache(filePath: string) {
try { try {
......
...@@ -10,6 +10,7 @@ import { interopDefault } from '../../../lib/interop-default' ...@@ -10,6 +10,7 @@ import { interopDefault } from '../../../lib/interop-default'
let cachedInstrumentationModule: InstrumentationModule let cachedInstrumentationModule: InstrumentationModule
export async function getInstrumentationModule( export async function getInstrumentationModule(
projectDir: string,
distDir: string distDir: string
): Promise<InstrumentationModule | undefined> { ): Promise<InstrumentationModule | undefined> {
if (cachedInstrumentationModule && process.env.NODE_ENV === 'production') { if (cachedInstrumentationModule && process.env.NODE_ENV === 'production') {
...@@ -19,7 +20,12 @@ export async function getInstrumentationModule( ...@@ -19,7 +20,12 @@ export async function getInstrumentationModule(
try { try {
cachedInstrumentationModule = interopDefault( cachedInstrumentationModule = interopDefault(
await require( await require(
path.join(distDir, 'server', `${INSTRUMENTATION_HOOK_FILENAME}.js`) path.join(
projectDir,
distDir,
'server',
`${INSTRUMENTATION_HOOK_FILENAME}.js`
)
) )
) )
return cachedInstrumentationModule return cachedInstrumentationModule
...@@ -36,11 +42,11 @@ export async function getInstrumentationModule( ...@@ -36,11 +42,11 @@ export async function getInstrumentationModule(
} }
let instrumentationModulePromise: Promise<any> | null = null let instrumentationModulePromise: Promise<any> | null = null
async function registerInstrumentation(distDir: string) { async function registerInstrumentation(projectDir: string, distDir: string) {
// Ensure registerInstrumentation is not called in production build // Ensure registerInstrumentation is not called in production build
if (process.env.NEXT_PHASE === 'phase-production-build') return if (process.env.NEXT_PHASE === 'phase-production-build') return
if (!instrumentationModulePromise) { if (!instrumentationModulePromise) {
instrumentationModulePromise = getInstrumentationModule(distDir) instrumentationModulePromise = getInstrumentationModule(projectDir, distDir)
} }
const instrumentation = await instrumentationModulePromise const instrumentation = await instrumentationModulePromise
if (instrumentation?.register) { if (instrumentation?.register) {
...@@ -54,10 +60,11 @@ async function registerInstrumentation(distDir: string) { ...@@ -54,10 +60,11 @@ async function registerInstrumentation(distDir: string) {
} }
export async function instrumentationOnRequestError( export async function instrumentationOnRequestError(
projectDir: string,
distDir: string, distDir: string,
...args: Parameters<InstrumentationOnRequestError> ...args: Parameters<InstrumentationOnRequestError>
) { ) {
const instrumentation = await getInstrumentationModule(distDir) const instrumentation = await getInstrumentationModule(projectDir, distDir)
try { try {
await instrumentation?.onRequestError?.(...args) await instrumentation?.onRequestError?.(...args)
} catch (err) { } catch (err) {
...@@ -67,9 +74,15 @@ export async function instrumentationOnRequestError( ...@@ -67,9 +74,15 @@ export async function instrumentationOnRequestError(
} }
let registerInstrumentationPromise: Promise<void> | null = null let registerInstrumentationPromise: Promise<void> | null = null
export function ensureInstrumentationRegistered(distDir: string) { export function ensureInstrumentationRegistered(
projectDir: string,
distDir: string
) {
if (!registerInstrumentationPromise) { if (!registerInstrumentationPromise) {
registerInstrumentationPromise = registerInstrumentation(distDir) registerInstrumentationPromise = registerInstrumentation(
projectDir,
distDir
)
} }
return registerInstrumentationPromise return registerInstrumentationPromise
} }
...@@ -27,7 +27,7 @@ import { requirePage } from './require' ...@@ -27,7 +27,7 @@ import { requirePage } from './require'
import { interopDefault } from '../lib/interop-default' import { interopDefault } from '../lib/interop-default'
import { getTracer } from './lib/trace/tracer' import { getTracer } from './lib/trace/tracer'
import { LoadComponentsSpan } from './lib/trace/constants' import { LoadComponentsSpan } from './lib/trace/constants'
import { evalManifest, loadManifest } from './load-manifest' import { evalManifest, loadManifest } from './load-manifest.external'
import { wait } from '../lib/wait' import { wait } from '../lib/wait'
import { setReferenceManifestsSingleton } from './app-render/encryption-utils' import { setReferenceManifestsSingleton } from './app-render/encryption-utils'
import { createServerModuleMap } from './app-render/action-utils' import { createServerModuleMap } from './app-render/action-utils'
......
import type { DeepReadonly } from '../shared/lib/deep-readonly' import type { DeepReadonly } from '../shared/lib/deep-readonly'
import { join } from 'path'
import { readFileSync } from 'fs' import { readFileSync } from 'fs'
import { runInNewContext } from 'vm' import { runInNewContext } from 'vm'
import { deepFreeze } from '../shared/lib/deep-freeze' import { deepFreeze } from '../shared/lib/deep-freeze'
...@@ -41,7 +42,9 @@ export function loadManifest<T extends object>( ...@@ -41,7 +42,9 @@ export function loadManifest<T extends object>(
return cached as T return cached as T
} }
let manifest = JSON.parse(readFileSync(path, 'utf8')) let manifest = JSON.parse(
readFileSync(/* turbopackIgnore: true */ path, 'utf8')
)
// Freeze the manifest so it cannot be modified if we're caching it. // Freeze the manifest so it cannot be modified if we're caching it.
if (shouldCache) { if (shouldCache) {
...@@ -79,7 +82,7 @@ export function evalManifest<T extends object>( ...@@ -79,7 +82,7 @@ export function evalManifest<T extends object>(
return cached as T return cached as T
} }
const content = readFileSync(path, 'utf8') const content = readFileSync(/* turbopackIgnore: true */ path, 'utf8')
if (content.length === 0) { if (content.length === 0) {
throw new Error('Manifest file is empty') throw new Error('Manifest file is empty')
} }
...@@ -99,6 +102,20 @@ export function evalManifest<T extends object>( ...@@ -99,6 +102,20 @@ export function evalManifest<T extends object>(
return contextObject as T return contextObject as T
} }
export function loadManifestFromRelativePath<T extends object>(
projectDir: string,
distDir: string,
manifest: string,
shouldCache = true,
cache?: Map<string, unknown>
): DeepReadonly<T> {
return loadManifest<T>(
join(/* turbopackIgnore: true */ projectDir, distDir, manifest),
shouldCache,
cache
)
}
export function clearManifestCache(path: string, cache = sharedCache): boolean { export function clearManifestCache(path: string, cache = sharedCache): boolean {
return cache.delete(path) return cache.delete(path)
} }
import { loadManifest } from './load-manifest' import { loadManifest } from './load-manifest.external'
import { readFileSync } from 'fs' import { readFileSync } from 'fs'
jest.mock('fs') jest.mock('fs')
......
...@@ -94,7 +94,7 @@ import { pipeToNodeResponse } from './pipe-readable' ...@@ -94,7 +94,7 @@ import { pipeToNodeResponse } from './pipe-readable'
import { createRequestResponseMocks } from './lib/mock-request' import { createRequestResponseMocks } from './lib/mock-request'
import { NEXT_RSC_UNION_QUERY } from '../client/components/app-router-headers' import { NEXT_RSC_UNION_QUERY } from '../client/components/app-router-headers'
import { signalFromNodeResponse } from './web/spec-extension/adapters/next-request' import { signalFromNodeResponse } from './web/spec-extension/adapters/next-request'
import { loadManifest } from './load-manifest' import { loadManifest } from './load-manifest.external'
import { lazyRenderAppPage } from './route-modules/app-page/module.render' import { lazyRenderAppPage } from './route-modules/app-page/module.render'
import { lazyRenderPagesPage } from './route-modules/pages/module.render' import { lazyRenderPagesPage } from './route-modules/pages/module.render'
import { interopDefault } from '../lib/interop-default' import { interopDefault } from '../lib/interop-default'
......
...@@ -10,7 +10,7 @@ import { denormalizePagePath } from '../shared/lib/page-path/denormalize-page-pa ...@@ -10,7 +10,7 @@ import { denormalizePagePath } from '../shared/lib/page-path/denormalize-page-pa
import type { PagesManifest } from '../build/webpack/plugins/pages-manifest-plugin' import type { PagesManifest } from '../build/webpack/plugins/pages-manifest-plugin'
import { PageNotFoundError, MissingStaticPage } from '../shared/lib/utils' import { PageNotFoundError, MissingStaticPage } from '../shared/lib/utils'
import { LRUCache } from '../server/lib/lru-cache' import { LRUCache } from '../server/lib/lru-cache'
import { loadManifest } from './load-manifest' import { loadManifest } from './load-manifest.external'
import { promises } from 'fs' import { promises } from 'fs'
const isDev = process.env.NODE_ENV === 'development' const isDev = process.env.NODE_ENV === 'development'
......
...@@ -25,6 +25,7 @@ import { ...@@ -25,6 +25,7 @@ import {
import { normalizeNextQueryParam } from './web/utils' import { normalizeNextQueryParam } from './web/utils'
import type { IncomingHttpHeaders } from 'http' import type { IncomingHttpHeaders } from 'http'
import { decodeQueryPathParameter } from './lib/decode-query-path-parameter' import { decodeQueryPathParameter } from './lib/decode-query-path-parameter'
import type { DeepReadonly } from '../shared/lib/deep-readonly'
export function normalizeCdnUrl( export function normalizeCdnUrl(
req: BaseNextRequest, req: BaseNextRequest,
...@@ -176,11 +177,11 @@ export function getUtils({ ...@@ -176,11 +177,11 @@ export function getUtils({
page: string page: string
i18n?: NextConfig['i18n'] i18n?: NextConfig['i18n']
basePath: string basePath: string
rewrites: { rewrites: DeepReadonly<{
fallback?: ReadonlyArray<Rewrite> fallback?: ReadonlyArray<Rewrite>
afterFiles?: ReadonlyArray<Rewrite> afterFiles?: ReadonlyArray<Rewrite>
beforeFiles?: ReadonlyArray<Rewrite> beforeFiles?: ReadonlyArray<Rewrite>
} }>
pageIsDynamic: boolean pageIsDynamic: boolean
trailingSlash?: boolean trailingSlash?: boolean
caseSensitive: boolean caseSensitive: boolean
...@@ -209,7 +210,7 @@ export function getUtils({ ...@@ -209,7 +210,7 @@ export function getUtils({
) )
} }
const checkRewrite = (rewrite: Rewrite): boolean => { const checkRewrite = (rewrite: DeepReadonly<Rewrite>): boolean => {
const matcher = getPathMatch( const matcher = getPathMatch(
rewrite.source + (trailingSlash ? '(/)?' : ''), rewrite.source + (trailingSlash ? '(/)?' : ''),
{ {
...@@ -227,8 +228,8 @@ export function getUtils({ ...@@ -227,8 +228,8 @@ export function getUtils({
const hasParams = matchHas( const hasParams = matchHas(
req, req,
parsedUrl.query, parsedUrl.query,
rewrite.has, rewrite.has as Rewrite['has'],
rewrite.missing rewrite.missing as Rewrite['missing']
) )
if (hasParams) { if (hasParams) {
......
...@@ -1256,7 +1256,11 @@ function runTests({ dev }) { ...@@ -1256,7 +1256,11 @@ function runTests({ dev }) {
caseSensitive: false, caseSensitive: false,
basePath: '', basePath: '',
headers: [], headers: [],
rewrites: [], rewrites: {
beforeFiles: [],
afterFiles: [],
fallback: [],
},
staticRoutes: [ staticRoutes: [
{ {
namedRegex: '^/(?:/)?$', namedRegex: '^/(?:/)?$',
......
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