fix: serialize shared Vite+ installs

Author: Clement Oh

dist/index.mjs

@@ -0,0 +1,49 @@
+import { describe, expect, it } from "vite-plus/test";
+import { mkdir, mkdtemp, rm, utimes } from "node:fs/promises";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+import { setTimeout as sleep } from "node:timers/promises";
+import { withVitePlusInstallLock } from "./install-lock.js";
+
+describe("withVitePlusInstallLock", () => {
+  it("serializes concurrent installs that share a Vite+ home", async () => {
+    const root = await mkdtemp(join(tmpdir(), "setup-vp-lock-"));
+    let active = 0;
+    let maxActive = 0;
+
+    try {
+      await Promise.all(
+        Array.from({ length: 3 }, () =>
+          withVitePlusInstallLock(join(root, ".vite-plus"), async () => {
+            active++;
+            maxActive = Math.max(maxActive, active);
+            await sleep(10);
+            active--;
+          }),
+        ),
+      );
+
+      expect(maxActive).toBe(1);
+    } finally {
+      await rm(root, { recursive: true, force: true });
+    }
+  });
+
+  it("recovers a stale lock that was interrupted before owner metadata existed", async () => {
+    const root = await mkdtemp(join(tmpdir(), "setup-vp-lock-"));
+    const vitePlusHome = join(root, ".vite-plus");
+    const lockPath = `${vitePlusHome}.setup-vp-lock`;
+    const old = new Date(Date.now() - 31 * 60 * 1000);
+
+    try {
+      await mkdir(lockPath, { recursive: true });
+      await utimes(lockPath, old, old);
+
+      await expect(withVitePlusInstallLock(vitePlusHome, async () => "recovered")).resolves.toBe(
+        "recovered",
+      );
+    } finally {
+      await rm(root, { recursive: true, force: true });
+    }
+  });
+});

src/install-lock.test.ts

@@ -0,0 +1,68 @@
+import { mkdir, readFile, rm, stat, writeFile } from "node:fs/promises";
+import { dirname, join } from "node:path";
+import { setTimeout as sleep } from "node:timers/promises";
+
+const RETRY_DELAY_MS = 250;
+const STALE_LOCK_MS = 30 * 60 * 1000;
+
+interface LockMetadata {
+  createdAt: number;
+  pid: number;
+}
+
+/**
+ * Serialize changes to Vite+'s process-wide installation. Self-hosted runners
+ * can execute multiple jobs under one HOME, while Vite+ updates its `current`
+ * shim and version directories in place.
+ */
+export async function withVitePlusInstallLock<T>(
+  vitePlusHome: string,
+  task: () => Promise<T>,
+): Promise<T> {
+  const lockPath = `${vitePlusHome}.setup-vp-lock`;
+
+  await acquireLock(lockPath);
+  try {
+    return await task();
+  } finally {
+    await rm(lockPath, { recursive: true, force: true });
+  }
+}
+
+async function acquireLock(lockPath: string): Promise<void> {
+  await mkdir(dirname(lockPath), { recursive: true });
+
+  for (;;) {
+    try {
+      await mkdir(lockPath);
+      await writeFile(
+        join(lockPath, "owner.json"),
+        JSON.stringify({ createdAt: Date.now(), pid: process.pid } satisfies LockMetadata),
+      );
+      return;
+    } catch (error) {
+      if ((error as NodeJS.ErrnoException).code !== "EEXIST") throw error;
+      await removeStaleLock(lockPath);
+      await sleep(RETRY_DELAY_MS);
+    }
+  }
+}
+
+async function removeStaleLock(lockPath: string): Promise<void> {
+  try {
+    const contents = await readFile(join(lockPath, "owner.json"), "utf8");
+    const metadata = JSON.parse(contents) as Partial<LockMetadata>;
+    await removeWhenExpired(lockPath, metadata.createdAt);
+  } catch {
+    // A process can be interrupted between mkdir and writing owner.json. The
+    // directory timestamp gives that partial lock the same recovery path.
+    await removeWhenExpired(lockPath);
+  }
+}
+
+async function removeWhenExpired(lockPath: string, createdAt?: number): Promise<void> {
+  const lockAgeStart = createdAt ?? (await stat(lockPath)).mtimeMs;
+  if (Date.now() - lockAgeStart > STALE_LOCK_MS) {
+    await rm(lockPath, { recursive: true, force: true });
+  }
+}

src/install-lock.ts

@@ -1,7 +1,10 @@
 import { describe, it, expect, beforeEach, afterEach, vi } from "vite-plus/test";
-import { exec } from "@actions/exec";
+import { exec, getExecOutput } from "@actions/exec";
 import { addPath, warning } from "@actions/core";
-import { writeFileSync } from "node:fs";
+import { mkdirSync, rmSync, writeFileSync } from "node:fs";
+import { mkdtempSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
 import { installVitePlus } from "./install-viteplus.js";
 import type { Inputs } from "./types.js";
 
@@ -13,6 +16,11 @@ vi.mock("@actions/core", () => ({
 
 vi.mock("@actions/exec", () => ({
   exec: vi.fn(),
+  getExecOutput: vi.fn(),
+}));
+
+vi.mock("./install-lock.js", () => ({
+  withVitePlusInstallLock: async <T>(_home: string, task: () => Promise<T>) => task(),
 }));
 
 vi.mock("node:timers/promises", () => ({
@@ -116,6 +124,36 @@ describe("installVitePlus", () => {
     expect(addPath).toHaveBeenCalledWith("/home/runner/.vite-plus/bin");
   });
 
+  it("reuses an installed exact version after waiting for the shared install lock", async () => {
+    const home = mkdtempSync(join(tmpdir(), "setup-vp-home-"));
+    vi.stubEnv("HOME", home);
+    const binary = join(home, ".vite-plus", "current", "bin", "vp");
+    mkdirSync(join(home, ".vite-plus", "current", "bin"), { recursive: true });
+    writeFileSync(binary, "#!/bin/sh\n");
+    vi.mocked(getExecOutput)
+      .mockResolvedValueOnce({ exitCode: 0, stdout: "vp v0.3.0\n", stderr: "" })
+      .mockResolvedValueOnce({
+        exitCode: 0,
+        stdout: [
+          "data\t/test/data",
+          "bin\t/test/data/bin",
+          "cache\t/test/cache",
+          "config\t/test/config",
+          "state\t/test/state",
+        ].join("\n"),
+        stderr: "",
+      });
+
+    try {
+      await installVitePlus({ ...baseInputs, version: "0.3.0" });
+
+      expect(exec).toHaveBeenCalledWith(binary, ["env", "setup", "--refresh"]);
+      expect(addPath).toHaveBeenCalledWith("/test/data/bin");
+    } finally {
+      rmSync(home, { recursive: true, force: true });
+    }
+  });
+
   it.each([
     { version: "0.3.0", output: "vp v0.2.9\n" },
     { version: `0.0.0-commit.${commitSha}`, output: "bin\t/test/data/bin\n" },

src/install-viteplus.test.ts

@@ -1,5 +1,6 @@
 import { info, warning, addPath } from "@actions/core";
-import { exec } from "@actions/exec";
+import { exec, getExecOutput } from "@actions/exec";
+import { existsSync, writeFileSync } from "node:fs";
 import { delimiter, join } from "node:path";
 import { setTimeout as sleep } from "node:timers/promises";
 import { getInstallScriptUrls, pkgPrNewCommitSha } from "./ci/install-script-urls.js";
@@ -14,6 +15,8 @@ import {
 import type { Inputs } from "./types.js";
 import { DISPLAY_NAME } from "./types.js";
 import { getVitePlusHome } from "./utils.js";
+import { withVitePlusInstallLock } from "./install-lock.js";
+import { parseInstalledVpVersion } from "./ci/version.js";
 
 // Try each group's URLs in order, for up to N rounds per group (max attempts
 // per group = rounds * URLs). Two rounds × two URLs = 4 attempts, ~1 minute
@@ -22,6 +25,10 @@ const INSTALL_MAX_ROUNDS = 2;
 const INSTALL_RETRY_DELAY_MS = 2000;
 
 export async function installVitePlus(inputs: Inputs): Promise<void> {
+  await withVitePlusInstallLock(getVitePlusHome(), () => installVitePlusUnlocked(inputs));
+}
+
+async function installVitePlusUnlocked(inputs: Inputs): Promise<void> {
   const { version } = inputs;
 
   info(`Installing ${DISPLAY_NAME}@${version}...`);
@@ -51,6 +58,13 @@ export async function installVitePlus(inputs: Inputs): Promise<void> {
     env.VP_NODE_MANAGER = inputs.nodeManager ? "yes" : "no";
   }
 
+  if (await canReuseInstalledVersion(version)) {
+    info(`Reusing installed ${DISPLAY_NAME}@${version}.`);
+    await restoreReusedInstall(version, dirsFile, inputs.nodeManager);
+    ensureVitePlusBinInPath(version, dirsFile, !dirsFile);
+    return;
+  }
+
   // For pkg.pr.new preview builds, tell the install script to fetch from
   // pkg.pr.new (bypassing the npm registry) instead of resolving VP_VERSION.
   const prVersion = pkgPrNewCommitSha(version);
@@ -124,8 +138,60 @@ async function runInstallCommand(url: string, env: { [key: string]: string }): P
   return exec(command, args, options);
 }
 
-function ensureVitePlusBinInPath(version: string, dirsFile: string | undefined): void {
-  const binDir = resolveVitePlusBinDir(version, dirsFile, join(getVitePlusHome(), "bin"));
+async function canReuseInstalledVersion(version: string): Promise<boolean> {
+  const requestedVersion = version.replace(/^v/, "");
+  if (!/^\d+\.\d+\.\d+(?:-[0-9A-Za-z.-]+)?$/.test(requestedVersion)) return false;
+
+  const binary = getCurrentVitePlusBinary();
+  if (!existsSync(binary)) return false;
+
+  const result = await getExecOutput(binary, ["--version"], {
+    ignoreReturnCode: true,
+    silent: true,
+  });
+  return result.exitCode === 0 && parseInstalledVpVersion(result.stdout) === requestedVersion;
+}
+
+async function restoreReusedInstall(
+  version: string,
+  dirsFile: string | undefined,
+  nodeManager: boolean | undefined,
+): Promise<void> {
+  const binary = getCurrentVitePlusBinary();
+
+  if (dirsFile) {
+    const result = await getExecOutput(binary, [], {
+      env: { ...process.env, VP_DUMP_DIRS: "1" },
+      ignoreReturnCode: true,
+      silent: true,
+    });
+    if (result.exitCode !== 0) {
+      throw new Error(`Could not read VpDirs from reused ${DISPLAY_NAME}@${version}.`);
+    }
+    writeFileSync(dirsFile, result.stdout);
+  }
+
+  // The installer refreshes managed Node.js shims by default on CI. Reapply
+  // that behavior after reuse; node-manager: false is reconciled by runMain's
+  // subsequent `vp env off` call.
+  if (nodeManager !== false) {
+    await exec(binary, ["env", "setup", "--refresh"]);
+  }
+}
+
+function getCurrentVitePlusBinary(): string {
+  return join(getVitePlusHome(), "current", "bin", process.platform === "win32" ? "vp.exe" : "vp");
+}
+
+function ensureVitePlusBinInPath(
+  version: string,
+  dirsFile: string | undefined,
+  allowLegacyBin = false,
+): void {
+  const legacyBinDir = join(getVitePlusHome(), "bin");
+  const binDir = allowLegacyBin
+    ? legacyBinDir
+    : resolveVitePlusBinDir(version, dirsFile, legacyBinDir);
   if (!process.env.PATH?.split(delimiter).includes(binDir)) {
     addPath(binDir);
   }