feat: refresh hooks api implementation

cypress/integration/default/dynamic-routes.spec.ts

@@ -17,7 +17,7 @@ describe('Static Routing', () => {
   it('renders correct page via ODB on a static route', () => {
     cy.request({ url: '/getStaticProps/with-revalidate/', headers: { 'x-nf-debug-logging': '1' } }).then((res) => {
       expect(res.status).to.eq(200)
-      expect(res.headers).to.have.property('x-nf-render-mode', 'odb ttl=60')
+      expect(res.headers).to.have.property('x-nf-render-mode', 'odb ttl=300')
       expect(res.body).to.contain('Dancing with the Stars')
     })
   })

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,25 @@
+export default async function handler(req, res) {
+  const query = req.query
+  const select = Number(query.select) || 0
+
+  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,9 +22,10 @@ export async function getStaticProps(context) {
   return {
     props: {
       show: data,
+      time: new Date().toISOString(),
     },
     // ODB handler will use the minimum TTL=60s
-    revalidate: 1,
+    revalidate: 300,
   }
 }
 

package.json

@@ -100,6 +100,7 @@
     "testMatch": [
       "**/test/**/*.spec.js",
       "**/test/**/*.spec.ts",
+      "**/*.test.ts",
       "!**/test/e2e/**",
       "!**/test/fixtures/**",
       "!**/test/sample/**",

packages/runtime/src/helpers/functions.ts

@@ -47,6 +47,10 @@ export const generateFunctions = async (
     await ensureDir(join(functionsDir, functionName))
     await writeFile(join(functionsDir, functionName, `${functionName}.js`), apiHandlerSource)
     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'),
@@ -67,6 +71,10 @@ export const generateFunctions = async (
     await ensureDir(join(functionsDir, functionName))
     await writeFile(join(functionsDir, functionName, `${functionName}.js`), handlerSource)
     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'),

packages/runtime/src/templates/getHandler.ts

@@ -5,10 +5,7 @@ import { outdent as javascript } from 'outdent'
 
 import type { NextConfig } from '../helpers/config'
 
-import type { NextServerType } from './handlerUtils'
-
 /* eslint-disable @typescript-eslint/no-var-requires */
-
 const { promises } = require('fs')
 const { Server } = require('http')
 const path = require('path')
@@ -22,17 +19,17 @@ const {
   getMaxAge,
   getMultiValueHeaders,
   getPrefetchResponse,
-  getNextServer,
   normalizePath,
 } = require('./handlerUtils')
+const { NetlifyNextServer } = require('./server')
 /* eslint-enable @typescript-eslint/no-var-requires */
 
 type Mutable<T> = {
   -readonly [K in keyof T]: T[K]
 }
 
 // We return a function and then call `toString()` on it to serialise it as the launcher function
-// eslint-disable-next-line max-params
+// eslint-disable-next-line max-params, max-lines-per-function
 const makeHandler = (conf: NextConfig, app, pageRoot, staticManifest: Array<[string, string]> = [], mode = 'ssr') => {
   // Change working directory into the site root, unless using Nx, which moves the
   // dist directory and handles this itself
@@ -68,22 +65,30 @@ const makeHandler = (conf: NextConfig, app, pageRoot, staticManifest: Array<[str
   // We memoize this because it can be shared between requests, but don't instantiate it until
   // the first request because we need the host and port.
   let bridge: NodeBridge
-  const getBridge = (event: HandlerEvent): NodeBridge => {
+  const getBridge = (event: HandlerEvent, context: HandlerContext): NodeBridge => {
+    const {
+      clientContext: { custom: customContext },
+    } = context
+
     if (bridge) {
       return bridge
     }
     const url = new URL(event.rawUrl)
     const port = Number.parseInt(url.port) || 80
     base = url.origin
 
-    const NextServer: NextServerType = getNextServer()
-    const nextServer = new NextServer({
-      conf,
-      dir,
-      customServer: false,
-      hostname: url.hostname,
-      port,
-    })
+    const nextServer = new NetlifyNextServer(
+      {
+        conf,
+        dir,
+        customServer: false,
+        hostname: url.hostname,
+        port,
+      },
+      {
+        revalidateToken: customContext.odb_refresh_hooks,
+      },
+    )
     const requestHandler = nextServer.getRequestHandler()
     const server = new Server(async (req, res) => {
       try {
@@ -119,7 +124,7 @@ const makeHandler = (conf: NextConfig, app, pageRoot, staticManifest: Array<[str
       process.env._NETLIFY_GRAPH_TOKEN = graphToken
     }
 
-    const { headers, ...result } = await getBridge(event).launcher(event, context)
+    const { headers, ...result } = await getBridge(event, context).launcher(event, context)
 
     // Convert all headers to multiValueHeaders
 
@@ -180,6 +185,7 @@ export const getHandler = ({ isODB = false, publishDir = '../../../.next', appDi
   // We copy the file here rather than requiring from the node module
   const { Bridge } = require("./bridge");
   const { augmentFsModule, getMaxAge, getMultiValueHeaders, getPrefetchResponse, getNextServer, normalizePath } = require('./handlerUtils')
+  const { NetlifyNextServer } = require('./server')
 
   ${isODB ? `const { builder } = require("@netlify/functions")` : ''}
   const { config }  = require("${publishDir}/required-server-files.json")

packages/runtime/src/templates/handlerUtils.test.ts

@@ -0,0 +1,82 @@
+import { normalizeRoute, unlocalizeRoute, localizeRoute, localizeDataRoute } from './handlerUtils'
+
+describe('normalizeRoute', () => {
+  it('removes a trailing slash from a route', () => {
+    expect(normalizeRoute('/foo/')).toEqual('/foo')
+  })
+  it('ignores a string without a trailing slash', () => {
+    expect(normalizeRoute('/foo')).toEqual('/foo')
+  })
+  it('does not remove a lone slash', () => {
+    expect(normalizeRoute('/')).toEqual('/')
+  })
+})
+
+describe('unlocalizeRoute', () => {
+  it('removes the locale prefix from an i18n route', () => {
+    expect(
+      unlocalizeRoute('/fr/foo', {
+        defaultLocale: 'en',
+        locales: ['en', 'fr', 'de'],
+      }),
+    ).toEqual('/foo')
+  })
+  it('removes the locale prefix from a root i18n route', () => {
+    expect(
+      unlocalizeRoute('/de', {
+        defaultLocale: 'en',
+        locales: ['en', 'fr', 'de'],
+      }),
+    ).toEqual('/')
+  })
+  it('does not modify a default locale route', () => {
+    expect(
+      unlocalizeRoute('/foo', {
+        defaultLocale: 'en',
+        locales: ['en', 'fr', 'de'],
+      }),
+    ).toEqual('/foo')
+  })
+})
+
+describe('localizeRoute', () => {
+  it('adds the locale prefix to an i18n route', () => {
+    expect(
+      localizeRoute('/foo', {
+        defaultLocale: 'en',
+        locales: ['en', 'fr', 'de'],
+      }),
+    ).toEqual('/en/foo')
+  })
+  it('adds the locale prefix to a root i18n route', () => {
+    expect(
+      localizeRoute('/', {
+        defaultLocale: 'en',
+        locales: ['en', 'fr', 'de'],
+      }),
+    ).toEqual('/en')
+  })
+  it('does not modify a prefixed i18n route', () => {
+    expect(
+      localizeRoute('/en/foo', {
+        defaultLocale: 'en',
+        locales: ['en', 'fr', 'de'],
+      }),
+    ).toEqual('/en/foo')
+  })
+})
+
+describe('localizeDataRoute', () => {
+  it('adds the locale prefix to a data route', () => {
+    expect(localizeDataRoute('/_next/data/build/foo.json', '/en/foo')).toEqual('/_next/data/build/en/foo.json')
+  })
+  it('removes the index suffix from a root route', () => {
+    expect(localizeDataRoute('/_next/data/build/index.json', '/en')).toEqual('/_next/data/build/en.json')
+  })
+  it('does not add the locale prefix if it already exists in the data route', () => {
+    expect(localizeDataRoute('/_next/data/build/en/foo.json', '/en/foo')).toEqual('/_next/data/build/en/foo.json')
+  })
+  it('does not modify an RSC data route', () => {
+    expect(localizeDataRoute('/foo.rsc', '/foo')).toEqual('/foo.rsc')
+  })
+})