feat: moving incremental cache to functions

Author: taty2010

packages/runtime/src/helpers/config.ts

@@ -37,10 +37,11 @@ const defaultFailBuild = (message: string, { error }): never => {
 export const getNextConfig = async function getNextConfig({
   publish,
   failBuild = defaultFailBuild,
+  INTERNAL_FUNCTIONS_SRC,
 }): Promise<NextConfig> {
   try {
     const requiredServerFiles: RequiredServerFiles = await readJSON(join(publish, 'required-server-files.json'))
-    const { config, appDir, ignore } = requiredServerFiles;
+    const { config, appDir, ignore } = requiredServerFiles
 
     if (!config) {
       // eslint-disable-next-line @typescript-eslint/ban-ts-comment
@@ -56,15 +57,17 @@ export const getNextConfig = async function getNextConfig({
 
     // For more info, see https://nextjs.org/docs/app/api-reference/next-config-js/incrementalCacheHandlerPath
     // ./cache-handler.js will be copied to the root or the .next build folder
-    
-    await writeJSON(join(publish, 'required-server-files.json'), { ...requiredServerFiles, config: {
-      ...config,
-      experimental: {
-        ...config.experimental,
-        incrementalCacheHandlerPath: join(publish, 'incremental-cache.js')
-      }
-    }
-  })
+
+    await writeJSON(join(publish, 'required-server-files.json'), {
+      ...requiredServerFiles,
+      config: {
+        ...config,
+        experimental: {
+          ...config.experimental,
+          incrementalCacheHandlerPath: join(INTERNAL_FUNCTIONS_SRC, '__incremental-cache', 'incremental-cache.js'),
+        },
+      },
+    })
     const routesManifest: RoutesManifest = await readJSON(join(publish, ROUTES_MANIFEST_FILE))
 
     // If you need access to other manifest files, you can add them here as well

packages/runtime/src/helpers/functions.ts

@@ -22,6 +22,7 @@ import {
   LAMBDA_WARNING_SIZE,
 } from '../constants'
 import { getApiHandler } from '../templates/getApiHandler'
+import { generateCacheHandler } from '../templates/getCacheHandler'
 import { getHandler } from '../templates/getHandler'
 import { getResolverForPages, getResolverForSourceFiles } from '../templates/getPageResolver'
 
@@ -168,6 +169,7 @@ export const generateFunctions = async (
 
   await writeHandler(HANDLER_FUNCTION_NAME, HANDLER_FUNCTION_TITLE, false)
   await writeHandler(ODB_FUNCTION_NAME, ODB_FUNCTION_TITLE, true)
+  await generateCacheHandler(functionsDir)
 }
 
 /**

packages/runtime/src/index.ts

@@ -41,7 +41,6 @@ import {
   warnForProblematicUserRewrites,
   warnForRootRedirects,
 } from './helpers/verification'
-import { generateCacheHandler } from './templates/getCacheHandler'
 
 const plugin: NetlifyPlugin = {
   async onPreBuild({
@@ -102,6 +101,7 @@ const plugin: NetlifyPlugin = {
     } = await getNextConfig({
       publish,
       failBuild,
+      INTERNAL_FUNCTIONS_SRC: constants.INTERNAL_FUNCTIONS_SRC,
     })
     await cleanupEdgeFunctions(constants)
 
@@ -165,8 +165,6 @@ const plugin: NetlifyPlugin = {
       }
     }
 
-    await generateCacheHandler(publish)
-
     const buildId = readFileSync(join(publish, 'BUILD_ID'), 'utf8').trim()
 
     const apiLambdas: APILambda[] = splitApiRoutes(featureFlags, publish)
@@ -230,7 +228,7 @@ const plugin: NetlifyPlugin = {
       functions,
       build: { failBuild },
     },
-    constants: { FUNCTIONS_DIST },
+    constants: { FUNCTIONS_DIST, INTERNAL_FUNCTIONS_SRC },
   }) {
     await saveCache({ cache, publish })
 
@@ -248,7 +246,7 @@ const plugin: NetlifyPlugin = {
 
     await checkForOldFunctions({ functions })
     await checkZipSize(join(FUNCTIONS_DIST, `${ODB_FUNCTION_NAME}.zip`))
-    const nextConfig = await getNextConfig({ publish, failBuild })
+    const nextConfig = await getNextConfig({ publish, failBuild, INTERNAL_FUNCTIONS_SRC })
 
     const { basePath, appDir, experimental } = nextConfig
 

packages/runtime/src/templates/getCacheHandler.ts

@@ -1,19 +1,19 @@
-import { copyFile, writeFile } from 'fs-extra'
-import { outdent as javascript } from 'outdent'
 import { join } from 'path'
 
-export const generateCacheHandler = async (publish: string): Promise<void> => {
+import { copyFile, ensureDir, writeFile } from 'fs-extra'
+import { outdent as javascript } from 'outdent'
 
-    const blobCache = getCacheHandler()
+export const generateCacheHandler = async (functionsDir: string): Promise<void> => {
+  const blobCache = getCacheHandler()
+  await ensureDir(join(functionsDir, '__incremental-cache'))
 
-    await writeFile(join(publish, 'incremental-cache.js'), blobCache)
-    await copyFile(join(__dirname, '..', '..', 'lib', 'helpers', 'blobStorage.js'), join('.netlify', 'blobStorage.js'))
+  await writeFile(join(functionsDir, '__incremental-cache', 'incremental-cache.js'), blobCache)
+  await copyFile(join(__dirname, '..', '..', 'lib', 'helpers', 'blobStorage.js'), join('.netlify', 'blobStorage.js'))
 }
 
-
 const getCacheHandler = (): string =>
-    // This is a string, but if you have the right editor plugin it should format as js (e.g. bierner.comment-tagged-templates in VS Code)
-    javascript/* javascript */ `
+  // This is a string, but if you have the right editor plugin it should format as js (e.g. bierner.comment-tagged-templates in VS Code)
+  javascript/* javascript */ `
    
     const { getBlobStorage } = require('./blobStorage')
     const { auth } = require('./handlerUtils')

packages/runtime/src/templates/getHandler.ts

@@ -86,16 +86,17 @@ const makeHandler = ({ conf, app, pageRoot, NextServer, staticManifest = [], mod
     } = context
 
     globalThis.getBlobContext = {}
-    const rawData = Buffer.from(customContext.blobs, "base64");
-    const data = JSON.parse(rawData.toString("ascii")); 
-    
+    // eslint-disable-next-line n/prefer-global/buffer
+    const rawData = Buffer.from(customContext.blobs, 'base64')
+    const data = JSON.parse(rawData.toString('ascii'))
+
     globalThis.getBlobContext = {
       authentication: {
         contextURL: data.url,
         token: data.token,
       },
-      context: `deploy:${event.headers["x-nf-deploy-id"]}`,
-      siteID: event.headers["x-nf-site-id"],
+      context: `deploy:${event.headers['x-nf-deploy-id']}`,
+      siteID: event.headers['x-nf-site-id'],
     }
 
     if (bridge) {