mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtterandGitHub
e1b8c24e5d
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.
82 lines
3.1 KiB
TypeScript
82 lines
3.1 KiB
TypeScript
import { ANALYTICS_EVENTS } from "@snapotter/shared";
|
|
import { describe, expect, it } from "vitest";
|
|
|
|
describe("ANALYTICS_EVENTS", () => {
|
|
it("has exactly 15 event keys", () => {
|
|
expect(Object.keys(ANALYTICS_EVENTS)).toHaveLength(15);
|
|
});
|
|
|
|
it("contains the expected keys", () => {
|
|
expect(ANALYTICS_EVENTS).toHaveProperty("TOOL_USED");
|
|
expect(ANALYTICS_EVENTS).toHaveProperty("TOOL_OPENED");
|
|
expect(ANALYTICS_EVENTS).toHaveProperty("FILE_ADDED");
|
|
expect(ANALYTICS_EVENTS).toHaveProperty("TOOL_STARTED");
|
|
expect(ANALYTICS_EVENTS).toHaveProperty("TOOL_CLIENT_ERROR");
|
|
expect(ANALYTICS_EVENTS).toHaveProperty("RESULT_DOWNLOADED");
|
|
expect(ANALYTICS_EVENTS).toHaveProperty("RESULT_SAVED");
|
|
expect(ANALYTICS_EVENTS).toHaveProperty("SEARCH");
|
|
expect(ANALYTICS_EVENTS).toHaveProperty("PIPELINE_EXECUTED");
|
|
expect(ANALYTICS_EVENTS).toHaveProperty("AI_BUNDLE_ACTION");
|
|
expect(ANALYTICS_EVENTS).toHaveProperty("AI_BUNDLE_PROMPTED");
|
|
expect(ANALYTICS_EVENTS).toHaveProperty("BATCH_PROCESSED");
|
|
expect(ANALYTICS_EVENTS).toHaveProperty("FEEDBACK_SUBMITTED");
|
|
expect(ANALYTICS_EVENTS).toHaveProperty("SPONSOR_CLICKED");
|
|
expect(ANALYTICS_EVENTS).toHaveProperty("INSTANCE_STARTED");
|
|
});
|
|
|
|
it("all event values are strings", () => {
|
|
for (const value of Object.values(ANALYTICS_EVENTS)) {
|
|
expect(typeof value).toBe("string");
|
|
}
|
|
});
|
|
|
|
it("TOOL_USED has the correct snake_case value", () => {
|
|
expect(ANALYTICS_EVENTS.TOOL_USED).toBe("tool_used");
|
|
});
|
|
|
|
it("SEARCH has the correct snake_case value", () => {
|
|
expect(ANALYTICS_EVENTS.SEARCH).toBe("search");
|
|
});
|
|
|
|
it("PIPELINE_EXECUTED has the correct snake_case value", () => {
|
|
expect(ANALYTICS_EVENTS.PIPELINE_EXECUTED).toBe("pipeline_executed");
|
|
});
|
|
|
|
it("AI_BUNDLE_ACTION has the correct snake_case value", () => {
|
|
expect(ANALYTICS_EVENTS.AI_BUNDLE_ACTION).toBe("ai_bundle_action");
|
|
});
|
|
|
|
it("FEEDBACK_SUBMITTED has the correct snake_case value", () => {
|
|
expect(ANALYTICS_EVENTS.FEEDBACK_SUBMITTED).toBe("feedback_submitted");
|
|
});
|
|
|
|
it("INSTANCE_STARTED has the correct snake_case value", () => {
|
|
expect(ANALYTICS_EVENTS.INSTANCE_STARTED).toBe("instance_started");
|
|
});
|
|
|
|
it("all values follow snake_case convention", () => {
|
|
for (const value of Object.values(ANALYTICS_EVENTS)) {
|
|
expect(value).toMatch(/^[a-z][a-z0-9_]*$/);
|
|
}
|
|
});
|
|
|
|
it("is frozen (as const prevents mutation)", () => {
|
|
// as const produces a readonly object; Object.isFrozen checks runtime freezing.
|
|
// TypeScript enforces readonly at compile time, but at runtime the object
|
|
// defined with "as const" is a plain object unless explicitly frozen.
|
|
// We verify the values are stable by checking they haven't changed.
|
|
const snapshot = { ...ANALYTICS_EVENTS };
|
|
for (const key of Object.keys(snapshot)) {
|
|
expect(ANALYTICS_EVENTS[key as keyof typeof ANALYTICS_EVENTS]).toBe(
|
|
snapshot[key as keyof typeof snapshot],
|
|
);
|
|
}
|
|
});
|
|
|
|
it("all values are unique (no duplicate event names)", () => {
|
|
const values = Object.values(ANALYTICS_EVENTS);
|
|
const unique = new Set(values);
|
|
expect(unique.size).toBe(values.length);
|
|
});
|
|
});
|