mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
* docs: add CLI component reuse guidance * docs: add unified ingest ux design * Refine unified ingest UX design after adversarial review iteration 1 * Refine unified ingest UX design after adversarial review iteration 2 * Refine unified ingest UX design after adversarial review iteration 3 * feat(cli): route public connection ingest command * feat(cli): hide standalone scan from public help * feat(cli): plan public ingest depth and query history * feat(cli): execute public database ingest facets * feat(ingest): read connection query history config * fix(cli): use public ingest wording * fix(config): stop generating ingest adapter allow lists * docs: document public ingest command * test: align ingest surface expectations * docs: add unified ingest public CLI surface plan * feat(cli): preflight deep public ingest readiness * feat(setup): store query history in connection context * feat(setup): store database context depth * feat(setup): verify context readiness by database depth * fix(setup): keep context build foreground only * fix(config): reject reserved ingest connection ids * test: close unified ingest v1 expectations * docs: add unified ingest v1 closure plan * fix(ingest): bypass adapter allow-list for public source ingest * fix(ingest): honor query history window intent * fix(ingest): hide scan internals from public database ingest * feat(ingest): use foreground view for interactive public ingest * fix(setup): use schema context and query history wording * test(cli): verify unified ingest public output * docs: add unified ingest v1 public output closure plan * fix(setup): forward query history flags * fix(setup): prompt for postgres query history * fix(status): report query history readiness * fix(ingest): remove legacy public guidance * fix(ingest): polish foreground retry copy * docs(examples): use unified query history wording * chore(ingest): finish public query history cleanup * docs: add unified ingest v1 query history status cleanup plan * test(docs): cover unified ingest public docs * docs: align ingest CLI reference with unified UX * docs: update context build guides for unified ingest * docs: update setup and primary source ingest wording * docs: stop advertising adapter-backed example ingest * docs: close unified ingest public docs gaps * docs: add unified ingest v1 docs site closure plan * fix: render unified ingest foreground warnings * fix: explain query history schema order * fix: add public ingest retry guidance * fix: align setup next steps with unified ingest * fix: remove scan wording from demo progress * test: verify unified ingest ux closure * docs: add unified ingest v1 foreground and retry closure plan * fix(cli): preserve query-history pull config in public ingest * fix(cli): omit hidden commands from docs command tree * test(cli): close unified ingest final public surface checks * docs: add unified ingest v1 final public surface closure plan * fix(cli): use public source labels in ingest reports * fix(cli): suppress low-level public ingest output * test(cli): verify unified ingest public plain output * docs: add unified ingest v1 public plain output closure plan * fix(cli): add public ingest copy sanitizers * fix(cli): sanitize public ingest progress copy * fix(cli): rename setup schema scope prompt * docs(plan): add progress copy closure; test: align setup back-nav fixture Adds the iter9 plan and updates the setup back-navigation test fixture to pass disableQueryHistory plus listSchemas/listTables stubs that the unified ingest setup step now requires. * docs(plan): add final ux labels plan with narrowed label scans * fix(cli): aggregate unsupported query-history warnings * fix(cli): align setup database labels * test(cli): fix setup database test type-check * fix(cli): remove primary-source wording from setup output * test(cli): verify unified ingest setup closure * docs(plan): add unified ingest v1 verification copy closure plan * fix(cli): remove top-level scan command * fix(cli): remove legacy ingest and wiki commands * Merge scan into ingest flow * feat(cli): split ingest progress into per-phase rows, rename work units to tasks Each database target in the unified ingest dashboard now renders one row per real subprocess (Schema, then Query history when enabled) instead of a single combined bar. Each phase has its own monotonic 0-100% bar so the progress never snaps back to zero when historic-sql starts after scan completes. Completed phases keep their final bar, summary, and elapsed time visible as an inline audit trail; queued and skipped phases are shown explicitly. Also rename user-facing "work units" / "Failed work units" to "tasks" / "Failed tasks" in ingest output and parseIngestSummary. The parser still accepts the legacy "Work units:" wording in captured output for backward compat. Internal memory-flow event names and type fields are left alone. * Fix test harness failures * Fix CI smoke checks --------- Co-authored-by: Andrey Avtomonov <7889985+andreybavt@users.noreply.github.com>
214 lines
8.1 KiB
TypeScript
214 lines
8.1 KiB
TypeScript
import type { KtxCliIo } from './cli-runtime.js';
|
|
import {
|
|
stopAllManagedPythonDaemons,
|
|
startManagedPythonDaemon,
|
|
stopManagedPythonDaemon,
|
|
type ManagedPythonDaemonStopAllResult,
|
|
type ManagedPythonDaemonStartResult,
|
|
type ManagedPythonDaemonStopResult,
|
|
} from './managed-python-daemon.js';
|
|
import {
|
|
doctorManagedPythonRuntime,
|
|
installManagedPythonRuntime,
|
|
readManagedPythonRuntimeStatus,
|
|
type KtxRuntimeFeature,
|
|
type ManagedPythonRuntimeDoctorCheck,
|
|
type ManagedPythonRuntimeInstallOptions,
|
|
type ManagedPythonRuntimeInstallResult,
|
|
type ManagedPythonRuntimeLayoutOptions,
|
|
type ManagedPythonRuntimeStatus,
|
|
} from './managed-python-runtime.js';
|
|
|
|
export type KtxRuntimeArgs =
|
|
| { command: 'install'; cliVersion: string; feature: KtxRuntimeFeature; force: boolean }
|
|
| { command: 'start'; cliVersion: string; feature: KtxRuntimeFeature; force: boolean }
|
|
| { command: 'stop'; cliVersion: string; all: boolean }
|
|
| { command: 'status'; cliVersion: string; json: boolean };
|
|
|
|
export interface KtxRuntimeDeps {
|
|
installRuntime?: (options: ManagedPythonRuntimeInstallOptions) => Promise<ManagedPythonRuntimeInstallResult>;
|
|
startDaemon?: (options: {
|
|
cliVersion: string;
|
|
features: KtxRuntimeFeature[];
|
|
force?: boolean;
|
|
}) => Promise<ManagedPythonDaemonStartResult>;
|
|
stopDaemon?: (options: { cliVersion: string }) => Promise<ManagedPythonDaemonStopResult>;
|
|
stopAllDaemons?: (options: { cliVersion: string }) => Promise<ManagedPythonDaemonStopAllResult>;
|
|
readStatus?: (options: ManagedPythonRuntimeLayoutOptions) => Promise<ManagedPythonRuntimeStatus>;
|
|
doctorRuntime?: (options: ManagedPythonRuntimeLayoutOptions) => Promise<ManagedPythonRuntimeDoctorCheck[]>;
|
|
}
|
|
|
|
function writeJson(io: KtxCliIo, value: unknown): void {
|
|
io.stdout.write(`${JSON.stringify(value, null, 2)}\n`);
|
|
}
|
|
|
|
function writeInstallResult(io: KtxCliIo, result: ManagedPythonRuntimeInstallResult): void {
|
|
const verb = result.status === 'ready' ? 'Using existing' : 'Installed';
|
|
io.stdout.write(`${verb} KTX Python runtime\n`);
|
|
io.stdout.write(`version: ${result.manifest.cliVersion}\n`);
|
|
io.stdout.write(`features: ${result.manifest.features.join(', ')}\n`);
|
|
io.stdout.write(`python: ${result.manifest.python.executable}\n`);
|
|
io.stdout.write(`daemon: ${result.manifest.python.daemonExecutable}\n`);
|
|
io.stdout.write(`manifest: ${result.layout.manifestPath}\n`);
|
|
io.stdout.write(`install log: ${result.layout.installLogPath}\n`);
|
|
}
|
|
|
|
function writeDaemonStart(io: KtxCliIo, result: ManagedPythonDaemonStartResult): void {
|
|
const verb = result.status === 'reused' ? 'Using existing' : 'Started';
|
|
io.stdout.write(`${verb} KTX Python daemon\n`);
|
|
io.stdout.write(`url: ${result.baseUrl}\n`);
|
|
io.stdout.write(`pid: ${result.state.pid}\n`);
|
|
io.stdout.write(`version: ${result.state.version}\n`);
|
|
io.stdout.write(`features: ${result.state.features.join(', ')}\n`);
|
|
io.stdout.write(`state: ${result.layout.daemonStatePath}\n`);
|
|
io.stdout.write(`stdout: ${result.state.stdoutLog}\n`);
|
|
io.stdout.write(`stderr: ${result.state.stderrLog}\n`);
|
|
}
|
|
|
|
function writeDaemonStop(io: KtxCliIo, result: ManagedPythonDaemonStopResult): void {
|
|
if (result.status === 'already-stopped') {
|
|
io.stdout.write('KTX Python daemon already stopped\n');
|
|
return;
|
|
}
|
|
io.stdout.write('Stopped KTX Python daemon\n');
|
|
io.stdout.write(`pid: ${result.state?.pid ?? 'unknown'}\n`);
|
|
io.stdout.write(`state: ${result.layout.daemonStatePath}\n`);
|
|
}
|
|
|
|
function writeStopAllEntry(io: KtxCliIo, entry: { pid: number; source: string; url?: string; health?: string; detail?: string }): void {
|
|
io.stdout.write(
|
|
`pid: ${entry.pid} source: ${entry.source}${entry.url ? ` url: ${entry.url}` : ''}${
|
|
entry.health ? ` health: ${entry.health}` : ''
|
|
}${
|
|
entry.detail ? ` detail: ${entry.detail}` : ''
|
|
}\n`,
|
|
);
|
|
}
|
|
|
|
function writeDaemonStopAll(io: KtxCliIo, result: ManagedPythonDaemonStopAllResult): number {
|
|
const failed = result.failed.length + result.scanErrors.length;
|
|
if (
|
|
result.stopped.length === 0 &&
|
|
result.stale.length === 0 &&
|
|
result.failed.length === 0 &&
|
|
result.scanErrors.length === 0
|
|
) {
|
|
io.stdout.write('No KTX Python daemons found\n');
|
|
return 0;
|
|
}
|
|
if (failed === 0) {
|
|
io.stdout.write(`Stopped ${result.stopped.length} KTX Python daemons\n`);
|
|
if (result.stale.length > 0) {
|
|
io.stdout.write(`Cleaned ${result.stale.length} stale daemon states\n`);
|
|
}
|
|
for (const entry of result.stopped) {
|
|
writeStopAllEntry(io, entry);
|
|
}
|
|
for (const entry of result.stale) {
|
|
writeStopAllEntry(io, entry);
|
|
}
|
|
return 0;
|
|
}
|
|
io.stderr.write(
|
|
`Stopped ${result.stopped.length} KTX Python daemons; failed ${result.failed.length}${
|
|
result.stale.length > 0 ? `; cleaned stale ${result.stale.length}` : ''
|
|
}\n`,
|
|
);
|
|
for (const entry of result.failed) {
|
|
io.stderr.write(
|
|
`pid: ${entry.pid} source: ${entry.source}${entry.url ? ` url: ${entry.url}` : ''}${
|
|
entry.health ? ` health: ${entry.health}` : ''
|
|
} detail: ${entry.detail}\n`,
|
|
);
|
|
}
|
|
for (const error of result.scanErrors) {
|
|
io.stderr.write(`process scan: ${error}\n`);
|
|
}
|
|
return 1;
|
|
}
|
|
|
|
function writeStatus(io: KtxCliIo, status: ManagedPythonRuntimeStatus): void {
|
|
io.stdout.write('KTX Python runtime\n');
|
|
io.stdout.write(`status: ${status.kind}\n`);
|
|
io.stdout.write(`detail: ${status.detail}\n`);
|
|
io.stdout.write(`runtime root: ${status.layout.runtimeRoot}\n`);
|
|
io.stdout.write(`version dir: ${status.layout.versionDir}\n`);
|
|
if (status.manifest) {
|
|
io.stdout.write(`features: ${status.manifest.features.join(', ')}\n`);
|
|
io.stdout.write(`python: ${status.manifest.python.executable}\n`);
|
|
io.stdout.write(`daemon: ${status.manifest.python.daemonExecutable}\n`);
|
|
}
|
|
}
|
|
|
|
function writeRuntimeChecks(io: KtxCliIo, checks: ManagedPythonRuntimeDoctorCheck[]): void {
|
|
io.stdout.write('KTX Python runtime checks\n');
|
|
for (const check of checks) {
|
|
io.stdout.write(`${check.status.toUpperCase()} ${check.label}: ${check.detail}\n`);
|
|
if (check.fix) {
|
|
io.stdout.write(` Fix: ${check.fix}\n`);
|
|
}
|
|
}
|
|
}
|
|
|
|
function hasRuntimeStatusFailure(status: ManagedPythonRuntimeStatus): boolean {
|
|
return status.kind !== 'ready';
|
|
}
|
|
|
|
export async function runKtxRuntime(
|
|
args: KtxRuntimeArgs,
|
|
io: KtxCliIo = process,
|
|
deps: KtxRuntimeDeps = {},
|
|
): Promise<number> {
|
|
try {
|
|
if (args.command === 'install') {
|
|
const installRuntime = deps.installRuntime ?? installManagedPythonRuntime;
|
|
const result = await installRuntime({
|
|
cliVersion: args.cliVersion,
|
|
features: [args.feature],
|
|
force: args.force,
|
|
});
|
|
writeInstallResult(io, result);
|
|
return 0;
|
|
}
|
|
if (args.command === 'start') {
|
|
const startDaemon = deps.startDaemon ?? startManagedPythonDaemon;
|
|
const result = await startDaemon({
|
|
cliVersion: args.cliVersion,
|
|
features: [args.feature],
|
|
force: args.force,
|
|
});
|
|
writeDaemonStart(io, result);
|
|
return 0;
|
|
}
|
|
if (args.command === 'stop') {
|
|
if (args.all) {
|
|
const stopAllDaemons = deps.stopAllDaemons ?? stopAllManagedPythonDaemons;
|
|
const result = await stopAllDaemons({ cliVersion: args.cliVersion });
|
|
return writeDaemonStopAll(io, result);
|
|
} else {
|
|
const stopDaemon = deps.stopDaemon ?? stopManagedPythonDaemon;
|
|
const result = await stopDaemon({ cliVersion: args.cliVersion });
|
|
writeDaemonStop(io, result);
|
|
return 0;
|
|
}
|
|
}
|
|
if (args.command === 'status') {
|
|
const readStatus = deps.readStatus ?? readManagedPythonRuntimeStatus;
|
|
const doctorRuntime = deps.doctorRuntime ?? doctorManagedPythonRuntime;
|
|
const status = await readStatus({ cliVersion: args.cliVersion });
|
|
const checks = await doctorRuntime({ cliVersion: args.cliVersion });
|
|
if (args.json) {
|
|
writeJson(io, { ...status, checks });
|
|
} else {
|
|
writeStatus(io, status);
|
|
writeRuntimeChecks(io, checks);
|
|
}
|
|
return hasRuntimeStatusFailure(status) ? 1 : 0;
|
|
}
|
|
const _exhaustive: never = args;
|
|
return _exhaustive;
|
|
} catch (error) {
|
|
io.stderr.write(`${error instanceof Error ? error.message : String(error)}\n`);
|
|
return 1;
|
|
}
|
|
}
|