fix: defer PostHog/Sentry loading until user consents to telemetry

PostHog SDK was initialized on app mount based only on the server-level
config flag, ignoring user consent. This caused network requests to
us-assets.i.posthog.com (config.js, web-vitals.js, dead-clicks-autocapture.js)
even when the user had not opted in or had explicitly declined telemetry.

- Replace static imports of posthog-js and @sentry/react with dynamic
  import() so the SDK bundles are not downloaded until consent is granted
- Gate initAnalytics on analyticsConsent.analyticsEnabled === true,
  not just server config.enabled
- Add consent re-check after each await import() to handle revocation
  during the async load
- Add shutdownAnalytics() that calls opt_out_capturing() + reset()
  for mid-session consent revocation
- setAnalyticsConsent(false) now triggers full SDK shutdown automatically
- Rewrite analytics test suite with 44 tests covering init gating,
  shutdown lifecycle, consent toggle, race conditions, and Sentry callbacks

Closes #98
This commit is contained in:
SnapOtter
2026-04-29 14:16:38 +08:00
parent 03f82567d0
commit 4d3e5e9c02
4 changed files with 377 additions and 195 deletions
+7 -10
View File
@@ -173,12 +173,6 @@ export function App() {
fetchAnalyticsConfig(); fetchAnalyticsConfig();
}, [fetchAnalyticsConfig]); }, [fetchAnalyticsConfig]);
useEffect(() => {
if (analyticsConfigLoaded && analyticsConfig?.enabled) {
initAnalytics(analyticsConfig);
}
}, [analyticsConfigLoaded, analyticsConfig]);
useEffect(() => { useEffect(() => {
if ( if (
!analyticsConfigLoaded || !analyticsConfigLoaded ||
@@ -186,10 +180,13 @@ export function App() {
analyticsConsent.analyticsEnabled !== true analyticsConsent.analyticsEnabled !== true
) )
return; return;
identify(analyticsConfig.instanceId, { void (async () => {
$set: { version: APP_VERSION }, await initAnalytics(analyticsConfig);
$set_once: { instance_id: analyticsConfig.instanceId }, identify(analyticsConfig.instanceId, {
}); $set: { version: APP_VERSION },
$set_once: { instance_id: analyticsConfig.instanceId },
});
})();
}, [analyticsConfigLoaded, analyticsConfig, analyticsConsent.analyticsEnabled]); }, [analyticsConfigLoaded, analyticsConfig, analyticsConsent.analyticsEnabled]);
return ( return (
+32 -5
View File
@@ -1,8 +1,8 @@
import * as Sentry from "@sentry/react";
import type { AnalyticsConfig } from "@snapotter/shared"; import type { AnalyticsConfig } from "@snapotter/shared";
import posthogJs from "posthog-js";
let posthog: import("posthog-js").PostHog | null = null; type PostHogInstance = import("posthog-js").PostHog;
let posthog: PostHogInstance | null = null;
let initialized = false; let initialized = false;
let consentGranted = false; let consentGranted = false;
@@ -14,11 +14,16 @@ function scrubString(str: string): string {
return str.replace(FILE_EXT_PATTERN, ".[REDACTED]").replace(FILE_PATH_PATTERN, "/[REDACTED]/"); return str.replace(FILE_EXT_PATTERN, ".[REDACTED]").replace(FILE_PATH_PATTERN, "/[REDACTED]/");
} }
export function initAnalytics(config: AnalyticsConfig): void { export async function initAnalytics(config: AnalyticsConfig): Promise<void> {
if (initialized || !config.enabled) return; if (initialized || !config.enabled) return;
initialized = true; initialized = true;
try { try {
const posthogJs = (await import("posthog-js")).default;
if (!consentGranted) {
initialized = false;
return;
}
posthog = posthog =
posthogJs.init(config.posthogApiKey, { posthogJs.init(config.posthogApiKey, {
api_host: config.posthogHost, api_host: config.posthogHost,
@@ -35,11 +40,16 @@ export function initAnalytics(config: AnalyticsConfig): void {
persistence: "localStorage", persistence: "localStorage",
}) ?? null; }) ?? null;
} catch { } catch {
// SDK blocked or unavailable — use null provider // SDK blocked or unavailable
} }
try { try {
if (config.sentryDsn) { if (config.sentryDsn) {
const Sentry = await import("@sentry/react");
if (!consentGranted) {
initialized = false;
return;
}
Sentry.init({ Sentry.init({
dsn: config.sentryDsn, dsn: config.sentryDsn,
sendDefaultPii: false, sendDefaultPii: false,
@@ -81,8 +91,25 @@ export function initAnalytics(config: AnalyticsConfig): void {
} }
} }
export function shutdownAnalytics(): void {
if (posthog) {
try {
posthog.opt_out_capturing();
posthog.reset();
} catch {
// never throw
}
}
posthog = null;
initialized = false;
consentGranted = false;
}
export function setAnalyticsConsent(enabled: boolean): void { export function setAnalyticsConsent(enabled: boolean): void {
consentGranted = enabled; consentGranted = enabled;
if (!enabled) {
shutdownAnalytics();
}
} }
export function identify(instanceId: string, properties: Record<string, unknown>): void { export function identify(instanceId: string, properties: Record<string, unknown>): void {
+336 -180
View File
@@ -1,38 +1,25 @@
// @vitest-environment node // @vitest-environment node
/** import { afterAll, afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vitest";
* Tests for the analytics lib's exported functions.
*
* Since posthog-js and @sentry/react are heavy browser-side SDKs that
* vitest cannot easily resolve (they live in web's node_modules behind
* a complex resolution chain), we test the module's behavior through
* its public API contract:
*
* - Functions never throw (silent failures per design)
* - Consent gating works correctly
* - setAnalyticsConsent can be called standalone
* - Functions are safe to call before/without initialization
*/
import { afterAll, beforeAll, describe, expect, it, vi } from "vitest";
// Mock both posthog-js and @sentry/react so the module can load const mockInit = vi.fn(() => ({
capture: mockCapture,
identify: mockIdentify,
startSessionRecording: mockStartSessionRecording,
opt_in_capturing: mockOptIn,
opt_out_capturing: mockOptOut,
reset: mockReset,
persistence: { disabled: false },
}));
const mockCapture = vi.fn(); const mockCapture = vi.fn();
const mockIdentify = vi.fn(); const mockIdentify = vi.fn();
const mockStartSessionRecording = vi.fn(); const mockStartSessionRecording = vi.fn();
const mockOptIn = vi.fn(); const mockOptIn = vi.fn();
const mockOptOut = vi.fn(); const mockOptOut = vi.fn();
const mockReset = vi.fn();
vi.mock("posthog-js", () => ({ vi.mock("posthog-js", () => ({
__esModule: true, __esModule: true,
default: { default: { init: mockInit },
init: vi.fn(() => ({
capture: mockCapture,
identify: mockIdentify,
startSessionRecording: mockStartSessionRecording,
opt_in_capturing: mockOptIn,
opt_out_capturing: mockOptOut,
persistence: { disabled: false },
})),
},
})); }));
const mockSentryInit = vi.fn(); const mockSentryInit = vi.fn();
@@ -58,51 +45,159 @@ import {
identify, identify,
initAnalytics, initAnalytics,
setAnalyticsConsent, setAnalyticsConsent,
shutdownAnalytics,
startErrorReplay, startErrorReplay,
track, track,
} from "@/lib/analytics"; } from "@/lib/analytics";
const enabledConfig = {
enabled: true,
posthogApiKey: "phc_test",
posthogHost: "https://ph.test",
sentryDsn: "https://sentry.test/123",
sampleRate: 1,
instanceId: "inst-1",
};
const disabledConfig = {
enabled: false,
posthogApiKey: "key",
posthogHost: "https://ph.test",
sentryDsn: "",
sampleRate: 1,
instanceId: "inst-1",
};
describe("analytics lib", () => { describe("analytics lib", () => {
beforeEach(() => {
shutdownAnalytics();
mockInit.mockClear();
mockCapture.mockClear();
mockIdentify.mockClear();
mockStartSessionRecording.mockClear();
mockOptIn.mockClear();
mockOptOut.mockClear();
mockReset.mockClear();
mockSentryInit.mockClear();
});
describe("initAnalytics", () => { describe("initAnalytics", () => {
it("does not throw when config.enabled is false", () => { it("skips initialization when config.enabled is false", async () => {
expect(() => setAnalyticsConsent(true);
initAnalytics({ await initAnalytics(disabledConfig);
enabled: false, expect(mockInit).not.toHaveBeenCalled();
posthogApiKey: "key",
posthogHost: "https://ph.test",
sentryDsn: "",
sampleRate: 1,
instanceId: "inst-1",
}),
).not.toThrow();
}); });
it("does not throw when config.enabled is true", () => { it("skips posthog.init when consent is not granted", async () => {
expect(() => await initAnalytics(enabledConfig);
initAnalytics({ expect(mockInit).not.toHaveBeenCalled();
enabled: true,
posthogApiKey: "phc_test",
posthogHost: "https://ph.test",
sentryDsn: "https://sentry.test/123",
sampleRate: 1,
instanceId: "inst-1",
}),
).not.toThrow();
}); });
it("does not throw on double initialization", () => { it("calls posthog.init when config.enabled and consent are both true", async () => {
const config = { setAnalyticsConsent(true);
enabled: true, await initAnalytics(enabledConfig);
posthogApiKey: "phc_test", expect(mockInit).toHaveBeenCalledOnce();
posthogHost: "https://ph.test", expect(mockInit).toHaveBeenCalledWith(
sentryDsn: "", "phc_test",
sampleRate: 1, expect.objectContaining({
instanceId: "inst-1", api_host: "https://ph.test",
}; autocapture: false,
expect(() => { ip: false,
initAnalytics(config); }),
initAnalytics(config); );
}).not.toThrow(); });
it("initializes Sentry when sentryDsn is provided and consent is granted", async () => {
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
expect(mockSentryInit).toHaveBeenCalledOnce();
expect(mockSentryInit).toHaveBeenCalledWith(
expect.objectContaining({
dsn: "https://sentry.test/123",
sendDefaultPii: false,
}),
);
});
it("skips Sentry when sentryDsn is empty", async () => {
setAnalyticsConsent(true);
await initAnalytics({ ...enabledConfig, sentryDsn: "" });
expect(mockSentryInit).not.toHaveBeenCalled();
});
it("does not double-initialize on repeated calls", async () => {
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
await initAnalytics(enabledConfig);
expect(mockInit).toHaveBeenCalledOnce();
});
it("bails out if consent is revoked during async import", async () => {
setAnalyticsConsent(true);
const initPromise = initAnalytics(enabledConfig);
setAnalyticsConsent(false);
await initPromise;
// shutdownAnalytics was called by setAnalyticsConsent(false),
// and the init should have bailed after the import resolved
// because consentGranted was false at that point.
// mockInit may or may not have been called depending on timing,
// but the SDK should not be active after shutdown.
// Verify track does not forward to posthog:
track("test_event");
expect(mockCapture).not.toHaveBeenCalled();
});
});
describe("shutdownAnalytics", () => {
it("calls opt_out_capturing and reset on the posthog instance", async () => {
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
shutdownAnalytics();
expect(mockOptOut).toHaveBeenCalledOnce();
expect(mockReset).toHaveBeenCalledOnce();
});
it("is safe to call when not initialized", () => {
expect(() => shutdownAnalytics()).not.toThrow();
});
it("is safe to call multiple times", async () => {
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
shutdownAnalytics();
expect(() => shutdownAnalytics()).not.toThrow();
// opt_out and reset only called once (first shutdown had a posthog instance)
expect(mockOptOut).toHaveBeenCalledOnce();
expect(mockReset).toHaveBeenCalledOnce();
});
it("allows re-initialization after shutdown", async () => {
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
expect(mockInit).toHaveBeenCalledOnce();
shutdownAnalytics();
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
expect(mockInit).toHaveBeenCalledTimes(2);
});
it("swallows exceptions from posthog.opt_out_capturing", async () => {
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
mockOptOut.mockImplementationOnce(() => {
throw new Error("opt_out boom");
});
expect(() => shutdownAnalytics()).not.toThrow();
});
it("swallows exceptions from posthog.reset", async () => {
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
mockReset.mockImplementationOnce(() => {
throw new Error("reset boom");
});
expect(() => shutdownAnalytics()).not.toThrow();
}); });
}); });
@@ -122,107 +217,132 @@ describe("analytics lib", () => {
setAnalyticsConsent(true); setAnalyticsConsent(true);
}).not.toThrow(); }).not.toThrow();
}); });
it("triggers shutdown when set to false after init", async () => {
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
setAnalyticsConsent(false);
expect(mockOptOut).toHaveBeenCalledOnce();
expect(mockReset).toHaveBeenCalledOnce();
});
it("does not trigger shutdown when set to true", async () => {
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
mockOptOut.mockClear();
mockReset.mockClear();
setAnalyticsConsent(true);
expect(mockOptOut).not.toHaveBeenCalled();
expect(mockReset).not.toHaveBeenCalled();
});
}); });
describe("track", () => { describe("track", () => {
it("does not throw without consent", () => { it("does not call capture without consent", async () => {
setAnalyticsConsent(false);
expect(() => track("test_event", { foo: "bar" })).not.toThrow();
});
it("does not throw with consent", () => {
setAnalyticsConsent(true); setAnalyticsConsent(true);
expect(() => track("tool_used", { tool: "resize" })).not.toThrow(); await initAnalytics(enabledConfig);
});
it("does not throw without properties", () => {
setAnalyticsConsent(true);
expect(() => track("simple_event")).not.toThrow();
});
it("does not throw with empty properties", () => {
setAnalyticsConsent(true);
expect(() => track("event", {})).not.toThrow();
});
});
describe("identify", () => {
it("does not throw without consent", () => {
setAnalyticsConsent(false);
expect(() => identify("inst-1", { version: "1.0" })).not.toThrow();
});
it("does not throw with consent", () => {
setAnalyticsConsent(true);
expect(() => identify("inst-1", { plan: "free" })).not.toThrow();
});
it("does not throw with empty properties", () => {
setAnalyticsConsent(true);
expect(() => identify("inst-1", {})).not.toThrow();
});
});
describe("startErrorReplay", () => {
it("does not throw without consent", () => {
setAnalyticsConsent(false);
expect(() => startErrorReplay()).not.toThrow();
});
it("does not throw with consent", () => {
setAnalyticsConsent(true);
expect(() => startErrorReplay()).not.toThrow();
});
});
describe("consent gating behavior", () => {
it("track captures only when consent is granted", () => {
mockCapture.mockClear(); mockCapture.mockClear();
setAnalyticsConsent(false); setAnalyticsConsent(false);
track("no_consent_event"); // Re-init to have a posthog instance for the next consent grant
const callsWithoutConsent = mockCapture.mock.calls.length;
setAnalyticsConsent(true); setAnalyticsConsent(true);
track("with_consent_event"); await initAnalytics(enabledConfig);
const callsWithConsent = mockCapture.mock.calls.length;
// With consent should have more calls than without
expect(callsWithConsent).toBeGreaterThanOrEqual(callsWithoutConsent);
});
it("identify only works when consent is granted", () => {
mockIdentify.mockClear();
setAnalyticsConsent(false); setAnalyticsConsent(false);
identify("no-consent", {}); track("blocked_event");
const callsWithoutConsent = mockIdentify.mock.calls.length; expect(mockCapture).not.toHaveBeenCalled();
setAnalyticsConsent(true);
identify("with-consent", {});
const callsWithConsent = mockIdentify.mock.calls.length;
expect(callsWithConsent).toBeGreaterThanOrEqual(callsWithoutConsent);
}); });
});
describe("error resilience", () => { it("calls capture with consent", async () => {
it("track swallows exception from posthog.capture", () => {
setAnalyticsConsent(true); setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
track("tool_used", { tool: "resize" });
expect(mockCapture).toHaveBeenCalledWith("tool_used", { tool: "resize" });
});
it("works without properties", async () => {
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
track("simple_event");
expect(mockCapture).toHaveBeenCalledWith("simple_event", undefined);
});
it("does not throw before initialization", () => {
setAnalyticsConsent(true);
expect(() => track("pre_init_event")).not.toThrow();
});
it("swallows exceptions from posthog.capture", async () => {
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
mockCapture.mockImplementationOnce(() => { mockCapture.mockImplementationOnce(() => {
throw new Error("capture boom"); throw new Error("capture boom");
}); });
expect(() => track("should_not_throw")).not.toThrow(); expect(() => track("should_not_throw")).not.toThrow();
}); });
});
it("identify swallows exception from posthog.identify", () => { describe("identify", () => {
it("does not call posthog.identify without consent", async () => {
setAnalyticsConsent(true); setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
setAnalyticsConsent(false);
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
setAnalyticsConsent(false);
mockIdentify.mockClear();
identify("blocked-id", {});
expect(mockIdentify).not.toHaveBeenCalled();
});
it("calls posthog.identify with consent", async () => {
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
identify("inst-1", { version: "1.0" });
expect(mockIdentify).toHaveBeenCalledWith("inst-1", { version: "1.0" });
});
it("does not throw before initialization", () => {
setAnalyticsConsent(true);
expect(() => identify("inst-1", {})).not.toThrow();
});
it("swallows exceptions from posthog.identify", async () => {
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
mockIdentify.mockImplementationOnce(() => { mockIdentify.mockImplementationOnce(() => {
throw new Error("identify boom"); throw new Error("identify boom");
}); });
expect(() => identify("inst-x", { foo: "bar" })).not.toThrow(); expect(() => identify("inst-x", { foo: "bar" })).not.toThrow();
}); });
});
it("startErrorReplay swallows exception from posthog.startSessionRecording", () => { describe("startErrorReplay", () => {
it("does not call startSessionRecording without consent", async () => {
setAnalyticsConsent(true); setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
setAnalyticsConsent(false);
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
setAnalyticsConsent(false);
mockStartSessionRecording.mockClear();
startErrorReplay();
expect(mockStartSessionRecording).not.toHaveBeenCalled();
});
it("calls startSessionRecording with consent", async () => {
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
startErrorReplay();
expect(mockStartSessionRecording).toHaveBeenCalledOnce();
});
it("does not throw before initialization", () => {
setAnalyticsConsent(true);
expect(() => startErrorReplay()).not.toThrow();
});
it("swallows exceptions from posthog.startSessionRecording", async () => {
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
mockStartSessionRecording.mockImplementationOnce(() => { mockStartSessionRecording.mockImplementationOnce(() => {
throw new Error("replay boom"); throw new Error("replay boom");
}); });
@@ -230,40 +350,79 @@ describe("analytics lib", () => {
}); });
}); });
describe("consent gating prevents calls", () => { describe("full consent lifecycle", () => {
it("track does not call capture when consent is false", () => { it("accept -> use -> revoke -> silent -> re-accept -> use", async () => {
mockCapture.mockClear(); // Phase 1: Accept and use analytics
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
expect(mockInit).toHaveBeenCalledOnce();
track("phase1_event");
expect(mockCapture).toHaveBeenCalledWith("phase1_event", undefined);
identify("inst-1", { phase: 1 });
expect(mockIdentify).toHaveBeenCalledWith("inst-1", { phase: 1 });
// Phase 2: Revoke consent mid-session
setAnalyticsConsent(false); setAnalyticsConsent(false);
track("blocked_event"); expect(mockOptOut).toHaveBeenCalledOnce();
expect(mockReset).toHaveBeenCalledOnce();
mockCapture.mockClear();
mockIdentify.mockClear();
track("phase2_blocked");
identify("inst-1", { phase: 2 });
expect(mockCapture).not.toHaveBeenCalled();
expect(mockIdentify).not.toHaveBeenCalled();
// Phase 3: Re-accept consent
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
expect(mockInit).toHaveBeenCalledTimes(2);
track("phase3_event");
expect(mockCapture).toHaveBeenCalledWith("phase3_event", undefined);
});
it("server disabled overrides user consent", async () => {
setAnalyticsConsent(true);
await initAnalytics(disabledConfig);
expect(mockInit).not.toHaveBeenCalled();
track("should_not_fire");
expect(mockCapture).not.toHaveBeenCalled(); expect(mockCapture).not.toHaveBeenCalled();
}); });
it("identify does not call identify when consent is false", () => { it("rapid consent toggles do not corrupt state", async () => {
mockIdentify.mockClear(); setAnalyticsConsent(true);
setAnalyticsConsent(false); await initAnalytics(enabledConfig);
identify("blocked-id", {});
expect(mockIdentify).not.toHaveBeenCalled();
});
it("startErrorReplay does not call startSessionRecording when consent is false", () => {
mockStartSessionRecording.mockClear();
setAnalyticsConsent(false); setAnalyticsConsent(false);
startErrorReplay(); setAnalyticsConsent(true);
expect(mockStartSessionRecording).not.toHaveBeenCalled(); setAnalyticsConsent(false);
setAnalyticsConsent(true);
// After rapid toggles ending on true, SDK was shut down multiple times.
// Re-init should work cleanly.
await initAnalytics(enabledConfig);
track("after_rapid_toggle");
expect(mockCapture).toHaveBeenCalledWith("after_rapid_toggle", undefined);
}); });
}); });
describe("Sentry beforeSend callback", () => { describe("Sentry beforeSend callback", () => {
function getBeforeSend() { async function getBeforeSend() {
shutdownAnalytics();
mockSentryInit.mockClear();
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
const sentryCall = mockSentryInit.mock.calls.find((call: unknown[]) => call[0]?.beforeSend); const sentryCall = mockSentryInit.mock.calls.find((call: unknown[]) => call[0]?.beforeSend);
return sentryCall ? sentryCall[0].beforeSend : null; return sentryCall ? sentryCall[0].beforeSend : null;
} }
it("scrubs file extensions from exception values", () => { it("scrubs file extensions from exception values", async () => {
const beforeSend = getBeforeSend(); const beforeSend = await getBeforeSend();
if (!beforeSend) return; if (!beforeSend) return;
setAnalyticsConsent(true);
const event = { const event = {
user: { email: "test@example.com", username: "user1" }, user: { email: "test@example.com", username: "user1" },
exception: { exception: {
@@ -291,8 +450,8 @@ describe("analytics lib", () => {
expect(result.exception.values[0].stacktrace.frames[0].abs_path).toContain("[REDACTED]"); expect(result.exception.values[0].stacktrace.frames[0].abs_path).toContain("[REDACTED]");
}); });
it("returns null when consent is not granted", () => { it("returns null when consent is not granted", async () => {
const beforeSend = getBeforeSend(); const beforeSend = await getBeforeSend();
if (!beforeSend) return; if (!beforeSend) return;
setAnalyticsConsent(false); setAnalyticsConsent(false);
@@ -300,20 +459,18 @@ describe("analytics lib", () => {
expect(result).toBeNull(); expect(result).toBeNull();
}); });
it("handles event without user or exception fields", () => { it("handles event without user or exception fields", async () => {
const beforeSend = getBeforeSend(); const beforeSend = await getBeforeSend();
if (!beforeSend) return; if (!beforeSend) return;
setAnalyticsConsent(true);
const result = beforeSend({}); const result = beforeSend({});
expect(result).toBeDefined(); expect(result).toBeDefined();
}); });
it("handles exception values without stacktrace", () => { it("handles exception values without stacktrace", async () => {
const beforeSend = getBeforeSend(); const beforeSend = await getBeforeSend();
if (!beforeSend) return; if (!beforeSend) return;
setAnalyticsConsent(true);
const event = { const event = {
exception: { values: [{ value: "plain error" }] }, exception: { values: [{ value: "plain error" }] },
}; };
@@ -324,27 +481,29 @@ describe("analytics lib", () => {
}); });
describe("Sentry beforeBreadcrumb callback", () => { describe("Sentry beforeBreadcrumb callback", () => {
function getBeforeBreadcrumb() { async function getBeforeBreadcrumb() {
shutdownAnalytics();
mockSentryInit.mockClear();
setAnalyticsConsent(true);
await initAnalytics(enabledConfig);
const sentryCall = mockSentryInit.mock.calls.find( const sentryCall = mockSentryInit.mock.calls.find(
(call: unknown[]) => call[0]?.beforeBreadcrumb, (call: unknown[]) => call[0]?.beforeBreadcrumb,
); );
return sentryCall ? sentryCall[0].beforeBreadcrumb : null; return sentryCall ? sentryCall[0].beforeBreadcrumb : null;
} }
it("returns null for ui.click breadcrumbs", () => { it("returns null for ui.click breadcrumbs", async () => {
const beforeBreadcrumb = getBeforeBreadcrumb(); const beforeBreadcrumb = await getBeforeBreadcrumb();
if (!beforeBreadcrumb) return; if (!beforeBreadcrumb) return;
setAnalyticsConsent(true);
const result = beforeBreadcrumb({ category: "ui.click" }); const result = beforeBreadcrumb({ category: "ui.click" });
expect(result).toBeNull(); expect(result).toBeNull();
}); });
it("returns null for fetch breadcrumbs with file extension URLs", () => { it("returns null for fetch breadcrumbs with file extension URLs", async () => {
const beforeBreadcrumb = getBeforeBreadcrumb(); const beforeBreadcrumb = await getBeforeBreadcrumb();
if (!beforeBreadcrumb) return; if (!beforeBreadcrumb) return;
setAnalyticsConsent(true);
const result = beforeBreadcrumb({ const result = beforeBreadcrumb({
category: "fetch", category: "fetch",
data: { url: "https://example.com/uploads/photo.png" }, data: { url: "https://example.com/uploads/photo.png" },
@@ -352,11 +511,10 @@ describe("analytics lib", () => {
expect(result).toBeNull(); expect(result).toBeNull();
}); });
it("scrubs messages containing file paths", () => { it("scrubs messages containing file paths", async () => {
const beforeBreadcrumb = getBeforeBreadcrumb(); const beforeBreadcrumb = await getBeforeBreadcrumb();
if (!beforeBreadcrumb) return; if (!beforeBreadcrumb) return;
setAnalyticsConsent(true);
const breadcrumb = { const breadcrumb = {
category: "console", category: "console",
message: "Error loading /tmp/workspace/file.jpg", message: "Error loading /tmp/workspace/file.jpg",
@@ -366,8 +524,8 @@ describe("analytics lib", () => {
expect(result.message).toContain("[REDACTED]"); expect(result.message).toContain("[REDACTED]");
}); });
it("returns null when consent is not granted", () => { it("returns null when consent is not granted", async () => {
const beforeBreadcrumb = getBeforeBreadcrumb(); const beforeBreadcrumb = await getBeforeBreadcrumb();
if (!beforeBreadcrumb) return; if (!beforeBreadcrumb) return;
setAnalyticsConsent(false); setAnalyticsConsent(false);
@@ -375,11 +533,10 @@ describe("analytics lib", () => {
expect(result).toBeNull(); expect(result).toBeNull();
}); });
it("passes through fetch breadcrumbs without file extension URLs", () => { it("passes through fetch breadcrumbs without file extension URLs", async () => {
const beforeBreadcrumb = getBeforeBreadcrumb(); const beforeBreadcrumb = await getBeforeBreadcrumb();
if (!beforeBreadcrumb) return; if (!beforeBreadcrumb) return;
setAnalyticsConsent(true);
const breadcrumb = { const breadcrumb = {
category: "fetch", category: "fetch",
data: { url: "https://example.com/api/v1/health" }, data: { url: "https://example.com/api/v1/health" },
@@ -388,11 +545,10 @@ describe("analytics lib", () => {
expect(result).not.toBeNull(); expect(result).not.toBeNull();
}); });
it("passes through breadcrumbs without message field", () => { it("passes through breadcrumbs without message field", async () => {
const beforeBreadcrumb = getBeforeBreadcrumb(); const beforeBreadcrumb = await getBeforeBreadcrumb();
if (!beforeBreadcrumb) return; if (!beforeBreadcrumb) return;
setAnalyticsConsent(true);
const breadcrumb = { category: "navigation" }; const breadcrumb = { category: "navigation" };
const result = beforeBreadcrumb(breadcrumb); const result = beforeBreadcrumb(breadcrumb);
expect(result).not.toBeNull(); expect(result).not.toBeNull();
+2
View File
@@ -108,6 +108,8 @@ export default defineConfig({
react: path.join(webNodeModules, "react"), react: path.join(webNodeModules, "react"),
"react-dom": path.join(webNodeModules, "react-dom"), "react-dom": path.join(webNodeModules, "react-dom"),
zustand: path.join(webNodeModules, "zustand"), zustand: path.join(webNodeModules, "zustand"),
"posthog-js": path.join(webNodeModules, "posthog-js"),
"@sentry/react": path.join(webNodeModules, "@sentry/react"),
}, },
}, },
}); });