Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/telemetry.ts
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,7 @@ export function createTelemetry({
if (
config.enabled === false
|| isTelemetryDisabledByEnv(env)
|| isRunningInCI(env)
|| !INSTALL_ID_PATTERN.test(config.installId)
|| !resolvedSink
) {
Expand Down Expand Up @@ -332,6 +333,17 @@ function isTelemetryDisabledByEnv(env: Record<string, string | undefined>): bool
return value !== undefined && DISABLED_ENV_VALUES.has(value);
}

function isRunningInCI(env: Record<string, string | undefined>): boolean {
// Most CI providers set `CI=true` (GitHub Actions, CircleCI, GitLab,
// Travis, Buildkite, Jenkins via plugins, etc.). We also check the
// GitHub Actions-specific marker as belt-and-braces, in case some
// future provider drops the conventional `CI` variable.
return (
env.CI?.trim().toLowerCase() === "true"
|| env.GITHUB_ACTIONS?.trim().toLowerCase() === "true"
);
}

function resolveConfiguredHost(
env: Record<string, string | undefined>,
config: TelemetryConfig,
Expand Down
67 changes: 67 additions & 0 deletions test/telemetry.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,73 @@ test("AGENTRAIL_TELEMETRY_DISABLED=1 wins over enabled config", async () => {
assert.deepEqual(delivered, []);
});

test("CI=true suppresses telemetry even with enabled config", async () => {
const delivered: TelemetrySinkEvent[] = [];
const telemetry = createTelemetry({
source: "cli",
version: "0.1.6",
config: {
enabled: true,
installId,
provider: "posthog",
host: DEFAULT_POSTHOG_HOST,
},
env: { CI: "true" },
sink: async (event) => {
delivered.push(event);
},
});

await telemetry.capture("init_started", { provider: "github" });

assert.deepEqual(delivered, []);
});

test("GITHUB_ACTIONS=true suppresses telemetry even without CI variable", async () => {
const delivered: TelemetrySinkEvent[] = [];
const telemetry = createTelemetry({
source: "cli",
version: "0.1.6",
config: {
enabled: true,
installId,
provider: "posthog",
host: DEFAULT_POSTHOG_HOST,
},
env: { GITHUB_ACTIONS: "true" },
sink: async (event) => {
delivered.push(event);
},
});

await telemetry.capture("init_started", { provider: "github" });

assert.deepEqual(delivered, []);
});

test("CI=false does not suppress telemetry", async () => {
const delivered: TelemetrySinkEvent[] = [];
const telemetry = createTelemetry({
source: "cli",
version: "0.1.6",
config: {
enabled: true,
installId,
provider: "posthog",
host: DEFAULT_POSTHOG_HOST,
},
env: { CI: "false" },
sink: async (event) => {
delivered.push(event);
},
});

await telemetry.capture("init_started", { provider: "github" });

assert.equal(delivered.length, 1);
assert.equal(delivered[0].event, "init_started");
});

test("invalid install id telemetry sends nothing", async () => {
const delivered: TelemetrySinkEvent[] = [];
const telemetry = createTelemetry({
Expand Down
Loading