mirror of
https://github.com/software-mansion/argent.git
synced 2026-09-14 19:27:14 +08:00
8483fe23f9
## Summary Adds anonymous, opt-out telemetry for Argent installer, update/uninstall flows, CLI telemetry controls, tool-server lifecycle, and tool invocation health signals. ## What Changed - Added a new private `@argent/telemetry` package - Introduced typed telemetry events with runtime property allowlisting/sanitization. - Added lazy anonymous identity creation in `~/.argent/telemetry-id`. - Added consent handling via: `argent telemetry enable`, `argent telemetry disable`, `argent telemetry status` - Added local debug logging with `ARGENT_TELEMETRY_DEBUG=1`. - Tracks installer funnel events for init, global install/update decisions, editor selection, allowlist decisions, skill installation, rules/agents copy, update, and uninstall. - Tracks tool-server start/stop and tool invocation/complete/fail events. - Adds per-tool invocation IDs so request metadata can be correlated without relying on ordering. - Records only coarse platform metadata (`ios` / `android`) for device tools - Ensures short-lived commands drain telemetry with bounded shutdown before exit. - Wires telemetry package into bundling and injects full Argent CLI version metadata at build time. - Added central `FAILURE_CODES` and `FailureSignal` helpers in `@argent/registry`. - Attached structured, sanitized failure metadata across registry errors, tool-server tools/services, HTTP validation/dependency gates, installer flows, and `argent run`. - Added telemetry allowlisting for safe failure fields only: static error codes/stages, coarse area/kind/command, bounded exit codes, allowlisted signals/spawn codes, and coarse network failure classes. - Split CLI-local `argent run` failures into `cli:run_fail` so they are not double-counted as tool failures. - Added installer telemetry for failed package actions, update/uninstall failures, rules/agents copy results, and skill refresh results. - Made telemetry consent writes atomic and kept telemetry status side-effect free via `peekAnonId()`. - Adds a coarse, anonymous signal to tool telemetry: which AI coding tool is driving the MCP server (Claude Code, Codex, Cursor, Gemini, VS Code, Windsurf, Zed, opencode, Copilot, or other). ## Tests Added / Updated - Telemetry unit coverage for consent precedence, identity creation, base props, sanitization, PostHog config, debug logging, shutdown, opt-out, and forget behavior. - Registry/tool-server tests for invocation IDs, platform metadata boundaries, startup failure flushing, and tool lifecycle telemetry. - Installer tests for final telemetry drain, update action classification, and uninstall identity cleanup ordering. --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
40 lines
1.1 KiB
TypeScript
40 lines
1.1 KiB
TypeScript
import { describe, expect, it, vi, beforeEach } from "vitest";
|
|
import { finalizeTelemetry } from "../src/telemetry-finalize.js";
|
|
|
|
const telemetryMock = vi.hoisted(() => ({
|
|
shutdown: vi.fn().mockResolvedValue(undefined),
|
|
}));
|
|
|
|
vi.mock("@argent/telemetry", () => telemetryMock);
|
|
|
|
describe("finalizeTelemetry", () => {
|
|
beforeEach(() => {
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
it("captures the final event and drains telemetry", async () => {
|
|
const capture = vi.fn();
|
|
|
|
await finalizeTelemetry(capture);
|
|
|
|
expect(capture).toHaveBeenCalledOnce();
|
|
expect(telemetryMock.shutdown).toHaveBeenCalledOnce();
|
|
});
|
|
|
|
it("still drains when final capture throws", async () => {
|
|
const capture = vi.fn(() => {
|
|
throw new Error("capture failed");
|
|
});
|
|
|
|
await expect(finalizeTelemetry(capture)).resolves.toBeUndefined();
|
|
|
|
expect(telemetryMock.shutdown).toHaveBeenCalledOnce();
|
|
});
|
|
|
|
it("swallows shutdown failures", async () => {
|
|
telemetryMock.shutdown.mockRejectedValueOnce(new Error("network timeout"));
|
|
|
|
await expect(finalizeTelemetry(vi.fn())).resolves.toBeUndefined();
|
|
});
|
|
});
|