Extract createAppRouteCode from next-app-loader.ts (#70352)

This is a small refactor in preparation for adding more logic to `createAppRouteCode` in a future PR. This change allows for a more focused diff when reviewing the upcoming PR. In this PR, all code lines are moved to the new file without any modifications.
vercel · Sep 23, 2024 · 64fdbcb · 64fdbcb
1 parent 952ecb2
commit 64fdbcb
Show file tree

Hide file tree

Showing 4 changed files with 93 additions and 85 deletions.
diff --git a/packages/next/src/build/webpack/loaders/next-app-loader/create-app-route-code.ts b/packages/next/src/build/webpack/loaders/next-app-loader/create-app-route-code.ts
@@ -0,0 +1,72 @@
+import path from 'path'
+import { stringify } from 'querystring'
+import { WEBPACK_RESOURCE_QUERIES } from '../../../../lib/constants'
+import { isMetadataRoute } from '../../../../lib/metadata/is-metadata-route'
+import type { NextConfig } from '../../../../server/config-shared'
+import { AppBundlePathNormalizer } from '../../../../server/normalizers/built/app/app-bundle-path-normalizer'
+import { AppPathnameNormalizer } from '../../../../server/normalizers/built/app/app-pathname-normalizer'
+import { loadEntrypoint } from '../../../load-entrypoint'
+import type { PageExtensions } from '../../../page-extensions-type'
+import { getFilenameAndExtension } from '../next-metadata-route-loader'
+
+export async function createAppRouteCode({
+  name,
+  page,
+  pagePath,
+  resolveAppRoute,
+  pageExtensions,
+  nextConfigOutput,
+}: {
+  name: string
+  page: string
+  pagePath: string
+  resolveAppRoute: (
+    pathname: string
+  ) => Promise<string | undefined> | string | undefined
+  pageExtensions: PageExtensions
+  nextConfigOutput: NextConfig['output']
+}): Promise<string> {
+  // routePath is the path to the route handler file,
+  // but could be aliased e.g. private-next-app-dir/favicon.ico
+  const routePath = pagePath.replace(/[\\/]/, '/')
+
+  // This, when used with the resolver will give us the pathname to the built
+  // route handler file.
+  let resolvedPagePath = await resolveAppRoute(routePath)
+  if (!resolvedPagePath) {
+    throw new Error(
+      `Invariant: could not resolve page path for ${name} at ${routePath}`
+    )
+  }
+
+  // If this is a metadata route, then we need to use the metadata loader for
+  // the route to ensure that the route is generated.
+  const fileBaseName = path.parse(resolvedPagePath).name
+  if (isMetadataRoute(name) && fileBaseName !== 'route') {
+    const { ext } = getFilenameAndExtension(resolvedPagePath)
+    const isDynamicRouteExtension = pageExtensions.includes(ext)
+
+    resolvedPagePath = `next-metadata-route-loader?${stringify({
+      filePath: resolvedPagePath,
+      isDynamicRouteExtension: isDynamicRouteExtension ? '1' : '0',
+    })}!?${WEBPACK_RESOURCE_QUERIES.metadataRoute}`
+  }
+
+  const pathname = new AppPathnameNormalizer().normalize(page)
+  const bundlePath = new AppBundlePathNormalizer().normalize(page)
+
+  return await loadEntrypoint(
+    'app-route',
+    {
+      VAR_USERLAND: resolvedPagePath,
+      VAR_DEFINITION_PAGE: page,
+      VAR_DEFINITION_PATHNAME: pathname,
+      VAR_DEFINITION_FILENAME: fileBaseName,
+      VAR_DEFINITION_BUNDLE_PATH: bundlePath,
+      VAR_RESOLVED_PAGE_PATH: resolvedPagePath,
+    },
+    {
+      nextConfigOutput: JSON.stringify(nextConfigOutput),
+    }
+  )
+}
diff --git a/.../build/webpack/loaders/next-app-loader.ts → .../webpack/loaders/next-app-loader/index.ts b/.../build/webpack/loaders/next-app-loader.ts → .../webpack/loaders/next-app-loader/index.ts
@@ -3,39 +3,36 @@ import {
   UNDERSCORE_NOT_FOUND_ROUTE,
   UNDERSCORE_NOT_FOUND_ROUTE_ENTRY,
   type ValueOf,
-} from '../../../shared/lib/constants'
-import type { ModuleTuple, CollectedMetadata } from './metadata/types'
+} from '../../../../shared/lib/constants'
+import type { ModuleTuple, CollectedMetadata } from '../metadata/types'
 
 import path from 'path'
-import { stringify } from 'querystring'
-import { bold } from '../../../lib/picocolors'
-import { getModuleBuildInfo } from './get-module-build-info'
-import { verifyRootLayout } from '../../../lib/verify-root-layout'
-import * as Log from '../../output/log'
-import { APP_DIR_ALIAS, WEBPACK_RESOURCE_QUERIES } from '../../../lib/constants'
+import { bold } from '../../../../lib/picocolors'
+import { getModuleBuildInfo } from '../get-module-build-info'
+import { verifyRootLayout } from '../../../../lib/verify-root-layout'
+import * as Log from '../../../output/log'
+import { APP_DIR_ALIAS } from '../../../../lib/constants'
 import {
   createMetadataExportsCode,
   createStaticMetadataFromRoute,
-} from './metadata/discover'
+} from '../metadata/discover'
 import { promises as fs } from 'fs'
-import { isAppRouteRoute } from '../../../lib/is-app-route-route'
-import { isMetadataRoute } from '../../../lib/metadata/is-metadata-route'
-import type { NextConfig } from '../../../server/config-shared'
-import { AppPathnameNormalizer } from '../../../server/normalizers/built/app/app-pathname-normalizer'
-import { AppBundlePathNormalizer } from '../../../server/normalizers/built/app/app-bundle-path-normalizer'
-import type { MiddlewareConfig } from '../../analysis/get-page-static-info'
-import { getFilenameAndExtension } from './next-metadata-route-loader'
-import { isAppBuiltinNotFoundPage } from '../../utils'
-import { loadEntrypoint } from '../../load-entrypoint'
+import { isAppRouteRoute } from '../../../../lib/is-app-route-route'
+import type { NextConfig } from '../../../../server/config-shared'
+import { AppPathnameNormalizer } from '../../../../server/normalizers/built/app/app-pathname-normalizer'
+import type { MiddlewareConfig } from '../../../analysis/get-page-static-info'
+import { isAppBuiltinNotFoundPage } from '../../../utils'
+import { loadEntrypoint } from '../../../load-entrypoint'
 import {
   isGroupSegment,
   DEFAULT_SEGMENT_KEY,
   PAGE_SEGMENT_KEY,
-} from '../../../shared/lib/segment'
-import { getFilesInDir } from '../../../lib/get-files-in-dir'
-import type { PageExtensions } from '../../page-extensions-type'
-import { PARALLEL_ROUTE_DEFAULT_PATH } from '../../../client/components/parallel-route-default'
+} from '../../../../shared/lib/segment'
+import { getFilesInDir } from '../../../../lib/get-files-in-dir'
+import type { PageExtensions } from '../../../page-extensions-type'
+import { PARALLEL_ROUTE_DEFAULT_PATH } from '../../../../client/components/parallel-route-default'
 import type { Compilation } from 'webpack'
+import { createAppRouteCode } from './create-app-route-code'
 
 export type AppLoaderOptions = {
   name: string
@@ -93,66 +90,6 @@ export type AppDirModules = {
   readonly defaultPage?: ModuleTuple
 }
 
-async function createAppRouteCode({
-  name,
-  page,
-  pagePath,
-  resolveAppRoute,
-  pageExtensions,
-  nextConfigOutput,
-}: {
-  name: string
-  page: string
-  pagePath: string
-  resolveAppRoute: PathResolver
-  pageExtensions: PageExtensions
-  nextConfigOutput: NextConfig['output']
-}): Promise<string> {
-  // routePath is the path to the route handler file,
-  // but could be aliased e.g. private-next-app-dir/favicon.ico
-  const routePath = pagePath.replace(/[\\/]/, '/')
-
-  // This, when used with the resolver will give us the pathname to the built
-  // route handler file.
-  let resolvedPagePath = await resolveAppRoute(routePath)
-  if (!resolvedPagePath) {
-    throw new Error(
-      `Invariant: could not resolve page path for ${name} at ${routePath}`
-    )
-  }
-
-  // If this is a metadata route, then we need to use the metadata loader for
-  // the route to ensure that the route is generated.
-  const fileBaseName = path.parse(resolvedPagePath).name
-  if (isMetadataRoute(name) && fileBaseName !== 'route') {
-    const { ext } = getFilenameAndExtension(resolvedPagePath)
-    const isDynamicRouteExtension = pageExtensions.includes(ext)
-
-    resolvedPagePath = `next-metadata-route-loader?${stringify({
-      filePath: resolvedPagePath,
-      isDynamicRouteExtension: isDynamicRouteExtension ? '1' : '0',
-    })}!?${WEBPACK_RESOURCE_QUERIES.metadataRoute}`
-  }
-
-  const pathname = new AppPathnameNormalizer().normalize(page)
-  const bundlePath = new AppBundlePathNormalizer().normalize(page)
-
-  return await loadEntrypoint(
-    'app-route',
-    {
-      VAR_USERLAND: resolvedPagePath,
-      VAR_DEFINITION_PAGE: page,
-      VAR_DEFINITION_PATHNAME: pathname,
-      VAR_DEFINITION_FILENAME: fileBaseName,
-      VAR_DEFINITION_BUNDLE_PATH: bundlePath,
-      VAR_RESOLVED_PAGE_PATH: resolvedPagePath,
-    },
-    {
-      nextConfigOutput: JSON.stringify(nextConfigOutput),
-    }
-  )
-}
-
 const normalizeParallelKey = (key: string) =>
   key.startsWith('@') ? key.slice(1) : key
 

diff --git a/packages/next/src/build/webpack/plugins/wellknown-errors-plugin/parseNextAppLoaderError.ts b/packages/next/src/build/webpack/plugins/wellknown-errors-plugin/parseNextAppLoaderError.ts
@@ -8,7 +8,7 @@ export function getNextAppLoaderError(
   compiler: webpack.Compiler
 ): SimpleWebpackError | false {
   try {
-    if (!module.loaders[0].loader.includes('next-app-loader.js')) {
+    if (!module.loaders[0].loader.includes('next-app-loader')) {
       return false
     }
 

diff --git a/packages/next/src/build/webpack/plugins/wellknown-errors-plugin/parseNotFoundError.ts b/packages/next/src/build/webpack/plugins/wellknown-errors-plugin/parseNotFoundError.ts
@@ -135,10 +135,9 @@ export async function getNotFoundError(
         .filter(
           (name) =>
             name &&
-            !/next-(app|middleware|client-pages|route|flight-(client|server|client-entry))-loader\.js/.test(
+            !/next-(app|middleware|client-pages|route|flight-(client|server|client-entry))-loader/.test(
               name
             ) &&
-            !/next-route-loader\/index\.js/.test(name) &&
             !/css-loader.+\.js/.test(name)
         )
       if (moduleTrace.length === 0) return ''