refactor: unify tarball resolution and optimize download latency

Author: aprendendofelipe

packages/app/e2e.test.ts

@@ -1,4 +1,3 @@
-import type { Response } from "@cloudflare/workers-types";
 import ezSpawn from "@jsdevtools/ez-spawn";
 import { simulation } from "@simulacrum/github-api-simulator";
 import fs from "node:fs/promises";
@@ -14,11 +13,20 @@ const E2E_TEMP_DIR_PREFIX = "pkg-pr-new-e2e-";
 
 let server: Awaited<ReturnType<ReturnType<typeof simulation>["listen"]>>;
 let workerUrl: string;
-let githubOutputDir: string;
+let tempDir: string;
 let githubOutputPath: string;
 
 let worker: UnstableDevWorker;
+
+const { stdout: gitHeadSha } = await ezSpawn.async("git rev-parse HEAD", {
+  stdio: "overlapped",
+});
+const fullSha = gitHeadSha.trim();
+const sha = fullSha.substring(0, 7);
+
 beforeAll(async () => {
+  tempDir = await fs.mkdtemp(path.join(os.tmpdir(), E2E_TEMP_DIR_PREFIX));
+
   const app = simulation({
     initialState: {
       users: [],
@@ -51,15 +59,12 @@ beforeAll(async () => {
     `${import.meta.dirname}/dist/_worker.js/index.js`,
     {
       config: `${import.meta.dirname}/wrangler.toml`,
+      persistTo: path.join(tempDir, "worker"),
     },
   );
   const url = `${worker.proxyData.userWorkerUrl.protocol}//${worker.proxyData.userWorkerUrl.hostname}:${worker.proxyData.userWorkerUrl.port}`;
   workerUrl = url;
-
-  githubOutputDir = await fs.mkdtemp(
-    path.join(os.tmpdir(), E2E_TEMP_DIR_PREFIX),
-  );
-  githubOutputPath = path.join(githubOutputDir, "output");
+  githubOutputPath = path.join(tempDir, "output");
   await fs.writeFile(githubOutputPath, "");
 
   await ezSpawn.async(
@@ -74,8 +79,8 @@ beforeAll(async () => {
 
 afterAll(async () => {
   await server.ensureClose();
-  if (githubOutputDir?.includes(E2E_TEMP_DIR_PREFIX)) {
-    await fs.rm(githubOutputDir, { recursive: true, force: true });
+  if (tempDir?.includes(E2E_TEMP_DIR_PREFIX)) {
+    await fs.rm(tempDir, { recursive: true, force: true });
   }
 });
 
@@ -147,14 +152,10 @@ describe.sequential.each([
     expect(process.stderr).toContain("pkg-pr-new:");
     expect(process.stderr).toContain("playground-a:");
     expect(process.stderr).toContain("playground-b:");
-  }, 10_000);
+  }, 20_000);
 
   it(`serves and installs playground-a for ${mode}`, async () => {
     const [owner, repo] = payload.repository.full_name.split("/");
-    const { stdout: gitHeadSha } = await ezSpawn.async("git rev-parse HEAD", {
-      stdio: "overlapped",
-    });
-    const sha = gitHeadSha.trim().substring(0, 7);
     const ref = pr?.payload.number ?? payload.workflow_run.head_branch;
 
     // Test download with SHA
@@ -166,9 +167,15 @@ describe.sequential.each([
     expect(shaBlob.size).toBeGreaterThan(0);
 
     // Test download with ref matches SHA content
-    const refResponse = await fetchWithRedirect(
+    const refResponse = await worker.fetch(
       `/${owner}/${repo}/playground-a@${ref}`,
     );
+    expect(refResponse.status).toBe(200);
+    expect(refResponse.headers.get("x-pkg-name-key")).toBe("playground-a");
+    expect(refResponse.headers.get("x-commit-key")).toBe(
+      `${owner}:${repo}:${fullSha}`,
+    );
+
     const refBlob = await refResponse.blob();
     const shaBlobSize = await shaBlob.arrayBuffer();
     const refBlobSize = await refBlob.arrayBuffer();
@@ -190,14 +197,31 @@ describe.sequential.each([
     expect(installProcess.stdout).toContain(
       "playground-a installed successfully!",
     );
-  }, 10_000);
+  }, 20_000);
+
+  it(`returns metadata for HEAD requests (${mode})`, async () => {
+    const [owner, repo] = payload.repository.full_name.split("/");
+
+    const headResponse = await worker.fetch(
+      `/${owner}/${repo}/playground-a@${sha}`,
+      { method: "HEAD" },
+    );
+
+    expect(headResponse.status).toBe(200);
+    expect(headResponse.headers.get("x-pkg-name-key")).toBe("playground-a");
+    expect(headResponse.headers.get("x-commit-key")).toBe(
+      `${owner}:${repo}:${sha}`,
+    );
+    expect(headResponse.headers.get("content-type")).toBe(
+      "application/tar+gzip",
+    );
+    expect(headResponse.headers.get("etag")).toBeDefined();
+    const lastModified = headResponse.headers.get("last-modified");
+    expect(new Date(lastModified!).toString()).not.toBe("Invalid Date");
+  });
 
   it(`serves and installs playground-b for ${mode}`, async () => {
     const [owner, repo] = payload.repository.full_name.split("/");
-    const { stdout: gitHeadSha } = await ezSpawn.async("git rev-parse HEAD", {
-      stdio: "overlapped",
-    });
-    const sha = gitHeadSha.trim().substring(0, 7);
 
     // Test download
     const response = await worker.fetch(
@@ -225,51 +249,60 @@ describe.sequential.each([
     expect(installProcess.stdout).toContain(
       "playground-b installed successfully!",
     );
-  }, 10_000);
+  }, 20_000);
 });
 
-describe("URL redirects", () => {
+describe("URL resolution", () => {
   describe("standard packages", () => {
-    it("redirects full URLs correctly", async () => {
-      const response = await fetchWithRedirect("/tinylibs/tinybench@a832a55");
-      expect(response.url).toContain("/tinylibs/tinybench/tinybench@a832a55");
+    it.each([
+      ["full", "/tinylibs/tinybench/tinybench@a832a55"],
+      ["compact", "/tinybench@a832a55"],
+      ["with .tgz extension", "/tinybench@a832a55.tgz"],
+    ])("resolves %s URLs", async (_, url) => {
+      const response = await worker.fetch(url);
+
+      expect(response.headers.get("x-commit-key")).toBe(
+        "tinylibs:tinybench:a832a55",
+      );
+      expect(response.headers.get("x-pkg-name-key")).toBe("tinybench");
     });
 
-    it("redirects compact URLs correctly", async () => {
-      const response = await fetchWithRedirect("/tinybench@a832a55");
-      expect(response.url).toContain("/tinylibs/tinybench/tinybench@a832a55");
+    it("resolves URL with full Git SHA", async () => {
+      const response = await worker.fetch(
+        "/tinylibs/tinybench/tinybench@a832a55e8f50c419ed8414024899e37e69b1f999",
+      );
+
+      expect(response.headers.get("x-pkg-name-key")).toBe("tinybench");
+      expect(response.headers.get("x-commit-key")).toBe(
+        "tinylibs:tinybench:a832a55e8f50c419ed8414024899e37e69b1f999",
+      );
     });
   });
 
   describe("scoped packages", () => {
-    const expectedPath = `/stackblitz/sdk/${encodeURIComponent("@stackblitz/sdk")}@a832a55`;
+    it.each([
+      ["full", "/stackblitz/sdk/@stackblitz/sdk@a832a55"],
+      ["encoded", "/stackblitz/sdk/%40stackblitz%2Fsdk@a832a55"],
+      ["compact", "/@stackblitz/sdk@a832a55"],
+      ["compact encoded", "/%40stackblitz%2Fsdk@a832a55"],
+    ])("resolves %s URLs", async (_, url) => {
+      const response = await worker.fetch(url);
 
-    it("redirects full scoped package URLs correctly", async () => {
-      const response = await fetchWithRedirect(
-        "/stackblitz/sdk/@stackblitz/sdk@a832a55",
+      expect(response.headers.get("x-pkg-name-key")).toBe("@stackblitz:sdk");
+      expect(response.headers.get("x-commit-key")).toBe(
+        "stackblitz:sdk:a832a55",
       );
-      expect(response.url).toContain(expectedPath);
     });
 
-    it("redirects compact scoped package URLs correctly", async () => {
-      const response = await fetchWithRedirect("/@stackblitz/sdk@a832a55");
-      expect(response.url).toContain(expectedPath);
+    it("resolves URL with full Git SHA", async () => {
+      const response = await worker.fetch(
+        "/stackblitz/sdk/@stackblitz/sdk@a832a55e8f50c419ed8414024899e37e69b1f999",
+      );
+
+      expect(response.headers.get("x-pkg-name-key")).toBe("@stackblitz:sdk");
+      expect(response.headers.get("x-commit-key")).toBe(
+        "stackblitz:sdk:a832a55e8f50c419ed8414024899e37e69b1f999",
+      );
     });
   });
 });
-
-async function fetchWithRedirect(
-  url: string,
-  maxRedirects = 999,
-): Promise<Response> {
-  const response = await worker.fetch(url, { redirect: "manual" });
-
-  if (response.status >= 300 && response.status < 400 && maxRedirects > 0) {
-    const location = response.headers.get("location");
-    if (location) {
-      return fetchWithRedirect(location, maxRedirects - 1);
-    }
-  }
-
-  return response as unknown as Response;
-}

packages/app/fixtures/workflow_run.in_progress.json

@@ -6,7 +6,7 @@
       "id": 9394452824,
       "name": "Preview & Release",
       "node_id": "WFR_kwLOLiqblM8AAAACL_P5WA",
-      "head_branch": "main",
+      "head_branch": "@test/@chaotic.branch/name-@v1.@",
       "head_sha": "ded05e838c418096e5dd77a29101c8af9e73daea",
       "path": ".github/workflows/ci.yml",
       "display_title": "chore: 007 (#94)",

packages/app/nuxt.config.ts

@@ -1,6 +1,3 @@
-// import ncb from "nitro-cloudflare-dev";
-import { resolve } from "pathe";
-
 // https://nuxt.com/docs/api/configuration/nuxt-config
 export default defineNuxtConfig({
   sourcemap: true,
@@ -57,23 +54,6 @@ export default defineNuxtConfig({
     test: "",
   },
 
-  hooks: {
-    "nitro:build:before": (nitro) => {
-      // Override the server routes with the client routes so they are higher priority
-      const clientRenderer = resolve(
-        "node_modules/nuxt/dist/core/runtime/nitro/renderer",
-      );
-      nitro.options.handlers.unshift({
-        route: "/",
-        handler: clientRenderer,
-      });
-      nitro.options.handlers.unshift({
-        route: "/~/**",
-        handler: clientRenderer,
-      });
-    },
-  },
-
   icon: {
     clientBundle: {
       icons: ["mdi-github"],