File size: 5,769 Bytes
7a1ad33 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 | /**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, it, expect } from 'vitest';
import {
parseBooleanEnvFlag,
parseTelemetryTargetValue,
resolveTelemetrySettings,
} from './config.js';
import { TelemetryTarget } from './index.js';
describe('telemetry/config helpers', () => {
describe('parseBooleanEnvFlag', () => {
it('returns undefined for undefined', () => {
expect(parseBooleanEnvFlag(undefined)).toBeUndefined();
});
it('parses true values', () => {
expect(parseBooleanEnvFlag('true')).toBe(true);
expect(parseBooleanEnvFlag('1')).toBe(true);
});
it('parses false/other values as false', () => {
expect(parseBooleanEnvFlag('false')).toBe(false);
expect(parseBooleanEnvFlag('0')).toBe(false);
expect(parseBooleanEnvFlag('TRUE')).toBe(false);
expect(parseBooleanEnvFlag('random')).toBe(false);
expect(parseBooleanEnvFlag('')).toBe(false);
});
});
describe('parseTelemetryTargetValue', () => {
it('parses string values', () => {
expect(parseTelemetryTargetValue('local')).toBe(TelemetryTarget.LOCAL);
expect(parseTelemetryTargetValue('gcp')).toBe(TelemetryTarget.GCP);
});
it('accepts enum values', () => {
expect(parseTelemetryTargetValue(TelemetryTarget.LOCAL)).toBe(
TelemetryTarget.LOCAL,
);
expect(parseTelemetryTargetValue(TelemetryTarget.GCP)).toBe(
TelemetryTarget.GCP,
);
});
it('returns undefined for unknown', () => {
expect(parseTelemetryTargetValue('other')).toBeUndefined();
expect(parseTelemetryTargetValue(undefined)).toBeUndefined();
});
});
describe('resolveTelemetrySettings', () => {
it('falls back to settings when no argv/env provided', async () => {
const settings = {
enabled: false,
target: TelemetryTarget.LOCAL,
otlpEndpoint: 'http://localhost:4317',
otlpProtocol: 'grpc' as const,
logPrompts: false,
outfile: 'settings.log',
useCollector: false,
};
const resolved = await resolveTelemetrySettings({ settings });
expect(resolved).toEqual(settings);
});
it('uses env over settings and argv over env', async () => {
const settings = {
enabled: false,
target: TelemetryTarget.LOCAL,
otlpEndpoint: 'http://settings:4317',
otlpProtocol: 'grpc' as const,
logPrompts: false,
outfile: 'settings.log',
useCollector: false,
};
const env = {
GEMINI_TELEMETRY_ENABLED: '1',
GEMINI_TELEMETRY_TARGET: 'gcp',
GEMINI_TELEMETRY_OTLP_ENDPOINT: 'http://env:4317',
GEMINI_TELEMETRY_OTLP_PROTOCOL: 'http',
GEMINI_TELEMETRY_LOG_PROMPTS: 'true',
GEMINI_TELEMETRY_OUTFILE: 'env.log',
GEMINI_TELEMETRY_USE_COLLECTOR: 'true',
} as Record<string, string>;
const argv = {
telemetry: false,
telemetryTarget: 'local',
telemetryOtlpEndpoint: 'http://argv:4317',
telemetryOtlpProtocol: 'grpc',
telemetryLogPrompts: false,
telemetryOutfile: 'argv.log',
};
const resolvedEnv = await resolveTelemetrySettings({ env, settings });
expect(resolvedEnv).toEqual({
enabled: true,
target: TelemetryTarget.GCP,
otlpEndpoint: 'http://env:4317',
otlpProtocol: 'http',
logPrompts: true,
outfile: 'env.log',
useCollector: true,
});
const resolvedArgv = await resolveTelemetrySettings({
argv,
env,
settings,
});
expect(resolvedArgv).toEqual({
enabled: false,
target: TelemetryTarget.LOCAL,
otlpEndpoint: 'http://argv:4317',
otlpProtocol: 'grpc',
logPrompts: false,
outfile: 'argv.log',
useCollector: true, // from env as no argv option
useCliAuth: undefined,
});
});
it('resolves useCliAuth from settings', async () => {
const settings = {
useCliAuth: true,
};
const resolved = await resolveTelemetrySettings({ settings });
expect(resolved.useCliAuth).toBe(true);
});
it('resolves useCliAuth from env', async () => {
const env = {
GEMINI_TELEMETRY_USE_CLI_AUTH: 'true',
};
const resolved = await resolveTelemetrySettings({ env });
expect(resolved.useCliAuth).toBe(true);
});
it('env overrides settings for useCliAuth', async () => {
const settings = {
useCliAuth: false,
};
const env = {
GEMINI_TELEMETRY_USE_CLI_AUTH: 'true',
};
const resolved = await resolveTelemetrySettings({ env, settings });
expect(resolved.useCliAuth).toBe(true);
});
it('falls back to OTEL_EXPORTER_OTLP_ENDPOINT when GEMINI var is missing', async () => {
const settings = {};
const env = {
OTEL_EXPORTER_OTLP_ENDPOINT: 'http://otel:4317',
} as Record<string, string>;
const resolved = await resolveTelemetrySettings({ env, settings });
expect(resolved.otlpEndpoint).toBe('http://otel:4317');
});
it('throws on unknown protocol values', async () => {
const env = { GEMINI_TELEMETRY_OTLP_PROTOCOL: 'unknown' } as Record<
string,
string
>;
await expect(resolveTelemetrySettings({ env })).rejects.toThrow(
/Invalid telemetry OTLP protocol/i,
);
});
it('throws on unknown target values', async () => {
const env = { GEMINI_TELEMETRY_TARGET: 'unknown' } as Record<
string,
string
>;
await expect(resolveTelemetrySettings({ env })).rejects.toThrow(
/Invalid telemetry target/i,
);
});
});
});
|