mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
278 lines
8.2 KiB
TypeScript
278 lines
8.2 KiB
TypeScript
import { mkdir, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises';
|
||
import { tmpdir } from 'node:os';
|
||
import { join, resolve } from 'node:path';
|
||
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
|
||
|
||
import {
|
||
computeTelemetryProjectId,
|
||
loadTelemetryIdentity,
|
||
readExistingTelemetryProjectId,
|
||
TELEMETRY_NOTICE,
|
||
type TelemetryIdentityEnv,
|
||
} from '../../src/telemetry/identity.js';
|
||
|
||
function makeIo(stdoutIsTTY = true) {
|
||
let stderr = '';
|
||
return {
|
||
io: {
|
||
stdout: { isTTY: stdoutIsTTY, write: () => {} },
|
||
stderr: {
|
||
write: (chunk: string) => {
|
||
stderr += chunk;
|
||
},
|
||
},
|
||
},
|
||
stderr: () => stderr,
|
||
};
|
||
}
|
||
|
||
describe('telemetry identity', () => {
|
||
let homeDir: string;
|
||
let env: TelemetryIdentityEnv;
|
||
|
||
beforeEach(async () => {
|
||
homeDir = await mkdtemp(join(tmpdir(), 'ktx-telemetry-home-'));
|
||
env = {};
|
||
});
|
||
|
||
afterEach(async () => {
|
||
await rm(homeDir, { recursive: true, force: true });
|
||
});
|
||
|
||
it('creates the telemetry file and one-line notice on first interactive enabled load', async () => {
|
||
const testIo = makeIo(true);
|
||
|
||
const identity = await loadTelemetryIdentity({
|
||
homeDir,
|
||
env,
|
||
stdoutIsTTY: true,
|
||
stderr: testIo.io.stderr,
|
||
now: () => new Date('2026-05-22T14:33:02.000Z'),
|
||
});
|
||
|
||
expect(identity.enabled).toBe(true);
|
||
expect(identity.installId).toMatch(/^[0-9a-f-]{36}$/);
|
||
expect(identity.createdFile).toBe(true);
|
||
expect(identity.noticeShown).toBe(true);
|
||
expect(testIo.stderr()).toBe(`[2m${TELEMETRY_NOTICE}[22m\n`);
|
||
|
||
const stored = JSON.parse(await readFile(join(homeDir, '.ktx', 'telemetry.json'), 'utf-8')) as {
|
||
enabled: boolean;
|
||
noticeShownVersion: number;
|
||
};
|
||
expect(stored.enabled).toBe(true);
|
||
expect(stored.noticeShownVersion).toBe(1);
|
||
});
|
||
|
||
it('emits the notice without ANSI when NO_COLOR is set', async () => {
|
||
const testIo = makeIo(true);
|
||
|
||
await loadTelemetryIdentity({
|
||
homeDir,
|
||
env: { NO_COLOR: '1' },
|
||
stdoutIsTTY: true,
|
||
stderr: testIo.io.stderr,
|
||
now: () => new Date('2026-05-22T14:33:02.000Z'),
|
||
});
|
||
|
||
expect(testIo.stderr()).toBe(`${TELEMETRY_NOTICE}\n`);
|
||
});
|
||
|
||
it('does not create a file when env disables telemetry', async () => {
|
||
const identity = await loadTelemetryIdentity({
|
||
homeDir,
|
||
env: { KTX_TELEMETRY_DISABLED: '1' },
|
||
stdoutIsTTY: true,
|
||
stderr: makeIo(true).io.stderr,
|
||
now: () => new Date('2026-05-22T14:33:02.000Z'),
|
||
});
|
||
|
||
expect(identity.enabled).toBe(false);
|
||
await expect(readFile(join(homeDir, '.ktx', 'telemetry.json'), 'utf-8')).rejects.toThrow();
|
||
});
|
||
|
||
it('does not create a file for CI or non-TTY command invocations', async () => {
|
||
await expect(
|
||
loadTelemetryIdentity({
|
||
homeDir,
|
||
env: { CI: '1' },
|
||
stdoutIsTTY: true,
|
||
stderr: makeIo(true).io.stderr,
|
||
now: () => new Date('2026-05-22T14:33:02.000Z'),
|
||
}),
|
||
).resolves.toMatchObject({ enabled: false, createdFile: false });
|
||
|
||
await expect(
|
||
loadTelemetryIdentity({
|
||
homeDir,
|
||
env: {},
|
||
stdoutIsTTY: false,
|
||
stderr: makeIo(false).io.stderr,
|
||
now: () => new Date('2026-05-22T14:33:02.000Z'),
|
||
}),
|
||
).resolves.toMatchObject({ enabled: false, createdFile: false });
|
||
});
|
||
|
||
it('honors persistent enabled false', async () => {
|
||
await mkdir(join(homeDir, '.ktx'), { recursive: true });
|
||
await writeFile(
|
||
join(homeDir, '.ktx', 'telemetry.json'),
|
||
JSON.stringify(
|
||
{
|
||
installId: '00000000-0000-4000-8000-000000000000',
|
||
enabled: false,
|
||
noticeShownAt: '2026-05-22T14:33:02.000Z',
|
||
noticeShownVersion: 1,
|
||
createdAt: '2026-05-22T14:33:02.000Z',
|
||
},
|
||
null,
|
||
2,
|
||
) + '\n',
|
||
'utf-8',
|
||
);
|
||
|
||
await expect(
|
||
loadTelemetryIdentity({
|
||
homeDir,
|
||
env,
|
||
stdoutIsTTY: true,
|
||
stderr: makeIo(true).io.stderr,
|
||
now: () => new Date('2026-05-22T15:00:00.000Z'),
|
||
}),
|
||
).resolves.toMatchObject({
|
||
installId: '00000000-0000-4000-8000-000000000000',
|
||
enabled: false,
|
||
createdFile: false,
|
||
});
|
||
});
|
||
|
||
it('enables a consented identity without a TTY (MCP servers run headless)', async () => {
|
||
await mkdir(join(homeDir, '.ktx'), { recursive: true });
|
||
await writeFile(
|
||
join(homeDir, '.ktx', 'telemetry.json'),
|
||
JSON.stringify(
|
||
{
|
||
installId: '00000000-0000-4000-8000-000000000000',
|
||
enabled: true,
|
||
noticeShownAt: '2026-05-22T14:33:02.000Z',
|
||
noticeShownVersion: 1,
|
||
createdAt: '2026-05-22T14:33:02.000Z',
|
||
},
|
||
null,
|
||
2,
|
||
) + '\n',
|
||
'utf-8',
|
||
);
|
||
const testIo = makeIo(false);
|
||
|
||
await expect(
|
||
loadTelemetryIdentity({
|
||
homeDir,
|
||
env,
|
||
stdoutIsTTY: false,
|
||
stderr: testIo.io.stderr,
|
||
now: () => new Date('2026-05-22T15:00:00.000Z'),
|
||
}),
|
||
).resolves.toMatchObject({
|
||
installId: '00000000-0000-4000-8000-000000000000',
|
||
enabled: true,
|
||
createdFile: false,
|
||
noticeShown: false,
|
||
});
|
||
// The one-time notice belongs to interactive surfaces only; a headless load
|
||
// must never write it (the MCP stdio protocol shares the process streams).
|
||
expect(testIo.stderr()).toBe('');
|
||
});
|
||
|
||
it('keeps opt-outs suppressing a consented identity without a TTY', async () => {
|
||
await mkdir(join(homeDir, '.ktx'), { recursive: true });
|
||
await writeFile(
|
||
join(homeDir, '.ktx', 'telemetry.json'),
|
||
JSON.stringify(
|
||
{
|
||
installId: '00000000-0000-4000-8000-000000000000',
|
||
enabled: true,
|
||
noticeShownAt: '2026-05-22T14:33:02.000Z',
|
||
noticeShownVersion: 1,
|
||
createdAt: '2026-05-22T14:33:02.000Z',
|
||
},
|
||
null,
|
||
2,
|
||
) + '\n',
|
||
'utf-8',
|
||
);
|
||
|
||
for (const optOut of [{ KTX_TELEMETRY_DISABLED: '1' }, { DO_NOT_TRACK: '1' }, { CI: '1' }]) {
|
||
await expect(
|
||
loadTelemetryIdentity({
|
||
homeDir,
|
||
env: optOut,
|
||
stdoutIsTTY: false,
|
||
stderr: makeIo(false).io.stderr,
|
||
now: () => new Date('2026-05-22T15:00:00.000Z'),
|
||
}),
|
||
).resolves.toMatchObject({ enabled: false });
|
||
}
|
||
});
|
||
|
||
it('recreates a corrupted file instead of surfacing an error to users', async () => {
|
||
await mkdir(join(homeDir, '.ktx'), { recursive: true });
|
||
await writeFile(join(homeDir, '.ktx', 'telemetry.json'), '{bad json', 'utf-8');
|
||
|
||
const identity = await loadTelemetryIdentity({
|
||
homeDir,
|
||
env,
|
||
stdoutIsTTY: true,
|
||
stderr: makeIo(true).io.stderr,
|
||
now: () => new Date('2026-05-22T14:33:02.000Z'),
|
||
});
|
||
|
||
expect(identity.enabled).toBe(true);
|
||
expect(identity.createdFile).toBe(true);
|
||
});
|
||
|
||
it('derives a salted project hash without exposing the path', () => {
|
||
const projectDir = resolve('/tmp/acme-private-project');
|
||
const projectId = computeTelemetryProjectId('00000000-0000-4000-8000-000000000000', projectDir);
|
||
|
||
expect(projectId).toMatch(/^[a-f0-9]{64}$/);
|
||
expect(projectId).not.toContain('acme');
|
||
expect(computeTelemetryProjectId('00000000-0000-4000-8000-000000000000', projectDir)).toBe(projectId);
|
||
expect(computeTelemetryProjectId('11111111-1111-4111-8111-111111111111', projectDir)).not.toBe(projectId);
|
||
});
|
||
|
||
it('reads an existing project id for Python telemetry without creating identity', async () => {
|
||
await mkdir(join(homeDir, '.ktx'), { recursive: true });
|
||
await writeFile(
|
||
join(homeDir, '.ktx', 'telemetry.json'),
|
||
JSON.stringify(
|
||
{
|
||
installId: '00000000-0000-4000-8000-000000000000',
|
||
enabled: true,
|
||
noticeShownAt: '2026-05-22T14:33:02.000Z',
|
||
noticeShownVersion: 1,
|
||
createdAt: '2026-05-22T14:33:02.000Z',
|
||
},
|
||
null,
|
||
2,
|
||
) + '\n',
|
||
'utf-8',
|
||
);
|
||
|
||
await expect(
|
||
readExistingTelemetryProjectId({
|
||
homeDir,
|
||
projectDir: '/tmp/acme-private-project',
|
||
env: {},
|
||
}),
|
||
).resolves.toMatch(/^[a-f0-9]{64}$/);
|
||
|
||
await expect(
|
||
readExistingTelemetryProjectId({
|
||
homeDir,
|
||
projectDir: '/tmp/acme-private-project',
|
||
env: { KTX_TELEMETRY_DISABLED: '1' },
|
||
}),
|
||
).resolves.toBeUndefined();
|
||
});
|
||
});
|