feat: read buildId from GIT_REVISION env if present

Author: fry69

packages/plugin-vite/demo/routes/tests/build_id.tsx

@@ -0,0 +1,10 @@
+import { BUILD_ID } from "@fresh/build-id";
+
+export default function BuildIdPage() {
+  return (
+    <div>
+      <div class="ready">Ready</div>
+      <div id="build-id">{BUILD_ID}</div>
+    </div>
+  );
+}

packages/plugin-vite/src/plugins/build_id.ts

@@ -39,6 +39,12 @@ export function setBuildId(id) {
 }
 
 export async function getBuildId(dev: boolean): Promise<string> {
+  // Check for GIT_REVISION environment variable first
+  const gitRevision = Deno.env.get("GIT_REVISION");
+  if (gitRevision !== undefined) {
+    return gitRevision;
+  }
+
   if (!dev) {
     const bin = Deno.build.os === "windows" ? "git.exe" : "git";
     const res = await new Deno.Command(bin, { args: ["rev-parse", "HEAD"] })

packages/plugin-vite/tests/build_test.ts

@@ -296,3 +296,99 @@ Deno.test({
   sanitizeOps: false,
   sanitizeResources: false,
 });
+
+Deno.test({
+  name: "vite build - build ID uses GIT_REVISION when set",
+  fn: async () => {
+    const testRevision = "test-commit-hash-123";
+    await using res = await buildVite(DEMO_DIR, { GIT_REVISION: testRevision });
+
+    await withChildProcessServer(
+      {
+        cwd: res.tmp,
+        args: ["serve", "-A", "--port", "0", "_fresh/server.js"],
+      },
+      async (address) => {
+        await withBrowser(async (page) => {
+          await page.goto(`${address}/tests/build_id`, {
+            waitUntil: "networkidle2",
+          });
+
+          await page.locator(".ready").wait();
+          const buildId = await page.locator("#build-id").evaluate((el) =>
+            // deno-lint-ignore no-explicit-any
+            (el as any).textContent?.trim()
+          );
+          expect(buildId).toEqual(testRevision);
+        });
+      },
+    );
+  },
+  sanitizeOps: false,
+  sanitizeResources: false,
+});
+
+Deno.test({
+  name:
+    "vite build - build ID generates unique value when GIT_REVISION not set",
+  fn: async () => {
+    await using res = await buildVite(DEMO_DIR);
+
+    await withChildProcessServer(
+      {
+        cwd: res.tmp,
+        args: ["serve", "-A", "--port", "0", "_fresh/server.js"],
+      },
+      async (address) => {
+        await withBrowser(async (page) => {
+          await page.goto(`${address}/tests/build_id`, {
+            waitUntil: "networkidle2",
+          });
+
+          await page.locator(".ready").wait();
+          const buildId = await page.locator("#build-id").evaluate((el) =>
+            // deno-lint-ignore no-explicit-any
+            (el as any).textContent?.trim()
+          );
+
+          // Should be a non-empty string
+          expect(buildId).toBeTruthy();
+          expect(typeof buildId).toEqual("string");
+          expect(buildId!.length).toBeGreaterThan(0);
+        });
+      },
+    );
+  },
+  sanitizeOps: false,
+  sanitizeResources: false,
+});
+
+Deno.test({
+  name: "vite build - build ID handles empty GIT_REVISION",
+  fn: async () => {
+    await using res = await buildVite(DEMO_DIR, { GIT_REVISION: "" });
+
+    await withChildProcessServer(
+      {
+        cwd: res.tmp,
+        args: ["serve", "-A", "--port", "0", "_fresh/server.js"],
+      },
+      async (address) => {
+        await withBrowser(async (page) => {
+          await page.goto(`${address}/tests/build_id`, {
+            waitUntil: "networkidle2",
+          });
+
+          await page.locator(".ready").wait();
+          const buildId = await page.locator("#build-id").evaluate((el) =>
+            // deno-lint-ignore no-explicit-any
+            (el as any).textContent?.trim()
+          );
+          expect(buildId).toEqual("");
+        });
+      },
+    );
+  },
+  sanitizeOps: false,
+  sanitizeResources: false,
+});

packages/plugin-vite/tests/test_utils.ts

@@ -78,31 +78,52 @@ export default defineConfig({
   );
 }
 
-export async function buildVite(fixtureDir: string) {
+export async function buildVite(
+  fixtureDir: string,
+  env: Record<string, string> = {},
+) {
   const tmp = await withTmpDir({
     dir: path.join(import.meta.dirname!, ".."),
     prefix: "tmp_vite_",
   });
 
-  const builder = await createBuilder({
-    root: fixtureDir,
-    build: {
-      emptyOutDir: true,
-    },
-    environments: {
-      ssr: {
-        build: {
-          outDir: path.join(tmp.dir, "_fresh", "server"),
-        },
+  // Set environment variables for the build process
+  const originalEnv: Record<string, string | undefined> = {};
+  for (const [key, value] of Object.entries(env)) {
+    originalEnv[key] = Deno.env.get(key);
+    Deno.env.set(key, value);
+  }
+
+  try {
+    const builder = await createBuilder({
+      root: fixtureDir,
+      build: {
+        emptyOutDir: true,
       },
-      client: {
-        build: {
-          outDir: path.join(tmp.dir, "_fresh", "client"),
+      environments: {
+        ssr: {
+          build: {
+            outDir: path.join(tmp.dir, "_fresh", "server"),
+          },
+        },
+        client: {
+          build: {
+            outDir: path.join(tmp.dir, "_fresh", "client"),
+          },
         },
       },
-    },
-  });
-  await builder.buildApp();
+    });
+    await builder.buildApp();
+  } finally {
+    // Restore original environment variables
+    for (const [key, originalValue] of Object.entries(originalEnv)) {
+      if (originalValue === undefined) {
+        Deno.env.delete(key);
+      } else {
+        Deno.env.set(key, originalValue);
+      }
+    }
+  }
 
   return {
     tmp: tmp.dir,