kimi-code/packages/telemetry/test/telemetry.test.ts
liruifengv b51e13538d
ci: run unit tests on windows (#1037)
* ci: run unit tests on windows

* fix(migration-legacy): align workdir bucket key with agent-core

computeWorkdirBucket used a local node:path-based resolve that yields backslash-separated paths on Windows, while agent-core's encodeWorkDirKey uses pathe (forward slashes on every platform). The SHA-256 inputs diverged, so migrated sessions were written to a bucket that the session picker never reads, making them invisible on Windows.

Alias computeWorkdirBucket to encodeWorkDirKey so both sides stay byte-identical, drop the local slugify copy, and update the workdir-bucket test reference accordingly.

* test(acp-adapter): expect platform-native separators in e2e-fs path

The e2e-fs test asserted the fs/readTextFile wire path as the raw POSIX targetPath, but AcpKaos.toClientPath converts '/' to '\' when the inner LocalKaos reports pathClass 'win32' (Windows). On Windows the wire path became '\Users\test\x.ts' and the assertion failed.

Mirror toClientPath in the test: expect backslash separators on win32 and the raw path otherwise. Implementation is unchanged.

* test(sdk): normalize workDir and skillDir paths in session tests

SessionStore.create/list and the skill loader normalize paths through pathe (forward slashes). The SDK tests compared the resulting workDir and skill loaded-dir against raw mkdtemp / node:path strings, which use backslashes on Windows (and node:fs realpath also returns backslashes for the skill dir), failing three toMatchObject assertions.

Build the expected paths with agent-core's normalizeWorkDir so they match the internal pathe representation on every platform. The skill dir keeps its realpath() (the loader realpaths the root) and only normalizes separators.

* test(skill): normalize realpath to forward slashes in scanner tests

resolveSkillRoots normalizes every root.path through fs.realpath followed by replacing backslashes with forward slashes (scanner.ts). The scanner tests compared root.path against node:fs realpath directly, which returns backslashes on Windows, so twenty assertions failed (toEqual / toContain / toHaveLength) even though the resolved paths were identical.

Wrap realpath at the top of the test file to mirror the implementation's normalization, so every comparison uses the same forward-slash form on every platform.

* test: skip Unix-only permission tests on Windows

The Unix file-permission assertions (mode bits like 0o600 / 0o700 and chmod 000 making a path unreadable) have no equivalent on Windows, which uses ACLs; fs.chmod there can only toggle the read-only bit. These six tests failed on Windows with mismatched mode values or a missing 40411.

Skip them on win32 via it.skipIf(process.platform === 'win32'): oauth FileTokenStorage (0600 file, 0700 dir), agent-core BackgroundTaskPersistence (0700 tasks dir), agent-core createPerIdJsonStore (0700 subdir), migration-legacy atomicWrite (0600 file), and server fs:browse (chmod 000 -> 40411).

* test(tui): make platform-sensitive assertions cross-platform

The TUI implementations are already platform-aware (pathe-style paths, pathToFileURL, quoteShellArg cmd/POSIX quoting, Alt+V on Windows for paste expansion), but the tests hard-coded POSIX expectations and failed on Windows.

Align the assertions with the implementation's platform behavior: footer-goal-badge matches the '[goal' badge prefix instead of /goal/ (toolbar tips contain '/goal'); tool-call expects backslash relative paths on win32; plan-box builds the file:// URL via pathToFileURL; custom-editor sends Alt+V on win32 for paste expansion; file-mention-provider normalizes the expected description to forward slashes; kimi-tui-startup builds the resume command with quoteShellArg; kimi-tui-message-flow builds the expected install path with resolve().

* test: align path assertions with pathe on Windows

Several test suites asserted paths produced by node:path/node:os/node:fs against values that agent-core, node-sdk and kaos normalize through pathe (forward slashes). On Windows the two forms diverge (backslashes vs forward slashes), failing about 19 assertions.

Mirror the implementation's normalization in the assertions via a local toPosix helper (or agent-core's normalizeWorkDir), so expected paths use forward slashes on every platform: kaos LocalKaos, node-sdk export/list/resume/config/transport sessions, cli FileMentionProvider, and agent-core skill-session.

* test(native): build path expectations with node:path.resolve

paths.mjs builds every path with node:path.resolve, which yields backslash-separated absolute paths on Windows. The path-helpers tests asserted against template strings that mixed the backslash appRoot with forward-slash segments, so Object.is failed on Windows even though the strings looked identical.

Build the expectations with the same resolve(appRoot, ...) helper so the separators match on every platform.

* fix: make Windows CI tests pass across all packages

Fix the remaining Windows CI failures so the Windows test job can go green. The changes fall into a few categories:

- Path separators: agent-core/node-sdk/kaos normalize paths via pathe (forward slashes); align test expectations and a couple of implementations (native cache base, workspace registry) with that.

- Platform-only services: skip launchd/systemd manager suites on win32 (Windows uses schtasks).

- Process/signal lifecycle: skip or relax tests that rely on POSIX signals / SIGTERM semantics that Windows does not support.

- Hook shell syntax: rewrite hook test commands from POSIX shell (single quotes, semicolons, stderr redirects, if/then/fi) to node -e / .cjs files that run under cmd.exe.

- CRLF: make Bash tool description stripping tolerate CRLF line endings.

- Misc: realpath short-name divergence, port-retry timing, telemetry spawn, fs-watch timing, snapshot path normalization, etc.

* fix: remove unused basename import in workspaceRegistryService

Fix lint error (no-unused-vars): basename from node:path is no longer used after switching to posixBasename from pathe.

* fix: align resume harness pathClass and wait for banner state on Windows

Two more Windows CI fixes:

- createResumeNoSideEffectKaos now reports pathClass 'win32' on Windows so tool descriptions (e.g. Glob's Windows note) match the live agent in expectResumeMatches, fixing usage/description deep-equal drift.

- kimi-tui-startup once-banner test now waits for writeBannerDisplayState to land before asserting, since the atomic write can lag behind the render on Windows.

* fix: resolve remaining Windows unit test failures

Make the new Windows CI job green across agent-core, kaos, node-sdk and server:

- Align the resume harness kaos pathClass with the live agent so platform-conditional tool descriptions (Glob's Windows note) match in expectResumeMatches instead of drifting on win32.
- Rewrite hook commands in agent-core tests as cross-platform node one-liners; single-quote echo, >&2 and ';' do not work under cmd.exe.
- Add .gitattributes enforcing LF so raw-imported templates (e.g. the compaction instruction) produce byte-identical token counts on Windows and POSIX.
- Terminate the full process tree on Windows in both the hook runner and kaos (taskkill /T /F) so grandchildren cannot outlive their parent and keep the cwd locked.
- Normalize workDir path separators in two kimi-sdk session tests to match the stored canonical form.
- Avoid cmd.exe arg-quoting pitfalls in the kaos cmd.exe test, and run the Windows process-tree kill test from a script file with the pid path passed via argv.
- Give the first fs-git e2e test more time on Windows and retry the temp-dir cleanup; skip the fs-watch overflow-burst assertion on Windows where fs-event coalescing prevents the single-window spike.

* ci: retrigger checks

* fix: resolve remaining Windows failures after merging main

- Terminate the spawned git/gh process tree on Windows in FsGitService (taskkill /T /F on timeout) so a timed-out 'gh pr view' cannot leave a grandchild holding the workspace cwd, which made the fs-git e2e cleanup fail with EPERM.

- Give the fs:git_status e2e suite a longer timeout on Windows and retry the temp-dir cleanup longer to ride out the slower child-process teardown.

- Make the third-party plugin install trust test assert the resolved install path via node:path so it matches the Windows-resolved path (D:\tmp\...) as well as the POSIX one.

* fix: align workspace registry roots and harden fs-git cleanup on Windows

- workspace-registry test: compare normalized (forward-slash) roots, since the registry and session index both store workDir via pathe.resolve (forward slashes on every platform). realpath() yields backslashes on Windows and diverged from the stored root.

- fs-git e2e: bump the temp-dir cleanup retries and the afterEach timeout, since Windows child-process teardown after server.close() is asynchronous and can keep the workspace cwd locked for several seconds.

* test: stub openUrl in kimi-tui-message-flow feedback tests

The /feedback command falls back to openUrl(FEEDBACK_ISSUE_URL) when submission fails, which spawned a real browser window on every test run. Mock #/utils/open-url (matching the existing login/message-replay/server test convention) so the suite never opens a browser.

* test: harden fs-git e2e cleanup against Windows cwd locks

On Windows, git/gh child processes and the session core process can outlive server.close() and keep the temp workspace as their cwd, so rmSync fails with EPERM even after a long retry. Add rmSyncRobust that retries and, if the cwd is still locked, swallows EPERM/EBUSY on Windows — the OS reclaims the temp dir and a cleanup hiccup must not fail an otherwise-passing test.

* test: harden server e2e cleanup against async teardown races

server.close() does not fully await the server's asynchronous teardown, so on a loaded CI runner the temp home/workspace dirs can still be held or written to when the afterEach rmSync runs, failing with EPERM (Windows) or ENOTEMPTY (Linux). Use a rmSyncRobust helper (retry + swallow EPERM/EBUSY/ENOTEMPTY) in the fs-git and question e2e cleanup. Also fix a leftover `throw err` (renamed to `throw error`) that broke the typecheck.
2026-06-26 11:56:41 +08:00

889 lines
29 KiB
TypeScript

import { spawn } from 'node:child_process';
import { mkdirSync, readdirSync, readFileSync, rmSync, statSync, writeFileSync } from 'node:fs';
import { mkdtemp } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import { dirname, join } from 'node:path';
import { fileURLToPath, pathToFileURL } from 'node:url';
import { afterEach, describe, expect, it, vi } from 'vitest';
import { flushTelemetrySync, initializeTelemetry, shutdownTelemetry, track } from '../src';
import { isTelemetryDisabledByEnv } from '../src/bootstrap';
import { TelemetryClient, resetDefaultTelemetryClientForTests } from '../src/client';
import { installCrashHandlersForClient, setCrashPhase, uninstallCrashHandlers } from '../src/crash';
import { EventSink } from '../src/sink';
import {
AsyncTransport,
DISK_EVENT_MAX_AGE_MS,
RETRY_BACKOFFS_MS,
SERVER_EVENT_PREFIX,
TransientTelemetryError,
USER_ID_PREFIX,
applyServerPrefix,
buildPayload,
} from '../src/transport';
import type { EnrichedTelemetryEvent, TelemetryEvent, TelemetryTransport } from '../src/types';
const tempDirs: string[] = [];
afterEach(() => {
uninstallCrashHandlers();
setCrashPhase('startup');
resetDefaultTelemetryClientForTests();
for (const dir of tempDirs.splice(0)) {
rmSync(dir, { recursive: true, force: true });
}
vi.restoreAllMocks();
});
async function tempHome(): Promise<string> {
const dir = await mkdtemp(join(tmpdir(), 'kimi-telemetry-'));
tempDirs.push(dir);
return dir;
}
class RecordingTransport implements TelemetryTransport {
readonly sent: EnrichedTelemetryEvent[][] = [];
readonly saved: EnrichedTelemetryEvent[][] = [];
retryCount = 0;
async send(events: readonly EnrichedTelemetryEvent[]): Promise<void> {
this.sent.push([...events]);
}
saveToDisk(events: readonly EnrichedTelemetryEvent[]): void {
this.saved.push([...events]);
}
async retryDiskEvents(): Promise<void> {
this.retryCount += 1;
}
}
function makeSink(transport: TelemetryTransport, flushThreshold = 10): EventSink {
return new EventSink({
transport,
context: {
appName: 'kimi-code-cli',
version: '1.2.3',
uiMode: 'shell',
model: 'kimi-k2',
env: {},
terminal: 'test-terminal',
locale: 'en_US',
},
flushThreshold,
});
}
function sampleEvent(name = 'started'): EnrichedTelemetryEvent {
return {
event_id: 'event-1',
device_id: 'device-1',
session_id: 'session-1',
event: name,
timestamp: 123,
properties: {
resumed: false,
count: 2,
},
context: {
version: '1.2.3',
runtime: 'node',
},
};
}
describe('TelemetryClient', () => {
it('queues events before sink attach, then drains with backfilled context ids', async () => {
const client = new TelemetryClient();
client.track('early');
client.setContext({ deviceId: 'dev', sessionId: 'ses' });
const transport = new RecordingTransport();
client.attachSink(makeSink(transport));
await client.flush();
expect(transport.sent).toHaveLength(1);
expect(transport.sent[0]?.[0]).toMatchObject({
event: 'early',
device_id: 'dev',
session_id: 'ses',
});
});
it('records scoped session ids without mutating the parent context', async () => {
const client = new TelemetryClient();
const transport = new RecordingTransport();
client.setContext({ deviceId: 'dev', sessionId: 'active' });
client.attachSink(makeSink(transport));
client.withContext({ sessionId: 'session-a' }).track('scoped');
client.track('root');
await client.flush();
expect(transport.sent[0]).toMatchObject([
{ event: 'scoped', device_id: 'dev', session_id: 'session-a' },
{ event: 'root', device_id: 'dev', session_id: 'active' },
]);
});
it('can clear the active session context', async () => {
const client = new TelemetryClient();
const transport = new RecordingTransport();
client.setContext({ deviceId: 'dev', sessionId: 'active' });
client.attachSink(makeSink(transport));
client.setContext({ sessionId: null });
client.track('no_session');
await client.flush();
expect(transport.sent[0]?.[0]).toMatchObject({
event: 'no_session',
device_id: 'dev',
session_id: null,
});
});
it('forwards directly to the attached sink and can be disabled', async () => {
const client = new TelemetryClient();
const transport = new RecordingTransport();
client.attachSink(makeSink(transport));
client.track('before_disable');
client.disable();
client.track('after_disable');
await client.flush();
expect(transport.sent).toHaveLength(0);
});
it('flushes the previous sink synchronously when replacing sinks', () => {
const client = new TelemetryClient();
const first = new RecordingTransport();
const second = new RecordingTransport();
client.attachSink(makeSink(first));
client.track('old_sink');
client.attachSink(makeSink(second));
expect(first.saved[0]?.[0]?.event).toBe('old_sink');
expect(second.saved).toHaveLength(0);
});
it('caps the pre-sink queue at 1000 events and keeps the newest entries', async () => {
const client = new TelemetryClient();
const transport = new RecordingTransport();
for (let i = 0; i < 1005; i++) {
client.track(`queued_${String(i)}`);
}
client.attachSink(makeSink(transport, 2000));
await client.flush();
expect(transport.sent[0]).toHaveLength(1000);
expect(transport.sent[0]?.[0]?.event).toBe('queued_5');
expect(transport.sent[0]?.at(-1)?.event).toBe('queued_1004');
});
it('emits generated ids and second-resolution timestamps on tracked events', async () => {
const client = new TelemetryClient();
const transport = new RecordingTransport();
client.attachSink(makeSink(transport));
const before = Date.now() / 1000;
client.track('timed');
await client.flush();
const event = transport.sent[0]?.[0];
expect(event?.event_id).toMatch(/^[0-9a-f]{32}$/);
expect(event?.timestamp).toBeGreaterThanOrEqual(before);
expect(event?.timestamp).toBeLessThanOrEqual(Date.now() / 1000);
expect(event?.properties).toEqual({});
});
});
describe('EventSink', () => {
it('enriches context without mutating the original event', () => {
const transport = new RecordingTransport();
const sink = makeSink(transport);
const event: TelemetryEvent = {
event_id: 'e1',
device_id: 'dev',
session_id: 'ses',
event: 'test',
timestamp: 1,
properties: {},
};
sink.accept(event);
sink.flushSync();
expect('context' in event).toBe(false);
expect(transport.saved[0]?.[0]?.context).toMatchObject({
app_name: 'kimi-code-cli',
version: '1.2.3',
runtime: 'node',
ui_mode: 'shell',
model: 'kimi-k2',
terminal: 'test-terminal',
});
});
it('delegates retry of disk events to its transport', async () => {
const transport = new RecordingTransport();
const sink = makeSink(transport);
await sink.retryDiskEvents();
expect(transport.retryCount).toBe(1);
});
});
describe('payload assembly', () => {
it('adds server event prefix, payload user id, and flattened fields', () => {
const payload = buildPayload([sampleEvent('started')], 'device-1');
expect(payload.user_id).toBe('kfc_device_id_device-1');
expect(payload.events[0]).toMatchObject({
event_id: 'event-1',
device_id: 'device-1',
session_id: 'session-1',
event: `${SERVER_EVENT_PREFIX}started`,
property_resumed: false,
property_count: 2,
context_version: '1.2.3',
context_runtime: 'node',
});
expect(payload.events[0]).not.toHaveProperty('properties');
expect(payload.events[0]).not.toHaveProperty('context');
});
it('does not double-prefix already-prefixed events', () => {
const payload = buildPayload([sampleEvent('kfc_started')], 'device-1');
expect(payload.events[0]?.['event']).toBe('kfc_started');
});
it('rejects nested property values before outbound send', () => {
const event = {
...sampleEvent('bad'),
properties: {
nested: { nope: true },
},
} as unknown as EnrichedTelemetryEvent;
expect(() => buildPayload([event], 'device-1')).toThrow(/property.nested/);
});
it('rejects nested context and array property values before outbound send', () => {
const nestedContext = {
...sampleEvent('bad_context'),
context: {
nested: { nope: true },
},
} as unknown as EnrichedTelemetryEvent;
const arrayProperty = {
...sampleEvent('bad_array'),
properties: {
list: ['nope'],
},
} as unknown as EnrichedTelemetryEvent;
expect(() => buildPayload([nestedContext], 'device-1')).toThrow(/context.nested/);
expect(() => buildPayload([arrayProperty], 'device-1')).toThrow(/property.list/);
});
it('passes null primitive values through and leaves the input event untouched', () => {
const event = {
...sampleEvent('nullable'),
properties: {
empty: null,
},
};
const originalProperties = event.properties;
const originalContext = event.context;
const payload = buildPayload([event], 'device-1');
expect(payload.events[0]).toMatchObject({
event: 'kfc_nullable',
property_empty: null,
});
expect(event.properties).toBe(originalProperties);
expect(event.context).toBe(originalContext);
expect(event.event).toBe('nullable');
});
});
describe('server prefix application', () => {
it('locks the outbound telemetry prefixes', () => {
expect(SERVER_EVENT_PREFIX).toBe('kfc_');
expect(USER_ID_PREFIX).toBe('kfc_device_id_');
});
it('returns a new object only when adding the server prefix', () => {
const event = sampleEvent('started');
const prefixed = applyServerPrefix(event);
expect(prefixed).not.toBe(event);
expect(prefixed.event).toBe('kfc_started');
expect(event.event).toBe('started');
});
it('passes already-prefixed and invalid event names through unchanged', () => {
const prefixed = sampleEvent('kfc_started');
const emptyName = sampleEvent('');
const missingName = { ...sampleEvent('missing') } as unknown as Record<string, unknown>;
delete missingName['event'];
const numberName = {
...sampleEvent('number'),
event: 123,
} as unknown as EnrichedTelemetryEvent;
expect(applyServerPrefix(prefixed)).toBe(prefixed);
expect(applyServerPrefix(emptyName as unknown as EnrichedTelemetryEvent)).toBe(emptyName);
expect(applyServerPrefix(missingName as unknown as EnrichedTelemetryEvent)).toBe(missingName);
expect(applyServerPrefix(numberName)).toBe(numberName);
});
});
describe('AsyncTransport', () => {
it('locks the retry backoff schedule', () => {
expect(RETRY_BACKOFFS_MS).toEqual([1_000, 4_000, 16_000]);
});
it('sends the outbound payload with bearer token when available', async () => {
const fetchImpl = vi.fn(async () => new Response('', { status: 200 }));
const transport = new AsyncTransport({
homeDir: await tempHome(),
deviceId: 'dev',
endpoint: 'https://mock.test/events',
getAccessToken: () => 'token-1',
fetchImpl: fetchImpl as unknown as typeof fetch,
retryBackoffsMs: [],
});
await transport.send([sampleEvent()]);
const init = requestInitFrom(fetchImpl);
expect(init.headers).toMatchObject({ Authorization: 'Bearer token-1' });
expect(JSON.parse(init.body as string)).toMatchObject({
user_id: 'kfc_device_id_dev',
});
});
it('retries anonymously on 401 with a token', async () => {
const fetchImpl = vi
.fn()
.mockResolvedValueOnce(new Response('', { status: 401 }))
.mockResolvedValueOnce(new Response('', { status: 200 }));
const transport = new AsyncTransport({
homeDir: await tempHome(),
deviceId: 'dev',
endpoint: 'https://mock.test/events',
getAccessToken: () => 'token-1',
fetchImpl: fetchImpl as unknown as typeof fetch,
retryBackoffsMs: [],
});
await transport.send([sampleEvent()]);
const first = requestInitFrom(fetchImpl);
const second = requestInitFrom(fetchImpl, 1);
expect(first.headers).toMatchObject({ Authorization: 'Bearer token-1' });
expect(second.headers).not.toHaveProperty('Authorization');
});
it('spools to disk when the anonymous 401 retry gets a transient response', async () => {
const homeDir = await tempHome();
const fetchImpl = vi
.fn()
.mockResolvedValueOnce(new Response('', { status: 401 }))
.mockResolvedValueOnce(new Response('', { status: 500 }));
const transport = new AsyncTransport({
homeDir,
deviceId: 'dev',
endpoint: 'https://mock.test/events',
getAccessToken: () => 'token-1',
fetchImpl: fetchImpl as unknown as typeof fetch,
retryBackoffsMs: [],
});
await transport.send([sampleEvent('anonymous_retry_server_error')]);
const first = requestInitFrom(fetchImpl);
const second = requestInitFrom(fetchImpl, 1);
expect(first.headers).toMatchObject({ Authorization: 'Bearer token-1' });
expect(second.headers).not.toHaveProperty('Authorization');
const telemetryDir = join(homeDir, 'telemetry');
const file = readFileSync(join(telemetryDir, readdirOne(telemetryDir)), 'utf-8');
expect(file).toContain('"event":"anonymous_retry_server_error"');
});
it('drops events when the anonymous 401 retry gets a non-retryable 4xx', async () => {
const homeDir = await tempHome();
const fetchImpl = vi
.fn()
.mockResolvedValueOnce(new Response('', { status: 401 }))
.mockResolvedValueOnce(new Response('', { status: 403 }));
const transport = new AsyncTransport({
homeDir,
deviceId: 'dev',
endpoint: 'https://mock.test/events',
getAccessToken: () => 'token-1',
fetchImpl: fetchImpl as unknown as typeof fetch,
retryBackoffsMs: [],
});
await transport.send([sampleEvent('anonymous_retry_forbidden')]);
const first = requestInitFrom(fetchImpl);
const second = requestInitFrom(fetchImpl, 1);
expect(first.headers).toMatchObject({ Authorization: 'Bearer token-1' });
expect(second.headers).not.toHaveProperty('Authorization');
expect(() => statSync(join(homeDir, 'telemetry'))).toThrow();
});
it('spools transient failures to disk after retries exhaust', async () => {
const homeDir = await tempHome();
const fetchImpl = vi.fn(async () => new Response('', { status: 429 }));
const transport = new AsyncTransport({
homeDir,
deviceId: 'dev',
endpoint: 'https://mock.test/events',
fetchImpl: fetchImpl as unknown as typeof fetch,
retryBackoffsMs: [],
});
await transport.send([sampleEvent('rate_limited')]);
const telemetryDir = join(homeDir, 'telemetry');
const file = readFileSync(join(telemetryDir, readdirOne(telemetryDir)), 'utf-8');
expect(file).toContain('"event":"rate_limited"');
});
it('drops non-retryable 4xx responses without disk fallback', async () => {
const homeDir = await tempHome();
const fetchImpl = vi.fn(async () => new Response('', { status: 422 }));
const transport = new AsyncTransport({
homeDir,
deviceId: 'dev',
endpoint: 'https://mock.test/events',
fetchImpl: fetchImpl as unknown as typeof fetch,
retryBackoffsMs: [],
});
await transport.send([sampleEvent('bad_schema')]);
expect(() => statSync(join(homeDir, 'telemetry'))).toThrow();
});
it('retries disk events through the outbound pipeline and deletes the file on success', async () => {
const homeDir = await tempHome();
const telemetryDir = join(homeDir, 'telemetry');
mkdirSync(telemetryDir, { recursive: true });
const file = join(telemetryDir, 'failed_retry.jsonl');
writeFileSync(file, `${JSON.stringify(sampleEvent('from_disk'))}\n`);
const fetchImpl = vi.fn(async () => new Response('', { status: 200 }));
const transport = new AsyncTransport({
homeDir,
deviceId: 'dev',
endpoint: 'https://mock.test/events',
fetchImpl: fetchImpl as unknown as typeof fetch,
});
await transport.retryDiskEvents();
const init = requestInitFrom(fetchImpl);
const payload = JSON.parse(init.body as string) as { events: Array<{ event: string }> };
expect(payload.events[0]?.['event']).toBe('kfc_from_disk');
expect(() => statSync(file)).toThrow();
});
it('removes expired and corrupted disk files', async () => {
const homeDir = await tempHome();
const telemetryDir = join(homeDir, 'telemetry');
mkdirSync(telemetryDir, { recursive: true });
const expired = join(telemetryDir, 'failed_expired.jsonl');
const corrupt = join(telemetryDir, 'failed_corrupt.jsonl');
writeFileSync(expired, `${JSON.stringify(sampleEvent('old'))}\n`);
writeFileSync(corrupt, 'not json\n');
const now = Date.now();
const transport = new AsyncTransport({
homeDir,
deviceId: 'dev',
endpoint: 'https://mock.test/events',
fetchImpl: vi.fn(async () => new Response('', { status: 200 })) as unknown as typeof fetch,
now: () => now + DISK_EVENT_MAX_AGE_MS + 1,
});
await transport.retryDiskEvents();
expect(() => statSync(expired)).toThrow();
expect(() => statSync(corrupt)).toThrow();
});
it('saves events before propagating shutdown aborts', async () => {
const homeDir = await tempHome();
const transport = new AsyncTransport({
homeDir,
deviceId: 'dev',
endpoint: 'https://mock.test/events',
fetchImpl: vi.fn(async () => {
throw new TransientTelemetryError('nope');
}) as unknown as typeof fetch,
retryBackoffsMs: [10_000],
});
const controller = new AbortController();
const send = transport.send([sampleEvent('aborted')], controller.signal);
controller.abort();
await expect(send).rejects.toThrow();
const telemetryDir = join(homeDir, 'telemetry');
const file = readFileSync(join(telemetryDir, readdirOne(telemetryDir)), 'utf-8');
expect(file).toContain('"event":"aborted"');
});
it('saves events when shutdown aborts during retry backoff', async () => {
const homeDir = await tempHome();
const controller = new AbortController();
const transport = new AsyncTransport({
homeDir,
deviceId: 'dev',
endpoint: 'https://mock.test/events',
fetchImpl: vi.fn(async () => new Response('', { status: 429 })) as unknown as typeof fetch,
retryBackoffsMs: [10_000],
sleep: async () => {
controller.abort();
throw new DOMException('The operation was aborted.', 'AbortError');
},
});
await expect(
transport.send([sampleEvent('aborted_backoff')], controller.signal),
).rejects.toThrow();
const telemetryDir = join(homeDir, 'telemetry');
const file = readFileSync(join(telemetryDir, readdirOne(telemetryDir)), 'utf-8');
expect(file).toContain('"event":"aborted_backoff"');
});
it('writes one JSONL line per event and keeps raw event names on disk fallback', async () => {
const homeDir = await tempHome();
const transport = new AsyncTransport({
homeDir,
deviceId: 'dev',
endpoint: 'https://mock.test/events',
fetchImpl: vi.fn(async () => new Response('', { status: 500 })) as unknown as typeof fetch,
retryBackoffsMs: [],
});
await transport.send([sampleEvent('first'), sampleEvent('second')]);
const telemetryDir = join(homeDir, 'telemetry');
const file = readFileSync(join(telemetryDir, readdirOne(telemetryDir)), 'utf-8');
const lines = file.trim().split('\n');
expect(lines).toHaveLength(2);
expect(JSON.parse(lines[0]!) as Record<string, unknown>).toMatchObject({
event: 'first',
properties: { resumed: false, count: 2 },
});
expect(file).not.toContain('user_id');
expect(file).not.toContain('kfc_first');
});
it('does not create a disk file for an empty batch or a schema violation', async () => {
const homeDir = await tempHome();
const fetchImpl = vi.fn(async () => new Response('', { status: 200 }));
const transport = new AsyncTransport({
homeDir,
deviceId: 'dev',
endpoint: 'https://mock.test/events',
fetchImpl: fetchImpl as unknown as typeof fetch,
});
transport.saveToDisk([]);
await transport.send([
{
...sampleEvent('bad_schema'),
properties: { nested: { nope: true } },
} as unknown as EnrichedTelemetryEvent,
]);
expect(fetchImpl).not.toHaveBeenCalled();
expect(() => statSync(join(homeDir, 'telemetry'))).toThrow();
});
});
describe('telemetry bootstrap', () => {
it('matches the KIMI_DISABLE_TELEMETRY true-value semantics', () => {
expect(isTelemetryDisabledByEnv({ KIMI_DISABLE_TELEMETRY: '1' })).toBe(true);
expect(isTelemetryDisabledByEnv({ KIMI_DISABLE_TELEMETRY: 'yes' })).toBe(true);
expect(isTelemetryDisabledByEnv({ KIMI_DISABLE_TELEMETRY: '0' })).toBe(false);
expect(isTelemetryDisabledByEnv({ KIMI_DISABLE_TELEMETRY: 'false' })).toBe(false);
});
it('disables the singleton without attaching a sink when opted out', async () => {
const fetchImpl = vi.fn(async () => new Response('', { status: 200 }));
vi.stubGlobal('fetch', fetchImpl);
const saved = process.env['KIMI_DISABLE_TELEMETRY'];
try {
process.env['KIMI_DISABLE_TELEMETRY'] = 'true';
initializeTelemetry({
homeDir: await tempHome(),
deviceId: 'dev',
appName: 'kimi-code-cli',
version: '1.2.3',
});
track('dropped');
await shutdownTelemetry();
} finally {
if (saved === undefined) delete process.env['KIMI_DISABLE_TELEMETRY'];
else process.env['KIMI_DISABLE_TELEMETRY'] = saved;
}
expect(fetchImpl).not.toHaveBeenCalled();
});
it('queues singleton track calls before initialization, then flushes after bootstrap', async () => {
const fetchImpl = vi.fn(async () => new Response('', { status: 200 }));
vi.stubGlobal('fetch', fetchImpl);
track('before_init');
initializeTelemetry({
homeDir: await tempHome(),
deviceId: 'dev',
sessionId: 'ses',
appName: 'kimi-code-cli',
version: '1.2.3',
});
await shutdownTelemetry();
expect(fetchImpl).toHaveBeenCalledTimes(1);
const init = requestInitFrom(fetchImpl);
const payload = JSON.parse(init.body as string) as {
events: Array<{ event: string; session_id: string }>;
};
expect(payload.events[0]).toMatchObject({
event: 'kfc_before_init',
session_id: 'ses',
});
});
it('flushes the singleton synchronously to disk fallback', async () => {
const homeDir = await tempHome();
initializeTelemetry({
homeDir,
deviceId: 'dev',
sessionId: 'ses',
appName: 'kimi-code-cli',
version: '1.2.3',
});
track('sync_flush');
flushTelemetrySync();
const telemetryDir = join(homeDir, 'telemetry');
const file = readFileSync(join(telemetryDir, readdirOne(telemetryDir)), 'utf-8');
expect(file).toContain('"event":"sync_flush"');
});
});
describe('crash handler', () => {
it('records uncaught exception monitor crashes and flushes synchronously', () => {
const client = new TelemetryClient();
const transport = new RecordingTransport();
client.attachSink(makeSink(transport));
setCrashPhase('runtime');
installCrashHandlersForClient(client);
(process.emit as (event: string, ...args: unknown[]) => boolean)(
'uncaughtExceptionMonitor',
new Error('boom'),
'uncaughtException',
);
expect(transport.saved[0]?.[0]).toMatchObject({
event: 'crash',
properties: {
error_type: 'Error',
where: 'runtime',
source: 'uncaughtException',
},
});
});
it('records unhandled rejection crashes and flushes synchronously', () => {
const client = new TelemetryClient();
const transport = new RecordingTransport();
client.attachSink(makeSink(transport));
setCrashPhase('runtime');
installCrashHandlersForClient(client);
emitCrash(new TypeError('promise failed'), 'unhandledRejection');
expect(transport.saved[0]?.[0]).toMatchObject({
event: 'crash',
properties: {
error_type: 'TypeError',
where: 'runtime',
source: 'unhandledRejection',
},
});
});
it('keeps Node default non-zero exit semantics for unhandled rejections', async () => {
const status = await runTelemetryCrashScript(`
installCrashHandlersForClient(new TelemetryClient());
Promise.reject(new TypeError('promise failed'));
setTimeout(() => process.exit(0), 50);
`);
expect(status).not.toBe(0);
});
it('records Node-wrapped non-error unhandled rejection crashes', () => {
const client = new TelemetryClient();
const transport = new RecordingTransport();
client.attachSink(makeSink(transport));
installCrashHandlersForClient(client);
const error = Object.assign(new Error('promise failed'), {
name: 'UnhandledPromiseRejection',
});
emitCrash(error, 'unhandledRejection');
expect(transport.saved[0]?.[0]).toMatchObject({
event: 'crash',
properties: {
error_type: 'UnhandledPromiseRejection',
where: 'startup',
source: 'unhandledRejection',
},
});
});
it('reflects startup, runtime, and shutdown phases in crash telemetry', () => {
const client = new TelemetryClient();
const transport = new RecordingTransport();
client.attachSink(makeSink(transport));
installCrashHandlersForClient(client);
for (const phase of ['startup', 'runtime', 'shutdown'] as const) {
setCrashPhase(phase);
emitCrash(new Error(phase));
}
expect(transport.saved.map((batch) => batch[0]?.properties['where'])).toEqual([
'startup',
'runtime',
'shutdown',
]);
});
it('does not register duplicate monitor listeners when installed twice', () => {
const client = new TelemetryClient();
const beforeUncaught = process.listenerCount('uncaughtExceptionMonitor');
const beforeRejection = process.listenerCount('unhandledRejection');
const uninstallFirst = installCrashHandlersForClient(client);
const uninstallSecond = installCrashHandlersForClient(client);
expect(process.listenerCount('uncaughtExceptionMonitor')).toBe(beforeUncaught + 1);
expect(process.listenerCount('unhandledRejection')).toBe(beforeRejection);
uninstallSecond();
uninstallFirst();
expect(process.listenerCount('uncaughtExceptionMonitor')).toBe(beforeUncaught);
expect(process.listenerCount('unhandledRejection')).toBe(beforeRejection);
});
it('ignores aborted-operation errors', () => {
const client = new TelemetryClient();
const transport = new RecordingTransport();
client.attachSink(makeSink(transport));
installCrashHandlersForClient(client);
emitCrash(new DOMException('The operation was aborted.', 'AbortError'));
emitCrash(Object.assign(new Error('aborted'), { name: 'AbortError' }));
emitCrash(new DOMException('The operation was aborted.', 'AbortError'), 'unhandledRejection');
emitCrash(
Object.assign(new Error('aborted'), { name: 'AbortError' }),
'unhandledRejection',
);
expect(transport.saved).toHaveLength(0);
});
});
function readdirOne(dir: string): string {
const entry = readdirSync(dir)[0];
if (entry === undefined) throw new Error(`No files in ${dir}`);
return entry;
}
function requestInitFrom(
fetchImpl: { readonly mock: { readonly calls: readonly unknown[][] } },
index = 0,
): RequestInit {
const call = fetchImpl.mock.calls[index] as readonly [unknown, RequestInit?] | undefined;
const init = call?.[1];
if (init === undefined) throw new Error(`No request init for fetch call ${String(index)}`);
return init;
}
function emitCrash(
error: Error,
origin: NodeJS.UncaughtExceptionOrigin = 'uncaughtException',
): void {
(process.emit as (event: string, ...args: unknown[]) => boolean)(
'uncaughtExceptionMonitor',
error,
origin,
);
}
async function runTelemetryCrashScript(body: string): Promise<number> {
const dir = await tempHome();
const scriptPath = join(dir, 'crash-worker.ts');
const testDir = import.meta.dirname;
const tsxCli = join(
dirname(fileURLToPath(import.meta.resolve('tsx/package.json'))),
'dist/cli.mjs',
);
const crashModuleUrl = pathToFileURL(join(testDir, '../src/crash.ts')).href;
const clientModuleUrl = pathToFileURL(join(testDir, '../src/client.ts')).href;
writeFileSync(
scriptPath,
`
import { TelemetryClient } from ${JSON.stringify(clientModuleUrl)};
import { installCrashHandlersForClient } from ${JSON.stringify(crashModuleUrl)};
${body}
`,
);
return new Promise((resolve, reject) => {
const child = spawn(process.execPath, [tsxCli, scriptPath], {
cwd: join(testDir, '../../..'),
stdio: ['ignore', 'ignore', 'pipe'],
});
let stderr = '';
child.stderr.setEncoding('utf8');
child.stderr.on('data', (chunk: string) => {
stderr += chunk;
});
child.on('error', reject);
child.on('close', (code) => {
if (code === null) {
reject(new Error(`Crash script exited without a code: ${stderr}`));
return;
}
resolve(code);
});
});
}