introduce netlify adapter context for reusable helpers

pieh · pieh · commit fb49bea41d4c · 2025-09-29T13:18:04.000+02:00
diff --git a/src/adapter/adapter.ts b/src/adapter/adapter.ts
@@ -10,10 +10,9 @@ import {
   onBuildComplete as onBuildCompleteForImageCDN,
 } from './build/image-cdn.js'
 import { onBuildComplete as onBuildCompleteForMiddleware } from './build/middleware.js'
+import { createNetlifyAdapterContext } from './build/netlify-adapter-context.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',
@@ -34,30 +33,21 @@ const adapter: NextAdapter = {
 
     console.log('onBuildComplete hook called')
 
-    let frameworksAPIConfig: FrameworksAPIConfig = null
+    const netlifyAdapterContext = createNetlifyAdapterContext(nextAdapterContext)
 
-    frameworksAPIConfig = onBuildCompleteForImageCDN(nextAdapterContext, frameworksAPIConfig)
-    frameworksAPIConfig = await onBuildCompleteForMiddleware(
-      nextAdapterContext,
-      frameworksAPIConfig,
-    )
-    frameworksAPIConfig = await onBuildCompleteForStaticAssets(
-      nextAdapterContext,
-      frameworksAPIConfig,
-    )
+    await onBuildCompleteForImageCDN(nextAdapterContext, netlifyAdapterContext)
+    await onBuildCompleteForMiddleware(nextAdapterContext, netlifyAdapterContext)
+    await onBuildCompleteForStaticAssets(nextAdapterContext, netlifyAdapterContext)
     // TODO: verifyNetlifyForms
-    frameworksAPIConfig = onBuildCompleteForHeaders(nextAdapterContext, frameworksAPIConfig)
-    frameworksAPIConfig = await onBuildCompleteForPagesAndAppHandlers(
-      nextAdapterContext,
-      frameworksAPIConfig,
-    )
+    await onBuildCompleteForHeaders(nextAdapterContext, netlifyAdapterContext)
+    await onBuildCompleteForPagesAndAppHandlers(nextAdapterContext, netlifyAdapterContext)
 
-    if (frameworksAPIConfig) {
+    if (netlifyAdapterContext.frameworksAPIConfig) {
       // write out config if there is any
       await mkdir(dirname(NETLIFY_FRAMEWORKS_API_CONFIG_PATH), { recursive: true })
       await writeFile(
         NETLIFY_FRAMEWORKS_API_CONFIG_PATH,
-        JSON.stringify(frameworksAPIConfig, null, 2),
+        JSON.stringify(netlifyAdapterContext.frameworksAPIConfig, null, 2),
       )
     }
   },
diff --git a/src/adapter/build/header.ts b/src/adapter/build/header.ts
@@ -1,14 +1,13 @@
-import type { FrameworksAPIConfig, OnBuildCompleteContext } from './types.js'
+import type { NetlifyAdapterContext, OnBuildCompleteContext } from './types.js'
 
-export function onBuildComplete(
+export async function onBuildComplete(
   nextAdapterContext: OnBuildCompleteContext,
-  frameworksAPIConfigArg: FrameworksAPIConfig,
+  netlifyAdapterContext: NetlifyAdapterContext,
 ) {
-  const frameworksAPIConfig: FrameworksAPIConfig = frameworksAPIConfigArg ?? {}
+  netlifyAdapterContext.frameworksAPIConfig ??= {}
+  netlifyAdapterContext.frameworksAPIConfig.headers ??= []
 
-  frameworksAPIConfig.headers ??= []
-
-  frameworksAPIConfig.headers.push({
+  netlifyAdapterContext.frameworksAPIConfig.headers.push({
     for: `${nextAdapterContext.config.basePath}/_next/static/*`,
     values: {
       'Cache-Control': 'public, max-age=31536000, immutable',
@@ -23,6 +22,4 @@ export function onBuildComplete(
   // }
   // per https://docs.netlify.com/manage/routing/headers/#wildcards-and-placeholders-in-paths
   // this is example of something we can't currently do
-
-  return frameworksAPIConfig
 }
diff --git a/src/adapter/build/image-cdn.ts b/src/adapter/build/image-cdn.ts
@@ -3,7 +3,7 @@ import { fileURLToPath } from 'node:url'
 import type { RemotePattern } from 'next-with-adapters/dist/shared/lib/image-config.js'
 import { makeRe } from 'picomatch'
 
-import type { FrameworksAPIConfig, NextConfigComplete, OnBuildCompleteContext } from './types.js'
+import type { NetlifyAdapterContext, NextConfigComplete, OnBuildCompleteContext } from './types.js'
 
 const NETLIFY_IMAGE_LOADER_FILE = fileURLToPath(
   import.meta.resolve(`./image-cdn-next-image-loader.cjs`),
@@ -22,15 +22,15 @@ function generateRegexFromPattern(pattern: string): string {
   return makeRe(pattern).source
 }
 
-export function onBuildComplete(
+export async function onBuildComplete(
   nextAdapterContext: OnBuildCompleteContext,
-  frameworksAPIConfigArg: FrameworksAPIConfig,
+  netlifyAdapterContext: NetlifyAdapterContext,
 ) {
-  const frameworksAPIConfig: FrameworksAPIConfig = frameworksAPIConfigArg ?? {}
+  netlifyAdapterContext.frameworksAPIConfig ??= {}
 
   // when migrating from @netlify/plugin-nextjs@4 image redirect to ipx might be cached in the browser
-  frameworksAPIConfig.redirects ??= []
-  frameworksAPIConfig.redirects.push({
+  netlifyAdapterContext.frameworksAPIConfig.redirects ??= []
+  netlifyAdapterContext.frameworksAPIConfig.redirects.push({
     from: '/_ipx/*',
     // w and q are too short to be used as params with id-length rule
     // but we are forced to do so because of the next/image loader decides on their names
@@ -100,9 +100,8 @@ export function onBuildComplete(
 
     if (remoteImageSources.length !== 0) {
       // https://docs.netlify.com/build/frameworks/frameworks-api/#images
-      frameworksAPIConfig.images ??= { remote_images: [] }
-      frameworksAPIConfig.images.remote_images = remoteImageSources
+      netlifyAdapterContext.frameworksAPIConfig.images ??= { remote_images: [] }
+      netlifyAdapterContext.frameworksAPIConfig.images.remote_images = remoteImageSources
     }
   }
-  return frameworksAPIConfig
 }
diff --git a/src/adapter/build/middleware.ts b/src/adapter/build/middleware.ts
@@ -10,7 +10,7 @@ import {
   NETLIFY_FRAMEWORKS_API_EDGE_FUNCTIONS,
   PLUGIN_DIR,
 } from './constants.js'
-import type { FrameworksAPIConfig, NextConfigComplete, OnBuildCompleteContext } from './types.js'
+import type { NetlifyAdapterContext, NextConfigComplete, OnBuildCompleteContext } from './types.js'
 
 const MIDDLEWARE_FUNCTION_INTERNAL_NAME = 'next_middleware'
 
@@ -21,25 +21,21 @@ const MIDDLEWARE_FUNCTION_DIR = join(
 
 export async function onBuildComplete(
   nextAdapterContext: OnBuildCompleteContext,
-  frameworksAPIConfigArg: FrameworksAPIConfig,
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  _netlifyAdapterContext: NetlifyAdapterContext,
 ) {
-  const frameworksAPIConfig: FrameworksAPIConfig = frameworksAPIConfigArg ?? {}
-
   const { middleware } = nextAdapterContext.outputs
   if (!middleware) {
-    return frameworksAPIConfig
+    return
   }
 
   if (middleware.runtime === 'edge') {
     await copyHandlerDependenciesForEdgeMiddleware(middleware)
   } else if (middleware.runtime === 'nodejs') {
-    // return frameworksAPIConfig
     await copyHandlerDependenciesForNodeMiddleware(middleware, nextAdapterContext.repoRoot)
   }
 
   await writeHandlerFile(middleware, nextAdapterContext.config)
-
-  return frameworksAPIConfig
 }
 
 const copyHandlerDependenciesForEdgeMiddleware = async (
diff --git a/src/adapter/build/netlify-adapter-context.ts b/src/adapter/build/netlify-adapter-context.ts
@@ -0,0 +1,19 @@
+import { readFile } from 'fs/promises'
+import { join } from 'path/posix'
+
+import type { FrameworksAPIConfig, OnBuildCompleteContext } from './types.js'
+
+export function createNetlifyAdapterContext(nextAdapterContext: OnBuildCompleteContext) {
+  let buildId: string | undefined
+  let frameworksAPIConfig: FrameworksAPIConfig | undefined
+
+  return {
+    async getBuildId() {
+      if (!buildId) {
+        buildId = await readFile(join(nextAdapterContext.distDir, 'BUILD_ID'), 'utf-8')
+      }
+      return buildId
+    },
+    frameworksAPIConfig,
+  }
+}
diff --git a/src/adapter/build/pages-and-app-handlers.ts b/src/adapter/build/pages-and-app-handlers.ts
@@ -9,7 +9,7 @@ import {
   NETLIFY_FRAMEWORKS_API_FUNCTIONS,
   PLUGIN_DIR,
 } from './constants.js'
-import type { FrameworksAPIConfig, OnBuildCompleteContext } from './types.js'
+import type { NetlifyAdapterContext, OnBuildCompleteContext } from './types.js'
 
 const PAGES_AND_APP_FUNCTION_INTERNAL_NAME = 'next_pages_and_app'
 
@@ -22,10 +22,9 @@ const PAGES_AND_APP_FUNCTION_DIR = join(
 
 export async function onBuildComplete(
   nextAdapterContext: OnBuildCompleteContext,
-  frameworksAPIConfigArg: FrameworksAPIConfig,
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  _netlifyAdapterContext: NetlifyAdapterContext,
 ) {
-  const frameworksAPIConfig: FrameworksAPIConfig = frameworksAPIConfigArg ?? {}
-
   const requiredFiles = new Set<string>()
   const pathnameToEntry: Record<string, string> = {}
 
@@ -129,8 +128,6 @@ export async function onBuildComplete(
       2,
     ),
   )
-
-  return frameworksAPIConfig
 }
 
 const copyRuntime = async (handlerDirectory: string): Promise<void> => {
diff --git a/src/adapter/build/static-assets.ts b/src/adapter/build/static-assets.ts
@@ -1,28 +1,25 @@
 import { existsSync } from 'node:fs'
-import { cp, mkdir, readFile, writeFile } from 'node:fs/promises'
+import { cp, mkdir, writeFile } from 'node:fs/promises'
 import { dirname, extname, join } from 'node:path/posix'
 
 import { NEXT_RUNTIME_STATIC_ASSETS } from './constants.js'
-import type { FrameworksAPIConfig, OnBuildCompleteContext } from './types.js'
+import type { NetlifyAdapterContext, OnBuildCompleteContext } from './types.js'
 
 export async function onBuildComplete(
   nextAdapterContext: OnBuildCompleteContext,
-  frameworksAPIConfigArg: FrameworksAPIConfig,
+  netlifyAdapterContext: NetlifyAdapterContext,
 ) {
-  const frameworksAPIConfig: FrameworksAPIConfig = frameworksAPIConfigArg ?? {}
-
   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(nextAdapterContext.distDir, 'BUILD_ID'), 'utf-8')
         const dataFilePath = join(
           NEXT_RUNTIME_STATIC_ASSETS,
           '_next',
           'data',
-          buildID,
+          await netlifyAdapterContext.getBuildId(),
           // eslint-disable-next-line unicorn/no-nested-ternary
           `${distPathname === '/' ? 'index' : distPathname.endsWith('/') ? distPathname.slice(0, -1) : distPathname}.json`,
         )
@@ -59,6 +56,4 @@ export async function onBuildComplete(
       recursive: true,
     })
   }
-
-  return frameworksAPIConfig
 }
diff --git a/src/adapter/build/types.ts b/src/adapter/build/types.ts
@@ -1,9 +1,13 @@
 import type { NetlifyConfig } from '@netlify/build'
 import type { NextAdapter } from 'next-with-adapters'
 
+import type { createNetlifyAdapterContext } from './netlify-adapter-context.js'
+
 export type OnBuildCompleteContext = Parameters<Required<NextAdapter>['onBuildComplete']>[0]
 export type NextConfigComplete = OnBuildCompleteContext['config']
 
 export type FrameworksAPIConfig = Partial<
   Pick<NetlifyConfig, 'edge_functions' | 'functions' | 'headers' | 'redirects' | 'images'>
 > | null
+
+export type NetlifyAdapterContext = ReturnType<typeof createNetlifyAdapterContext>
