feat: refresh hooks api implementation

demos/default/pages/api/revalidate.js

@@ -0,0 +1,10 @@
+export default async function handler(req, res) {
+  try {
+    const path = '/getStaticProps/with-revalidate/'
+    await res.revalidate(path)
+    console.log('Revalidated:', path)
+    return res.json({ revalidated: true })
+  } catch (err) {
+    return res.status(500).send('Error revalidating:', err)
+  }
+}

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,
   }
 }
 

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,9 +19,9 @@ const {
   getMaxAge,
   getMultiValueHeaders,
   getPrefetchResponse,
-  getNextServer,
   normalizePath,
 } = require('./handlerUtils')
+const { NetlifyNextServer } = require('./server')
 /* eslint-enable @typescript-eslint/no-var-requires */
 
 type Mutable<T> = {
@@ -68,21 +65,21 @@ 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 => {
     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({
+    const nextServer = new NetlifyNextServer({
       conf,
       dir,
       customServer: false,
       hostname: url.hostname,
       port,
+      netlifyRevalidateToken: context.clientContext?.custom?.odb_refresh_hooks,
     })
     const requestHandler = nextServer.getRequestHandler()
     const server = new Server(async (req, res) => {
@@ -119,7 +116,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 +177,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/server.ts

@@ -0,0 +1,73 @@
+import https from 'https'
+
+import { NodeRequestHandler, Options } from 'next/dist/server/next-server'
+
+import { getNextServer, NextServerType } from './handlerUtils'
+
+const NextServer: NextServerType = getNextServer()
+
+interface NetlifyNextServerOptions extends Options {
+  netlifyRevalidateToken: string
+}
+
+class NetlifyNextServer extends NextServer {
+  private netlifyRevalidateToken?: string
+
+  public constructor(options: NetlifyNextServerOptions) {
+    super(options)
+    this.netlifyRevalidateToken = options.netlifyRevalidateToken
+  }
+
+  public getRequestHandler(): NodeRequestHandler {
+    const handler = super.getRequestHandler()
+    return async (req, res, parsedUrl) => {
+      if (req.headers['x-prerender-revalidate']) {
+        if (this.netlifyRevalidateToken) {
+          await this.netlifyRevalidate(req.url)
+        } else {
+          throw new Error(`Missing revalidate token`)
+        }
+      }
+      return handler(req, res, parsedUrl)
+    }
+  }
+
+  private netlifyRevalidate(url: string) {
+    const domain = this.hostname
+    const siteId = process.env.SITE_ID
+
+    return new Promise((resolve, reject) => {
+      const body = JSON.stringify({ paths: [url], domain })
+
+      const req = https
+        .request(
+          {
+            hostname: 'api.netlify.com',
+            port: 443,
+            path: `/api/v1/sites/${siteId}/refresh_on_demand_builders`,
+            method: 'POST',
+            headers: {
+              'Content-Type': 'application/json',
+              'Content-Length': body.length,
+              Authorization: `Bearer ${this.netlifyRevalidateToken}`,
+            },
+          },
+          (res) => {
+            let data = ''
+            res.on('data', (chunk) => {
+              data += chunk
+            })
+            res.on('end', () => {
+              resolve(JSON.parse(data))
+            })
+          },
+        )
+        .on('error', reject)
+
+      req.write(body)
+      req.end()
+    })
+  }
+}
+
+export { NetlifyNextServer }