Files
software-mansion__argent/packages/tool-server/test/debugger/metro-cdp-harness.ts
filip131311 4975ff490c fix(debugger): cut debugger tool fail rate — structured not-connected results, classified CDP failures, narrow recovery (#610)
## Why

PostHog (30d) shows the debugger tool family is argent's least reliable
surface:

| tool | fail rate | dominant causes |
|---|---|---|
| `debugger-status` | **37%** | METRO_NO_TARGETS /
SERVICE_INITIALIZATION_FAILED / zod |
| `debugger-connect` | **24%** | SERVICE_INITIALIZATION_FAILED (~7k, >1k
users), METRO_NO_TARGETS |
| `debugger-log-registry` | 41.7% raw / 4.2% excl. storms | one user
retry-looped it **12,742×** on NO_TARGETS |

Three design issues drive this: (1) "app/Metro not ready yet" — an
expected precondition — is reported as a tool *error*, which both
inflates fail rates and invites agent retry storms; (2) every CDP
init/lifecycle fault lands in telemetry as the catch-all
`REGISTRY_SERVICE_INITIALIZATION_FAILED` with `error_kind=unknown`; (3)
~600 users/30d hit zod validation failures with zero visibility into
which parameter was wrong.

## What

**1. Classified failures** (`d71efa43`) — six former plain-`Error` sites
in `cdp-client.ts` / `target-selection.ts` now carry dedicated
`DEBUGGER_CDP_*` / `DEBUGGER_TARGET_DEVICE_MISMATCH` signals (messages
byte-identical). The registry's two causeless "terminating window"
`ServiceInitializationError`s get their own
`REGISTRY_SERVICE_TERMINATING` code.

**2. Narrow recovery** (`ff9c1955`) — `recoverable()` on both debugger
blueprints, scoped to windows where retry is provably safe: Metro
recovers only `DEBUGGER_CDP_NOT_CONNECTED` (request never left the host;
a detected socket death already self-heals for the *next* call via the
terminated cascade — recovering `CONNECTION_CLOSED` there would be dead
code, see the blueprint comment). Chromium also recovers
`CONNECTION_CLOSED` for the tab-switch reconnect window.
`REQUEST_TIMEOUT` stays unrecoverable (double-execution risk). A
reachability test proves the retry actually fires for a RUNNING node.

**3. Structured not-connected results** (`48b91ffd`) — `debugger-status`
and `debugger-log-registry` become factories that return `{ status:
"not_connected", reason, detail, guidance }` for classified
preconditions (`metro_not_running | no_app_connected | device_mismatch |
cdp_unreachable | stale_connection | reconnecting`) and still throw on
unexpected faults. `detail` preserves the original error text for
string-matching agents. `debugger-status` gains a socket-state gate
(Metro: dispose stale node; Chromium: report transient reconnect, no
dispose — the client belongs to the ChromiumCdp dependency).
log-registry keeps **no** gate on purpose: captured logs are readable
over a dead socket, and disposal would destroy the post-crash log file.
Flows/run-sequence map a not_connected result to a **failed step**
(mirrors `isUnmetUiWaitResult`) so recorded connectivity gates don't
silently pass. `debugger-evaluate` re-codes agent-expression throws as
`DEBUGGER_EVALUATE_EXPRESSION_THREW`.

**4. Telemetry + guidance + docs** (`7602a70d`) —
`tool:fail.invalid_params` (schema-declared names only; unknown keys →
literal `"unrecognized_keys"`; capped emit-side at 16), new
`debugger:tool_outcome` event (coded enum; joins
`tool:invoke`/`complete` via `tool_invocation_id` —
`ai_client`/`duration` live on the joined row), anti-retry-loop guidance
appended to the Metro discovery errors (first sentences verbatim —
skills match on them), six skills updated, Telemetry.md bumped to v1.03
with the new coded diagnostics disclosed.

## Dashboard migration note

`debugger-status` / `debugger-log-registry` precondition failures stop
emitting `tool:fail` — track them via `debugger:tool_outcome` (`outcome
!= 'connected'`). Per-AI-client breakdowns of those outcomes need a join
on `tool_invocation_id` against `tool:complete`.

## Testing

- Full suites green: tool-server 3,142, telemetry 290, registry 87. New
coverage: recoverable truth tables (incl. non-Error inputs), status
not-connected matrix
(Metro/Chromium/terminating-window/stale/dispose-side-effect/fall-through-rethrow),
log-registry rows, zod `invalid_params` derivation + emission-level
guard, flow gate, evaluate rewrap, sanitize-level enum checks.
- Live-tested against a booted iOS simulator + RN app and an Electron
target (details in PR comments).

Plan hardened through 3 adversarial review rounds (46 confirmed findings
addressed) before implementation.

🤖 Generated with [Claude Code](https://claude.com/claude-code)
2026-08-10 11:51:45 +02:00

101 lines
3.2 KiB
TypeScript

import { WebSocketServer } from "ws";
import * as http from "node:http";
import { AddressInfo } from "node:net";
/** A TCP port that (was just proven to be bindable and) now has no listener. */
export async function freePort(): Promise<number> {
return new Promise<number>((resolve) => {
const srv = http.createServer();
srv.listen(0, "127.0.0.1", () => {
const port = (srv.address() as AddressInfo).port;
srv.close(() => resolve(port));
});
});
}
export interface MockMetroCdp {
port: number;
close: () => Promise<void>;
}
/**
* Mock Metro HTTP + CDP WebSocket target, the minimum wire behavior the
* JsRuntimeDebugger connect pipeline needs (same protocol surface as
* test/metro/integration.test.ts): /status, /json/list with one Fusebox
* target, and a CDP socket that ACKs every method (Debugger.enable also emits
* a scriptParsed; Runtime.evaluate answers a string so the addBinding probe
* sees the binding as installed).
*/
export async function startMockMetroCdp(opts?: {
/** Advertise this logicalDeviceId on the single target (default: none). */
logicalDeviceId?: string;
}): Promise<MockMetroCdp> {
let port = 0;
const server = http.createServer((req, res) => {
if (req.url === "/status") {
res.setHeader("X-React-Native-Project-Root", "/mock/project");
res.end("packager-status:running");
return;
}
if (req.url === "/json/list") {
res.setHeader("Content-Type", "application/json");
res.end(
JSON.stringify([
{
id: "page-1",
title: "React Native (mock)",
description: "[C++ connection]",
webSocketDebuggerUrl: `ws://localhost:${port}/inspector/debug?device=0&page=1`,
deviceName: "MockDevice",
reactNative: {
capabilities: { prefersFuseboxFrontend: true },
...(opts?.logicalDeviceId ? { logicalDeviceId: opts.logicalDeviceId } : {}),
},
},
])
);
return;
}
res.statusCode = 404;
res.end();
});
const wss = new WebSocketServer({ server });
wss.on("connection", (ws) => {
ws.on("message", (raw) => {
const msg = JSON.parse(raw.toString());
if (msg.method === "Debugger.enable") {
ws.send(JSON.stringify({ id: msg.id, result: { debuggerId: "mock-debugger" } }));
ws.send(
JSON.stringify({
method: "Debugger.scriptParsed",
params: {
scriptId: "1",
url: "http://localhost/index.bundle?platform=ios&dev=true",
startLine: 0,
endLine: 50000,
},
})
);
return;
}
if (msg.method === "Runtime.evaluate") {
ws.send(
JSON.stringify({ id: msg.id, result: { result: { type: "string", value: "mock" } } })
);
return;
}
ws.send(JSON.stringify({ id: msg.id, result: {} }));
});
});
await new Promise<void>((resolve) => server.listen(0, () => resolve()));
port = (server.address() as AddressInfo).port;
return {
port,
close: () =>
new Promise((resolve) => {
for (const c of wss.clients) c.close();
wss.close(() => server.close(() => resolve()));
}),
};
}