mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
56985b7e09
* 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
436 lines
16 KiB
TypeScript
436 lines
16 KiB
TypeScript
import { describe, expect, it, vi } from 'vitest';
|
|
import type {
|
|
ManagedPythonDaemonStopAllResult,
|
|
ManagedPythonDaemonStartResult,
|
|
ManagedPythonDaemonStopResult,
|
|
} from '../src/managed-python-daemon.js';
|
|
import type {
|
|
ManagedPythonRuntimeDoctorCheck,
|
|
ManagedPythonRuntimeInstallResult,
|
|
ManagedPythonRuntimeStatus,
|
|
} from '../src/managed-python-runtime.js';
|
|
import { runKtxRuntime, type KtxRuntimeDeps } from '../src/runtime.js';
|
|
|
|
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('runKtxRuntime', () => {
|
|
it('installs the requested runtime feature and prints the manifest path', async () => {
|
|
const io = makeIo();
|
|
const deps: KtxRuntimeDeps = {
|
|
installRuntime: vi.fn(async (): Promise<ManagedPythonRuntimeInstallResult> => ({
|
|
status: 'installed',
|
|
layout: {
|
|
cliVersion: '0.2.0',
|
|
runtimeRoot: '/runtime',
|
|
versionDir: '/runtime/0.2.0',
|
|
venvDir: '/runtime/0.2.0/.venv',
|
|
manifestPath: '/runtime/0.2.0/manifest.json',
|
|
installLogPath: '/runtime/0.2.0/install.log',
|
|
assetDir: '/assets/python',
|
|
assetManifestPath: '/assets/python/manifest.json',
|
|
pythonPath: '/runtime/0.2.0/.venv/bin/python',
|
|
daemonPath: '/runtime/0.2.0/.venv/bin/ktx-daemon',
|
|
},
|
|
asset: {
|
|
wheelPath: '/assets/python/kaelio_ktx-0.1.0-py3-none-any.whl',
|
|
requiresPython: { specifier: '>=3.13', minimumVersion: '3.13' },
|
|
manifest: {
|
|
schemaVersion: 1,
|
|
distributionName: 'kaelio-ktx',
|
|
normalizedName: 'kaelio_ktx',
|
|
version: '0.1.0',
|
|
wheel: {
|
|
file: 'kaelio_ktx-0.1.0-py3-none-any.whl',
|
|
sha256: 'a'.repeat(64),
|
|
bytes: 10,
|
|
},
|
|
},
|
|
},
|
|
manifest: {
|
|
schemaVersion: 1,
|
|
cliVersion: '0.2.0',
|
|
installedAt: '2026-05-11T00:00:00.000Z',
|
|
asset: {
|
|
schemaVersion: 1,
|
|
distributionName: 'kaelio-ktx',
|
|
normalizedName: 'kaelio_ktx',
|
|
version: '0.1.0',
|
|
wheel: {
|
|
file: 'kaelio_ktx-0.1.0-py3-none-any.whl',
|
|
sha256: 'a'.repeat(64),
|
|
bytes: 10,
|
|
},
|
|
},
|
|
features: ['core', 'local-embeddings'],
|
|
python: {
|
|
executable: '/runtime/0.2.0/.venv/bin/python',
|
|
daemonExecutable: '/runtime/0.2.0/.venv/bin/ktx-daemon',
|
|
},
|
|
installLog: '/runtime/0.2.0/install.log',
|
|
},
|
|
})),
|
|
};
|
|
|
|
await expect(
|
|
runKtxRuntime(
|
|
{ command: 'install', cliVersion: '0.2.0', feature: 'local-embeddings', force: true },
|
|
io.io,
|
|
deps,
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(deps.installRuntime).toHaveBeenCalledWith({
|
|
cliVersion: '0.2.0',
|
|
features: ['local-embeddings'],
|
|
force: true,
|
|
});
|
|
expect(io.stdout()).toContain('Installed KTX Python runtime');
|
|
expect(io.stdout()).toContain('features: core, local-embeddings');
|
|
expect(io.stdout()).toContain('manifest: /runtime/0.2.0/manifest.json');
|
|
expect(io.stderr()).toBe('');
|
|
});
|
|
|
|
it('starts the KTX daemon and prints the base URL', async () => {
|
|
const io = makeIo();
|
|
const deps: KtxRuntimeDeps = {
|
|
startDaemon: vi.fn(async (): Promise<ManagedPythonDaemonStartResult> => ({
|
|
status: 'started',
|
|
baseUrl: 'http://127.0.0.1:61234',
|
|
layout: {
|
|
cliVersion: '0.2.0',
|
|
runtimeRoot: '/runtime',
|
|
versionDir: '/runtime/0.2.0',
|
|
venvDir: '/runtime/0.2.0/.venv',
|
|
manifestPath: '/runtime/0.2.0/manifest.json',
|
|
installLogPath: '/runtime/0.2.0/install.log',
|
|
assetDir: '/assets/python',
|
|
assetManifestPath: '/assets/python/manifest.json',
|
|
pythonPath: '/runtime/0.2.0/.venv/bin/python',
|
|
daemonPath: '/runtime/0.2.0/.venv/bin/ktx-daemon',
|
|
projectDir: '/work/proj',
|
|
daemonStateDir: '/work/proj/.ktx/runtime',
|
|
daemonStatePath: '/work/proj/.ktx/runtime/daemon.json',
|
|
daemonStdoutPath: '/work/proj/.ktx/runtime/daemon.stdout.log',
|
|
daemonStderrPath: '/work/proj/.ktx/runtime/daemon.stderr.log',
|
|
},
|
|
state: {
|
|
schemaVersion: 1,
|
|
pid: 4242,
|
|
host: '127.0.0.1',
|
|
port: 61234,
|
|
version: '0.2.0',
|
|
features: ['core', 'local-embeddings'],
|
|
startedAt: '2026-05-11T00:00:00.000Z',
|
|
stdoutLog: '/work/proj/.ktx/runtime/daemon.stdout.log',
|
|
stderrLog: '/work/proj/.ktx/runtime/daemon.stderr.log',
|
|
},
|
|
})),
|
|
};
|
|
|
|
await expect(
|
|
runKtxRuntime(
|
|
{ command: 'start', cliVersion: '0.2.0', projectDir: '/work/proj', feature: 'local-embeddings', force: true },
|
|
io.io,
|
|
deps,
|
|
),
|
|
).resolves.toBe(0);
|
|
|
|
expect(deps.startDaemon).toHaveBeenCalledWith({
|
|
cliVersion: '0.2.0',
|
|
projectDir: '/work/proj',
|
|
features: ['local-embeddings'],
|
|
force: true,
|
|
});
|
|
expect(io.stdout()).toContain('Started KTX daemon');
|
|
expect(io.stdout()).toContain('url: http://127.0.0.1:61234');
|
|
expect(io.stdout()).toContain('pid: 4242');
|
|
expect(io.stdout()).toContain('features: core, local-embeddings');
|
|
expect(io.stdout()).toContain('stderr: /work/proj/.ktx/runtime/daemon.stderr.log');
|
|
});
|
|
|
|
it('stops the KTX daemon', async () => {
|
|
const io = makeIo();
|
|
const deps: KtxRuntimeDeps = {
|
|
stopDaemon: vi.fn(async (): Promise<ManagedPythonDaemonStopResult> => ({
|
|
status: 'stopped',
|
|
layout: {
|
|
cliVersion: '0.2.0',
|
|
runtimeRoot: '/runtime',
|
|
versionDir: '/runtime/0.2.0',
|
|
venvDir: '/runtime/0.2.0/.venv',
|
|
manifestPath: '/runtime/0.2.0/manifest.json',
|
|
installLogPath: '/runtime/0.2.0/install.log',
|
|
assetDir: '/assets/python',
|
|
assetManifestPath: '/assets/python/manifest.json',
|
|
pythonPath: '/runtime/0.2.0/.venv/bin/python',
|
|
daemonPath: '/runtime/0.2.0/.venv/bin/ktx-daemon',
|
|
projectDir: '/work/proj',
|
|
daemonStateDir: '/work/proj/.ktx/runtime',
|
|
daemonStatePath: '/work/proj/.ktx/runtime/daemon.json',
|
|
daemonStdoutPath: '/work/proj/.ktx/runtime/daemon.stdout.log',
|
|
daemonStderrPath: '/work/proj/.ktx/runtime/daemon.stderr.log',
|
|
},
|
|
state: {
|
|
schemaVersion: 1,
|
|
pid: 4242,
|
|
host: '127.0.0.1',
|
|
port: 61234,
|
|
version: '0.2.0',
|
|
features: ['core'],
|
|
startedAt: '2026-05-11T00:00:00.000Z',
|
|
stdoutLog: '/work/proj/.ktx/runtime/daemon.stdout.log',
|
|
stderrLog: '/work/proj/.ktx/runtime/daemon.stderr.log',
|
|
},
|
|
})),
|
|
};
|
|
|
|
await expect(
|
|
runKtxRuntime({ command: 'stop', cliVersion: '0.2.0', projectDir: '/work/proj', all: false }, io.io, deps),
|
|
).resolves.toBe(0);
|
|
|
|
expect(deps.stopDaemon).toHaveBeenCalledWith({ cliVersion: '0.2.0', projectDir: '/work/proj' });
|
|
expect(io.stdout()).toContain('Stopped KTX daemon');
|
|
expect(io.stdout()).toContain('pid: 4242');
|
|
});
|
|
|
|
it('stops all discovered KTX daemons and reports the summary', async () => {
|
|
const io = makeIo();
|
|
const deps: KtxRuntimeDeps = {
|
|
stopAllDaemons: vi.fn(async (): Promise<ManagedPythonDaemonStopAllResult> => ({
|
|
stopped: [
|
|
{ pid: 4242, source: 'state', url: 'http://127.0.0.1:61234', statePaths: ['/work/proj/.ktx/runtime/daemon.json'] },
|
|
{ pid: 5252, source: 'process', url: 'http://127.0.0.1:8765', statePaths: [] },
|
|
],
|
|
stale: [],
|
|
failed: [],
|
|
scanErrors: [],
|
|
})),
|
|
};
|
|
|
|
await expect(
|
|
runKtxRuntime({ command: 'stop', cliVersion: '0.2.0', projectDir: '/work/proj', all: true }, io.io, deps),
|
|
).resolves.toBe(0);
|
|
|
|
expect(deps.stopAllDaemons).toHaveBeenCalledWith({ cliVersion: '0.2.0', projectDir: '/work/proj' });
|
|
expect(io.stdout()).toContain('Stopped 2 KTX daemons');
|
|
expect(io.stdout()).toContain('pid: 4242 source: state url: http://127.0.0.1:61234');
|
|
expect(io.stdout()).toContain('pid: 5252 source: process url: http://127.0.0.1:8765');
|
|
});
|
|
|
|
it('returns failure when stop all cannot stop every daemon', async () => {
|
|
const io = makeIo();
|
|
const deps: KtxRuntimeDeps = {
|
|
stopAllDaemons: vi.fn(async (): Promise<ManagedPythonDaemonStopAllResult> => ({
|
|
stopped: [],
|
|
stale: [],
|
|
failed: [
|
|
{
|
|
pid: 4242,
|
|
source: 'state',
|
|
url: 'http://127.0.0.1:61234',
|
|
statePaths: ['/work/proj/.ktx/runtime/daemon.json'],
|
|
detail: 'Process still running after SIGKILL',
|
|
},
|
|
],
|
|
scanErrors: ['ps failed'],
|
|
})),
|
|
};
|
|
|
|
await expect(
|
|
runKtxRuntime({ command: 'stop', cliVersion: '0.2.0', projectDir: '/work/proj', all: true }, io.io, deps),
|
|
).resolves.toBe(1);
|
|
|
|
expect(io.stderr()).toContain('Stopped 0 KTX daemons; failed 1');
|
|
expect(io.stderr()).toContain('pid: 4242 source: state url: http://127.0.0.1:61234');
|
|
expect(io.stderr()).toContain('process scan: ps failed');
|
|
});
|
|
|
|
it('prints runtime status and doctor checks as JSON with doctor-style exit status', async () => {
|
|
const io = makeIo();
|
|
const deps: KtxRuntimeDeps = {
|
|
readStatus: vi.fn(async (): Promise<ManagedPythonRuntimeStatus> => ({
|
|
kind: 'missing',
|
|
detail: 'No runtime manifest at /runtime/0.2.0/manifest.json',
|
|
layout: {
|
|
cliVersion: '0.2.0',
|
|
runtimeRoot: '/runtime',
|
|
versionDir: '/runtime/0.2.0',
|
|
venvDir: '/runtime/0.2.0/.venv',
|
|
manifestPath: '/runtime/0.2.0/manifest.json',
|
|
installLogPath: '/runtime/0.2.0/install.log',
|
|
assetDir: '/assets/python',
|
|
assetManifestPath: '/assets/python/manifest.json',
|
|
pythonPath: '/runtime/0.2.0/.venv/bin/python',
|
|
daemonPath: '/runtime/0.2.0/.venv/bin/ktx-daemon',
|
|
},
|
|
})),
|
|
doctorRuntime: vi.fn(async (): Promise<ManagedPythonRuntimeDoctorCheck[]> => [
|
|
{ id: 'uv', label: 'uv', status: 'pass', detail: 'uv 0.9.5' },
|
|
{ id: 'asset', label: 'Bundled Python wheel', status: 'pass', detail: '/assets/python/runtime.whl' },
|
|
{
|
|
id: 'runtime',
|
|
label: 'Managed Python runtime',
|
|
status: 'fail',
|
|
detail: 'No runtime manifest at /runtime/0.2.0/manifest.json',
|
|
fix: 'Run: ktx admin runtime install --yes',
|
|
},
|
|
]),
|
|
};
|
|
|
|
await expect(runKtxRuntime({ command: 'status', cliVersion: '0.2.0', json: true }, io.io, deps)).resolves.toBe(1);
|
|
|
|
expect(JSON.parse(io.stdout())).toMatchObject({
|
|
kind: 'missing',
|
|
detail: 'No runtime manifest at /runtime/0.2.0/manifest.json',
|
|
layout: { runtimeRoot: '/runtime' },
|
|
checks: [
|
|
{ id: 'uv', status: 'pass' },
|
|
{ id: 'asset', status: 'pass' },
|
|
{ id: 'runtime', status: 'fail' },
|
|
],
|
|
});
|
|
expect(deps.readStatus).toHaveBeenCalledWith({ cliVersion: '0.2.0' });
|
|
expect(deps.doctorRuntime).toHaveBeenCalledWith({ cliVersion: '0.2.0' });
|
|
});
|
|
|
|
it('prints runtime status and doctor checks in plain output', async () => {
|
|
const io = makeIo();
|
|
const deps: KtxRuntimeDeps = {
|
|
readStatus: vi.fn(async (): Promise<ManagedPythonRuntimeStatus> => ({
|
|
kind: 'ready',
|
|
detail: 'Runtime ready at /runtime/0.2.0',
|
|
layout: {
|
|
cliVersion: '0.2.0',
|
|
runtimeRoot: '/runtime',
|
|
versionDir: '/runtime/0.2.0',
|
|
venvDir: '/runtime/0.2.0/.venv',
|
|
manifestPath: '/runtime/0.2.0/manifest.json',
|
|
installLogPath: '/runtime/0.2.0/install.log',
|
|
assetDir: '/assets/python',
|
|
assetManifestPath: '/assets/python/manifest.json',
|
|
pythonPath: '/runtime/0.2.0/.venv/bin/python',
|
|
daemonPath: '/runtime/0.2.0/.venv/bin/ktx-daemon',
|
|
},
|
|
manifest: {
|
|
schemaVersion: 1,
|
|
cliVersion: '0.2.0',
|
|
installedAt: '2026-05-11T00:00:00.000Z',
|
|
asset: {
|
|
schemaVersion: 1,
|
|
distributionName: 'kaelio-ktx',
|
|
normalizedName: 'kaelio_ktx',
|
|
version: '0.1.0',
|
|
wheel: {
|
|
file: 'kaelio_ktx-0.1.0-py3-none-any.whl',
|
|
sha256: 'a'.repeat(64),
|
|
bytes: 10,
|
|
},
|
|
},
|
|
features: ['core'],
|
|
python: {
|
|
executable: '/runtime/0.2.0/.venv/bin/python',
|
|
daemonExecutable: '/runtime/0.2.0/.venv/bin/ktx-daemon',
|
|
},
|
|
installLog: '/runtime/0.2.0/install.log',
|
|
},
|
|
})),
|
|
doctorRuntime: vi.fn(async (): Promise<ManagedPythonRuntimeDoctorCheck[]> => [
|
|
{ id: 'uv', label: 'uv', status: 'pass', detail: 'uv 0.9.5' },
|
|
{ id: 'asset', label: 'Bundled Python wheel', status: 'pass', detail: '/assets/python/runtime.whl' },
|
|
{ id: 'runtime', label: 'Managed Python runtime', status: 'pass', detail: 'Runtime ready at /runtime/0.2.0' },
|
|
]),
|
|
};
|
|
|
|
await expect(runKtxRuntime({ command: 'status', cliVersion: '0.2.0', json: false }, io.io, deps)).resolves.toBe(0);
|
|
|
|
expect(io.stdout()).toContain('KTX Python runtime');
|
|
expect(io.stdout()).toContain('status: ready');
|
|
expect(io.stdout()).toContain('KTX Python runtime checks');
|
|
expect(io.stdout()).toContain('PASS uv: uv 0.9.5');
|
|
expect(io.stdout()).toContain('PASS Managed Python runtime: Runtime ready at /runtime/0.2.0');
|
|
expect(io.stderr()).toBe('');
|
|
});
|
|
|
|
it('returns success when the installed runtime is ready but source assets are missing', async () => {
|
|
const io = makeIo();
|
|
const deps: KtxRuntimeDeps = {
|
|
readStatus: vi.fn(async (): Promise<ManagedPythonRuntimeStatus> => ({
|
|
kind: 'ready',
|
|
detail: 'Runtime ready at /runtime/0.2.0',
|
|
layout: {
|
|
cliVersion: '0.2.0',
|
|
runtimeRoot: '/runtime',
|
|
versionDir: '/runtime/0.2.0',
|
|
venvDir: '/runtime/0.2.0/.venv',
|
|
manifestPath: '/runtime/0.2.0/manifest.json',
|
|
installLogPath: '/runtime/0.2.0/install.log',
|
|
assetDir: '/assets/python',
|
|
assetManifestPath: '/assets/python/manifest.json',
|
|
pythonPath: '/runtime/0.2.0/.venv/bin/python',
|
|
daemonPath: '/runtime/0.2.0/.venv/bin/ktx-daemon',
|
|
},
|
|
manifest: {
|
|
schemaVersion: 1,
|
|
cliVersion: '0.2.0',
|
|
installedAt: '2026-05-11T00:00:00.000Z',
|
|
asset: {
|
|
schemaVersion: 1,
|
|
distributionName: 'kaelio-ktx',
|
|
normalizedName: 'kaelio_ktx',
|
|
version: '0.1.0',
|
|
wheel: {
|
|
file: 'kaelio_ktx-0.1.0-py3-none-any.whl',
|
|
sha256: 'a'.repeat(64),
|
|
bytes: 10,
|
|
},
|
|
},
|
|
features: ['core'],
|
|
python: {
|
|
executable: '/runtime/0.2.0/.venv/bin/python',
|
|
daemonExecutable: '/runtime/0.2.0/.venv/bin/ktx-daemon',
|
|
},
|
|
installLog: '/runtime/0.2.0/install.log',
|
|
},
|
|
})),
|
|
doctorRuntime: vi.fn(async (): Promise<ManagedPythonRuntimeDoctorCheck[]> => [
|
|
{ id: 'uv', label: 'uv', status: 'pass', detail: 'uv 0.9.5' },
|
|
{
|
|
id: 'asset',
|
|
label: 'Bundled Python wheel',
|
|
status: 'fail',
|
|
detail: 'Missing bundled Python runtime manifest: /assets/python/manifest.json',
|
|
fix: 'Run: pnpm run artifacts:check',
|
|
},
|
|
{ id: 'runtime', label: 'Managed Python runtime', status: 'pass', detail: 'Runtime ready at /runtime/0.2.0' },
|
|
]),
|
|
};
|
|
|
|
await expect(runKtxRuntime({ command: 'status', cliVersion: '0.2.0', json: false }, io.io, deps)).resolves.toBe(
|
|
0,
|
|
);
|
|
|
|
expect(io.stdout()).toContain('status: ready');
|
|
expect(io.stdout()).toContain('FAIL Bundled Python wheel: Missing bundled Python runtime manifest');
|
|
expect(io.stdout()).toContain('PASS Managed Python runtime: Runtime ready at /runtime/0.2.0');
|
|
expect(io.stderr()).toBe('');
|
|
});
|
|
});
|