mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-10 08:05:14 +02:00
* 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.
339 lines
10 KiB
TypeScript
339 lines
10 KiB
TypeScript
import { describe, expect, it, vi } from 'vitest';
|
|
import type { MemoryIngestStatus } from './context/memory/memory-runs.js';
|
|
import type { KtxLocalProject } from './context/project/project.js';
|
|
import { runKtxTextIngest, type TextMemoryIngestPort } from './text-ingest.js';
|
|
|
|
function makeIo(options: { isTTY?: boolean } = {}) {
|
|
let stdout = '';
|
|
let stderr = '';
|
|
return {
|
|
io: {
|
|
stdout: {
|
|
isTTY: options.isTTY,
|
|
write: (chunk: string) => {
|
|
stdout += chunk;
|
|
},
|
|
},
|
|
stderr: {
|
|
write: (chunk: string) => {
|
|
stderr += chunk;
|
|
},
|
|
},
|
|
},
|
|
stdout: () => stdout,
|
|
stderr: () => stderr,
|
|
};
|
|
}
|
|
|
|
function fakeIngest(
|
|
options: {
|
|
failRunIds?: Set<string>;
|
|
missingStatusRunIds?: Set<string>;
|
|
events?: string[];
|
|
} = {},
|
|
): TextMemoryIngestPort {
|
|
let next = 1;
|
|
return {
|
|
ingest: vi.fn(async () => {
|
|
const runId = `run-${next++}`;
|
|
options.events?.push(`ingest:${runId}`);
|
|
return { runId };
|
|
}),
|
|
waitForRun: vi.fn(async (runId: string) => {
|
|
options.events?.push(`wait:${runId}`);
|
|
}),
|
|
status: vi.fn(async (runId: string) => {
|
|
options.events?.push(`status:${runId}`);
|
|
if (options.missingStatusRunIds?.has(runId)) {
|
|
return null;
|
|
}
|
|
if (options.failRunIds?.has(runId)) {
|
|
return {
|
|
runId,
|
|
status: 'error',
|
|
stage: 'ingesting',
|
|
done: true,
|
|
captured: { wiki: [], sl: [], xrefs: [] },
|
|
error: `${runId} failed`,
|
|
commitHash: null,
|
|
skillsLoaded: [],
|
|
signalDetected: false,
|
|
} satisfies MemoryIngestStatus;
|
|
}
|
|
return {
|
|
runId,
|
|
status: 'done',
|
|
stage: 'ingesting',
|
|
done: true,
|
|
captured: { wiki: [`wiki-${runId}`], sl: [`sl-${runId}`], xrefs: [] },
|
|
error: null,
|
|
commitHash: `commit-${runId}`,
|
|
skillsLoaded: ['wiki_capture', 'sl'],
|
|
signalDetected: true,
|
|
} satisfies MemoryIngestStatus;
|
|
}),
|
|
};
|
|
}
|
|
|
|
function fakeProject(projectDir = '/tmp/project'): KtxLocalProject {
|
|
return { projectDir } as KtxLocalProject;
|
|
}
|
|
|
|
describe('runKtxTextIngest', () => {
|
|
it('ingests repeated inline text sequentially with generated internal chat ids', async () => {
|
|
const io = makeIo();
|
|
const events: string[] = [];
|
|
const ingest = fakeIngest({ events });
|
|
const createMemoryIngest = vi.fn(() => ingest);
|
|
|
|
await expect(
|
|
runKtxTextIngest(
|
|
{
|
|
projectDir: '/tmp/project',
|
|
texts: ['Revenue means gross receipts.', 'Orders are completed purchases.'],
|
|
files: [],
|
|
userId: 'local-cli',
|
|
json: true,
|
|
failFast: false,
|
|
},
|
|
io.io,
|
|
{
|
|
loadProject: vi.fn(async () => fakeProject()),
|
|
createMemoryIngest,
|
|
now: () => 1_700_000_000_000,
|
|
},
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(createMemoryIngest).toHaveBeenCalledWith({ projectDir: '/tmp/project' });
|
|
expect(ingest.ingest).toHaveBeenNthCalledWith(
|
|
1,
|
|
expect.objectContaining({
|
|
userId: 'local-cli',
|
|
chatId: 'cli-text-ingest-1700000000000-1',
|
|
userMessage: 'Ingest external text artifact "Revenue means gross receipts." into KTX memory.',
|
|
assistantMessage: 'Revenue means gross receipts.',
|
|
sourceType: 'external_ingest',
|
|
}),
|
|
);
|
|
expect(ingest.ingest).toHaveBeenNthCalledWith(
|
|
2,
|
|
expect.objectContaining({
|
|
chatId: 'cli-text-ingest-1700000000000-2',
|
|
userMessage: 'Ingest external text artifact "Orders are completed purchases." into KTX memory.',
|
|
assistantMessage: 'Orders are completed purchases.',
|
|
}),
|
|
);
|
|
expect(ingest.ingest).not.toHaveBeenCalledWith(expect.objectContaining({ connectionId: expect.anything() }));
|
|
expect(events).toEqual(['ingest:run-1', 'wait:run-1', 'status:run-1', 'ingest:run-2', 'wait:run-2', 'status:run-2']);
|
|
expect(JSON.parse(io.stdout())).toMatchObject({
|
|
status: 'done',
|
|
results: [
|
|
{
|
|
label: '"Revenue means gross receipts."',
|
|
runId: 'run-1',
|
|
status: 'done',
|
|
captured: { wiki: ['wiki-run-1'], sl: ['sl-run-1'] },
|
|
},
|
|
{
|
|
label: '"Orders are completed purchases."',
|
|
runId: 'run-2',
|
|
status: 'done',
|
|
captured: { wiki: ['wiki-run-2'], sl: ['sl-run-2'] },
|
|
},
|
|
],
|
|
});
|
|
});
|
|
|
|
it('loads files and stdin as batch items and passes a global connection id', async () => {
|
|
const io = makeIo();
|
|
const ingest = fakeIngest();
|
|
|
|
await expect(
|
|
runKtxTextIngest(
|
|
{
|
|
projectDir: '/tmp/project',
|
|
texts: [],
|
|
files: ['/tmp/docs/revenue.md', '-'],
|
|
connectionId: 'warehouse',
|
|
userId: 'agent',
|
|
json: false,
|
|
failFast: false,
|
|
},
|
|
io.io,
|
|
{
|
|
loadProject: vi.fn(async () => fakeProject()),
|
|
createMemoryIngest: vi.fn(() => ingest),
|
|
readFile: vi.fn(async (path) => `file:${path}`),
|
|
readStdin: vi.fn(async () => 'stdin content'),
|
|
now: () => 10,
|
|
},
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(ingest.ingest).toHaveBeenNthCalledWith(
|
|
1,
|
|
expect.objectContaining({
|
|
connectionId: 'warehouse',
|
|
userId: 'agent',
|
|
userMessage: 'Ingest external text artifact "revenue.md" into KTX memory.',
|
|
assistantMessage: 'file:/tmp/docs/revenue.md',
|
|
}),
|
|
);
|
|
expect(ingest.ingest).toHaveBeenNthCalledWith(
|
|
2,
|
|
expect.objectContaining({
|
|
connectionId: 'warehouse',
|
|
userMessage: 'Ingest external text artifact "stdin" into KTX memory.',
|
|
assistantMessage: 'stdin content',
|
|
}),
|
|
);
|
|
expect(io.stdout()).toContain('Ingesting text memory');
|
|
expect(io.stdout()).toContain('Texts:');
|
|
expect(io.stdout()).toContain('revenue.md');
|
|
expect(io.stdout()).toContain('stdin');
|
|
});
|
|
|
|
it('uses bounded inline text previews as labels in plain output and ingest metadata', async () => {
|
|
const io = makeIo();
|
|
const ingest = fakeIngest();
|
|
const longText = `This inline note is intentionally long ${'x'.repeat(120)}`;
|
|
|
|
await expect(
|
|
runKtxTextIngest(
|
|
{
|
|
projectDir: '/tmp/project',
|
|
texts: ['remember to call me Andrey', ' first line\n\tsecond line ', longText],
|
|
files: [],
|
|
userId: 'local-cli',
|
|
json: false,
|
|
failFast: false,
|
|
},
|
|
io.io,
|
|
{
|
|
loadProject: vi.fn(async () => fakeProject()),
|
|
createMemoryIngest: vi.fn(() => ingest),
|
|
now: () => 10,
|
|
},
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
const output = io.stdout();
|
|
expect(output).toContain('"remember to call me Andrey"');
|
|
expect(output).toContain('"first line second line"');
|
|
expect(output).toContain('"This inline note is intentionally long xxxxxxxx..."');
|
|
expect(output).not.toContain('text-1');
|
|
expect(output).not.toContain(longText);
|
|
|
|
expect(ingest.ingest).toHaveBeenNthCalledWith(
|
|
1,
|
|
expect.objectContaining({
|
|
userMessage: 'Ingest external text artifact "remember to call me Andrey" into KTX memory.',
|
|
}),
|
|
);
|
|
expect(ingest.ingest).toHaveBeenNthCalledWith(
|
|
2,
|
|
expect.objectContaining({
|
|
userMessage: 'Ingest external text artifact "first line second line" into KTX memory.',
|
|
}),
|
|
);
|
|
expect(ingest.ingest).toHaveBeenNthCalledWith(
|
|
3,
|
|
expect.objectContaining({
|
|
userMessage: 'Ingest external text artifact "This inline note is intentionally long xxxxxxxx..." into KTX memory.',
|
|
}),
|
|
);
|
|
});
|
|
|
|
it('continues after an item failure by default and stops when failFast is set', async () => {
|
|
const continueIo = makeIo();
|
|
const continueIngest = fakeIngest({ failRunIds: new Set(['run-1']) });
|
|
|
|
await expect(
|
|
runKtxTextIngest(
|
|
{
|
|
projectDir: '/tmp/project',
|
|
texts: ['bad', 'good'],
|
|
files: [],
|
|
userId: 'local-cli',
|
|
json: true,
|
|
failFast: false,
|
|
},
|
|
continueIo.io,
|
|
{
|
|
loadProject: vi.fn(async () => fakeProject()),
|
|
createMemoryIngest: vi.fn(() => continueIngest),
|
|
},
|
|
),
|
|
).resolves.toBe(1);
|
|
|
|
expect(continueIngest.ingest).toHaveBeenCalledTimes(2);
|
|
expect(JSON.parse(continueIo.stdout())).toMatchObject({
|
|
status: 'failed',
|
|
results: [
|
|
{ label: '"bad"', status: 'error', error: 'run-1 failed' },
|
|
{ label: '"good"', status: 'done' },
|
|
],
|
|
});
|
|
|
|
const failFastIo = makeIo();
|
|
const failFastIngest = fakeIngest({ failRunIds: new Set(['run-1']) });
|
|
|
|
await expect(
|
|
runKtxTextIngest(
|
|
{
|
|
projectDir: '/tmp/project',
|
|
texts: ['bad', 'skipped'],
|
|
files: [],
|
|
userId: 'local-cli',
|
|
json: true,
|
|
failFast: true,
|
|
},
|
|
failFastIo.io,
|
|
{
|
|
loadProject: vi.fn(async () => fakeProject()),
|
|
createMemoryIngest: vi.fn(() => failFastIngest),
|
|
},
|
|
),
|
|
).resolves.toBe(1);
|
|
|
|
expect(failFastIngest.ingest).toHaveBeenCalledTimes(1);
|
|
expect(JSON.parse(failFastIo.stdout()).results).toHaveLength(1);
|
|
});
|
|
|
|
it('rejects empty batches and empty text items', async () => {
|
|
const noInputIo = makeIo();
|
|
await expect(
|
|
runKtxTextIngest(
|
|
{
|
|
projectDir: '/tmp/project',
|
|
texts: [],
|
|
files: [],
|
|
userId: 'local-cli',
|
|
json: false,
|
|
failFast: false,
|
|
},
|
|
noInputIo.io,
|
|
{ loadProject: vi.fn(), createMemoryIngest: vi.fn() },
|
|
),
|
|
).resolves.toBe(1);
|
|
expect(noInputIo.stderr()).toContain('Provide at least one text item');
|
|
|
|
const emptyIo = makeIo();
|
|
await expect(
|
|
runKtxTextIngest(
|
|
{
|
|
projectDir: '/tmp/project',
|
|
texts: [' '],
|
|
files: [],
|
|
userId: 'local-cli',
|
|
json: false,
|
|
failFast: false,
|
|
},
|
|
emptyIo.io,
|
|
{ loadProject: vi.fn(), createMemoryIngest: vi.fn() },
|
|
),
|
|
).resolves.toBe(1);
|
|
expect(emptyIo.stderr()).toContain('Text item "text-1" is empty');
|
|
});
|
|
});
|