chore: renamed getApiRoutes to make it clearer what it is getting

Author: nickytonline

packages/runtime/src/helpers/functions.ts

@@ -165,9 +165,9 @@ export const setupImageFunction = async ({
 }
 
 /**
- * Look for API routes, and extract the config from the source file.
+ * Look for advanced API routes (background and scheduled functions), and extract the config from the source file.
  */
-export const getApiRouteConfigs = async (publish: string, baseDir: string): Promise<Array<ApiRouteConfig>> => {
+export const getAdvancedApiRouteConfigs = async (publish: string, baseDir: string): Promise<Array<ApiRouteConfig>> => {
   const pages = await readJSON(join(publish, 'server', 'pages-manifest.json'))
   const apiRoutes = Object.keys(pages).filter((page) => page.startsWith('/api/'))
   const pagesDir = join(baseDir, 'pages')
@@ -179,6 +179,7 @@ export const getApiRouteConfigs = async (publish: string, baseDir: string): Prom
     }),
   )
 
+  // We only want to return the API routes that are background or scheduled functions
   return settledApiRoutes.filter((apiRoute) => apiRoute.config.type !== undefined)
 }
 

packages/runtime/src/index.ts

@@ -23,7 +23,7 @@ import {
   generateFunctions,
   setupImageFunction,
   generatePagesResolver,
-  getApiRouteConfigs,
+  getAdvancedApiRouteConfigs,
   warnOnApiRoutes,
 } from './helpers/functions'
 import { generateRedirects, generateStaticRedirects } from './helpers/redirects'
@@ -152,7 +152,7 @@ const plugin: NetlifyPlugin = {
     const buildId = readFileSync(join(publish, 'BUILD_ID'), 'utf8').trim()
 
     await configureHandlerFunctions({ netlifyConfig, ignore, publish: relative(process.cwd(), publish) })
-    const apiRoutes = await getApiRouteConfigs(publish, appDir)
+    const apiRoutes = await getAdvancedApiRouteConfigs(publish, appDir)
 
     await generateFunctions(constants, appDir, apiRoutes)
     await generatePagesResolver({ target, constants })

test/index.js

@@ -13,7 +13,7 @@ const os = require('os')
 const cpy = require('cpy')
 const { dir: getTmpDir } = require('tmp-promise')
 const { downloadFile } = require('../packages/runtime/src/templates/handlerUtils')
-const { getApiRouteConfigs } = require('../packages/runtime/src/helpers/functions')
+const { getAdvancedApiRouteConfigs } = require('../packages/runtime/src/helpers/functions')
 const nextRuntimeFactory = require('../packages/runtime/src')
 const nextRuntime = nextRuntimeFactory({})
 
@@ -1623,7 +1623,7 @@ describe('function helpers', () => {
 describe('api route file analysis', () => {
   it('extracts correct route configs from source files', async () => {
     await moveNextDist()
-    const configs = await getApiRouteConfigs('.next', process.cwd())
+    const configs = await getAdvancedApiRouteConfigs('.next', process.cwd())
     // Using a Set means the order doesn't matter
     expect(new Set(configs)).toEqual(
       new Set([