mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
* chore: standardize daemon naming on "KTX daemon"
Replace inconsistent names ("KTX Python daemon", "KTX local embeddings
daemon", "KTX managed daemon", "Python daemon") with the single name
"KTX daemon" in CLI output, errors, command descriptions, test
assertions, smoke scripts, docs, AGENTS.md, issue templates, and
codecov flags. The daemon is a portable compute server with endpoints
for SQL analysis, semantic layer, LookML, database introspection, and
embeddings; the previous labels misrepresented it as embeddings-only or
exposed implementation details ("Python", "managed").
The "KTX Python runtime" concept (installed interpreter + packages) is
deliberately left as-is — it is a separate concept from the daemon
process.
* refactor(release): drop release-policy.json runtime dep and next branch
Strips the release-policy.json fallback from release-version.ts so the CLI
reads its version straight from packages/cli/package.json. dev → 0.0.0-private,
installed @kaelio/ktx → the real semver baked into the published package.json.
KtxCliPackageInfo collapses to { name, version, contextPackageName }; /health
no longer depends on version files surviving past a CI run.
Replaces the dual-branch (main + next) semantic-release model with a single-
branch model on main. rcs and stables interleave on the same branch via
{ name: 'main', prerelease: 'rc', channel: 'next' } / ['main']. Drops
@semantic-release/git and @semantic-release/changelog (nothing is committed
back to the repo on any channel) and the workflow's "Prepare next prerelease
branch" step plus the KTX_PRERELEASE_BRANCH plumbing. The git tag plus the
published npm artifact carry the version forward.
Updates docs/release.md, removes the two now-unused devDeps, regenerates
pnpm-lock.yaml. 611/611 @ktx/cli tests, 173/173 script tests, type-check,
biome, knip all clean.
* fix(release): don't throw on non-main branches at config-load time
knip loads .releaserc.cjs on every PR run, where GITHUB_REF_NAME is the
merge ref (e.g. 180/merge). The previous version of releaseBranches threw
immediately when the branch wasn't main, which made knip fail to evaluate
the config and then mis-flag @semantic-release/exec as an unused dep.
semantic-release already refuses to publish when the current branch doesn't
match a configured release branch, so the explicit throw was redundant.
Drop it (and the unused currentBranch helper) and replace the
"rejects releases from non-main" assertion with one that exercises a CI-
shaped GITHUB_REF_NAME and confirms the config loads.
216 lines
8.3 KiB
TypeScript
216 lines
8.3 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; projectDir: string; feature: KtxRuntimeFeature; force: boolean }
|
|
| { command: 'stop'; cliVersion: string; projectDir: string; all: boolean }
|
|
| { command: 'status'; cliVersion: string; json: boolean };
|
|
|
|
export interface KtxRuntimeDeps {
|
|
installRuntime?: (options: ManagedPythonRuntimeInstallOptions) => Promise<ManagedPythonRuntimeInstallResult>;
|
|
startDaemon?: (options: {
|
|
cliVersion: string;
|
|
projectDir: string;
|
|
features: KtxRuntimeFeature[];
|
|
force?: boolean;
|
|
}) => Promise<ManagedPythonDaemonStartResult>;
|
|
stopDaemon?: (options: { cliVersion: string; projectDir: string }) => Promise<ManagedPythonDaemonStopResult>;
|
|
stopAllDaemons?: (options: { cliVersion: string; projectDir: 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 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 daemon already stopped\n');
|
|
return;
|
|
}
|
|
io.stdout.write('Stopped KTX 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 daemons found\n');
|
|
return 0;
|
|
}
|
|
if (failed === 0) {
|
|
io.stdout.write(`Stopped ${result.stopped.length} KTX 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 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,
|
|
projectDir: args.projectDir,
|
|
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, projectDir: args.projectDir });
|
|
return writeDaemonStopAll(io, result);
|
|
} else {
|
|
const stopDaemon = deps.stopDaemon ?? stopManagedPythonDaemon;
|
|
const result = await stopDaemon({ cliVersion: args.cliVersion, projectDir: args.projectDir });
|
|
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;
|
|
}
|
|
}
|