|
| 1 | +import { describe, it, expect, beforeEach, afterEach, vi } from "vitest"; |
| 2 | +import * as fs from "fs"; |
| 3 | + |
| 4 | +// ─── Isolated temp directory for every run ─────────────────────────────────── |
| 5 | +const MOCK_DIR = vi.hoisted(() => { |
| 6 | + const tmp = process.env["TMPDIR"] ?? process.env["TEMP"] ?? "/tmp"; |
| 7 | + return `${tmp}/cc-router-telemetry-${Date.now()}-${Math.floor(Math.random() * 10_000)}`; |
| 8 | +}); |
| 9 | + |
| 10 | +vi.mock("../config/paths.js", () => ({ |
| 11 | + CONFIG_DIR: MOCK_DIR, |
| 12 | + TELEMETRY_PATH: `${MOCK_DIR}/telemetry.json`, |
| 13 | + ACCOUNTS_PATH: `${MOCK_DIR}/accounts.json`, |
| 14 | + CLAUDE_SETTINGS_PATH: `${MOCK_DIR}/settings.json`, |
| 15 | + CONFIG_PATH: `${MOCK_DIR}/config.json`, |
| 16 | + PROXY_PORT: 3456, |
| 17 | + LITELLM_PORT: 4000, |
| 18 | + LITELLM_URL: undefined, |
| 19 | +})); |
| 20 | + |
| 21 | +import { |
| 22 | + loadTelemetryState, |
| 23 | + writeTelemetryState, |
| 24 | + isTelemetryEnabled, |
| 25 | + type TelemetryState, |
| 26 | +} from "../config/telemetry.js"; |
| 27 | + |
| 28 | +beforeEach(() => { |
| 29 | + fs.mkdirSync(MOCK_DIR, { recursive: true }); |
| 30 | + // Reset env vars |
| 31 | + delete process.env["DO_NOT_TRACK"]; |
| 32 | + delete process.env["CC_ROUTER_TELEMETRY"]; |
| 33 | +}); |
| 34 | + |
| 35 | +afterEach(() => { |
| 36 | + fs.rmSync(MOCK_DIR, { recursive: true, force: true }); |
| 37 | + delete process.env["DO_NOT_TRACK"]; |
| 38 | + delete process.env["CC_ROUTER_TELEMETRY"]; |
| 39 | +}); |
| 40 | + |
| 41 | +// ─── TelemetryState persistence ────────────────────────────────────────────── |
| 42 | + |
| 43 | +describe("loadTelemetryState", () => { |
| 44 | + it("creates fresh state with UUID and persists on first call", () => { |
| 45 | + const state = loadTelemetryState(); |
| 46 | + expect(state.enabled).toBe(true); |
| 47 | + expect(state.installId).toMatch( |
| 48 | + /^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$/i, |
| 49 | + ); |
| 50 | + expect(state.disclosureShown).toBe(false); |
| 51 | + expect(new Date(state.firstRunAt).getTime()).toBeGreaterThan(0); |
| 52 | + |
| 53 | + // Was persisted to disk |
| 54 | + const onDisk = JSON.parse( |
| 55 | + fs.readFileSync(`${MOCK_DIR}/telemetry.json`, "utf-8"), |
| 56 | + ) as TelemetryState; |
| 57 | + expect(onDisk.installId).toBe(state.installId); |
| 58 | + }); |
| 59 | + |
| 60 | + it("returns the same installId on subsequent calls", () => { |
| 61 | + const first = loadTelemetryState(); |
| 62 | + const second = loadTelemetryState(); |
| 63 | + expect(second.installId).toBe(first.installId); |
| 64 | + }); |
| 65 | + |
| 66 | + it("recovers from corrupted JSON", () => { |
| 67 | + fs.writeFileSync(`${MOCK_DIR}/telemetry.json`, "NOT_JSON{}", "utf-8"); |
| 68 | + const state = loadTelemetryState(); |
| 69 | + expect(state.enabled).toBe(true); |
| 70 | + expect(state.installId).toBeDefined(); |
| 71 | + }); |
| 72 | +}); |
| 73 | + |
| 74 | +describe("writeTelemetryState", () => { |
| 75 | + it("atomically writes state", () => { |
| 76 | + const state: TelemetryState = { |
| 77 | + enabled: false, |
| 78 | + installId: "test-uuid", |
| 79 | + firstRunAt: "2026-01-01T00:00:00.000Z", |
| 80 | + disclosureShown: true, |
| 81 | + }; |
| 82 | + writeTelemetryState(state); |
| 83 | + const raw = JSON.parse( |
| 84 | + fs.readFileSync(`${MOCK_DIR}/telemetry.json`, "utf-8"), |
| 85 | + ) as TelemetryState; |
| 86 | + expect(raw).toEqual(state); |
| 87 | + // .tmp was cleaned up (rename replaces) |
| 88 | + expect(fs.existsSync(`${MOCK_DIR}/telemetry.json.tmp`)).toBe(false); |
| 89 | + }); |
| 90 | +}); |
| 91 | + |
| 92 | +// ─── isTelemetryEnabled ────────────────────────────────────────────────────── |
| 93 | + |
| 94 | +describe("isTelemetryEnabled", () => { |
| 95 | + it("returns true by default", () => { |
| 96 | + expect(isTelemetryEnabled()).toBe(true); |
| 97 | + }); |
| 98 | + |
| 99 | + it("returns false when DO_NOT_TRACK=1", () => { |
| 100 | + process.env["DO_NOT_TRACK"] = "1"; |
| 101 | + expect(isTelemetryEnabled()).toBe(false); |
| 102 | + }); |
| 103 | + |
| 104 | + it("returns false when CC_ROUTER_TELEMETRY=0", () => { |
| 105 | + process.env["CC_ROUTER_TELEMETRY"] = "0"; |
| 106 | + expect(isTelemetryEnabled()).toBe(false); |
| 107 | + }); |
| 108 | + |
| 109 | + it("returns false when state.enabled is false", () => { |
| 110 | + const state = loadTelemetryState(); |
| 111 | + state.enabled = false; |
| 112 | + writeTelemetryState(state); |
| 113 | + expect(isTelemetryEnabled()).toBe(false); |
| 114 | + }); |
| 115 | + |
| 116 | + it("env var takes precedence even when state.enabled is true", () => { |
| 117 | + const state = loadTelemetryState(); |
| 118 | + state.enabled = true; |
| 119 | + writeTelemetryState(state); |
| 120 | + process.env["DO_NOT_TRACK"] = "1"; |
| 121 | + expect(isTelemetryEnabled()).toBe(false); |
| 122 | + }); |
| 123 | +}); |
| 124 | + |
| 125 | +// ─── trackEvent (HTTP client) ──────────────────────────────────────────────── |
| 126 | + |
| 127 | +describe("trackEvent", () => { |
| 128 | + const fetchSpy = vi.spyOn(globalThis, "fetch"); |
| 129 | + |
| 130 | + beforeEach(() => { |
| 131 | + fetchSpy.mockReset(); |
| 132 | + fetchSpy.mockResolvedValue(new Response("ok", { status: 200 })); |
| 133 | + }); |
| 134 | + |
| 135 | + afterEach(() => { |
| 136 | + fetchSpy.mockRestore(); |
| 137 | + }); |
| 138 | + |
| 139 | + // Import after mocks are in place |
| 140 | + let trackEvent: typeof import("../utils/telemetry.js").trackEvent; |
| 141 | + |
| 142 | + beforeEach(async () => { |
| 143 | + // Dynamic import so the module picks up our mocked paths |
| 144 | + const mod = await import("../utils/telemetry.js"); |
| 145 | + trackEvent = mod.trackEvent; |
| 146 | + }); |
| 147 | + |
| 148 | + it("sends event to Aptabase EU endpoint", async () => { |
| 149 | + // Ensure telemetry state exists (enabled by default) |
| 150 | + loadTelemetryState(); |
| 151 | + |
| 152 | + await trackEvent("test_event", { key: "value" }); |
| 153 | + |
| 154 | + expect(fetchSpy).toHaveBeenCalledOnce(); |
| 155 | + const [url, opts] = fetchSpy.mock.calls[0]; |
| 156 | + expect(url).toBe("https://eu.aptabase.com/api/v0/event"); |
| 157 | + expect((opts as RequestInit).method).toBe("POST"); |
| 158 | + expect((opts as RequestInit).headers).toEqual( |
| 159 | + expect.objectContaining({ |
| 160 | + "Content-Type": "application/json", |
| 161 | + "App-Key": "A-EU-1060569594", |
| 162 | + }), |
| 163 | + ); |
| 164 | + |
| 165 | + const body = JSON.parse((opts as RequestInit).body as string); |
| 166 | + expect(body.eventName).toBe("test_event"); |
| 167 | + expect(body.props.key).toBe("value"); |
| 168 | + expect(body.systemProps.osName).toMatch(/^(macOS|Linux|Windows)$/); |
| 169 | + expect(body.systemProps.engineName).toBe("node"); |
| 170 | + expect(body.timestamp).toMatch(/^\d{4}-\d{2}-\d{2}T/); |
| 171 | + expect(body.sessionId).toContain(loadTelemetryState().installId); |
| 172 | + }); |
| 173 | + |
| 174 | + it("does not call fetch when telemetry is disabled", async () => { |
| 175 | + process.env["DO_NOT_TRACK"] = "1"; |
| 176 | + await trackEvent("should_not_send"); |
| 177 | + expect(fetchSpy).not.toHaveBeenCalled(); |
| 178 | + }); |
| 179 | + |
| 180 | + it("never throws, even if fetch rejects", async () => { |
| 181 | + loadTelemetryState(); |
| 182 | + fetchSpy.mockRejectedValue(new Error("network down")); |
| 183 | + await expect(trackEvent("crash_test")).resolves.toBeUndefined(); |
| 184 | + }); |
| 185 | + |
| 186 | + it("never throws if fetch times out", async () => { |
| 187 | + loadTelemetryState(); |
| 188 | + fetchSpy.mockImplementation( |
| 189 | + () => new Promise((_, reject) => setTimeout(() => reject(new Error("timeout")), 10)), |
| 190 | + ); |
| 191 | + await expect(trackEvent("timeout_test")).resolves.toBeUndefined(); |
| 192 | + }); |
| 193 | +}); |
0 commit comments