// Per-checkout port derivation: every checkout (main repo, agent worktree, // /tmp rig) hashes its repo root into a PREFERRED block of e2e ports, so // concurrent suites normally never fight over a shared default. The hash is // only a preference, not a guarantee (28 checkouts over 400 blocks is // birthday-paradox territory) — the globalsetups call `claimPorts`, which // probes the preferred block and walks forward to the next fully-free one, // then publishes the claimed ports via the E2E_*_PORT env vars so vitest's // test workers (spawned after globalsetup) compute the same URLs. The // collision failure mode this kills is brutal: vite's --strictPort exit is // swallowed by the boot glue and waitForHttp happily attaches to the OTHER // checkout's server, failing dozens of scenarios with baffling auth errors // instead of one clear bind error. Individual E2E_*_PORT env vars still // override everything, and E2E__URL still attaches to a running // instance. import { connect, createServer, type Server } from "node:net"; import { resolve } from "node:path"; import { fileURLToPath } from "node:url"; /** The repo root identifies the checkout (stable regardless of process cwd). */ export const repoRoot = resolve(fileURLToPath(new URL("../..", import.meta.url))); // FNV-1a — tiny, deterministic, and the same value in every process of this // checkout (globalsetup and test workers must agree on the ports). const hash = (text: string): number => { let h = 2166136261; for (let i = 0; i < text.length; i++) { h ^= text.charCodeAt(i); h = Math.imul(h, 16777619); } return h >>> 0; }; // 400 blocks of 10 ports in 42000..45999: unprivileged and clear of common dev // servers. NOTE: this range is below macOS's ephemeral range (49152+) but sits // ENTIRELY inside Linux's default ephemeral range (net.ipv4.ip_local_port_range // = 32768..60999). On a CI runner any outbound TCP connection the booting stack // makes (DB dials, emulator warmups, telemetry exporters) can be assigned one of // these ports as its LOCAL port between claim and bind, causing an EADDRINUSE // that no other suite triggered. A connect-probe can't see such a squatter // (nothing is listening on it), so `claimPorts` BIND-probes (holds a listener on // every claimed port until the instant services take over) and `claimAndBoot` // retries on EADDRINUSE by re-claiming the next block. We keep the range here // because it's good for local macOS dev and moving it churns every consumer; the // bind-probe + retry are what make it safe on Linux CI. Offsets 0-8 are // claimable; offset 9 is the block's lock port (held for the suite's lifetime to // make claims atomic across concurrent suites). const BLOCK_BASE = 42000; const BLOCK_SIZE = 10; const BLOCK_COUNT = 400; const LOCK_OFFSET = BLOCK_SIZE - 1; export const portBlock = BLOCK_BASE + (hash(repoRoot) % BLOCK_COUNT) * BLOCK_SIZE; export const e2ePort = (envVar: string, offset: number): number => { const fromEnv = process.env[envVar]; return fromEnv ? Number(fromEnv) : portBlock + offset; }; const listenOn = (options: { readonly port: number; readonly host: string; readonly ipv6Only?: boolean; }): Promise => new Promise((done) => { const server = createServer(); server.once("error", () => done(undefined)); server.listen(options, () => done(server)); }); const closeServer = (server: Server): Promise => new Promise((done) => server.close(() => done())); const isListening = (port: number, host: string): Promise => new Promise((done) => { const socket = connect({ port, host }); socket.once("connect", () => { socket.destroy(); done(true); }); socket.once("error", () => done(false)); socket.setTimeout(1_000, () => { socket.destroy(); done(false); }); }); // Bind-probe a single port and hold the listeners: resolves the held servers // when the port is provably free, or undefined when anything squats it. Three // checks, in a deliberate order: // // 1. Connect-probe the loopbacks (127.0.0.1 and ::1). On macOS a specific- // address listener (a leaked vite dev server on 127.0.0.1, or selfhost's // ::1) coexists with a wildcard bind, so the bind-probes below can't see // it — but a connect can. Runs FIRST because once our own wildcard probes // are up they would answer loopback connects themselves. Persistent // listeners are what this catches, so its check-vs-use gap is harmless. // 2. Bind 0.0.0.0 — catches v4 squatters, including ephemeral OUTBOUND // sockets, which no connect-probe can see (nothing is listening). // 3. Bind :: with ipv6Only — catches v6 squatters. ipv6Only is load-bearing: // a plain `::` bind is DUAL-STACK on Linux (ipv6Only defaults to false), // so it also claims the v4 side and EADDRINUSEs against our OWN 0.0.0.0 // probe from step 2, rejecting every block; the v6-ONLY side never // overlaps the v4 side, so this pair coexists on both Linux and macOS // (verified empirically on both). Sequential on purpose: the second bind // must observe the first, not race it. // // The caller holds every probe server until the whole block is proven free, // then closes them the instant before the real services bind — shrinking the // time-of-check/time-of-use window from seconds (probe, then boot) to // microseconds (close, then boot). Services bind 127.0.0.1 or dual-stack `::`, // both of which succeed once the probes are released. const bindProbe = async (port: number): Promise | undefined> => { const loopbacks = await Promise.all(["127.0.0.1", "::1"].map((host) => isListening(port, host))); if (loopbacks.some(Boolean)) return undefined; const v4 = await listenOn({ port, host: "0.0.0.0" }); if (!v4) return undefined; const v6 = await listenOn({ port, host: "::", ipv6Only: true }); if (!v6) { await closeServer(v4); return undefined; } return [v4, v6]; }; export interface PortClaim { readonly envVar: string; readonly offset: number; readonly label: string; } export interface ClaimedPorts { readonly ports: Record; /** Releases the block's lock port — call from the suite teardown. */ readonly release: () => Promise; } // Binding is atomic where probing is not: holding the block's lock port for // the suite's lifetime means two suites racing for the same block can never // both win (the second bind EADDRINUSEs and walks on). const tryLockBlock = (block: number): Promise => new Promise((done) => { const server = createServer(); server.once("error", () => done(undefined)); server.listen(block + LOCK_OFFSET, "127.0.0.1", () => done(server)); }); /** * Claim a free set of ports for a target and publish them via env. Starts at * this checkout's preferred block and walks forward block-by-block until it * can atomically lock a block whose requested ports are all free — so two * checkouts whose hashes collide (or a leaked server squatting the preferred * block) degrade to "boot one block over" instead of attaching to a foreign * server. Explicit env overrides win and are never probed or locked: if you * pin a port and it's busy, vite's --strictPort fails visibly. A target * re-claiming inside an already-locked process (cloud + selfhost projects in * one vitest run) shares the block via disjoint offsets. */ export const claimPorts = async (claims: ReadonlyArray): Promise => { const ports: Record = {}; const unpinned = claims.filter((claim) => { const pinned = process.env[claim.envVar]; if (pinned) ports[claim.envVar] = Number(pinned); return !pinned; }); if (unpinned.length === 0) return { ports, release: async () => {} }; for (let attempt = 0; attempt < BLOCK_COUNT; attempt++) { const block = BLOCK_BASE + ((portBlock - BLOCK_BASE + attempt * BLOCK_SIZE) % (BLOCK_COUNT * BLOCK_SIZE)); // This process may already hold the block's lock (the other target's // globalsetup in the same vitest run); reuse it instead of re-locking. let lock = heldLocks.get(block); if (!lock) { lock = await tryLockBlock(block); if (!lock) { console.warn(`[e2e] port block ${block} is locked by another suite; trying next block`); continue; } heldLocks.set(block, lock); } // BIND-probe every claimed port, holding all probe servers open until the // whole block is proven free. A bind (unlike a connect-probe) also detects // an ephemeral outbound socket squatting the port, and keeping the probes // open means nothing can slip into these ports between the check and the // moment we close them just before the services bind. const probes = await Promise.all(unpinned.map((claim) => bindProbe(block + claim.offset))); const held = probes.flatMap((probe) => probe ?? []); if (probes.some((probe) => probe === undefined)) { const taken = unpinned .filter((_, index) => probes[index] === undefined) .map((claim) => `${block + claim.offset} (${claim.label})`); await Promise.all(held.map(closeServer)); // Free the ports we did grab. console.warn( `[e2e] port block ${block} has squatters — ${taken.join(", ")}; trying next block`, ); continue; // Keep the lock: a half-busy block is still ours, just unusable now. } for (const claim of unpinned) { const port = block + claim.offset; ports[claim.envVar] = port; // Workers spawn after globalsetup, so they inherit these and agree. process.env[claim.envVar] = String(port); } // Release the probe listeners the instant before we return: the caller boots // its services immediately, so the ports go from probe-held to service-held // with only a microsecond gap (vs. the seconds a pre-boot probe left open). await Promise.all(held.map(closeServer)); return { ports, release: async () => { // Values published by this claim are not operator pins. Clear them // when the acquisition is released so a failed `claimAndBoot` attempt // can genuinely probe and claim again instead of treating its own // stale E2E_* value as an explicit override on every retry. for (const claim of unpinned) { const published = ports[claim.envVar]; if (published !== undefined && process.env[claim.envVar] === String(published)) { delete process.env[claim.envVar]; } } const held = heldLocks.get(block); if (!held) return; heldLocks.delete(block); await new Promise((done) => held.close(() => done())); }, }; } throw new Error("e2e: no free port block found — the 42000-45999 range is exhausted?"); }; const heldLocks = new Map(); /** True when an error (or any nested cause) is an EADDRINUSE bind failure. */ export const isAddrInUse = (error: unknown): boolean => { for (let cursor: unknown = error; cursor instanceof Error; cursor = cursor.cause) { if ((cursor as NodeJS.ErrnoException).code === "EADDRINUSE") return true; // The emulate/vite boot glue wraps the OS error in a plain Error whose // message carries the code, so match the text too. Vite's --strictPort // exit never says EADDRINUSE at all — the CLI catches the bind failure // and dies with "Port N is already in use", which reaches us only as // BootProcessExitError's log tail — so match that phrasing as well, or // the claimAndBoot re-claim retry never engages for the most common // collision (a Linux ephemeral outbound socket grabbing the claimed // port between probe release and vite's bind). if (/EADDRINUSE|is already in use/.test(cursor.message)) return true; } return false; }; /** * Claim a port block and boot the services that bind it, retrying on EADDRINUSE. * * The bind-probe in `claimPorts` shrinks the claim→bind race to microseconds but * cannot close it: on a Linux CI runner (where the whole 42000-45999 range is * ephemeral) an outbound socket can still grab a just-released probe port before * the service binds it. When that happens the boot throws EADDRINUSE; we release * the block (freeing its lock so `claimPorts` walks past it) and re-claim + retry * up to `maxAttempts` times. Callers may also classify another idempotent * acquisition failure with `retryWhen` (for example, a bounded Vite readiness * timeout). Unclassified failures and exhausted retries surface unchanged. * * `boot` receives the freshly claimed ports and must return its teardown; the * returned `teardown` chains the caller's teardown then releases the block. */ export const claimAndBoot = async ( claims: ReadonlyArray, boot: (ports: Record) => Promise<{ teardown: () => Promise; value: T }>, options: { readonly maxAttempts?: number; readonly label?: string; /** Additional acquisition failures that are safe to retry from scratch. */ readonly retryWhen?: (error: unknown) => boolean; } = {}, ): Promise<{ ports: Record; teardown: () => Promise; value: T }> => { const maxAttempts = options.maxAttempts ?? 3; const label = options.label ?? "boot"; let lastError: unknown; for (let attempt = 1; attempt <= maxAttempts; attempt++) { const { ports, release } = await claimPorts(claims); try { const booted = await boot(ports); return { ports, value: booted.value, teardown: async () => { await booted.teardown(); await release(); }, }; } catch (error) { await release(); lastError = error; const retryable = isAddrInUse(error) || options.retryWhen?.(error) === true; if (!retryable || attempt === maxAttempts) throw error; const collided = claims .map((claim) => ports[claim.envVar]) .filter((port): port is number => port !== undefined) .join(", "); const reason = isAddrInUse(error) ? `hit EADDRINUSE on port(s) ${collided}` : String(error); console.warn( `[e2e] ${label} acquisition failed (${reason}, attempt ${attempt}/${maxAttempts}); re-claiming a fresh block and retrying`, ); } } throw lastError; };