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.
448 lines
14 KiB
TypeScript
448 lines
14 KiB
TypeScript
import { getDialectForDriver } from '../../context/connections/dialects.js';
|
|
import type { KtxFileStorePort } from '../../context/core/file-store.js';
|
|
import type {
|
|
KtxConnectionDriver,
|
|
KtxSchemaColumn,
|
|
KtxSchemaForeignKey,
|
|
KtxSchemaTable,
|
|
KtxTableRef,
|
|
} from './types.js';
|
|
|
|
type CatalogDriver = KtxConnectionDriver | 'sqlite3';
|
|
|
|
export interface WarehouseCatalogServiceDeps {
|
|
fileStore: KtxFileStorePort;
|
|
}
|
|
|
|
interface WarehouseColumnDetail extends KtxSchemaColumn {
|
|
descriptions: Record<string, string>;
|
|
rowCount: number | null;
|
|
nullCount: number | null;
|
|
distinctCount: number | null;
|
|
nullRate: number | null;
|
|
sampleValues: string[];
|
|
}
|
|
|
|
export interface TableDetail {
|
|
connectionId: string;
|
|
catalog: string | null;
|
|
db: string | null;
|
|
name: string;
|
|
display: string;
|
|
kind: string;
|
|
comment: string | null;
|
|
description: string | null;
|
|
rowCount: number | null;
|
|
columns: WarehouseColumnDetail[];
|
|
foreignKeys: KtxSchemaForeignKey[];
|
|
}
|
|
|
|
export type RawSchemaHit =
|
|
| {
|
|
kind: 'table';
|
|
connectionId: string;
|
|
ref: KtxTableRef;
|
|
display: string;
|
|
matchedOn: 'name' | 'db' | 'comment' | 'description';
|
|
}
|
|
| {
|
|
kind: 'column';
|
|
connectionId: string;
|
|
ref: KtxTableRef & { column: string };
|
|
display: string;
|
|
matchedOn: 'name' | 'comment' | 'description';
|
|
};
|
|
|
|
export interface DisplayTargetResolution {
|
|
resolved: (KtxTableRef & { column?: string }) | null;
|
|
candidates: KtxTableRef[];
|
|
dialect: string;
|
|
}
|
|
|
|
interface ConnectionArtifact {
|
|
driver?: CatalogDriver;
|
|
}
|
|
|
|
interface RelationshipProfileColumn {
|
|
table?: KtxTableRef;
|
|
column?: string;
|
|
rowCount?: number;
|
|
nullCount?: number;
|
|
distinctCount?: number;
|
|
nullRate?: number;
|
|
sampleValues?: unknown[];
|
|
}
|
|
|
|
interface RelationshipProfileArtifact {
|
|
driver?: CatalogDriver;
|
|
tables?: Array<{ table?: KtxTableRef; rowCount?: number }>;
|
|
columns?: Record<string, RelationshipProfileColumn>;
|
|
}
|
|
|
|
interface ConnectionCatalog {
|
|
connectionId: string;
|
|
syncId: string;
|
|
driver: CatalogDriver;
|
|
tables: KtxSchemaTable[];
|
|
profile: RelationshipProfileArtifact | null;
|
|
}
|
|
|
|
type TableWithDescriptions = KtxSchemaTable & {
|
|
descriptions?: Record<string, string>;
|
|
columns: Array<KtxSchemaColumn & { descriptions?: Record<string, string> }>;
|
|
};
|
|
|
|
function normalize(value: string | null | undefined): string {
|
|
return (value ?? '').toLowerCase();
|
|
}
|
|
|
|
function refsEqual(left: KtxTableRef, right: KtxTableRef): boolean {
|
|
return (
|
|
normalize(left.catalog) === normalize(right.catalog) &&
|
|
normalize(left.db) === normalize(right.db) &&
|
|
normalize(left.name) === normalize(right.name)
|
|
);
|
|
}
|
|
|
|
function refKey(ref: KtxTableRef): string {
|
|
return [ref.catalog, ref.db, ref.name].map((part) => normalize(part)).join('.');
|
|
}
|
|
|
|
function columnKey(ref: KtxTableRef, column: string): string {
|
|
return `${refKey(ref)}.${normalize(column)}`;
|
|
}
|
|
|
|
function readJson<T>(content: string): T {
|
|
return JSON.parse(content) as T;
|
|
}
|
|
|
|
function cleanIdentifierPart(part: string): string {
|
|
return part.trim().replace(/^["'`\[]|["'`\]]$/g, '');
|
|
}
|
|
|
|
function splitDisplay(display: string): string[] {
|
|
return display
|
|
.trim()
|
|
.split('.')
|
|
.map(cleanIdentifierPart)
|
|
.filter(Boolean);
|
|
}
|
|
|
|
function formatDisplay(driver: CatalogDriver, table: KtxTableRef): string {
|
|
if (driver === 'sqlite' || driver === 'sqlite3') {
|
|
return table.name;
|
|
}
|
|
return [table.catalog, table.db, table.name].filter((part): part is string => Boolean(part)).join('.');
|
|
}
|
|
|
|
function parseDisplay(driver: CatalogDriver, display: string): KtxTableRef | null {
|
|
const parts = splitDisplay(display);
|
|
if (driver === 'sqlite' || driver === 'sqlite3') {
|
|
return parts.length === 1 ? { catalog: null, db: null, name: parts[0]! } : null;
|
|
}
|
|
if (driver === 'bigquery' || driver === 'snowflake' || driver === 'sqlserver') {
|
|
if (parts.length !== 3) {
|
|
return null;
|
|
}
|
|
return { catalog: parts[0]!, db: parts[1]!, name: parts[2]! };
|
|
}
|
|
if (parts.length === 2) {
|
|
return { catalog: null, db: parts[0]!, name: parts[1]! };
|
|
}
|
|
if (parts.length === 3) {
|
|
return { catalog: parts[0]!, db: parts[1]!, name: parts[2]! };
|
|
}
|
|
return parts.length === 1 ? { catalog: null, db: null, name: parts[0]! } : null;
|
|
}
|
|
|
|
function expectedDisplayPartCount(driver: CatalogDriver): number {
|
|
if (driver === 'sqlite' || driver === 'sqlite3') {
|
|
return 1;
|
|
}
|
|
if (driver === 'bigquery' || driver === 'snowflake' || driver === 'sqlserver') {
|
|
return 3;
|
|
}
|
|
return 2;
|
|
}
|
|
|
|
function parseColumnDisplay(driver: CatalogDriver, display: string): (KtxTableRef & { column: string }) | null {
|
|
const parts = splitDisplay(display);
|
|
const tablePartCount = expectedDisplayPartCount(driver);
|
|
if (parts.length !== tablePartCount + 1) {
|
|
return null;
|
|
}
|
|
const column = parts.at(-1);
|
|
if (!column) {
|
|
return null;
|
|
}
|
|
const table = parseDisplay(driver, parts.slice(0, -1).join('.'));
|
|
return table ? { ...table, column } : null;
|
|
}
|
|
|
|
function bestCandidates(tables: KtxSchemaTable[], display: string, limit = 5): KtxTableRef[] {
|
|
const needle = normalize(splitDisplay(display).at(-1) ?? display);
|
|
return tables
|
|
.map((table) => {
|
|
const name = normalize(table.name);
|
|
let score = 0;
|
|
if (name === needle) {
|
|
score = 100;
|
|
} else if (name.includes(needle) || needle.includes(name)) {
|
|
score = 80;
|
|
} else {
|
|
const samePrefix = [...name].filter((char, index) => needle[index] === char).length;
|
|
score = samePrefix / Math.max(name.length, needle.length, 1);
|
|
}
|
|
return { table, score };
|
|
})
|
|
.filter((entry) => entry.score > 0)
|
|
.sort((left, right) => right.score - left.score || left.table.name.localeCompare(right.table.name))
|
|
.slice(0, limit)
|
|
.map(({ table }) => ({ catalog: table.catalog, db: table.db, name: table.name }));
|
|
}
|
|
|
|
function firstDescription(descriptions: Record<string, string> | undefined): string | null {
|
|
return Object.values(descriptions ?? {}).find((value) => value.trim().length > 0) ?? null;
|
|
}
|
|
|
|
function matchedOnTable(table: TableWithDescriptions, query: string): RawSchemaHit['matchedOn'] | null {
|
|
const q = normalize(query);
|
|
if (!q) {
|
|
return null;
|
|
}
|
|
if (normalize(table.name).includes(q)) {
|
|
return 'name';
|
|
}
|
|
if (normalize(table.db).includes(q)) {
|
|
return 'db';
|
|
}
|
|
if (normalize(table.comment).includes(q)) {
|
|
return 'comment';
|
|
}
|
|
if (normalize(firstDescription(table.descriptions)).includes(q)) {
|
|
return 'description';
|
|
}
|
|
return null;
|
|
}
|
|
|
|
function matchedOnColumn(
|
|
column: KtxSchemaColumn & { descriptions?: Record<string, string> },
|
|
query: string,
|
|
): 'name' | 'comment' | 'description' | null {
|
|
const q = normalize(query);
|
|
if (!q) {
|
|
return null;
|
|
}
|
|
if (normalize(column.name).includes(q)) {
|
|
return 'name';
|
|
}
|
|
if (normalize(column.comment).includes(q)) {
|
|
return 'comment';
|
|
}
|
|
if (normalize(firstDescription(column.descriptions)).includes(q)) {
|
|
return 'description';
|
|
}
|
|
return null;
|
|
}
|
|
|
|
export class WarehouseCatalogService {
|
|
private readonly catalogs = new Map<string, Promise<ConnectionCatalog | null>>();
|
|
|
|
constructor(private readonly deps: WarehouseCatalogServiceDeps) {}
|
|
|
|
async hasScan(connectionId: string): Promise<boolean> {
|
|
return (await this.loadCatalog(connectionId)) !== null;
|
|
}
|
|
|
|
async getLatestSyncId(connectionId: string): Promise<string | null> {
|
|
return (await this.loadCatalog(connectionId))?.syncId ?? null;
|
|
}
|
|
|
|
async listTables(connectionId: string): Promise<KtxTableRef[]> {
|
|
const catalog = await this.loadCatalog(connectionId);
|
|
return catalog?.tables.map((table) => ({ catalog: table.catalog, db: table.db, name: table.name })) ?? [];
|
|
}
|
|
|
|
async getTable(ref: { connectionId: string } & KtxTableRef): Promise<TableDetail | null> {
|
|
const catalog = await this.loadCatalog(ref.connectionId);
|
|
if (!catalog) {
|
|
return null;
|
|
}
|
|
const table = catalog.tables.find((candidate) => refsEqual(candidate, ref)) as TableWithDescriptions | undefined;
|
|
if (!table) {
|
|
return null;
|
|
}
|
|
const profileTables = catalog.profile?.tables ?? [];
|
|
const profileTable = profileTables.find((candidate) => candidate.table && refsEqual(candidate.table, table));
|
|
const profileColumns = catalog.profile?.columns ?? {};
|
|
|
|
return {
|
|
connectionId: ref.connectionId,
|
|
catalog: table.catalog,
|
|
db: table.db,
|
|
name: table.name,
|
|
display: formatDisplay(catalog.driver, table),
|
|
kind: table.kind,
|
|
comment: table.comment,
|
|
description: firstDescription(table.descriptions),
|
|
rowCount: profileTable?.rowCount ?? table.estimatedRows ?? null,
|
|
columns: table.columns.map((rawColumn) => {
|
|
const column = rawColumn as KtxSchemaColumn & { descriptions?: Record<string, string> };
|
|
const profileColumn =
|
|
profileColumns[columnKey(table, column.name)] ??
|
|
Object.entries(profileColumns).find(
|
|
([key, value]) =>
|
|
normalize(key) === `${normalize(table.name)}.${normalize(column.name)}` ||
|
|
(value.table && refsEqual(value.table, table) && normalize(value.column) === normalize(column.name)),
|
|
)?.[1];
|
|
return {
|
|
...column,
|
|
descriptions: column.descriptions ?? {},
|
|
rowCount: profileColumn?.rowCount ?? null,
|
|
nullCount: profileColumn?.nullCount ?? null,
|
|
distinctCount: profileColumn?.distinctCount ?? null,
|
|
nullRate: profileColumn?.nullRate ?? null,
|
|
sampleValues: (profileColumn?.sampleValues ?? []).map((value) => String(value)),
|
|
};
|
|
}),
|
|
foreignKeys: table.foreignKeys,
|
|
};
|
|
}
|
|
|
|
async resolveDisplay(
|
|
connectionId: string,
|
|
display: string,
|
|
): Promise<{
|
|
resolved: KtxTableRef | null;
|
|
candidates: KtxTableRef[];
|
|
dialect: string;
|
|
}> {
|
|
const catalog = await this.loadCatalog(connectionId);
|
|
if (!catalog) {
|
|
return { resolved: null, candidates: [], dialect: 'unknown' };
|
|
}
|
|
const dialect = getDialectForDriver(catalog.driver).type;
|
|
const parsed = parseDisplay(catalog.driver, display);
|
|
if (!parsed) {
|
|
return { resolved: null, candidates: bestCandidates(catalog.tables, display), dialect };
|
|
}
|
|
const table = catalog.tables.find((candidate) => refsEqual(candidate, parsed));
|
|
if (!table) {
|
|
return { resolved: null, candidates: bestCandidates(catalog.tables, display), dialect };
|
|
}
|
|
return { resolved: { catalog: table.catalog, db: table.db, name: table.name }, candidates: [], dialect };
|
|
}
|
|
|
|
async resolveDisplayTarget(connectionId: string, display: string): Promise<DisplayTargetResolution> {
|
|
const catalog = await this.loadCatalog(connectionId);
|
|
if (!catalog) {
|
|
return { resolved: null, candidates: [], dialect: 'unknown' };
|
|
}
|
|
|
|
const dialect = getDialectForDriver(catalog.driver).type;
|
|
const tableResolution = await this.resolveDisplay(connectionId, display);
|
|
if (tableResolution.resolved) {
|
|
return tableResolution;
|
|
}
|
|
|
|
const parsedColumn = parseColumnDisplay(catalog.driver, display);
|
|
if (!parsedColumn) {
|
|
return { resolved: null, candidates: bestCandidates(catalog.tables, display), dialect };
|
|
}
|
|
|
|
const table = catalog.tables.find((candidate) => refsEqual(candidate, parsedColumn));
|
|
if (!table) {
|
|
return { resolved: null, candidates: bestCandidates(catalog.tables, display), dialect };
|
|
}
|
|
|
|
return {
|
|
resolved: {
|
|
catalog: table.catalog,
|
|
db: table.db,
|
|
name: table.name,
|
|
column: parsedColumn.column,
|
|
},
|
|
candidates: [],
|
|
dialect,
|
|
};
|
|
}
|
|
|
|
async searchByName(connectionId: string, query: string, limit: number): Promise<RawSchemaHit[]> {
|
|
const catalog = await this.loadCatalog(connectionId);
|
|
if (!catalog) {
|
|
return [];
|
|
}
|
|
const hits: RawSchemaHit[] = [];
|
|
for (const table of catalog.tables as TableWithDescriptions[]) {
|
|
const tableMatch = matchedOnTable(table, query);
|
|
if (tableMatch) {
|
|
hits.push({
|
|
kind: 'table',
|
|
connectionId,
|
|
ref: { catalog: table.catalog, db: table.db, name: table.name },
|
|
display: formatDisplay(catalog.driver, table),
|
|
matchedOn: tableMatch,
|
|
});
|
|
}
|
|
for (const column of table.columns) {
|
|
const columnMatch = matchedOnColumn(column, query);
|
|
if (!columnMatch) {
|
|
continue;
|
|
}
|
|
hits.push({
|
|
kind: 'column',
|
|
connectionId,
|
|
ref: { catalog: table.catalog, db: table.db, name: table.name, column: column.name },
|
|
display: `${formatDisplay(catalog.driver, table)}.${column.name}`,
|
|
matchedOn: columnMatch,
|
|
});
|
|
}
|
|
}
|
|
return hits.slice(0, Math.max(0, limit));
|
|
}
|
|
|
|
private loadCatalog(connectionId: string): Promise<ConnectionCatalog | null> {
|
|
const existing = this.catalogs.get(connectionId);
|
|
if (existing) {
|
|
return existing;
|
|
}
|
|
const pending = this.readCatalog(connectionId);
|
|
this.catalogs.set(connectionId, pending);
|
|
return pending;
|
|
}
|
|
|
|
private async readCatalog(connectionId: string): Promise<ConnectionCatalog | null> {
|
|
const root = `raw-sources/${connectionId}/live-database`;
|
|
const listed = await this.deps.fileStore.listFiles(root);
|
|
const connectionFiles = listed.files.filter((file) => file.endsWith('/connection.json')).sort();
|
|
const latestConnectionPath = connectionFiles.at(-1);
|
|
if (!latestConnectionPath) {
|
|
return null;
|
|
}
|
|
const latestRoot = latestConnectionPath.slice(0, -'/connection.json'.length);
|
|
const syncId = latestRoot.split('/').at(-1) ?? '';
|
|
const connection = readJson<ConnectionArtifact>((await this.deps.fileStore.readFile(latestConnectionPath)).content);
|
|
const tablesListing = await this.deps.fileStore.listFiles(`${latestRoot}/tables`);
|
|
const tables: KtxSchemaTable[] = [];
|
|
for (const tablePath of tablesListing.files.filter((file) => file.endsWith('.json')).sort()) {
|
|
tables.push(readJson<KtxSchemaTable>((await this.deps.fileStore.readFile(tablePath)).content));
|
|
}
|
|
|
|
let profile: RelationshipProfileArtifact | null = null;
|
|
try {
|
|
profile = readJson<RelationshipProfileArtifact>(
|
|
(await this.deps.fileStore.readFile(`${latestRoot}/enrichment/relationship-profile.json`)).content,
|
|
);
|
|
} catch {
|
|
profile = null;
|
|
}
|
|
|
|
return {
|
|
connectionId,
|
|
syncId,
|
|
driver: connection.driver ?? profile?.driver ?? 'postgres',
|
|
tables,
|
|
profile,
|
|
};
|
|
}
|
|
}
|