feat: provide display name for split api routes

Author: Skn0tt

packages/runtime/src/constants.ts

@@ -2,11 +2,13 @@ import destr from 'destr'
 
 export const HANDLER_FUNCTION_NAME = '___netlify-handler'
 export const ODB_FUNCTION_NAME = '___netlify-odb-handler'
+export const API_FUNCTION_NAME = '___netlify-api-handler'
 export const IMAGE_FUNCTION_NAME = '_ipx'
 export const NEXT_PLUGIN_NAME = '@netlify/next-runtime'
 export const NEXT_PLUGIN = '@netlify/plugin-nextjs'
 export const HANDLER_FUNCTION_TITLE = 'Next.js SSR handler'
 export const ODB_FUNCTION_TITLE = 'Next.js ISR handler'
+export const API_FUNCTION_TITLE = 'Next.js API handler'
 export const IMAGE_FUNCTION_TITLE = 'next/image handler'
 // These are paths in .next that shouldn't be publicly accessible
 export const HIDDEN_PATHS = destr(process.env.NEXT_KEEP_METADATA_FILES)

packages/runtime/src/helpers/functions.ts

@@ -16,6 +16,8 @@ import {
   HANDLER_FUNCTION_TITLE,
   ODB_FUNCTION_TITLE,
   IMAGE_FUNCTION_TITLE,
+  API_FUNCTION_TITLE,
+  API_FUNCTION_NAME,
 } from '../constants'
 import { getApiHandler } from '../templates/getApiHandler'
 import { getHandler } from '../templates/getHandler'
@@ -31,6 +33,7 @@ import { getFunctionNameForPage } from './utils'
 
 export interface ApiRouteConfig {
   functionName: string
+  functionTitle?: string
   route: string
   config: ApiConfig
   compiled: string
@@ -39,6 +42,7 @@ export interface ApiRouteConfig {
 
 export interface APILambda {
   functionName: string
+  functionTitle: string
   routes: ApiRouteConfig[]
   includedFiles: string[]
   type?: ApiRouteType
@@ -60,7 +64,7 @@ export const generateFunctions = async (
     : undefined
 
   for (const apiLambda of apiLambdas) {
-    const { functionName, routes, type, includedFiles } = apiLambda
+    const { functionName, functionTitle, routes, type, includedFiles } = apiLambda
 
     const apiHandlerSource = getApiHandler({
       // most api lambdas serve multiple routes, but scheduled functions need to be in separate lambdas.
@@ -102,6 +106,8 @@ export const generateFunctions = async (
     })
     await writeFile(join(functionsDir, functionName, 'pages.js'), resolverSource)
 
+    await writeFunctionConfiguration({ functionName, functionTitle, functionsDir })
+
     const nfInternalFiles = await glob(join(functionsDir, functionName, '**'))
     includedFiles.push(...nfInternalFiles)
   }
@@ -128,7 +134,7 @@ export const generateFunctions = async (
       join(__dirname, '..', '..', 'lib', 'templates', 'handlerUtils.js'),
       join(functionsDir, functionName, 'handlerUtils.js'),
     )
-    writeFunctionConfiguration({ functionName, functionTitle, functionsDir })
+    await writeFunctionConfiguration({ functionName, functionTitle, functionsDir })
   }
 
   await writeHandler(HANDLER_FUNCTION_NAME, HANDLER_FUNCTION_TITLE, false)
@@ -334,12 +340,41 @@ export const getAPILambdas = async (
 
     const bins = pack(weighedRoutes, threshold)
 
-    return bins.map((bin, index) => ({
-      functionName: bin.length === 1 ? bin[0].functionName : `api-${index}`,
-      routes: bin,
-      includedFiles: [...commonDependencies, ...routes.flatMap((route) => route.includedFiles)],
-      type,
-    }))
+    return bins.map((bin) => {
+      if (bin.length === 1) {
+        const [func] = bin
+        const { functionName, functionTitle, config, includedFiles } = func
+        return {
+          functionName,
+          functionTitle,
+          routes: [func],
+          includedFiles: [...commonDependencies, ...includedFiles],
+          type: config.type,
+        }
+      }
+
+      const includedFiles = [...commonDependencies, ...bin.flatMap((route) => route.includedFiles)]
+      const nonSingletonBins = bins.filter((b) => b.length > 1)
+      if (nonSingletonBins.length === 1) {
+        return {
+          functionName: API_FUNCTION_NAME,
+          functionTitle: API_FUNCTION_TITLE,
+          includedFiles,
+          routes: bin,
+          type,
+        }
+      }
+
+      const indexInNonSingletonBins = nonSingletonBins.indexOf(bin)
+
+      return {
+        functionName: `${API_FUNCTION_NAME}-${indexInNonSingletonBins + 1}`,
+        functionTitle: `${API_FUNCTION_TITLE} ${indexInNonSingletonBins + 1}/${nonSingletonBins.length}`,
+        includedFiles,
+        routes: bin,
+        type,
+      }
+    })
   }
 
   const standardFunctions = apiRoutes.filter(
@@ -381,6 +416,7 @@ export const getApiRouteConfigs = async (
       const config = await extractConfigFromFile(filePath, appDir)
 
       const functionName = getFunctionNameForPage(apiRoute, config.type === ApiRouteType.BACKGROUND)
+      const functionTitle = `${API_FUNCTION_TITLE} ${apiRoute}`
 
       const compiled = pages[apiRoute]
       const compiledPath = join(publish, 'server', compiled)
@@ -390,6 +426,7 @@ export const getApiRouteConfigs = async (
 
       return {
         functionName,
+        functionTitle,
         route: apiRoute,
         config,
         compiled,
@@ -415,6 +452,7 @@ export const getExtendedApiRouteConfigs = async (
 
 export const packSingleFunction = (func: ApiRouteConfig): APILambda => ({
   functionName: func.functionName,
+  functionTitle: func.functionTitle,
   includedFiles: func.includedFiles,
   routes: [func],
   type: func.config.type,

test/__snapshots__/index.spec.ts.snap

@@ -2109,17 +2109,17 @@ Array [
   Object {
     "from": "/api/enterPreview",
     "status": 200,
-    "to": "/.netlify/functions/api-0",
+    "to": "/.netlify/functions/___netlify-api-handler",
   },
   Object {
     "from": "/api/exitPreview",
     "status": 200,
-    "to": "/.netlify/functions/api-0",
+    "to": "/.netlify/functions/___netlify-api-handler",
   },
   Object {
     "from": "/api/hello",
     "status": 200,
-    "to": "/.netlify/functions/api-0",
+    "to": "/.netlify/functions/___netlify-api-handler",
   },
   Object {
     "from": "/api/hello-background",
@@ -2134,17 +2134,17 @@ Array [
   Object {
     "from": "/api/revalidate",
     "status": 200,
-    "to": "/.netlify/functions/api-0",
+    "to": "/.netlify/functions/___netlify-api-handler",
   },
   Object {
     "from": "/api/shows/:id",
     "status": 200,
-    "to": "/.netlify/functions/api-0",
+    "to": "/.netlify/functions/___netlify-api-handler",
   },
   Object {
     "from": "/api/shows/:params/*",
     "status": 200,
-    "to": "/.netlify/functions/api-0",
+    "to": "/.netlify/functions/___netlify-api-handler",
   },
   Object {
     "force": false,

test/helpers/functions.spec.ts

@@ -70,7 +70,7 @@ describeCwdTmpDir('api route file analysis', () => {
 
   it('only shows scheduled/background functions as extended funcs', async () => {
     await moveNextDist()
-    const configs = await getExtendedApiRouteConfigs('.next', process.cwd())
+    const configs = await getExtendedApiRouteConfigs('.next', process.cwd(), [])
     // Using a Set means the order doesn't matter
     expect(new Set(configs.map(({ includedFiles, ...rest }) => rest))).toEqual(
       new Set([

test/index.spec.ts

@@ -738,6 +738,23 @@ describe('onBuild()', () => {
     expect(netlifyConfig.functions['_api_*'].node_bundler).toEqual('nft')
   })
 
+  it('provides displayname for split api routes', async () => {
+    await moveNextDist()
+    await nextRuntime.onBuild(defaultArgs)
+
+    const functionsManifest = await readJson(
+      path.join('.netlify', 'functions-internal', '___netlify-api-handler', '___netlify-api-handler.json'),
+    )
+
+    expect(functionsManifest).toEqual({
+      config: {
+        generator: '@netlify/next-runtime@unknown',
+        name: 'Next.js API handler',
+      },
+      version: 1,
+    })
+  })
+
   // eslint-disable-next-line jest/expect-expect
   it('works when `relativeAppDir` is undefined', async () => {
     await moveNextDist()