Skip to content

The Open Standard for Generative UI

Standardize telemetry logic (#1473)

Zahle Khan05eb83ee6b87
diff --git a/packages/lang-core/src/telemetry/install.ts b/packages/lang-core/src/telemetry/install.ts
index 30e4be6e6..9041632dc 100644
--- a/packages/lang-core/src/telemetry/install.ts
+++ b/packages/lang-core/src/telemetry/install.ts
@@ -16,7 +16,7 @@
*/
import { id as ciInfoId, isCI as ciInfoIsCI } from "ci-info";
import { execFileSync } from "node:child_process";
-import { createHash, randomBytes, randomUUID } from "node:crypto";
+import { createHash, randomUUID } from "node:crypto";
import { existsSync, mkdirSync, readFileSync, writeFileSync, type WriteFileOptions } from "node:fs";
import { homedir, release } from "node:os";
import path from "node:path";
@@ -25,6 +25,7 @@ import {
isTelemetryDisabled,
isTruthyEnv,
normalizeProjectIdentity,
+ PROJECT_ID_SALT,
TELEMETRY_REQUEST_TIMEOUT_MS,
TELEMETRY_SCHEMA_VERSION,
} from "./shared";
@@ -69,7 +70,6 @@ export interface InstallTelemetryIO {
architecture: string;
release(): string;
randomUUID(): string;
- randomHex(bytes: number): string;
isDocker(): boolean;
stdout(message: string): void;
stderr(message: string): void;
@@ -94,7 +94,6 @@ export type RunInstallTelemetryResult =
interface StoredTelemetryState extends Record<string, unknown> {
distinctId: string;
- projectSalt: string;
langCorePostinstallNoticeShown?: boolean;
}
@@ -146,7 +145,7 @@ export async function runInstallTelemetry(
event: INSTALL_EVENT,
properties: {
telemetry_schema_version: TELEMETRY_SCHEMA_VERSION,
- project_id: hashProjectIdentity(state.projectSalt, projectIdentity.value),
+ project_id: hashProjectIdentity(PROJECT_ID_SALT, projectIdentity.value),
project_id_source: projectIdentity.source,
lang_core_version:
env["OPENUI_LANG_CORE_PACKAGE_VERSION"] || env["npm_package_version"] || "unknown",
@@ -192,7 +191,6 @@ function createInstallTelemetryIO(overrides: Partial<InstallTelemetryIO> = {}):
architecture: process.arch,
release,
randomUUID,
- randomHex: (bytes) => randomBytes(bytes).toString("hex"),
isDocker: defaultIsDocker,
stdout: (message) => process.stdout.write(message),
stderr: (message) => process.stderr.write(message),
@@ -220,10 +218,6 @@ function loadOrCreateState(stateFile: string, io: InstallTelemetryIO): StoredTel
typeof stored["distinctId"] === "string" && stored["distinctId"]
? stored["distinctId"]
: io.randomUUID(),
- projectSalt:
- typeof stored["projectSalt"] === "string" && stored["projectSalt"]
- ? stored["projectSalt"]
- : io.randomHex(16),
langCorePostinstallNoticeShown: stored["langCorePostinstallNoticeShown"] === true,
};
}
diff --git a/packages/lang-core/src/telemetry/runtime.ts b/packages/lang-core/src/telemetry/runtime.ts
index c46ab069c..748f297db 100644
--- a/packages/lang-core/src/telemetry/runtime.ts
+++ b/packages/lang-core/src/telemetry/runtime.ts
@@ -4,6 +4,7 @@ import {
getPostHogConfig,
isRuntimeTelemetryEnabled,
normalizeProjectIdentity,
+ PROJECT_ID_SALT,
TELEMETRY_REQUEST_TIMEOUT_MS,
TELEMETRY_SCHEMA_VERSION,
} from "./shared";
@@ -80,7 +81,7 @@ interface SystemPromptCaptureProperties {
telemetry_schema_version: typeof TELEMETRY_SCHEMA_VERSION;
system_prompt_config_hash_version: 1;
system_prompt_config_hash: string;
- project_hash_version?: 1;
+ project_hash_version?: 2;
project_hash?: string;
component_count: number;
tool_count: number;
@@ -124,7 +125,7 @@ interface ParserParseCaptureProperties {
$process_person_profile: false;
event_id: string;
telemetry_schema_version: typeof TELEMETRY_SCHEMA_VERSION;
- project_hash_version?: 1;
+ project_hash_version?: 2;
project_hash?: string;
sdk_name: "@openuidev/lang-core";
sdk_version: string;
@@ -336,7 +337,7 @@ async function getRepositoryIdentifier(
export function calculateProjectHash(repositoryIdentifier: string): Promise<string> {
const normalized = normalizeProjectIdentity(repositoryIdentifier);
if (!normalized) return Promise.reject(new TypeError("Repository identifier is empty"));
- return sha256(normalized);
+ return sha256(`${PROJECT_ID_SALT}\0${normalized}`);
}
function getProjectHash(state: TelemetryState, runtime: RuntimeInfo): Promise<string | undefined> {
@@ -416,7 +417,7 @@ async function sendSystemPromptCapture(
sample_rate: SYSTEM_PROMPT_SAMPLE_RATE,
...(projectHash
? {
- project_hash_version: 1 as const,
+ project_hash_version: 2 as const,
project_hash: projectHash,
}
: {}),
@@ -533,7 +534,7 @@ async function sendParserParseCapture(
...outcome,
...(projectHash
? {
- project_hash_version: 1 as const,
+ project_hash_version: 2 as const,
project_hash: projectHash,
}
: {}),
diff --git a/packages/lang-core/src/telemetry/shared.ts b/packages/lang-core/src/telemetry/shared.ts
index 6fc7350cb..972b0cb20 100644
--- a/packages/lang-core/src/telemetry/shared.ts
+++ b/packages/lang-core/src/telemetry/shared.ts
@@ -2,7 +2,9 @@
export const POSTHOG_KEY = "phc_3OLW53x09ZTVZSV6BEpj5uycj3ooqR6KOemOjx04e3D";
export const POSTHOG_HOST = "https://dgoeivjus9jfp.cloudfront.net";
export const TELEMETRY_REQUEST_TIMEOUT_MS = 2_000;
-export const TELEMETRY_SCHEMA_VERSION = 1;
+export const TELEMETRY_SCHEMA_VERSION = 2;
+// Fixed salt so installation and runtime telemetry derive project IDs the same standard way.
+export const PROJECT_ID_SALT = "openui-project-id";
export type TelemetryEnvironment = Readonly<Record<string, string | undefined>>;