Merge branch 'main' into mk/matcher-magic

Author: ascorbic

.release-please-manifest.json

@@ -1,4 +1,4 @@
 {
-  "packages/runtime": "4.26.0",
+  "packages/runtime": "4.27.1",
   "packages/next": "1.3.1"
 }

cypress/integration/default/api.spec.ts

@@ -0,0 +1,10 @@
+describe('Extended API routes', () => {
+  it('returns HTTP 202 Accepted for background route', () => {
+    cy.request('/api/hello-background').then((response) => {
+      expect(response.status).to.equal(202)
+    })
+  })
+  it('correctly returns 404 for scheduled route', () => {
+    cy.request({ url: '/api/hello-scheduled', failOnStatusCode: false }).its('status').should('equal', 404)
+  })
+})

cypress/integration/default/preview.spec.ts

@@ -1,8 +1,10 @@
 describe('Preview Mode', () => {
   it('enters and exits preview mode', () => {
+    Cypress.Cookies.debug(true)
+    cy.getCookies().then((cookie) => cy.log('cookies', cookie))
     // preview mode is off by default
     cy.visit('/previewTest')
-    cy.findByText('Is preview? No', {selector: 'h1'})
+    cy.findByText('Is preview? No', { selector: 'h1' })
 
     // enter preview mode
     cy.request('/api/enterPreview').then((response) => {

demos/default/pages/api/hello-background.ts

@@ -0,0 +1,9 @@
+export default (req, res) => {
+  res.setHeader('Content-Type', 'application/json')
+  res.status(200)
+  res.json({ message: 'hello world :)' })
+}
+
+export const config = {
+  type: 'experimental-background',
+}

demos/default/pages/api/hello-scheduled.js

@@ -0,0 +1,10 @@
+export default (req, res) => {
+  res.setHeader('Content-Type', 'application/json')
+  res.status(200)
+  res.json({ message: 'hello world :)' })
+}
+
+export const config = {
+  type: 'experimental-scheduled',
+  schedule: '@hourly',
+}

packages/runtime/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [4.27.1](https://github.com/netlify/next-runtime/compare/plugin-nextjs-v4.27.0...plugin-nextjs-v4.27.1) (2022-10-18)
+
+
+### Bug Fixes
+
+* gracefully handle missing static analysis tools ([#1691](https://github.com/netlify/next-runtime/issues/1691)) ([34a039e](https://github.com/netlify/next-runtime/commit/34a039ec80a7c7f050fb5f2dab6f4b8ffddda38a))
+
+## [4.27.0](https://github.com/netlify/next-runtime/compare/plugin-nextjs-v4.26.0...plugin-nextjs-v4.27.0) (2022-10-17)
+
+
+### Features
+
+* split api routes into separate functions ([#1495](https://github.com/netlify/next-runtime/issues/1495)) ([654c6de](https://github.com/netlify/next-runtime/commit/654c6defa99d33de5178409d43827b57a29821d8))
+
 ## [4.26.0](https://github.com/netlify/next-runtime/compare/plugin-nextjs-v4.25.0...plugin-nextjs-v4.26.0) (2022-10-17)
 
 

packages/runtime/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@netlify/plugin-nextjs",
-  "version": "4.26.0",
+  "version": "4.27.1",
   "description": "Run Next.js seamlessly on Netlify",
   "main": "index.js",
   "files": [

packages/runtime/src/helpers/analysis.ts

@@ -0,0 +1,135 @@
+import fs, { existsSync } from 'fs'
+
+import { relative } from 'pathe'
+
+// I have no idea what eslint is up to here but it gives an error
+// eslint-disable-next-line no-shadow
+export const enum ApiRouteType {
+  SCHEDULED = 'experimental-scheduled',
+  BACKGROUND = 'experimental-background',
+}
+
+export interface ApiStandardConfig {
+  type?: never
+  runtime?: 'nodejs' | 'experimental-edge'
+  schedule?: never
+}
+
+export interface ApiScheduledConfig {
+  type: ApiRouteType.SCHEDULED
+  runtime?: 'nodejs'
+  schedule: string
+}
+
+export interface ApiBackgroundConfig {
+  type: ApiRouteType.BACKGROUND
+  runtime?: 'nodejs'
+  schedule?: never
+}
+
+export type ApiConfig = ApiStandardConfig | ApiScheduledConfig | ApiBackgroundConfig
+
+export const validateConfigValue = (config: ApiConfig, apiFilePath: string): config is ApiConfig => {
+  if (config.type === ApiRouteType.SCHEDULED) {
+    if (!config.schedule) {
+      console.error(
+        `Invalid config value in ${relative(process.cwd(), apiFilePath)}: schedule is required when type is "${
+          ApiRouteType.SCHEDULED
+        }"`,
+      )
+      return false
+    }
+    if ((config as ApiConfig).runtime === 'experimental-edge') {
+      console.error(
+        `Invalid config value in ${relative(
+          process.cwd(),
+          apiFilePath,
+        )}: edge runtime is not supported for scheduled functions`,
+      )
+      return false
+    }
+    return true
+  }
+
+  if (!config.type || config.type === ApiRouteType.BACKGROUND) {
+    if (config.schedule) {
+      console.error(
+        `Invalid config value in ${relative(process.cwd(), apiFilePath)}: schedule is not allowed unless type is "${
+          ApiRouteType.SCHEDULED
+        }"`,
+      )
+      return false
+    }
+    if (config.type && (config as ApiConfig).runtime === 'experimental-edge') {
+      console.error(
+        `Invalid config value in ${relative(
+          process.cwd(),
+          apiFilePath,
+        )}: edge runtime is not supported for background functions`,
+      )
+      return false
+    }
+    return true
+  }
+  console.error(
+    `Invalid config value in ${relative(process.cwd(), apiFilePath)}: type ${
+      (config as ApiConfig).type
+    } is not supported`,
+  )
+  return false
+}
+
+let extractConstValue
+let parseModule
+let hasWarnedAboutNextVersion = false
+/**
+ * Uses Next's swc static analysis to extract the config values from a file.
+ */
+export const extractConfigFromFile = async (apiFilePath: string): Promise<ApiConfig> => {
+  if (!apiFilePath || !existsSync(apiFilePath)) {
+    return {}
+  }
+
+  try {
+    if (!extractConstValue) {
+      extractConstValue = require('next/dist/build/analysis/extract-const-value')
+    }
+    if (!parseModule) {
+      // eslint-disable-next-line prefer-destructuring, @typescript-eslint/no-var-requires
+      parseModule = require('next/dist/build/analysis/parse-module').parseModule
+    }
+  } catch (error) {
+    if (error.code === 'MODULE_NOT_FOUND') {
+      if (!hasWarnedAboutNextVersion) {
+        console.log("This version of Next.js doesn't support advanced API routes. Skipping...")
+        hasWarnedAboutNextVersion = true
+      }
+      // Old Next.js version
+      return {}
+    }
+    throw error
+  }
+
+  const { extractExportedConstValue, UnsupportedValueError } = extractConstValue
+
+  const fileContent = await fs.promises.readFile(apiFilePath, 'utf8')
+  // No need to parse if there's no "config"
+  if (!fileContent.includes('config')) {
+    return {}
+  }
+  const ast = await parseModule(apiFilePath, fileContent)
+
+  let config: ApiConfig
+  try {
+    config = extractExportedConstValue(ast, 'config')
+  } catch (error) {
+    if (UnsupportedValueError && error instanceof UnsupportedValueError) {
+      console.warn(`Unsupported config value in ${relative(process.cwd(), apiFilePath)}`)
+    }
+    return {}
+  }
+  if (validateConfigValue(config, apiFilePath)) {
+    return config
+  }
+  throw new Error(`Unsupported config value in ${relative(process.cwd(), apiFilePath)}`)
+}

packages/runtime/src/helpers/config.ts

@@ -92,7 +92,7 @@ export const configureHandlerFunctions = async ({ netlifyConfig, publish, ignore
   }
 
   /* eslint-enable no-underscore-dangle */
-  ;[HANDLER_FUNCTION_NAME, ODB_FUNCTION_NAME].forEach((functionName) => {
+  ;[HANDLER_FUNCTION_NAME, ODB_FUNCTION_NAME, '_api_*'].forEach((functionName) => {
     netlifyConfig.functions[functionName] ||= { included_files: [], external_node_modules: [] }
     netlifyConfig.functions[functionName].node_bundler = 'nft'
     netlifyConfig.functions[functionName].included_files ||= []

packages/runtime/src/helpers/files.ts

@@ -8,7 +8,7 @@ import globby from 'globby'
 import { PrerenderManifest } from 'next/dist/build'
 import { outdent } from 'outdent'
 import pLimit from 'p-limit'
-import { join } from 'pathe'
+import { join, resolve } from 'pathe'
 import slash from 'slash'
 
 import { MINIMUM_REVALIDATE_SECONDS, DIVIDER } from '../constants'
@@ -18,6 +18,7 @@ import { Rewrites, RoutesManifest } from './types'
 import { findModuleFromBase } from './utils'
 
 const TEST_ROUTE = /(|\/)\[[^/]+?](\/|\.html|$)/
+const SOURCE_FILE_EXTENSIONS = ['js', 'jsx', 'ts', 'tsx']
 
 export const isDynamicRoute = (route) => TEST_ROUTE.test(route)
 
@@ -333,6 +334,31 @@ const getServerFile = (root: string, includeBase = true) => {
   return findModuleFromBase({ candidates, paths: [root] })
 }
 
+/**
+ * Find the source file for a given page route
+ */
+export const getSourceFileForPage = (page: string, root: string) => {
+  for (const extension of SOURCE_FILE_EXTENSIONS) {
+    const file = join(root, `${page}.${extension}`)
+    if (existsSync(file)) {
+      return file
+    }
+  }
+  console.log('Could not find source file for page', page)
+}
+
+/**
+ * Reads the node file trace file for a given file, and resolves the dependencies
+ */
+export const getDependenciesOfFile = async (file: string) => {
+  const nft = `${file}.nft.json`
+  if (!existsSync(nft)) {
+    return []
+  }
+  const dependencies = await readJson(nft, 'utf8')
+  return dependencies.files.map((dep) => resolve(file, dep))
+}
+
 const baseServerReplacements: Array<[string, string]> = [
   // force manual revalidate during cache fetches
   [