functions.spec.ts

import { getApiRouteConfigs, getExtendedApiRouteConfigs } from '../../packages/runtime/src/helpers/functions'
import { describeCwdTmpDir, moveNextDist } from '../test-utils'

describeCwdTmpDir('api route file analysis', () => {
  it('extracts correct route configs from source files', async () => {
    await moveNextDist()
    const configs = await getApiRouteConfigs('.next', process.cwd())
    // Using a Set means the order doesn't matter
    expect(new Set(configs.map(({ includedFiles, ...rest }) => rest))).toEqual(
      new Set([
        {
          functionName: '_api_og-handler',
          functionTitle: 'Next.js API handler /api/og',
          compiled: 'pages/api/og.js',
          config: {
            runtime: 'edge',
          },
          route: '/api/og',
        },
        {
          functionName: '_api_enterPreview-handler',
          functionTitle: 'Next.js API handler /api/enterPreview',
          compiled: 'pages/api/enterPreview.js',
          config: {},
          route: '/api/enterPreview',
        },
        {
          functionName: '_api_exitPreview-handler',
          functionTitle: 'Next.js API handler /api/exitPreview',
          compiled: 'pages/api/exitPreview.js',
          config: {},
          route: '/api/exitPreview',
        },
        {
          functionName: '_api_hello-handler',
          functionTitle: 'Next.js API handler /api/hello',
          compiled: 'pages/api/hello.js',
          config: {},
          route: '/api/hello',
        },
        {
          functionName: '_api_shows_params-SPLAT-handler',
          functionTitle: 'Next.js API handler /api/shows/[...params]',
          compiled: 'pages/api/shows/[...params].js',
          config: {},
          route: '/api/shows/[...params]',
        },
        {
          functionName: '_api_shows_id-PARAM-handler',
          functionTitle: 'Next.js API handler /api/shows/[id]',
          compiled: 'pages/api/shows/[id].js',
          config: {},
          route: '/api/shows/[id]',
        },
        {
          functionName: '_api_hello-background-background',
          functionTitle: 'Next.js API handler /api/hello-background',
          compiled: 'pages/api/hello-background.js',
          config: { type: 'experimental-background' },
          route: '/api/hello-background',
        },
        {
          functionName: '_api_hello-scheduled-handler',
          functionTitle: 'Next.js API handler /api/hello-scheduled',
          compiled: 'pages/api/hello-scheduled.js',
          config: { schedule: '@hourly', type: 'experimental-scheduled' },
          route: '/api/hello-scheduled',
        },
        {
          functionName: '_api_revalidate-handler',
          functionTitle: 'Next.js API handler /api/revalidate',
          compiled: 'pages/api/revalidate.js',
          config: {},
          route: '/api/revalidate',
        },
      ]),
    )
  })

  it('only shows scheduled/background functions as extended funcs', async () => {
    await moveNextDist()
    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([
        {
          functionName: '_api_hello-background-background',
          functionTitle: 'Next.js API handler /api/hello-background',
          compiled: 'pages/api/hello-background.js',
          config: { type: 'experimental-background' },
          route: '/api/hello-background',
        },
        {
          functionName: '_api_hello-scheduled-handler',
          functionTitle: 'Next.js API handler /api/hello-scheduled',
          compiled: 'pages/api/hello-scheduled.js',
          config: { schedule: '@hourly', type: 'experimental-scheduled' },
          route: '/api/hello-scheduled',
        },
      ]),
    )
  })
})