mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
* feat(cli): define full warehouse dialect contract
* test(cli): keep dialect edge tests focused
* fix(cli): stabilize dialect contract foundation
* refactor(connectors): own read-only query preparation
* refactor(connectors): resolve dialects through registry
* refactor(connectors): keep concrete dialect classes internal
* chore(workspace): enforce dialect import boundary
* refactor(cli): resolve relationship dialect at scan boundary
* refactor(cli): use dialect display parsing for entity details
* refactor(cli): use dialect display parsing for warehouse catalog
* refactor(cli): use dialect SQL in relationship workflows
* test(cli): verify solid dialect scan workflow closure
* test: split cli tests from source tree
* refactor(cli): standardize BigQuery scope listing
* feat(sqlite): implement connector scope listing
* test(connectors): cover required table listing
* feat(cli): add warehouse driver registry
* refactor(setup): route scope discovery through driver registry
* refactor(cli): route local query execution through driver registry
* refactor(historic-sql): route dialect support through driver registry
* refactor(cli): test warehouse connections through driver registry
* fix(cli): close driver registry type export gaps
* Improve setup daemon diagnostics
* refactor(setup): centralize rail-prefixed diagnostics + query-history fallback
Extract errorMessage, writePrefixedLines, and flushPrefixedBufferedCommandOutput
into clack.ts so the setup wizard, managed daemons, and embedding/agent steps
share one rail-formatted writer. setup-databases.ts also adds a
"disable query history and retry" option when the schema-context build fails
and query history is the likely culprit, surfaced via a new
failed-query-history-unavailable status.
* fix(cli): carry catalog through the picker so BigQuery/Snowflake/SQL Server scope filters match
The setup picker's KtxTableListEntry was a 2-level { schema, name }, so
qualifiedTableId always wrote db.name into enabled_tables. When BigQuery,
Snowflake, or SQL Server later ran fast ingest, their introspect step filtered
the scope set with scopedTableNames(scope, { catalog: projectId|database, db })
— catalog was non-null on the introspect side but null in the scope refs, so
every entry was rejected, the live-database adapter staged zero table files,
and detect() failed with 'Adapter "live-database" did not recognize fetched
source output'.
Align the picker boundary with the canonical 3-level KtxTableRef:
- Add catalog: string | null to KtxTableListEntry.
- BigQuery/Snowflake/SQL Server listTables populate catalog from the
resolved projectId / database; Postgres/MySQL/ClickHouse/SQLite set null.
- qualifiedTableId emits catalog.schema.name when catalog is non-null
(resolveEnabledTables already accepts the 3-part shape) and
schemasFromEnabledTables now goes through parseDottedTableEntry so it
recovers the schema correctly from both 2-part and 3-part entries.
- Export parseDottedTableEntry from enabled-tables.ts (@internal) for picker
reuse.
Update listTables expectations in all seven connector tests and the setup /
picker test fixtures. Add a picker regression test that covers the
catalog-bearing round-trip (save + refine).
* fix(cli): allow debug telemetry under opt-out env
161 lines
5.4 KiB
TypeScript
161 lines
5.4 KiB
TypeScript
import { mkdtemp, rm, writeFile } from 'node:fs/promises';
|
|
import { tmpdir } from 'node:os';
|
|
import { join } from 'node:path';
|
|
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
|
|
import { runKtxCli, type KtxCliDeps } from '../src/index.js';
|
|
|
|
async function makeFixtureProject(prefix: string): Promise<string> {
|
|
const dir = await mkdtemp(join(tmpdir(), prefix));
|
|
await writeFile(join(dir, 'ktx.yaml'), '{}\n', 'utf-8');
|
|
return dir;
|
|
}
|
|
|
|
function makeIo() {
|
|
let stdout = '';
|
|
let stderr = '';
|
|
return {
|
|
io: {
|
|
stdout: {
|
|
write: (chunk: string) => {
|
|
stdout += chunk;
|
|
},
|
|
},
|
|
stderr: {
|
|
write: (chunk: string) => {
|
|
stderr += chunk;
|
|
},
|
|
},
|
|
},
|
|
stdout: () => stdout,
|
|
stderr: () => stderr,
|
|
};
|
|
}
|
|
|
|
describe('project directory defaults', () => {
|
|
let envProjectDir: string;
|
|
let explicitProjectDir: string;
|
|
|
|
beforeEach(async () => {
|
|
envProjectDir = await makeFixtureProject('ktx-env-project-');
|
|
explicitProjectDir = await makeFixtureProject('ktx-explicit-project-');
|
|
});
|
|
|
|
afterEach(async () => {
|
|
delete process.env.KTX_PROJECT_DIR;
|
|
await rm(envProjectDir, { recursive: true, force: true });
|
|
await rm(explicitProjectDir, { recursive: true, force: true });
|
|
});
|
|
|
|
it('uses KTX_PROJECT_DIR when Commander-dispatched commands omit --project-dir', async () => {
|
|
process.env.KTX_PROJECT_DIR = envProjectDir;
|
|
|
|
const connection = vi.fn(async () => 0);
|
|
const doctor = vi.fn(async () => 0);
|
|
const publicIngest = vi.fn(async () => 0);
|
|
const setup = vi.fn(async () => 0);
|
|
const deps: KtxCliDeps = { connection, doctor, publicIngest, setup };
|
|
|
|
const cases: Array<{
|
|
argv: string[];
|
|
spy: ReturnType<typeof vi.fn>;
|
|
expected: Record<string, unknown>;
|
|
expectedStderr: string;
|
|
}> = [
|
|
{
|
|
argv: ['connection', 'list'],
|
|
spy: connection,
|
|
expected: { command: 'list', projectDir: envProjectDir },
|
|
expectedStderr: `Project: ${envProjectDir}\n`,
|
|
},
|
|
{
|
|
argv: ['status', '--no-input'],
|
|
spy: doctor,
|
|
expected: { command: 'project', projectDir: envProjectDir },
|
|
expectedStderr: `Project: ${envProjectDir}\n`,
|
|
},
|
|
{
|
|
argv: ['setup', '--no-input'],
|
|
spy: setup,
|
|
expected: { command: 'run', projectDir: envProjectDir },
|
|
expectedStderr: '',
|
|
},
|
|
{
|
|
argv: ['ingest', 'warehouse', '--no-input'],
|
|
spy: publicIngest,
|
|
expected: { command: 'run', projectDir: envProjectDir, targetConnectionId: 'warehouse' },
|
|
expectedStderr: `Project: ${envProjectDir}\n`,
|
|
},
|
|
];
|
|
|
|
for (const item of cases) {
|
|
const testIo = makeIo();
|
|
await expect(runKtxCli(item.argv, testIo.io, deps)).resolves.toBe(0);
|
|
expect(item.spy).toHaveBeenLastCalledWith(expect.objectContaining(item.expected), testIo.io);
|
|
expect(testIo.stderr()).toBe(item.expectedStderr);
|
|
}
|
|
});
|
|
|
|
it('lets explicit global --project-dir override KTX_PROJECT_DIR before and after nested commands', async () => {
|
|
process.env.KTX_PROJECT_DIR = envProjectDir;
|
|
|
|
const publicIngest = vi.fn(async () => 0);
|
|
const beforeCommandIo = makeIo();
|
|
const afterCommandIo = makeIo();
|
|
|
|
await expect(
|
|
runKtxCli(['--project-dir', explicitProjectDir, 'ingest', 'warehouse', '--no-input'], beforeCommandIo.io, {
|
|
publicIngest,
|
|
}),
|
|
).resolves.toBe(0);
|
|
await expect(
|
|
runKtxCli(['ingest', 'warehouse', `--project-dir=${explicitProjectDir}`, '--no-input'], afterCommandIo.io, {
|
|
publicIngest,
|
|
}),
|
|
).resolves.toBe(0);
|
|
|
|
expect(publicIngest).toHaveBeenNthCalledWith(
|
|
1,
|
|
expect.objectContaining({ command: 'run', projectDir: explicitProjectDir }),
|
|
beforeCommandIo.io,
|
|
);
|
|
expect(publicIngest).toHaveBeenNthCalledWith(
|
|
2,
|
|
expect.objectContaining({ command: 'run', projectDir: explicitProjectDir }),
|
|
afterCommandIo.io,
|
|
);
|
|
expect(beforeCommandIo.stderr()).toBe(`Project: ${explicitProjectDir}\n`);
|
|
expect(afterCommandIo.stderr()).toBe(`Project: ${explicitProjectDir}\n`);
|
|
});
|
|
|
|
it('uses nearest ancestor containing ktx.yaml when no explicit or environment project-dir exists', async () => {
|
|
const { mkdir, realpath, writeFile } = await import('node:fs/promises');
|
|
const { mkdtemp, rm } = await import('node:fs/promises');
|
|
const { tmpdir } = await import('node:os');
|
|
const { join } = await import('node:path');
|
|
|
|
const originalCwd = process.cwd();
|
|
const root = await mkdtemp(join(tmpdir(), 'ktx-cli-nearest-project-'));
|
|
const projectDir = join(root, 'warehouse');
|
|
const nestedDir = join(projectDir, 'nested', 'deeper');
|
|
await mkdir(nestedDir, { recursive: true });
|
|
await writeFile(join(projectDir, 'ktx.yaml'), '{}\n', 'utf-8');
|
|
const expectedProjectDir = await realpath(projectDir);
|
|
|
|
const publicIngest = vi.fn(async () => 0);
|
|
const testIo = makeIo();
|
|
|
|
try {
|
|
process.chdir(nestedDir);
|
|
await expect(runKtxCli(['ingest', 'warehouse', '--no-input'], testIo.io, { publicIngest })).resolves.toBe(0);
|
|
} finally {
|
|
process.chdir(originalCwd);
|
|
await rm(root, { recursive: true, force: true });
|
|
}
|
|
|
|
expect(publicIngest).toHaveBeenCalledWith(
|
|
expect.objectContaining({ command: 'run', projectDir: expectedProjectDir }),
|
|
testIo.io,
|
|
);
|
|
expect(testIo.stderr()).toBe(`Project: ${expectedProjectDir}\n`);
|
|
});
|
|
});
|