feat: Added .hai.config to support external overrides for telemetry configuration (#156)

Author: anand-presidio

.changeset/new-knives-reflect.md

@@ -0,0 +1,5 @@
+---
+"hai-build-code-generator": minor
+---
+
+Add .hai.config to support external overrides for telemetry configuration

src/core/controller/index.ts

@@ -71,6 +71,7 @@ import { deleteFromContextDirectory } from "@utils/delete-helper"
 import { isLocalMcp, getLocalMcpDetails, getLocalMcp, getAllLocalMcps } from "@utils/local-mcp-registry"
 import { getStarCount } from "../../services/github/github"
 import { openFile } from "@integrations/misc/open-file"
+import { posthogClientProvider } from "@/services/posthog/PostHogClientProvider"
 
 /*
 https://github.com/microsoft/vscode-webview-ui-toolkit-samples/blob/main/default/weather-webview/src/providers/WeatherViewProvider.ts
@@ -263,7 +264,6 @@ export class Controller {
 				await this.postStateToWebview()
 				break
 			case "webviewDidLaunch":
-				await this.updateHaiRulesState()
 				this.postStateToWebview()
 				this.workspaceTracker?.populateFilePaths() // don't await
 				getTheme().then((theme) =>
@@ -742,9 +742,6 @@ export class Controller {
 					ollamaEmbeddingModels,
 				})
 				break
-			case "checkHaiRules":
-				await this.updateHaiRulesState(true)
-				break
 			case "showToast":
 				switch (message.toast?.toastType) {
 					case "info":
@@ -1877,7 +1874,6 @@ Here is the project's README to help you get started:\n\n${mcpDetails.readmeCont
 			lastShownAnnouncementId,
 			customInstructions,
 			expertPrompt,
-			isHaiRulesPresent,
 			taskHistory,
 			autoApprovalSettings,
 			browserSettings,
@@ -1907,7 +1903,6 @@ Here is the project's README to help you get started:\n\n${mcpDetails.readmeCont
 			apiConfiguration,
 			customInstructions,
 			expertPrompt,
-			isHaiRulesPresent,
 			uriScheme: vscode.env.uriScheme,
 			currentTaskItem: this.task?.taskId ? (taskHistory || []).find((item) => item.id === this.task?.taskId) : undefined,
 			checkpointTrackerErrorMessage: this.task?.checkpointTrackerErrorMessage,
@@ -2512,19 +2507,13 @@ Commit message:`
 		}
 	}
 
-	async updateHaiRulesState(postToWebview: boolean = false) {
-		const workspaceFolder = getWorkspacePath()
-		if (!workspaceFolder) {
-			return
-		}
-		const haiRulesPath = path.join(workspaceFolder, GlobalFileNames.clineRules)
-		const isHaiRulePresent = await fileExistsAtPath(haiRulesPath)
-
-		await customUpdateState(this.context, "isHaiRulesPresent", isHaiRulePresent)
+	async updateTelemetryConfig() {
+		// Create new posthost client
+		posthogClientProvider.initPostHogClient()
 
-		if (postToWebview) {
-			await this.postStateToWebview()
-		}
+		// Update langfuse and posthog instance in telemetry
+		telemetryService.initPostHogClient()
+		telemetryService.initLangfuseClient()
 	}
 
 	async updateExpertPrompt(prompt?: string, expertName?: string) {

src/core/storage/state.ts

@@ -212,7 +212,6 @@ export async function getAllExtensionState(context: vscode.ExtensionContext, wor
 		globalClineRulesToggles,
 		requestTimeoutMs,
 		shellIntegrationTimeout,
-		isHaiRulesPresent,
 		buildContextOptions,
 		buildIndexProgress,
 		isApiConfigurationValid,
@@ -314,7 +313,6 @@ export async function getAllExtensionState(context: vscode.ExtensionContext, wor
 		customGetState(context, "globalClineRulesToggles") as Promise<ClineRulesToggles | undefined>,
 		customGetState(context, "requestTimeoutMs") as Promise<number | undefined>,
 		customGetState(context, "shellIntegrationTimeout") as Promise<number | undefined>,
-		customGetState(context, "isHaiRulesPresent") as Promise<boolean | undefined>,
 		customGetState(context, "buildContextOptions") as Promise<HaiBuildContextOptions | undefined>,
 		customGetState(context, "buildIndexProgress") as Promise<HaiBuildIndexProgress | undefined>,
 		customGetState(context, "isApiConfigurationValid") as Promise<boolean | undefined>,
@@ -469,7 +467,6 @@ export async function getAllExtensionState(context: vscode.ExtensionContext, wor
 		lastShownAnnouncementId,
 		customInstructions,
 		expertPrompt,
-		isHaiRulesPresent,
 		taskHistory,
 		buildContextOptions: buildContextOptions
 			? {

src/global-constants.ts

@@ -7,4 +7,5 @@ export const GlobalFileNames = {
 	clineRules: ".hairules",
 	experts: ".hai-experts",
 	defaultExperts: "src/experts",
+	haiConfig: ".hai.config",
 }

src/integrations/workspace/HaiFileSystemWatcher.ts

@@ -28,7 +28,7 @@ class HaiFileSystemWatcher {
 			this.ig.add(
 				content
 					.split("\n")
-					.filter((line) => line.trim() && !line.startsWith("#") && !line.includes(GlobalFileNames.clineRules)),
+					.filter((line) => line.trim() && !line.startsWith("#") && !line.includes(GlobalFileNames.haiConfig)),
 			)
 		} catch (error) {
 			console.log("HaiFileSystemWatcher No .gitignore found, using default exclusions.")
@@ -67,9 +67,9 @@ class HaiFileSystemWatcher {
 		this.watcher.on("unlink", (filePath) => {
 			console.log("HaiFileSystemWatcher File deleted", filePath)
 
-			// Check for .hairules
-			if (this.isHaiRulesPath(filePath)) {
-				this.providerRef.deref()?.updateHaiRulesState(true)
+			// Check for .hai.config
+			if (this.isHaiConfigPath(filePath)) {
+				this.providerRef.deref()?.updateTelemetryConfig()
 			}
 
 			// Check for the experts
@@ -83,9 +83,9 @@ class HaiFileSystemWatcher {
 		this.watcher.on("add", (filePath) => {
 			console.log("HaiFileSystemWatcher File added", filePath)
 
-			// Check for .hairules
-			if (this.isHaiRulesPath(filePath)) {
-				this.providerRef.deref()?.updateHaiRulesState(true)
+			// Check for .hai.config
+			if (this.isHaiConfigPath(filePath)) {
+				this.providerRef.deref()?.updateTelemetryConfig()
 			}
 
 			// Check for the experts
@@ -98,6 +98,12 @@ class HaiFileSystemWatcher {
 
 		this.watcher.on("change", (filePath) => {
 			console.log("HaiFileSystemWatcher File changes", filePath)
+
+			// Check for .hai.config
+			if (this.isHaiConfigPath(filePath)) {
+				this.providerRef.deref()?.updateTelemetryConfig()
+			}
+
 			// Check for the experts
 			if (filePath.includes(GlobalFileNames.experts)) {
 				this.providerRef.deref()?.loadExperts()
@@ -106,11 +112,11 @@ class HaiFileSystemWatcher {
 		})
 	}
 
-	isHaiRulesPath(path: string) {
+	isHaiConfigPath(path: string) {
 		const pathSplit = path.split(this.sourceFolder)
 		const hairulesPath = pathSplit.length === 2 ? pathSplit[1].replace("/", "") : ""
 
-		return hairulesPath === GlobalFileNames.clineRules
+		return hairulesPath === GlobalFileNames.haiConfig
 	}
 
 	async dispose() {

src/services/posthog/PostHogClientProvider.ts

@@ -1,15 +1,26 @@
 import { PostHog } from "posthog-node"
 import { posthogConfig } from "@/shared/services/config/posthog-config"
+import { HaiConfig } from "@/shared/hai-config"
 
-class PostHogClientProvider {
+export class PostHogClientProvider {
 	private static instance: PostHogClientProvider
 	private client: PostHog
 
 	private constructor() {
-		this.client = new PostHog(posthogConfig.apiKey, {
-			host: posthogConfig.host,
+		this.client = this.initPostHogClient()
+	}
+
+	public initPostHogClient() {
+		const config = HaiConfig.getPostHogConfig()
+		const apiKey = config && config.apiKey ? config.apiKey : posthogConfig.apiKey
+		const host = config && config.url ? config.url : posthogConfig.host
+
+		this.client = new PostHog(apiKey, {
+			host,
 			enableExceptionAutocapture: false,
 		})
+
+		return this.client
 	}
 
 	public static getInstance(): PostHogClientProvider {

src/services/posthog/telemetry/TelemetryService.ts

@@ -6,6 +6,7 @@ import type { BrowserSettings } from "@shared/BrowserSettings"
 import { posthogClientProvider } from "../PostHogClientProvider"
 import { getGitUserInfo } from "@utils/git"
 import { Langfuse, LangfuseTraceClient } from "langfuse"
+import { HaiConfig } from "@/shared/hai-config"
 
 /**
  * PostHogClient handles telemetry event tracking for the Cline extension
@@ -122,25 +123,10 @@ class PostHogClient {
 	 * Initializes PostHog client with configuration
 	 */
 	private constructor() {
-		this.client = posthogClientProvider.getClient()
-
-		// Set distinct ID for the client & identify the user
-		this.client.identify({
-			distinctId: this.distinctId,
-			properties: {
-				name: this.gitUserInfo.username,
-				email: this.gitUserInfo.email,
-			},
-		})
+		this.client = this.initPostHogClient()
 
 		// Initialize Langfuse client
-		this.langfuse = new Langfuse({
-			secretKey: process.env.LANGFUSE_API_KEY!,
-			publicKey: process.env.LANGFUSE_PUBLIC_KEY!,
-			baseUrl: process.env.LANGFUSE_API_URL,
-			requestTimeout: 10000,
-			enabled: true,
-		})
+		this.langfuse = this.initLangfuseClient()
 	}
 
 	private createLangfuseTraceClient(taskId: string, isNew: boolean = false) {
@@ -159,6 +145,38 @@ class PostHogClient {
 		})
 	}
 
+	public initPostHogClient() {
+		this.client = posthogClientProvider.getClient()
+
+		// Set distinct ID for the client & identify the user
+		this.client.identify({
+			distinctId: this.distinctId,
+			properties: {
+				name: this.gitUserInfo.username,
+				email: this.gitUserInfo.email,
+			},
+		})
+
+		return this.client
+	}
+
+	public initLangfuseClient() {
+		const config = HaiConfig.getLangfuseConfig()
+		const secretKey = config && config.apiKey ? config.apiKey : process.env.LANGFUSE_API_KEY!
+		const publicKey = config && config.publicKey ? config.publicKey : process.env.LANGFUSE_PUBLIC_KEY!
+		const baseUrl = config && config.apiUrl ? config.apiUrl : process.env.LANGFUSE_API_URL
+
+		this.langfuse = new Langfuse({
+			secretKey,
+			publicKey,
+			baseUrl,
+			requestTimeout: 10000,
+			enabled: true,
+		})
+
+		return this.langfuse
+	}
+
 	/**
 	 * Updates the telemetry state based on user preferences and VSCode settings
 	 * Only enables telemetry if both VSCode global telemetry is enabled and user has opted in

src/shared/ExtensionMessage.ts

@@ -170,7 +170,6 @@ export interface ExtensionState {
 	telemetrySetting: TelemetrySetting
 	shellIntegrationTimeout: number
 	uriScheme?: string
-	isHaiRulesPresent?: boolean
 	userInfo?: {
 		displayName: string | null
 		email: string | null

src/shared/WebviewMessage.ts

@@ -86,7 +86,6 @@ export interface WebviewMessage {
 		| "searchCommits"
 		| "showMcpView"
 		| "fetchLatestMcpServersFromHub"
-		| "checkHaiRules"
 		| "telemetrySetting"
 		| "openSettings"
 		| "updateMcpTimeout"

src/shared/hai-config.ts

@@ -0,0 +1,86 @@
+import * as fs from "fs"
+import * as path from "path"
+import { z } from "zod"
+import { GlobalFileNames } from "@/global-constants"
+import { getWorkspacePath } from "@/utils/path"
+
+export const haiConfigSchema = z.object({
+	name: z.string().optional(),
+	langfuse: z
+		.object({
+			apiUrl: z.string().trim().optional(),
+			apiKey: z.string().trim().optional(),
+			publicKey: z.string().trim().optional(),
+		})
+		.optional(),
+	posthog: z
+		.object({
+			url: z.string().trim().optional(),
+			apiKey: z.string().trim().optional(),
+		})
+		.optional(),
+})
+
+export class HaiConfig {
+	static getConfig(workspacePath?: string) {
+		if (!workspacePath) {
+			workspacePath = getWorkspacePath()
+		}
+
+		// Parse hai config file
+		const configPath = path.join(workspacePath, GlobalFileNames.haiConfig)
+		if (!fs.existsSync(configPath)) {
+			console.log(`[HaiConfig]: ${configPath} does not exist`)
+			return
+		}
+
+		const content = fs.readFileSync(configPath, "utf-8")
+		const lines = content.split("\n")
+
+		const config: Record<string, any> = {}
+
+		for (const line of lines) {
+			const trimmed = line.trim()
+			if (!trimmed || trimmed.startsWith("#")) {
+				continue
+			}
+
+			const [key, ...rest] = trimmed.split("=")
+			const value = rest.join("=").trim() // supports '=' in value
+
+			const keyParts = key.trim().split(".")
+
+			let current = config
+			for (let i = 0; i < keyParts.length; i++) {
+				const part = keyParts[i]
+				if (i === keyParts.length - 1) {
+					current[part] = value
+				} else {
+					if (!current[part]) {
+						current[part] = {}
+					}
+					current = current[part]
+				}
+			}
+		}
+
+		// Validate the parsed content with schema
+		const { success, data, error } = haiConfigSchema.safeParse(config)
+		if (!success) {
+			console.error(`Error validating ${configPath}, Error: ${error}`)
+			return
+		}
+
+		return data
+	}
+
+	static getPostHogConfig(workspacePath?: string) {
+		const config = HaiConfig.getConfig(workspacePath)
+		return config?.posthog
+	}
+
+	static getLangfuseConfig(workspacePath?: string) {
+		const config = HaiConfig.getConfig(workspacePath)
+		return config?.langfuse
+	}
+}

webview-ui/src/components/settings/SettingsView.tsx

@@ -27,7 +27,6 @@ const SettingsView = ({ onDone }: SettingsViewProps) => {
 		version,
 		customInstructions,
 		setCustomInstructions,
-		isHaiRulesPresent,
 		buildContextOptions,
 		setBuildContextOptions,
 		buildIndexProgress,

webview-ui/src/components/welcome/WelcomeView.tsx

@@ -16,7 +16,6 @@ const WelcomeView = () => {
 	const handleSubmit = () => {
 		vscode.postMessage({ type: "apiConfiguration", apiConfiguration })
 		vscode.postMessage({ type: "embeddingConfiguration", embeddingConfiguration })
-		vscode.postMessage({ type: "checkHaiRules" })
 	}
 
 	return (

webview-ui/src/context/ExtensionStateContext.tsx

@@ -67,7 +67,6 @@ export const ExtensionStateContextProvider: React.FC<{
 		version: "",
 		clineMessages: [],
 		taskHistory: [],
-		isHaiRulesPresent: false,
 		shouldShowAnnouncement: false,
 		autoApprovalSettings: DEFAULT_AUTO_APPROVAL_SETTINGS,
 		browserSettings: DEFAULT_BROWSER_SETTINGS,