refactor: separate build-time and run-time concerns for adapter

Author: pieh

src/adapter/adapter.ts

@@ -3,16 +3,17 @@ import { dirname } from 'node:path'
 
 import type { NextAdapter } from 'next-with-adapters'
 
-import { NETLIFY_FRAMEWORKS_API_CONFIG_PATH } from './constants.js'
-import { onBuildComplete as onBuildCompleteForHeaders } from './header.js'
+import { NETLIFY_FRAMEWORKS_API_CONFIG_PATH } from './build/constants.js'
+import { onBuildComplete as onBuildCompleteForHeaders } from './build/header.js'
 import {
   modifyConfig as modifyConfigForImageCDN,
   onBuildComplete as onBuildCompleteForImageCDN,
-} from './image-cdn.js'
-import { onBuildComplete as onBuildCompleteForMiddleware } from './middleware.js'
-import { onBuildComplete as onBuildCompleteForPagesAndAppHandlers } from './pages-and-app-handlers.js'
-import { onBuildComplete as onBuildCompleteForStaticAssets } from './static-assets.js'
-import { FrameworksAPIConfig } from './types.js'
+} from './build/image-cdn.js'
+import { onBuildComplete as onBuildCompleteForMiddleware } from './build/middleware.js'
+import { onBuildComplete as onBuildCompleteForPagesAndAppHandlers } from './build/pages-and-app-handlers.js'
+import { onBuildComplete as onBuildCompleteForStaticAssets } from './build/static-assets.js'
+import { NETLIFY_FRAMEWORKS_API_CONFIG_PATH } from './build/constants.js'
+import { FrameworksAPIConfig } from './build/types.js'
 
 const adapter: NextAdapter = {
   name: 'Netlify',

src/adapter/constants.ts renamed to src/adapter/build/constants.ts

@@ -3,7 +3,7 @@ import { join } from 'node:path'
 import { fileURLToPath } from 'node:url'
 
 const MODULE_DIR = fileURLToPath(new URL('.', import.meta.url))
-export const PLUGIN_DIR = join(MODULE_DIR, '../..')
+export const PLUGIN_DIR = join(MODULE_DIR, '../../..')
 
 const packageJSON = JSON.parse(readFileSync(join(PLUGIN_DIR, 'package.json'), 'utf-8'))
 

src/adapter/header.ts renamed to src/adapter/build/header.ts

@@ -1,15 +1,15 @@
 import type { FrameworksAPIConfig, OnBuildCompleteContext } from './types.js'
 
 export function onBuildComplete(
-  ctx: OnBuildCompleteContext,
+  nextAdapterContext: OnBuildCompleteContext,
   frameworksAPIConfigArg: FrameworksAPIConfig,
 ) {
   const frameworksAPIConfig: FrameworksAPIConfig = frameworksAPIConfigArg ?? {}
 
   frameworksAPIConfig.headers ??= []
 
   frameworksAPIConfig.headers.push({
-    for: `${ctx.config.basePath}/_next/static/*`,
+    for: `${nextAdapterContext.config.basePath}/_next/static/*`,
     values: {
       'Cache-Control': 'public, max-age=31536000, immutable',
     },

src/adapter/next-image-loader.cts renamed to src/adapter/build/image-cdn-next-image-loader.cts

@@ -5,7 +5,9 @@ import { makeRe } from 'picomatch'
 
 import type { FrameworksAPIConfig, NextConfigComplete, OnBuildCompleteContext } from './types.js'
 
-const NETLIFY_IMAGE_LOADER_FILE = fileURLToPath(import.meta.resolve(`./next-image-loader.cjs`))
+const NETLIFY_IMAGE_LOADER_FILE = fileURLToPath(
+  import.meta.resolve(`./image-cdn-next-image-loader.cjs`),
+)
 
 export function modifyConfig(config: NextConfigComplete) {
   if (config.images.loader === 'default') {
@@ -21,7 +23,7 @@ function generateRegexFromPattern(pattern: string): string {
 }
 
 export function onBuildComplete(
-  ctx: OnBuildCompleteContext,
+  nextAdapterContext: OnBuildCompleteContext,
   frameworksAPIConfigArg: FrameworksAPIConfig,
 ) {
   const frameworksAPIConfig: FrameworksAPIConfig = frameworksAPIConfigArg ?? {}
@@ -38,7 +40,7 @@ export function onBuildComplete(
     status: 200,
   })
 
-  const { images } = ctx.config
+  const { images } = nextAdapterContext.config
   if (images.loader === 'custom' && images.loaderFile === NETLIFY_IMAGE_LOADER_FILE) {
     const { remotePatterns, domains } = images
     // if Netlify image loader is used, configure allowed remote image sources

src/adapter/image-cdn.ts renamed to src/adapter/build/image-cdn.ts

@@ -20,12 +20,12 @@ const MIDDLEWARE_FUNCTION_DIR = join(
 )
 
 export async function onBuildComplete(
-  ctx: OnBuildCompleteContext,
+  nextAdapterContext: OnBuildCompleteContext,
   frameworksAPIConfigArg: FrameworksAPIConfig,
 ) {
   const frameworksAPIConfig: FrameworksAPIConfig = frameworksAPIConfigArg ?? {}
 
-  const { middleware } = ctx.outputs
+  const { middleware } = nextAdapterContext.outputs
   if (!middleware) {
     return frameworksAPIConfig
   }
@@ -34,10 +34,10 @@ export async function onBuildComplete(
     await copyHandlerDependenciesForEdgeMiddleware(middleware)
   } else if (middleware.runtime === 'nodejs') {
     // return frameworksAPIConfig
-    await copyHandlerDependenciesForNodeMiddleware(middleware, ctx.repoRoot)
+    await copyHandlerDependenciesForNodeMiddleware(middleware, nextAdapterContext.repoRoot)
   }
 
-  await writeHandlerFile(middleware, ctx.config)
+  await writeHandlerFile(middleware, nextAdapterContext.config)
 
   return frameworksAPIConfig
 }

src/adapter/middleware.ts renamed to src/adapter/build/middleware.ts

@@ -21,7 +21,7 @@ const PAGES_AND_APP_FUNCTION_DIR = join(
 )
 
 export async function onBuildComplete(
-  ctx: OnBuildCompleteContext,
+  nextAdapterContext: OnBuildCompleteContext,
   frameworksAPIConfigArg: FrameworksAPIConfig,
 ) {
   const frameworksAPIConfig: FrameworksAPIConfig = frameworksAPIConfigArg ?? {}
@@ -30,10 +30,10 @@ export async function onBuildComplete(
   const pathnameToEntry: Record<string, string> = {}
 
   for (const outputs of [
-    ctx.outputs.pages,
-    ctx.outputs.pagesApi,
-    ctx.outputs.appPages,
-    ctx.outputs.appRoutes,
+    nextAdapterContext.outputs.pages,
+    nextAdapterContext.outputs.pagesApi,
+    nextAdapterContext.outputs.appPages,
+    nextAdapterContext.outputs.appRoutes,
   ]) {
     if (outputs) {
       for (const output of outputs) {
@@ -46,17 +46,21 @@ export async function onBuildComplete(
         }
 
         requiredFiles.add(output.filePath)
-        pathnameToEntry[output.pathname] = relative(ctx.repoRoot, output.filePath)
+        pathnameToEntry[output.pathname] = relative(nextAdapterContext.repoRoot, output.filePath)
       }
     }
   }
 
   await mkdir(PAGES_AND_APP_FUNCTION_DIR, { recursive: true })
 
   for (const filePath of requiredFiles) {
-    await cp(filePath, join(PAGES_AND_APP_FUNCTION_DIR, relative(ctx.repoRoot, filePath)), {
-      recursive: true,
-    })
+    await cp(
+      filePath,
+      join(PAGES_AND_APP_FUNCTION_DIR, relative(nextAdapterContext.repoRoot, filePath)),
+      {
+        recursive: true,
+      },
+    )
   }
 
   // copy needed runtime files
@@ -67,7 +71,7 @@ export async function onBuildComplete(
   const entrypoint = /* javascript */ `
   import { AsyncLocalStorage } from 'node:async_hooks'
   import { createRequire } from 'node:module'
-  import { runNextHandler } from './${RUNTIME_DIR}/dist/adapter/adapter-handler.js'
+  import { runNextHandler } from './${RUNTIME_DIR}/dist/adapter/run/pages-and-app-handler.js'
 
   globalThis.AsyncLocalStorage = AsyncLocalStorage
 

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

@@ -6,18 +6,18 @@ import { NEXT_RUNTIME_STATIC_ASSETS } from './constants.js'
 import type { FrameworksAPIConfig, OnBuildCompleteContext } from './types.js'
 
 export async function onBuildComplete(
-  ctx: OnBuildCompleteContext,
+  nextAdapterContext: OnBuildCompleteContext,
   frameworksAPIConfigArg: FrameworksAPIConfig,
 ) {
   const frameworksAPIConfig: FrameworksAPIConfig = frameworksAPIConfigArg ?? {}
 
-  for (const staticFile of ctx.outputs.staticFiles) {
+  for (const staticFile of nextAdapterContext.outputs.staticFiles) {
     try {
       let distPathname = staticFile.pathname
       if (extname(distPathname) === '' && extname(staticFile.filePath) === '.html') {
         // if it's fully static page, we need to also create empty _next/data JSON file
         // on Vercel this is done in routing layer, but we can't express that routing right now on Netlify
-        const buildID = await readFile(join(ctx.distDir, 'BUILD_ID'), 'utf-8')
+        const buildID = await readFile(join(nextAdapterContext.distDir, 'BUILD_ID'), 'utf-8')
         const dataFilePath = join(
           NEXT_RUNTIME_STATIC_ASSETS,
           '_next',
@@ -31,9 +31,9 @@ export async function onBuildComplete(
 
         // FEEDBACK: should this be applied in Next.js before passing to context to adapters?
         if (distPathname !== '/') {
-          if (ctx.config.trailingSlash && !distPathname.endsWith('/')) {
+          if (nextAdapterContext.config.trailingSlash && !distPathname.endsWith('/')) {
             distPathname += '/'
-          } else if (!ctx.config.trailingSlash && distPathname.endsWith('/')) {
+          } else if (!nextAdapterContext.config.trailingSlash && distPathname.endsWith('/')) {
             distPathname = distPathname.slice(0, -1)
           }
         }