2026-05-10 23:12:26 +02:00
|
|
|
#!/usr/bin/env node
|
|
|
|
|
import { existsSync, readFileSync, writeFileSync } from 'node:fs';
|
|
|
|
|
import { createRequire } from 'node:module';
|
|
|
|
|
import path from 'node:path';
|
|
|
|
|
import { fileURLToPath } from 'node:url';
|
|
|
|
|
|
|
|
|
|
const scriptDir = path.dirname(fileURLToPath(import.meta.url));
|
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
|
|
|
const require = createRequire(new URL('../packages/cli/package.json', import.meta.url));
|
2026-05-10 23:12:26 +02:00
|
|
|
const Database = require('better-sqlite3');
|
|
|
|
|
const { stringify: yamlStringify } = require('yaml');
|
|
|
|
|
|
|
|
|
|
const TIME_PATTERNS = /(_at$|_date$|^date_|_time$|^timestamp_)/i;
|
|
|
|
|
const TIME_TYPES = /(date|time|timestamp)/i;
|
|
|
|
|
|
|
|
|
|
function quoteIdentifier(value) {
|
|
|
|
|
return `"${String(value).replaceAll('"', '""')}"`;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export function normalizeSqliteType(rawType) {
|
|
|
|
|
const t = (rawType || '').toLowerCase().trim();
|
|
|
|
|
if (!t) {
|
|
|
|
|
return 'text';
|
|
|
|
|
}
|
|
|
|
|
if (/int/.test(t)) {
|
|
|
|
|
return 'integer';
|
|
|
|
|
}
|
|
|
|
|
if (/char|text|clob/.test(t)) {
|
|
|
|
|
return 'text';
|
|
|
|
|
}
|
|
|
|
|
if (/real|float|double|numeric|decimal/.test(t)) {
|
|
|
|
|
return 'real';
|
|
|
|
|
}
|
|
|
|
|
if (/blob/.test(t)) {
|
|
|
|
|
return 'blob';
|
|
|
|
|
}
|
|
|
|
|
if (/bool/.test(t)) {
|
|
|
|
|
return 'integer';
|
|
|
|
|
}
|
|
|
|
|
if (/date|time/.test(t)) {
|
|
|
|
|
return 'text';
|
|
|
|
|
}
|
|
|
|
|
return 'text';
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export function dimensionTypeFor(rawType, columnName) {
|
|
|
|
|
const t = (rawType || '').toLowerCase();
|
|
|
|
|
const n = (columnName || '').toLowerCase();
|
|
|
|
|
if (TIME_PATTERNS.test(n) || TIME_TYPES.test(t)) {
|
|
|
|
|
return 'time';
|
|
|
|
|
}
|
|
|
|
|
if (/bool/.test(t)) {
|
|
|
|
|
return 'boolean';
|
|
|
|
|
}
|
|
|
|
|
if (/int|real|float|double|numeric|decimal/.test(t)) {
|
|
|
|
|
return 'number';
|
|
|
|
|
}
|
|
|
|
|
return 'string';
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function tableNames(db) {
|
|
|
|
|
return db
|
|
|
|
|
.prepare("SELECT name FROM sqlite_master WHERE type = 'table' AND name NOT LIKE 'sqlite_%' ORDER BY name")
|
|
|
|
|
.all()
|
|
|
|
|
.map((row) => row.name);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function columnsFor(db, table) {
|
|
|
|
|
return db
|
|
|
|
|
.prepare(`PRAGMA table_info(${quoteIdentifier(table)})`)
|
|
|
|
|
.all()
|
|
|
|
|
.map((c) => ({
|
|
|
|
|
cid: c.cid,
|
|
|
|
|
name: c.name,
|
|
|
|
|
nativeType: c.type ?? '',
|
|
|
|
|
nullable: !c.notnull,
|
|
|
|
|
primaryKey: c.pk > 0,
|
|
|
|
|
pkOrdinal: c.pk > 0 ? c.pk : null,
|
|
|
|
|
}));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function rawForeignKeys(db, table) {
|
|
|
|
|
return db.prepare(`PRAGMA foreign_key_list(${quoteIdentifier(table)})`).all();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function rowCount(db, table) {
|
|
|
|
|
const row = db.prepare(`SELECT COUNT(*) AS c FROM ${quoteIdentifier(table)}`).get();
|
|
|
|
|
return Number(row?.c ?? 0);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function groupedForeignKeys(rawFks, table) {
|
|
|
|
|
const byId = new Map();
|
|
|
|
|
for (const row of rawFks) {
|
|
|
|
|
const list = byId.get(row.id) ?? [];
|
|
|
|
|
list.push(row);
|
|
|
|
|
byId.set(row.id, list);
|
|
|
|
|
}
|
|
|
|
|
const out = [];
|
|
|
|
|
for (const rows of byId.values()) {
|
|
|
|
|
rows.sort((a, b) => a.seq - b.seq);
|
|
|
|
|
out.push({
|
|
|
|
|
from: rows.map((r) => r.from),
|
|
|
|
|
toTable: rows[0].table,
|
|
|
|
|
to: rows.map((r) => r.to),
|
|
|
|
|
constraintName: `${table}_${rows.map((r) => r.from).join('_')}_fkey`,
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
return out;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function groupedSnapshotForeignKeys(table) {
|
|
|
|
|
const byKey = new Map();
|
|
|
|
|
for (const fk of table.foreignKeys ?? []) {
|
|
|
|
|
const key = fk.constraintName ?? `${table.name}:${fk.toTable}:${fk.toColumn}`;
|
|
|
|
|
const rows = byKey.get(key) ?? [];
|
|
|
|
|
rows.push(fk);
|
|
|
|
|
byKey.set(key, rows);
|
|
|
|
|
}
|
|
|
|
|
return [...byKey.values()].map((rows) => ({
|
|
|
|
|
fromTable: table.name,
|
|
|
|
|
fromColumns: rows.map((row) => row.fromColumn),
|
|
|
|
|
toTable: rows[0].toTable,
|
|
|
|
|
toColumns: rows.map((row) => row.toColumn),
|
|
|
|
|
relationship: 'many_to_one',
|
|
|
|
|
}));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export function expectedLinksFromSnapshot(snapshot) {
|
|
|
|
|
const expectedPks = [];
|
|
|
|
|
const expectedLinks = [];
|
|
|
|
|
|
|
|
|
|
for (const table of snapshot.tables ?? []) {
|
|
|
|
|
if (table.kind !== 'table') {
|
|
|
|
|
continue;
|
|
|
|
|
}
|
|
|
|
|
const pkColumns = (table.columns ?? []).filter((column) => column.primaryKey).map((column) => column.name);
|
|
|
|
|
if (pkColumns.length) {
|
|
|
|
|
expectedPks.push({ table: table.name, columns: pkColumns });
|
|
|
|
|
}
|
|
|
|
|
expectedLinks.push(...groupedSnapshotForeignKeys(table));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
expectedPks.sort((left, right) => left.table.localeCompare(right.table));
|
|
|
|
|
expectedLinks.sort((left, right) => {
|
|
|
|
|
const leftKey = `${left.fromTable}.${left.fromColumns.join(',')}->${left.toTable}.${left.toColumns.join(',')}`;
|
|
|
|
|
const rightKey = `${right.fromTable}.${right.fromColumns.join(',')}->${right.toTable}.${right.toColumns.join(',')}`;
|
|
|
|
|
return leftKey.localeCompare(rightKey);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
return { expectedPks, expectedLinks };
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export function buildBenchmarkSnapshot(input) {
|
|
|
|
|
const { db, fixtureId, extractedAt } = input;
|
|
|
|
|
const names = tableNames(db);
|
|
|
|
|
const tables = [];
|
|
|
|
|
|
|
|
|
|
for (const name of names) {
|
|
|
|
|
const cols = columnsFor(db, name);
|
|
|
|
|
const grouped = groupedForeignKeys(rawForeignKeys(db, name), name);
|
|
|
|
|
const estimatedRows = rowCount(db, name);
|
|
|
|
|
|
|
|
|
|
const columns = cols.map((c) => ({
|
|
|
|
|
name: c.name,
|
|
|
|
|
nativeType: c.nativeType,
|
|
|
|
|
normalizedType: normalizeSqliteType(c.nativeType),
|
|
|
|
|
dimensionType: dimensionTypeFor(c.nativeType, c.name),
|
|
|
|
|
nullable: c.nullable,
|
|
|
|
|
primaryKey: c.primaryKey,
|
|
|
|
|
comment: null,
|
|
|
|
|
}));
|
|
|
|
|
|
|
|
|
|
const foreignKeys = grouped.flatMap((g) =>
|
|
|
|
|
g.from.map((fromColumn, index) => ({
|
|
|
|
|
fromColumn,
|
|
|
|
|
toCatalog: null,
|
|
|
|
|
toDb: 'main',
|
|
|
|
|
toTable: g.toTable,
|
|
|
|
|
toColumn: g.to[index],
|
|
|
|
|
constraintName: g.constraintName,
|
|
|
|
|
})),
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
tables.push({
|
|
|
|
|
catalog: null,
|
|
|
|
|
db: 'main',
|
|
|
|
|
name,
|
|
|
|
|
kind: 'table',
|
|
|
|
|
comment: null,
|
|
|
|
|
estimatedRows,
|
|
|
|
|
columns,
|
|
|
|
|
foreignKeys,
|
|
|
|
|
});
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return {
|
|
|
|
|
snapshot: {
|
|
|
|
|
connectionId: fixtureId,
|
|
|
|
|
driver: 'sqlite',
|
|
|
|
|
extractedAt: extractedAt ?? '2026-05-07T00:00:00.000Z',
|
|
|
|
|
scope: {},
|
|
|
|
|
metadata: {},
|
|
|
|
|
tables,
|
|
|
|
|
},
|
|
|
|
|
expected: expectedLinksFromSnapshot({
|
|
|
|
|
connectionId: fixtureId,
|
|
|
|
|
driver: 'sqlite',
|
|
|
|
|
extractedAt: extractedAt ?? '2026-05-07T00:00:00.000Z',
|
|
|
|
|
scope: {},
|
|
|
|
|
metadata: {},
|
|
|
|
|
tables,
|
|
|
|
|
}),
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export function writeFixtureFiles(input) {
|
|
|
|
|
const { fixtureDir, snapshot, expected } = input;
|
|
|
|
|
writeFileSync(path.join(fixtureDir, 'snapshot.json'), `${JSON.stringify(snapshot, null, 2)}\n`, 'utf8');
|
|
|
|
|
writeFileSync(path.join(fixtureDir, 'expected-links.yaml'), yamlStringify(expected), 'utf8');
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export function rebuildAllPublicSnapshots(options = {}) {
|
|
|
|
|
const repoRoot = options.repoRoot ?? path.resolve(scriptDir, '..');
|
|
|
|
|
const fixturesRoot =
|
|
|
|
|
options.fixturesRoot ?? path.join(repoRoot, 'packages', 'context', 'test', 'fixtures', 'relationship-benchmarks');
|
|
|
|
|
const manifestPath = options.manifestPath ?? path.join(scriptDir, 'public-benchmark-manifest.json');
|
|
|
|
|
const manifest = JSON.parse(readFileSync(manifestPath, 'utf8'));
|
|
|
|
|
|
|
|
|
|
for (const fixture of manifest.fixtures) {
|
|
|
|
|
const fixtureDir = path.join(fixturesRoot, fixture.id);
|
|
|
|
|
const dataPath = path.join(fixtureDir, 'data.sqlite');
|
|
|
|
|
if (!existsSync(dataPath)) {
|
|
|
|
|
console.log(`[skip] ${fixture.id}: data.sqlite missing (run relationships:acquire-public-fixtures first)`);
|
|
|
|
|
continue;
|
|
|
|
|
}
|
|
|
|
|
const db = new Database(dataPath, { readonly: true });
|
|
|
|
|
try {
|
|
|
|
|
const result = buildBenchmarkSnapshot({ db, fixtureId: fixture.id });
|
|
|
|
|
writeFixtureFiles({ fixtureDir, snapshot: result.snapshot, expected: result.expected });
|
|
|
|
|
console.log(
|
|
|
|
|
`[built] ${fixture.id}: ${result.snapshot.tables.length} tables, ${result.expected.expectedLinks.length} expected links`,
|
|
|
|
|
);
|
|
|
|
|
} finally {
|
|
|
|
|
db.close();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (import.meta.url === `file://${process.argv[1]}`) {
|
|
|
|
|
const args = process.argv.slice(2);
|
|
|
|
|
if (args[0] === '--rebuild-all') {
|
|
|
|
|
rebuildAllPublicSnapshots();
|
|
|
|
|
} else if (args.length === 2) {
|
|
|
|
|
const [dataPath, fixtureDir] = args;
|
|
|
|
|
const db = new Database(dataPath, { readonly: true });
|
|
|
|
|
try {
|
|
|
|
|
const fixtureId = path.basename(fixtureDir);
|
|
|
|
|
const result = buildBenchmarkSnapshot({ db, fixtureId });
|
|
|
|
|
writeFixtureFiles({ fixtureDir, snapshot: result.snapshot, expected: result.expected });
|
|
|
|
|
console.log(`[built] ${fixtureId}`);
|
|
|
|
|
} finally {
|
|
|
|
|
db.close();
|
|
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
console.error('Usage: build-benchmark-snapshot.mjs <data.sqlite> <fixtureDir> | --rebuild-all');
|
|
|
|
|
process.exit(2);
|
|
|
|
|
}
|
|
|
|
|
}
|