chore: refactor revalidate handling for easier testing

Author: orinokai

packages/runtime/src/templates/getHandler.ts

@@ -21,7 +21,7 @@ const {
   getPrefetchResponse,
   normalizePath,
 } = require('./handlerUtils')
-const { NetlifyNextServer } = require('./server')
+const NetlifyNextServer = require('./server')
 /* eslint-enable @typescript-eslint/no-var-requires */
 
 type Mutable<T> = {
@@ -177,7 +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')
+  const NetlifyNextServer = require('./server')
 
   ${isODB ? `const { builder } = require("@netlify/functions")` : ''}
   const { config }  = require("${publishDir}/required-server-files.json")

packages/runtime/src/templates/handlerUtils.ts

@@ -1,4 +1,5 @@
 import fs, { createWriteStream, existsSync } from 'fs'
+import { ServerResponse } from 'http'
 import { tmpdir } from 'os'
 import path from 'path'
 import { pipeline } from 'stream'
@@ -222,3 +223,46 @@ export const normalizePath = (event: HandlerEvent) => {
   // Ensure that paths are encoded - but don't double-encode them
   return new URL(event.rawUrl).pathname
 }
+
+export const netlifyApiFetch = <T>({
+  endpoint,
+  payload,
+  token,
+  method = 'GET',
+}: {
+  endpoint: string
+  payload: unknown
+  token: string
+  method: 'GET' | 'POST'
+}): Promise<T> =>
+  new Promise((resolve, reject) => {
+    const body = JSON.stringify(payload)
+
+    const req = https.request(
+      {
+        hostname: 'api.netlify.com',
+        port: 443,
+        path: `/api/v1/${endpoint}`,
+        method,
+        headers: {
+          'Content-Type': 'application/json',
+          'Content-Length': body.length,
+          Authorization: `Bearer ${token}`,
+        },
+      },
+      (res: ServerResponse) => {
+        let data = ''
+        res.on('data', (chunk) => {
+          data += chunk
+        })
+        res.on('end', () => {
+          resolve(JSON.parse(data))
+        })
+      },
+    )
+
+    req.on('error', reject)
+
+    req.write(body)
+    req.end()
+  })

packages/runtime/src/templates/server.ts

@@ -1,16 +1,14 @@
-import https from 'https'
-
 import { NodeRequestHandler, Options } from 'next/dist/server/next-server'
 
-import { getNextServer, NextServerType } from './handlerUtils'
+import { netlifyApiFetch, getNextServer, NextServerType } from './handlerUtils'
 
 const NextServer: NextServerType = getNextServer()
 
 interface NetlifyNextServerOptions extends Options {
-  netlifyRevalidateToken: string
+  netlifyRevalidateToken?: string
 }
 
-class NetlifyNextServer extends NextServer {
+export default class NetlifyNextServer extends NextServer {
   private netlifyRevalidateToken?: string
 
   public constructor(options: NetlifyNextServerOptions) {
@@ -22,52 +20,25 @@ class NetlifyNextServer extends NextServer {
     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`)
-        }
+        await this.netlifyRevalidate(req.url)
       }
       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()
-    })
+  private async netlifyRevalidate(url: string) {
+    try {
+      const result = await netlifyApiFetch<{ code: number; message: string }>({
+        endpoint: `sites/${process.env.SITE_ID}/refresh_on_demand_builders`,
+        payload: { paths: [url], domain: this.hostname },
+        token: this.netlifyRevalidateToken,
+        method: 'POST',
+      })
+      if (result.code !== 200) {
+        throw result
+      }
+    } catch (error) {
+      throw new Error(`Unsuccessful revalidate - ${error.message}`)
+    }
   }
 }
-
-export { NetlifyNextServer }