Merge branch 'main' into fix-ampersand

Author: LekoArts

cypress/integration/default/revalidate.spec.ts

@@ -0,0 +1,69 @@
+describe('On-demand revalidation', () => {
+  it('revalidates static ISR route with default locale', () => {
+    cy.request({ url: '/api/revalidate/?select=0' }).then((res) => {
+      expect(res.status).to.eq(200)
+      expect(res.body).to.have.property('message', 'success')
+    })
+  })
+  it('revalidates static ISR route with non-default locale', () => {
+    cy.request({ url: '/api/revalidate/?select=1' }).then((res) => {
+      expect(res.status).to.eq(200)
+      expect(res.body).to.have.property('message', 'success')
+    })
+  })
+  it('revalidates root static ISR route with default locale', () => {
+    cy.request({ url: '/api/revalidate/?select=2' }).then((res) => {
+      expect(res.status).to.eq(200)
+      expect(res.body).to.have.property('message', 'success')
+    })
+  })
+  it('revalidates root static ISR route with non-default locale', () => {
+    cy.request({ url: '/api/revalidate/?select=3' }).then((res) => {
+      expect(res.status).to.eq(200)
+      expect(res.body).to.have.property('message', 'success')
+    })
+  })
+  it('revalidates dynamic prerendered ISR route with default locale', () => {
+    cy.request({ url: '/api/revalidate/?select=4' }).then((res) => {
+      expect(res.status).to.eq(200)
+      expect(res.body).to.have.property('message', 'success')
+    })
+  })
+  it('fails to revalidate dynamic non-prerendered ISR route with fallback false', () => {
+    cy.request({ url: '/api/revalidate/?select=5', failOnStatusCode: false }).then((res) => {
+      expect(res.status).to.eq(500)
+      expect(res.body).to.have.property('message')
+      expect(res.body.message).to.include('Invalid response 404')
+    })
+  })
+  it('revalidates dynamic non-prerendered ISR route with fallback blocking', () => {
+    cy.request({ url: '/api/revalidate/?select=6' }).then((res) => {
+      expect(res.status).to.eq(200)
+      expect(res.body).to.have.property('message', 'success')
+    })
+  })
+  it('revalidates dynamic non-prerendered ISR route with fallback blocking and non-default locale', () => {
+    cy.request({ url: '/api/revalidate/?select=7' }).then((res) => {
+      expect(res.status).to.eq(200)
+      expect(res.body).to.have.property('message', 'success')
+    })
+  })
+  it('revalidates dynamic prerendered appDir route', () => {
+    cy.request({ url: '/api/revalidate/?select=8' }).then((res) => {
+      expect(res.status).to.eq(200)
+      expect(res.body).to.have.property('message', 'success')
+    })
+  })
+  it('fails to revalidate dynamic non-prerendered appDir route', () => {
+    cy.request({ url: '/api/revalidate/?select=9' }).then((res) => {
+      expect(res.status).to.eq(200)
+      expect(res.body).to.have.property('message', 'success')
+    })
+  })
+  it('revalidates dynamic prerendered appDir route with catch-all params', () => {
+    cy.request({ url: '/api/revalidate/?select=10' }).then((res) => {
+      expect(res.status).to.eq(200)
+      expect(res.body).to.have.property('message', 'success')
+    })
+  })
+})

demos/default/pages/api/revalidate.js

@@ -0,0 +1,26 @@
+export default async function handler(req, res) {
+  const query = req.query
+  const select = Number(query.select) || 0
+
+  // these paths are used for e2e testing res.revalidate()
+  const paths = [
+    '/getStaticProps/with-revalidate/', // valid path
+    '/fr/getStaticProps/with-revalidate/', // valid path (with locale)
+    '/', // valid path (index)
+    '/fr/', // valid path (index with locale)
+    '/getStaticProps/withRevalidate/2/', // valid path (with dynamic route)
+    '/getStaticProps/withRevalidate/3/', // invalid path (fallback false with dynamic route)
+    '/getStaticProps/withRevalidate/withFallbackBlocking/3/', // valid path (fallback blocking with dynamic route)
+    '/fr/getStaticProps/withRevalidate/withFallbackBlocking/3/', // valid path (fallback blocking with dynamic route and locale)
+    '/blog/nick/', // valid path (with prerendered appDir dynamic route)
+    '/blog/greg/', // invalid path (with non-prerendered appDir dynamic route)
+    '/blog/rob/hello/', // valid path (with appDir dynamic route catch-all)
+  ]
+
+  try {
+    await res.revalidate(paths[select])
+    return res.json({ code: 200, message: 'success' })
+  } catch (err) {
+    return res.status(500).send({ code: 500, message: err.message })
+  }
+}

demos/default/pages/getStaticProps/with-revalidate.js

@@ -1,8 +1,8 @@
 import Link from 'next/link'
 
-const Show = ({ show }) => (
+const Show = ({ show, time }) => (
   <div>
-    <p>This page uses getStaticProps() to pre-fetch a TV show.</p>
+    <p>This page uses getStaticProps() to pre-fetch a TV show at {time}</p>
 
     <hr />
 
@@ -22,6 +22,7 @@ export async function getStaticProps(context) {
   return {
     props: {
       show: data,
+      time: new Date().toISOString(),
     },
     // ODB handler will use the minimum TTL=60s
     revalidate: 1,

package-lock.json

@@ -75,6 +75,7 @@
     "jest-extended": "^3.2.0",
     "jest-fetch-mock": "^3.0.3",
     "jest-junit": "^14.0.1",
+    "mock-fs": "^5.2.0",
     "netlify-plugin-cypress": "^2.2.1",
     "npm-run-all": "^4.1.5",
     "playwright-chromium": "^1.26.1",

package.json

@@ -1,7 +1,11 @@
 export const HANDLER_FUNCTION_NAME = '___netlify-handler'
 export const ODB_FUNCTION_NAME = '___netlify-odb-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 IMAGE_FUNCTION_TITLE = 'next/image handler'
 // These are paths in .next that shouldn't be publicly accessible
 export const HIDDEN_PATHS = [
   '/cache/*',

packages/runtime/src/constants.ts

@@ -71,7 +71,7 @@ export const updateRequiredServerFiles = async (publish: string, modifiedConfig:
   await writeJSON(configFile, modifiedConfig)
 }
 
-const resolveModuleRoot = (moduleName) => {
+export const resolveModuleRoot = (moduleName) => {
   try {
     return dirname(relative(process.cwd(), require.resolve(`${moduleName}/package.json`, { paths: [process.cwd()] })))
   } catch {

packages/runtime/src/helpers/config.ts

@@ -7,13 +7,22 @@ import type { ImageConfigComplete, RemotePattern } from 'next/dist/shared/lib/im
 import { outdent } from 'outdent'
 import { join, relative, resolve } from 'pathe'
 
-import { HANDLER_FUNCTION_NAME, ODB_FUNCTION_NAME, IMAGE_FUNCTION_NAME, DEFAULT_FUNCTIONS_SRC } from '../constants'
+import {
+  HANDLER_FUNCTION_NAME,
+  ODB_FUNCTION_NAME,
+  IMAGE_FUNCTION_NAME,
+  DEFAULT_FUNCTIONS_SRC,
+  HANDLER_FUNCTION_TITLE,
+  ODB_FUNCTION_TITLE,
+  IMAGE_FUNCTION_TITLE,
+} from '../constants'
 import { getApiHandler } from '../templates/getApiHandler'
 import { getHandler } from '../templates/getHandler'
 import { getResolverForPages, getResolverForSourceFiles } from '../templates/getPageResolver'
 
 import { ApiConfig, ApiRouteType, extractConfigFromFile } from './analysis'
 import { getSourceFileForPage } from './files'
+import { writeFunctionConfiguration } from './functionsMetaData'
 import { getFunctionNameForPage } from './utils'
 
 export interface ApiRouteConfig {
@@ -45,8 +54,16 @@ export const generateFunctions = async (
     })
     const functionName = getFunctionNameForPage(route, config.type === ApiRouteType.BACKGROUND)
     await ensureDir(join(functionsDir, functionName))
+
+    // write main API handler file
     await writeFile(join(functionsDir, functionName, `${functionName}.js`), apiHandlerSource)
+
+    // copy handler dependencies (VercelNodeBridge, NetlifyNextServer, etc.)
     await copyFile(bridgeFile, join(functionsDir, functionName, 'bridge.js'))
+    await copyFile(
+      join(__dirname, '..', '..', 'lib', 'templates', 'server.js'),
+      join(functionsDir, functionName, 'server.js'),
+    )
     await copyFile(
       join(__dirname, '..', '..', 'lib', 'templates', 'handlerUtils.js'),
       join(functionsDir, functionName, 'handlerUtils.js'),
@@ -62,19 +79,28 @@ export const generateFunctions = async (
     await writeFile(join(functionsDir, functionName, 'pages.js'), resolverSource)
   }
 
-  const writeHandler = async (functionName: string, isODB: boolean) => {
+  const writeHandler = async (functionName: string, functionTitle: string, isODB: boolean) => {
     const handlerSource = await getHandler({ isODB, publishDir, appDir: relative(functionDir, appDir) })
     await ensureDir(join(functionsDir, functionName))
+
+    // write main handler file (standard or ODB)
     await writeFile(join(functionsDir, functionName, `${functionName}.js`), handlerSource)
+
+    // copy handler dependencies (VercelNodeBridge, NetlifyNextServer, etc.)
     await copyFile(bridgeFile, join(functionsDir, functionName, 'bridge.js'))
+    await copyFile(
+      join(__dirname, '..', '..', 'lib', 'templates', 'server.js'),
+      join(functionsDir, functionName, 'server.js'),
+    )
     await copyFile(
       join(__dirname, '..', '..', 'lib', 'templates', 'handlerUtils.js'),
       join(functionsDir, functionName, 'handlerUtils.js'),
     )
+    writeFunctionConfiguration({ functionName, functionTitle, functionsDir })
   }
 
-  await writeHandler(HANDLER_FUNCTION_NAME, false)
-  await writeHandler(ODB_FUNCTION_NAME, true)
+  await writeHandler(HANDLER_FUNCTION_NAME, HANDLER_FUNCTION_TITLE, false)
+  await writeHandler(ODB_FUNCTION_NAME, ODB_FUNCTION_TITLE, true)
 }
 
 /**
@@ -138,6 +164,11 @@ export const setupImageFunction = async ({
     })
 
     await copyFile(join(__dirname, '..', '..', 'lib', 'templates', 'ipx.js'), join(functionDirectory, functionName))
+    writeFunctionConfiguration({
+      functionName: IMAGE_FUNCTION_NAME,
+      functionTitle: IMAGE_FUNCTION_TITLE,
+      functionsDir: functionsPath,
+    })
 
     // If we have edge functions then the request will have already been rewritten
     // so this won't match. This is matched if edge is disabled or unavailable.

packages/runtime/src/helpers/functions.ts

@@ -0,0 +1,56 @@
+import { existsSync, readJSON, writeFile } from 'fs-extra'
+import { join } from 'pathe'
+
+import { NEXT_PLUGIN, NEXT_PLUGIN_NAME } from '../constants'
+
+import { resolveModuleRoot } from './config'
+
+const getNextRuntimeVersion = async (packageJsonPath: string, useNodeModulesPath: boolean) => {
+  if (!existsSync(packageJsonPath)) {
+    return
+  }
+
+  const packagePlugin = await readJSON(packageJsonPath)
+
+  return useNodeModulesPath ? packagePlugin.version : packagePlugin.dependencies[NEXT_PLUGIN]
+}
+
+// The information needed to create a function configuration file
+export interface FunctionInfo {
+  // The name of the function, e.g. `___netlify-handler`
+  functionName: string
+
+  // The name of the function that will be displayed in logs, e.g. `Next.js SSR handler`
+  functionTitle: string
+
+  // The directory where the function is located, e.g. `.netlify/functions`
+  functionsDir: string
+}
+
+/**
+ * Creates a function configuration file for the given function.
+ *
+ * @param functionInfo The information needed to create a function configuration file
+ */
+export const writeFunctionConfiguration = async (functionInfo: FunctionInfo) => {
+  const { functionName, functionTitle, functionsDir } = functionInfo
+  const pluginPackagePath = '.netlify/plugins/package.json'
+  const moduleRoot = resolveModuleRoot(NEXT_PLUGIN)
+  const nodeModulesPath = moduleRoot ? join(moduleRoot, 'package.json') : null
+
+  const nextPluginVersion =
+    (await getNextRuntimeVersion(nodeModulesPath, true)) ||
+    (await getNextRuntimeVersion(pluginPackagePath, false)) ||
+    // The runtime version should always be available, but if it's not, return 'unknown'
+    'unknown'
+
+  const metadata = {
+    config: {
+      name: functionTitle,
+      generator: `${NEXT_PLUGIN_NAME}@${nextPluginVersion}`,
+    },
+    version: 1,
+  }
+
+  await writeFile(join(functionsDir, functionName, `${functionName}.json`), JSON.stringify(metadata))
+}