Files
PaperClipAI/server/src/services/workspace-runtime-exposure.test.ts
T
Devin FoleyandPaperclip 6681c71b40 fix(ci): stabilize chat startup and close the initial live-update gap (#13895)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work.
> - Browser tests check chat state across navigation, reload, and agent
runs.
> - Runtime tests check that a service is ready before Paperclip
publishes its address.
> - CI for #13891 failed in these paths, then passed attempt 3 with the
same code.
> - The browser traces stopped during development asset startup. A
separate sidebar assertion used an unstable focus path through the rich
editor.
> - This PR gives browser tests fresh built assets and a direct keyboard
path to the star button. It adds service-worker reload coverage under
CPU throttling.
> - A later browser failure exposed a real reload race: comments can
change between the first query and the first live subscription. The UI
now refreshes active queries when that subscription opens.
> - Runtime fixtures now have separate registry state and better failure
evidence. The readiness deadline remains unchanged.
> - A later CI run exposed a wall-clock backoff assertion and three
authorization cases sharing one test lifecycle. The PR anchors the
assertion to transport time and separates the cases.

## Linked Issues or Issue Description

Refs #13891. Related runtime ownership and cleanup work: #11791, #11389,
#11278.

Evidence: [original CI run, attempt
3](https://github.com/paperclipai/paperclip/actions/runs/35910335089/attempts/3).
Attempt 3 passed both affected shards without code changes. This PR is
separate from the wake-payload change, which has since merged.

| Failure | Diagnosis and classification |
| --- | --- |
| Sidebar blank page and retry text missing after reload in CI | Both
traces show a blank document before React startup. Vite connects, but
the failing page makes no application API requests. The service worker
forwards the unbundled development module graph. The retry response is
already stored and its process-adapter run succeeded before reload. This
places the failure in browser bootstrap, not wake payload or reply
persistence. The exact reason the development module graph stopped is
not established by the retained trace. The harness now serves built
assets, and the new test covers startup and controlled reload at 4x CPU
throttling. |
| Star opacity remains zero on macOS | Reproduced on unchanged master
`f55759942b`. The old test clicked the rich editor, focused the star,
then used Tab and Shift+Tab. An instrumented baseline run captured the
sequence: Tab moved from the star to the next sidebar link, then the
editor bundle called `focus()` on its contenteditable before Shift+Tab.
That key reached the composer, where it is a work-mode shortcut. This
confirms a pending editor selection update stole focus; it was not the
browser skipping sidebar buttons. The assertion did not prove the star
retained focus. The test now moves the pointer away, focuses the
preceding sidebar link, presses Tab once, and asserts both actual focus
and opacity. This is test synchronization and keyboard traversal, not a
demonstrated CSS defect. |
| Runtime readiness exceeds 10 seconds | The old error only says `fetch
failed`. There is no child startup output in that failure, so it cannot
distinguish slow process startup from a refused or stalled probe. It
passed unchanged locally and took 3.416 seconds in attempt 3. Resource
contention is plausible but unproved. This PR does not claim a proven
historical runtime root cause: it isolates fixture registry/log files,
checks ports before spawn and after stop, checks live backends at
publication, and preserves transport errors, probe count, elapsed time,
and fixture startup timestamps for the next occurrence. |
| Later CI: recovery reply disappears after reload | Product
synchronization bug, distinct from the blank-page bootstrap failure.
Reproduced locally with a trace: the comments request started at
`21:56:07.443`, the server saved the reply at `.520`, and the first live
subscription started at `.541`. The reload fetched a successful run and
its complete log, but missed the comment event. The provider refreshed
after reconnects only. It now refreshes active queries on the first
connection too. A deterministic regression test fails before the fix. No
browser assertion was changed. |
| Later CI: Slack backoff and authorization tests | The 30-second
backoff assertion required more than 25 seconds to remain when it read
the saved action. CI spent 10.311 seconds in the test, exceeding that
five-second allowance. A local six-second read delay reproduces the
failure; the new transport-anchored lower and upper bounds pass the same
fault injection. The neighbouring authorization test ran three
independent fixtures in one test and timed out at 15 seconds. Each case
now has its own fixture cleanup and the normal per-test deadline, so
earlier cases do not remain active during later global worker sweeps. No
specific production slow call was established. |
| Self-hosted runner loses communication or shuts down | The original
lost-communication failure has no assertion. On final-head [attempt
1](https://github.com/paperclipai/paperclip/actions/runs/35925901613/attempts/1),
Build, Runner Vitest 1/2, and chat 2/3 ran on three separate fleet
instances. All received a runner shutdown signal at `22:04:55 UTC`,
within 35 milliseconds, then cancellation. Server shard 6/12 received
the same shutdown signal one minute later. All four were Spot
`m7i-flex.xlarge` instances in `us-east-1a`. No test assertion or build
error preceded those stops. This is infrastructure interruption; the
reason the fleet stopped the runners is not available in job logs. |

## What Changed

- Build the browser fixture UI into the static server's preferred
directory, `server/ui-dist`, and disable Vite middleware. Ignore these
generated assets. Start the source CLI directly from the repository
root, as required by the CLI invocation safety contract.
- Keep all existing chat assertions. Add first takeover and three
service-worker-controlled reloads under CPU throttling. Assert that the
page uses built module assets and that opening it creates no chat task.
- Use forward keyboard traversal from the Zeta link to its star. Check
focus before checking the reveal style.
- Give each runtime exposure test a temporary Paperclip home and restore
environment state after process cleanup.
- Check that reserved ports are free before spawn, serve the fixture
response before exposure, and become free after stop.
- Include the nested fetch error, probe count, and elapsed time in
readiness failures. Add a unit test for this diagnostic contract.
- Refresh active queries when the first live connection opens, covering
events missed during initial page loading. Keep reconnect toast
suppression unchanged.
- Measure Slack retry timing from the transport attempt and recovery
completion. This checks the full provider-requested delay without
spending a small wall-clock allowance on unrelated processing.
- Run each Slack authorization-revocation scenario as a separate test,
with cleanup between cases. All assertions remain.
- Document the browser fixture's build and serving mode. No configured
assertion deadline, readiness deadline, retry count, or skip was added.

## Verification

- Final-head [Linux CI, attempt
2](https://github.com/paperclipai/paperclip/actions/runs/35925901613/attempts/2):
**green**. All 52 check runs passed; two conditional checks were
skipped. The legacy Snyk status also passed. No pending or failed checks
remain.
- `pnpm -r typecheck` passed.
- `pnpm build` passed again after the final UI fix.
- Focused runtime suites: 38 passed, 3 existing platform skips.
- CLI invocation safety suite: 39 passed.
- Slack timing negative control: inserting a six-second delay before
reading the saved action fails the old assertion. All four revised
authorization/backoff cases pass with that same delay. The diagnostic
delay is not committed.
- Live update suites: 92 passed, including the new regression. UI
typecheck and token gates passed.
- Recovery browser negative control: the unchanged tests reproduced the
missing reply (1 failed, 9 passed). After the first-connection fix, all
six recovery paths passed twice (12 passed). Browser assertions and
deadlines are unchanged.
- Server typecheck passed after the Slack test adjustment.
- `GITHUB_WORKFLOW=PR pnpm test:run:general -- --group general-chat
--shard-index 0 --shard-count 3`: 342 passed. The other 682 tests belong
to the remaining shards; collection verified exact coverage.
- Final direct-source CLI launch: all five chat session tests passed.
- `PAPERCLIP_E2E_PORT=32993 PAPERCLIP_PLAYWRIGHT_CHANNEL=chrome pnpm
exec playwright test --config tests/e2e/playwright.config.ts
tests/e2e/agent-chat-sessions.spec.ts --repeat-each=3`: 15 passed,
including nine controlled reloads at 4x CPU throttling.
- `GITHUB_WORKFLOW=PR pnpm test:run:general -- --group
general-server-without-chat --shard-index 10 --shard-count 12`: 55 files
passed, 867 tests passed, 21 existing skips. An earlier run could not
initialize PostgreSQL because this Mac exhausted its System V
shared-memory slots. After reclaiming the orphaned segment from this
task's stopped browser server, the full shard passed.
- On final commit `1f1fafc08d`, [browser
4/8](https://github.com/paperclipai/paperclip/actions/runs/35925901613/job/107400837947)
passed all 16 tests; [browser
8/8](https://github.com/paperclipai/paperclip/actions/runs/35925901613/job/107400838155)
passed all 23 tests; [server
11/12](https://github.com/paperclipai/paperclip/actions/runs/35925901613/job/107400838328)
passed 887 tests with one existing skip. The readiness lifecycle case
took 1.842 seconds. Chat 1/3 also passed. All four jobs interrupted by
runner shutdowns passed unchanged on their single rerun.
- Greptile reviewed `1f1fafc08d`: **5/5**, with no unresolved comments.
- Full local `pnpm test:run` was attempted and stopped after confirming
failures outside this patch: a sibling `skills` directory shadows
bundled Slack/AgentMail skills; macOS rejects rename of read-only
skill-cache directories (`EACCES`, also reproduced in an isolated
filesystem probe); and the host exhausts PostgreSQL System V
shared-memory slots. Focused reruns confirmed these limits. The complete
Linux CI run is the repository-wide verification; the full local run is
not green.
- Baseline evidence: the original sidebar test failed on unchanged
master; a development-mode run at 4x CPU throttling passed six selected
cases, so CPU pressure alone did not reproduce the CI bootstrap stall.

## Risks

- Default browser tests now exercise the shipped static UI. They no
longer implicitly cover Vite middleware or HMR; use the development
server for those checks.
- The new browser startup test uses Chromium CDP, matching the only
configured browser project.
- Opening a live subscription now causes one active-query refresh to
close the initial event gap. This adds startup API reads but no
recurring poll.
- Runtime behavior and deadlines are unchanged except for error details.
The historical readiness stall remains unconfirmed; a green rerun alone
cannot establish its cause.
- Local verification runs on macOS. The runtime lifecycle checks also
passed on Linux CI.

## Model Used

- OpenAI GPT-6 through Codex. The session identifies the model family as
GPT-6; an exact served model ID and context window size are not exposed.
Used reasoning, repository inspection, shell tools, code editing, and
test execution. No subagents were used.

## Checklist

- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#123` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
and contains no internal Paperclip ticket id or instance-derived details
- [x] I have run tests locally and they pass — targeted suites passed;
full local host limits are listed above
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [x] All Paperclip CI gates are green
- [x] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

---------

Co-authored-by: Paperclip <noreply@paperclip.ing>
2026-09-23 15:22:21 -07:00

1012 lines
43 KiB
TypeScript

import fs from "node:fs/promises";
import net from "node:net";
import os from "node:os";
import path from "node:path";
import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
import {
deriveViteHmrPort,
RUNTIME_EXPOSURE_APP_PORT_MAX,
RUNTIME_EXPOSURE_APP_PORT_MIN,
} from "@paperclipai/shared";
import type { BrokerClient, BrokerListenerRequest } from "./runtime-exposure/broker-client.js";
import {
diagnoseRuntimeListenerBinds,
readListenerBindFacts,
} from "./runtime-exposure/loopback-listener.js";
import {
classifyExposureHostCollisions,
type ExposurePortHostState,
resetRuntimeServicesForTests,
setWorkspaceRuntimeExposureDepsForTests,
startRuntimeServicesForWorkspaceControl,
stopRuntimeServicesForExecutionWorkspace,
} from "./workspace-runtime.js";
const EXECUTION_WORKSPACE_ID = "11111111-2222-4333-8444-555566667777";
const HANDLE = "handle-abcdef1234567890";
// The shared test setup pins the automatic default off so unrelated suites do
// not probe for a real host broker. This suite is about the default, so it opts
// back in and restores the harness value afterwards.
beforeEach(async () => {
vi.stubEnv("PAPERCLIP_MANAGED_RUNTIME_HTTPS", "auto");
// Registry records and append-only logs must not share a developer's instance
// or a previous test's service identity.
vi.stubEnv("PAPERCLIP_HOME", await fs.mkdtemp(path.join(guestDir, "home-")));
});
afterEach(async () => {
// These tests spawn real loopback backends on dedicated-range ports; reap them
// rather than leaving one squatting 42xxx/52xxx for every test in the file.
try {
await resetRuntimeServicesForTests({ terminateProcesses: true });
} finally {
vi.unstubAllEnvs();
}
});
function serviceCommand() {
// Answers `/api/health` the way a real Paperclip dev runtime does: managed
// publication requires semantic health, not just a 200 (PAP-17572).
return `node -e 'console.log("fixture started",process.pid,Date.now());const http=require("http");const p=Number(process.env.PORT);for(const q of [p,p+10000].filter(q=>q<65536))http.createServer((rq,r)=>{if(rq.url==="/api/health"){r.setHeader("content-type","application/json");r.end(JSON.stringify({status:"ok"}));return}r.statusCode=200;r.end("ok")}).listen(q,"127.0.0.1",()=>console.log("fixture listening",q,Date.now()));setInterval(()=>{},1000)'`;
}
/**
* Fake guest dev runners written to disk (PAP-17256).
*
* They must be real files named `dev-runner*.mjs` for two reasons: the command
* has to look like a dev-runner invocation for the rewrite to apply at all, and
* `node <file> --bind lan` hands the flags to the script, which is exactly how a
* real `pnpm dev --bind lan` reaches `scripts/dev-runner.ts`.
*/
let guestDir: string;
/**
* A guest checkout from *before* managed HTTPS exposure existed.
*
* Reproduces the behaviour that actually broke the lanes: `scripts/dev-runner.ts`
* on plain master derives its bind mode from its own `--bind` / `--bind-host`
* argv and **ignores `PAPERCLIP_BIND` / `PAPERCLIP_MANAGED_RUNTIME_EXPOSURE`
* entirely** — so env-only hardening cannot reach it. `--bind lan` therefore
* means `0.0.0.0`, which the broker must refuse.
*/
const PRE_MANAGED_EXPOSURE_GUEST = `
import http from "node:http";
const argv = process.argv.slice(2);
const valueOf = (flag) => {
const at = argv.indexOf(flag);
const value = at >= 0 ? argv[at + 1] : undefined;
return value && !value.startsWith("--") ? value : undefined;
};
const mode = valueOf("--bind") ?? "loopback";
const host = mode === "custom" ? (valueOf("--bind-host") ?? "127.0.0.1")
: mode === "lan" ? "0.0.0.0"
: "127.0.0.1";
const p = Number(process.env.PORT);
// Even a pre-exposure checkout answered /api/health semantically; these guests
// model bind behaviour, not health behaviour.
const health = (rq, r) => { if (rq.url === "/api/health") { r.setHeader("content-type", "application/json"); r.end(JSON.stringify({ status: "ok" })); return true; } return false; };
for (const q of [p, p + 10000]) {
http.createServer((rq, r) => { if (health(rq, r)) return; r.statusCode = 200; r.end("ok"); }).listen(q, host);
}
setInterval(() => {}, 1000);
`;
/**
* The true shape of the deployed failure: a guest that honours the bind argv for
* its own HTTP listener but whose Vite gets `hmr.port` with no `hmr.server` and
* no `server.host`, so Vite opens its *own* HMR websocket on the IPv6 wildcard
* regardless of the bind mode. Plain master's `server/src/app.ts` does exactly
* this, which is why forcing the bind is necessary but not sufficient there.
*/
const WILDCARD_HMR_GUEST = `
import http from "node:http";
const argv = process.argv.slice(2);
const at = argv.indexOf("--bind-host");
const host = at >= 0 ? argv[at + 1] : "127.0.0.1";
const p = Number(process.env.PORT);
const health = (rq, r) => { if (rq.url === "/api/health") { r.setHeader("content-type", "application/json"); r.end(JSON.stringify({ status: "ok" })); return true; } return false; };
http.createServer((rq, r) => { if (health(rq, r)) return; r.statusCode = 200; r.end("ok"); }).listen(p, host);
// No host argument: Vite's own HMR listener lands on the wildcard.
http.createServer((_, r) => { r.statusCode = 426; r.end(); }).listen(p + 10000);
setInterval(() => {}, 1000);
`;
/** A guest so old it has no bind flags at all and always binds the wildcard. */
const ALWAYS_WILDCARD_GUEST = `
import http from "node:http";
const p = Number(process.env.PORT);
const health = (rq, r) => { if (rq.url === "/api/health") { r.setHeader("content-type", "application/json"); r.end(JSON.stringify({ status: "ok" })); return true; } return false; };
for (const q of [p, p + 10000]) {
http.createServer((rq, r) => { if (health(rq, r)) return; r.statusCode = 200; r.end("ok"); }).listen(q, "0.0.0.0");
}
setInterval(() => {}, 1000);
`;
/**
* A guest that prints a synthetic `EADDRINUSE` line for its assigned port with no
* host listener behind it, then exits. It models guest-controlled output that
* claims a collision the host cannot confirm. The runtime must not quarantine the
* pair on the printed line alone. Otherwise repeated starts drain the shared
* exposure-port pool. The start must surface the failure terminally after a single
* allocation.
*/
const SYNTHETIC_EADDRINUSE_ON_ASSIGNED_PORT_GUEST = `
const p = Number(process.env.PORT);
process.stderr.write("node:events:497\\nError: listen EADDRINUSE: address already in use 127.0.0.1:" + p + "\\n");
process.exit(1);
`;
/**
* A guest that exits with `EADDRINUSE` on an unrelated auxiliary port, never on
* its assigned app or HMR port. It models a fixed helper listener (for example an
* inspector or metrics port) that an external process already holds. The managed
* start must not quarantine the valid exposure pair; it must surface the failure
* terminally after a single allocation.
*/
const EADDRINUSE_ON_AUXILIARY_PORT_GUEST = `
import http from "node:http";
process.stderr.write("node:events:497\\nError: listen EADDRINUSE: address already in use 127.0.0.1:39999\\n");
process.exit(1);
`;
/**
* A guest that fails with `EADDRINUSE` on an unrelated auxiliary port, and also
* prints the assigned app port on a separate, benign line. It models mixed
* startup output: one line names the assigned port for an informational reason,
* a different line reports the auxiliary-port conflict. The parser must match the
* error and the port on the same line, so the benign mention of the assigned port
* must not trigger a wrong quarantine. The managed start must surface the failure
* terminally after a single allocation.
*/
const EADDRINUSE_ON_AUXILIARY_PORT_WITH_ASSIGNED_MENTION_GUEST = `
import http from "node:http";
const p = Number(process.env.PORT);
process.stderr.write("[dev] server ready on http://127.0.0.1:" + p + "/\\n");
process.stderr.write("node:events:497\\nError: listen EADDRINUSE: address already in use 127.0.0.1:39999\\n");
process.exit(1);
`;
beforeAll(async () => {
guestDir = await fs.mkdtemp(path.join(os.tmpdir(), "pap-17256-guest-"));
await fs.writeFile(path.join(guestDir, "dev-runner.mjs"), PRE_MANAGED_EXPOSURE_GUEST);
await fs.writeFile(path.join(guestDir, "dev-runner-legacy.mjs"), ALWAYS_WILDCARD_GUEST);
await fs.writeFile(path.join(guestDir, "dev-runner-wildcard-hmr.mjs"), WILDCARD_HMR_GUEST);
await fs.writeFile(
path.join(guestDir, "dev-runner-bind-conflict.mjs"),
'process.stderr.write("local_trusted requires server.bind=loopback\\n"); process.exit(1);\n',
);
// A guest that prints a synthetic EADDRINUSE line for its assigned port with no
// host listener behind it. It models guest-controlled output that claims a
// collision the host cannot confirm. The start must not quarantine the pair.
await fs.writeFile(
path.join(guestDir, "dev-runner-eaddrinuse-synthetic.mjs"),
SYNTHETIC_EADDRINUSE_ON_ASSIGNED_PORT_GUEST,
);
// A guest that fails on a fixed auxiliary port, not on its assigned app or HMR
// port. It models an unrelated helper listener that an external process holds.
// The assigned exposure pair stays valid, so the start must not quarantine it.
await fs.writeFile(
path.join(guestDir, "dev-runner-eaddrinuse-auxiliary.mjs"),
EADDRINUSE_ON_AUXILIARY_PORT_GUEST,
);
// A guest that fails on an auxiliary port and also prints the assigned app port
// on a separate, benign line. It models mixed output where the assigned port
// appears for an unrelated reason. The parser must match the error and the port
// on the same line, so the start must not quarantine the valid exposure pair.
await fs.writeFile(
path.join(guestDir, "dev-runner-eaddrinuse-auxiliary-mixed.mjs"),
EADDRINUSE_ON_AUXILIARY_PORT_WITH_ASSIGNED_MENTION_GUEST,
);
});
afterAll(async () => {
await fs.rm(guestDir, { recursive: true, force: true });
});
const guestCommand = (file: string) => `node ${path.join(guestDir, file)}`;
function createBroker() {
const calls: string[] = [];
let listeners: BrokerListenerRequest[] = [];
const broker: BrokerClient = {
async reserve(_runtimeId, requested) {
calls.push("reserve");
listeners = requested;
return { handle: HANDLE, reservedPorts: requested.map((listener) => listener.port) };
},
async expose() {
calls.push("expose");
return { handle: HANDLE, publicPorts: listeners.map((listener) => listener.port) };
},
async remove() {
calls.push("remove");
return { removedPorts: listeners.map((listener) => listener.port) };
},
async list() {
return [];
},
};
return { broker, calls };
}
/**
* A real loopback bind probe, matching production's `isLoopbackPortAvailable`.
*
* The default used to be `async () => true`, which claimed every port in the
* dedicated range was free. On a developer or canary host that already runs a
* managed lane on `42000`, that lie made the suite allocate a port something
* else was listening on — so the spawned guest could not bind, and every
* assertion downstream failed for a reason that had nothing to do with the
* behaviour under test. It also meant the suite exercised allocation against a
* range it never actually checked (PAP-17419; PAP-17255 started this with
* "make exposure fixture honor occupied ports").
*/
async function isLoopbackPortFree(port: number): Promise<boolean> {
const facts = await readListenerBindFacts(port);
if (facts?.present) return false;
return await new Promise<boolean>((resolve) => {
const probe = net.createServer();
probe.unref();
probe.once("error", () => resolve(false));
probe.listen(port, "127.0.0.1", () => {
probe.close(() => resolve(true));
});
});
}
/**
* The first app port at or above `startAt` whose HMR companion is also free on
* the real host, mirroring the allocator's own scan. The pinned-port test needs
* a port that is *verifiably* free right now rather than a hard-coded one: the
* whole dedicated range sits inside the Linux ephemeral port range, so any
* transient loopback socket on the host (the client side of a readiness probe,
* a TIME_WAIT remnant from another suite) can occupy a fixed constant at probe
* time and make the allocator relocate for a reason unrelated to the behaviour
* under test.
*/
async function findFreeExposureAppPort(startAt: number): Promise<number> {
for (let appPort = startAt; appPort <= RUNTIME_EXPOSURE_APP_PORT_MAX; appPort += 1) {
if (await isLoopbackPortFree(appPort) && await isLoopbackPortFree(deriveViteHmrPort(appPort))) {
return appPort;
}
}
throw new Error("no free app/HMR port pair available in the dedicated runtime exposure range");
}
function installDeps(overrides: {
broker: BrokerClient;
probeHealth?: () => Promise<boolean>;
isBrokerAvailable?: () => Promise<boolean>;
isPortAvailable?: (port: number) => Promise<boolean>;
diagnoseListenerBinds?: (ports: number[]) => Promise<string | null>;
resolveHostname?: () => Promise<string>;
}) {
setWorkspaceRuntimeExposureDepsForTests({
broker: overrides.broker,
isPortAvailable: overrides.isPortAvailable ?? isLoopbackPortFree,
isBrokerAvailable: overrides.isBrokerAvailable ?? (async () => true),
resolveHostname: overrides.resolveHostname ?? (async () => "runner.tail123.ts.net"),
probeHealth: overrides.probeHealth ?? (async () => true),
now: () => "2026-08-11T00:00:00.000Z",
// The real /proc-backed diagnosis, not a fake: the fake broker below always
// says yes, so this is what has to catch an off-loopback bind here.
diagnoseListenerBinds: overrides.diagnoseListenerBinds ?? diagnoseRuntimeListenerBinds,
});
}
const DECLARED_EXPOSE = {
type: "tailscale_https",
hostname: "auto",
publicPort: "same",
includePaperclipViteHmr: true,
failurePolicy: "fail_closed",
} as const;
/**
* The pre-feature Paperclip App project template, verbatim: a hard-coded HTTP
* `urlTemplate`, a pinned port outside the broker's dedicated range, and no
* exposure declaration at all.
*/
const LEGACY_HTTP_EXPOSE = {
type: "url",
urlTemplate: "http://paperclip-dev:{{port}}",
} as const;
function startInput(options?: {
serviceName?: string;
expose?: Record<string, unknown> | null;
port?: Record<string, unknown> | number;
command?: string;
}) {
const expose = options?.expose === undefined ? DECLARED_EXPOSE : options.expose;
return {
invocationId: "runtime-exposure-test",
actor: { id: null, name: "Paperclip", companyId: "aaaaaaaa-bbbb-4ccc-8ddd-eeeeeeeeeeee" },
issue: null,
workspace: {
baseCwd: process.cwd(),
source: "project_primary" as const,
projectId: null,
workspaceId: null,
repoUrl: null,
repoRef: null,
strategy: "project_primary" as const,
cwd: process.cwd(),
branchName: "test",
worktreePath: null,
warnings: [],
created: false,
branchCreatedByRuntime: false,
},
executionWorkspaceId: EXECUTION_WORKSPACE_ID,
config: {
workspaceRuntime: {
services: [{
name: options?.serviceName ?? "preview",
command: options?.command ?? serviceCommand(),
env: { PAPERCLIP_PUBLIC_URL: "http://127.0.0.1:3100" },
port: options?.port ?? { type: "auto", envKey: "PORT" },
// These lifecycle tests spawn real servers; cold CI startup can take
// five seconds before the first listener is ready.
readiness: { type: "http", urlTemplate: "http://127.0.0.1:{{port}}", timeoutSec: 10 },
...(expose ? { expose } : {}),
}],
},
},
adapterEnv: {},
};
}
describe("workspace runtime tailscale_https lifecycle", () => {
it("reserves before spawn, exposes after backend readiness, and removes on stop", async () => {
const { broker, calls } = createBroker();
let reservedPorts: number[] = [];
installDeps({
broker: {
...broker,
async reserve(runtimeId, listeners) {
reservedPorts = listeners.map((listener) => listener.port);
for (const port of reservedPorts) expect(await isLoopbackPortFree(port)).toBe(true);
return broker.reserve(runtimeId, listeners);
},
async expose(...args) {
for (const port of reservedPorts) {
const response = await fetch(`http://127.0.0.1:${port}/`, { signal: AbortSignal.timeout(5_000) });
expect(await response.text()).toBe("ok");
}
return broker.expose(...args);
},
},
});
const [runtime] = await startRuntimeServicesForWorkspaceControl(startInput());
expect(calls.slice(0, 2)).toEqual(["reserve", "expose"]);
expect(runtime.port).toBeGreaterThanOrEqual(42000);
expect(runtime.url).toBe(`https://runner.tail123.ts.net:${runtime.port}`);
expect(runtime.exposure?.state).toBe("ready");
await stopRuntimeServicesForExecutionWorkspace({
executionWorkspaceId: EXECUTION_WORKSPACE_ID,
runtimeServiceId: runtime.id,
});
expect(calls).toEqual(["reserve", "expose", "remove"]);
for (const port of reservedPorts) expect(await isLoopbackPortFree(port)).toBe(true);
}, 15_000);
it("fails closed and removes the mapping when external HTTPS validation fails", async () => {
const { broker, calls } = createBroker();
installDeps({ broker, probeHealth: async () => false });
await expect(startRuntimeServicesForWorkspaceControl(startInput())).rejects.toThrow(/HTTPS exposure failed/);
expect(calls).toEqual(["reserve", "expose", "remove"]);
}, 15_000);
});
describe("automatic tailscale_https default for managed worktree runtimes", () => {
it("defaults a legacy paperclip-dev service with no exposure block, relocating its pinned port", async () => {
const { broker, calls } = createBroker();
installDeps({ broker });
// Exactly the persisted pre-feature shape: pinned 45439 + HTTP urlTemplate.
const [runtime] = await startRuntimeServicesForWorkspaceControl(startInput({
serviceName: "paperclip-dev",
expose: LEGACY_HTTP_EXPOSE,
port: 45_439,
}));
expect(calls.slice(0, 2)).toEqual(["reserve", "expose"]);
// 45439 is outside the broker allowlist, so the pinned port cannot be kept.
expect(runtime.port).not.toBe(45_439);
expect(runtime.port).toBeGreaterThanOrEqual(42_000);
expect(runtime.port).toBeLessThanOrEqual(42_999);
// The canonical URL is the verified HTTPS origin; HTTP is never retained.
expect(runtime.url).toBe(`https://runner.tail123.ts.net:${runtime.port}`);
expect(runtime.url).not.toContain("http://");
expect(runtime.exposure?.state).toBe("ready");
}, 15_000);
it("keeps an existing runtime port that is already inside the dedicated range", async () => {
const { broker } = createBroker();
installDeps({ broker });
// Pin a pair that is free right now, strictly above the lowest free pair.
// If the keep-the-preferred-port path were broken, the ascending fallback
// scan would return that lower pair, so coming back with the pinned port
// still proves the behaviour — without betting the test on one hard-coded
// host port (formerly 42500) staying unoccupied for the whole run.
const lowestFreeAppPort = await findFreeExposureAppPort(RUNTIME_EXPOSURE_APP_PORT_MIN);
const pinnedPort = await findFreeExposureAppPort(lowestFreeAppPort + 1);
const [runtime] = await startRuntimeServicesForWorkspaceControl(startInput({
serviceName: "paperclip-dev",
expose: LEGACY_HTTP_EXPOSE,
port: pinnedPort,
}));
expect(runtime.port).toBe(pinnedPort);
expect(runtime.url).toBe(`https://runner.tail123.ts.net:${pinnedPort}`);
}, 15_000);
it("preserves a deliberate opt-out and leaves the service on plain HTTP", async () => {
const { broker, calls } = createBroker();
installDeps({ broker });
const [runtime] = await startRuntimeServicesForWorkspaceControl(startInput({
serviceName: "paperclip-dev",
expose: { ...LEGACY_HTTP_EXPOSE, tailscaleHttps: false },
port: { type: "auto", envKey: "PORT" },
}));
expect(calls).toEqual([]);
expect(runtime.exposure ?? null).toBeNull();
expect(runtime.url).toBe(`http://paperclip-dev:${runtime.port}`);
}, 15_000);
it("leaves an unmanaged/custom service untouched", async () => {
const { broker, calls } = createBroker();
installDeps({ broker });
const [runtime] = await startRuntimeServicesForWorkspaceControl(startInput({
serviceName: "preview",
expose: LEGACY_HTTP_EXPOSE,
port: { type: "auto", envKey: "PORT" },
}));
expect(calls).toEqual([]);
expect(runtime.exposure ?? null).toBeNull();
expect(runtime.url).toBe(`http://paperclip-dev:${runtime.port}`);
}, 15_000);
it("does not default when the host broker is unavailable", async () => {
const { broker, calls } = createBroker();
installDeps({ broker, isBrokerAvailable: async () => false });
const [runtime] = await startRuntimeServicesForWorkspaceControl(startInput({
serviceName: "paperclip-dev",
expose: LEGACY_HTTP_EXPOSE,
port: { type: "auto", envKey: "PORT" },
}));
expect(calls).toEqual([]);
expect(runtime.exposure ?? null).toBeNull();
}, 15_000);
it("still honors an explicit opt-in when the broker socket is missing, failing loudly", async () => {
// A missing broker must never silently downgrade a requested HTTPS preview.
const { broker, calls } = createBroker();
const failing: BrokerClient = {
...broker,
async reserve() {
calls.push("reserve");
throw new Error("ENOENT: broker socket missing");
},
};
installDeps({ broker: failing, isBrokerAvailable: async () => false });
await expect(
startRuntimeServicesForWorkspaceControl(startInput({ serviceName: "paperclip-dev" })),
).rejects.toThrow();
expect(calls).toEqual(["reserve"]);
}, 15_000);
it("is idempotent across repeated starts: the same port pair is reserved again", async () => {
const { broker, calls } = createBroker();
installDeps({ broker });
const [first] = await startRuntimeServicesForWorkspaceControl(startInput({
serviceName: "paperclip-dev",
expose: LEGACY_HTTP_EXPOSE,
port: 45_439,
}));
const firstPort = first.port;
await stopRuntimeServicesForExecutionWorkspace({
executionWorkspaceId: EXECUTION_WORKSPACE_ID,
runtimeServiceId: first.id,
});
calls.length = 0;
const [second] = await startRuntimeServicesForWorkspaceControl(startInput({
serviceName: "paperclip-dev",
expose: LEGACY_HTTP_EXPOSE,
port: 45_439,
}));
expect(calls.slice(0, 2)).toEqual(["reserve", "expose"]);
expect(second.port).toBe(firstPort);
expect(second.url).toBe(`https://runner.tail123.ts.net:${firstPort}`);
}, 25_000);
it("releases the in-flight pair claim when hostname resolution fails, so a retry storm cannot exhaust the range", async () => {
// The reservation keeps the winning pair's in-process claim on purpose, for
// the caller to release on stop/teardown. A hostname failure throws before any
// runtime record exists, so that teardown can never run for this pair — and
// removing only the broker reservation would leave the claim held. Each retry
// would then burn another pair and the lane would report the range exhausted
// rather than the real cause, a Tailscale outage.
const reservedAppPorts: number[] = [];
const broker: BrokerClient = {
async reserve(_runtimeId, requested) {
reservedAppPorts.push(requested[0]!.port);
return { handle: HANDLE, reservedPorts: requested.map((listener) => listener.port) };
},
async expose() {
return { handle: HANDLE, publicPorts: [] };
},
async remove() {
return { removedPorts: [] };
},
async list() {
return [];
},
};
installDeps({
broker,
resolveHostname: async () => {
throw new Error("MagicDNS unavailable");
},
});
for (let attempt = 0; attempt < 3; attempt += 1) {
await expect(
startRuntimeServicesForWorkspaceControl(startInput({ serviceName: "paperclip-dev" })),
).rejects.toThrow(/MagicDNS hostname unavailable/);
}
// Every attempt reserved the same pair. A leaked claim would push each retry
// onto a fresh pair instead.
expect(reservedAppPorts).toHaveLength(3);
expect(new Set(reservedAppPorts).size).toBe(1);
}, 25_000);
});
/**
* PAP-17256: the deployed regression. A fresh managed lane on service index 0
* failed every start with `listener_ownership_mismatch` because the branch
* checkout it launched bound `0.0.0.0`, and the server only asked for loopback
* via env vars that checkout never read.
*/
describe("loopback bind is forced on the guest, not merely requested (PAP-17256)", () => {
it("starts a fresh service-index-0 lane whose guest only honours argv", async () => {
const { broker, calls } = createBroker();
installDeps({ broker });
const [runtime] = await startRuntimeServicesForWorkspaceControl(startInput({
serviceName: "paperclip-dev",
// Verbatim the command every failing lane recorded, modulo the fake guest.
command: `${guestCommand("dev-runner.mjs")} --bind lan`,
expose: LEGACY_HTTP_EXPOSE,
port: { type: "auto", envKey: "PORT" },
}));
// The launched command carries the loopback bind, replacing `--bind lan`.
expect(runtime.command).toContain("--bind loopback");
expect(runtime.command).not.toContain("--bind lan");
// And because the guest honoured it, both listeners are loopback-only, so
// the exposure completes instead of being denied.
expect(calls.slice(0, 2)).toEqual(["reserve", "expose"]);
expect(runtime.exposure?.state).toBe("ready");
expect(runtime.exposure?.lastError ?? null).toBeNull();
expect(runtime.port).toBeGreaterThanOrEqual(42_000);
expect(runtime.url).toBe(`https://runner.tail123.ts.net:${runtime.port}`);
// Independent confirmation on the live listeners, using the same /proc read
// the broker's gate performs.
const hmrPort = runtime.port! + 10_000;
expect(await diagnoseRuntimeListenerBinds([runtime.port!, hmrPort])).toBeNull();
await stopRuntimeServicesForExecutionWorkspace({
executionWorkspaceId: EXECUTION_WORKSPACE_ID,
runtimeServiceId: runtime.id,
});
expect(calls).toEqual(["reserve", "expose", "remove"]);
}, 20_000);
// This acceptance fixture inspects live Linux /proc socket tables.
it.skipIf(process.platform !== "linux")("reaches a terminal failure naming the port and address when a guest still binds the wildcard", async () => {
const { broker, calls } = createBroker();
installDeps({ broker });
// A guest with no bind flags at all: the argv rewrite cannot reach it, so
// this is the residual case that must fail loudly rather than expose.
await expect(startRuntimeServicesForWorkspaceControl(startInput({
serviceName: "paperclip-dev",
command: guestCommand("dev-runner-legacy.mjs"),
expose: LEGACY_HTTP_EXPOSE,
port: { type: "auto", envKey: "PORT" },
}))).rejects.toThrow(/listener_ownership_mismatch.*(?:0\.0\.0\.0|::)/s);
// Terminal recovery: the reservation is released and nothing was exposed.
// The diagnosis runs before the broker, so `expose` is never attempted.
expect(calls).toEqual(["reserve", "remove"]);
}, 20_000);
// This acceptance fixture inspects live Linux /proc socket tables.
it.skipIf(process.platform !== "linux")("explains rather than only coding the failure, so the next operator can act", async () => {
const { broker } = createBroker();
installDeps({ broker });
const error = await startRuntimeServicesForWorkspaceControl(startInput({
serviceName: "paperclip-dev",
command: guestCommand("dev-runner-legacy.mjs"),
expose: LEGACY_HTTP_EXPOSE,
port: { type: "auto", envKey: "PORT" },
})).then(() => null, (err: unknown) => err as Error);
expect(error).not.toBeNull();
// The bare code alone is what cost PAP-17254 three diagnostic cycles.
expect(error!.message).toContain("listener_ownership_mismatch");
expect(error!.message).toContain("loopback");
expect(error!.message).toContain("--bind loopback");
}, 20_000);
it("leaves a non-Paperclip service's --bind argument alone", async () => {
// `--bind` means something entirely different to the HTTPS probe canaries
// (`python3 -m http.server --bind 127.0.0.1`); rewriting it would break them.
const { broker, calls } = createBroker();
installDeps({ broker });
const declared = `${serviceCommand()} -- --bind 127.0.0.1`;
const [runtime] = await startRuntimeServicesForWorkspaceControl(startInput({
serviceName: "https-probe-canary",
command: declared,
port: { type: "auto", envKey: "PORT" },
}));
expect(runtime.command).toBe(declared);
expect(runtime.command).not.toContain("--bind loopback");
expect(calls.slice(0, 2)).toEqual(["reserve", "expose"]);
expect(runtime.exposure?.state).toBe("ready");
}, 20_000);
it("does not rewrite a Paperclip dev command when the service is not exposed", async () => {
const { broker, calls } = createBroker();
installDeps({ broker });
const declared = `${guestCommand("dev-runner.mjs")} --bind lan`;
const [runtime] = await startRuntimeServicesForWorkspaceControl(startInput({
serviceName: "paperclip-dev",
command: declared,
expose: { ...LEGACY_HTTP_EXPOSE, tailscaleHttps: false },
// This guest opens a second listener at appPort + 10000. An arbitrary
// ephemeral app port can overflow the valid TCP port range.
port: await findFreeExposureAppPort(RUNTIME_EXPOSURE_APP_PORT_MIN),
}));
expect(calls).toEqual([]);
expect(runtime.command).toBe(declared);
}, 20_000);
it("surfaces a deployment/bind conflict from a guest that exits during startup", async () => {
const { broker } = createBroker();
installDeps({ broker });
await expect(startRuntimeServicesForWorkspaceControl(startInput({
serviceName: "paperclip-dev",
command: guestCommand("dev-runner-bind-conflict.mjs"),
expose: LEGACY_HTTP_EXPOSE,
port: { type: "auto", envKey: "PORT" },
}))).rejects.toThrow(
/deployment\/bind conflict: local_trusted requires server\.bind=loopback.*output: local_trusted requires server\.bind=loopback/s,
);
}, 20_000);
});
describe("readiness probes loopback for an exposed runtime (PAP-17256)", () => {
it("starts even when the only readiness target is the MagicDNS display URL", async () => {
// The live project config declares a loopback readiness URL, but when it does
// not, readiness falls back to `expose.urlTemplate` — a MagicDNS name that
// resolves off-loopback. That only ever answered because the guest was bound
// to the wildcard, so it must be normalised alongside the bind fix.
const { broker, calls } = createBroker();
installDeps({ broker });
const input = startInput({
serviceName: "paperclip-dev",
command: `${guestCommand("dev-runner.mjs")} --bind lan`,
expose: LEGACY_HTTP_EXPOSE,
port: { type: "auto", envKey: "PORT" },
});
// Drop the explicit loopback readiness URL so the fallback path is exercised.
const service = input.config.workspaceRuntime.services[0] as Record<string, unknown>;
service.readiness = { type: "http", timeoutSec: 10, intervalMs: 100 };
const [runtime] = await startRuntimeServicesForWorkspaceControl(input);
expect(calls.slice(0, 2)).toEqual(["reserve", "expose"]);
expect(runtime.exposure?.state).toBe("ready");
expect(runtime.url).toBe(`https://runner.tail123.ts.net:${runtime.port}`);
}, 20_000);
});
describe("the deployed failure shape: loopback app port, wildcard HMR (PAP-17256)", () => {
// This acceptance fixture inspects live Linux /proc socket tables.
it.skipIf(process.platform !== "linux")("fails terminally naming the HMR port, because forcing the bind cannot reach Vite's own listener", async () => {
// Plain master's app.ts passes Vite `hmr.port` without `hmr.server` or
// `server.host`, so the HMR websocket binds `::` no matter what the bind mode
// is. The argv rewrite fixes the app port; only the preflight catches this.
const { broker, calls } = createBroker();
installDeps({ broker });
const error = await startRuntimeServicesForWorkspaceControl(startInput({
serviceName: "paperclip-dev",
command: `${guestCommand("dev-runner-wildcard-hmr.mjs")} --bind lan`,
expose: LEGACY_HTTP_EXPOSE,
port: { type: "auto", envKey: "PORT" },
})).then(() => null, (err: unknown) => err as Error);
expect(error).not.toBeNull();
expect(error!.message).toContain("listener_ownership_mismatch");
// The app port obeyed the forced bind; the HMR companion is the offender, and
// the diagnosis has to say so rather than blaming the lane as a whole.
expect(error!.message).toMatch(/port 5\d{4} is bound to/);
expect(error!.message).not.toMatch(/port 4\d{4} is bound to/);
expect(calls).toEqual(["reserve", "remove"]);
}, 20_000);
});
describe.each([false, true])("guest exposure-port collision reporting (base pair occupied: %s)", (basePairOccupied) => {
// The quarantine decision itself is unit-tested through
// `classifyExposureHostCollisions` below. A deterministic end-to-end quarantine
// test is not reachable here: a real host listener that holds the assigned port
// is intercepted earlier, either by the pre-spawn ownership guard or by the
// allocated-port bind wait, before the EADDRINUSE-text quarantine branch runs.
it("does not quarantine the pair when the guest fabricates an assigned-port EADDRINUSE with no host listener", async () => {
const { broker } = createBroker();
const reservedAppPorts: number[] = [];
const recordingBroker: BrokerClient = {
...broker,
async reserve(runtimeId, requested) {
reservedAppPorts.push(requested[0]!.port);
return broker.reserve(runtimeId, requested);
},
};
installDeps({
broker: recordingBroker,
isPortAvailable: (port) => basePairOccupied &&
[RUNTIME_EXPOSURE_APP_PORT_MIN, deriveViteHmrPort(RUNTIME_EXPOSURE_APP_PORT_MIN)].includes(port)
? Promise.resolve(false) : isLoopbackPortFree(port),
});
const logs: string[] = [];
const error = await startRuntimeServicesForWorkspaceControl({
...startInput({
serviceName: "paperclip-dev",
command: `${guestCommand("dev-runner-eaddrinuse-synthetic.mjs")} --bind lan`,
expose: LEGACY_HTTP_EXPOSE,
port: { type: "auto", envKey: "PORT" },
}),
onLog: async (_stream, chunk) => {
logs.push(chunk);
},
}).then(() => null, (err: unknown) => err as Error);
// The assigned pair is free, so the printed EADDRINUSE line is unverified.
// The start fails terminally after ONE allocation and never burns the pool.
expect(error).not.toBeNull();
expect(error!.message).toContain(String(reservedAppPorts[0]));
expect(error!.message).toContain("not verified");
expect(reservedAppPorts).toHaveLength(1);
expect(reservedAppPorts[0]).toBeGreaterThanOrEqual(RUNTIME_EXPOSURE_APP_PORT_MIN + (basePairOccupied ? 1 : 0));
expect(reservedAppPorts[0]).toBeLessThanOrEqual(RUNTIME_EXPOSURE_APP_PORT_MAX);
// No quarantine and no re-allocation happened for the unverified claim.
const diagnosis = logs.join("");
expect(diagnosis).not.toContain("Quarantined pair");
expect(diagnosis).not.toContain("collided during startup");
}, 25_000);
it("does not quarantine the pair for an EADDRINUSE on an unrelated auxiliary port", async () => {
const { broker } = createBroker();
const reservedAppPorts: number[] = [];
const recordingBroker: BrokerClient = {
...broker,
async reserve(runtimeId, requested) {
reservedAppPorts.push(requested[0]!.port);
return broker.reserve(runtimeId, requested);
},
};
installDeps({
broker: recordingBroker,
isPortAvailable: (port) => basePairOccupied &&
[RUNTIME_EXPOSURE_APP_PORT_MIN, deriveViteHmrPort(RUNTIME_EXPOSURE_APP_PORT_MIN)].includes(port)
? Promise.resolve(false) : isLoopbackPortFree(port),
});
const logs: string[] = [];
const error = await startRuntimeServicesForWorkspaceControl({
...startInput({
serviceName: "paperclip-dev",
command: `${guestCommand("dev-runner-eaddrinuse-auxiliary.mjs")} --bind lan`,
expose: LEGACY_HTTP_EXPOSE,
port: { type: "auto", envKey: "PORT" },
}),
onLog: async (_stream, chunk) => {
logs.push(chunk);
},
}).then(() => null, (err: unknown) => err as Error);
// The failure names an unrelated port, so the assigned pair is not a
// collision. The start fails terminally after ONE allocation, and never
// burns the bounded retries on a valid pair.
expect(error).not.toBeNull();
expect(error!.message).toContain("39999");
expect(reservedAppPorts).toHaveLength(1);
expect(reservedAppPorts[0]).toBeGreaterThanOrEqual(RUNTIME_EXPOSURE_APP_PORT_MIN + (basePairOccupied ? 1 : 0));
expect(reservedAppPorts[0]).toBeLessThanOrEqual(RUNTIME_EXPOSURE_APP_PORT_MAX);
// No quarantine and no re-allocation happened for the auxiliary conflict.
const diagnosis = logs.join("");
expect(diagnosis).not.toContain("Quarantined pair");
expect(diagnosis).not.toContain("collided during startup");
}, 25_000);
it("does not quarantine when an auxiliary EADDRINUSE mixes with a benign assigned-port line", async () => {
const { broker } = createBroker();
const reservedAppPorts: number[] = [];
const recordingBroker: BrokerClient = {
...broker,
async reserve(runtimeId, requested) {
reservedAppPorts.push(requested[0]!.port);
return broker.reserve(runtimeId, requested);
},
};
installDeps({
broker: recordingBroker,
isPortAvailable: (port) => basePairOccupied &&
[RUNTIME_EXPOSURE_APP_PORT_MIN, deriveViteHmrPort(RUNTIME_EXPOSURE_APP_PORT_MIN)].includes(port)
? Promise.resolve(false) : isLoopbackPortFree(port),
});
const logs: string[] = [];
const error = await startRuntimeServicesForWorkspaceControl({
...startInput({
serviceName: "paperclip-dev",
command: `${guestCommand("dev-runner-eaddrinuse-auxiliary-mixed.mjs")} --bind lan`,
expose: LEGACY_HTTP_EXPOSE,
port: { type: "auto", envKey: "PORT" },
}),
onLog: async (_stream, chunk) => {
logs.push(chunk);
},
}).then(() => null, (err: unknown) => err as Error);
// The assigned port appears on a benign line, but EADDRINUSE names only
// the auxiliary port 39999. The parser matches the error and the port on the
// same line, so the assigned pair is not a collision. The start fails
// terminally after ONE allocation and never quarantines the valid pair.
expect(error).not.toBeNull();
expect(error!.message).toContain("39999");
expect(reservedAppPorts).toHaveLength(1);
expect(reservedAppPorts[0]).toBeGreaterThanOrEqual(RUNTIME_EXPOSURE_APP_PORT_MIN + (basePairOccupied ? 1 : 0));
expect(reservedAppPorts[0]).toBeLessThanOrEqual(RUNTIME_EXPOSURE_APP_PORT_MAX);
const diagnosis = logs.join("");
expect(diagnosis).not.toContain("Quarantined pair");
expect(diagnosis).not.toContain("collided during startup");
}, 25_000);
});
describe("classifyExposureHostCollisions gates quarantine on verified host state", () => {
const state = (over: Partial<ExposurePortHostState> & { port: number }): ExposurePortHostState => ({
named: false,
listenerPresent: false,
ownerPid: null,
ownerProcessGroupId: null,
...over,
});
it("reports a host collision when a named port has a present listener owned by another process", () => {
const result = classifyExposureHostCollisions({
childPid: 4242,
ports: [
state({ port: 42_000, named: true, listenerPresent: true, ownerPid: 9999 }),
state({ port: 52_000, named: false, listenerPresent: false, ownerPid: null }),
],
});
expect(result).toEqual({ hostCollisionPorts: [42_000], hostCollision: true });
});
it("treats a present listener with an unknown owner as a host collision", () => {
// /proc proves a listener, and a guest that lost its assigned port does not
// hold it, so an unknown owner still counts as the host.
const result = classifyExposureHostCollisions({
childPid: 4242,
ports: [state({ port: 42_000, named: true, listenerPresent: true, ownerPid: null })],
});
expect(result).toEqual({ hostCollisionPorts: [42_000], hostCollision: true });
});
it("does not report a collision when the named port has no listener", () => {
// A synthetic EADDRINUSE line with no host listener behind it. Quarantine here
// would drain the shared exposure-port pool across repeated starts.
const result = classifyExposureHostCollisions({
childPid: 4242,
ports: [state({ port: 42_000, named: true, listenerPresent: false, ownerPid: null })],
});
expect(result).toEqual({ hostCollisionPorts: [], hostCollision: false });
});
it("does not report a collision when the guest itself owns the present listener", () => {
// The guest bound and holds its own port, so this is not a host collision.
const result = classifyExposureHostCollisions({
childPid: 4242,
ports: [state({ port: 42_000, named: true, listenerPresent: true, ownerPid: 4242 })],
});
expect(result).toEqual({ hostCollisionPorts: [], hostCollision: false });
});
it("does not report a collision when a guest descendant owns the present listener", () => {
// The runtime launches the guest as a shell process group leader (pid 4242).
// The real dev server binds the port from a descendant (pid 9999) that shares
// the shell process group. The owner pid differs from the shell pid, but the
// owner process group id matches it, so this is the guest, not the host. A raw
// pid equality would quarantine this valid pair until the shared pool drains.
const result = classifyExposureHostCollisions({
childPid: 4242,
ports: [
state({
port: 42_000,
named: true,
listenerPresent: true,
ownerPid: 9999,
ownerProcessGroupId: 4242,
}),
],
});
expect(result).toEqual({ hostCollisionPorts: [], hostCollision: false });
});
it("reports a host collision when the owner and its process group are both external", () => {
// A different process group holds the port, so neither the shell pid nor the
// process group matches. This is a real external owner and quarantine is right.
const result = classifyExposureHostCollisions({
childPid: 4242,
ports: [
state({
port: 42_000,
named: true,
listenerPresent: true,
ownerPid: 9999,
ownerProcessGroupId: 8888,
}),
],
});
expect(result).toEqual({ hostCollisionPorts: [42_000], hostCollision: true });
});
it("ignores a present listener on a port the failure text did not name", () => {
// An auxiliary-port conflict leaves the assigned pair valid.
const result = classifyExposureHostCollisions({
childPid: 4242,
ports: [state({ port: 42_000, named: false, listenerPresent: true, ownerPid: 9999 })],
});
expect(result).toEqual({ hostCollisionPorts: [], hostCollision: false });
});
});