2026-05-10 23:12:26 +02:00
|
|
|
import { mkdtemp, rm } from 'node:fs/promises';
|
|
|
|
|
import { tmpdir } from 'node:os';
|
|
|
|
|
import { join } from 'node:path';
|
2026-05-17 02:32:41 +02:00
|
|
|
import { stripVTControlCharacters } from 'node:util';
|
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
|
|
|
import { initKtxProject, loadKtxProject } from './context/project/project.js';
|
|
|
|
|
import type { KtxEmbeddingPort } from './context/core/embedding.js';
|
|
|
|
|
import { writeLocalKnowledgePage } from './context/wiki/local-knowledge.js';
|
2026-05-21 02:21:22 +02:00
|
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
2026-05-10 23:51:24 +02:00
|
|
|
import { runKtxKnowledge } from './knowledge.js';
|
2026-05-10 23:12:26 +02:00
|
|
|
|
|
|
|
|
function makeIo() {
|
|
|
|
|
let stdout = '';
|
|
|
|
|
let stderr = '';
|
|
|
|
|
return {
|
|
|
|
|
io: {
|
|
|
|
|
stdout: {
|
|
|
|
|
write: (chunk: string) => {
|
|
|
|
|
stdout += chunk;
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
stderr: {
|
|
|
|
|
write: (chunk: string) => {
|
|
|
|
|
stderr += chunk;
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
},
|
|
|
|
|
stdout: () => stdout,
|
|
|
|
|
stderr: () => stderr,
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
2026-05-11 22:59:45 +02:00
|
|
|
class FakeEmbeddingPort implements KtxEmbeddingPort {
|
|
|
|
|
readonly maxBatchSize = 16;
|
|
|
|
|
|
|
|
|
|
async computeEmbedding(text: string): Promise<number[]> {
|
|
|
|
|
const lower = text.toLowerCase();
|
|
|
|
|
return lower.includes('revenue') || lower.includes('arr') ? [1, 0] : [0, 1];
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
async computeEmbeddingsBulk(texts: string[]): Promise<number[][]> {
|
|
|
|
|
return Promise.all(texts.map((text) => this.computeEmbedding(text)));
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2026-05-14 19:04:22 -04:00
|
|
|
interface WikiPageFixture {
|
|
|
|
|
key?: string;
|
|
|
|
|
summary?: string;
|
|
|
|
|
content?: string;
|
|
|
|
|
tags?: string[];
|
|
|
|
|
slRefs?: string[];
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
async function seedWikiPage(projectDir: string, fixture: WikiPageFixture = {}): Promise<void> {
|
|
|
|
|
const project = await loadKtxProject({ projectDir });
|
|
|
|
|
await writeLocalKnowledgePage(project, {
|
|
|
|
|
key: fixture.key ?? 'metrics-revenue',
|
|
|
|
|
scope: 'GLOBAL',
|
|
|
|
|
userId: 'local',
|
|
|
|
|
summary: fixture.summary ?? 'Revenue',
|
|
|
|
|
content: fixture.content ?? 'Revenue is paid order value.',
|
|
|
|
|
tags: fixture.tags ?? ['finance'],
|
|
|
|
|
refs: [],
|
|
|
|
|
slRefs: fixture.slRefs ?? ['orders'],
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
2026-05-10 23:51:24 +02:00
|
|
|
describe('runKtxKnowledge', () => {
|
2026-05-10 23:12:26 +02:00
|
|
|
let tempDir: string;
|
|
|
|
|
|
|
|
|
|
beforeEach(async () => {
|
2026-05-10 23:51:24 +02:00
|
|
|
tempDir = await mkdtemp(join(tmpdir(), 'ktx-cli-knowledge-'));
|
2026-05-10 23:12:26 +02:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
afterEach(async () => {
|
|
|
|
|
await rm(tempDir, { recursive: true, force: true });
|
|
|
|
|
});
|
|
|
|
|
|
2026-05-14 19:04:22 -04:00
|
|
|
it('lists and searches wiki pages', async () => {
|
2026-05-10 23:12:26 +02:00
|
|
|
const projectDir = join(tempDir, 'project');
|
2026-05-14 17:39:31 +02:00
|
|
|
await initKtxProject({ projectDir });
|
2026-05-14 19:04:22 -04:00
|
|
|
await seedWikiPage(projectDir);
|
2026-05-10 23:12:26 +02:00
|
|
|
|
|
|
|
|
const listIo = makeIo();
|
2026-05-21 02:21:22 +02:00
|
|
|
await expect(
|
|
|
|
|
runKtxKnowledge({ command: 'list', projectDir, userId: 'local', cliVersion: '0.0.0-test' }, listIo.io),
|
|
|
|
|
).resolves.toBe(0);
|
2026-05-12 16:56:58 -04:00
|
|
|
expect(listIo.stdout()).toContain('GLOBAL\tmetrics-revenue\tRevenue');
|
2026-05-10 23:12:26 +02:00
|
|
|
|
|
|
|
|
const searchIo = makeIo();
|
|
|
|
|
await expect(
|
2026-05-21 02:21:22 +02:00
|
|
|
runKtxKnowledge(
|
|
|
|
|
{ command: 'search', projectDir, query: 'paid order', userId: 'local', cliVersion: '0.0.0-test' },
|
|
|
|
|
searchIo.io,
|
|
|
|
|
),
|
2026-05-10 23:12:26 +02:00
|
|
|
).resolves.toBe(0);
|
2026-05-12 16:56:58 -04:00
|
|
|
expect(searchIo.stdout()).toContain('metrics-revenue');
|
|
|
|
|
});
|
|
|
|
|
|
2026-05-17 02:32:41 +02:00
|
|
|
it('prints wiki search rank badges in pretty output', async () => {
|
|
|
|
|
const projectDir = join(tempDir, 'rank-project');
|
|
|
|
|
await initKtxProject({ projectDir });
|
|
|
|
|
await seedWikiPage(projectDir);
|
|
|
|
|
|
|
|
|
|
const searchIo = makeIo();
|
|
|
|
|
await expect(
|
|
|
|
|
runKtxKnowledge(
|
2026-05-21 02:21:22 +02:00
|
|
|
{
|
|
|
|
|
command: 'search',
|
|
|
|
|
projectDir,
|
|
|
|
|
query: 'paid order',
|
|
|
|
|
userId: 'local',
|
|
|
|
|
output: 'pretty',
|
|
|
|
|
cliVersion: '0.0.0-test',
|
|
|
|
|
},
|
2026-05-17 02:32:41 +02:00
|
|
|
searchIo.io,
|
|
|
|
|
),
|
|
|
|
|
).resolves.toBe(0);
|
|
|
|
|
|
|
|
|
|
const stdout = stripVTControlCharacters(searchIo.stdout());
|
|
|
|
|
expect(stdout).toMatch(/#1\s+metrics-revenue/);
|
|
|
|
|
expect(stdout).not.toContain('%');
|
|
|
|
|
});
|
|
|
|
|
|
2026-05-14 19:04:22 -04:00
|
|
|
it('prints wiki list and search as public JSON envelopes', async () => {
|
2026-05-13 13:01:56 +02:00
|
|
|
const projectDir = join(tempDir, 'project');
|
2026-05-14 17:39:31 +02:00
|
|
|
await initKtxProject({ projectDir });
|
2026-05-14 19:04:22 -04:00
|
|
|
await seedWikiPage(projectDir);
|
2026-05-13 13:01:56 +02:00
|
|
|
|
|
|
|
|
const listIo = makeIo();
|
2026-05-21 02:21:22 +02:00
|
|
|
await expect(
|
|
|
|
|
runKtxKnowledge(
|
|
|
|
|
{ command: 'list', projectDir, userId: 'local', json: true, cliVersion: '0.0.0-test' },
|
|
|
|
|
listIo.io,
|
|
|
|
|
),
|
|
|
|
|
).resolves.toBe(0);
|
2026-05-13 13:01:56 +02:00
|
|
|
expect(JSON.parse(listIo.stdout())).toMatchObject({
|
|
|
|
|
kind: 'list',
|
|
|
|
|
data: { items: [expect.objectContaining({ key: 'metrics-revenue', summary: 'Revenue' })] },
|
|
|
|
|
meta: { command: 'wiki list' },
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const searchIo = makeIo();
|
|
|
|
|
await expect(
|
|
|
|
|
runKtxKnowledge(
|
2026-05-21 02:21:22 +02:00
|
|
|
{
|
|
|
|
|
command: 'search',
|
|
|
|
|
projectDir,
|
|
|
|
|
query: 'paid order',
|
|
|
|
|
userId: 'local',
|
|
|
|
|
json: true,
|
|
|
|
|
limit: 5,
|
|
|
|
|
cliVersion: '0.0.0-test',
|
|
|
|
|
},
|
2026-05-13 13:01:56 +02:00
|
|
|
searchIo.io,
|
|
|
|
|
),
|
|
|
|
|
).resolves.toBe(0);
|
|
|
|
|
expect(JSON.parse(searchIo.stdout())).toMatchObject({
|
|
|
|
|
kind: 'list',
|
|
|
|
|
data: { items: [expect.objectContaining({ key: 'metrics-revenue', summary: 'Revenue' })] },
|
|
|
|
|
meta: { command: 'wiki search' },
|
|
|
|
|
});
|
2026-05-10 23:12:26 +02:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('explains empty search results for a project without wiki pages', async () => {
|
|
|
|
|
const projectDir = join(tempDir, 'empty-project');
|
2026-05-14 17:39:31 +02:00
|
|
|
await initKtxProject({ projectDir });
|
2026-05-10 23:12:26 +02:00
|
|
|
|
|
|
|
|
const searchIo = makeIo();
|
|
|
|
|
await expect(
|
2026-05-21 02:21:22 +02:00
|
|
|
runKtxKnowledge(
|
|
|
|
|
{ command: 'search', projectDir, query: 'revenue', userId: 'local', cliVersion: '0.0.0-test' },
|
|
|
|
|
searchIo.io,
|
|
|
|
|
),
|
2026-05-10 23:12:26 +02:00
|
|
|
).resolves.toBe(0);
|
|
|
|
|
|
|
|
|
|
expect(searchIo.stdout()).toBe('');
|
|
|
|
|
expect(searchIo.stderr()).toContain('No local wiki pages found');
|
2026-05-14 01:43:06 +02:00
|
|
|
expect(searchIo.stderr()).toContain('ktx ingest <connectionId>');
|
2026-05-10 23:12:26 +02:00
|
|
|
});
|
2026-05-11 22:59:45 +02:00
|
|
|
|
|
|
|
|
it('uses configured embeddings for semantic wiki search', async () => {
|
|
|
|
|
const projectDir = join(tempDir, 'semantic-project');
|
2026-05-14 17:39:31 +02:00
|
|
|
await initKtxProject({ projectDir });
|
2026-05-14 19:04:22 -04:00
|
|
|
await seedWikiPage(projectDir, {
|
|
|
|
|
key: 'active-contract-arr-open-tickets',
|
|
|
|
|
summary: 'Active Contract ARR Ranked by Open Support Ticket Count',
|
|
|
|
|
content: 'Accounts ranked by annual recurring contract value and support ticket load.',
|
|
|
|
|
tags: ['historic-sql'],
|
|
|
|
|
slRefs: [],
|
|
|
|
|
});
|
2026-05-11 22:59:45 +02:00
|
|
|
|
|
|
|
|
const searchIo = makeIo();
|
|
|
|
|
await expect(
|
|
|
|
|
runKtxKnowledge(
|
2026-05-21 02:21:22 +02:00
|
|
|
{ command: 'search', projectDir, query: 'revenue', userId: 'local', cliVersion: '0.0.0-test' },
|
2026-05-11 22:59:45 +02:00
|
|
|
searchIo.io,
|
|
|
|
|
{ embeddingService: new FakeEmbeddingPort() },
|
|
|
|
|
),
|
|
|
|
|
).resolves.toBe(0);
|
|
|
|
|
|
2026-05-12 16:56:58 -04:00
|
|
|
expect(searchIo.stdout()).toContain('active-contract-arr-open-tickets');
|
2026-05-11 22:59:45 +02:00
|
|
|
expect(searchIo.stderr()).toBe('');
|
|
|
|
|
});
|
2026-05-17 02:32:41 +02:00
|
|
|
|
2026-05-21 02:21:22 +02:00
|
|
|
it('routes wiki search through resolveEmbeddingProvider when no embeddingService is injected', async () => {
|
|
|
|
|
const projectDir = join(tempDir, 'resolver-project');
|
|
|
|
|
await initKtxProject({ projectDir });
|
|
|
|
|
const search = vi.fn(async () => []);
|
|
|
|
|
const searchIo = makeIo();
|
|
|
|
|
await expect(
|
|
|
|
|
runKtxKnowledge(
|
|
|
|
|
{
|
|
|
|
|
command: 'search',
|
|
|
|
|
projectDir,
|
|
|
|
|
query: 'income',
|
|
|
|
|
userId: 'local',
|
|
|
|
|
cliVersion: '0.5.0',
|
|
|
|
|
},
|
|
|
|
|
searchIo.io,
|
|
|
|
|
{
|
|
|
|
|
resolveEmbeddingProvider: async () => ({
|
|
|
|
|
kind: 'managed-running',
|
|
|
|
|
provider: { id: 'fake' } as never,
|
|
|
|
|
baseUrl: 'http://127.0.0.1:51234',
|
|
|
|
|
}),
|
|
|
|
|
searchLocalKnowledgePages: search,
|
|
|
|
|
},
|
|
|
|
|
),
|
|
|
|
|
).resolves.toBe(0);
|
|
|
|
|
expect(search).toHaveBeenCalledWith(
|
|
|
|
|
expect.anything(),
|
|
|
|
|
expect.objectContaining({ embeddingService: expect.any(Object) }),
|
|
|
|
|
);
|
|
|
|
|
});
|
|
|
|
|
|
2026-05-17 02:32:41 +02:00
|
|
|
it('writes wiki search lane diagnostics to stderr when debug is enabled', async () => {
|
|
|
|
|
const projectDir = join(tempDir, 'debug-project');
|
|
|
|
|
await initKtxProject({ projectDir });
|
|
|
|
|
await seedWikiPage(projectDir);
|
|
|
|
|
|
|
|
|
|
const searchIo = makeIo();
|
|
|
|
|
await expect(
|
|
|
|
|
runKtxKnowledge(
|
2026-05-21 02:21:22 +02:00
|
|
|
{
|
|
|
|
|
command: 'search',
|
|
|
|
|
projectDir,
|
|
|
|
|
query: 'paid order',
|
|
|
|
|
userId: 'local',
|
|
|
|
|
json: true,
|
|
|
|
|
debug: true,
|
|
|
|
|
cliVersion: '0.0.0-test',
|
|
|
|
|
},
|
2026-05-17 02:32:41 +02:00
|
|
|
searchIo.io,
|
|
|
|
|
{ embeddingService: new FakeEmbeddingPort() },
|
|
|
|
|
),
|
|
|
|
|
).resolves.toBe(0);
|
|
|
|
|
|
|
|
|
|
expect(JSON.parse(searchIo.stdout())).toMatchObject({
|
|
|
|
|
kind: 'list',
|
|
|
|
|
data: { items: [expect.objectContaining({ key: 'metrics-revenue' })] },
|
|
|
|
|
meta: { command: 'wiki search' },
|
|
|
|
|
});
|
|
|
|
|
expect(searchIo.stderr()).toContain('[debug] wiki search mode=sqlite-fts5');
|
|
|
|
|
expect(searchIo.stderr()).toContain('embedding=configured');
|
|
|
|
|
expect(searchIo.stderr()).toContain('lane=lexical status=available');
|
|
|
|
|
expect(searchIo.stderr()).toContain('lane=semantic status=available');
|
|
|
|
|
});
|
2026-05-10 23:12:26 +02:00
|
|
|
});
|