Unverified Commit 205d3845 authored by Wyatt Johnson's avatar Wyatt Johnson Committed by GitHub

Move Pages API rendering into bundle (#52149)

Moves the rendering for Pages API routes into the bundle. This also implements the `routeModule` interface for both Pages and Pages API routes in the Turbopack output. This also fixes a bug where the order of the imports for `Document` and `App` were reversed in the Turbopack build.
parent f57eecde
use std::io::Write;
use anyhow::{bail, Result}; use anyhow::{bail, Result};
use indexmap::indexmap;
use indoc::writedoc;
use next_core::{ use next_core::{
create_page_loader_entry_module, get_asset_path_from_pathname, create_page_loader_entry_module, get_asset_path_from_pathname,
mode::NextMode, mode::NextMode,
...@@ -20,10 +24,15 @@ use next_core::{ ...@@ -20,10 +24,15 @@ use next_core::{
}; };
use turbo_tasks::Vc; use turbo_tasks::Vc;
use turbopack_binding::{ use turbopack_binding::{
turbo::{tasks::Value, tasks_env::ProcessEnv, tasks_fs::FileSystemPath}, turbo::{
tasks::Value,
tasks_env::ProcessEnv,
tasks_fs::{rope::RopeBuilder, File, FileSystemPath},
},
turbopack::{ turbopack::{
build::BuildChunkingContext, build::BuildChunkingContext,
core::{ core::{
asset::AssetContent,
chunk::{ChunkableModule, ChunkingContext, EvaluatableAssets}, chunk::{ChunkableModule, ChunkingContext, EvaluatableAssets},
compile_time_info::CompileTimeInfo, compile_time_info::CompileTimeInfo,
context::AssetContext, context::AssetContext,
...@@ -31,6 +40,7 @@ use turbopack_binding::{ ...@@ -31,6 +40,7 @@ use turbopack_binding::{
output::OutputAsset, output::OutputAsset,
reference_type::{EntryReferenceSubType, ReferenceType}, reference_type::{EntryReferenceSubType, ReferenceType},
source::Source, source::Source,
virtual_source::VirtualSource,
}, },
ecmascript::{ ecmascript::{
chunk::{EcmascriptChunkPlaceable, EcmascriptChunkingContext}, chunk::{EcmascriptChunkPlaceable, EcmascriptChunkingContext},
...@@ -191,6 +201,8 @@ async fn get_page_entries_for_root_directory( ...@@ -191,6 +201,8 @@ async fn get_page_entries_for_root_directory(
Vc::upcast(FileSource::new(app.project_path)), Vc::upcast(FileSource::new(app.project_path)),
next_router_root, next_router_root,
app.next_router_path, app.next_router_path,
app.original_path,
PathType::Page,
)); ));
// This only makes sense on the server. // This only makes sense on the server.
...@@ -201,6 +213,8 @@ async fn get_page_entries_for_root_directory( ...@@ -201,6 +213,8 @@ async fn get_page_entries_for_root_directory(
Vc::upcast(FileSource::new(document.project_path)), Vc::upcast(FileSource::new(document.project_path)),
next_router_root, next_router_root,
document.next_router_path, document.next_router_path,
document.original_path,
PathType::Page,
)); ));
// This only makes sense on both the client and the server, but they should map // This only makes sense on both the client and the server, but they should map
...@@ -212,6 +226,8 @@ async fn get_page_entries_for_root_directory( ...@@ -212,6 +226,8 @@ async fn get_page_entries_for_root_directory(
Vc::upcast(FileSource::new(error.project_path)), Vc::upcast(FileSource::new(error.project_path)),
next_router_root, next_router_root,
error.next_router_path, error.next_router_path,
error.original_path,
PathType::Page,
)); ));
if let Some(api) = api { if let Some(api) = api {
...@@ -221,6 +237,7 @@ async fn get_page_entries_for_root_directory( ...@@ -221,6 +237,7 @@ async fn get_page_entries_for_root_directory(
api, api,
next_router_root, next_router_root,
&mut entries, &mut entries,
PathType::PagesAPI,
) )
.await?; .await?;
} }
...@@ -232,6 +249,7 @@ async fn get_page_entries_for_root_directory( ...@@ -232,6 +249,7 @@ async fn get_page_entries_for_root_directory(
pages, pages,
next_router_root, next_router_root,
&mut entries, &mut entries,
PathType::Page,
) )
.await?; .await?;
} }
...@@ -246,6 +264,7 @@ async fn get_page_entries_for_directory( ...@@ -246,6 +264,7 @@ async fn get_page_entries_for_directory(
pages_structure: Vc<PagesDirectoryStructure>, pages_structure: Vc<PagesDirectoryStructure>,
next_router_root: Vc<FileSystemPath>, next_router_root: Vc<FileSystemPath>,
entries: &mut Vec<Vc<PageEntry>>, entries: &mut Vec<Vc<PageEntry>>,
path_type: PathType,
) -> Result<()> { ) -> Result<()> {
let PagesDirectoryStructure { let PagesDirectoryStructure {
ref items, ref items,
...@@ -257,7 +276,7 @@ async fn get_page_entries_for_directory( ...@@ -257,7 +276,7 @@ async fn get_page_entries_for_directory(
let PagesStructureItem { let PagesStructureItem {
project_path, project_path,
next_router_path, next_router_path,
original_path: _, original_path,
} = *item.await?; } = *item.await?;
entries.push(get_page_entry_for_file( entries.push(get_page_entry_for_file(
ssr_module_context, ssr_module_context,
...@@ -265,6 +284,8 @@ async fn get_page_entries_for_directory( ...@@ -265,6 +284,8 @@ async fn get_page_entries_for_directory(
Vc::upcast(FileSource::new(project_path)), Vc::upcast(FileSource::new(project_path)),
next_router_root, next_router_root,
next_router_path, next_router_path,
original_path,
path_type,
)); ));
} }
...@@ -275,6 +296,7 @@ async fn get_page_entries_for_directory( ...@@ -275,6 +296,7 @@ async fn get_page_entries_for_directory(
*child, *child,
next_router_root, next_router_root,
entries, entries,
path_type,
) )
.await?; .await?;
} }
...@@ -300,13 +322,129 @@ async fn get_page_entry_for_file( ...@@ -300,13 +322,129 @@ async fn get_page_entry_for_file(
source: Vc<Box<dyn Source>>, source: Vc<Box<dyn Source>>,
next_router_root: Vc<FileSystemPath>, next_router_root: Vc<FileSystemPath>,
next_router_path: Vc<FileSystemPath>, next_router_path: Vc<FileSystemPath>,
next_original_path: Vc<FileSystemPath>,
path_type: PathType,
) -> Result<Vc<PageEntry>> { ) -> Result<Vc<PageEntry>> {
let reference_type = Value::new(ReferenceType::Entry(EntryReferenceSubType::Page)); let reference_type = Value::new(ReferenceType::Entry(match path_type {
PathType::Page => EntryReferenceSubType::Page,
PathType::PagesAPI => EntryReferenceSubType::PagesApi,
_ => bail!("Invalid path type"),
}));
let pathname = pathname_for_path(next_router_root, next_router_path, path_type);
let pathname = pathname_for_path(next_router_root, next_router_path, PathType::Page); let definition_page = format!("/{}", next_original_path.await?);
let definition_pathname = pathname.await?;
let ssr_module = ssr_module_context.process(source, reference_type.clone()); let ssr_module = ssr_module_context.process(source, reference_type.clone());
let mut result = RopeBuilder::default();
match path_type {
PathType::Page => {
// Sourced from https://github.com/vercel/next.js/blob/2848ce51d1552633119c89ab49ff7fe2e4e91c91/packages/next/src/build/webpack/loaders/next-route-loader/index.ts
writedoc!(
result,
r#"
import RouteModule from "next/dist/server/future/route-modules/pages/module"
import {{ hoist }} from "next/dist/build/webpack/loaders/next-route-loader/helpers"
import Document from "@vercel/turbopack-next/pages/_document"
import App from "@vercel/turbopack-next/pages/_app"
import * as userland from "INNER"
export default hoist(userland, "default")
export const getStaticProps = hoist(userland, "getStaticProps")
export const getStaticPaths = hoist(userland, "getStaticPaths")
export const getServerSideProps = hoist(userland, "getServerSideProps")
export const config = hoist(userland, "config")
export const reportWebVitals = hoist(userland, "reportWebVitals")
export const unstable_getStaticProps = hoist(userland, "unstable_getStaticProps")
export const unstable_getStaticPaths = hoist(userland, "unstable_getStaticPaths")
export const unstable_getStaticParams = hoist(userland, "unstable_getStaticParams")
export const unstable_getServerProps = hoist(userland, "unstable_getServerProps")
export const unstable_getServerSideProps = hoist(userland, "unstable_getServerSideProps")
export const routeModule = new RouteModule({{
definition: {{
kind: "PAGES",
page: "{definition_page}",
pathname: "{definition_pathname}",
// The following aren't used in production, but are
// required for the RouteModule constructor.
bundlePath: "",
filename: "",
}},
components: {{
App,
Document,
}},
userland,
}})
"#
)?;
// When we're building the instrumentation page (only when the
// instrumentation file conflicts with a page also labeled
// /instrumentation) hoist the `register` method.
if definition_page == "/instrumentation" || definition_page == "/src/instrumentation" {
writeln!(
result,
r#"export const register = hoist(userland, "register")"#
)?;
}
}
PathType::PagesAPI => {
// Sourced from https://github.com/vercel/next.js/blob/2848ce51d1552633119c89ab49ff7fe2e4e91c91/packages/next/src/build/webpack/loaders/next-route-loader/index.ts
writedoc!(
result,
r#"
import RouteModule from "next/dist/server/future/route-modules/pages-api/module"
import {{ hoist }} from "next/dist/build/webpack/loaders/next-route-loader/helpers"
import * as userland from "INNER"
export default hoist(userland, "default")
export const config = hoist(userland, "config")
export const routeModule = new RouteModule({{
definition: {{
kind: "PAGES_API",
page: "{definition_page}",
pathname: "{definition_pathname}",
// The following aren't used in production, but are
// required for the RouteModule constructor.
bundlePath: "",
filename: "",
}},
userland,
}})
"#
)?;
}
_ => bail!("Invalid path type"),
};
let file = File::from(result.build());
let asset = VirtualSource::new(
source.ident().path().join(match path_type {
PathType::Page => "pages-entry.tsx".to_string(),
PathType::PagesAPI => "pages-api-entry.tsx".to_string(),
_ => bail!("Invalid path type"),
}),
AssetContent::file(file.into()),
);
let ssr_module = ssr_module_context.process(
Vc::upcast(asset),
Value::new(ReferenceType::Internal(Vc::cell(indexmap! {
"INNER".to_string() => ssr_module,
}))),
);
let client_module = create_page_loader_entry_module(client_module_context, source, pathname); let client_module = create_page_loader_entry_module(client_module_context, source, pathname);
let Some(client_module) = let Some(client_module) =
......
...@@ -2,8 +2,8 @@ ...@@ -2,8 +2,8 @@
// the other imports // the other imports
import startHandler from '../internal/page-server-handler' import startHandler from '../internal/page-server-handler'
import App from '@vercel/turbopack-next/pages/_app'
import Document from '@vercel/turbopack-next/pages/_document' import Document from '@vercel/turbopack-next/pages/_document'
import App from '@vercel/turbopack-next/pages/_app'
import chunkGroup from 'INNER_CLIENT_CHUNK_GROUP' import chunkGroup from 'INNER_CLIENT_CHUNK_GROUP'
......
...@@ -34,6 +34,7 @@ use crate::next_config::{NextConfig, OutputType}; ...@@ -34,6 +34,7 @@ use crate::next_config::{NextConfig, OutputType};
#[derive(Debug, Clone, Copy, PartialEq, Eq, TaskInput)] #[derive(Debug, Clone, Copy, PartialEq, Eq, TaskInput)]
pub enum PathType { pub enum PathType {
Page, Page,
PagesAPI,
Data, Data,
} }
......
...@@ -55,6 +55,8 @@ import { fileExists } from '../lib/file-exists' ...@@ -55,6 +55,8 @@ import { fileExists } from '../lib/file-exists'
import { getRouteLoaderEntry } from './webpack/loaders/next-route-loader' import { getRouteLoaderEntry } from './webpack/loaders/next-route-loader'
import { isInternalComponent } from '../lib/is-internal-component' import { isInternalComponent } from '../lib/is-internal-component'
import { isStaticMetadataRouteFile } from '../lib/metadata/is-metadata-route' import { isStaticMetadataRouteFile } from '../lib/metadata/is-metadata-route'
import { RouteKind } from '../server/future/route-kind'
import { encodeToBase64 } from './webpack/loaders/utils'
export async function getStaticInfoIncludingLayouts({ export async function getStaticInfoIncludingLayouts({
isInsideAppDir, isInsideAppDir,
...@@ -589,9 +591,7 @@ export async function createEntrypoints( ...@@ -589,9 +591,7 @@ export async function createEntrypoints(
assetPrefix: config.assetPrefix, assetPrefix: config.assetPrefix,
nextConfigOutput: config.output, nextConfigOutput: config.output,
preferredRegion: staticInfo.preferredRegion, preferredRegion: staticInfo.preferredRegion,
middlewareConfig: Buffer.from( middlewareConfig: encodeToBase64(staticInfo.middleware || {}),
JSON.stringify(staticInfo.middleware || {})
).toString('base64'),
}) })
} else if (isInstrumentationHookFile(page) && pagesType === 'root') { } else if (isInstrumentationHookFile(page) && pagesType === 'root') {
server[serverBundlePath.replace('src/', '')] = { server[serverBundlePath.replace('src/', '')] = {
...@@ -599,13 +599,23 @@ export async function createEntrypoints( ...@@ -599,13 +599,23 @@ export async function createEntrypoints(
// the '../' is needed to make sure the file is not chunked // the '../' is needed to make sure the file is not chunked
filename: `../${INSTRUMENTATION_HOOK_FILENAME}.js`, filename: `../${INSTRUMENTATION_HOOK_FILENAME}.js`,
} }
} else if (isAPIRoute(page)) {
server[serverBundlePath] = [
getRouteLoaderEntry({
kind: RouteKind.PAGES_API,
page,
absolutePagePath,
preferredRegion: staticInfo.preferredRegion,
middlewareConfig: staticInfo.middleware || {},
}),
]
} else if ( } else if (
!isAPIRoute(page) &&
!isMiddlewareFile(page) && !isMiddlewareFile(page) &&
!isInternalComponent(absolutePagePath) !isInternalComponent(absolutePagePath)
) { ) {
server[serverBundlePath] = [ server[serverBundlePath] = [
getRouteLoaderEntry({ getRouteLoaderEntry({
kind: RouteKind.PAGES,
page, page,
pages, pages,
absolutePagePath, absolutePagePath,
......
...@@ -5,23 +5,25 @@ import type { ...@@ -5,23 +5,25 @@ import type {
} from '../../analysis/get-page-static-info' } from '../../analysis/get-page-static-info'
import { webpack } from 'next/dist/compiled/webpack/webpack' import { webpack } from 'next/dist/compiled/webpack/webpack'
export type ModuleBuildInfo = {
nextEdgeMiddleware?: EdgeMiddlewareMeta
nextEdgeApiFunction?: EdgeMiddlewareMeta
nextEdgeSSR?: EdgeSSRMeta
nextWasmMiddlewareBinding?: AssetBinding
nextAssetMiddlewareBinding?: AssetBinding
usingIndirectEval?: boolean | Set<string>
route?: RouteMeta
importLocByPath?: Map<string, any>
rootDir?: string
rsc?: RSCMeta
}
/** /**
* A getter for module build info that casts to the type it should have. * A getter for module build info that casts to the type it should have.
* We also expose here types to make easier to use it. * We also expose here types to make easier to use it.
*/ */
export function getModuleBuildInfo(webpackModule: webpack.Module) { export function getModuleBuildInfo(webpackModule: webpack.Module) {
return webpackModule.buildInfo as { return webpackModule.buildInfo as ModuleBuildInfo
nextEdgeMiddleware?: EdgeMiddlewareMeta
nextEdgeApiFunction?: EdgeMiddlewareMeta
nextEdgeSSR?: EdgeSSRMeta
nextWasmMiddlewareBinding?: AssetBinding
nextAssetMiddlewareBinding?: AssetBinding
usingIndirectEval?: boolean | Set<string>
route?: RouteMeta
importLocByPath?: Map<string, any>
rootDir?: string
rsc?: RSCMeta
}
} }
export interface RSCMeta { export interface RSCMeta {
......
...@@ -191,17 +191,17 @@ export async function parseBody( ...@@ -191,17 +191,17 @@ export async function parseBody(
} }
} }
type RevalidateFn = (config: {
urlPath: string
revalidateHeaders: { [key: string]: string | string[] }
opts: { unstable_onlyGenerated?: boolean }
}) => Promise<void>
type ApiContext = __ApiPreviewProps & { type ApiContext = __ApiPreviewProps & {
trustHostHeader?: boolean trustHostHeader?: boolean
allowedRevalidateHeaderKeys?: string[] allowedRevalidateHeaderKeys?: string[]
hostname?: string hostname?: string
revalidate?: (config: { revalidate?: RevalidateFn
urlPath: string
revalidateHeaders: { [key: string]: string | string[] }
opts: { unstable_onlyGenerated?: boolean }
}) => Promise<any>
// (_req: IncomingMessage, _res: ServerResponse) => Promise<any>
} }
function getMaxContentLength(responseLimit?: ResponseLimit) { function getMaxContentLength(responseLimit?: ResponseLimit) {
......
...@@ -31,6 +31,7 @@ import type { NodeNextRequest, NodeNextResponse } from './base-http/node' ...@@ -31,6 +31,7 @@ import type { NodeNextRequest, NodeNextResponse } from './base-http/node'
import type { AppRouteRouteMatch } from './future/route-matches/app-route-route-match' import type { AppRouteRouteMatch } from './future/route-matches/app-route-route-match'
import type { RouteDefinition } from './future/route-definitions/route-definition' import type { RouteDefinition } from './future/route-definitions/route-definition'
import type { WebNextRequest, WebNextResponse } from './base-http/web' import type { WebNextRequest, WebNextResponse } from './base-http/web'
import type { PagesAPIRouteMatch } from './future/route-matches/pages-api-route-match'
import { format as formatUrl, parse as parseUrl } from 'url' import { format as formatUrl, parse as parseUrl } from 'url'
import { getRedirectStatus } from '../lib/redirect-status' import { getRedirectStatus } from '../lib/redirect-status'
...@@ -314,9 +315,7 @@ export default abstract class Server<ServerOptions extends Options = Options> { ...@@ -314,9 +315,7 @@ export default abstract class Server<ServerOptions extends Options = Options> {
req: BaseNextRequest, req: BaseNextRequest,
res: BaseNextResponse, res: BaseNextResponse,
query: ParsedUrlQuery, query: ParsedUrlQuery,
params: Params | undefined, match: PagesAPIRouteMatch
page: string,
builtPagePath: string
): Promise<boolean> ): Promise<boolean>
protected abstract renderHTML( protected abstract renderHTML(
...@@ -1897,13 +1896,13 @@ export default abstract class Server<ServerOptions extends Options = Options> { ...@@ -1897,13 +1896,13 @@ export default abstract class Server<ServerOptions extends Options = Options> {
components.routeModule components.routeModule
) { ) {
const module = components.routeModule as PagesRouteModule const module = components.routeModule as PagesRouteModule
renderOpts.clientReferenceManifest = components.clientReferenceManifest
// Due to the way we pass data by mutating `renderOpts`, we can't extend // Due to the way we pass data by mutating `renderOpts`, we can't extend
// the object here but only updating its `nextFontManifest` // the object here but only updating its `clientReferenceManifest` and
// field. // `nextFontManifest` properties.
// https://github.com/vercel/next.js/blob/df7cbd904c3bd85f399d1ce90680c0ecf92d2752/packages/next/server/render.tsx#L947-L952 // https://github.com/vercel/next.js/blob/df7cbd904c3bd85f399d1ce90680c0ecf92d2752/packages/next/server/render.tsx#L947-L952
renderOpts.nextFontManifest = this.nextFontManifest renderOpts.nextFontManifest = this.nextFontManifest
renderOpts.clientReferenceManifest = components.clientReferenceManifest
// Call the built-in render method on the module. // Call the built-in render method on the module.
result = await module.render( result = await module.render(
...@@ -1920,7 +1919,7 @@ export default abstract class Server<ServerOptions extends Options = Options> { ...@@ -1920,7 +1919,7 @@ export default abstract class Server<ServerOptions extends Options = Options> {
const module = components.routeModule as AppPageRouteModule const module = components.routeModule as AppPageRouteModule
// Due to the way we pass data by mutating `renderOpts`, we can't extend the // Due to the way we pass data by mutating `renderOpts`, we can't extend the
// object here but only updating its `clientReferenceManifest` field. // object here but only updating its `nextFontManifest` field.
// https://github.com/vercel/next.js/blob/df7cbd904c3bd85f399d1ce90680c0ecf92d2752/packages/next/server/render.tsx#L947-L952 // https://github.com/vercel/next.js/blob/df7cbd904c3bd85f399d1ce90680c0ecf92d2752/packages/next/server/render.tsx#L947-L952
renderOpts.nextFontManifest = this.nextFontManifest renderOpts.nextFontManifest = this.nextFontManifest
......
...@@ -297,6 +297,11 @@ export interface ExperimentalConfig { ...@@ -297,6 +297,11 @@ export interface ExperimentalConfig {
* Enables source maps generation for the server production bundle. * Enables source maps generation for the server production bundle.
*/ */
serverSourceMaps?: boolean serverSourceMaps?: boolean
/**
* @internal Used by the Next.js internals only.
*/
trustHostHeader?: boolean
} }
export type ExportPathMap = { export type ExportPathMap = {
......
...@@ -62,6 +62,7 @@ import { parseVersionInfo, VersionInfo } from './parse-version-info' ...@@ -62,6 +62,7 @@ import { parseVersionInfo, VersionInfo } from './parse-version-info'
import { isAPIRoute } from '../../lib/is-api-route' import { isAPIRoute } from '../../lib/is-api-route'
import { getRouteLoaderEntry } from '../../build/webpack/loaders/next-route-loader' import { getRouteLoaderEntry } from '../../build/webpack/loaders/next-route-loader'
import { isInternalComponent } from '../../lib/is-internal-component' import { isInternalComponent } from '../../lib/is-internal-component'
import { RouteKind } from '../future/route-kind'
function diff(a: Set<any>, b: Set<any>) { function diff(a: Set<any>, b: Set<any>) {
return new Set([...a].filter((v) => !b.has(v))) return new Set([...a].filter((v) => !b.has(v)))
...@@ -906,12 +907,20 @@ export default class HotReloader { ...@@ -906,12 +907,20 @@ export default class HotReloader {
JSON.stringify(staticInfo.middleware || {}) JSON.stringify(staticInfo.middleware || {})
).toString('base64'), ).toString('base64'),
}) })
} else if (isAPIRoute(page)) {
value = getRouteLoaderEntry({
kind: RouteKind.PAGES_API,
page,
absolutePagePath: relativeRequest,
preferredRegion: staticInfo.preferredRegion,
middlewareConfig: staticInfo.middleware || {},
})
} else if ( } else if (
!isAPIRoute(page) &&
!isMiddlewareFile(page) && !isMiddlewareFile(page) &&
!isInternalComponent(relativeRequest) !isInternalComponent(relativeRequest)
) { ) {
value = getRouteLoaderEntry({ value = getRouteLoaderEntry({
kind: RouteKind.PAGES,
page, page,
pages: this.pagesMapping, pages: this.pagesMapping,
absolutePagePath: relativeRequest, absolutePagePath: relativeRequest,
......
...@@ -12,12 +12,11 @@ export class RouteModuleLoader { ...@@ -12,12 +12,11 @@ export class RouteModuleLoader {
id: string, id: string,
loader: ModuleLoader = new NodeModuleLoader() loader: ModuleLoader = new NodeModuleLoader()
): Promise<M> { ): Promise<M> {
if (process.env.NEXT_RUNTIME !== 'edge') { const module: AppLoaderModule<M> = await loader.load(id)
const { routeModule }: AppLoaderModule<M> = await loader.load(id) if ('routeModule' in module) {
return module.routeModule
return routeModule
} }
throw new Error('RouteModuleLoader is not supported in edge runtime.') throw new Error(`Module "${id}" does not export a routeModule.`)
} }
} }
import type { IncomingMessage, ServerResponse } from 'http'
import type { PagesAPIRouteDefinition } from '../../route-definitions/pages-api-route-definition'
import type { PageConfig } from '../../../../../types'
import type { ParsedUrlQuery } from 'querystring'
import {
RouteModule,
RouteModuleOptions,
type RouteModuleHandleContext,
} from '../route-module'
import { apiResolver } from '../../../api-utils/node'
import { __ApiPreviewProps } from '../../../api-utils'
type PagesAPIHandleFn = (
req: IncomingMessage,
res: ServerResponse
) => Promise<void>
type PagesAPIUserlandModule = {
/**
* The exported handler method.
*/
readonly default: PagesAPIHandleFn
/**
* The exported page config.
*/
readonly config?: PageConfig
}
type PagesAPIRouteHandlerContext = RouteModuleHandleContext & {
/**
* The incoming server request in non-edge runtime.
*/
req?: IncomingMessage
/**
* The outgoing server response in non-edge runtime.
*/
res?: ServerResponse
/**
* The revalidate method used by the `revalidate` API.
*
* @param config the configuration for the revalidation
*/
revalidate: (config: {
urlPath: string
revalidateHeaders: { [key: string]: string | string[] }
opts: { unstable_onlyGenerated?: boolean }
}) => Promise<void>
/**
* The hostname for the request.
*/
hostname?: string
/**
* Keys allowed in the revalidate call.
*/
allowedRevalidateHeaderKeys?: string[]
/**
* Whether to trust the host header.
*/
trustHostHeader?: boolean
/**
* The query for the request.
*/
query: ParsedUrlQuery
/**
* The preview props used by the `preview` API.
*/
previewProps: __ApiPreviewProps
/**
* True if the server is in development mode.
*/
dev: boolean
/**
* True if the server is in minimal mode.
*/
minimalMode: boolean
/**
* The page that's being rendered.
*/
page: string
}
export type PagesAPIRouteModuleOptions = RouteModuleOptions<
PagesAPIRouteDefinition,
PagesAPIUserlandModule
>
export class PagesAPIRouteModule extends RouteModule<
PagesAPIRouteDefinition,
PagesAPIUserlandModule
> {
public handle(): Promise<Response> {
throw new Error('Method not implemented.')
}
/**
*
* @param req the incoming server request
* @param res the outgoing server response
* @param context the context for the render
*/
public async render(
req: IncomingMessage,
res: ServerResponse,
context: PagesAPIRouteHandlerContext
): Promise<void> {
await apiResolver(
req,
res,
context.query,
this.userland,
{
...context.previewProps,
revalidate: context.revalidate,
trustHostHeader: context.trustHostHeader,
allowedRevalidateHeaderKeys: context.allowedRevalidateHeaderKeys,
hostname: context.hostname,
},
context.minimalMode,
context.dev,
context.page
)
}
}
export default PagesAPIRouteModule
...@@ -31,6 +31,7 @@ import { renderToHTML, type RenderOpts } from './render' ...@@ -31,6 +31,7 @@ import { renderToHTML, type RenderOpts } from './render'
import fs from 'fs' import fs from 'fs'
import { join, resolve, isAbsolute } from 'path' import { join, resolve, isAbsolute } from 'path'
import { IncomingMessage, ServerResponse } from 'http' import { IncomingMessage, ServerResponse } from 'http'
import type { PagesAPIRouteModule } from './future/route-modules/pages-api/module'
import { addRequestMeta, getRequestMeta } from './request-meta' import { addRequestMeta, getRequestMeta } from './request-meta'
import { import {
PAGES_MANIFEST, PAGES_MANIFEST,
...@@ -52,7 +53,6 @@ import { NodeNextRequest, NodeNextResponse } from './base-http/node' ...@@ -52,7 +53,6 @@ import { NodeNextRequest, NodeNextResponse } from './base-http/node'
import { sendRenderResult } from './send-payload' import { sendRenderResult } from './send-payload'
import { getExtension, serveStatic } from './serve-static' import { getExtension, serveStatic } from './serve-static'
import { ParsedUrlQuery } from 'querystring' import { ParsedUrlQuery } from 'querystring'
import { apiResolver } from './api-utils/node'
import { ParsedUrl, parseUrl } from '../shared/lib/router/utils/parse-url' import { ParsedUrl, parseUrl } from '../shared/lib/router/utils/parse-url'
import * as Log from '../build/output/log' import * as Log from '../build/output/log'
...@@ -97,6 +97,7 @@ import { createRequestResponseMocks } from './lib/mock-request' ...@@ -97,6 +97,7 @@ import { createRequestResponseMocks } from './lib/mock-request'
import chalk from 'next/dist/compiled/chalk' import chalk from 'next/dist/compiled/chalk'
import { NEXT_RSC_UNION_QUERY } from '../client/components/app-router-headers' import { NEXT_RSC_UNION_QUERY } from '../client/components/app-router-headers'
import { signalFromNodeRequest } from './web/spec-extension/adapters/next-request' import { signalFromNodeRequest } from './web/spec-extension/adapters/next-request'
import { RouteModuleLoader } from './future/helpers/module-loader/route-module-loader'
import { loadManifest } from './load-manifest' import { loadManifest } from './load-manifest'
export * from './base-server' export * from './base-server'
...@@ -382,20 +383,18 @@ export default class NextNodeServer extends BaseServer { ...@@ -382,20 +383,18 @@ export default class NextNodeServer extends BaseServer {
req: BaseNextRequest | NodeNextRequest, req: BaseNextRequest | NodeNextRequest,
res: BaseNextResponse | NodeNextResponse, res: BaseNextResponse | NodeNextResponse,
query: ParsedUrlQuery, query: ParsedUrlQuery,
params: Params | undefined, match: PagesAPIRouteMatch
page: string,
builtPagePath: string
): Promise<boolean> { ): Promise<boolean> {
const edgeFunctionsPages = this.getEdgeFunctionsPages() const edgeFunctionsPages = this.getEdgeFunctionsPages()
for (const edgeFunctionsPage of edgeFunctionsPages) { for (const edgeFunctionsPage of edgeFunctionsPages) {
if (edgeFunctionsPage === page) { if (edgeFunctionsPage === match.definition.pathname) {
const handledAsEdgeFunction = await this.runEdgeFunction({ const handledAsEdgeFunction = await this.runEdgeFunction({
req, req,
res, res,
query, query,
params, params: match.params,
page, page: match.definition.pathname,
appPaths: null, appPaths: null,
}) })
...@@ -405,32 +404,35 @@ export default class NextNodeServer extends BaseServer { ...@@ -405,32 +404,35 @@ export default class NextNodeServer extends BaseServer {
} }
} }
const pageModule = await require(builtPagePath) // The module supports minimal mode, load the minimal module.
query = { ...query, ...params } const module = await RouteModuleLoader.load<PagesAPIRouteModule>(
match.definition.filename
)
query = { ...query, ...match.params }
delete query.__nextLocale delete query.__nextLocale
delete query.__nextDefaultLocale delete query.__nextDefaultLocale
delete query.__nextInferredLocaleFromDefault delete query.__nextInferredLocaleFromDefault
await apiResolver( await module.render(
(req as NodeNextRequest).originalRequest, (req as NodeNextRequest).originalRequest,
(res as NodeNextResponse).originalResponse, (res as NodeNextResponse).originalResponse,
query,
pageModule,
{ {
...this.renderOpts.previewProps, previewProps: this.renderOpts.previewProps,
revalidate: this.revalidate.bind(this), revalidate: this.revalidate.bind(this),
// internal config so is not typed trustHostHeader: this.nextConfig.experimental.trustHostHeader,
trustHostHeader: (this.nextConfig.experimental as Record<string, any>)
.trustHostHeader,
allowedRevalidateHeaderKeys: allowedRevalidateHeaderKeys:
this.nextConfig.experimental.allowedRevalidateHeaderKeys, this.nextConfig.experimental.allowedRevalidateHeaderKeys,
hostname: this.hostname, hostname: this.hostname,
}, minimalMode: this.minimalMode,
this.minimalMode, dev: this.renderOpts.dev === true,
this.renderOpts.dev, query,
page params: match.params,
page: match.definition.pathname,
}
) )
return true return true
} }
...@@ -1022,12 +1024,7 @@ export default class NextNodeServer extends BaseServer { ...@@ -1022,12 +1024,7 @@ export default class NextNodeServer extends BaseServer {
query: ParsedUrlQuery, query: ParsedUrlQuery,
match: PagesAPIRouteMatch match: PagesAPIRouteMatch
): Promise<boolean> { ): Promise<boolean> {
const { return this.runApi(req, res, query, match)
definition: { pathname, filename },
params,
} = match
return this.runApi(req, res, query, params, pathname, filename)
} }
protected getCacheFilesystem(): CacheFs { protected getCacheFilesystem(): CacheFs {
...@@ -1214,7 +1211,6 @@ export default class NextNodeServer extends BaseServer { ...@@ -1214,7 +1211,6 @@ export default class NextNodeServer extends BaseServer {
) { ) {
throw new Error(`Invalid response ${mocked.res.statusCode}`) throw new Error(`Invalid response ${mocked.res.statusCode}`)
} }
return {}
} }
public async render( public async render(
......
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