2026-05-10 23:12:26 +02:00
|
|
|
import { describe, expect, it, vi } from 'vitest';
|
|
|
|
|
|
|
|
|
|
vi.mock('ai', async (importOriginal) => {
|
|
|
|
|
const actual = await importOriginal<typeof import('ai')>();
|
|
|
|
|
return { ...actual, generateText: vi.fn() };
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
import { generateText } from 'ai';
|
|
|
|
|
import {
|
2026-05-10 23:51:24 +02:00
|
|
|
buildKtxColumnDescriptionPrompt,
|
|
|
|
|
buildKtxDataSourceDescriptionPrompt,
|
|
|
|
|
buildKtxTableDescriptionPrompt,
|
|
|
|
|
type KtxDescriptionCachePort,
|
|
|
|
|
KtxDescriptionGenerator,
|
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/description-generation.js';
|
|
|
|
|
import { createKtxConnectorCapabilities, type KtxScanConnector } from '../../../src/context/scan/types.js';
|
2026-05-10 23:12:26 +02:00
|
|
|
|
2026-05-10 23:51:24 +02:00
|
|
|
function createCache(initial: Record<string, string> = {}): KtxDescriptionCachePort {
|
2026-05-10 23:12:26 +02:00
|
|
|
const data = new Map(Object.entries(initial));
|
|
|
|
|
return {
|
|
|
|
|
buildTableKey: (table) => [table.catalog, table.db, table.name].filter(Boolean).join('.'),
|
|
|
|
|
buildColumnKey: (table, columnName) => [table.catalog, table.db, table.name, columnName].filter(Boolean).join('.'),
|
|
|
|
|
buildConnectionKey: (connectionName) => `__connection:${connectionName}`,
|
|
|
|
|
get: vi.fn(async (key: string) => data.get(key) ?? null),
|
|
|
|
|
set: vi.fn(async (key: string, value: string) => {
|
|
|
|
|
data.set(key, value);
|
|
|
|
|
}),
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function createLlmProvider(text = 'generated description') {
|
|
|
|
|
vi.mocked(generateText).mockResolvedValue({ text } as never);
|
|
|
|
|
return {
|
2026-05-16 12:06:34 +02:00
|
|
|
generateText: vi.fn(async (input) => {
|
|
|
|
|
const result = await generateText({
|
|
|
|
|
system: input.system ? { role: 'system', content: input.system } : undefined,
|
|
|
|
|
messages: [{ role: 'user', content: input.prompt }],
|
|
|
|
|
temperature: input.temperature,
|
|
|
|
|
} as never);
|
|
|
|
|
return result.text;
|
|
|
|
|
}),
|
|
|
|
|
generateObject: vi.fn(),
|
|
|
|
|
runAgentLoop: vi.fn(),
|
2026-05-10 23:12:26 +02:00
|
|
|
} as any;
|
|
|
|
|
}
|
|
|
|
|
|
2026-05-12 14:34:15 +02:00
|
|
|
function createFailingLlmProvider(message = 'timeout exceeded when trying to connect') {
|
|
|
|
|
vi.mocked(generateText).mockRejectedValue(new Error(message) as never);
|
|
|
|
|
return {
|
2026-05-16 12:06:34 +02:00
|
|
|
generateText: vi.fn(async (input) => {
|
|
|
|
|
const result = await generateText({
|
|
|
|
|
system: input.system ? { role: 'system', content: input.system } : undefined,
|
|
|
|
|
messages: [{ role: 'user', content: input.prompt }],
|
|
|
|
|
temperature: input.temperature,
|
|
|
|
|
} as never);
|
|
|
|
|
return result.text;
|
|
|
|
|
}),
|
|
|
|
|
generateObject: vi.fn(),
|
|
|
|
|
runAgentLoop: vi.fn(),
|
2026-05-12 14:34:15 +02:00
|
|
|
} as any;
|
|
|
|
|
}
|
|
|
|
|
|
2026-05-10 23:51:24 +02:00
|
|
|
function createConnector(): KtxScanConnector {
|
2026-05-10 23:12:26 +02:00
|
|
|
return {
|
|
|
|
|
id: 'test-connector',
|
|
|
|
|
driver: 'postgres',
|
2026-05-10 23:51:24 +02:00
|
|
|
capabilities: createKtxConnectorCapabilities({
|
2026-05-10 23:12:26 +02:00
|
|
|
tableSampling: true,
|
|
|
|
|
columnSampling: true,
|
|
|
|
|
nestedAnalysis: true,
|
|
|
|
|
}),
|
|
|
|
|
introspect: vi.fn(async () => {
|
|
|
|
|
throw new Error('introspection is not used by description generation');
|
|
|
|
|
}),
|
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
|
|
|
listSchemas: vi.fn(async () => []),
|
|
|
|
|
listTables: vi.fn(async () => []),
|
2026-05-10 23:12:26 +02:00
|
|
|
sampleColumn: vi.fn(async () => ({
|
|
|
|
|
values: ['paid', 'refunded', null],
|
|
|
|
|
nullCount: 1,
|
|
|
|
|
distinctCount: 2,
|
|
|
|
|
})),
|
|
|
|
|
sampleTable: vi.fn(async () => ({
|
|
|
|
|
headers: ['id', 'status', 'amount'],
|
|
|
|
|
rows: [
|
|
|
|
|
[1, 'paid', 20],
|
|
|
|
|
[2, 'refunded', 10],
|
|
|
|
|
],
|
|
|
|
|
totalRows: 2,
|
|
|
|
|
})),
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
2026-05-10 23:51:24 +02:00
|
|
|
describe('KTX description prompt builders', () => {
|
2026-05-10 23:12:26 +02:00
|
|
|
it('builds column prompts with sample values, source descriptions, and nested BigQuery guidance', () => {
|
2026-05-14 15:36:27 +02:00
|
|
|
const { system, user } = buildKtxColumnDescriptionPrompt({
|
2026-05-10 23:12:26 +02:00
|
|
|
columnName: 'payload',
|
|
|
|
|
columnValues: [{ nested: true }, '[1,2]'],
|
|
|
|
|
tableContext: 'Table: events | Columns: payload | Data source: BIGQUERY',
|
|
|
|
|
dataSourceType: 'BIGQUERY',
|
|
|
|
|
supportsNestedAnalysis: true,
|
|
|
|
|
rawDescriptions: { db: 'Raw event payload', ai: 'Old AI text', user: 'User text' },
|
2026-05-14 15:36:27 +02:00
|
|
|
maxWords: 12,
|
2026-05-10 23:12:26 +02:00
|
|
|
});
|
|
|
|
|
|
2026-05-14 15:36:27 +02:00
|
|
|
expect(user).toContain(
|
2026-05-10 23:12:26 +02:00
|
|
|
'<table_context> Table: events | Columns: payload | Data source: BIGQUERY </table_context>',
|
|
|
|
|
);
|
2026-05-14 15:36:27 +02:00
|
|
|
expect(user).toContain('<column_name> payload </column_name>');
|
|
|
|
|
expect(user).toContain('<sample_values> [object Object], [1,2] </sample_values>');
|
|
|
|
|
expect(user).toContain('<db_documentation> Raw event payload </db_documentation>');
|
|
|
|
|
expect(user).not.toContain('Old AI text');
|
|
|
|
|
expect(user).not.toContain('User text');
|
|
|
|
|
expect(system).toContain('nested/structured data');
|
|
|
|
|
expect(system).toContain('12 words or less');
|
|
|
|
|
expect(user).not.toContain('12 words or less');
|
2026-05-10 23:12:26 +02:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('builds table and data-source prompts from sampled rows', () => {
|
|
|
|
|
const sample = {
|
|
|
|
|
headers: ['id', 'status'],
|
|
|
|
|
rows: [
|
|
|
|
|
[1, 'paid'],
|
|
|
|
|
[2, 'refunded'],
|
|
|
|
|
],
|
|
|
|
|
totalRows: 2,
|
|
|
|
|
};
|
|
|
|
|
|
2026-05-14 15:36:27 +02:00
|
|
|
const table = buildKtxTableDescriptionPrompt({
|
|
|
|
|
tableName: 'orders',
|
|
|
|
|
sampleData: sample,
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
rawDescriptions: { dbt: 'Fact table for commerce orders' },
|
|
|
|
|
});
|
|
|
|
|
expect(table.user).toContain('status: paid, refunded');
|
|
|
|
|
expect(table.system).toContain('Analyze database tables');
|
2026-05-10 23:12:26 +02:00
|
|
|
|
2026-05-14 15:36:27 +02:00
|
|
|
const datasource = buildKtxDataSourceDescriptionPrompt({
|
|
|
|
|
tableSamples: [['orders', sample]],
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
});
|
|
|
|
|
expect(datasource.user).toContain('orders (2 columns, 2 sample rows)');
|
|
|
|
|
expect(datasource.system).toContain('Analyze databases');
|
2026-05-10 23:12:26 +02:00
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
|
2026-05-10 23:51:24 +02:00
|
|
|
describe('KtxDescriptionGenerator', () => {
|
2026-05-10 23:12:26 +02:00
|
|
|
it('generates column descriptions with pre-fetched values, cache hits, and word-limit metadata', async () => {
|
|
|
|
|
const cache = createCache({ 'warehouse.public.orders.cached_status': 'Cached status description' });
|
2026-05-16 12:06:34 +02:00
|
|
|
const llmRuntime = createLlmProvider('Payment state');
|
2026-05-10 23:12:26 +02:00
|
|
|
const connector = createConnector();
|
2026-05-10 23:51:24 +02:00
|
|
|
const generator = new KtxDescriptionGenerator({
|
2026-05-16 12:06:34 +02:00
|
|
|
llmRuntime,
|
2026-05-10 23:12:26 +02:00
|
|
|
cache,
|
|
|
|
|
settings: {
|
|
|
|
|
columnMaxWords: 12,
|
|
|
|
|
tableMaxWords: 18,
|
|
|
|
|
dataSourceMaxWords: 24,
|
|
|
|
|
temperature: 0.2,
|
|
|
|
|
concurrencyLimit: 2,
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const result = await generator.generateColumnDescriptions({
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
connector,
|
|
|
|
|
context: { runId: 'run-1' },
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
supportsNestedAnalysis: false,
|
|
|
|
|
table: {
|
|
|
|
|
catalog: 'warehouse',
|
|
|
|
|
db: 'public',
|
|
|
|
|
name: 'orders',
|
|
|
|
|
columns: [
|
|
|
|
|
{ name: 'status', sampleValues: ['paid', 'refunded'], rawDescriptions: { db: 'Payment lifecycle' } },
|
|
|
|
|
{ name: 'cached_status', sampleValues: ['open'] },
|
|
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
skipExisting: false,
|
|
|
|
|
existingDescriptions: {},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(result).toEqual({
|
|
|
|
|
columnDescriptions: [
|
|
|
|
|
['status', 'Payment state'],
|
|
|
|
|
['cached_status', 'Cached status description'],
|
|
|
|
|
],
|
|
|
|
|
processedColumns: ['status'],
|
|
|
|
|
skippedColumns: ['cached_status'],
|
|
|
|
|
});
|
|
|
|
|
expect(connector.sampleColumn).not.toHaveBeenCalled();
|
|
|
|
|
expect(generateText).toHaveBeenCalledWith(
|
|
|
|
|
expect.objectContaining({
|
|
|
|
|
temperature: 0.2,
|
fix(context): merge overlay columns onto manifest columns by name (#94)
* fix(context): merge overlay columns onto manifest columns by name
composeOverlay was appending overlay columns to the manifest column list,
producing duplicate entries when dbt/metabase overlays declared a column
just to attach descriptions. The duplicates carried no `type`, so the
pydantic SourceDefinition rejected them at semantic-query time and broke
`ktx sl query` for every overlay-backed measure. Now overlay columns
match base columns by name (case-insensitive): same-name entries merge
onto the manifest (overlay fields win, type/role fall back to the base,
descriptions merge per source key) and only new names append.
* refactor(sl): split overlay columns from column_overrides and enforce TS/Python wire contract
Overlay sources now have two distinct collections: `columns:` for computed
columns (requiring `expr` + `type`) and `column_overrides:` for metadata
patches to inherited manifest columns. Composing or loading an overlay that
mixes the two — or references an unknown column — fails with a typed error.
Introduce `ResolvedSemanticLayerSource` / `resolvedSourceSchema` /
`toResolvedWire` as the strict shape sent to the Python engine, and add a
schema contract test that diffs Zod against the Pydantic JSON schema dumped
by `python -m semantic_layer dump-schema`. `SourceDefinition` is now
`extra="forbid"` on the Python side.
`loadAllSources` surfaces per-file load errors instead of swallowing them,
so validation/query paths can report manifest shard parse failures.
* fix(context): make scan description generation resilient and quiet
A transient sampleTable failure during ingest used to take out every
table in a connection: generateTableDescription returned a hardcoded
'Table not found' string into descriptions.ai, and KtxDescriptionGenerator
was constructed without a logger, so the failure left no trail anywhere.
- sampleTable / sampleColumn calls retry 3x with 200/400/800ms backoff,
honouring KtxScanContext.signal via a new KtxAbortedError.
- On retry exhaustion or missing capability, table generation falls back
to a metadata-only prompt built from column name / native type / comment
/ rawDescriptions. The column path follows the same rule -- call the
LLM when any of samples or rawDescriptions are available; skip only
when both are absent.
- Logger is now threaded from KtxScanContext into the generator. Failures
emit structured KtxScanWarning entries (new description_fallback_used
code, plus existing sampling_failed / enrichment_failed /
connector_capability_missing). ktx scan groups warnings by code so a
batch of identical failures collapses to one summary line plus sample.
- Returns null on failure instead of the 'Table not found' sentinel; the
manifest writer's existing guard already skips empty descriptions, so
schema YAML no longer carries misleading text. SCAN_MANAGED_DESCRIPTION_KEYS
already strips stale 'ai' on merge, so existing YAML clears on next run.
Also suppress AI SDK v6 'system in messages' warning: pull system messages
out of KtxMessageBuilder.wrapSimple's output via a new splitKtxSystemMessages
helper and pass them top-level to generateText (preserves cacheControl
providerOptions on the SystemModelMessage). Agent-runner's local
splitSystemPromptMessages dedupes onto the shared helper.
* test(docs): align examples-docs assertions with revamped docs
PR #103 (setup/guide doc revamp) reworded several CLI examples and
connection labels; the assertions in scripts/examples-docs.test.mjs
still referenced the pre-revamp wording and were failing in CI on main.
Update the regexes to match the post-revamp content:
- drop the `--json` flag from the sl-query example expectation
- move the `Driver:` / `Status: ok` probe to the connection reference,
which is where that output now lives (driver id is lowercase
`postgres`, not the display name `PostgreSQL`)
- drop the obsolete `Install \`uv\`...` troubleshooting line
- accept `<connectionId>` everywhere; the docs no longer use the
hyphenated `<connection-id>` form
- match the `warehouse` connection id used in the quickstart instead of
the `postgres-warehouse` id only used in the README and setup ref
* fix(sl): skip TS/Python schema contract test when uv is unavailable
The TypeScript checks CI job does not install uv or Python, so the
module-level `execFileSync('uv', ...)` in schemas.contract.test.ts threw
ENOENT and failed the suite. Wrap the schema dump in a try/catch and
guard the describe block with `describe.skipIf` so the test skips in
environments without uv. Local dev and any CI job that has uv on PATH
still runs the cross-language contract assertion.
2026-05-15 02:11:04 +02:00
|
|
|
system: expect.objectContaining({
|
|
|
|
|
role: 'system',
|
|
|
|
|
content: expect.stringContaining('Please provide a concise description in 12 words or less.'),
|
|
|
|
|
}),
|
2026-05-10 23:12:26 +02:00
|
|
|
messages: expect.arrayContaining([
|
2026-05-14 15:36:27 +02:00
|
|
|
expect.objectContaining({
|
|
|
|
|
role: 'user',
|
|
|
|
|
content: expect.stringContaining('<column_name> status </column_name>'),
|
|
|
|
|
}),
|
2026-05-10 23:12:26 +02:00
|
|
|
]),
|
|
|
|
|
}),
|
|
|
|
|
);
|
fix(context): merge overlay columns onto manifest columns by name (#94)
* fix(context): merge overlay columns onto manifest columns by name
composeOverlay was appending overlay columns to the manifest column list,
producing duplicate entries when dbt/metabase overlays declared a column
just to attach descriptions. The duplicates carried no `type`, so the
pydantic SourceDefinition rejected them at semantic-query time and broke
`ktx sl query` for every overlay-backed measure. Now overlay columns
match base columns by name (case-insensitive): same-name entries merge
onto the manifest (overlay fields win, type/role fall back to the base,
descriptions merge per source key) and only new names append.
* refactor(sl): split overlay columns from column_overrides and enforce TS/Python wire contract
Overlay sources now have two distinct collections: `columns:` for computed
columns (requiring `expr` + `type`) and `column_overrides:` for metadata
patches to inherited manifest columns. Composing or loading an overlay that
mixes the two — or references an unknown column — fails with a typed error.
Introduce `ResolvedSemanticLayerSource` / `resolvedSourceSchema` /
`toResolvedWire` as the strict shape sent to the Python engine, and add a
schema contract test that diffs Zod against the Pydantic JSON schema dumped
by `python -m semantic_layer dump-schema`. `SourceDefinition` is now
`extra="forbid"` on the Python side.
`loadAllSources` surfaces per-file load errors instead of swallowing them,
so validation/query paths can report manifest shard parse failures.
* fix(context): make scan description generation resilient and quiet
A transient sampleTable failure during ingest used to take out every
table in a connection: generateTableDescription returned a hardcoded
'Table not found' string into descriptions.ai, and KtxDescriptionGenerator
was constructed without a logger, so the failure left no trail anywhere.
- sampleTable / sampleColumn calls retry 3x with 200/400/800ms backoff,
honouring KtxScanContext.signal via a new KtxAbortedError.
- On retry exhaustion or missing capability, table generation falls back
to a metadata-only prompt built from column name / native type / comment
/ rawDescriptions. The column path follows the same rule -- call the
LLM when any of samples or rawDescriptions are available; skip only
when both are absent.
- Logger is now threaded from KtxScanContext into the generator. Failures
emit structured KtxScanWarning entries (new description_fallback_used
code, plus existing sampling_failed / enrichment_failed /
connector_capability_missing). ktx scan groups warnings by code so a
batch of identical failures collapses to one summary line plus sample.
- Returns null on failure instead of the 'Table not found' sentinel; the
manifest writer's existing guard already skips empty descriptions, so
schema YAML no longer carries misleading text. SCAN_MANAGED_DESCRIPTION_KEYS
already strips stale 'ai' on merge, so existing YAML clears on next run.
Also suppress AI SDK v6 'system in messages' warning: pull system messages
out of KtxMessageBuilder.wrapSimple's output via a new splitKtxSystemMessages
helper and pass them top-level to generateText (preserves cacheControl
providerOptions on the SystemModelMessage). Agent-runner's local
splitSystemPromptMessages dedupes onto the shared helper.
* test(docs): align examples-docs assertions with revamped docs
PR #103 (setup/guide doc revamp) reworded several CLI examples and
connection labels; the assertions in scripts/examples-docs.test.mjs
still referenced the pre-revamp wording and were failing in CI on main.
Update the regexes to match the post-revamp content:
- drop the `--json` flag from the sl-query example expectation
- move the `Driver:` / `Status: ok` probe to the connection reference,
which is where that output now lives (driver id is lowercase
`postgres`, not the display name `PostgreSQL`)
- drop the obsolete `Install \`uv\`...` troubleshooting line
- accept `<connectionId>` everywhere; the docs no longer use the
hyphenated `<connection-id>` form
- match the `warehouse` connection id used in the quickstart instead of
the `postgres-warehouse` id only used in the README and setup ref
* fix(sl): skip TS/Python schema contract test when uv is unavailable
The TypeScript checks CI job does not install uv or Python, so the
module-level `execFileSync('uv', ...)` in schemas.contract.test.ts threw
ENOENT and failed the suite. Wrap the schema dump in a try/catch and
guard the describe block with `describe.skipIf` so the test skips in
environments without uv. Local dev and any CI job that has uv on PATH
still runs the cross-language contract assertion.
2026-05-15 02:11:04 +02:00
|
|
|
const lastCall = vi.mocked(generateText).mock.calls.at(-1)?.[0];
|
|
|
|
|
expect(lastCall?.messages?.some((message) => message.role === 'system')).toBe(false);
|
2026-05-10 23:12:26 +02:00
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('samples through the connector when column values are not pre-fetched', async () => {
|
|
|
|
|
const connector = createConnector();
|
2026-05-10 23:51:24 +02:00
|
|
|
const generator = new KtxDescriptionGenerator({
|
2026-05-16 12:06:34 +02:00
|
|
|
llmRuntime: createLlmProvider('Current order state'),
|
2026-05-10 23:12:26 +02:00
|
|
|
settings: {
|
|
|
|
|
columnMaxWords: 12,
|
|
|
|
|
tableMaxWords: 18,
|
|
|
|
|
dataSourceMaxWords: 24,
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const result = await generator.generateColumnDescriptions({
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
connector,
|
|
|
|
|
context: { runId: 'run-1' },
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
supportsNestedAnalysis: false,
|
|
|
|
|
table: {
|
|
|
|
|
catalog: null,
|
|
|
|
|
db: 'public',
|
|
|
|
|
name: 'orders',
|
|
|
|
|
columns: [{ name: 'status' }],
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(connector.sampleColumn).toHaveBeenCalledWith(
|
|
|
|
|
{
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
table: { catalog: null, db: 'public', name: 'orders' },
|
|
|
|
|
column: 'status',
|
|
|
|
|
limit: 50,
|
|
|
|
|
},
|
|
|
|
|
{ runId: 'run-1' },
|
|
|
|
|
);
|
|
|
|
|
expect(result.columnDescriptions).toEqual([['status', 'Current order state']]);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('samples through a description sampling port without requiring structural introspection', async () => {
|
|
|
|
|
const sampler = {
|
|
|
|
|
id: 'description-sampler:conn-1',
|
|
|
|
|
sampleColumn: vi.fn(async () => ({
|
|
|
|
|
values: ['paid', 'refunded'],
|
|
|
|
|
nullCount: null,
|
|
|
|
|
distinctCount: null,
|
|
|
|
|
})),
|
|
|
|
|
sampleTable: vi.fn(async () => ({
|
|
|
|
|
headers: ['id', 'status'],
|
|
|
|
|
rows: [[1, 'paid']],
|
|
|
|
|
totalRows: 1,
|
|
|
|
|
})),
|
|
|
|
|
};
|
2026-05-10 23:51:24 +02:00
|
|
|
const generator = new KtxDescriptionGenerator({
|
2026-05-16 12:06:34 +02:00
|
|
|
llmRuntime: createLlmProvider('Generated through sampler'),
|
2026-05-10 23:12:26 +02:00
|
|
|
settings: {
|
|
|
|
|
columnMaxWords: 12,
|
|
|
|
|
tableMaxWords: 18,
|
|
|
|
|
dataSourceMaxWords: 24,
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const result = await generator.generateColumnDescriptions({
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
connector: sampler,
|
|
|
|
|
context: { runId: 'run-1' },
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
supportsNestedAnalysis: false,
|
|
|
|
|
table: {
|
|
|
|
|
catalog: null,
|
|
|
|
|
db: 'public',
|
|
|
|
|
name: 'orders',
|
|
|
|
|
columns: [{ name: 'status' }],
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(result.columnDescriptions).toEqual([['status', 'Generated through sampler']]);
|
|
|
|
|
expect(sampler.sampleColumn).toHaveBeenCalledWith(
|
|
|
|
|
{
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
table: { catalog: null, db: 'public', name: 'orders' },
|
|
|
|
|
column: 'status',
|
|
|
|
|
limit: 50,
|
|
|
|
|
},
|
|
|
|
|
{ runId: 'run-1' },
|
|
|
|
|
);
|
|
|
|
|
expect('introspect' in sampler).toBe(false);
|
|
|
|
|
});
|
|
|
|
|
|
2026-05-12 14:34:15 +02:00
|
|
|
it('does not turn LLM failures into generated descriptions', async () => {
|
|
|
|
|
const cache = createCache();
|
|
|
|
|
const connector = createConnector();
|
|
|
|
|
const generator = new KtxDescriptionGenerator({
|
2026-05-16 12:06:34 +02:00
|
|
|
llmRuntime: createFailingLlmProvider(),
|
2026-05-12 14:34:15 +02:00
|
|
|
cache,
|
|
|
|
|
settings: {
|
|
|
|
|
columnMaxWords: 12,
|
|
|
|
|
tableMaxWords: 18,
|
|
|
|
|
dataSourceMaxWords: 24,
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const columnResult = await generator.generateColumnDescriptions({
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
connector,
|
|
|
|
|
context: { runId: 'run-1' },
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
supportsNestedAnalysis: false,
|
|
|
|
|
table: {
|
|
|
|
|
catalog: null,
|
|
|
|
|
db: 'public',
|
|
|
|
|
name: 'orders',
|
|
|
|
|
columns: [{ name: 'status' }],
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
await expect(
|
|
|
|
|
generator.generateTableDescription({
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
connector,
|
|
|
|
|
context: { runId: 'run-1' },
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
table: { catalog: null, db: 'public', name: 'orders' },
|
|
|
|
|
}),
|
|
|
|
|
).resolves.toBeNull();
|
|
|
|
|
|
|
|
|
|
expect(columnResult).toEqual({
|
|
|
|
|
columnDescriptions: [['status', null]],
|
|
|
|
|
processedColumns: [],
|
|
|
|
|
skippedColumns: [],
|
|
|
|
|
});
|
|
|
|
|
expect(cache.set).not.toHaveBeenCalled();
|
|
|
|
|
});
|
|
|
|
|
|
2026-05-10 23:12:26 +02:00
|
|
|
it('generates and caches table and data-source descriptions', async () => {
|
|
|
|
|
const cache = createCache();
|
|
|
|
|
const connector = createConnector();
|
2026-05-10 23:51:24 +02:00
|
|
|
const generator = new KtxDescriptionGenerator({
|
2026-05-16 12:06:34 +02:00
|
|
|
llmRuntime: createLlmProvider('Commerce orders'),
|
2026-05-10 23:12:26 +02:00
|
|
|
cache,
|
|
|
|
|
settings: {
|
|
|
|
|
columnMaxWords: 12,
|
|
|
|
|
tableMaxWords: 18,
|
|
|
|
|
dataSourceMaxWords: 24,
|
|
|
|
|
concurrencyLimit: 2,
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
await expect(
|
|
|
|
|
generator.generateTableDescription({
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
connector,
|
|
|
|
|
context: { runId: 'run-1' },
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
table: { catalog: 'warehouse', db: 'public', name: 'orders', rawDescriptions: { db: 'Raw orders' } },
|
|
|
|
|
}),
|
|
|
|
|
).resolves.toBe('Commerce orders');
|
|
|
|
|
|
|
|
|
|
await expect(
|
|
|
|
|
generator.generateDataSourceDescription({
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
connector,
|
|
|
|
|
context: { runId: 'run-1' },
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
tables: [
|
|
|
|
|
{ catalog: 'warehouse', db: 'public', name: 'orders' },
|
|
|
|
|
{ catalog: 'warehouse', db: 'public', name: 'customers' },
|
|
|
|
|
],
|
|
|
|
|
connectionName: 'Warehouse',
|
|
|
|
|
}),
|
|
|
|
|
).resolves.toBe('Commerce orders');
|
|
|
|
|
|
|
|
|
|
expect(cache.set).toHaveBeenCalledWith('warehouse.public.orders', 'Commerce orders');
|
|
|
|
|
expect(cache.set).toHaveBeenCalledWith('__connection:Warehouse', 'Commerce orders');
|
|
|
|
|
});
|
fix(snowflake): unblock multi-schema ingest and relationship discovery (#204)
* feat(setup): drop redundant Snowflake schema prompt; fall back to free-text on listSchemas failure
Snowflake setup previously asked for a single schema as free text, then
ran a multiselect against the discovered schemas — two schema questions
back-to-back, with the first being only a session bootstrap. The SDK's
`schema` is optional, so the bootstrap step is unnecessary.
- Remove the free-text Snowflake schema prompt; only pass `schema` to
snowflake-sdk when one is configured.
- When `listSchemas()` fails (e.g. role lacks SHOW SCHEMAS), prompt the
user for a comma-separated list, persist it as `schema_names`, and use
it as both the table-list filter and the multiselect default. Applies
to every driver with a scope-discovery spec, not just Snowflake.
- Update docs to lead with `schema_names`; keep `schema_name` as a
documented single-schema shorthand.
* fix(snowflake): keep introspecting when primary-key discovery is denied
The PK query joins INFORMATION_SCHEMA.TABLE_CONSTRAINTS and
INFORMATION_SCHEMA.KEY_COLUMN_USAGE, which require grants the
connection role may not have. Previously a 'SQL compilation error:
Object ANALYTICS.INFORMATION_SCHEMA.KEY_COLUMN_USAGE does not exist
or not authorized' aborted the entire introspect — schemas, columns,
and row counts were all discarded over a missing nice-to-have.
Wrap the constraint query in try/catch, log a one-line warning per
schema, and return an empty PK map. Columns end up with
primaryKey=false; relationship inference still has FK and profiling
to fall back on.
* fix(scan): unblock relationship discovery on Snowflake
Two adjacent bugs prevented the scan's relationship pipeline from producing
any joins on a Snowflake warehouse:
- relationship-profiling.ts fell through to a default `GROUP_CONCAT` branch
for unknown drivers. Snowflake has no GROUP_CONCAT, so every per-table
profile query failed with "Unknown function GROUP_CONCAT". Add an explicit
Snowflake branch that uses LISTAGG with a literal '\x1f' delimiter
(Snowflake requires the delimiter to be a constant, so CHR(31) is rejected).
- description-generation.ts destructured `connector.sampleTable` and
`connector.sampleColumn` into bare locals, losing the `this` binding when
the class-method connectors (Snowflake, Postgres, MySQL) were invoked.
Every sample call threw "Cannot read properties of undefined (reading
'assertConnection')" and degraded LLM descriptions to metadata-only
prompts. Call the methods through the connector instead.
Without these, even after the primary-key probe is allowed to fail softly,
the scan ends up with 0 validated relationships and an empty `joins:` block
in every shard YAML.
* test(scan): cover table-ref helpers
* feat(scan): plumb tableScope through live-database introspection port
* feat(scan): apply tableScope during metadata fetch
* feat(scan): enforce table scope at fetch boundary
* feat(scan): pool Snowflake sessions and batch enrichment for faster ingest (#206)
* feat(cli): add RSA key-pair auth option to Snowflake setup wizard
Extends the interactive Snowflake setup flow with an authentication-method
prompt (password vs RSA/JWT key-pair). The RSA branch collects a private-key
path (env/file/absolute) and an optional passphrase; the resulting connection
config records `authMethod: 'rsa'` with `privateKey` and `passphrase` instead
of `password`.
* feat(scan): pool Snowflake sessions
* fix(scan): reuse structural snapshots and cleanup connectors
* feat(scan): parallelize relationship profiling
* feat(scan): batch table description generation
* docs: document Snowflake ingest concurrency knobs
* fix(scan): close Snowflake ingest perf verification gaps
* fix(scan): keep batched description failure bounded
* feat(scan): dispatch query-history probes by connection driver
Extract historic-sql dialect resolution into a shared helper so the
status-project readiness check and the local ingest factory agree on
which connections enable query history and which probe to run. The
status command now picks the postgres/snowflake/bigquery probe based on
the connection's driver instead of always reporting against postgres,
which previously caused snowflake connections with queryHistory.enabled
to surface a misleading "driver is snowflake" failure.
Also drops a noisy console.warn from Snowflake primary-key discovery —
INFORMATION_SCHEMA.KEY_COLUMN_USAGE is commonly ungranted for read-only
roles and the FK + profiling paths handle the empty PK map already.
* fix(llm): allow StructuredOutput tool and raise maxTurns for generateObject
The Claude Code agent SDK announces an internal pseudo-tool named
StructuredOutput in the system/init message whenever outputFormat is set
to { type: 'json_schema' }. The runtime's isolation check built its
allowedToolIds set only from MCP tool ids and treated StructuredOutput
as an unexpected host-injected tool, so every generateObject call threw
"Claude Code runtime isolation failed: tools=StructuredOutput ..." and
the table-descriptions and relationship-LLM-proposal enrichment stages
recorded null output across the board.
Whitelist StructuredOutput specifically in generateObject's
allowedToolIds — the check also enforces missing_tools symmetry, so
generateText and runAgentLoop, which do not see StructuredOutput, must
not require it.
generateObject also ran with maxTurns: 1, which the model intermittently
breached when it emitted thinking text before the structured response.
Raised to 5 to give the schema-bound call enough headroom without
allowing unbounded loops. The existing tests now exercise the path with
an init message that announces StructuredOutput so the regression cannot
slip back in.
* chore(scripts): add ktx-reset.sh project-cleanup helper
Convenience script for repeatable ingest testing: takes a project
directory and prunes everything except ktx.yaml and .ktx/secrets/, so
the next ktx setup or ktx ingest run starts from a known-clean state.
2026-05-23 10:41:30 +02:00
|
|
|
|
|
|
|
|
it('generates one structured table description and reuses table samples for all columns', async () => {
|
|
|
|
|
const llmRuntime = createLlmProvider('unused');
|
|
|
|
|
llmRuntime.generateObject = vi.fn(async () => ({
|
|
|
|
|
tableDescription: 'Commerce orders',
|
|
|
|
|
columns: [
|
|
|
|
|
{ name: 'status', description: 'Current order state' },
|
|
|
|
|
{ name: 'amount', description: 'Order amount in dollars' },
|
|
|
|
|
],
|
|
|
|
|
}));
|
|
|
|
|
const connector = createConnector();
|
|
|
|
|
const generator = new KtxDescriptionGenerator({
|
|
|
|
|
llmRuntime,
|
|
|
|
|
settings: { columnMaxWords: 12, tableMaxWords: 18, dataSourceMaxWords: 24 },
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const result = await generator.generateBatchedTableDescriptions({
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
connector,
|
|
|
|
|
context: { runId: 'run-1' },
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
supportsNestedAnalysis: false,
|
|
|
|
|
table: {
|
|
|
|
|
catalog: null,
|
|
|
|
|
db: 'public',
|
|
|
|
|
name: 'orders',
|
|
|
|
|
rawDescriptions: { db: 'Orders fact table' },
|
|
|
|
|
columns: [
|
|
|
|
|
{ name: 'status', type: 'text' },
|
|
|
|
|
{ name: 'amount', type: 'numeric' },
|
|
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(result.tableDescription).toBe('Commerce orders');
|
|
|
|
|
expect(Object.fromEntries(result.columnDescriptions)).toEqual({
|
|
|
|
|
status: 'Current order state',
|
|
|
|
|
amount: 'Order amount in dollars',
|
|
|
|
|
});
|
|
|
|
|
expect(connector.sampleTable).toHaveBeenCalledTimes(1);
|
|
|
|
|
expect(connector.sampleColumn).not.toHaveBeenCalled();
|
|
|
|
|
expect(llmRuntime.generateObject).toHaveBeenCalledTimes(1);
|
|
|
|
|
expect(llmRuntime.generateText).not.toHaveBeenCalled();
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('falls back to one column generateText call for each missing structured column', async () => {
|
|
|
|
|
const llmRuntime = createLlmProvider('Fallback status');
|
|
|
|
|
llmRuntime.generateObject = vi.fn(async () => ({
|
|
|
|
|
tableDescription: 'Commerce orders',
|
|
|
|
|
columns: [{ name: 'amount', description: 'Order amount in dollars' }],
|
|
|
|
|
}));
|
|
|
|
|
const connector = createConnector();
|
|
|
|
|
const generator = new KtxDescriptionGenerator({
|
|
|
|
|
llmRuntime,
|
|
|
|
|
settings: { columnMaxWords: 12, tableMaxWords: 18, dataSourceMaxWords: 24 },
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const result = await generator.generateBatchedTableDescriptions({
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
connector,
|
|
|
|
|
context: { runId: 'run-1' },
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
supportsNestedAnalysis: false,
|
|
|
|
|
table: {
|
|
|
|
|
catalog: null,
|
|
|
|
|
db: 'public',
|
|
|
|
|
name: 'orders',
|
|
|
|
|
columns: [
|
|
|
|
|
{ name: 'status', type: 'text' },
|
|
|
|
|
{ name: 'amount', type: 'numeric' },
|
|
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(Object.fromEntries(result.columnDescriptions)).toEqual({
|
|
|
|
|
status: 'Fallback status',
|
|
|
|
|
amount: 'Order amount in dollars',
|
|
|
|
|
});
|
|
|
|
|
expect(connector.sampleColumn).not.toHaveBeenCalled();
|
|
|
|
|
expect(llmRuntime.generateObject).toHaveBeenCalledTimes(1);
|
|
|
|
|
expect(llmRuntime.generateText).toHaveBeenCalledTimes(1);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('does not run per-column fallback when structured object generation throws', async () => {
|
|
|
|
|
const llmRuntime = createLlmProvider('Fallback description');
|
|
|
|
|
llmRuntime.generateObject = vi.fn(async () => {
|
|
|
|
|
throw new Error('object output unavailable');
|
|
|
|
|
});
|
|
|
|
|
const warnings: string[] = [];
|
|
|
|
|
const generator = new KtxDescriptionGenerator({
|
|
|
|
|
llmRuntime,
|
|
|
|
|
onWarning: (warning) => warnings.push(warning.code),
|
|
|
|
|
settings: { columnMaxWords: 12, tableMaxWords: 18, dataSourceMaxWords: 24 },
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const result = await generator.generateBatchedTableDescriptions({
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
connector: createConnector(),
|
|
|
|
|
context: { runId: 'run-1' },
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
supportsNestedAnalysis: false,
|
|
|
|
|
table: {
|
|
|
|
|
catalog: null,
|
|
|
|
|
db: 'public',
|
|
|
|
|
name: 'orders',
|
|
|
|
|
columns: [{ name: 'status', type: 'text' }],
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(result.tableDescription).toBeNull();
|
|
|
|
|
expect(Object.fromEntries(result.columnDescriptions)).toEqual({ status: null });
|
|
|
|
|
expect(warnings).toContain('enrichment_failed');
|
|
|
|
|
expect(llmRuntime.generateObject).toHaveBeenCalledTimes(1);
|
|
|
|
|
expect(llmRuntime.generateText).not.toHaveBeenCalled();
|
|
|
|
|
});
|
2026-05-10 23:12:26 +02:00
|
|
|
});
|
fix(context): merge overlay columns onto manifest columns by name (#94)
* fix(context): merge overlay columns onto manifest columns by name
composeOverlay was appending overlay columns to the manifest column list,
producing duplicate entries when dbt/metabase overlays declared a column
just to attach descriptions. The duplicates carried no `type`, so the
pydantic SourceDefinition rejected them at semantic-query time and broke
`ktx sl query` for every overlay-backed measure. Now overlay columns
match base columns by name (case-insensitive): same-name entries merge
onto the manifest (overlay fields win, type/role fall back to the base,
descriptions merge per source key) and only new names append.
* refactor(sl): split overlay columns from column_overrides and enforce TS/Python wire contract
Overlay sources now have two distinct collections: `columns:` for computed
columns (requiring `expr` + `type`) and `column_overrides:` for metadata
patches to inherited manifest columns. Composing or loading an overlay that
mixes the two — or references an unknown column — fails with a typed error.
Introduce `ResolvedSemanticLayerSource` / `resolvedSourceSchema` /
`toResolvedWire` as the strict shape sent to the Python engine, and add a
schema contract test that diffs Zod against the Pydantic JSON schema dumped
by `python -m semantic_layer dump-schema`. `SourceDefinition` is now
`extra="forbid"` on the Python side.
`loadAllSources` surfaces per-file load errors instead of swallowing them,
so validation/query paths can report manifest shard parse failures.
* fix(context): make scan description generation resilient and quiet
A transient sampleTable failure during ingest used to take out every
table in a connection: generateTableDescription returned a hardcoded
'Table not found' string into descriptions.ai, and KtxDescriptionGenerator
was constructed without a logger, so the failure left no trail anywhere.
- sampleTable / sampleColumn calls retry 3x with 200/400/800ms backoff,
honouring KtxScanContext.signal via a new KtxAbortedError.
- On retry exhaustion or missing capability, table generation falls back
to a metadata-only prompt built from column name / native type / comment
/ rawDescriptions. The column path follows the same rule -- call the
LLM when any of samples or rawDescriptions are available; skip only
when both are absent.
- Logger is now threaded from KtxScanContext into the generator. Failures
emit structured KtxScanWarning entries (new description_fallback_used
code, plus existing sampling_failed / enrichment_failed /
connector_capability_missing). ktx scan groups warnings by code so a
batch of identical failures collapses to one summary line plus sample.
- Returns null on failure instead of the 'Table not found' sentinel; the
manifest writer's existing guard already skips empty descriptions, so
schema YAML no longer carries misleading text. SCAN_MANAGED_DESCRIPTION_KEYS
already strips stale 'ai' on merge, so existing YAML clears on next run.
Also suppress AI SDK v6 'system in messages' warning: pull system messages
out of KtxMessageBuilder.wrapSimple's output via a new splitKtxSystemMessages
helper and pass them top-level to generateText (preserves cacheControl
providerOptions on the SystemModelMessage). Agent-runner's local
splitSystemPromptMessages dedupes onto the shared helper.
* test(docs): align examples-docs assertions with revamped docs
PR #103 (setup/guide doc revamp) reworded several CLI examples and
connection labels; the assertions in scripts/examples-docs.test.mjs
still referenced the pre-revamp wording and were failing in CI on main.
Update the regexes to match the post-revamp content:
- drop the `--json` flag from the sl-query example expectation
- move the `Driver:` / `Status: ok` probe to the connection reference,
which is where that output now lives (driver id is lowercase
`postgres`, not the display name `PostgreSQL`)
- drop the obsolete `Install \`uv\`...` troubleshooting line
- accept `<connectionId>` everywhere; the docs no longer use the
hyphenated `<connection-id>` form
- match the `warehouse` connection id used in the quickstart instead of
the `postgres-warehouse` id only used in the README and setup ref
* fix(sl): skip TS/Python schema contract test when uv is unavailable
The TypeScript checks CI job does not install uv or Python, so the
module-level `execFileSync('uv', ...)` in schemas.contract.test.ts threw
ENOENT and failed the suite. Wrap the schema dump in a try/catch and
guard the describe block with `describe.skipIf` so the test skips in
environments without uv. Local dev and any CI job that has uv on PATH
still runs the cross-language contract assertion.
2026-05-15 02:11:04 +02:00
|
|
|
|
|
|
|
|
describe('KtxDescriptionGenerator resilience', () => {
|
|
|
|
|
function createLogger() {
|
|
|
|
|
return {
|
|
|
|
|
debug: vi.fn(),
|
|
|
|
|
info: vi.fn(),
|
|
|
|
|
warn: vi.fn(),
|
|
|
|
|
error: vi.fn(),
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
it('retries sampleTable on transient failure and uses sampled rows when it eventually succeeds', async () => {
|
|
|
|
|
const sampleTable = vi
|
|
|
|
|
.fn<NonNullable<KtxScanConnector['sampleTable']>>()
|
|
|
|
|
.mockRejectedValueOnce(new Error('pool: transient ECONNRESET'))
|
|
|
|
|
.mockRejectedValueOnce(new Error('pool: transient ECONNRESET'))
|
|
|
|
|
.mockResolvedValue({
|
|
|
|
|
headers: ['id', 'status'],
|
|
|
|
|
rows: [
|
|
|
|
|
[1, 'paid'],
|
|
|
|
|
[2, 'refunded'],
|
|
|
|
|
],
|
|
|
|
|
totalRows: 2,
|
|
|
|
|
});
|
|
|
|
|
const connector: KtxScanConnector = {
|
|
|
|
|
...createConnector(),
|
|
|
|
|
sampleTable,
|
|
|
|
|
};
|
|
|
|
|
const logger = createLogger();
|
|
|
|
|
const warnings: Array<{ code: string; table?: string }> = [];
|
|
|
|
|
const generator = new KtxDescriptionGenerator({
|
2026-05-16 12:06:34 +02:00
|
|
|
llmRuntime: createLlmProvider('Commerce orders'),
|
fix(context): merge overlay columns onto manifest columns by name (#94)
* fix(context): merge overlay columns onto manifest columns by name
composeOverlay was appending overlay columns to the manifest column list,
producing duplicate entries when dbt/metabase overlays declared a column
just to attach descriptions. The duplicates carried no `type`, so the
pydantic SourceDefinition rejected them at semantic-query time and broke
`ktx sl query` for every overlay-backed measure. Now overlay columns
match base columns by name (case-insensitive): same-name entries merge
onto the manifest (overlay fields win, type/role fall back to the base,
descriptions merge per source key) and only new names append.
* refactor(sl): split overlay columns from column_overrides and enforce TS/Python wire contract
Overlay sources now have two distinct collections: `columns:` for computed
columns (requiring `expr` + `type`) and `column_overrides:` for metadata
patches to inherited manifest columns. Composing or loading an overlay that
mixes the two — or references an unknown column — fails with a typed error.
Introduce `ResolvedSemanticLayerSource` / `resolvedSourceSchema` /
`toResolvedWire` as the strict shape sent to the Python engine, and add a
schema contract test that diffs Zod against the Pydantic JSON schema dumped
by `python -m semantic_layer dump-schema`. `SourceDefinition` is now
`extra="forbid"` on the Python side.
`loadAllSources` surfaces per-file load errors instead of swallowing them,
so validation/query paths can report manifest shard parse failures.
* fix(context): make scan description generation resilient and quiet
A transient sampleTable failure during ingest used to take out every
table in a connection: generateTableDescription returned a hardcoded
'Table not found' string into descriptions.ai, and KtxDescriptionGenerator
was constructed without a logger, so the failure left no trail anywhere.
- sampleTable / sampleColumn calls retry 3x with 200/400/800ms backoff,
honouring KtxScanContext.signal via a new KtxAbortedError.
- On retry exhaustion or missing capability, table generation falls back
to a metadata-only prompt built from column name / native type / comment
/ rawDescriptions. The column path follows the same rule -- call the
LLM when any of samples or rawDescriptions are available; skip only
when both are absent.
- Logger is now threaded from KtxScanContext into the generator. Failures
emit structured KtxScanWarning entries (new description_fallback_used
code, plus existing sampling_failed / enrichment_failed /
connector_capability_missing). ktx scan groups warnings by code so a
batch of identical failures collapses to one summary line plus sample.
- Returns null on failure instead of the 'Table not found' sentinel; the
manifest writer's existing guard already skips empty descriptions, so
schema YAML no longer carries misleading text. SCAN_MANAGED_DESCRIPTION_KEYS
already strips stale 'ai' on merge, so existing YAML clears on next run.
Also suppress AI SDK v6 'system in messages' warning: pull system messages
out of KtxMessageBuilder.wrapSimple's output via a new splitKtxSystemMessages
helper and pass them top-level to generateText (preserves cacheControl
providerOptions on the SystemModelMessage). Agent-runner's local
splitSystemPromptMessages dedupes onto the shared helper.
* test(docs): align examples-docs assertions with revamped docs
PR #103 (setup/guide doc revamp) reworded several CLI examples and
connection labels; the assertions in scripts/examples-docs.test.mjs
still referenced the pre-revamp wording and were failing in CI on main.
Update the regexes to match the post-revamp content:
- drop the `--json` flag from the sl-query example expectation
- move the `Driver:` / `Status: ok` probe to the connection reference,
which is where that output now lives (driver id is lowercase
`postgres`, not the display name `PostgreSQL`)
- drop the obsolete `Install \`uv\`...` troubleshooting line
- accept `<connectionId>` everywhere; the docs no longer use the
hyphenated `<connection-id>` form
- match the `warehouse` connection id used in the quickstart instead of
the `postgres-warehouse` id only used in the README and setup ref
* fix(sl): skip TS/Python schema contract test when uv is unavailable
The TypeScript checks CI job does not install uv or Python, so the
module-level `execFileSync('uv', ...)` in schemas.contract.test.ts threw
ENOENT and failed the suite. Wrap the schema dump in a try/catch and
guard the describe block with `describe.skipIf` so the test skips in
environments without uv. Local dev and any CI job that has uv on PATH
still runs the cross-language contract assertion.
2026-05-15 02:11:04 +02:00
|
|
|
logger,
|
|
|
|
|
onWarning: (warning) => warnings.push({ code: warning.code, ...(warning.table ? { table: warning.table } : {}) }),
|
|
|
|
|
settings: { columnMaxWords: 12, tableMaxWords: 18, dataSourceMaxWords: 24, concurrencyLimit: 2 },
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const description = await generator.generateTableDescription({
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
connector,
|
|
|
|
|
context: { runId: 'run-1' },
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
table: { catalog: null, db: 'public', name: 'orders' },
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(description).toBe('Commerce orders');
|
|
|
|
|
expect(sampleTable).toHaveBeenCalledTimes(3);
|
|
|
|
|
expect(logger.warn).toHaveBeenCalledTimes(2);
|
|
|
|
|
expect(warnings).toEqual([]);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('falls back to metadata-only prompt when sampleTable retries exhaust', async () => {
|
|
|
|
|
const sampleTable = vi
|
|
|
|
|
.fn<NonNullable<KtxScanConnector['sampleTable']>>()
|
|
|
|
|
.mockRejectedValue(new Error('pool: connection refused'));
|
|
|
|
|
const connector: KtxScanConnector = {
|
|
|
|
|
...createConnector(),
|
|
|
|
|
sampleTable,
|
|
|
|
|
};
|
|
|
|
|
const logger = createLogger();
|
|
|
|
|
const warnings: Array<{ code: string; table?: string; metadata?: Record<string, unknown> }> = [];
|
|
|
|
|
const generator = new KtxDescriptionGenerator({
|
2026-05-16 12:06:34 +02:00
|
|
|
llmRuntime: createLlmProvider('Customer reference data'),
|
fix(context): merge overlay columns onto manifest columns by name (#94)
* fix(context): merge overlay columns onto manifest columns by name
composeOverlay was appending overlay columns to the manifest column list,
producing duplicate entries when dbt/metabase overlays declared a column
just to attach descriptions. The duplicates carried no `type`, so the
pydantic SourceDefinition rejected them at semantic-query time and broke
`ktx sl query` for every overlay-backed measure. Now overlay columns
match base columns by name (case-insensitive): same-name entries merge
onto the manifest (overlay fields win, type/role fall back to the base,
descriptions merge per source key) and only new names append.
* refactor(sl): split overlay columns from column_overrides and enforce TS/Python wire contract
Overlay sources now have two distinct collections: `columns:` for computed
columns (requiring `expr` + `type`) and `column_overrides:` for metadata
patches to inherited manifest columns. Composing or loading an overlay that
mixes the two — or references an unknown column — fails with a typed error.
Introduce `ResolvedSemanticLayerSource` / `resolvedSourceSchema` /
`toResolvedWire` as the strict shape sent to the Python engine, and add a
schema contract test that diffs Zod against the Pydantic JSON schema dumped
by `python -m semantic_layer dump-schema`. `SourceDefinition` is now
`extra="forbid"` on the Python side.
`loadAllSources` surfaces per-file load errors instead of swallowing them,
so validation/query paths can report manifest shard parse failures.
* fix(context): make scan description generation resilient and quiet
A transient sampleTable failure during ingest used to take out every
table in a connection: generateTableDescription returned a hardcoded
'Table not found' string into descriptions.ai, and KtxDescriptionGenerator
was constructed without a logger, so the failure left no trail anywhere.
- sampleTable / sampleColumn calls retry 3x with 200/400/800ms backoff,
honouring KtxScanContext.signal via a new KtxAbortedError.
- On retry exhaustion or missing capability, table generation falls back
to a metadata-only prompt built from column name / native type / comment
/ rawDescriptions. The column path follows the same rule -- call the
LLM when any of samples or rawDescriptions are available; skip only
when both are absent.
- Logger is now threaded from KtxScanContext into the generator. Failures
emit structured KtxScanWarning entries (new description_fallback_used
code, plus existing sampling_failed / enrichment_failed /
connector_capability_missing). ktx scan groups warnings by code so a
batch of identical failures collapses to one summary line plus sample.
- Returns null on failure instead of the 'Table not found' sentinel; the
manifest writer's existing guard already skips empty descriptions, so
schema YAML no longer carries misleading text. SCAN_MANAGED_DESCRIPTION_KEYS
already strips stale 'ai' on merge, so existing YAML clears on next run.
Also suppress AI SDK v6 'system in messages' warning: pull system messages
out of KtxMessageBuilder.wrapSimple's output via a new splitKtxSystemMessages
helper and pass them top-level to generateText (preserves cacheControl
providerOptions on the SystemModelMessage). Agent-runner's local
splitSystemPromptMessages dedupes onto the shared helper.
* test(docs): align examples-docs assertions with revamped docs
PR #103 (setup/guide doc revamp) reworded several CLI examples and
connection labels; the assertions in scripts/examples-docs.test.mjs
still referenced the pre-revamp wording and were failing in CI on main.
Update the regexes to match the post-revamp content:
- drop the `--json` flag from the sl-query example expectation
- move the `Driver:` / `Status: ok` probe to the connection reference,
which is where that output now lives (driver id is lowercase
`postgres`, not the display name `PostgreSQL`)
- drop the obsolete `Install \`uv\`...` troubleshooting line
- accept `<connectionId>` everywhere; the docs no longer use the
hyphenated `<connection-id>` form
- match the `warehouse` connection id used in the quickstart instead of
the `postgres-warehouse` id only used in the README and setup ref
* fix(sl): skip TS/Python schema contract test when uv is unavailable
The TypeScript checks CI job does not install uv or Python, so the
module-level `execFileSync('uv', ...)` in schemas.contract.test.ts threw
ENOENT and failed the suite. Wrap the schema dump in a try/catch and
guard the describe block with `describe.skipIf` so the test skips in
environments without uv. Local dev and any CI job that has uv on PATH
still runs the cross-language contract assertion.
2026-05-15 02:11:04 +02:00
|
|
|
logger,
|
|
|
|
|
onWarning: (warning) =>
|
|
|
|
|
warnings.push({
|
|
|
|
|
code: warning.code,
|
|
|
|
|
...(warning.table ? { table: warning.table } : {}),
|
|
|
|
|
...(warning.metadata ? { metadata: warning.metadata } : {}),
|
|
|
|
|
}),
|
|
|
|
|
settings: { columnMaxWords: 12, tableMaxWords: 18, dataSourceMaxWords: 24, concurrencyLimit: 2 },
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const description = await generator.generateTableDescription({
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
connector,
|
|
|
|
|
context: { runId: 'run-1' },
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
table: {
|
|
|
|
|
catalog: null,
|
|
|
|
|
db: 'public',
|
|
|
|
|
name: 'customers',
|
|
|
|
|
columns: [
|
|
|
|
|
{ name: 'id', nativeType: 'uuid' },
|
|
|
|
|
{ name: 'email', nativeType: 'text', comment: 'Primary contact email' },
|
|
|
|
|
],
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(description).toBe('Customer reference data');
|
|
|
|
|
expect(sampleTable).toHaveBeenCalledTimes(3);
|
|
|
|
|
expect(warnings.map((warning) => warning.code)).toEqual(['sampling_failed', 'description_fallback_used']);
|
|
|
|
|
expect(warnings[1]?.metadata?.reason).toBe('sampling_failed');
|
|
|
|
|
const userPrompt = (vi.mocked(generateText).mock.calls.at(-1)?.[0] as { messages: Array<{ role: string; content: string }> })
|
|
|
|
|
.messages.find((message) => message.role === 'user')?.content;
|
|
|
|
|
expect(userPrompt).toContain('Columns (metadata only, no sample rows)');
|
|
|
|
|
expect(userPrompt).toContain('email (text)');
|
|
|
|
|
expect(userPrompt).toContain('Primary contact email');
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('emits enrichment_failed and returns null when both sampling and metadata-only LLM fail', async () => {
|
|
|
|
|
const sampleTable = vi
|
|
|
|
|
.fn<NonNullable<KtxScanConnector['sampleTable']>>()
|
|
|
|
|
.mockRejectedValue(new Error('pool: connection refused'));
|
|
|
|
|
const connector: KtxScanConnector = {
|
|
|
|
|
...createConnector(),
|
|
|
|
|
sampleTable,
|
|
|
|
|
};
|
|
|
|
|
const warnings: string[] = [];
|
|
|
|
|
const generator = new KtxDescriptionGenerator({
|
2026-05-16 12:06:34 +02:00
|
|
|
llmRuntime: createFailingLlmProvider(),
|
fix(context): merge overlay columns onto manifest columns by name (#94)
* fix(context): merge overlay columns onto manifest columns by name
composeOverlay was appending overlay columns to the manifest column list,
producing duplicate entries when dbt/metabase overlays declared a column
just to attach descriptions. The duplicates carried no `type`, so the
pydantic SourceDefinition rejected them at semantic-query time and broke
`ktx sl query` for every overlay-backed measure. Now overlay columns
match base columns by name (case-insensitive): same-name entries merge
onto the manifest (overlay fields win, type/role fall back to the base,
descriptions merge per source key) and only new names append.
* refactor(sl): split overlay columns from column_overrides and enforce TS/Python wire contract
Overlay sources now have two distinct collections: `columns:` for computed
columns (requiring `expr` + `type`) and `column_overrides:` for metadata
patches to inherited manifest columns. Composing or loading an overlay that
mixes the two — or references an unknown column — fails with a typed error.
Introduce `ResolvedSemanticLayerSource` / `resolvedSourceSchema` /
`toResolvedWire` as the strict shape sent to the Python engine, and add a
schema contract test that diffs Zod against the Pydantic JSON schema dumped
by `python -m semantic_layer dump-schema`. `SourceDefinition` is now
`extra="forbid"` on the Python side.
`loadAllSources` surfaces per-file load errors instead of swallowing them,
so validation/query paths can report manifest shard parse failures.
* fix(context): make scan description generation resilient and quiet
A transient sampleTable failure during ingest used to take out every
table in a connection: generateTableDescription returned a hardcoded
'Table not found' string into descriptions.ai, and KtxDescriptionGenerator
was constructed without a logger, so the failure left no trail anywhere.
- sampleTable / sampleColumn calls retry 3x with 200/400/800ms backoff,
honouring KtxScanContext.signal via a new KtxAbortedError.
- On retry exhaustion or missing capability, table generation falls back
to a metadata-only prompt built from column name / native type / comment
/ rawDescriptions. The column path follows the same rule -- call the
LLM when any of samples or rawDescriptions are available; skip only
when both are absent.
- Logger is now threaded from KtxScanContext into the generator. Failures
emit structured KtxScanWarning entries (new description_fallback_used
code, plus existing sampling_failed / enrichment_failed /
connector_capability_missing). ktx scan groups warnings by code so a
batch of identical failures collapses to one summary line plus sample.
- Returns null on failure instead of the 'Table not found' sentinel; the
manifest writer's existing guard already skips empty descriptions, so
schema YAML no longer carries misleading text. SCAN_MANAGED_DESCRIPTION_KEYS
already strips stale 'ai' on merge, so existing YAML clears on next run.
Also suppress AI SDK v6 'system in messages' warning: pull system messages
out of KtxMessageBuilder.wrapSimple's output via a new splitKtxSystemMessages
helper and pass them top-level to generateText (preserves cacheControl
providerOptions on the SystemModelMessage). Agent-runner's local
splitSystemPromptMessages dedupes onto the shared helper.
* test(docs): align examples-docs assertions with revamped docs
PR #103 (setup/guide doc revamp) reworded several CLI examples and
connection labels; the assertions in scripts/examples-docs.test.mjs
still referenced the pre-revamp wording and were failing in CI on main.
Update the regexes to match the post-revamp content:
- drop the `--json` flag from the sl-query example expectation
- move the `Driver:` / `Status: ok` probe to the connection reference,
which is where that output now lives (driver id is lowercase
`postgres`, not the display name `PostgreSQL`)
- drop the obsolete `Install \`uv\`...` troubleshooting line
- accept `<connectionId>` everywhere; the docs no longer use the
hyphenated `<connection-id>` form
- match the `warehouse` connection id used in the quickstart instead of
the `postgres-warehouse` id only used in the README and setup ref
* fix(sl): skip TS/Python schema contract test when uv is unavailable
The TypeScript checks CI job does not install uv or Python, so the
module-level `execFileSync('uv', ...)` in schemas.contract.test.ts threw
ENOENT and failed the suite. Wrap the schema dump in a try/catch and
guard the describe block with `describe.skipIf` so the test skips in
environments without uv. Local dev and any CI job that has uv on PATH
still runs the cross-language contract assertion.
2026-05-15 02:11:04 +02:00
|
|
|
onWarning: (warning) => warnings.push(warning.code),
|
|
|
|
|
settings: { columnMaxWords: 12, tableMaxWords: 18, dataSourceMaxWords: 24 },
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const description = await generator.generateTableDescription({
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
connector,
|
|
|
|
|
context: { runId: 'run-1' },
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
table: { catalog: null, db: 'public', name: 'orphan', columns: [{ name: 'id' }] },
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(description).toBeNull();
|
|
|
|
|
expect(warnings).toEqual(['sampling_failed', 'enrichment_failed']);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('uses metadata-only fallback when connector has no sampleTable', async () => {
|
|
|
|
|
const connector = createConnector();
|
|
|
|
|
const samplerWithoutTable: KtxScanConnector = {
|
|
|
|
|
...connector,
|
|
|
|
|
sampleTable: undefined,
|
|
|
|
|
};
|
|
|
|
|
const warnings: string[] = [];
|
|
|
|
|
const generator = new KtxDescriptionGenerator({
|
2026-05-16 12:06:34 +02:00
|
|
|
llmRuntime: createLlmProvider('Orders mart'),
|
fix(context): merge overlay columns onto manifest columns by name (#94)
* fix(context): merge overlay columns onto manifest columns by name
composeOverlay was appending overlay columns to the manifest column list,
producing duplicate entries when dbt/metabase overlays declared a column
just to attach descriptions. The duplicates carried no `type`, so the
pydantic SourceDefinition rejected them at semantic-query time and broke
`ktx sl query` for every overlay-backed measure. Now overlay columns
match base columns by name (case-insensitive): same-name entries merge
onto the manifest (overlay fields win, type/role fall back to the base,
descriptions merge per source key) and only new names append.
* refactor(sl): split overlay columns from column_overrides and enforce TS/Python wire contract
Overlay sources now have two distinct collections: `columns:` for computed
columns (requiring `expr` + `type`) and `column_overrides:` for metadata
patches to inherited manifest columns. Composing or loading an overlay that
mixes the two — or references an unknown column — fails with a typed error.
Introduce `ResolvedSemanticLayerSource` / `resolvedSourceSchema` /
`toResolvedWire` as the strict shape sent to the Python engine, and add a
schema contract test that diffs Zod against the Pydantic JSON schema dumped
by `python -m semantic_layer dump-schema`. `SourceDefinition` is now
`extra="forbid"` on the Python side.
`loadAllSources` surfaces per-file load errors instead of swallowing them,
so validation/query paths can report manifest shard parse failures.
* fix(context): make scan description generation resilient and quiet
A transient sampleTable failure during ingest used to take out every
table in a connection: generateTableDescription returned a hardcoded
'Table not found' string into descriptions.ai, and KtxDescriptionGenerator
was constructed without a logger, so the failure left no trail anywhere.
- sampleTable / sampleColumn calls retry 3x with 200/400/800ms backoff,
honouring KtxScanContext.signal via a new KtxAbortedError.
- On retry exhaustion or missing capability, table generation falls back
to a metadata-only prompt built from column name / native type / comment
/ rawDescriptions. The column path follows the same rule -- call the
LLM when any of samples or rawDescriptions are available; skip only
when both are absent.
- Logger is now threaded from KtxScanContext into the generator. Failures
emit structured KtxScanWarning entries (new description_fallback_used
code, plus existing sampling_failed / enrichment_failed /
connector_capability_missing). ktx scan groups warnings by code so a
batch of identical failures collapses to one summary line plus sample.
- Returns null on failure instead of the 'Table not found' sentinel; the
manifest writer's existing guard already skips empty descriptions, so
schema YAML no longer carries misleading text. SCAN_MANAGED_DESCRIPTION_KEYS
already strips stale 'ai' on merge, so existing YAML clears on next run.
Also suppress AI SDK v6 'system in messages' warning: pull system messages
out of KtxMessageBuilder.wrapSimple's output via a new splitKtxSystemMessages
helper and pass them top-level to generateText (preserves cacheControl
providerOptions on the SystemModelMessage). Agent-runner's local
splitSystemPromptMessages dedupes onto the shared helper.
* test(docs): align examples-docs assertions with revamped docs
PR #103 (setup/guide doc revamp) reworded several CLI examples and
connection labels; the assertions in scripts/examples-docs.test.mjs
still referenced the pre-revamp wording and were failing in CI on main.
Update the regexes to match the post-revamp content:
- drop the `--json` flag from the sl-query example expectation
- move the `Driver:` / `Status: ok` probe to the connection reference,
which is where that output now lives (driver id is lowercase
`postgres`, not the display name `PostgreSQL`)
- drop the obsolete `Install \`uv\`...` troubleshooting line
- accept `<connectionId>` everywhere; the docs no longer use the
hyphenated `<connection-id>` form
- match the `warehouse` connection id used in the quickstart instead of
the `postgres-warehouse` id only used in the README and setup ref
* fix(sl): skip TS/Python schema contract test when uv is unavailable
The TypeScript checks CI job does not install uv or Python, so the
module-level `execFileSync('uv', ...)` in schemas.contract.test.ts threw
ENOENT and failed the suite. Wrap the schema dump in a try/catch and
guard the describe block with `describe.skipIf` so the test skips in
environments without uv. Local dev and any CI job that has uv on PATH
still runs the cross-language contract assertion.
2026-05-15 02:11:04 +02:00
|
|
|
onWarning: (warning) => warnings.push(warning.code),
|
|
|
|
|
settings: { columnMaxWords: 12, tableMaxWords: 18, dataSourceMaxWords: 24 },
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const description = await generator.generateTableDescription({
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
connector: samplerWithoutTable,
|
|
|
|
|
context: { runId: 'run-1' },
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
table: {
|
|
|
|
|
catalog: null,
|
|
|
|
|
db: 'public',
|
|
|
|
|
name: 'mart_orders',
|
|
|
|
|
columns: [{ name: 'order_id', nativeType: 'uuid' }],
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(description).toBe('Orders mart');
|
|
|
|
|
expect(warnings).toEqual(['connector_capability_missing', 'description_fallback_used']);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('aborts retry loop when the scan context signal fires', async () => {
|
|
|
|
|
const controller = new AbortController();
|
|
|
|
|
const sampleTable = vi.fn<NonNullable<KtxScanConnector['sampleTable']>>().mockImplementation(async () => {
|
|
|
|
|
controller.abort();
|
|
|
|
|
throw new Error('first attempt blew up');
|
|
|
|
|
});
|
|
|
|
|
const connector: KtxScanConnector = {
|
|
|
|
|
...createConnector(),
|
|
|
|
|
sampleTable,
|
|
|
|
|
};
|
|
|
|
|
const warnings: string[] = [];
|
|
|
|
|
const generator = new KtxDescriptionGenerator({
|
2026-05-16 12:06:34 +02:00
|
|
|
llmRuntime: createLlmProvider('should not be called'),
|
fix(context): merge overlay columns onto manifest columns by name (#94)
* fix(context): merge overlay columns onto manifest columns by name
composeOverlay was appending overlay columns to the manifest column list,
producing duplicate entries when dbt/metabase overlays declared a column
just to attach descriptions. The duplicates carried no `type`, so the
pydantic SourceDefinition rejected them at semantic-query time and broke
`ktx sl query` for every overlay-backed measure. Now overlay columns
match base columns by name (case-insensitive): same-name entries merge
onto the manifest (overlay fields win, type/role fall back to the base,
descriptions merge per source key) and only new names append.
* refactor(sl): split overlay columns from column_overrides and enforce TS/Python wire contract
Overlay sources now have two distinct collections: `columns:` for computed
columns (requiring `expr` + `type`) and `column_overrides:` for metadata
patches to inherited manifest columns. Composing or loading an overlay that
mixes the two — or references an unknown column — fails with a typed error.
Introduce `ResolvedSemanticLayerSource` / `resolvedSourceSchema` /
`toResolvedWire` as the strict shape sent to the Python engine, and add a
schema contract test that diffs Zod against the Pydantic JSON schema dumped
by `python -m semantic_layer dump-schema`. `SourceDefinition` is now
`extra="forbid"` on the Python side.
`loadAllSources` surfaces per-file load errors instead of swallowing them,
so validation/query paths can report manifest shard parse failures.
* fix(context): make scan description generation resilient and quiet
A transient sampleTable failure during ingest used to take out every
table in a connection: generateTableDescription returned a hardcoded
'Table not found' string into descriptions.ai, and KtxDescriptionGenerator
was constructed without a logger, so the failure left no trail anywhere.
- sampleTable / sampleColumn calls retry 3x with 200/400/800ms backoff,
honouring KtxScanContext.signal via a new KtxAbortedError.
- On retry exhaustion or missing capability, table generation falls back
to a metadata-only prompt built from column name / native type / comment
/ rawDescriptions. The column path follows the same rule -- call the
LLM when any of samples or rawDescriptions are available; skip only
when both are absent.
- Logger is now threaded from KtxScanContext into the generator. Failures
emit structured KtxScanWarning entries (new description_fallback_used
code, plus existing sampling_failed / enrichment_failed /
connector_capability_missing). ktx scan groups warnings by code so a
batch of identical failures collapses to one summary line plus sample.
- Returns null on failure instead of the 'Table not found' sentinel; the
manifest writer's existing guard already skips empty descriptions, so
schema YAML no longer carries misleading text. SCAN_MANAGED_DESCRIPTION_KEYS
already strips stale 'ai' on merge, so existing YAML clears on next run.
Also suppress AI SDK v6 'system in messages' warning: pull system messages
out of KtxMessageBuilder.wrapSimple's output via a new splitKtxSystemMessages
helper and pass them top-level to generateText (preserves cacheControl
providerOptions on the SystemModelMessage). Agent-runner's local
splitSystemPromptMessages dedupes onto the shared helper.
* test(docs): align examples-docs assertions with revamped docs
PR #103 (setup/guide doc revamp) reworded several CLI examples and
connection labels; the assertions in scripts/examples-docs.test.mjs
still referenced the pre-revamp wording and were failing in CI on main.
Update the regexes to match the post-revamp content:
- drop the `--json` flag from the sl-query example expectation
- move the `Driver:` / `Status: ok` probe to the connection reference,
which is where that output now lives (driver id is lowercase
`postgres`, not the display name `PostgreSQL`)
- drop the obsolete `Install \`uv\`...` troubleshooting line
- accept `<connectionId>` everywhere; the docs no longer use the
hyphenated `<connection-id>` form
- match the `warehouse` connection id used in the quickstart instead of
the `postgres-warehouse` id only used in the README and setup ref
* fix(sl): skip TS/Python schema contract test when uv is unavailable
The TypeScript checks CI job does not install uv or Python, so the
module-level `execFileSync('uv', ...)` in schemas.contract.test.ts threw
ENOENT and failed the suite. Wrap the schema dump in a try/catch and
guard the describe block with `describe.skipIf` so the test skips in
environments without uv. Local dev and any CI job that has uv on PATH
still runs the cross-language contract assertion.
2026-05-15 02:11:04 +02:00
|
|
|
onWarning: (warning) => warnings.push(warning.code),
|
|
|
|
|
settings: { columnMaxWords: 12, tableMaxWords: 18, dataSourceMaxWords: 24 },
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
await expect(
|
|
|
|
|
generator.generateTableDescription({
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
connector,
|
|
|
|
|
context: { runId: 'run-1', signal: controller.signal },
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
table: { catalog: null, db: 'public', name: 'orders' },
|
|
|
|
|
}),
|
|
|
|
|
).rejects.toThrow('aborted');
|
|
|
|
|
|
|
|
|
|
expect(sampleTable).toHaveBeenCalledTimes(1);
|
|
|
|
|
expect(warnings).toEqual([]);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('generates column descriptions from rawDescriptions when sampleColumn is unavailable', async () => {
|
|
|
|
|
const samplerWithoutColumn: KtxScanConnector = {
|
|
|
|
|
...createConnector(),
|
|
|
|
|
sampleColumn: undefined,
|
|
|
|
|
};
|
|
|
|
|
const logger = createLogger();
|
|
|
|
|
const generator = new KtxDescriptionGenerator({
|
2026-05-16 12:06:34 +02:00
|
|
|
llmRuntime: createLlmProvider('Payment lifecycle state'),
|
fix(context): merge overlay columns onto manifest columns by name (#94)
* fix(context): merge overlay columns onto manifest columns by name
composeOverlay was appending overlay columns to the manifest column list,
producing duplicate entries when dbt/metabase overlays declared a column
just to attach descriptions. The duplicates carried no `type`, so the
pydantic SourceDefinition rejected them at semantic-query time and broke
`ktx sl query` for every overlay-backed measure. Now overlay columns
match base columns by name (case-insensitive): same-name entries merge
onto the manifest (overlay fields win, type/role fall back to the base,
descriptions merge per source key) and only new names append.
* refactor(sl): split overlay columns from column_overrides and enforce TS/Python wire contract
Overlay sources now have two distinct collections: `columns:` for computed
columns (requiring `expr` + `type`) and `column_overrides:` for metadata
patches to inherited manifest columns. Composing or loading an overlay that
mixes the two — or references an unknown column — fails with a typed error.
Introduce `ResolvedSemanticLayerSource` / `resolvedSourceSchema` /
`toResolvedWire` as the strict shape sent to the Python engine, and add a
schema contract test that diffs Zod against the Pydantic JSON schema dumped
by `python -m semantic_layer dump-schema`. `SourceDefinition` is now
`extra="forbid"` on the Python side.
`loadAllSources` surfaces per-file load errors instead of swallowing them,
so validation/query paths can report manifest shard parse failures.
* fix(context): make scan description generation resilient and quiet
A transient sampleTable failure during ingest used to take out every
table in a connection: generateTableDescription returned a hardcoded
'Table not found' string into descriptions.ai, and KtxDescriptionGenerator
was constructed without a logger, so the failure left no trail anywhere.
- sampleTable / sampleColumn calls retry 3x with 200/400/800ms backoff,
honouring KtxScanContext.signal via a new KtxAbortedError.
- On retry exhaustion or missing capability, table generation falls back
to a metadata-only prompt built from column name / native type / comment
/ rawDescriptions. The column path follows the same rule -- call the
LLM when any of samples or rawDescriptions are available; skip only
when both are absent.
- Logger is now threaded from KtxScanContext into the generator. Failures
emit structured KtxScanWarning entries (new description_fallback_used
code, plus existing sampling_failed / enrichment_failed /
connector_capability_missing). ktx scan groups warnings by code so a
batch of identical failures collapses to one summary line plus sample.
- Returns null on failure instead of the 'Table not found' sentinel; the
manifest writer's existing guard already skips empty descriptions, so
schema YAML no longer carries misleading text. SCAN_MANAGED_DESCRIPTION_KEYS
already strips stale 'ai' on merge, so existing YAML clears on next run.
Also suppress AI SDK v6 'system in messages' warning: pull system messages
out of KtxMessageBuilder.wrapSimple's output via a new splitKtxSystemMessages
helper and pass them top-level to generateText (preserves cacheControl
providerOptions on the SystemModelMessage). Agent-runner's local
splitSystemPromptMessages dedupes onto the shared helper.
* test(docs): align examples-docs assertions with revamped docs
PR #103 (setup/guide doc revamp) reworded several CLI examples and
connection labels; the assertions in scripts/examples-docs.test.mjs
still referenced the pre-revamp wording and were failing in CI on main.
Update the regexes to match the post-revamp content:
- drop the `--json` flag from the sl-query example expectation
- move the `Driver:` / `Status: ok` probe to the connection reference,
which is where that output now lives (driver id is lowercase
`postgres`, not the display name `PostgreSQL`)
- drop the obsolete `Install \`uv\`...` troubleshooting line
- accept `<connectionId>` everywhere; the docs no longer use the
hyphenated `<connection-id>` form
- match the `warehouse` connection id used in the quickstart instead of
the `postgres-warehouse` id only used in the README and setup ref
* fix(sl): skip TS/Python schema contract test when uv is unavailable
The TypeScript checks CI job does not install uv or Python, so the
module-level `execFileSync('uv', ...)` in schemas.contract.test.ts threw
ENOENT and failed the suite. Wrap the schema dump in a try/catch and
guard the describe block with `describe.skipIf` so the test skips in
environments without uv. Local dev and any CI job that has uv on PATH
still runs the cross-language contract assertion.
2026-05-15 02:11:04 +02:00
|
|
|
logger,
|
|
|
|
|
settings: { columnMaxWords: 12, tableMaxWords: 18, dataSourceMaxWords: 24 },
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const result = await generator.generateColumnDescriptions({
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
connector: samplerWithoutColumn,
|
|
|
|
|
context: { runId: 'run-1' },
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
supportsNestedAnalysis: false,
|
|
|
|
|
table: {
|
|
|
|
|
catalog: null,
|
|
|
|
|
db: 'public',
|
|
|
|
|
name: 'orders',
|
|
|
|
|
columns: [{ name: 'status', rawDescriptions: { db: 'order lifecycle state' } }],
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(result.columnDescriptions).toEqual([['status', 'Payment lifecycle state']]);
|
|
|
|
|
expect(logger.warn).toHaveBeenCalled();
|
|
|
|
|
const userPrompt = (
|
|
|
|
|
vi.mocked(generateText).mock.calls.at(-1)?.[0] as { messages: Array<{ role: string; content: string }> }
|
|
|
|
|
).messages.find((message) => message.role === 'user')?.content;
|
|
|
|
|
expect(userPrompt).toContain('<sample_values> unavailable </sample_values>');
|
|
|
|
|
expect(userPrompt).toContain('<db_documentation> order lifecycle state </db_documentation>');
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('generates column descriptions from rawDescriptions when sampleColumn retries exhaust', async () => {
|
|
|
|
|
const sampleColumn = vi
|
|
|
|
|
.fn<NonNullable<KtxScanConnector['sampleColumn']>>()
|
|
|
|
|
.mockRejectedValue(new Error('pool: connection refused'));
|
|
|
|
|
const flakyConnector: KtxScanConnector = {
|
|
|
|
|
...createConnector(),
|
|
|
|
|
sampleColumn,
|
|
|
|
|
};
|
|
|
|
|
const generator = new KtxDescriptionGenerator({
|
2026-05-16 12:06:34 +02:00
|
|
|
llmRuntime: createLlmProvider('Customer reference identifier'),
|
fix(context): merge overlay columns onto manifest columns by name (#94)
* fix(context): merge overlay columns onto manifest columns by name
composeOverlay was appending overlay columns to the manifest column list,
producing duplicate entries when dbt/metabase overlays declared a column
just to attach descriptions. The duplicates carried no `type`, so the
pydantic SourceDefinition rejected them at semantic-query time and broke
`ktx sl query` for every overlay-backed measure. Now overlay columns
match base columns by name (case-insensitive): same-name entries merge
onto the manifest (overlay fields win, type/role fall back to the base,
descriptions merge per source key) and only new names append.
* refactor(sl): split overlay columns from column_overrides and enforce TS/Python wire contract
Overlay sources now have two distinct collections: `columns:` for computed
columns (requiring `expr` + `type`) and `column_overrides:` for metadata
patches to inherited manifest columns. Composing or loading an overlay that
mixes the two — or references an unknown column — fails with a typed error.
Introduce `ResolvedSemanticLayerSource` / `resolvedSourceSchema` /
`toResolvedWire` as the strict shape sent to the Python engine, and add a
schema contract test that diffs Zod against the Pydantic JSON schema dumped
by `python -m semantic_layer dump-schema`. `SourceDefinition` is now
`extra="forbid"` on the Python side.
`loadAllSources` surfaces per-file load errors instead of swallowing them,
so validation/query paths can report manifest shard parse failures.
* fix(context): make scan description generation resilient and quiet
A transient sampleTable failure during ingest used to take out every
table in a connection: generateTableDescription returned a hardcoded
'Table not found' string into descriptions.ai, and KtxDescriptionGenerator
was constructed without a logger, so the failure left no trail anywhere.
- sampleTable / sampleColumn calls retry 3x with 200/400/800ms backoff,
honouring KtxScanContext.signal via a new KtxAbortedError.
- On retry exhaustion or missing capability, table generation falls back
to a metadata-only prompt built from column name / native type / comment
/ rawDescriptions. The column path follows the same rule -- call the
LLM when any of samples or rawDescriptions are available; skip only
when both are absent.
- Logger is now threaded from KtxScanContext into the generator. Failures
emit structured KtxScanWarning entries (new description_fallback_used
code, plus existing sampling_failed / enrichment_failed /
connector_capability_missing). ktx scan groups warnings by code so a
batch of identical failures collapses to one summary line plus sample.
- Returns null on failure instead of the 'Table not found' sentinel; the
manifest writer's existing guard already skips empty descriptions, so
schema YAML no longer carries misleading text. SCAN_MANAGED_DESCRIPTION_KEYS
already strips stale 'ai' on merge, so existing YAML clears on next run.
Also suppress AI SDK v6 'system in messages' warning: pull system messages
out of KtxMessageBuilder.wrapSimple's output via a new splitKtxSystemMessages
helper and pass them top-level to generateText (preserves cacheControl
providerOptions on the SystemModelMessage). Agent-runner's local
splitSystemPromptMessages dedupes onto the shared helper.
* test(docs): align examples-docs assertions with revamped docs
PR #103 (setup/guide doc revamp) reworded several CLI examples and
connection labels; the assertions in scripts/examples-docs.test.mjs
still referenced the pre-revamp wording and were failing in CI on main.
Update the regexes to match the post-revamp content:
- drop the `--json` flag from the sl-query example expectation
- move the `Driver:` / `Status: ok` probe to the connection reference,
which is where that output now lives (driver id is lowercase
`postgres`, not the display name `PostgreSQL`)
- drop the obsolete `Install \`uv\`...` troubleshooting line
- accept `<connectionId>` everywhere; the docs no longer use the
hyphenated `<connection-id>` form
- match the `warehouse` connection id used in the quickstart instead of
the `postgres-warehouse` id only used in the README and setup ref
* fix(sl): skip TS/Python schema contract test when uv is unavailable
The TypeScript checks CI job does not install uv or Python, so the
module-level `execFileSync('uv', ...)` in schemas.contract.test.ts threw
ENOENT and failed the suite. Wrap the schema dump in a try/catch and
guard the describe block with `describe.skipIf` so the test skips in
environments without uv. Local dev and any CI job that has uv on PATH
still runs the cross-language contract assertion.
2026-05-15 02:11:04 +02:00
|
|
|
settings: { columnMaxWords: 12, tableMaxWords: 18, dataSourceMaxWords: 24 },
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const result = await generator.generateColumnDescriptions({
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
connector: flakyConnector,
|
|
|
|
|
context: { runId: 'run-1' },
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
supportsNestedAnalysis: false,
|
|
|
|
|
table: {
|
|
|
|
|
catalog: null,
|
|
|
|
|
db: 'public',
|
|
|
|
|
name: 'orders',
|
|
|
|
|
columns: [{ name: 'customer_id', rawDescriptions: { db: 'FK to customers.id' } }],
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(sampleColumn).toHaveBeenCalledTimes(3);
|
|
|
|
|
expect(result.columnDescriptions).toEqual([['customer_id', 'Customer reference identifier']]);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
it('skips column LLM call only when neither samples nor rawDescriptions are available', async () => {
|
|
|
|
|
const sampleColumn = vi
|
|
|
|
|
.fn<NonNullable<KtxScanConnector['sampleColumn']>>()
|
|
|
|
|
.mockResolvedValue({ values: [null, null], nullCount: 2, distinctCount: 0 });
|
|
|
|
|
const connector: KtxScanConnector = {
|
|
|
|
|
...createConnector(),
|
|
|
|
|
sampleColumn,
|
|
|
|
|
};
|
|
|
|
|
vi.mocked(generateText).mockClear();
|
|
|
|
|
const generator = new KtxDescriptionGenerator({
|
2026-05-16 12:06:34 +02:00
|
|
|
llmRuntime: createLlmProvider('should not be called'),
|
fix(context): merge overlay columns onto manifest columns by name (#94)
* fix(context): merge overlay columns onto manifest columns by name
composeOverlay was appending overlay columns to the manifest column list,
producing duplicate entries when dbt/metabase overlays declared a column
just to attach descriptions. The duplicates carried no `type`, so the
pydantic SourceDefinition rejected them at semantic-query time and broke
`ktx sl query` for every overlay-backed measure. Now overlay columns
match base columns by name (case-insensitive): same-name entries merge
onto the manifest (overlay fields win, type/role fall back to the base,
descriptions merge per source key) and only new names append.
* refactor(sl): split overlay columns from column_overrides and enforce TS/Python wire contract
Overlay sources now have two distinct collections: `columns:` for computed
columns (requiring `expr` + `type`) and `column_overrides:` for metadata
patches to inherited manifest columns. Composing or loading an overlay that
mixes the two — or references an unknown column — fails with a typed error.
Introduce `ResolvedSemanticLayerSource` / `resolvedSourceSchema` /
`toResolvedWire` as the strict shape sent to the Python engine, and add a
schema contract test that diffs Zod against the Pydantic JSON schema dumped
by `python -m semantic_layer dump-schema`. `SourceDefinition` is now
`extra="forbid"` on the Python side.
`loadAllSources` surfaces per-file load errors instead of swallowing them,
so validation/query paths can report manifest shard parse failures.
* fix(context): make scan description generation resilient and quiet
A transient sampleTable failure during ingest used to take out every
table in a connection: generateTableDescription returned a hardcoded
'Table not found' string into descriptions.ai, and KtxDescriptionGenerator
was constructed without a logger, so the failure left no trail anywhere.
- sampleTable / sampleColumn calls retry 3x with 200/400/800ms backoff,
honouring KtxScanContext.signal via a new KtxAbortedError.
- On retry exhaustion or missing capability, table generation falls back
to a metadata-only prompt built from column name / native type / comment
/ rawDescriptions. The column path follows the same rule -- call the
LLM when any of samples or rawDescriptions are available; skip only
when both are absent.
- Logger is now threaded from KtxScanContext into the generator. Failures
emit structured KtxScanWarning entries (new description_fallback_used
code, plus existing sampling_failed / enrichment_failed /
connector_capability_missing). ktx scan groups warnings by code so a
batch of identical failures collapses to one summary line plus sample.
- Returns null on failure instead of the 'Table not found' sentinel; the
manifest writer's existing guard already skips empty descriptions, so
schema YAML no longer carries misleading text. SCAN_MANAGED_DESCRIPTION_KEYS
already strips stale 'ai' on merge, so existing YAML clears on next run.
Also suppress AI SDK v6 'system in messages' warning: pull system messages
out of KtxMessageBuilder.wrapSimple's output via a new splitKtxSystemMessages
helper and pass them top-level to generateText (preserves cacheControl
providerOptions on the SystemModelMessage). Agent-runner's local
splitSystemPromptMessages dedupes onto the shared helper.
* test(docs): align examples-docs assertions with revamped docs
PR #103 (setup/guide doc revamp) reworded several CLI examples and
connection labels; the assertions in scripts/examples-docs.test.mjs
still referenced the pre-revamp wording and were failing in CI on main.
Update the regexes to match the post-revamp content:
- drop the `--json` flag from the sl-query example expectation
- move the `Driver:` / `Status: ok` probe to the connection reference,
which is where that output now lives (driver id is lowercase
`postgres`, not the display name `PostgreSQL`)
- drop the obsolete `Install \`uv\`...` troubleshooting line
- accept `<connectionId>` everywhere; the docs no longer use the
hyphenated `<connection-id>` form
- match the `warehouse` connection id used in the quickstart instead of
the `postgres-warehouse` id only used in the README and setup ref
* fix(sl): skip TS/Python schema contract test when uv is unavailable
The TypeScript checks CI job does not install uv or Python, so the
module-level `execFileSync('uv', ...)` in schemas.contract.test.ts threw
ENOENT and failed the suite. Wrap the schema dump in a try/catch and
guard the describe block with `describe.skipIf` so the test skips in
environments without uv. Local dev and any CI job that has uv on PATH
still runs the cross-language contract assertion.
2026-05-15 02:11:04 +02:00
|
|
|
settings: { columnMaxWords: 12, tableMaxWords: 18, dataSourceMaxWords: 24 },
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
const result = await generator.generateColumnDescriptions({
|
|
|
|
|
connectionId: 'conn-1',
|
|
|
|
|
connector,
|
|
|
|
|
context: { runId: 'run-1' },
|
|
|
|
|
dataSourceType: 'POSTGRESQL',
|
|
|
|
|
supportsNestedAnalysis: false,
|
|
|
|
|
table: {
|
|
|
|
|
catalog: null,
|
|
|
|
|
db: 'public',
|
|
|
|
|
name: 'orders',
|
|
|
|
|
columns: [{ name: 'opaque_blob' }],
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
expect(result.columnDescriptions).toEqual([['opaque_blob', null]]);
|
|
|
|
|
expect(generateText).not.toHaveBeenCalled();
|
|
|
|
|
});
|
|
|
|
|
});
|