2026-05-15 02:35:09 +02:00
|
|
|
import { mkdtemp, rm } from 'node:fs/promises';
|
|
|
|
|
import { tmpdir } from 'node:os';
|
|
|
|
|
import { join } from 'node:path';
|
|
|
|
|
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
|
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, type KtxLocalProject } from '../../context/project/project.js';
|
2026-05-15 02:35:09 +02:00
|
|
|
import { writeLocalKnowledgePage } from '../wiki/local-knowledge.js';
|
|
|
|
|
import { createKtxDiscoverDataService } from './discover.js';
|
|
|
|
|
|
|
|
|
|
describe('createKtxDiscoverDataService', () => {
|
|
|
|
|
let tempDir: string;
|
|
|
|
|
let project: KtxLocalProject;
|
|
|
|
|
|
|
|
|
|
beforeEach(async () => {
|
|
|
|
|
tempDir = await mkdtemp(join(tmpdir(), 'ktx-discover-data-'));
|
|
|
|
|
project = await initKtxProject({ projectDir: join(tempDir, 'project') });
|
|
|
|
|
project.config.connections.warehouse = { driver: 'postgres', url: 'env:DATABASE_URL' };
|
|
|
|
|
project.config.connections.billing = { driver: 'postgres', url: 'env:BILLING_DATABASE_URL' };
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
afterEach(async () => {
|
|
|
|
|
await rm(tempDir, { recursive: true, force: true });
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
async function seedWiki(): Promise<void> {
|
|
|
|
|
await writeLocalKnowledgePage(project, {
|
|
|
|
|
key: 'orders-playbook',
|
|
|
|
|
scope: 'GLOBAL',
|
|
|
|
|
summary: 'Paid order operations',
|
|
|
|
|
content: 'Use paid orders and order_count to inspect monthly customer activity for Acme Corp.',
|
|
|
|
|
tags: ['orders'],
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
async function seedSl(): Promise<void> {
|
|
|
|
|
await project.fileStore.writeFile(
|
|
|
|
|
'semantic-layer/warehouse/orders.yaml',
|
|
|
|
|
[
|
|
|
|
|
'name: orders',
|
|
|
|
|
'descriptions:',
|
|
|
|
|
' user: Paid order facts',
|
|
|
|
|
'table: public.orders',
|
|
|
|
|
'grain: [id]',
|
|
|
|
|
'columns:',
|
|
|
|
|
' - name: status',
|
|
|
|
|
' type: string',
|
|
|
|
|
' descriptions:',
|
|
|
|
|
' user: Payment status for the order',
|
|
|
|
|
' - name: ordered_at',
|
|
|
|
|
' type: time',
|
|
|
|
|
'measures:',
|
|
|
|
|
' - name: order_count',
|
|
|
|
|
' expr: count(*)',
|
|
|
|
|
' description: Number of paid orders',
|
|
|
|
|
'',
|
|
|
|
|
].join('\n'),
|
|
|
|
|
'ktx',
|
|
|
|
|
'ktx@example.com',
|
|
|
|
|
'seed sl source',
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
async function seedScan(input: {
|
|
|
|
|
connectionId?: string;
|
|
|
|
|
syncId: string;
|
|
|
|
|
tableName?: string;
|
|
|
|
|
comment?: string;
|
|
|
|
|
sampleValues?: string[];
|
|
|
|
|
}): Promise<void> {
|
|
|
|
|
const connectionId = input.connectionId ?? 'warehouse';
|
|
|
|
|
const root = `raw-sources/${connectionId}/live-database/${input.syncId}`;
|
|
|
|
|
const tableName = input.tableName ?? 'orders';
|
|
|
|
|
await project.fileStore.writeFile(
|
|
|
|
|
`${root}/connection.json`,
|
|
|
|
|
JSON.stringify(
|
|
|
|
|
{
|
|
|
|
|
connectionId,
|
|
|
|
|
driver: 'postgres',
|
|
|
|
|
extractedAt: `2026-05-14T09:00:00.000Z`,
|
|
|
|
|
scope: { schemas: ['public'] },
|
|
|
|
|
},
|
|
|
|
|
null,
|
|
|
|
|
2,
|
|
|
|
|
),
|
|
|
|
|
'ktx',
|
|
|
|
|
'ktx@example.com',
|
|
|
|
|
'seed scan connection',
|
|
|
|
|
);
|
|
|
|
|
await project.fileStore.writeFile(
|
|
|
|
|
`${root}/tables/public-${tableName}.json`,
|
|
|
|
|
JSON.stringify(
|
|
|
|
|
{
|
|
|
|
|
catalog: null,
|
|
|
|
|
db: 'public',
|
|
|
|
|
name: tableName,
|
|
|
|
|
kind: 'table',
|
|
|
|
|
comment: input.comment ?? 'Orders table from warehouse',
|
|
|
|
|
estimatedRows: 123,
|
|
|
|
|
descriptions: { db: input.comment ?? 'Orders table from warehouse' },
|
|
|
|
|
columns: [
|
|
|
|
|
{
|
|
|
|
|
name: 'id',
|
|
|
|
|
nativeType: 'integer',
|
|
|
|
|
normalizedType: 'integer',
|
|
|
|
|
dimensionType: 'number',
|
|
|
|
|
nullable: false,
|
|
|
|
|
primaryKey: true,
|
|
|
|
|
comment: 'Order id',
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
name: 'status',
|
|
|
|
|
nativeType: 'text',
|
|
|
|
|
normalizedType: 'text',
|
|
|
|
|
dimensionType: 'string',
|
|
|
|
|
nullable: false,
|
|
|
|
|
primaryKey: false,
|
|
|
|
|
comment: 'Order status',
|
|
|
|
|
sampleValues: input.sampleValues ?? ['paid', 'pending'],
|
|
|
|
|
},
|
|
|
|
|
],
|
|
|
|
|
foreignKeys: [],
|
|
|
|
|
},
|
|
|
|
|
null,
|
|
|
|
|
2,
|
|
|
|
|
),
|
|
|
|
|
'ktx',
|
|
|
|
|
'ktx@example.com',
|
|
|
|
|
'seed table',
|
|
|
|
|
);
|
|
|
|
|
await project.fileStore.writeFile(
|
|
|
|
|
`${root}/scan-report.json`,
|
|
|
|
|
JSON.stringify(
|
|
|
|
|
{
|
|
|
|
|
connectionId,
|
|
|
|
|
driver: 'postgres',
|
|
|
|
|
syncId: input.syncId,
|
|
|
|
|
runId: `scan-${input.syncId}`,
|
|
|
|
|
trigger: 'mcp',
|
|
|
|
|
mode: 'enriched',
|
|
|
|
|
dryRun: false,
|
|
|
|
|
artifactPaths: {
|
|
|
|
|
rawSourcesDir: root,
|
|
|
|
|
reportPath: `${root}/scan-report.json`,
|
|
|
|
|
manifestShards: [],
|
|
|
|
|
enrichmentArtifacts: [],
|
|
|
|
|
},
|
|
|
|
|
diffSummary: {
|
|
|
|
|
tablesAdded: 1,
|
|
|
|
|
tablesModified: 0,
|
|
|
|
|
tablesDeleted: 0,
|
|
|
|
|
tablesUnchanged: 0,
|
|
|
|
|
columnsAdded: 0,
|
|
|
|
|
columnsModified: 0,
|
|
|
|
|
columnsDeleted: 0,
|
|
|
|
|
},
|
|
|
|
|
manifestShardsWritten: 0,
|
|
|
|
|
structuralSyncStats: {
|
|
|
|
|
tablesCreated: 0,
|
|
|
|
|
tablesUpdated: 0,
|
|
|
|
|
tablesDeleted: 0,
|
|
|
|
|
columnsCreated: 0,
|
|
|
|
|
columnsUpdated: 0,
|
|
|
|
|
columnsDeleted: 0,
|
|
|
|
|
},
|
|
|
|
|
enrichment: {
|
|
|
|
|
dataDictionary: 'completed',
|
|
|
|
|
tableDescriptions: 'completed',
|
|
|
|
|
columnDescriptions: 'completed',
|
|
|
|
|
embeddings: 'skipped',
|
|
|
|
|
deterministicRelationships: 'skipped',
|
|
|
|
|
llmRelationshipValidation: 'skipped',
|
|
|
|
|
statisticalValidation: 'skipped',
|
|
|
|
|
},
|
|
|
|
|
capabilityGaps: [],
|
|
|
|
|
warnings: [],
|
|
|
|
|
relationships: { accepted: 0, review: 0, rejected: 0, skipped: 0 },
|
|
|
|
|
enrichmentState: { resumedStages: [], completedStages: [], failedStages: [] },
|
|
|
|
|
createdAt: '2026-05-14T09:00:00.000Z',
|
|
|
|
|
},
|
|
|
|
|
null,
|
|
|
|
|
2,
|
|
|
|
|
),
|
|
|
|
|
'ktx',
|
|
|
|
|
'ktx@example.com',
|
|
|
|
|
'seed scan report',
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
it('returns unified ranked refs across wiki, semantic-layer, and raw schema', async () => {
|
|
|
|
|
await seedWiki();
|
|
|
|
|
await seedSl();
|
|
|
|
|
await seedScan({ syncId: 'sync-1', sampleValues: ['paid', 'refunded'] });
|
|
|
|
|
const service = createKtxDiscoverDataService(project, { userId: 'local-user' });
|
|
|
|
|
|
|
|
|
|
const results = await service.search({ query: 'paid orders', connectionId: 'warehouse', limit: 10 });
|
|
|
|
|
|
|
|
|
|
expect(results.map((result) => result.kind)).toEqual(
|
|
|
|
|
expect.arrayContaining(['wiki', 'sl_source', 'sl_measure', 'sl_dimension', 'table', 'column']),
|
|
|
|
|
);
|
|
|
|
|
expect(results.every((result) => result.score >= 0 && result.score <= 1)).toBe(true);
|
|
|
|
|
expect(results.every((result) => result.snippet === null || result.snippet.length <= 200)).toBe(true);
|
|
|
|
|
expect(results).toContainEqual(
|
|
|
|
|
expect.objectContaining({
|
|
|
|
|
kind: 'table',
|
|
|
|
|
id: 'public.orders',
|
|
|
|
|
connectionId: 'warehouse',
|
|
|
|
|
tableRef: { catalog: null, db: 'public', name: 'orders' },
|
|
|
|
|
matchedOn: expect.stringMatching(/name|description|comment|display/),
|
|
|
|
|
}),
|
|
|
|
|
);
|
|
|
|
|
expect(results).toContainEqual(
|
|
|
|
|
expect.objectContaining({
|
|
|
|
|
kind: 'column',
|
|
|
|
|
id: 'public.orders.status',
|
|
|
|
|
connectionId: 'warehouse',
|
|
|
|
|
columnName: 'status',
|
|
|
|
|
matchedOn: expect.stringMatching(/name|comment|description|sample_value/),
|
|
|
|
|
}),
|
|
|
|
|
);
|
|
|
|
|
expect(results).toContainEqual(
|
|
|
|
|
expect.objectContaining({
|
|
|
|
|
kind: 'sl_measure',
|
|
|
|
|
id: 'orders.order_count',
|
|
|
|
|
connectionId: 'warehouse',
|
|
|
|
|
summary: 'Number of paid orders',
|
|
|
|
|
snippet: 'count(*)',
|
|
|
|
|
matchedOn: expect.stringMatching(/name|description|expr/),
|
|
|
|
|
}),
|
|
|
|
|
);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('honors kind filters and connection scope', async () => {
|
|
|
|
|
await seedWiki();
|
|
|
|
|
await seedSl();
|
|
|
|
|
await seedScan({ syncId: 'sync-1', connectionId: 'warehouse', tableName: 'orders' });
|
|
|
|
|
await seedScan({ syncId: 'sync-2', connectionId: 'billing', tableName: 'invoices', comment: 'Billing invoices' });
|
|
|
|
|
const service = createKtxDiscoverDataService(project);
|
|
|
|
|
|
|
|
|
|
const results = await service.search({
|
|
|
|
|
query: 'orders',
|
|
|
|
|
connectionId: 'warehouse',
|
|
|
|
|
kinds: ['table', 'column'],
|
|
|
|
|
limit: 10,
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(results.every((result) => result.kind === 'table' || result.kind === 'column')).toBe(true);
|
|
|
|
|
expect(results.every((result) => result.connectionId === 'warehouse')).toBe(true);
|
|
|
|
|
expect(results.some((result) => result.id.includes('invoices'))).toBe(false);
|
|
|
|
|
expect(results.some((result) => result.kind === 'wiki')).toBe(false);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('re-reads the latest scan artifacts on each call', async () => {
|
|
|
|
|
await seedScan({ syncId: 'sync-1', tableName: 'orders', comment: 'Old orders table' });
|
|
|
|
|
const service = createKtxDiscoverDataService(project);
|
|
|
|
|
await expect(
|
|
|
|
|
service.search({ query: 'orders', connectionId: 'warehouse', kinds: ['table'], limit: 10 }),
|
|
|
|
|
).resolves.toEqual(expect.arrayContaining([expect.objectContaining({ id: 'public.orders' })]));
|
|
|
|
|
|
|
|
|
|
await seedScan({ syncId: 'sync-2', tableName: 'invoices', comment: 'Invoice facts' });
|
|
|
|
|
const fresh = await service.search({ query: 'invoice', connectionId: 'warehouse', kinds: ['table'], limit: 10 });
|
|
|
|
|
|
|
|
|
|
expect(fresh).toEqual(expect.arrayContaining([expect.objectContaining({ id: 'public.invoices' })]));
|
|
|
|
|
expect(fresh.some((result) => result.id === 'public.orders')).toBe(false);
|
|
|
|
|
});
|
|
|
|
|
});
|