ktx/packages/cli/test/context/scan/enrichment-state.test.ts

176 lines
5.1 KiB
TypeScript
Raw Permalink Normal View History

2026-05-10 23:12:26 +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';
import {
2026-05-10 23:51:24 +02:00
completedKtxScanEnrichmentStateSummary,
computeKtxScanEnrichmentInputHash,
summarizeKtxScanEnrichmentState,
test: split cli tests from source tree (#216) * 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
2026-05-26 08:49:05 +02:00
} from '../../../src/context/scan/enrichment-state.js';
import { SqliteLocalScanEnrichmentStateStore } from '../../../src/context/scan/sqlite-local-enrichment-state-store.js';
import type { KtxSchemaSnapshot } from '../../../src/context/scan/types.js';
2026-05-10 23:12:26 +02:00
2026-05-10 23:51:24 +02:00
const snapshot: KtxSchemaSnapshot = {
2026-05-10 23:12:26 +02:00
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 () => {
2026-05-10 23:51:24 +02:00
tempDir = await mkdtemp(join(tmpdir(), 'ktx-scan-enrichment-state-'));
2026-05-10 23:12:26 +02:00
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', () => {
2026-05-10 23:51:24 +02:00
const first = computeKtxScanEnrichmentInputHash({
2026-05-10 23:12:26 +02:00
snapshot,
mode: 'enriched',
detectRelationships: true,
providerIdentity: { provider: 'local-heuristic', llmModel: 'a' },
2026-05-10 23:12:26 +02:00
});
2026-05-10 23:51:24 +02:00
const second = computeKtxScanEnrichmentInputHash({
2026-05-10 23:12:26 +02:00
snapshot: { ...snapshot, metadata: {} },
mode: 'enriched',
detectRelationships: true,
providerIdentity: { llmModel: 'a', provider: 'local-heuristic' },
2026-05-10 23:12:26 +02:00
});
const firstTable = snapshot.tables[0];
if (!firstTable) {
throw new Error('Expected test snapshot table');
}
2026-05-10 23:51:24 +02:00
const changed = computeKtxScanEnrichmentInputHash({
2026-05-10 23:12:26 +02:00
snapshot: { ...snapshot, tables: [{ ...firstTable, name: 'orders_v2' }] },
mode: 'enriched',
detectRelationships: true,
providerIdentity: { provider: 'local-heuristic', llmModel: 'a' },
2026-05-10 23:12:26 +02:00
});
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 () => {
2026-05-10 23:51:24 +02:00
const inputHash = computeKtxScanEnrichmentInputHash({
2026-05-10 23:12:26 +02:00
snapshot,
mode: 'enriched',
detectRelationships: true,
providerIdentity: { provider: 'local-heuristic' },
2026-05-10 23:12:26 +02:00
});
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(
2026-05-10 23:51:24 +02:00
summarizeKtxScanEnrichmentState({
2026-05-10 23:12:26 +02:00
resumedStages: ['descriptions'],
completedStages: ['descriptions', 'embeddings'],
failedStages: ['relationships'],
}),
).toEqual({
resumedStages: ['descriptions'],
completedStages: ['descriptions', 'embeddings'],
failedStages: ['relationships'],
});
2026-05-10 23:51:24 +02:00
expect(completedKtxScanEnrichmentStateSummary()).toEqual({
2026-05-10 23:12:26 +02:00
resumedStages: [],
completedStages: [],
failedStages: [],
});
});
});