ktx/packages/cli/src/demo-metrics.test.ts
Andrey Avtomonov 2366b00301
chore(workspace): gate dead-code with knip production mode (#196)
* refactor(workspace): relocate @ktx/llm source into packages/cli/src/llm

* refactor(workspace): rewrite @ktx/llm imports to relative paths

* refactor(workspace): fold internal packages into cli

* chore(workspace): gate dead-code with knip production mode

Turn on production-mode knip plus an autofix run in pre-commit and the
`pnpm dead-code` script, document the `/** @internal */` convention for
test-only exports in AGENTS.md, annotate test-only exports across the
CLI with that JSDoc, and drop dead exports/wrappers the new gate
surfaced (e.g. `cli-project.ts`, `lookerRuntimeSourceToFileAdapterSource`,
`createLocalScanEnrichmentProvidersFromConfig`,
`PGLITE_OWNER_PROCESS_BACKEND_CAPABILITIES`, stale type re-exports).
Replace the loose `ignoreIssues` allowlist in `knip.json` with explicit
production entries so cross-package barrel leaks are caught.

* refactor(cli): delete internal barrel index.ts files

The 34 `index.ts` re-export barrels inside `packages/cli/src/` were
holdovers from the pre-fold multi-workspace structure. Post-fold-in they
served no production purpose: external consumers go through the single
package main entry, and in-repo callers mostly imported through them
only because the path was short. Internally, knip flagged most barrel
re-exports as production-dead (only reached via tests).

This change:
- Deletes every internal barrel except `packages/cli/src/index.ts`
  (the published package entry).
- Rewrites ~270 source/test files to import each name directly from
  the file that defines it.
- Moves `tools/warehouse-verification/index.ts` to
  `create-warehouse-verification-tools.ts` (the function it defined
  locally) and updates its single consumer.
- Renames `search/backend-conformance.ts` → `.test-utils.ts` to match
  the existing test-helper file convention.
- Deletes 13 dead test-only chains (dbt-descriptions/*,
  live-database/extracted-schema, live-database/structural-sync,
  relationship-* feedback/review chain) plus their tests and a
  cascading orphan integration test.
- Updates test mocks that pointed at deleted barrel paths
  (notion-client, connector barrels in scan/local-scan-connectors
  tests) to mock the source files instead.
- Points the maintainer benchmark script
  (`scripts/relationship-benchmark-report.mjs`) at source files
  instead of `dist/context/scan/index.js`.
- Drops the barrel `!` entries from `knip.json`; adds explicit
  production entries only for the benchmark code reached via dist by
  the maintainer script.

Net: 413 files changed, ~1.2k insertions, ~9.4k deletions.

`pnpm run dead-code` (Biome + knip default + knip production) and
`pnpm run type-check` are clean; 2277 tests pass.

* refactor(workspace): rename @ktx/cli to @kaelio/ktx and pack it directly

Promote the CLI workspace package to the public name `@kaelio/ktx` and
drop the separate `scripts/build-public-npm-package.mjs` wrapper. The
CLI package is now publishable in place (`publishConfig.access: public`,
`provenance: true`), so artifact packing uses `pnpm pack` against
`packages/cli/` instead of assembling a parallel package tree.

Updates all workspace filter invocations, docs, tests, and release
readiness checks to reference the new package name, and folds the
tarball-name helper into `scripts/public-npm-release-metadata.mjs`.

* docs: align "agent clients" and "data agents" terminology

Replace "client agents" with "agent clients" and "database agents" with
"data agents" across AGENTS.md, README.md, the docs-site copy, and the
matching setup-agents test description, matching the canonical
vocabulary in docs/terminology.md.

Also moves packages/cli/tsconfig.json's tsBuildInfoFile from
node_modules/.cache/ to dist/.tsbuildinfo so incremental builds survive
node_modules reinstalls.

* refactor(release): single source of truth for package version

Make packages/cli/package.json the single source of truth for the
@kaelio/ktx version. publicNpmPackageVersion() now reads it directly,
so artifact filenames, release-readiness checks, and the Python wheel
version all derive from one field. The duplicate
release-policy.json.publicNpmPackageVersion is removed.

Previously the two fields could drift: tarballs were named
kaelio-ktx-0.4.1.tgz while internally containing
@kaelio/ktx@0.0.0-private.

- update-public-release-version.mjs rewrites both Python pyproject.toml
  files (ktx-daemon, ktx-sl) alongside the npm package.jsons,
  normalizing the version for PEP 440 (e.g. 0.1.0-rc.2 -> 0.1.0rc2).
- semantic-release-config.cjs adds the two pyproject.toml files to
  @semantic-release/git assets so the release commit back to main
  carries every version source in lockstep.
- The six "?? '0.0.0-private'" fallback literals across the CLI are
  replaced with "?? getKtxCliPackageInfo().version", and
  createDefaultKtxMcpServer makes its version arg required.
- docs/release.md describes the actual commit-back model: the dev tree
  always reflects the most recent release; no sentinel pin to
  maintain.

Verified: pnpm run artifacts:build now produces
kaelio-ktx-0.4.1.tgz and kaelio_ktx-0.4.1-py3-none-any.whl with
@kaelio/ktx@0.4.1 inside. Full type-check, dead-code, and
2287 vitests + 173 script tests pass.

* refactor(cli): inject embedding provider resolution and detect sentence-transformers runtime

Make resolveProjectEmbeddingProvider and runtimeIo injectable in ingest and
scan command entrypoints so tests can stub them, and teach
resolvePublicIngestRuntimeRequirements to flag the local-embeddings runtime
feature when ktx.yaml selects sentence-transformers.

* chore(cli): mark buildLocalStatsStatus and LocalStatsStatus as @internal

Both symbols are consumed only by status-project.test.ts. Annotating with
/** @internal */ keeps knip's production-mode check clean without changing
runtime behavior.

* fix(cli): use real package metadata in print-command-tree

The stubbed package name embedded a forbidden product identifier that
tripped the boundary check in CI. Read the metadata from package.json
instead — keeps the rendered tree unchanged and removes a duplicate
source of truth.

* feat(cli): show embedding coverage in `ktx status`, drop duplicate disk counts

Inline `(N embedded)` next to the Wiki scope counts and Semantic-layer
source counts, computed with `SUM(embedding_json IS NOT NULL)` over
`knowledge_pages` and `local_sl_sources`. Rename the "Knowledge" label to
"Wiki" (canonical per `docs/terminology.md`) and rename the matching
`localStats.knowledgePages` field to `localStats.wikiPages`.

Drop `wiki=N md` and `semantic-layer=N yaml` from the Disk row — those
duplicated the per-surface rows above. Disk now reports only actual byte
usage (db, cache, raw-sources). The unused `wikiGlobalMarkdownCount` /
`semanticLayerYamlCount` fields, the `isMarkdownEntry` / `isYamlEntry`
helpers, and the `filter` arg on `summarizeDir` are removed.
2026-05-21 15:28:58 +02:00

137 lines
5.2 KiB
TypeScript

import type { MemoryFlowEvent, MemoryFlowReplayInput } from './context/ingest/memory-flow/types.js';
import { describe, expect, it } from 'vitest';
import {
buildDemoMetrics,
formatCost,
formatDuration,
formatEta,
formatTokens,
formatTokensPerSec,
progressBar,
} from './demo-metrics.js';
function snapshot(events: MemoryFlowEvent[], overrides: Partial<MemoryFlowReplayInput> = {}): MemoryFlowReplayInput {
return {
runId: 'run-1',
connectionId: 'orbit_demo',
adapter: 'live-database',
status: 'running',
sourceDir: null,
syncId: 'sync-1',
errors: [],
events,
plannedWorkUnits: [],
details: { actions: [], provenance: [], transcripts: [] },
...overrides,
};
}
describe('buildDemoMetrics', () => {
it('estimates elapsed, agent steps, tool calls, and cost from event stream', () => {
const start = Date.UTC(2026, 0, 1, 0, 0, 0);
const input = snapshot(
[
{ type: 'source_acquired', adapter: 'live-database', trigger: 'demo_full', fileCount: 5, emittedAt: new Date(start).toISOString() },
{ type: 'work_unit_started', unitKey: 'orders', skills: [], stepBudget: 40, emittedAt: new Date(start + 1000).toISOString() },
{ type: 'work_unit_step', unitKey: 'orders', stepIndex: 6, stepBudget: 40, emittedAt: new Date(start + 6000).toISOString() },
],
{
plannedWorkUnits: [
{ unitKey: 'orders', rawFiles: [], peerFileCount: 0, dependencyCount: 0 },
{ unitKey: 'customers', rawFiles: [], peerFileCount: 0, dependencyCount: 0 },
],
details: {
actions: [],
provenance: [],
transcripts: [{ unitKey: 'orders', path: '/tmp/orders.jsonl', toolCallCount: 3, errorCount: 0, toolNames: ['x'] }],
},
},
);
const metrics = buildDemoMetrics(input, { now: () => start + 10_000 });
expect(metrics.elapsedMs).toBe(10_000);
expect(metrics.agentSteps).toBe(6);
expect(metrics.agentStepBudget).toBe(40);
expect(metrics.toolCalls).toBe(3);
expect(metrics.workUnitsTotal).toBe(2);
expect(metrics.estimatedTokens).toBeGreaterThan(0);
expect(metrics.estimatedCostUsd).toBeGreaterThan(0);
expect(metrics.isCostEstimated).toBe(true);
});
it('returns null ETA before the first work unit completes', () => {
const input = snapshot([{ type: 'source_acquired', adapter: 'live-database', trigger: 'x', fileCount: 1 }]);
const metrics = buildDemoMetrics(input, { now: () => Date.now() });
expect(metrics.etaMs).toBeNull();
});
it('extrapolates ETA from completed/total ratio when at least one unit finishes', () => {
const start = Date.UTC(2026, 0, 1);
const input = snapshot(
[
{ type: 'source_acquired', adapter: 'a', trigger: 't', fileCount: 1, emittedAt: new Date(start).toISOString() },
{ type: 'work_unit_started', unitKey: 'a', skills: [], stepBudget: 10, emittedAt: new Date(start + 1000).toISOString() },
{ type: 'work_unit_finished', unitKey: 'a', status: 'success', emittedAt: new Date(start + 5000).toISOString() },
],
{
plannedWorkUnits: [
{ unitKey: 'a', rawFiles: [], peerFileCount: 0, dependencyCount: 0 },
{ unitKey: 'b', rawFiles: [], peerFileCount: 0, dependencyCount: 0 },
{ unitKey: 'c', rawFiles: [], peerFileCount: 0, dependencyCount: 0 },
],
},
);
const metrics = buildDemoMetrics(input, { now: () => start + 6_000 });
expect(metrics.etaMs).toBe(12_000);
});
it('reports ETA=0 when the run is finished', () => {
const input = snapshot([], { status: 'done' });
const metrics = buildDemoMetrics(input, { now: () => Date.now() });
expect(metrics.etaMs).toBe(0);
});
});
describe('format helpers', () => {
it('formats duration in s/m/h cascades', () => {
expect(formatDuration(5_000)).toBe('5s');
expect(formatDuration(95_000)).toBe('1m35s');
expect(formatDuration(3_700_000)).toBe('1h01m');
expect(formatDuration(-1)).toBe('--');
});
it('formats ETA as estimating before any data and as duration once running', () => {
expect(formatEta(null, 'running')).toBe('estimating...');
expect(formatEta(8_000, 'running')).toBe('8s');
expect(formatEta(8_000, 'done')).toBe('done');
});
it('formats cost with sub-cent guard', () => {
expect(formatCost(0)).toBe('$0.000');
expect(formatCost(0.0005)).toBe('<$0.001');
expect(formatCost(0.012)).toBe('$0.012');
expect(formatCost(2.5)).toBe('$2.50');
});
it('formats token counts with K/M abbreviations', () => {
expect(formatTokens(0)).toBe('0');
expect(formatTokens(450)).toBe('450');
expect(formatTokens(2_300)).toBe('2.3K');
expect(formatTokens(1_500_000)).toBe('1.50M');
});
it('formats tokens per second', () => {
expect(formatTokensPerSec(0)).toBe('0/s');
expect(formatTokensPerSec(450)).toBe('450/s');
expect(formatTokensPerSec(2300)).toBe('2.3K/s');
});
it('renders a deterministic progress bar with hash and dash characters', () => {
expect(progressBar(0, 10)).toBe('----------');
expect(progressBar(0.5, 10)).toBe('#####-----');
expect(progressBar(1, 10)).toBe('##########');
expect(progressBar(1.4, 10)).toBe('##########');
});
});