normalize index at build time

Author: pieh

src/adapter/build/pages-and-app-handlers.ts

@@ -21,7 +21,20 @@ const PAGES_AND_APP_FUNCTION_DIR = join(
   PAGES_AND_APP_FUNCTION_INTERNAL_NAME,
 )
 
-// const abc: OneOfThePaths = 'asa(/abc/)dsa'
+// there is some inconsistency with pathnames sometimes being '/' and sometimes being '/index',
+// but handler seems to expect '/'
+function normalizeIndex(path: string): string {
+  if (path === '/index') {
+    return '/'
+  }
+
+  return path.replace(
+    // if Index is getServerSideProps weird things happen:
+    // /_next/data/<build-id>/.json is produced instead of /_next/data/<build-id>/index.json
+    /^\/_next\/data\/(?<buildId>[^/]+)\/\.json$/,
+    '/_next/data/$<buildId>/index.json',
+  )
+}
 
 export async function onBuildComplete(
   nextAdapterContext: OnBuildCompleteContext,
@@ -46,24 +59,30 @@ export async function onBuildComplete(
       }
 
       requiredFiles.add(output.filePath)
-      pathnameToEntry[output.pathname] = relative(nextAdapterContext.repoRoot, output.filePath)
+      pathnameToEntry[normalizeIndex(output.pathname)] = relative(
+        nextAdapterContext.repoRoot,
+        output.filePath,
+      )
     }
   }
 
   for (const prerender of nextAdapterContext.outputs.prerenders) {
-    if (prerender.pathname in pathnameToEntry) {
-      console.log('Skipping prerender, already have route:', prerender.pathname)
-    } else if (prerender.parentOutputId in pathnameToEntry) {
+    const normalizedPathname = normalizeIndex(prerender.pathname)
+    const normalizedParentOutputId = normalizeIndex(prerender.parentOutputId)
+
+    if (normalizedPathname in pathnameToEntry) {
+      console.log('Skipping prerender, already have route:', normalizedPathname)
+    } else if (normalizedParentOutputId in pathnameToEntry) {
       // if we don't have routing for this route yet, add it
       console.log('prerender mapping', {
-        from: prerender.pathname,
-        to: prerender.parentOutputId,
+        from: normalizedPathname,
+        to: normalizedParentOutputId,
       })
-      pathnameToEntry[prerender.pathname] = pathnameToEntry[prerender.parentOutputId]
+      pathnameToEntry[normalizedPathname] = pathnameToEntry[normalizedParentOutputId]
     } else {
       console.warn('Could not find parent output for prerender:', {
-        pathname: prerender,
-        parentOutputId: prerender.parentOutputId,
+        pathname: normalizedPathname,
+        parentOutputId: normalizedParentOutputId,
       })
     }
   }

src/adapter/run/routing.ts

@@ -80,17 +80,6 @@ function selectRoutingPhasesRules(routingRules: RoutingRule[], phases: RoutingPh
 
 let requestCounter = 0
 
-function normalizeIndex(request: Request, prefix: string) {
-  const currentURL = new URL(request.url)
-  const { pathname } = currentURL
-  if (pathname === '/') {
-    const destURL = new URL('/index', currentURL)
-    console.log(prefix, 'Normalizing "/" to "/index" for routing purposes')
-    return new Request(destURL, request)
-  }
-  return request
-}
-
 // eslint-disable-next-line max-params
 async function match(
   request: Request,
@@ -99,7 +88,7 @@ async function match(
   outputs: NetlifyAdapterContext['preparedOutputs'],
   prefix: string,
 ) {
-  let currentRequest = normalizeIndex(request, prefix)
+  let currentRequest = request
   let maybeResponse: Response | undefined
 
   const currentURL = new URL(currentRequest.url)
@@ -112,7 +101,8 @@ async function match(
         if (rule.match.type === 'static-asset-or-function') {
           let matchedType: 'static-asset' | 'function' | 'static-asset-alias' | null = null
 
-          // below assumes no overlap between static assets (files and aliases) and functions
+          // below assumes no overlap between static assets (files and aliases) and functions so order of checks "doesn't matter"
+          // unclear what should be precedence if there would ever be overlap
           if (outputs.staticAssets.includes(pathname)) {
             matchedType = 'static-asset'
           } else if (outputs.endpoints.includes(pathname)) {