mirror of
https://github.com/software-mansion/argent.git
synced 2026-09-14 19:27:14 +08:00
4975ff490c
## 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)
98 lines
3.5 KiB
TypeScript
98 lines
3.5 KiB
TypeScript
import { describe, it, expect } from "vitest";
|
|
import { FAILURE_CODES, FailureError, getFailureSignal } from "@argent/registry";
|
|
import { debuggerEvaluateTool } from "../../src/tools/debugger/debugger-evaluate";
|
|
import type { JsRuntimeDebuggerApi } from "../../src/blueprints/js-runtime-debugger";
|
|
|
|
/**
|
|
* Step 7: an agent-supplied expression THROWING inside the runtime is not a CDP
|
|
* malfunction — the evaluate round-trip worked. The tool must re-code
|
|
* DEBUGGER_CDP_RUNTIME_EXCEPTION as DEBUGGER_EVALUATE_EXPRESSION_THREW so
|
|
* telemetry can separate "agent's JS threw" from genuine CDP faults, while
|
|
* preserving the message (with the JS stack the agent needs) byte-for-byte.
|
|
*/
|
|
|
|
const RUNTIME_EXCEPTION_MESSAGE =
|
|
"Error: x\n at <anonymous> (http://localhost:8081/index.bundle:1:7)";
|
|
|
|
function makeServices(evaluateImpl: () => Promise<unknown>) {
|
|
return {
|
|
debugger: {
|
|
cdp: { evaluate: evaluateImpl },
|
|
deviceName: "MockDevice",
|
|
appName: "MockApp",
|
|
logicalDeviceId: "aaa",
|
|
} as unknown as JsRuntimeDebuggerApi,
|
|
};
|
|
}
|
|
|
|
describe("debugger-evaluate runtime-exception rewrap", () => {
|
|
it("rewraps RUNTIME_EXCEPTION as EVALUATE_EXPRESSION_THREW — outer signal wins, message identical", async () => {
|
|
const inner = new FailureError(RUNTIME_EXCEPTION_MESSAGE, {
|
|
error_code: FAILURE_CODES.DEBUGGER_CDP_RUNTIME_EXCEPTION,
|
|
failure_stage: "debugger_cdp_evaluate",
|
|
failure_area: "tool_server",
|
|
error_kind: "unknown",
|
|
});
|
|
const services = makeServices(() => Promise.reject(inner));
|
|
|
|
let thrown: unknown;
|
|
try {
|
|
await debuggerEvaluateTool.execute(services, {
|
|
port: 8081,
|
|
device_id: "dev",
|
|
expression: 'throw new Error("x")',
|
|
});
|
|
} catch (err) {
|
|
thrown = err;
|
|
}
|
|
|
|
expect(thrown).toBeInstanceOf(FailureError);
|
|
// getFailureSignal walks the cause chain breadth-first: the OUTER
|
|
// rewrapped signal must win over the inner RUNTIME_EXCEPTION.
|
|
expect(getFailureSignal(thrown)).toMatchObject({
|
|
error_code: FAILURE_CODES.DEBUGGER_EVALUATE_EXPRESSION_THREW,
|
|
failure_stage: "debugger_evaluate_expression",
|
|
failure_area: "tool_server",
|
|
});
|
|
// Message preserved verbatim — the JS stack is the agent's payload.
|
|
expect((thrown as Error).message).toBe(RUNTIME_EXCEPTION_MESSAGE);
|
|
// The original error stays reachable as the cause.
|
|
expect((thrown as Error).cause).toBe(inner);
|
|
});
|
|
|
|
it("does NOT rewrap other CDP faults — NOT_CONNECTED passes through untouched", async () => {
|
|
const inner = new FailureError("CDP not connected", {
|
|
error_code: FAILURE_CODES.DEBUGGER_CDP_NOT_CONNECTED,
|
|
failure_stage: "debugger_cdp_send",
|
|
failure_area: "tool_server",
|
|
error_kind: "network",
|
|
});
|
|
const services = makeServices(() => Promise.reject(inner));
|
|
|
|
let thrown: unknown;
|
|
try {
|
|
await debuggerEvaluateTool.execute(services, {
|
|
port: 8081,
|
|
device_id: "dev",
|
|
expression: "1 + 1",
|
|
});
|
|
} catch (err) {
|
|
thrown = err;
|
|
}
|
|
|
|
// Identity, not just code: the rewrap path must not touch this error.
|
|
expect(thrown).toBe(inner);
|
|
});
|
|
|
|
it("returns the evaluation result unchanged when nothing throws", async () => {
|
|
const services = makeServices(() => Promise.resolve(42));
|
|
const result = (await debuggerEvaluateTool.execute(services, {
|
|
port: 8081,
|
|
device_id: "dev",
|
|
expression: "40 + 2",
|
|
})) as Record<string, unknown>;
|
|
expect(result.result).toBe(42);
|
|
expect(result.deviceName).toBe("MockDevice");
|
|
});
|
|
});
|