mirror of
https://github.com/Kaelio/ktx.git
synced 2026-07-01 08:59:39 +02:00
* feat(cli): define full warehouse dialect contract
* test(cli): keep dialect edge tests focused
* fix(cli): stabilize dialect contract foundation
* refactor(connectors): own read-only query preparation
* refactor(connectors): resolve dialects through registry
* refactor(connectors): keep concrete dialect classes internal
* chore(workspace): enforce dialect import boundary
* refactor(cli): resolve relationship dialect at scan boundary
* refactor(cli): use dialect display parsing for entity details
* refactor(cli): use dialect display parsing for warehouse catalog
* refactor(cli): use dialect SQL in relationship workflows
* test(cli): verify solid dialect scan workflow closure
* test: split cli tests from source tree
* refactor(cli): standardize BigQuery scope listing
* feat(sqlite): implement connector scope listing
* test(connectors): cover required table listing
* feat(cli): add warehouse driver registry
* refactor(setup): route scope discovery through driver registry
* refactor(cli): route local query execution through driver registry
* refactor(historic-sql): route dialect support through driver registry
* refactor(cli): test warehouse connections through driver registry
* fix(cli): close driver registry type export gaps
* Improve setup daemon diagnostics
* refactor(setup): centralize rail-prefixed diagnostics + query-history fallback
Extract errorMessage, writePrefixedLines, and flushPrefixedBufferedCommandOutput
into clack.ts so the setup wizard, managed daemons, and embedding/agent steps
share one rail-formatted writer. setup-databases.ts also adds a
"disable query history and retry" option when the schema-context build fails
and query history is the likely culprit, surfaced via a new
failed-query-history-unavailable status.
* fix(cli): carry catalog through the picker so BigQuery/Snowflake/SQL Server scope filters match
The setup picker's KtxTableListEntry was a 2-level { schema, name }, so
qualifiedTableId always wrote db.name into enabled_tables. When BigQuery,
Snowflake, or SQL Server later ran fast ingest, their introspect step filtered
the scope set with scopedTableNames(scope, { catalog: projectId|database, db })
— catalog was non-null on the introspect side but null in the scope refs, so
every entry was rejected, the live-database adapter staged zero table files,
and detect() failed with 'Adapter "live-database" did not recognize fetched
source output'.
Align the picker boundary with the canonical 3-level KtxTableRef:
- Add catalog: string | null to KtxTableListEntry.
- BigQuery/Snowflake/SQL Server listTables populate catalog from the
resolved projectId / database; Postgres/MySQL/ClickHouse/SQLite set null.
- qualifiedTableId emits catalog.schema.name when catalog is non-null
(resolveEnabledTables already accepts the 3-part shape) and
schemasFromEnabledTables now goes through parseDottedTableEntry so it
recovers the schema correctly from both 2-part and 3-part entries.
- Export parseDottedTableEntry from enabled-tables.ts (@internal) for picker
reuse.
Update listTables expectations in all seven connector tests and the setup /
picker test fixtures. Add a picker regression test that covers the
catalog-bearing round-trip (save + refine).
* fix(cli): allow debug telemetry under opt-out env
431 lines
14 KiB
TypeScript
431 lines
14 KiB
TypeScript
import { getDialectForDriver, type KtxDialect } from '../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;
|
|
|
|
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(dialect: KtxDialect, table: KtxTableRef): string {
|
|
return dialect.formatDisplayRef(table);
|
|
}
|
|
|
|
function parseDisplay(dialect: KtxDialect, display: string): KtxTableRef | null {
|
|
const parsed = dialect.parseDisplayRef(display);
|
|
if (parsed) {
|
|
return parsed;
|
|
}
|
|
const parts = splitDisplay(display);
|
|
return parts.length === 1 ? { catalog: null, db: null, name: parts[0]! } : null;
|
|
}
|
|
|
|
function parseColumnDisplay(dialect: KtxDialect, display: string): (KtxTableRef & { column: string }) | null {
|
|
const parts = splitDisplay(display);
|
|
const tablePartCount = dialect.columnDisplayTablePartCount();
|
|
if (parts.length !== tablePartCount + 1) {
|
|
return null;
|
|
}
|
|
const column = parts.at(-1);
|
|
if (!column) {
|
|
return null;
|
|
}
|
|
const table = dialect.parseDisplayRef(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 dialect = getDialectForDriver(catalog.driver);
|
|
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(dialect, 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);
|
|
const parsed = parseDisplay(dialect, display);
|
|
if (!parsed) {
|
|
return { resolved: null, candidates: bestCandidates(catalog.tables, display), dialect: dialect.type };
|
|
}
|
|
const exactTable = catalog.tables.find((candidate) => refsEqual(candidate, parsed));
|
|
const looseNameMatches =
|
|
parsed.catalog === null && parsed.db === null
|
|
? catalog.tables.filter((candidate) => normalize(candidate.name) === normalize(parsed.name))
|
|
: [];
|
|
const table = exactTable ?? (looseNameMatches.length === 1 ? looseNameMatches[0] : undefined);
|
|
if (!table) {
|
|
return { resolved: null, candidates: bestCandidates(catalog.tables, display), dialect: dialect.type };
|
|
}
|
|
return { resolved: { catalog: table.catalog, db: table.db, name: table.name }, candidates: [], dialect: dialect.type };
|
|
}
|
|
|
|
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);
|
|
const tableResolution = await this.resolveDisplay(connectionId, display);
|
|
if (tableResolution.resolved) {
|
|
return tableResolution;
|
|
}
|
|
|
|
const parsedColumn = parseColumnDisplay(dialect, display);
|
|
if (!parsedColumn) {
|
|
return { resolved: null, candidates: bestCandidates(catalog.tables, display), dialect: dialect.type };
|
|
}
|
|
|
|
const table = catalog.tables.find((candidate) => refsEqual(candidate, parsedColumn));
|
|
if (!table) {
|
|
return { resolved: null, candidates: bestCandidates(catalog.tables, display), dialect: dialect.type };
|
|
}
|
|
|
|
return {
|
|
resolved: {
|
|
catalog: table.catalog,
|
|
db: table.db,
|
|
name: table.name,
|
|
column: parsedColumn.column,
|
|
},
|
|
candidates: [],
|
|
dialect: dialect.type,
|
|
};
|
|
}
|
|
|
|
async searchByName(connectionId: string, query: string, limit: number): Promise<RawSchemaHit[]> {
|
|
const catalog = await this.loadCatalog(connectionId);
|
|
if (!catalog) {
|
|
return [];
|
|
}
|
|
const dialect = getDialectForDriver(catalog.driver);
|
|
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(dialect, 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(dialect, 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,
|
|
};
|
|
}
|
|
}
|