File size: 15,125 Bytes
f0634fb | 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 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 | import { mkdtempSync, readdirSync, rmSync, writeFileSync } from 'node:fs';
import { tmpdir } from 'node:os';
import { join } from 'node:path';
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
import {
resetUnexpectedErrorHandler,
setUnexpectedErrorHandler,
} from '#/_base/errors/unexpectedError';
import { FileStorageService } from '#/persistence/backends/node-fs/fileStorageService';
import { CloudAppender, type CloudAppenderOptions } from '#/app/telemetry/cloudAppender';
import { stubBootstrap, stubClientIdentity } from '../bootstrap/stubs';
interface CapturedRequest {
readonly url: string;
readonly headers: Record<string, string>;
readonly body: {
readonly user_id: string;
readonly events: readonly Record<string, unknown>[];
};
}
type Responder = (req: CapturedRequest) => Response | Promise<Response>;
function makeFetch(responder: Responder): typeof fetch {
return (async (input: unknown, init: unknown) => {
const requestInit = init as { headers: Record<string, string>; body: string };
const req: CapturedRequest = {
url: String(input),
headers: requestInit.headers,
body: JSON.parse(requestInit.body) as CapturedRequest['body'],
};
return responder(req);
}) as unknown as typeof fetch;
}
function okResponse(): Response {
return new Response(null, { status: 200 });
}
function statusResponse(status: number): Response {
return new Response(null, { status });
}
function baseOptions(
overrides: Partial<CloudAppenderOptions> & { homeDir?: string; bootstrapEnv?: NodeJS.ProcessEnv } = {},
): CloudAppenderOptions {
const { homeDir: dir = '', storage, bootstrapEnv, ...rest } = overrides;
return {
storage: storage ?? new FileStorageService(dir),
bootstrap: {
...stubBootstrap(dir === '' ? undefined : dir, bootstrapEnv),
clientIdentity: { ...stubClientIdentity, version: '1.0.0' },
},
deviceId: 'dev',
appName: 'test-app',
sleep: async () => {},
...rest,
};
}
describe('CloudAppender', () => {
let homeDir: string;
let savedOauthHost: string | undefined;
let savedLegacyOauthHost: string | undefined;
let savedKimiHome: string | undefined;
beforeEach(() => {
homeDir = mkdtempSync(join(tmpdir(), 'cloud-appender-'));
savedOauthHost = process.env['KIMI_CODE_OAUTH_HOST'];
savedLegacyOauthHost = process.env['KIMI_OAUTH_HOST'];
savedKimiHome = process.env['KIMI_CODE_HOME'];
delete process.env['KIMI_CODE_OAUTH_HOST'];
delete process.env['KIMI_OAUTH_HOST'];
process.env['KIMI_CODE_HOME'] = homeDir;
});
afterEach(() => {
rmSync(homeDir, { recursive: true, force: true });
if (savedOauthHost === undefined) delete process.env['KIMI_CODE_OAUTH_HOST'];
else process.env['KIMI_CODE_OAUTH_HOST'] = savedOauthHost;
if (savedLegacyOauthHost === undefined) delete process.env['KIMI_OAUTH_HOST'];
else process.env['KIMI_OAUTH_HOST'] = savedLegacyOauthHost;
if (savedKimiHome === undefined) delete process.env['KIMI_CODE_HOME'];
else process.env['KIMI_CODE_HOME'] = savedKimiHome;
});
it('sends a flattened, prefixed payload with user_id and context', async () => {
const requests: CapturedRequest[] = [];
const appender = new CloudAppender(
baseOptions({
homeDir,
deviceId: 'dev123',
sessionId: 'sess1',
fetchImpl: makeFetch((req) => {
requests.push(req);
return okResponse();
}),
}),
);
appender.track({ event: 'tool.call', context: {}, properties: { name: 'bash', count: 2 } });
await appender.flush();
expect(requests).toHaveLength(1);
expect(requests[0]?.url).toBe('https://telemetry-logs.kimi.com/v1/event');
expect(requests[0]?.body.user_id).toBe('kfc_device_id_dev123');
const event = requests[0]?.body.events[0];
expect(event?.['event']).toBe('kfc_tool.call');
expect(event?.['device_id']).toBe('dev123');
expect(event?.['session_id']).toBe('sess1');
expect(event?.['property_name']).toBe('bash');
expect(event?.['property_count']).toBe(2);
expect(event?.['context_app_name']).toBe('test-app');
expect(event?.['context_client_version']).toBe('1.0.0');
expect(event?.['context_version']).toBe('1.0.0');
expect(typeof event?.['context_core_version']).toBe('string');
expect(typeof event?.['event_id']).toBe('string');
expect(typeof event?.['timestamp']).toBe('number');
});
it('derives the global endpoint when the env pins the global region', async () => {
process.env['KIMI_CODE_OAUTH_HOST'] = 'https://auth.kimi.ai';
const requests: CapturedRequest[] = [];
const appender = new CloudAppender(
baseOptions({
homeDir,
fetchImpl: makeFetch((req) => {
requests.push(req);
return okResponse();
}),
}),
);
appender.track({ event: 'tool.call', context: {}, properties: { name: 'bash' } });
await appender.flush();
expect(requests).toHaveLength(1);
expect(requests[0]?.url).toBe('https://telemetry-logs.kimi.ai/v1/event');
});
it('reads the install marker from the bootstrapped home for the default endpoint', async () => {
writeFileSync(join(homeDir, 'region'), 'global\n');
const requests: CapturedRequest[] = [];
const appender = new CloudAppender(
baseOptions({
homeDir,
fetchImpl: makeFetch((req) => {
requests.push(req);
return okResponse();
}),
}),
);
appender.track({ event: 'tool.call', context: {}, properties: { name: 'bash' } });
await appender.flush();
expect(requests).toHaveLength(1);
expect(requests[0]?.url).toBe('https://telemetry-logs.kimi.ai/v1/event');
});
it('honors the marker opt-out from the bootstrap env bag (no process.env needed)', async () => {
writeFileSync(join(homeDir, 'region'), 'global\n');
const requests: CapturedRequest[] = [];
const appender = new CloudAppender(
baseOptions({
homeDir,
bootstrapEnv: { KIMI_CODE_REGION_MARKER: 'off' },
fetchImpl: makeFetch((req) => {
requests.push(req);
return okResponse();
}),
}),
);
appender.track({ event: 'tool.call', context: {}, properties: { name: 'bash' } });
await appender.flush();
expect(requests).toHaveLength(1);
expect(requests[0]?.url).toBe('https://telemetry-logs.kimi.com/v1/event');
});
it('honors KIMI_CODE_REGION_MARKER=off so embedded servers ignore the install marker', async () => {
writeFileSync(join(homeDir, 'region'), 'global\n');
const savedMarkerFlag = process.env['KIMI_CODE_REGION_MARKER'];
process.env['KIMI_CODE_REGION_MARKER'] = 'off';
try {
const requests: CapturedRequest[] = [];
const appender = new CloudAppender(
baseOptions({
homeDir,
fetchImpl: makeFetch((req) => {
requests.push(req);
return okResponse();
}),
}),
);
appender.track({ event: 'tool.call', context: {}, properties: { name: 'bash' } });
await appender.flush();
expect(requests).toHaveLength(1);
expect(requests[0]?.url).toBe('https://telemetry-logs.kimi.com/v1/event');
} finally {
if (savedMarkerFlag === undefined) delete process.env['KIMI_CODE_REGION_MARKER'];
else process.env['KIMI_CODE_REGION_MARKER'] = savedMarkerFlag;
}
});
it('uses the ambient session_id for the top-level envelope session_id', async () => {
const requests: CapturedRequest[] = [];
const appender = new CloudAppender(
baseOptions({
homeDir,
deviceId: 'dev123',
sessionId: 'default-session',
fetchImpl: makeFetch((req) => {
requests.push(req);
return okResponse();
}),
}),
);
appender.track({
event: 'turn_started',
context: { session_id: 'ambient-session' },
properties: { sessionId: 'ambient-session' },
});
await appender.flush();
expect(requests[0]?.body.events[0]?.['session_id']).toBe('ambient-session');
expect(requests[0]?.body.events[0]?.['property_sessionId']).toBe('ambient-session');
});
it('falls back to the appender static session id when ambient has none', async () => {
const requests: CapturedRequest[] = [];
const appender = new CloudAppender(
baseOptions({
homeDir,
sessionId: 'default-session',
fetchImpl: makeFetch((req) => {
requests.push(req);
return okResponse();
}),
}),
);
appender.track({ event: 'turn_started', context: {}, properties: {} });
await appender.flush();
expect(requests[0]?.body.events[0]?.['session_id']).toBe('default-session');
});
it('uses the ambient model for the envelope context when constructed without a model', async () => {
const requests: CapturedRequest[] = [];
const appender = new CloudAppender(
baseOptions({
homeDir,
fetchImpl: makeFetch((req) => {
requests.push(req);
return okResponse();
}),
}),
);
appender.track({ event: 'turn_started', context: { model: 'ambient-model' }, properties: {} });
await appender.flush();
expect(requests[0]?.body.events[0]?.['context_model']).toBe('ambient-model');
});
it('prefers the ambient model over the constructor model in the envelope context', async () => {
const requests: CapturedRequest[] = [];
const appender = new CloudAppender(
baseOptions({
homeDir,
model: 'constructor-model',
fetchImpl: makeFetch((req) => {
requests.push(req);
return okResponse();
}),
}),
);
appender.track({ event: 'turn_started', context: { model: 'ambient-model' }, properties: {} });
await appender.flush();
expect(requests[0]?.body.events[0]?.['context_model']).toBe('ambient-model');
});
it('sends Authorization header when a token is provided', async () => {
const requests: CapturedRequest[] = [];
const appender = new CloudAppender(
baseOptions({
homeDir,
getAccessToken: () => 'tok123',
fetchImpl: makeFetch((req) => {
requests.push(req);
return okResponse();
}),
}),
);
appender.track({ event: 'evt', context: {}, properties: {} });
await appender.flush();
expect(requests[0]?.headers['Authorization']).toBe('Bearer tok123');
});
it('auto-flushes when the buffer reaches the threshold', async () => {
let sends = 0;
const appender = new CloudAppender(
baseOptions({
homeDir,
flushThreshold: 3,
fetchImpl: makeFetch(() => {
sends += 1;
return okResponse();
}),
}),
);
appender.track({ event: 'e1', context: {}, properties: {} });
appender.track({ event: 'e2', context: {}, properties: {} });
expect(sends).toBe(0);
appender.track({ event: 'e3', context: {}, properties: {} });
await new Promise((resolve) => setTimeout(resolve, 20));
expect(sends).toBe(1);
});
it('shutdown flushes the remaining buffered events', async () => {
let sends = 0;
const appender = new CloudAppender(
baseOptions({
homeDir,
fetchImpl: makeFetch(() => {
sends += 1;
return okResponse();
}),
}),
);
appender.track({ event: 'e1', context: {}, properties: {} });
await appender.shutdown();
expect(sends).toBe(1);
});
it('retries on 5xx and saves to disk after exhausting backoffs', async () => {
let attempts = 0;
const appender = new CloudAppender(
baseOptions({
homeDir,
fetchImpl: makeFetch(() => {
attempts += 1;
return statusResponse(500);
}),
}),
);
appender.track({ event: 'evt', context: {}, properties: {} });
await appender.flush();
expect(attempts).toBe(4);
const files = readdirSync(join(homeDir, 'telemetry')).filter((f) => f.startsWith('failed_'));
expect(files).toHaveLength(1);
});
it('retries a 401 once without the Authorization header', async () => {
const seenAuths: (string | undefined)[] = [];
const appender = new CloudAppender(
baseOptions({
homeDir,
getAccessToken: () => 'tok',
fetchImpl: makeFetch((req) => {
seenAuths.push(req.headers['Authorization']);
if (req.headers['Authorization'] !== undefined) {
return statusResponse(401);
}
return okResponse();
}),
}),
);
appender.track({ event: 'evt', context: {}, properties: {} });
await appender.flush();
expect(seenAuths).toEqual(['Bearer tok', undefined]);
});
it('retryDiskEvents resends saved events and removes the file on success', async () => {
let shouldFail = true;
const appender = new CloudAppender(
baseOptions({
homeDir,
fetchImpl: makeFetch(() => (shouldFail ? statusResponse(500) : okResponse())),
}),
);
appender.track({ event: 'evt', context: {}, properties: {} });
await appender.flush();
expect(
readdirSync(join(homeDir, 'telemetry')).filter((f) => f.startsWith('failed_')),
).toHaveLength(1);
shouldFail = false;
await appender.retryDiskEvents();
expect(
readdirSync(join(homeDir, 'telemetry')).filter((f) => f.startsWith('failed_')),
).toHaveLength(0);
});
it('drops null values from the outbound payload', async () => {
const requests: CapturedRequest[] = [];
const appender = new CloudAppender(
baseOptions({
homeDir,
deviceId: 'dev123',
fetchImpl: makeFetch((req) => {
requests.push(req);
return okResponse();
}),
}),
);
appender.track({ event: 'evt', context: {}, properties: { empty: null, keep: 'yes' } });
await appender.flush();
expect(requests).toHaveLength(1);
const event = requests[0]?.body.events[0];
expect(event?.['property_keep']).toBe('yes');
expect(event).not.toHaveProperty('property_empty');
expect(event).not.toHaveProperty('session_id');
});
it('drops non-primitive properties and reports the violation', async () => {
const errors: unknown[] = [];
setUnexpectedErrorHandler((err) => errors.push(err));
try {
const requests: CapturedRequest[] = [];
const appender = new CloudAppender(
baseOptions({
homeDir,
fetchImpl: makeFetch((req) => {
requests.push(req);
return okResponse();
}),
}),
);
appender.track({
event: 'evt',
context: {},
properties: { ok: 'yes', bad: { nested: true } as unknown as string },
});
await appender.flush();
const event = requests[0]?.body.events[0];
expect(event?.['property_ok']).toBe('yes');
expect(event?.['property_bad']).toBeUndefined();
expect(errors).toHaveLength(1);
} finally {
resetUnexpectedErrorHandler();
}
});
});
|