mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-22 08:38:08 +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.
175 lines
5 KiB
TypeScript
175 lines
5 KiB
TypeScript
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';
|
|
import {
|
|
completedKtxScanEnrichmentStateSummary,
|
|
computeKtxScanEnrichmentInputHash,
|
|
summarizeKtxScanEnrichmentState,
|
|
} from './enrichment-state.js';
|
|
import { SqliteLocalScanEnrichmentStateStore } from './sqlite-local-enrichment-state-store.js';
|
|
import type { KtxSchemaSnapshot } from './types.js';
|
|
|
|
const snapshot: KtxSchemaSnapshot = {
|
|
connectionId: 'warehouse',
|
|
driver: 'postgres',
|
|
extractedAt: '2026-04-29T12:00:00.000Z',
|
|
scope: { schemas: ['public'] },
|
|
metadata: {},
|
|
tables: [
|
|
{
|
|
catalog: null,
|
|
db: 'public',
|
|
name: 'orders',
|
|
kind: 'table',
|
|
comment: null,
|
|
estimatedRows: 1,
|
|
foreignKeys: [],
|
|
columns: [
|
|
{
|
|
name: 'id',
|
|
nativeType: 'integer',
|
|
normalizedType: 'integer',
|
|
dimensionType: 'number',
|
|
nullable: false,
|
|
primaryKey: true,
|
|
comment: null,
|
|
},
|
|
],
|
|
},
|
|
],
|
|
};
|
|
|
|
describe('scan enrichment state', () => {
|
|
let tempDir: string;
|
|
let store: SqliteLocalScanEnrichmentStateStore;
|
|
|
|
beforeEach(async () => {
|
|
tempDir = await mkdtemp(join(tmpdir(), 'ktx-scan-enrichment-state-'));
|
|
store = new SqliteLocalScanEnrichmentStateStore({ dbPath: join(tempDir, 'db.sqlite') });
|
|
});
|
|
|
|
afterEach(async () => {
|
|
await rm(tempDir, { recursive: true, force: true });
|
|
});
|
|
|
|
it('computes stable input hashes without depending on object key order', () => {
|
|
const first = computeKtxScanEnrichmentInputHash({
|
|
snapshot,
|
|
mode: 'enriched',
|
|
detectRelationships: true,
|
|
providerIdentity: { provider: 'local-heuristic', llmModel: 'a' },
|
|
});
|
|
const second = computeKtxScanEnrichmentInputHash({
|
|
snapshot: { ...snapshot, metadata: {} },
|
|
mode: 'enriched',
|
|
detectRelationships: true,
|
|
providerIdentity: { llmModel: 'a', provider: 'local-heuristic' },
|
|
});
|
|
const firstTable = snapshot.tables[0];
|
|
if (!firstTable) {
|
|
throw new Error('Expected test snapshot table');
|
|
}
|
|
const changed = computeKtxScanEnrichmentInputHash({
|
|
snapshot: { ...snapshot, tables: [{ ...firstTable, name: 'orders_v2' }] },
|
|
mode: 'enriched',
|
|
detectRelationships: true,
|
|
providerIdentity: { provider: 'local-heuristic', llmModel: 'a' },
|
|
});
|
|
|
|
expect(first).toMatch(/^[a-f0-9]{64}$/);
|
|
expect(second).toBe(first);
|
|
expect(changed).not.toBe(first);
|
|
});
|
|
|
|
it('persists completed stages and ignores stale hashes', async () => {
|
|
const inputHash = computeKtxScanEnrichmentInputHash({
|
|
snapshot,
|
|
mode: 'enriched',
|
|
detectRelationships: true,
|
|
providerIdentity: { provider: 'local-heuristic' },
|
|
});
|
|
|
|
await store.saveCompletedStage({
|
|
runId: 'scan-run-1',
|
|
connectionId: 'warehouse',
|
|
syncId: 'sync-1',
|
|
mode: 'enriched',
|
|
stage: 'descriptions',
|
|
inputHash,
|
|
output: [{ table: { catalog: null, db: 'public', name: 'orders' }, tableDescription: 'Orders' }],
|
|
updatedAt: '2026-04-29T12:01:00.000Z',
|
|
});
|
|
|
|
await expect(
|
|
store.findCompletedStage({
|
|
runId: 'scan-run-1',
|
|
stage: 'descriptions',
|
|
inputHash,
|
|
}),
|
|
).resolves.toMatchObject({
|
|
runId: 'scan-run-1',
|
|
stage: 'descriptions',
|
|
status: 'completed',
|
|
output: [{ table: { catalog: null, db: 'public', name: 'orders' }, tableDescription: 'Orders' }],
|
|
});
|
|
|
|
await expect(
|
|
store.findCompletedStage({
|
|
runId: 'scan-run-1',
|
|
stage: 'descriptions',
|
|
inputHash: 'different-hash',
|
|
}),
|
|
).resolves.toBeNull();
|
|
});
|
|
|
|
it('records failed stages without making them reusable', async () => {
|
|
await store.saveFailedStage({
|
|
runId: 'scan-run-2',
|
|
connectionId: 'warehouse',
|
|
syncId: 'sync-2',
|
|
mode: 'enriched',
|
|
stage: 'embeddings',
|
|
inputHash: 'hash-2',
|
|
errorMessage: 'embedding service timed out',
|
|
updatedAt: '2026-04-29T12:02:00.000Z',
|
|
});
|
|
|
|
await expect(
|
|
store.findCompletedStage({
|
|
runId: 'scan-run-2',
|
|
stage: 'embeddings',
|
|
inputHash: 'hash-2',
|
|
}),
|
|
).resolves.toBeNull();
|
|
|
|
await expect(store.listRunStages('scan-run-2')).resolves.toEqual([
|
|
expect.objectContaining({
|
|
runId: 'scan-run-2',
|
|
stage: 'embeddings',
|
|
status: 'failed',
|
|
errorMessage: 'embedding service timed out',
|
|
}),
|
|
]);
|
|
});
|
|
|
|
it('summarizes resumed, completed, and failed stages for reports', () => {
|
|
expect(
|
|
summarizeKtxScanEnrichmentState({
|
|
resumedStages: ['descriptions'],
|
|
completedStages: ['descriptions', 'embeddings'],
|
|
failedStages: ['relationships'],
|
|
}),
|
|
).toEqual({
|
|
resumedStages: ['descriptions'],
|
|
completedStages: ['descriptions', 'embeddings'],
|
|
failedStages: ['relationships'],
|
|
});
|
|
|
|
expect(completedKtxScanEnrichmentStateSummary()).toEqual({
|
|
resumedStages: [],
|
|
completedStages: [],
|
|
failedStages: [],
|
|
});
|
|
});
|
|
});
|