feat(telemetry): add app version to exception captures and filter 402 errors

- Add appVersion as required parameter in captureException across TelemetryClient interface
- TelemetryService stores appVersion (set once at activation) and automatically passes it to all clients
- PostHogTelemetryClient includes $app_version in all exception reports sent to PostHog
- Add 402 (payment required) to EXPECTED_API_ERROR_CODES to filter out billing-related errors
- Add tests for shouldReportApiErrorToTelemetry and updated captureException tests

Author: daniel-lxs

packages/cloud/src/TelemetryClient.ts

@@ -69,7 +69,7 @@ abstract class BaseTelemetryClient implements TelemetryClient {
 
 	public abstract capture(event: TelemetryEvent): Promise<void>
 
-	public captureException(_error: Error, _additionalProperties?: Record<string, unknown>): void {
+	public captureException(_error: Error, _appVersion: string, _additionalProperties?: Record<string, unknown>): void {
 		// No-op - exception capture is only supported by PostHog
 	}
 

packages/telemetry/src/BaseTelemetryClient.ts

@@ -59,7 +59,11 @@ export abstract class BaseTelemetryClient implements TelemetryClient {
 
 	public abstract capture(event: TelemetryEvent): Promise<void>
 
-	public abstract captureException(error: Error, additionalProperties?: Record<string, unknown>): void
+	public abstract captureException(
+		error: Error,
+		appVersion: string,
+		additionalProperties?: Record<string, unknown>,
+	): void
 
 	public setProvider(provider: TelemetryPropertiesProvider): void {
 		this.providerRef = new WeakRef(provider)

packages/telemetry/src/PostHogTelemetryClient.ts

@@ -61,7 +61,11 @@ export class PostHogTelemetryClient extends BaseTelemetryClient {
 		})
 	}
 
-	public override captureException(error: Error, additionalProperties?: Record<string, unknown>): void {
+	public override captureException(
+		error: Error,
+		appVersion: string,
+		additionalProperties?: Record<string, unknown>,
+	): void {
 		if (!this.isTelemetryEnabled()) {
 			if (this.debug) {
 				console.info(`[PostHogTelemetryClient#captureException] Skipping exception: ${error.message}`)
@@ -74,7 +78,10 @@ export class PostHogTelemetryClient extends BaseTelemetryClient {
 			console.info(`[PostHogTelemetryClient#captureException] ${error.message}`)
 		}
 
-		this.client.captureException(error, this.distinctId, additionalProperties)
+		this.client.captureException(error, this.distinctId, {
+			...additionalProperties,
+			$app_version: appVersion,
+		})
 	}
 
 	/**

packages/telemetry/src/TelemetryService.ts

@@ -13,12 +13,22 @@ import {
  * variables are loaded.
  */
 export class TelemetryService {
+	private appVersion: string = "unknown"
+
 	constructor(private clients: TelemetryClient[]) {}
 
 	public register(client: TelemetryClient): void {
 		this.clients.push(client)
 	}
 
+	/**
+	 * Sets the app version for exception tracking
+	 * @param version The app version string
+	 */
+	public setAppVersion(version: string): void {
+		this.appVersion = version
+	}
+
 	/**
 	 * Sets the ClineProvider reference to use for global properties
 	 * @param provider A ClineProvider instance to use
@@ -75,7 +85,7 @@ export class TelemetryService {
 			return
 		}
 
-		this.clients.forEach((client) => client.captureException(error, additionalProperties))
+		this.clients.forEach((client) => client.captureException(error, this.appVersion, additionalProperties))
 	}
 
 	public captureTaskCreated(taskId: string): void {

packages/telemetry/src/__tests__/PostHogTelemetryClient.test.ts

@@ -32,6 +32,7 @@ describe("PostHogTelemetryClient", () => {
 
 		mockPostHogClient = {
 			capture: vi.fn(),
+			captureException: vi.fn(),
 			optIn: vi.fn(),
 			optOut: vi.fn(),
 			shutdown: vi.fn().mockResolvedValue(undefined),
@@ -366,6 +367,47 @@ describe("PostHogTelemetryClient", () => {
 		})
 	})
 
+	describe("captureException", () => {
+		it("should not capture exceptions when telemetry is disabled", () => {
+			const client = new PostHogTelemetryClient()
+			client.updateTelemetryState(false)
+
+			const error = new Error("Test error")
+			client.captureException(error, "1.0.0")
+
+			expect(mockPostHogClient.captureException).not.toHaveBeenCalled()
+		})
+
+		it("should capture exceptions with app version", () => {
+			const client = new PostHogTelemetryClient()
+			client.updateTelemetryState(true)
+
+			const error = new Error("Test error")
+			client.captureException(error, "1.0.0", { customProp: "value" })
+
+			expect(mockPostHogClient.captureException).toHaveBeenCalledWith(
+				error,
+				"test-machine-id",
+				expect.objectContaining({
+					customProp: "value",
+					$app_version: "1.0.0",
+				}),
+			)
+		})
+
+		it("should capture exceptions with only app version (no additional properties)", () => {
+			const client = new PostHogTelemetryClient()
+			client.updateTelemetryState(true)
+
+			const error = new Error("Test error")
+			client.captureException(error, "2.0.0")
+
+			expect(mockPostHogClient.captureException).toHaveBeenCalledWith(error, "test-machine-id", {
+				$app_version: "2.0.0",
+			})
+		})
+	})
+
 	describe("shutdown", () => {
 		it("should call shutdown on the PostHog client", async () => {
 			const client = new PostHogTelemetryClient()

packages/types/src/__tests__/telemetry.test.ts

@@ -0,0 +1,42 @@
+// pnpm --filter @roo-code/types test src/__tests__/telemetry.test.ts
+
+import { describe, it, expect } from "vitest"
+import { shouldReportApiErrorToTelemetry, EXPECTED_API_ERROR_CODES } from "../telemetry.js"
+
+describe("shouldReportApiErrorToTelemetry", () => {
+	it("should return true when errorCode is undefined", () => {
+		expect(shouldReportApiErrorToTelemetry(undefined)).toBe(true)
+	})
+
+	it("should return false for 402 (payment required) errors", () => {
+		expect(shouldReportApiErrorToTelemetry(402)).toBe(false)
+	})
+
+	it("should return false for 429 (rate limit) errors", () => {
+		expect(shouldReportApiErrorToTelemetry(429)).toBe(false)
+	})
+
+	it("should return true for other error codes", () => {
+		expect(shouldReportApiErrorToTelemetry(400)).toBe(true)
+		expect(shouldReportApiErrorToTelemetry(401)).toBe(true)
+		expect(shouldReportApiErrorToTelemetry(403)).toBe(true)
+		expect(shouldReportApiErrorToTelemetry(404)).toBe(true)
+		expect(shouldReportApiErrorToTelemetry(500)).toBe(true)
+		expect(shouldReportApiErrorToTelemetry(502)).toBe(true)
+		expect(shouldReportApiErrorToTelemetry(503)).toBe(true)
+	})
+})
+
+describe("EXPECTED_API_ERROR_CODES", () => {
+	it("should contain 402 (payment required)", () => {
+		expect(EXPECTED_API_ERROR_CODES.has(402)).toBe(true)
+	})
+
+	it("should contain 429 (rate limit)", () => {
+		expect(EXPECTED_API_ERROR_CODES.has(429)).toBe(true)
+	})
+
+	it("should only contain expected error codes", () => {
+		expect(EXPECTED_API_ERROR_CODES.size).toBe(2)
+	})
+})

packages/types/src/telemetry.ts

@@ -262,7 +262,7 @@ export interface TelemetryClient {
 
 	setProvider(provider: TelemetryPropertiesProvider): void
 	capture(options: TelemetryEvent): Promise<void>
-	captureException(error: Error, additionalProperties?: Record<string, unknown>): void
+	captureException(error: Error, appVersion: string, additionalProperties?: Record<string, unknown>): void
 	updateTelemetryState(isOptedIn: boolean): void
 	isTelemetryEnabled(): boolean
 	shutdown(): Promise<void>
@@ -273,6 +273,7 @@ export interface TelemetryClient {
  * These are normal/expected errors that users can't do much about.
  */
 export const EXPECTED_API_ERROR_CODES = new Set([
+	402, // Payment required - billing issues
 	429, // Rate limit - expected when hitting API limits
 ])
 

src/__tests__/extension.spec.ts

@@ -72,12 +72,14 @@ vi.mock("@roo-code/telemetry", () => ({
 		createInstance: vi.fn().mockReturnValue({
 			register: vi.fn(),
 			setProvider: vi.fn(),
+			setAppVersion: vi.fn(),
 			shutdown: vi.fn(),
 		}),
 		get instance() {
 			return {
 				register: vi.fn(),
 				setProvider: vi.fn(),
+				setAppVersion: vi.fn(),
 				shutdown: vi.fn(),
 			}
 		},

src/extension.ts

@@ -71,6 +71,7 @@ export async function activate(context: vscode.ExtensionContext) {
 
 	// Initialize telemetry service.
 	const telemetryService = TelemetryService.createInstance()
+	telemetryService.setAppVersion(Package.version)
 
 	try {
 		telemetryService.register(new PostHogTelemetryClient())