refactor: patch getBuildId using ast-grep (#401)

Author: vicb

packages/cloudflare/src/cli/build/bundle-server.ts

@@ -9,6 +9,7 @@ import { build } from "esbuild";
 import { patchVercelOgLibrary } from "./patches/ast/patch-vercel-og-library.js";
 import { patchWebpackRuntime } from "./patches/ast/webpack-runtime.js";
 import * as patches from "./patches/index.js";
+import { inlineBuildId } from "./patches/plugins/build-id.js";
 import { ContentUpdater } from "./patches/plugins/content-updater.js";
 import { inlineEvalManifest } from "./patches/plugins/eval-manifest.js";
 import { patchFetchCacheSetMissingWaitUntil } from "./patches/plugins/fetch-cache-wait-until.js";
@@ -95,6 +96,7 @@ export async function bundleServer(buildOpts: BuildOptions): Promise<void> {
       inlineEvalManifest(updater, buildOpts),
       inlineFindDir(updater, buildOpts),
       inlineLoadManifest(updater, buildOpts),
+      inlineBuildId(updater),
       // Apply updater updaters, must be the last plugin
       updater.plugin,
     ],
@@ -197,7 +199,6 @@ export async function updateWorkerBundledCode(
 
   const patchedCode = await patchCodeWithValidations(code, [
     ["require", patches.patchRequire],
-    ["`buildId` function", (code) => patches.patchBuildId(code, buildOpts)],
     ["cacheHandler", (code) => patches.patchCache(code, buildOpts)],
     [
       "'require(this.middlewareManifestPath)'",

packages/cloudflare/src/cli/build/patches/index.ts

@@ -1,2 +1,2 @@
 export * from "./investigated/index.js";
-export * from "./to-investigate/index.js";
+export * from "./to-investigate/inline-middleware-manifest.js";

packages/cloudflare/src/cli/build/patches/plugins/build-id.ts

@@ -0,0 +1,31 @@
+/**
+ * Inline `getBuildId` as it relies on `readFileSync` that is not supported by workerd.
+ */
+
+import { getCrossPlatformPathRegex } from "@opennextjs/aws/utils/regex.js";
+
+import { patchCode } from "../ast/util.js";
+import type { ContentUpdater } from "./content-updater.js";
+
+export function inlineBuildId(updater: ContentUpdater) {
+  return updater.updateContent(
+    "inline-build-id",
+    {
+      filter: getCrossPlatformPathRegex(String.raw`/next/dist/server/next-server\.js$`, { escape: false }),
+      contentFilter: /getBuildId\(/,
+    },
+    async ({ contents }) => patchCode(contents, rule)
+  );
+}
+
+export const rule = `
+rule:
+  kind: method_definition
+  has:
+    field: name
+    regex: ^getBuildId$
+fix: |-
+  getBuildId() {
+    return process.env.NEXT_BUILD_ID;
+  }
+`;

packages/cloudflare/src/cli/build/patches/plugins/find-dir.spec.ts

@@ -0,0 +1,85 @@
+import { describe, expect, test } from "vitest";
+
+import { patchCode } from "../ast/util.js";
+import { rule } from "./build-id.js";
+
+describe("getBuildId", () => {
+  test("patch", () => {
+    const code = `
+class NextNodeServer extends _baseserver.default {
+    constructor(options){
+        // Initialize super class
+        super(options);
+        this.handleNextImageRequest = async (req, res, parsedUrl) => { /* ... */ };
+    }
+    async handleUpgrade() {
+    // The web server does not support web sockets, it's only used for HMR in
+    // development.
+    }
+    loadEnvConfig({ dev, forceReload, silent }) {
+        (0, _env.loadEnvConfig)(this.dir, dev, silent ? {
+            info: ()=>{},
+            error: ()=>{}
+        } : _log, forceReload);
+    }
+    async hasPage(pathname) {
+        var _this_nextConfig_i18n;
+        return !!(0, _require.getMaybePagePath)(pathname, this.distDir, (_this_nextConfig_i18n = this.nextConfig.i18n) == null ? void 0 : _this_nextConfig_i18n.locales, this.enabledDirectories.app);
+    }
+    getBuildId() {
+        const buildIdFile = (0, _path.join)(this.distDir, _constants.BUILD_ID_FILE);
+        try {
+            return _fs.default.readFileSync(buildIdFile, "utf8").trim();
+        } catch (err) {
+            if (err.code === "ENOENT") {
+                throw new Error(\`Could not find a production build in the '\${this.distDir}' directory. Try building your app with 'next build' before starting the production server. https://nextjs.org/docs/messages/production-start-no-build-id\`);
+            }
+            throw err;
+        }
+    }
+    getEnabledDirectories(dev) {
+        const dir = dev ? this.dir : this.serverDistDir;
+        return {
+            app: (0, _findpagesdir.findDir)(dir, "app") ? true : false,
+            pages: (0, _findpagesdir.findDir)(dir, "pages") ? true : false
+        };
+    }
+    // ...
+}`;
+
+    expect(patchCode(code, rule)).toMatchInlineSnapshot(`
+      "class NextNodeServer extends _baseserver.default {
+          constructor(options){
+              // Initialize super class
+              super(options);
+              this.handleNextImageRequest = async (req, res, parsedUrl) => { /* ... */ };
+          }
+          async handleUpgrade() {
+          // The web server does not support web sockets, it's only used for HMR in
+          // development.
+          }
+          loadEnvConfig({ dev, forceReload, silent }) {
+              (0, _env.loadEnvConfig)(this.dir, dev, silent ? {
+                  info: ()=>{},
+                  error: ()=>{}
+              } : _log, forceReload);
+          }
+          async hasPage(pathname) {
+              var _this_nextConfig_i18n;
+              return !!(0, _require.getMaybePagePath)(pathname, this.distDir, (_this_nextConfig_i18n = this.nextConfig.i18n) == null ? void 0 : _this_nextConfig_i18n.locales, this.enabledDirectories.app);
+          }
+          getBuildId() {
+        return process.env.NEXT_BUILD_ID;
+      }
+          getEnabledDirectories(dev) {
+              const dir = dev ? this.dir : this.serverDistDir;
+              return {
+                  app: (0, _findpagesdir.findDir)(dir, "app") ? true : false,
+                  pages: (0, _findpagesdir.findDir)(dir, "pages") ? true : false
+              };
+          }
+          // ...
+      }"
+    `);
+  });
+});

packages/cloudflare/src/cli/build/patches/plugins/load-manifest.ts

@@ -1,5 +1,5 @@
 /**
- * Inline `loadManifest` as it relies on `readFileSync`that is not supported by workerd.
+ * Inline `loadManifest` as it relies on `readFileSync` that is not supported by workerd.
  */
 
 import { readFile } from "node:fs/promises";