Files
SnapOtter/tests/unit/api/capture-path.test.ts
T
SnapOtterandGitHub b457596649 fix(telemetry): sharpen Sentry signal for v2.1.0 residual defects (#498)
Follow-ups to the v2.1.0 Sentry telemetry overhaul, found by reviewing live release:2.1.0 events:

- error_code tag was empty because reportError read only the top-level err.code; add extractErrorCode() to walk the cause chain (pg SQLSTATE, node E-code, else first short code).
- InputValidationError from a tool's processV2 in the worker was logged as error_class=bug; classify it as expected for any source. Worker-side ZodError stays a bug (schema drift).
- AI dispatcher timeouts rejected with a bare Error, which the sanitizer scrubbed to a message-less "Error: Error"; reject with an operational SafeError (code "timeout") at both timeout sites.

Each fix written failing-test-first; affected and adjacent unit suites green plus full CI (integration + e2e).
2026-07-11 16:18:26 +08:00

75 lines
2.9 KiB
TypeScript

/**
* Regression guard for the single deliberate Sentry capture path.
*
* Before the overhaul a failed tool job was captured twice (processToolJob
* catch + worker.on("failed")) and wrapped in new Error(String(err)), which
* produced frameless events. These tests pin the contract: one reportError
* call yields exactly one captureException with the ORIGINAL error object,
* and the throttle allows one capture per distinct signature.
*/
import { beforeEach, describe, expect, it, vi } from "vitest";
import { reportError, resetThrottleForTests } from "../../../apps/api/src/lib/error-report.js";
const h = vi.hoisted(() => {
const scope = { setTag: vi.fn(), setLevel: vi.fn(), setFingerprint: vi.fn() };
return {
scope,
captureException: vi.fn(),
withScope: vi.fn((cb: (s: typeof scope) => unknown) => cb(scope)),
};
});
vi.mock("@sentry/node", () => ({
captureException: h.captureException,
withScope: h.withScope,
}));
vi.mock("../../../apps/api/src/lib/analytics-gate.js", () => ({
analyticsEnabled: () => true,
}));
beforeEach(() => {
resetThrottleForTests();
vi.clearAllMocks();
});
describe("capture path", () => {
it("a single worker-failure reportError yields exactly one capture, unwrapped, tagged", async () => {
const boom = new Error("boom");
await reportError(boom, { source: "worker", pool: "image" });
expect(h.captureException).toHaveBeenCalledTimes(1);
// The original object flows through: no new Error(String(err)) wrapping,
// so stacks, codes, and marker properties survive.
expect(h.captureException).toHaveBeenCalledWith(boom);
expect(h.scope.setTag).toHaveBeenCalledWith("source", "worker");
expect(h.scope.setTag).toHaveBeenCalledWith("pool", "image");
});
it("tags error_code from a code nested in the cause chain, not just the top level", async () => {
// pg/undici bury the real code under a drizzle/wrapper Error whose own
// .code is undefined; reading only the top level left error_code empty.
const pg = Object.assign(new Error("password authentication failed"), {
code: "28P01",
severity: "FATAL",
});
const wrapped = Object.assign(new Error("Failed query: select 1"), { cause: pg });
await reportError(wrapped, { source: "worker", pool: "docs" });
expect(h.captureException).toHaveBeenCalledTimes(1);
expect(h.scope.setTag).toHaveBeenCalledWith("error_code", "28P01");
});
it("captures once per distinct signature; operational repeats are throttled", async () => {
const full = Object.assign(new Error("disk full"), { code: "ENOSPC" });
await reportError(full, { source: "worker", pool: "image" });
await reportError(full, { source: "worker", pool: "image" });
expect(h.captureException).toHaveBeenCalledTimes(1);
const denied = Object.assign(new Error("denied"), { code: "EACCES" });
await reportError(denied, { source: "worker", pool: "image" });
expect(h.captureException).toHaveBeenCalledTimes(2);
});
});