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