Files
SnapOtter/tests/unit/web/sentry-scrub.test.ts
T
SnapOtterandGitHub e1b8c24e5d feat(analytics): instance census, full capture, richer error context (#511)
Add a once-per-boot instance_started event (arch, os, deploy_mode,
gpu_present) so the fleet architecture mix is measurable. It reuses the
existing per-instance instance_id and is exempt from the volume sample
rate, since a census that fires once per boot must not be thinned.

Restore useful capture depth now that the sponsored plan removes the
quota pressure behind the earlier hardening:

- PostHog sample rate 0.1 to 1.0 (full analytics when enabled); the
  property allowlist still blocks file data.
- Sentry per-instance ceiling 20 to 500/hr, breadcrumb trail restored
  (sanitized: urls/paths redacted, data payloads dropped), full stack
  paths kept; local vars, request bodies, and PII still dropped. Both
  api and web.

Honor ANALYTICS_ENABLED=false as an opt-out alias: it was documented on
the Docker Hub README but never wired in 2.x, so anyone who set it was
still tracked.

All capture stays behind the analytics opt-out gate.
2026-07-13 14:23:16 +08:00

110 lines
4.2 KiB
TypeScript

import { describe, expect, it } from "vitest";
import {
buildWebBeforeSend,
DENY_URLS,
IGNORE_ERRORS,
scrubBrowserMessage,
} from "@/lib/sentry-scrub";
describe("scrubBrowserMessage", () => {
it("keeps browser-native messages with urls/paths redacted", () => {
expect(scrubBrowserMessage("TypeError", "Failed to fetch https://intra.host/x?q=1")).toBe(
"Failed to fetch <url>",
);
expect(scrubBrowserMessage("TypeError", "cannot read /Users/bob/file.png")).toBe(
"cannot read <path>",
);
expect(scrubBrowserMessage("RangeError", "Invalid array length")).toBe("Invalid array length");
});
it("redacts blob urls and windows paths", () => {
expect(scrubBrowserMessage("DOMException", "load blob:http://x/abc failed")).toBe(
"load <blob> failed",
);
expect(scrubBrowserMessage("TypeError", "open C:\\Users\\bob\\tax.pdf")).toBe("open <path>");
});
it("drops messages for non-native error names", () => {
expect(scrubBrowserMessage("CustomerDataError", "contains secret.pdf")).toBeNull();
});
});
describe("static filter lists", () => {
it("deny extension frames and ignore noisy network errors", () => {
expect(DENY_URLS.some((re) => re.test("chrome-extension://abcdef/content.js"))).toBe(true);
expect(DENY_URLS.some((re) => re.test("moz-extension://abcdef/content.js"))).toBe(true);
expect(IGNORE_ERRORS).toContain("Failed to fetch");
expect(IGNORE_ERRORS).toContain("Load failed");
});
});
describe("buildWebBeforeSend", () => {
const baseEvent = (over: Record<string, any> = {}): Record<string, any> => ({
request: { url: "http://192.168.0.4:1349/image/resize" },
breadcrumbs: [{}],
user: { id: "x" },
contexts: { react: { componentStack: "at ToolPage" }, device: { name: "leak" } },
exception: {
values: [
{
type: "TypeError",
value: "secret /Users/a/b",
stacktrace: { frames: [{ filename: "http://192.168.0.4:1349/assets/app.js" }] },
},
],
},
tags: { tool_id: "resize", drop_me: "x" },
...over,
});
it("gates, strips, keeps react componentStack, redacts values", () => {
const send = buildWebBeforeSend(() => true);
const out = send(baseEvent(), { originalException: new TypeError("boom /Users/a/b") })!;
expect(out.request).toBeUndefined();
expect(out.user).toBeUndefined();
expect(out.contexts.react.componentStack).toBe("at ToolPage");
expect(out.contexts.device).toBeUndefined();
expect(out.exception.values[0].value).toBe("boom <path>");
expect(out.exception.values[0].stacktrace.frames[0].filename).toBe("/assets/app.js");
expect(out.tags.tool_id).toBe("resize");
expect(out.tags.drop_me).toBeUndefined();
expect(buildWebBeforeSend(() => false)(baseEvent(), {})).toBeNull();
});
it("keeps the breadcrumb trail, redacting paths/urls and dropping data payloads", () => {
const send = buildWebBeforeSend(() => true);
const out = send(
baseEvent({
breadcrumbs: [
{ message: "fetch https://host/user.png", category: "fetch", data: { url: "x" } },
{ message: "open /Users/a/secret.pdf", category: "console", level: "warning" },
],
}),
{},
)!;
expect(out.breadcrumbs).toEqual([
{ message: "fetch <url>", category: "fetch" },
{ message: "open <path>", category: "console", level: "warning" },
]);
});
it("falls back to type-only for non-native exceptions without a rebuild", () => {
const send = buildWebBeforeSend(() => true);
const custom = Object.assign(new Error("user secret"), { name: "WeirdLibError" });
const out = send(baseEvent(), { originalException: custom })!;
expect(out.exception.values[0].value).toBe("TypeError");
});
it("enforces the 500-per-hour ceiling", () => {
const send = buildWebBeforeSend(() => true);
for (let i = 0; i < 500; i++) expect(send(baseEvent(), {})).not.toBeNull();
expect(send(baseEvent(), {})).toBeNull();
});
it("never throws on malformed events", () => {
const send = buildWebBeforeSend(() => true);
expect(() => send({} as Record<string, any>, {})).not.toThrow();
expect(() => send({ exception: { values: null } } as any, {})).not.toThrow();
});
});