apunkt/ktx
1
0
Fork 0
mirror of https://github.com/Kaelio/ktx.git synced 2026-07-01 08:59:39 +02:00
Code Issues Projects Releases Packages Wiki Activity

feat(telemetry): show first-run notice before command output

Browse source
This commit is contained in:
Andrey Avtomonov 2026-05-22 16:52:01 +02:00
parent 1953466c78
commit 91772e5bce
3 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
packages/cli/src/cli-program-telemetry.test.ts
View file

@ -80,6 +80,11 @@ describe('runCommanderKtxCli telemetry', () => {
expect(statusIo.stderr()).toContain('"event":"project_stack_snapshot"'); expect(statusIo.stderr()).toContain('"event":"project_stack_snapshot"');
expect(statusIo.stderr()).toContain('"connectionCount"'); expect(statusIo.stderr()).toContain('"connectionCount"');
expect(statusIo.stderr()).not.toContain(tempDir); expect(statusIo.stderr()).not.toContain(tempDir);
const noticeIndex = statusIo.stderr().indexOf('ktx collects anonymous usage data');
const firstTelemetryIndex = statusIo.stderr().indexOf('[telemetry]');
expect(noticeIndex).toBeGreaterThanOrEqual(0);
expect(firstTelemetryIndex).toBeGreaterThan(noticeIndex);
}); });
it('emits aborted telemetry when project validation aborts after preAction starts', async () => { it('emits aborted telemetry when project validation aborts after preAction starts', async () => {

1
packages/cli/src/cli-program.ts
View file

@ -417,6 +417,7 @@ export function buildKtxProgram(options: BuildKtxProgramOptions): Command {
program.hook('preAction', async (_thisCommand, actionCommand) => { program.hook('preAction', async (_thisCommand, actionCommand) => {
const telemetry = await import('./telemetry/index.js'); const telemetry = await import('./telemetry/index.js');
options.setTelemetryModule?.(telemetry); options.setTelemetryModule?.(telemetry);
await telemetry.showTelemetryNoticeIfNeeded(options.io);
const commandNode = actionCommand as CommandPathNode; const commandNode = actionCommand as CommandPathNode;
const path = commandPath(commandNode); const path = commandPath(commandNode);
const projectDir = resolveCommandProjectDir(commandNode); const projectDir = resolveCommandProjectDir(commandNode);

8
packages/cli/src/telemetry/index.ts
View file

@ -20,6 +20,14 @@ import { buildProjectStackSnapshotFields } from './project-snapshot.js';
export { beginCommandSpan, completeCommandSpan, shutdownTelemetryEmitter }; export { beginCommandSpan, completeCommandSpan, shutdownTelemetryEmitter };
export type { CommandOutcome, CompletedCommandSpan }; export type { CommandOutcome, CompletedCommandSpan };
export async function showTelemetryNoticeIfNeeded(io: KtxCliIo): Promise<void> {
await loadTelemetryIdentity({
stdoutIsTTY: io.stdout.isTTY === true,
stderr: io.stderr,
env: process.env,
});
}
type TelemetryEventFields<Name extends TelemetryEventName> = Omit< type TelemetryEventFields<Name extends TelemetryEventName> = Omit<
TelemetryEventProperties<Name>, TelemetryEventProperties<Name>,
keyof TelemetryCommonEnvelope keyof TelemetryCommonEnvelope