Always call createPagesMapping for root paths (vercel#60107)

## What? Always call `createPagesMapping` as it already handles the case when there are no paths. Also introduces `PAGE_TYPES` to have a single source of truth for these types and where they're used. As you can see this replaces a ton of hardcoded `'app'`, `'pages'`, and `'root'` references.  Closes NEXT-1935
agustints · Jan 6, 2024 · 9f13546 · 9f13546
1 parent f7b3adb
commit 9f13546
Show file tree

Hide file tree

Showing 20 changed files with 151 additions and 110 deletions.
diff --git a/packages/next/src/build/analysis/get-page-static-info.ts b/packages/next/src/build/analysis/get-page-static-info.ts
@@ -18,6 +18,7 @@ import { isAPIRoute } from '../../lib/is-api-route'
 import { isEdgeRuntime } from '../../lib/is-edge-runtime'
 import { RSC_MODULE_TYPES } from '../../shared/lib/constants'
 import type { RSCMeta } from '../webpack/loaders/get-module-build-info'
+import { PAGE_TYPES } from '../../lib/page-types'
 
 // TODO: migrate preferredRegion here
 // Don't forget to update the next-types-plugin file as well
@@ -478,7 +479,7 @@ export async function getPageStaticInfo(params: {
   nextConfig: Partial<NextConfig>
   isDev?: boolean
   page?: string
-  pageType: 'pages' | 'app' | 'root'
+  pageType: PAGE_TYPES
 }): Promise<PageStaticInfo> {
   const { isDev, pageFilePath, nextConfig, page, pageType } = params
 
@@ -514,7 +515,7 @@ export async function getPageStaticInfo(params: {
 
     const extraConfig: Record<string, any> = {}
 
-    if (extraProperties && pageType === 'app') {
+    if (extraProperties && pageType === PAGE_TYPES.APP) {
       for (const prop of extraProperties) {
         if (!AUTHORIZED_EXTRA_ROUTER_PROPS.includes(prop)) continue
         try {
@@ -525,14 +526,14 @@ export async function getPageStaticInfo(params: {
           }
         }
       }
-    } else if (pageType === 'pages') {
+    } else if (pageType === PAGE_TYPES.PAGES) {
       for (const key in config) {
         if (!AUTHORIZED_EXTRA_ROUTER_PROPS.includes(key)) continue
         extraConfig[key] = config[key]
       }
     }
 
-    if (pageType === 'app') {
+    if (pageType === PAGE_TYPES.APP) {
       if (config) {
         let message = `Page config in ${pageFilePath} is deprecated. Replace \`export const config=…\` with the following:`
 
@@ -565,7 +566,7 @@ export async function getPageStaticInfo(params: {
     // and deprecate the old way. To prevent breaking changes for `pages`, we use the exported config
     // as the fallback value.
     let resolvedRuntime
-    if (pageType === 'app') {
+    if (pageType === PAGE_TYPES.APP) {
       resolvedRuntime = runtime
     } else {
       resolvedRuntime = runtime || config.runtime
@@ -588,7 +589,7 @@ export async function getPageStaticInfo(params: {
       }
     }
 
-    const requiresServerRuntime = ssr || ssg || pageType === 'app'
+    const requiresServerRuntime = ssr || ssg || pageType === PAGE_TYPES.APP
 
     const isAnAPIRoute = isAPIRoute(page?.replace(/^(?:\/src)?\/pages\//, '/'))
 
@@ -603,7 +604,7 @@ export async function getPageStaticInfo(params: {
 
     if (
       resolvedRuntime === SERVER_RUNTIME.edge &&
-      pageType === 'pages' &&
+      pageType === PAGE_TYPES.PAGES &&
       page &&
       !isAnAPIRoute
     ) {
@@ -622,7 +623,7 @@ export async function getPageStaticInfo(params: {
     )
 
     if (
-      pageType === 'app' &&
+      pageType === PAGE_TYPES.APP &&
       directives?.has('client') &&
       generateStaticParams
     ) {

diff --git a/packages/next/src/build/entries.ts b/packages/next/src/build/entries.ts
@@ -61,6 +61,7 @@ import { encodeToBase64 } from './webpack/loaders/utils'
 import { normalizeCatchAllRoutes } from './normalize-catchall-routes'
 import type { PageExtensions } from './page-extensions-type'
 import type { MappedPages } from './build-context'
+import { PAGE_TYPES } from '../lib/page-types'
 
 export function sortByPageExts(pageExtensions: PageExtensions) {
   return (a: string, b: string) => {
@@ -106,7 +107,7 @@ export async function getStaticInfoIncludingLayouts({
     pageFilePath,
     isDev,
     page,
-    pageType: isInsideAppDir ? 'app' : 'pages',
+    pageType: isInsideAppDir ? PAGE_TYPES.APP : PAGE_TYPES.PAGES,
   })
 
   const staticInfo: PageStaticInfo = isInsideAppDir
@@ -139,7 +140,7 @@ export async function getStaticInfoIncludingLayouts({
         pageFilePath: layoutFile,
         isDev,
         page,
-        pageType: isInsideAppDir ? 'app' : 'pages',
+        pageType: isInsideAppDir ? PAGE_TYPES.APP : PAGE_TYPES.PAGES,
       })
 
       // Only runtime is relevant here.
@@ -226,13 +227,13 @@ export function createPagesMapping({
   isDev: boolean
   pageExtensions: PageExtensions
   pagePaths: string[]
-  pagesType: 'pages' | 'root' | 'app'
+  pagesType: PAGE_TYPES
   pagesDir: string | undefined
 }): MappedPages {
   const isAppRoute = pagesType === 'app'
   const pages = pagePaths.reduce<{ [key: string]: string }>(
     (result, pagePath) => {
-      // Do not process .d.ts files inside the `pages` folder
+      // Do not process .d.ts files as routes
       if (pagePath.endsWith('.d.ts') && pageExtensions.includes('ts')) {
         return result
       }
@@ -262,38 +263,45 @@ export function createPagesMapping({
     {}
   )
 
-  if (pagesType === 'app') {
-    const hasAppPages = Object.keys(pages).some((page) =>
-      page.endsWith('/page')
-    )
-    return {
-      // If there's any app pages existed, add a default not-found page.
-      // If there's any custom not-found page existed, it will override the default one.
-      ...(hasAppPages && {
-        '/_not-found': 'next/dist/client/components/not-found-error',
-      }),
-      ...pages,
+  switch (pagesType) {
+    case PAGE_TYPES.ROOT: {
+      return pages
     }
-  } else if (pagesType === 'root') {
-    return pages
-  }
-
-  if (isDev) {
-    delete pages['/_app']
-    delete pages['/_error']
-    delete pages['/_document']
-  }
+    case PAGE_TYPES.APP: {
+      const hasAppPages = Object.keys(pages).some((page) =>
+        page.endsWith('/page')
+      )
+      return {
+        // If there's any app pages existed, add a default not-found page.
+        // If there's any custom not-found page existed, it will override the default one.
+        ...(hasAppPages && {
+          '/_not-found': 'next/dist/client/components/not-found-error',
+        }),
+        ...pages,
+      }
+    }
+    case PAGE_TYPES.PAGES: {
+      if (isDev) {
+        delete pages['/_app']
+        delete pages['/_error']
+        delete pages['/_document']
+      }
 
-  // In development we always alias these to allow Webpack to fallback to
-  // the correct source file so that HMR can work properly when a file is
-  // added or removed.
-  const root = isDev && pagesDir ? PAGES_DIR_ALIAS : 'next/dist/pages'
+      // In development we always alias these to allow Webpack to fallback to
+      // the correct source file so that HMR can work properly when a file is
+      // added or removed.
+      const root = isDev && pagesDir ? PAGES_DIR_ALIAS : 'next/dist/pages'
 
-  return {
-    '/_app': `${root}/_app`,
-    '/_error': `${root}/_error`,
-    '/_document': `${root}/_document`,
-    ...pages,
+      return {
+        '/_app': `${root}/_app`,
+        '/_error': `${root}/_error`,
+        '/_document': `${root}/_document`,
+        ...pages,
+      }
+    }
+    default: {
+      return {}
+    }
   }
 }
 
@@ -324,7 +332,7 @@ export function getEdgeServerEntry(opts: {
   page: string
   pages: MappedPages
   middleware?: Partial<MiddlewareConfig>
-  pagesType: 'app' | 'pages' | 'root'
+  pagesType: PAGE_TYPES
   appDirLoader?: string
   hasInstrumentationHook?: boolean
   preferredRegion: string | string[] | undefined
@@ -456,9 +464,12 @@ export function runDependingOnPageType<T>(params: {
   onServer: () => T
   page: string
   pageRuntime: ServerRuntime
-  pageType?: 'app' | 'pages' | 'root'
+  pageType?: PAGE_TYPES
 }): void {
-  if (params.pageType === 'root' && isInstrumentationHookFile(params.page)) {
+  if (
+    params.pageType === PAGE_TYPES.ROOT &&
+    isInstrumentationHookFile(params.page)
+  ) {
     params.onServer()
     params.onEdgeServer()
     return
@@ -550,17 +561,14 @@ export async function createEntrypoints(
   }
 
   const getEntryHandler =
-    (
-      mappings: MappedPages,
-      pagesType: 'app' | 'pages' | 'root'
-    ): ((page: string) => void) =>
+    (mappings: MappedPages, pagesType: PAGE_TYPES): ((page: string) => void) =>
     async (page) => {
       const bundleFile = normalizePagePath(page)
       const clientBundlePath = posix.join(pagesType, bundleFile)
       const serverBundlePath =
-        pagesType === 'pages'
+        pagesType === PAGE_TYPES.PAGES
           ? posix.join('pages', bundleFile)
-          : pagesType === 'app'
+          : pagesType === PAGE_TYPES.APP
           ? posix.join('app', bundleFile)
           : bundleFile.slice(1)
       const absolutePagePath = mappings[page]
@@ -629,7 +637,10 @@ export async function createEntrypoints(
               preferredRegion: staticInfo.preferredRegion,
               middlewareConfig: encodeToBase64(staticInfo.middleware || {}),
             })
-          } else if (isInstrumentationHookFile(page) && pagesType === 'root') {
+          } else if (
+            isInstrumentationHookFile(page) &&
+            pagesType === PAGE_TYPES.ROOT
+          ) {
             server[serverBundlePath.replace('src/', '')] = {
               import: absolutePagePath,
               // the '../' is needed to make sure the file is not chunked
@@ -687,7 +698,7 @@ export async function createEntrypoints(
             }).import
           }
           const normalizedServerBundlePath =
-            isInstrumentationHookFile(page) && pagesType === 'root'
+            isInstrumentationHookFile(page) && pagesType === PAGE_TYPES.ROOT
               ? serverBundlePath.replace('src/', '')
               : serverBundlePath
           edgeServer[normalizedServerBundlePath] = getEdgeServerEntry({
@@ -711,18 +722,20 @@ export async function createEntrypoints(
   const promises: Promise<void[]>[] = []
 
   if (appPaths) {
-    const entryHandler = getEntryHandler(appPaths, 'app')
+    const entryHandler = getEntryHandler(appPaths, PAGE_TYPES.APP)
     promises.push(Promise.all(Object.keys(appPaths).map(entryHandler)))
   }
   if (rootPaths) {
     promises.push(
       Promise.all(
-        Object.keys(rootPaths).map(getEntryHandler(rootPaths, 'root'))
+        Object.keys(rootPaths).map(getEntryHandler(rootPaths, PAGE_TYPES.ROOT))
       )
     )
   }
   promises.push(
-    Promise.all(Object.keys(pages).map(getEntryHandler(pages, 'pages')))
+    Promise.all(
+      Object.keys(pages).map(getEntryHandler(pages, PAGE_TYPES.PAGES))
+    )
   )
 
   await Promise.all(promises)

diff --git a/packages/next/src/build/index.ts b/packages/next/src/build/index.ts
@@ -100,6 +100,7 @@ import {
   getPageStaticInfo,
 } from './analysis/get-page-static-info'
 import { createPagesMapping, getPageFilePath, sortByPageExts } from './entries'
+import { PAGE_TYPES } from '../lib/page-types'
 import { generateBuildId } from './generate-build-id'
 import { isWriteable } from './is-writeable'
 import * as Log from './output/log'
@@ -600,7 +601,7 @@ export default async function build(
           createPagesMapping({
             isDev: false,
             pageExtensions: config.pageExtensions,
-            pagesType: 'pages',
+            pagesType: PAGE_TYPES.PAGES,
             pagePaths: pagesPaths,
             pagesDir,
           })
@@ -630,7 +631,7 @@ export default async function build(
             createPagesMapping({
               pagePaths: appPaths,
               isDev: false,
-              pagesType: 'app',
+              pagesType: PAGE_TYPES.APP,
               pageExtensions: config.pageExtensions,
               pagesDir: pagesDir,
             })
@@ -672,18 +673,13 @@ export default async function build(
         NextBuildContext.mappedAppPages = mappedAppPages
       }
 
-      let mappedRootPaths: MappedPages = {}
-
-      if (rootPaths.length > 0) {
-        mappedRootPaths = createPagesMapping({
-          isDev: false,
-          pageExtensions: config.pageExtensions,
-          pagePaths: rootPaths,
-          pagesType: 'root',
-          pagesDir: pagesDir,
-        })
-      }
-
+      const mappedRootPaths = createPagesMapping({
+        isDev: false,
+        pageExtensions: config.pageExtensions,
+        pagePaths: rootPaths,
+        pagesType: PAGE_TYPES.ROOT,
+        pagesDir: pagesDir,
+      })
       NextBuildContext.mappedRootPaths = mappedRootPaths
 
       const pagesPageKeys = Object.keys(mappedPages)
@@ -1585,7 +1581,9 @@ export default async function build(
                   ? await getPageStaticInfo({
                       pageFilePath,
                       nextConfig: config,
-                      pageType,
+                      // TODO: fix type mismatch
+                      pageType:
+                        pageType === 'app' ? PAGE_TYPES.APP : PAGE_TYPES.PAGES,
                     })
                   : undefined
 

diff --git a/packages/next/src/build/templates/edge-ssr-app.ts b/packages/next/src/build/templates/edge-ssr-app.ts
@@ -10,6 +10,7 @@ import type { DocumentType } from '../../shared/lib/utils'
 import type { BuildManifest } from '../../server/get-page-files'
 import type { RequestData } from '../../server/web/types'
 import type { NextConfigComplete } from '../../server/config-shared'
+import { PAGE_TYPES } from '../../lib/page-types'
 
 declare const incrementalCacheHandler: any
 // OPTIONAL_IMPORT:incrementalCacheHandler
@@ -44,7 +45,7 @@ const subresourceIntegrityManifest = sriEnabled
 const nextFontManifest = maybeJSONParse(self.__NEXT_FONT_MANIFEST)
 
 const render = getRender({
-  pagesType: 'app',
+  pagesType: PAGE_TYPES.APP,
   dev,
   page: 'VAR_PAGE',
   appMod,

diff --git a/packages/next/src/build/templates/edge-ssr.ts b/packages/next/src/build/templates/edge-ssr.ts
@@ -22,9 +22,10 @@ import RouteModule from '../../server/future/route-modules/pages/module'
 import type { RequestData } from '../../server/web/types'
 import type { BuildManifest } from '../../server/get-page-files'
 import type { NextConfigComplete } from '../../server/config-shared'
+import type { PAGE_TYPES } from '../../lib/page-types'
 
 // injected by the loader afterwards.
-declare const pagesType: 'app' | 'pages' | 'root'
+declare const pagesType: PAGE_TYPES
 declare const sriEnabled: boolean
 declare const dev: boolean
 declare const nextConfig: NextConfigComplete

diff --git a/packages/next/src/build/webpack/loaders/next-edge-ssr-loader/index.ts b/packages/next/src/build/webpack/loaders/next-edge-ssr-loader/index.ts
@@ -8,6 +8,7 @@ import { WEBPACK_RESOURCE_QUERIES } from '../../../../lib/constants'
 import { RouteKind } from '../../../../server/future/route-kind'
 import { normalizePagePath } from '../../../../shared/lib/page-path/normalize-page-path'
 import { loadEntrypoint } from '../../../load-entrypoint'
+import type { PAGE_TYPES } from '../../../../lib/page-types'
 
 export type EdgeSSRLoaderQuery = {
   absolute500Path: string
@@ -21,7 +22,7 @@ export type EdgeSSRLoaderQuery = {
   page: string
   stringifiedConfig: string
   appDirLoader?: string
-  pagesType: 'app' | 'pages' | 'root'
+  pagesType: PAGE_TYPES
   sriEnabled: boolean
   incrementalCacheHandlerPath?: string
   preferredRegion: string | string[] | undefined