Implement initial handler interface for pages routes (#79260)

Continuation of #78166 this
implements the `handler` interface for pages routes, This does not move
the response handling inside of the handler yet as that will be in a
follow-up PR to keep the changes isolated. This still returns the
`RenderResult` for the `base-server` to continue to handle.

Validated against `vercel/vercel` deploy tests here
vercel/vercel#13349

Author: ijjk

packages/next/errors.json

@@ -678,11 +678,17 @@
   "677": "`trackDynamicImport` should always receive a promise. Something went wrong in the dynamic imports transform.",
   "678": "CacheSignal got more endRead() calls than beginRead() calls",
   "679": "A CacheSignal cannot subscribe to itself",
-  "680": "CacheSignal cannot be used in the edge runtime, because `dynamicIO` does not support it.",
-  "681": "Dynamic imports should not be instrumented in the edge runtime, because `dynamicIO` doesn't support it",
-  "682": "\\`experimental.ppr\\` can not be \\`%s\\` when \\`experimental.dynamicIO\\` is \\`true\\`. PPR is implicitly enabled when Dynamic IO is enabled.",
-  "683": "The \\`compiler.define\\` option is configured to replace the \\`%s\\` variable. This variable is either part of a Next.js built-in or is already configured.",
-  "684": "The \\`compiler.defineServer\\` option is configured to replace the \\`%s\\` variable. This variable is either part of a Next.js built-in or is already configured.",
-  "685": "Accessed fallback \\`params\\` during prerendering.",
-  "686": "Expected clientReferenceManifest to be defined."
+  "680": "Invariant: missing result from invoking %s",
+  "681": "Invariant: missing result from invoking %s handler",
+  "682": "Invariant: missing result",
+  "683": "Invariant: missing result from ",
+  "684": "Invariant: missing result from ino",
+  "685": "CacheSignal cannot be used in the edge runtime, because `dynamicIO` does not support it.",
+  "686": "\\`experimental.ppr\\` can not be \\`%s\\` when \\`experimental.dynamicIO\\` is \\`true\\`. PPR is implicitly enabled when Dynamic IO is enabled.",
+  "687": "Dynamic imports should not be instrumented in the edge runtime, because `dynamicIO` doesn't support it",
+  "688": "The \\`compiler.define\\` option is configured to replace the \\`%s\\` variable. This variable is either part of a Next.js built-in or is already configured.",
+  "689": "The \\`compiler.defineServer\\` option is configured to replace the \\`%s\\` variable. This variable is either part of a Next.js built-in or is already configured.",
+  "690": "Invariant: loadManifests called for edge runtime",
+  "691": "Accessed fallback \\`params\\` during prerendering.",
+  "692": "Expected clientReferenceManifest to be defined."
 }

packages/next/src/build/define-env.ts

@@ -1,5 +1,6 @@
 import type { I18NDomains, NextConfigComplete } from '../server/config-shared'
 import type { MiddlewareMatcher } from './analysis/get-page-static-info'
+import path from 'node:path'
 import { needsExperimentalReact } from '../lib/needs-experimental-react'
 import { checkIsAppPPREnabled } from '../server/lib/experimental/ppr'
 import {
@@ -20,6 +21,7 @@ export interface DefineEnvOptions {
   config: NextConfigComplete
   dev: boolean
   distDir: string
+  projectPath: string
   fetchCacheKeyPrefix: string | undefined
   hasRewrites: boolean
   isClient: boolean
@@ -89,6 +91,7 @@ export function getDefineEnv({
   config,
   dev,
   distDir,
+  projectPath,
   fetchCacheKeyPrefix,
   hasRewrites,
   isClient,
@@ -275,6 +278,10 @@ export function getDefineEnv({
     ...(isNodeServer
       ? {
           'process.env.__NEXT_RELATIVE_DIST_DIR': config.distDir,
+          'process.env.__NEXT_RELATIVE_PROJECT_DIR': path.relative(
+            process.cwd(),
+            projectPath
+          ),
         }
       : {}),
     'process.env.__NEXT_DEVTOOL_SEGMENT_EXPLORER':

packages/next/src/build/index.ts

@@ -551,7 +551,7 @@ async function writeFunctionsConfigManifest(
   )
 }
 
-interface RequiredServerFilesManifest {
+export interface RequiredServerFilesManifest {
   version: number
   config: NextConfigComplete
   appDir: string
@@ -2262,8 +2262,6 @@ export default async function build(
                 ...config.experimental,
                 cacheHandlers: normalizedCacheHandlers,
                 trustHostHeader: ciEnvironment.hasNextSupport,
-
-                // @ts-expect-error internal field TODO: fix this, should use a separate mechanism to pass the info.
                 isExperimentalCompile: isCompileMode,
               },
             },
@@ -2322,6 +2320,7 @@ export default async function build(
               BUILD_ID_FILE,
               path.join(SERVER_DIRECTORY, NEXT_FONT_MANIFEST + '.js'),
               path.join(SERVER_DIRECTORY, NEXT_FONT_MANIFEST + '.json'),
+              SERVER_FILES_MANIFEST,
               ...instrumentationHookEntryFiles,
             ]
               .filter(nonNullable)

packages/next/src/build/swc/index.ts

@@ -386,6 +386,7 @@ export function createDefineEnv({
   config,
   dev,
   distDir,
+  projectPath,
   fetchCacheKeyPrefix,
   hasRewrites,
   middlewareMatchers,
@@ -407,6 +408,7 @@ export function createDefineEnv({
         config,
         dev,
         distDir,
+        projectPath,
         fetchCacheKeyPrefix,
         hasRewrites,
         isClient: variant === 'client',

packages/next/src/build/templates/app-page.ts

@@ -49,4 +49,5 @@ export const routeModule = new AppPageRouteModule({
     loaderTree: tree,
   },
   distDir: process.env.__NEXT_RELATIVE_DIST_DIR || '',
+  projectDir: process.env.__NEXT_RELATIVE_PROJECT_DIR || '',
 })

packages/next/src/build/templates/app-route.ts

@@ -25,6 +25,7 @@ const routeModule = new AppRouteRouteModule({
     bundlePath: 'VAR_DEFINITION_BUNDLE_PATH',
   },
   distDir: process.env.__NEXT_RELATIVE_DIST_DIR || '',
+  projectDir: process.env.__NEXT_RELATIVE_PROJECT_DIR || '',
   resolvedPagePath: 'VAR_RESOLVED_PAGE_PATH',
   nextConfigOutput,
   userland,

packages/next/src/build/templates/pages-api.ts

@@ -12,6 +12,7 @@ import { hoist } from './helpers'
 import * as userland from 'VAR_USERLAND'
 import { getTracer, SpanKind } from '../../server/lib/trace/tracer'
 import { BaseServerSpan } from '../../server/lib/trace/constants'
+import type { InstrumentationOnRequestError } from '../../server/instrumentation/types'
 
 // Re-export the handler (should be the default export).
 export default hoist(userland, 'default')
@@ -31,6 +32,7 @@ const routeModule = new PagesAPIRouteModule({
   },
   userland,
   distDir: process.env.__NEXT_RELATIVE_DIST_DIR || '',
+  projectDir: process.env.__NEXT_RELATIVE_PROJECT_DIR || '',
 })
 
 export async function handler(
@@ -44,11 +46,12 @@ export async function handler(
 
   // turbopack doesn't normalize `/index` in the page name
   // so we need to to process dynamic routes properly
+  // TODO: fix turbopack providing differing value from webpack
   if (process.env.TURBOPACK) {
-    srcPage = srcPage.replace(/\/index$/, '')
+    srcPage = srcPage.replace(/\/index$/, '') || '/'
   }
 
-  const prepareResult = await routeModule.prepare(req, srcPage)
+  const prepareResult = await routeModule.prepare(req, res, { srcPage })
 
   if (!prepareResult) {
     res.statusCode = 400
@@ -64,11 +67,16 @@ export async function handler(
     const tracer = getTracer()
 
     const activeSpan = tracer.getActiveScopeSpan()
+    const onRequestError =
+      routeModule.instrumentationOnRequestError.bind(routeModule)
 
     const invokeRouteModule = async (span?: Span) =>
       routeModule
         .render(req, res, {
-          query,
+          query: {
+            ...query,
+            ...params,
+          },
           params,
           allowedRevalidateHeaderKeys: process.env
             .__NEXT_ALLOWED_REVALIDATE_HEADERS as any as string[],
@@ -81,8 +89,10 @@ export async function handler(
           propagateError: false,
           dev: routeModule.isDev,
           page: 'VAR_DEFINITION_PAGE',
+          projectDir: process.env.__NEXT_RELATIVE_PROJECT_DIR || '',
 
-          onError: routeModule.instrumentationOnRequestError.bind(routeModule),
+          onError: (...args: Parameters<InstrumentationOnRequestError>) =>
+            onRequestError(req, ...args),
         })
         .finally(() => {
           if (!span) return