The Open Standard for Generative UI
Improve LangCore CI telemetry detection (#975)
Zahle Khan44fa7952f1e2
diff --git a/packages/lang-core/package.json b/packages/lang-core/package.jsonindex 81e269cd6..673f4ee2e 100644--- a/packages/lang-core/package.json+++ b/packages/lang-core/package.json@@ -75,5 +75,8 @@"@modelcontextprotocol/sdk": "^1.27.1","@types/node": "^20","vitest": "^4.0.18"+ },+ "dependencies": {+ "ci-info": "^4.4.0"}}diff --git a/packages/lang-core/src/telemetry/install.ts b/packages/lang-core/src/telemetry/install.tsindex d272469c8..30e4be6e6 100644--- a/packages/lang-core/src/telemetry/install.ts+++ b/packages/lang-core/src/telemetry/install.ts@@ -14,29 +14,28 @@* proxy and PostHog can observe the source IP as transport metadata; the script does* not read it or add it to the payload.*/+import { id as ciInfoId, isCI as ciInfoIsCI } from "ci-info";import { execFileSync } from "node:child_process";import { createHash, randomBytes, 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";import {- detectCI,getPostHogConfig,isTelemetryDisabled,isTruthyEnv,normalizeProjectIdentity,TELEMETRY_REQUEST_TIMEOUT_MS,TELEMETRY_SCHEMA_VERSION,- type CiName,} from "./shared";-export { detectCI, isTelemetryDisabled, isTruthyEnv, normalizeProjectIdentity };-export type { CiName };+export { isTelemetryDisabled, isTruthyEnv, normalizeProjectIdentity };export const INSTALL_EVENT = "openui_lang_core_installed";export type ProjectIdSource = "git_origin" | "repository_url" | "install_root";export type PackageManagerName = "npm" | "pnpm" | "yarn" | "bun" | "unknown";+export interface InstallTelemetryProperties extends Record<string, unknown> {telemetry_schema_version: number;project_id: string;@@ -49,7 +48,7 @@ export interface InstallTelemetryProperties extends Record<string, unknown> {package_manager: PackageManagerName;package_manager_version?: string;ci: boolean;- ci_name?: CiName;+ ci_name?: string;is_docker: boolean;}@@ -141,7 +140,6 @@ export async function runInstallTelemetry(const projectRoot = path.resolve(env["INIT_CWD"] || io.cwd());const projectIdentity = resolveProjectIdentity(projectRoot, env, io);const packageManager = detectPackageManager(env);- const ci = detectCI(env);payload = {distinctId: state.distinctId,@@ -158,8 +156,8 @@ export async function runInstallTelemetry(system_architecture: io.architecture,package_manager: packageManager.name,...(packageManager.version ? { package_manager_version: packageManager.version } : {}),- ci: ci.ci,- ...(ci.name ? { ci_name: ci.name } : {}),+ ci: ciInfoIsCI,+ ...(ciInfoId ? { ci_name: ciInfoId } : {}),is_docker: io.isDocker(),},};diff --git a/packages/lang-core/src/telemetry/runtime.ts b/packages/lang-core/src/telemetry/runtime.tsindex c4bc60a64..0359b291a 100644--- a/packages/lang-core/src/telemetry/runtime.ts+++ b/packages/lang-core/src/telemetry/runtime.ts@@ -1,6 +1,5 @@import type { PromptSpec } from "../parser/prompt";import {- detectCI,getPostHogConfig,isTelemetryDisabled,normalizeProjectIdentity,@@ -12,7 +11,7 @@ import {* Telemetry disclosure** Sent for sampled server-side generations:- * - Event timestamp, SDK and runtime versions, environment and CI status+ * - Event timestamp, SDK and runtime versions, environment, CI status, and CI provider category* - API input shape, component count, tool count, and schema/sample versions* - Random event and runtime identifiers* - A locally computed SHA-256 prompt-configuration hash@@ -83,9 +82,15 @@ interface CaptureProperties {runtime_version?: string;environment: Environment;ci: boolean;+ ci_name?: string;sample_rate: 0.1;}+interface CiInfoSnapshot {+ id: string | null;+ isCI: boolean;+}+const STATE_KEY = Symbol.for("@openuidev/lang-core/telemetry/v1");export function buildSystemPromptConfigProjection(spec: PromptSpec): Json {@@ -287,6 +292,17 @@ function getProjectHash(state: TelemetryState, runtime: RuntimeInfo): Promise<streturn state.projectHash;}+async function getCIInfo(runtime: RuntimeInfo): Promise<CiInfoSnapshot> {+ if (!runtime.env) return { id: null, isCI: false };++ try {+ const ciInfo = await import("ci-info");+ return { id: ciInfo.id, isCI: ciInfo.isCI };+ } catch {+ return { id: null, isCI: false };+ }+}+async function sendCapture(state: TelemetryState,spec: PromptSpec,@@ -295,9 +311,10 @@ async function sendCapture(runtime: RuntimeInfo,environment: Environment,): Promise<void> {- const [systemPromptConfigHash, projectHash] = await Promise.all([+ const [systemPromptConfigHash, projectHash, ciInfo] = await Promise.all([configHash,getProjectHash(state, runtime),+ getCIInfo(runtime),]);const postHog = getPostHogConfig(runtime.env);@@ -317,7 +334,8 @@ async function sendCapture(runtime: runtime.name,runtime_version: runtime.version,environment,- ci: detectCI(runtime.env).ci,+ ci: ciInfo.isCI,+ ...(ciInfo.id ? { ci_name: ciInfo.id } : {}),sample_rate: SAMPLE_RATE,...(projectHash? {diff --git a/packages/lang-core/src/telemetry/shared.ts b/packages/lang-core/src/telemetry/shared.tsindex 25a24fcb4..fefc605e9 100644--- a/packages/lang-core/src/telemetry/shared.ts+++ b/packages/lang-core/src/telemetry/shared.ts@@ -6,29 +6,6 @@ export const TELEMETRY_SCHEMA_VERSION = 1;export type TelemetryEnvironment = Readonly<Record<string, string | undefined>>;-export type CiName =- | "github_actions"- | "gitlab_ci"- | "buildkite"- | "circleci"- | "vercel"- | "netlify"- | "jenkins"- | "travis";--const CI_PROVIDERS: ReadonlyArray<readonly [string, CiName]> = [- ["GITHUB_ACTIONS", "github_actions"],- ["GITLAB_CI", "gitlab_ci"],- ["BUILDKITE", "buildkite"],- ["CIRCLECI", "circleci"],- ["VERCEL", "vercel"],- ["NETLIFY", "netlify"],- ["JENKINS_URL", "jenkins"],- ["TRAVIS", "travis"],-];--const GENERIC_CI_ENV_VARS = ["CI", "CONTINUOUS_INTEGRATION", "BUILD_NUMBER"] as const;-export function getPostHogConfig(env?: TelemetryEnvironment): {apiKey: string;captureUrl: string;@@ -48,16 +25,6 @@ export function isTelemetryDisabled(env?: TelemetryEnvironment): boolean {return isTruthyEnv(env?.["OPENUI_TELEMETRY_DISABLED"]) || isTruthyEnv(env?.["DO_NOT_TRACK"]);}-export function detectCI(env?: TelemetryEnvironment): { ci: boolean; name?: CiName } {- if (!env) return { ci: false };-- const provider = CI_PROVIDERS.find(([key]) => isEnabledEnvValue(env[key]));- return {- ci: Boolean(provider) || GENERIC_CI_ENV_VARS.some((key) => isEnabledEnvValue(env[key])),- ...(provider ? { name: provider[1] } : {}),- };-}-export function normalizeProjectIdentity(rawValue: string): string {const value = rawValue.trim();if (!value) return "";@@ -79,12 +46,6 @@ export function normalizeProjectIdentity(rawValue: string): string {return normalizeRepositoryPath(value);}-function isEnabledEnvValue(value: string | undefined): boolean {- if (!value) return false;- const normalized = value.toLowerCase();- return normalized !== "0" && normalized !== "false";-}-function joinHostAndPath(host: string, repositoryPath: string): string {const normalizedHost = host.trim().toLowerCase();const normalizedPath = normalizeRepositoryPath(repositoryPath);diff --git a/pnpm-lock.yaml b/pnpm-lock.yamlindex fc03eb9e8..d0e390ef1 100644--- a/pnpm-lock.yaml+++ b/pnpm-lock.yaml@@ -1766,6 +1766,9 @@ importers:packages/lang-core:dependencies:+ ci-info:+ specifier: ^4.4.0+ version: 4.4.0zod:specifier: 'catalog:'version: 4.4.3@@ -10768,6 +10771,10 @@ packages:resolution: {integrity: sha512-NIxF55hv4nSqQswkAeiOi1r83xy8JldOFDTWiug55KBu9Jnblncd2U6ViHmYgHf01TPZS77NJBhBMKdWj9HQMQ==}engines: {node: '>=8'}+ resolution: {integrity: sha512-77PSwercCZU2Fc4sX94eF8k8Pxte6JAwL4/ICZLFjJLqegs7kCuAsqqj/70NQF6TvDpgFjkubQB2FW2ZZddvQg==}+ engines: {node: '>=8'}+resolution: {integrity: sha512-tskPPKEs8D2KPafUypv2gxwJP8h/OaJmC82QQGGDQcHvXX43xF2VDACcJVmZ0EuSxkpO9Kc4MlrA3q0+FG58AQ==}@@ -29644,6 +29651,8 @@ snapshots:+ [email protected]: {}+dependencies:consola: 3.4.2