Skip to content

A desktop coding agent with free access to frontier models.

TypeScript

fix: desktop analytics only from release builds

ogsamrat25cb561f2c16
diff --git a/apps/app/src/app/lib/analytics-key.ts b/apps/app/src/app/lib/analytics-key.ts
index c6726720..02b680b9 100644
--- a/apps/app/src/app/lib/analytics-key.ts
+++ b/apps/app/src/app/lib/analytics-key.ts
@@ -2,7 +2,17 @@
* Resolve the PostHog project key. `raw` is VITE_OMNIRUSH_POSTHOG_KEY.
* There is no built-in key: analytics stay off unless a build sets one.
* Explicit strings are used after trim; unset or blank disables analytics.
+ *
+ * Only a packaged build stamped with a release version sends: a dev or
+ * unpackaged build (`pnpm dev`, a source checkout, the "0.0.0-dev"
+ * placeholder version) never does, even with the key in its environment,
+ * like the CLI's source checkout.
*/
-export function resolvePosthogKey(raw: unknown): string {
- return typeof raw === "string" ? raw.trim() : "";
+export function resolvePosthogKey(raw: unknown, build: { appVersion?: string | null; packaged?: boolean } = {}): string {
+ const key = typeof raw === "string" ? raw.trim() : "";
+ if (!key || build.packaged !== true) return "";
+ const version = (build.appVersion ?? "").trim();
+ const release = /^(\d+)\.(\d+)\.(\d+)(?:-[0-9A-Za-z.-]+)?$/.exec(version);
+ if (!release || /^0\.0\.0(?:-|$)/.test(version) || /-dev(?:[.-]|$)/i.test(version)) return "";
+ return key;
}
diff --git a/apps/app/src/app/lib/analytics.ts b/apps/app/src/app/lib/analytics.ts
index 05b0a0a1..91757de0 100644
--- a/apps/app/src/app/lib/analytics.ts
+++ b/apps/app/src/app/lib/analytics.ts
@@ -22,13 +22,16 @@ import { resolvePosthogKey } from "./analytics-key";
const ENV_POSTHOG_HOST = String(import.meta.env.VITE_OMNIRUSH_POSTHOG_HOST ?? "").trim();
const ENV_APP_VERSION = String(import.meta.env.VITE_OMNIRUSH_APP_VERSION ?? "").trim();
+/** Set by the packaged Electron build (vite.config.ts); empty in `pnpm dev` and other unpackaged builds. */
+const ENV_PACKAGED_BUILD = String(import.meta.env.VITE_OMNIRUSH_PACKAGED_BUILD ?? "").trim() === "1";
const DEFAULT_POSTHOG_HOST = "https://us.i.posthog.com";
// No built-in key: nothing is sent unless the build sets
-// VITE_OMNIRUSH_POSTHOG_KEY. The inspector mirror still records events
-// locally either way.
-let posthogKey = resolvePosthogKey(import.meta.env.VITE_OMNIRUSH_POSTHOG_KEY);
+// VITE_OMNIRUSH_POSTHOG_KEY, and only a packaged release build uses it
+// (never a dev build). The inspector mirror still records events locally
+// either way.
+let posthogKey = resolvePosthogKey(import.meta.env.VITE_OMNIRUSH_POSTHOG_KEY, { appVersion: ENV_APP_VERSION, packaged: ENV_PACKAGED_BUILD });
let posthogHost = (ENV_POSTHOG_HOST || DEFAULT_POSTHOG_HOST).replace(/\/+$/, "");
let appVersion = ENV_APP_VERSION;
@@ -67,7 +70,8 @@ const hadPreferencesAtStart = (() => {
/** Tests only: set the key, host and version a build would. */
export function configureAnalyticsForTests(config: { key?: string; host?: string; appVersion?: string }) {
- if (config.key !== undefined) posthogKey = resolvePosthogKey(config.key);
+ // As a packaged release build would.
+ if (config.key !== undefined) posthogKey = resolvePosthogKey(config.key, { appVersion: "1.0.0", packaged: true });
if (config.host !== undefined) posthogHost = config.host.replace(/\/+$/, "");
if (config.appVersion !== undefined) appVersion = config.appVersion;
}
@@ -126,6 +130,7 @@ export function analyticsOs(platform: string | null | undefined): string {
function baseProperties(): AnalyticsProperties {
const platform = typeof navigator === "undefined" ? null : navigator.platform || null;
return {
+ client: "desktop",
app_version: appVersion || null,
platform,
os: analyticsOs(platform),
diff --git a/apps/app/tests/analytics-key.test.ts b/apps/app/tests/analytics-key.test.ts
index b6ca452b..9eb7a3a0 100644
--- a/apps/app/tests/analytics-key.test.ts
+++ b/apps/app/tests/analytics-key.test.ts
@@ -1,27 +1,49 @@
import { describe, expect, test } from "bun:test";
+import { readFileSync } from "node:fs";
+import path from "node:path";
import * as analyticsKey from "../src/app/lib/analytics-key";
import { resolvePosthogKey } from "../src/app/lib/analytics-key";
+const release = { appVersion: "3.5.9", packaged: true };
+
describe("analytics-key", () => {
test("ships without a built-in key", () => {
expect(Object.keys(analyticsKey)).toEqual(["resolvePosthogKey"]);
});
test("stays silent without an env key", () => {
- expect(resolvePosthogKey(undefined)).toBe("");
- expect(resolvePosthogKey(null)).toBe("");
+ expect(resolvePosthogKey(undefined, release)).toBe("");
+ expect(resolvePosthogKey(null, release)).toBe("");
});
test("treats an explicit blank as disabled", () => {
- expect(resolvePosthogKey("")).toBe("");
+ expect(resolvePosthogKey("", release)).toBe("");
});
test("trims whitespace to disabled", () => {
- expect(resolvePosthogKey(" ")).toBe("");
+ expect(resolvePosthogKey(" ", release)).toBe("");
+ });
+
+ test("uses an explicit key after trim in a packaged release build", () => {
+ expect(resolvePosthogKey(" phc_custom ", release)).toBe("phc_custom");
+ expect(resolvePosthogKey("phc_custom", { appVersion: "3.6.0-rc.1", packaged: true })).toBe("phc_custom");
+ });
+
+ test("never sends from a dev or unpackaged build, even with the key set", () => {
+ // `pnpm dev`, a source checkout, an unpackaged build: no packaged flag.
+ expect(resolvePosthogKey("phc_custom")).toBe("");
+ expect(resolvePosthogKey("phc_custom", { appVersion: "3.5.9" })).toBe("");
+ expect(resolvePosthogKey("phc_custom", { appVersion: "3.5.9", packaged: false })).toBe("");
+ // A packaged build that was never stamped with a release version.
+ for (const appVersion of ["0.0.0-dev", "0.0.0", "", null, "3.5.9-dev", "3.5.9-dev.2", "dev", "latest"]) {
+ expect(resolvePosthogKey("phc_custom", { appVersion, packaged: true })).toBe("");
+ }
});
- test("uses an explicit key after trim", () => {
- expect(resolvePosthogKey(" phc_custom ")).toBe("phc_custom");
+ test("the packaged flag comes only from the Electron build", () => {
+ const vite = readFileSync(path.join(import.meta.dir, "..", "vite.config.ts"), "utf8");
+ expect(vite).toContain('"import.meta.env.VITE_OMNIRUSH_PACKAGED_BUILD": JSON.stringify(isElectronPackagedBuild ? "1" : "")');
+ expect(vite).toContain('const isElectronPackagedBuild = process.env.OMNIRUSH_ELECTRON_BUILD === "1"');
});
});
diff --git a/apps/app/tests/analytics.test.ts b/apps/app/tests/analytics.test.ts
index 5dc1323f..a75bf9be 100644
--- a/apps/app/tests/analytics.test.ts
+++ b/apps/app/tests/analytics.test.ts
@@ -60,8 +60,8 @@ describe("analytics identity", () => {
analytics.captureAnalyticsEvent("app_opened", {});
const [event] = await flushed();
expect(event.distinct_id).toBe(analytics.getAnalyticsDistinctId());
- expect(event.properties).toMatchObject({ app_version: "3.5.8" });
- expect(Object.keys(event.properties)).toEqual(expect.arrayContaining(["app_version", "platform", "os"]));
+ expect(event.properties).toMatchObject({ client: "desktop", app_version: "3.5.8" });
+ expect(Object.keys(event.properties)).toEqual(expect.arrayContaining(["client", "app_version", "platform", "os"]));
expect(sent[0].url).toBe("http://127.0.0.1:9/batch/");
expect(sent[0].body.api_key).toBe(NEW_KEY);
});
diff --git a/apps/app/vite.config.ts b/apps/app/vite.config.ts
index 9b4ffdc8..5a0b782d 100644
--- a/apps/app/vite.config.ts
+++ b/apps/app/vite.config.ts
@@ -89,6 +89,8 @@ export default defineConfig({
define: {
"import.meta.env.VITE_OMNIRUSH_APP_VERSION": JSON.stringify(buildAppVersion),
"import.meta.env.VITE_OMNIRUSH_BUILD_SHA": JSON.stringify(shortBuildSha),
+ // Analytics send only from a packaged release build (analytics-key.ts).
+ "import.meta.env.VITE_OMNIRUSH_PACKAGED_BUILD": JSON.stringify(isElectronPackagedBuild ? "1" : ""),
},
plugins: [
{