mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +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
295 lines
10 KiB
TypeScript
295 lines
10 KiB
TypeScript
import { describe, expect, it, vi } from 'vitest';
|
|
import { buildSemanticLayerSourceSearchText, SlSearchService } from '../../../src/context/sl/sl-search.service.js';
|
|
import type { SemanticLayerSource } from '../../../src/context/sl/types.js';
|
|
|
|
describe('SlSearchService', () => {
|
|
it('builds search text from source, columns, measures, and joins', () => {
|
|
const service = new SlSearchService(
|
|
{ maxBatchSize: 16, computeEmbedding: vi.fn(), computeEmbeddingsBulk: vi.fn() },
|
|
{
|
|
upsertSources: vi.fn(),
|
|
getExistingSearchTexts: vi.fn(),
|
|
deleteStale: vi.fn(),
|
|
deleteByConnection: vi.fn(),
|
|
deleteByConnectionAndName: vi.fn(),
|
|
search: vi.fn(),
|
|
},
|
|
);
|
|
const source: SemanticLayerSource = {
|
|
name: 'orders',
|
|
descriptions: { user: 'Customer orders' },
|
|
table: 'public.orders',
|
|
grain: ['id'],
|
|
columns: [
|
|
{ name: 'id', type: 'string' },
|
|
{ name: 'amount', type: 'number', descriptions: { user: 'Order amount' } },
|
|
],
|
|
measures: [{ name: 'revenue', expr: 'sum(amount)', description: 'Gross revenue' }],
|
|
joins: [{ to: 'customers', on: 'orders.customer_id = customers.id', relationship: 'many_to_one' }],
|
|
};
|
|
|
|
expect(service.buildSearchText(source)).toContain('orders');
|
|
expect(service.buildSearchText(source)).toContain('Customer orders');
|
|
expect(service.buildSearchText(source)).toContain('amount (number) Order amount');
|
|
expect(service.buildSearchText(source)).toContain('measure: revenue sum(amount) Gross revenue');
|
|
expect(service.buildSearchText(source)).toContain('join: customers (many_to_one)');
|
|
});
|
|
|
|
it('exports the same canonical search text builder used by SlSearchService', () => {
|
|
const service = new SlSearchService(
|
|
{ maxBatchSize: 16, computeEmbedding: vi.fn(), computeEmbeddingsBulk: vi.fn() },
|
|
{
|
|
upsertSources: vi.fn(),
|
|
getExistingSearchTexts: vi.fn(),
|
|
deleteStale: vi.fn(),
|
|
deleteByConnection: vi.fn(),
|
|
deleteByConnectionAndName: vi.fn(),
|
|
search: vi.fn(),
|
|
},
|
|
);
|
|
const source: SemanticLayerSource = {
|
|
name: 'orders',
|
|
descriptions: { user: 'Customer orders' },
|
|
table: 'public.orders',
|
|
grain: ['id'],
|
|
columns: [
|
|
{
|
|
name: 'status',
|
|
type: 'string',
|
|
enum_values: { dbt: ['paid', 'refunded'] },
|
|
constraints: { dbt: { not_null: true } },
|
|
},
|
|
],
|
|
joins: [{ to: 'customers', on: 'orders.customer_id = customers.id', relationship: 'many_to_one' }],
|
|
measures: [{ name: 'total_revenue', expr: 'sum(revenue)', description: 'Gross revenue' }],
|
|
tags: { dbt: ['finance'] },
|
|
};
|
|
|
|
expect(buildSemanticLayerSourceSearchText(source)).toBe(service.buildSearchText(source));
|
|
expect(buildSemanticLayerSourceSearchText(source)).toContain('dbt values: paid, refunded');
|
|
expect(buildSemanticLayerSourceSearchText(source)).toContain('measure: total_revenue sum(revenue) Gross revenue');
|
|
expect(buildSemanticLayerSourceSearchText(source)).toContain('dbt tags: finance');
|
|
});
|
|
|
|
it('includes dbt enum, not_null, and unique tokens for columns', () => {
|
|
const service = new SlSearchService(
|
|
{ maxBatchSize: 16, computeEmbedding: vi.fn(), computeEmbeddingsBulk: vi.fn() },
|
|
{
|
|
upsertSources: vi.fn(),
|
|
getExistingSearchTexts: vi.fn(),
|
|
deleteStale: vi.fn(),
|
|
deleteByConnection: vi.fn(),
|
|
deleteByConnectionAndName: vi.fn(),
|
|
search: vi.fn(),
|
|
},
|
|
);
|
|
const source: SemanticLayerSource = {
|
|
name: 'src_orders',
|
|
table: 'public.orders',
|
|
grain: [],
|
|
columns: [
|
|
{
|
|
name: 'status',
|
|
type: 'string',
|
|
descriptions: {},
|
|
enum_values: { dbt: ['a', 'b'] },
|
|
constraints: { dbt: { not_null: true, unique: true } },
|
|
},
|
|
],
|
|
joins: [],
|
|
measures: [],
|
|
};
|
|
const text = service.buildSearchText(source);
|
|
expect(text).toContain('dbt values: a, b');
|
|
expect(text).toContain('not_null');
|
|
expect(text).toContain('unique');
|
|
});
|
|
|
|
it('includes dbt default time token for MetricFlow agg_time_dimension', () => {
|
|
const service = new SlSearchService(
|
|
{ maxBatchSize: 16, computeEmbedding: vi.fn(), computeEmbeddingsBulk: vi.fn() },
|
|
{
|
|
upsertSources: vi.fn(),
|
|
getExistingSearchTexts: vi.fn(),
|
|
deleteStale: vi.fn(),
|
|
deleteByConnection: vi.fn(),
|
|
deleteByConnectionAndName: vi.fn(),
|
|
search: vi.fn(),
|
|
},
|
|
);
|
|
const source: SemanticLayerSource = {
|
|
name: 'orders',
|
|
table: 'public.orders',
|
|
grain: ['id'],
|
|
columns: [{ name: 'id', type: 'number' }],
|
|
joins: [],
|
|
measures: [],
|
|
default_time_dimension: { dbt: 'order_date' },
|
|
};
|
|
expect(service.buildSearchText(source)).toContain('dbt default time: order_date');
|
|
});
|
|
|
|
it('includes dbt table tags and freshness from manifest-backed source', () => {
|
|
const service = new SlSearchService(
|
|
{ maxBatchSize: 16, computeEmbedding: vi.fn(), computeEmbeddingsBulk: vi.fn() },
|
|
{
|
|
upsertSources: vi.fn(),
|
|
getExistingSearchTexts: vi.fn(),
|
|
deleteStale: vi.fn(),
|
|
deleteByConnection: vi.fn(),
|
|
deleteByConnectionAndName: vi.fn(),
|
|
search: vi.fn(),
|
|
},
|
|
);
|
|
const source: SemanticLayerSource = {
|
|
name: 'customers',
|
|
table: 'jaffle.customers',
|
|
grain: ['id'],
|
|
columns: [{ name: 'id', type: 'number' }],
|
|
joins: [],
|
|
measures: [],
|
|
tags: { dbt: ['raw', 'core'] },
|
|
freshness: {
|
|
dbt: {
|
|
loaded_at_field: 'updated_at',
|
|
raw: { warn_after: { count: 12, period: 'hour' } },
|
|
},
|
|
},
|
|
};
|
|
const text = service.buildSearchText(source);
|
|
expect(text).toContain('dbt tags: raw, core');
|
|
expect(text).toContain('dbt freshness:');
|
|
expect(text).toContain('loaded_at=updated_at');
|
|
expect(text).toContain('warn_after');
|
|
});
|
|
|
|
it('includes historic SQL usage in semantic-layer search text', () => {
|
|
const source: SemanticLayerSource = {
|
|
name: 'orders',
|
|
descriptions: { user: 'Customer orders' },
|
|
table: 'public.orders',
|
|
grain: ['order_id'],
|
|
columns: [{ name: 'order_id', type: 'string' }],
|
|
joins: [],
|
|
measures: [],
|
|
usage: {
|
|
narrative: 'Analysts inspect paid and refunded order lifecycle trends by customer segment.',
|
|
frequencyTier: 'high',
|
|
commonFilters: ['status', 'created_at'],
|
|
commonGroupBys: ['customer_segment'],
|
|
commonJoins: [{ table: 'public.customers', on: ['customer_id'] }],
|
|
staleSince: '2026-05-01T00:00:00.000Z',
|
|
},
|
|
};
|
|
|
|
const text = buildSemanticLayerSourceSearchText(source);
|
|
|
|
expect(text).toContain('usage: Analysts inspect paid and refunded order lifecycle trends by customer segment.');
|
|
expect(text).toContain('frequency: high');
|
|
expect(text).toContain('commonly filtered by: status, created_at');
|
|
expect(text).toContain('commonly grouped by: customer_segment');
|
|
expect(text).toContain('commonly joined to public.customers on customer_id');
|
|
expect(text).toContain('stale since 2026-05-01T00:00:00.000Z');
|
|
});
|
|
|
|
it('preserves FTS snippets returned by the source index', async () => {
|
|
const service = new SlSearchService(
|
|
{
|
|
maxBatchSize: 16,
|
|
computeEmbedding: vi.fn(async () => [1, 0]),
|
|
computeEmbeddingsBulk: vi.fn(),
|
|
},
|
|
{
|
|
upsertSources: vi.fn(),
|
|
getExistingSearchTexts: vi.fn(),
|
|
deleteStale: vi.fn(),
|
|
deleteByConnection: vi.fn(),
|
|
deleteByConnectionAndName: vi.fn(),
|
|
search: vi.fn(async () => [
|
|
{
|
|
sourceName: 'orders',
|
|
rrfScore: 0.75,
|
|
snippet: 'usage: paid <mark>order</mark> lifecycle',
|
|
},
|
|
]),
|
|
},
|
|
);
|
|
|
|
await expect(service.search('warehouse', 'order lifecycle', 10)).resolves.toEqual([
|
|
{
|
|
sourceName: 'orders',
|
|
score: 0.75,
|
|
snippet: 'usage: paid <mark>order</mark> lifecycle',
|
|
},
|
|
]);
|
|
});
|
|
|
|
it('indexSources reports stats and supports lexical-only indexing', async () => {
|
|
const repository = {
|
|
upsertSources: vi.fn().mockResolvedValue(undefined),
|
|
getExistingSearchTexts: vi.fn().mockResolvedValue(
|
|
new Map([
|
|
['old_source', { searchText: 'old source', hasEmbedding: true }],
|
|
]),
|
|
),
|
|
deleteStale: vi.fn().mockResolvedValue(1),
|
|
deleteByConnection: vi.fn().mockResolvedValue(0),
|
|
deleteByConnectionAndName: vi.fn(),
|
|
search: vi.fn(),
|
|
};
|
|
const service = new SlSearchService(null, repository);
|
|
const source: SemanticLayerSource = {
|
|
name: 'orders',
|
|
table: 'public.orders',
|
|
grain: ['id'],
|
|
columns: [{ name: 'id', type: 'number' }],
|
|
joins: [],
|
|
measures: [],
|
|
};
|
|
|
|
await expect(service.indexSources('warehouse', [source])).resolves.toEqual({
|
|
scanned: 1,
|
|
updated: 1,
|
|
deleted: 1,
|
|
embeddingsRecomputed: 0,
|
|
embeddingsFailed: 0,
|
|
});
|
|
expect(repository.upsertSources).toHaveBeenCalledWith('warehouse', [
|
|
expect.objectContaining({ sourceName: 'orders', embedding: null }),
|
|
]);
|
|
});
|
|
|
|
it('does not update unchanged lexical-only SL rows on repeated sync', async () => {
|
|
const repository = {
|
|
upsertSources: vi.fn().mockResolvedValue(undefined),
|
|
getExistingSearchTexts: vi.fn().mockResolvedValue(
|
|
new Map([
|
|
['orders', { searchText: 'orders. table: public.orders. id (number)', hasEmbedding: false }],
|
|
]),
|
|
),
|
|
deleteStale: vi.fn().mockResolvedValue(0),
|
|
deleteByConnection: vi.fn().mockResolvedValue(0),
|
|
deleteByConnectionAndName: vi.fn(),
|
|
search: vi.fn(),
|
|
};
|
|
const service = new SlSearchService(null, repository);
|
|
const source: SemanticLayerSource = {
|
|
name: 'orders',
|
|
table: 'public.orders',
|
|
grain: ['id'],
|
|
columns: [{ name: 'id', type: 'number' }],
|
|
joins: [],
|
|
measures: [],
|
|
};
|
|
|
|
await expect(service.indexSources('warehouse', [source])).resolves.toEqual({
|
|
scanned: 1,
|
|
updated: 0,
|
|
deleted: 0,
|
|
embeddingsRecomputed: 0,
|
|
embeddingsFailed: 0,
|
|
});
|
|
expect(repository.upsertSources).toHaveBeenCalledWith('warehouse', []);
|
|
expect(repository.deleteStale).toHaveBeenCalledWith('warehouse', ['orders']);
|
|
});
|
|
});
|