mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-10 08:05:14 +02:00
* refactor(workspace): relocate @ktx/llm source into packages/cli/src/llm * refactor(workspace): rewrite @ktx/llm imports to relative paths * refactor(workspace): fold internal packages into cli * chore(workspace): gate dead-code with knip production mode Turn on production-mode knip plus an autofix run in pre-commit and the `pnpm dead-code` script, document the `/** @internal */` convention for test-only exports in AGENTS.md, annotate test-only exports across the CLI with that JSDoc, and drop dead exports/wrappers the new gate surfaced (e.g. `cli-project.ts`, `lookerRuntimeSourceToFileAdapterSource`, `createLocalScanEnrichmentProvidersFromConfig`, `PGLITE_OWNER_PROCESS_BACKEND_CAPABILITIES`, stale type re-exports). Replace the loose `ignoreIssues` allowlist in `knip.json` with explicit production entries so cross-package barrel leaks are caught. * refactor(cli): delete internal barrel index.ts files The 34 `index.ts` re-export barrels inside `packages/cli/src/` were holdovers from the pre-fold multi-workspace structure. Post-fold-in they served no production purpose: external consumers go through the single package main entry, and in-repo callers mostly imported through them only because the path was short. Internally, knip flagged most barrel re-exports as production-dead (only reached via tests). This change: - Deletes every internal barrel except `packages/cli/src/index.ts` (the published package entry). - Rewrites ~270 source/test files to import each name directly from the file that defines it. - Moves `tools/warehouse-verification/index.ts` to `create-warehouse-verification-tools.ts` (the function it defined locally) and updates its single consumer. - Renames `search/backend-conformance.ts` → `.test-utils.ts` to match the existing test-helper file convention. - Deletes 13 dead test-only chains (dbt-descriptions/*, live-database/extracted-schema, live-database/structural-sync, relationship-* feedback/review chain) plus their tests and a cascading orphan integration test. - Updates test mocks that pointed at deleted barrel paths (notion-client, connector barrels in scan/local-scan-connectors tests) to mock the source files instead. - Points the maintainer benchmark script (`scripts/relationship-benchmark-report.mjs`) at source files instead of `dist/context/scan/index.js`. - Drops the barrel `!` entries from `knip.json`; adds explicit production entries only for the benchmark code reached via dist by the maintainer script. Net: 413 files changed, ~1.2k insertions, ~9.4k deletions. `pnpm run dead-code` (Biome + knip default + knip production) and `pnpm run type-check` are clean; 2277 tests pass. * refactor(workspace): rename @ktx/cli to @kaelio/ktx and pack it directly Promote the CLI workspace package to the public name `@kaelio/ktx` and drop the separate `scripts/build-public-npm-package.mjs` wrapper. The CLI package is now publishable in place (`publishConfig.access: public`, `provenance: true`), so artifact packing uses `pnpm pack` against `packages/cli/` instead of assembling a parallel package tree. Updates all workspace filter invocations, docs, tests, and release readiness checks to reference the new package name, and folds the tarball-name helper into `scripts/public-npm-release-metadata.mjs`. * docs: align "agent clients" and "data agents" terminology Replace "client agents" with "agent clients" and "database agents" with "data agents" across AGENTS.md, README.md, the docs-site copy, and the matching setup-agents test description, matching the canonical vocabulary in docs/terminology.md. Also moves packages/cli/tsconfig.json's tsBuildInfoFile from node_modules/.cache/ to dist/.tsbuildinfo so incremental builds survive node_modules reinstalls. * refactor(release): single source of truth for package version Make packages/cli/package.json the single source of truth for the @kaelio/ktx version. publicNpmPackageVersion() now reads it directly, so artifact filenames, release-readiness checks, and the Python wheel version all derive from one field. The duplicate release-policy.json.publicNpmPackageVersion is removed. Previously the two fields could drift: tarballs were named kaelio-ktx-0.4.1.tgz while internally containing @kaelio/ktx@0.0.0-private. - update-public-release-version.mjs rewrites both Python pyproject.toml files (ktx-daemon, ktx-sl) alongside the npm package.jsons, normalizing the version for PEP 440 (e.g. 0.1.0-rc.2 -> 0.1.0rc2). - semantic-release-config.cjs adds the two pyproject.toml files to @semantic-release/git assets so the release commit back to main carries every version source in lockstep. - The six "?? '0.0.0-private'" fallback literals across the CLI are replaced with "?? getKtxCliPackageInfo().version", and createDefaultKtxMcpServer makes its version arg required. - docs/release.md describes the actual commit-back model: the dev tree always reflects the most recent release; no sentinel pin to maintain. Verified: pnpm run artifacts:build now produces kaelio-ktx-0.4.1.tgz and kaelio_ktx-0.4.1-py3-none-any.whl with @kaelio/ktx@0.4.1 inside. Full type-check, dead-code, and 2287 vitests + 173 script tests pass. * refactor(cli): inject embedding provider resolution and detect sentence-transformers runtime Make resolveProjectEmbeddingProvider and runtimeIo injectable in ingest and scan command entrypoints so tests can stub them, and teach resolvePublicIngestRuntimeRequirements to flag the local-embeddings runtime feature when ktx.yaml selects sentence-transformers. * chore(cli): mark buildLocalStatsStatus and LocalStatsStatus as @internal Both symbols are consumed only by status-project.test.ts. Annotating with /** @internal */ keeps knip's production-mode check clean without changing runtime behavior. * fix(cli): use real package metadata in print-command-tree The stubbed package name embedded a forbidden product identifier that tripped the boundary check in CI. Read the metadata from package.json instead — keeps the rendered tree unchanged and removes a duplicate source of truth. * feat(cli): show embedding coverage in `ktx status`, drop duplicate disk counts Inline `(N embedded)` next to the Wiki scope counts and Semantic-layer source counts, computed with `SUM(embedding_json IS NOT NULL)` over `knowledge_pages` and `local_sl_sources`. Rename the "Knowledge" label to "Wiki" (canonical per `docs/terminology.md`) and rename the matching `localStats.knowledgePages` field to `localStats.wikiPages`. Drop `wiki=N md` and `semantic-layer=N yaml` from the Disk row — those duplicated the per-surface rows above. Disk now reports only actual byte usage (db, cache, raw-sources). The unused `wikiGlobalMarkdownCount` / `semanticLayerYamlCount` fields, the `isMarkdownEntry` / `isYamlEntry` helpers, and the `filter` arg on `summarizeDir` are removed.
280 lines
10 KiB
TypeScript
280 lines
10 KiB
TypeScript
import { readFile } from 'node:fs/promises';
|
|
import { createDefaultLocalQueryExecutor } from './context/connections/local-query-executor.js';
|
|
import type { KtxSqlQueryExecutorPort } from './context/connections/query-executor.js';
|
|
import { KtxIngestEmbeddingPortAdapter } from './context/llm/embedding-port.js';
|
|
import type { KtxEmbeddingPort } from './context/core/embedding.js';
|
|
import type { KtxSemanticLayerComputePort } from './context/daemon/semantic-layer-compute.js';
|
|
import { loadKtxProject, type KtxLocalProject } from './context/project/project.js';
|
|
import { compileLocalSlQuery } from './context/sl/local-query.js';
|
|
import { listLocalSlSources, readLocalSlSource, searchLocalSlSources as defaultSearchLocalSlSources, validateLocalSlSource, type LocalSlSourceSearchResult, type LocalSlSourceSummary } from './context/sl/local-sl.js';
|
|
import type { SemanticLayerQueryInput } from './context/sl/types.js';
|
|
import {
|
|
resolveProjectEmbeddingProvider,
|
|
type EmbeddingProviderResolution,
|
|
} from './embedding-resolution.js';
|
|
import type { PrintListColumn } from './io/print-list.js';
|
|
import {
|
|
createManagedPythonSemanticLayerComputePort,
|
|
type KtxManagedPythonInstallPolicy,
|
|
} from './managed-python-command.js';
|
|
import { profileMark } from './startup-profile.js';
|
|
|
|
profileMark('module:sl');
|
|
|
|
type SlQueryFormat = 'json' | 'sql';
|
|
|
|
export type KtxSlArgs =
|
|
| {
|
|
command: 'list';
|
|
projectDir: string;
|
|
connectionId?: string;
|
|
output?: string;
|
|
json?: boolean;
|
|
cliVersion: string;
|
|
}
|
|
| {
|
|
command: 'search';
|
|
projectDir: string;
|
|
connectionId?: string;
|
|
query: string;
|
|
limit?: number;
|
|
output?: string;
|
|
json?: boolean;
|
|
cliVersion: string;
|
|
}
|
|
| { command: 'validate'; projectDir: string; connectionId: string; sourceName: string }
|
|
| {
|
|
command: 'query';
|
|
projectDir: string;
|
|
connectionId?: string;
|
|
query?: SemanticLayerQueryInput;
|
|
queryFile?: string;
|
|
format: SlQueryFormat;
|
|
execute: boolean;
|
|
maxRows?: number;
|
|
cliVersion: string;
|
|
runtimeInstallPolicy: KtxManagedPythonInstallPolicy;
|
|
};
|
|
|
|
interface KtxSlIo {
|
|
stdout: { write(chunk: string): void };
|
|
stderr: { write(chunk: string): void };
|
|
}
|
|
|
|
interface KtxSlDeps {
|
|
loadProject?: typeof loadKtxProject;
|
|
resolveEmbeddingProvider?: typeof resolveProjectEmbeddingProvider;
|
|
searchLocalSlSources?: typeof defaultSearchLocalSlSources;
|
|
createSemanticLayerCompute?: () => KtxSemanticLayerComputePort;
|
|
createManagedSemanticLayerCompute?: (options: {
|
|
cliVersion: string;
|
|
installPolicy: KtxManagedPythonInstallPolicy;
|
|
io: KtxSlIo;
|
|
}) => Promise<KtxSemanticLayerComputePort>;
|
|
createQueryExecutor?: () => KtxSqlQueryExecutorPort;
|
|
}
|
|
|
|
function resolutionToEmbeddingPort(resolution: EmbeddingProviderResolution): KtxEmbeddingPort | null {
|
|
if (
|
|
resolution.kind === 'configured' ||
|
|
resolution.kind === 'managed-running' ||
|
|
resolution.kind === 'managed-started'
|
|
) {
|
|
return new KtxIngestEmbeddingPortAdapter(resolution.provider);
|
|
}
|
|
return null;
|
|
}
|
|
|
|
async function printSlSources(input: {
|
|
rows: ReadonlyArray<LocalSlSourceSummary>;
|
|
command: 'sl list';
|
|
output?: string;
|
|
json?: boolean;
|
|
io: KtxSlIo;
|
|
emptyMessage: string;
|
|
emptyHint?: string;
|
|
}): Promise<void>;
|
|
async function printSlSources(input: {
|
|
rows: ReadonlyArray<LocalSlSourceSearchResult>;
|
|
command: 'sl search';
|
|
output?: string;
|
|
json?: boolean;
|
|
io: KtxSlIo;
|
|
emptyMessage: string;
|
|
emptyHint?: string;
|
|
}): Promise<void>;
|
|
async function printSlSources(input: {
|
|
rows: ReadonlyArray<LocalSlSourceSummary | LocalSlSourceSearchResult>;
|
|
command: 'sl list' | 'sl search';
|
|
output?: string;
|
|
json?: boolean;
|
|
io: KtxSlIo;
|
|
emptyMessage: string;
|
|
emptyHint?: string;
|
|
}): Promise<void> {
|
|
const { resolveOutputMode } = await import('./io/mode.js');
|
|
const { createRankBadgeFormatter, printList } = await import('./io/print-list.js');
|
|
const mode = resolveOutputMode({ explicit: input.output, json: input.json, io: input.io });
|
|
|
|
if (input.command === 'sl search') {
|
|
const searchColumns: ReadonlyArray<PrintListColumn<LocalSlSourceSearchResult>> = [
|
|
{
|
|
key: 'score',
|
|
label: 'SCORE',
|
|
plain: 'score=',
|
|
role: 'badge',
|
|
prettyFormat: createRankBadgeFormatter(input.rows as ReadonlyArray<LocalSlSourceSearchResult>),
|
|
dim: true,
|
|
},
|
|
{ key: 'connectionId', label: 'CONNECTION', plain: '' },
|
|
{ key: 'name', label: 'NAME', plain: '' },
|
|
{ key: 'columnCount', label: 'COLS', plain: 'columns=', dim: true },
|
|
{ key: 'measureCount', label: 'MEASURES', plain: 'measures=', dim: true },
|
|
{ key: 'joinCount', label: 'JOINS', plain: 'joins=', dim: true },
|
|
{ key: 'description', label: 'DESCRIPTION', plain: false, optional: true, dim: true },
|
|
];
|
|
printList<LocalSlSourceSearchResult>({
|
|
rows: input.rows as ReadonlyArray<LocalSlSourceSearchResult>,
|
|
columns: searchColumns,
|
|
groupBy: 'connectionId',
|
|
emptyMessage: input.emptyMessage,
|
|
emptyHint: input.emptyHint,
|
|
unit: 'source',
|
|
command: input.command,
|
|
mode,
|
|
io: input.io,
|
|
});
|
|
return;
|
|
}
|
|
|
|
const listColumns: ReadonlyArray<PrintListColumn<LocalSlSourceSummary>> = [
|
|
{ key: 'connectionId', label: 'CONNECTION', plain: '' },
|
|
{ key: 'name', label: 'NAME', plain: '' },
|
|
{ key: 'columnCount', label: 'COLS', plain: 'columns=', dim: true },
|
|
{ key: 'measureCount', label: 'MEASURES', plain: 'measures=', dim: true },
|
|
{ key: 'joinCount', label: 'JOINS', plain: 'joins=', dim: true },
|
|
{ key: 'description', label: 'DESCRIPTION', plain: false, optional: true, dim: true },
|
|
];
|
|
printList<LocalSlSourceSummary>({
|
|
rows: input.rows as ReadonlyArray<LocalSlSourceSummary>,
|
|
columns: listColumns,
|
|
groupBy: 'connectionId',
|
|
emptyMessage: input.emptyMessage,
|
|
emptyHint: input.emptyHint,
|
|
unit: 'source',
|
|
command: input.command,
|
|
mode,
|
|
io: input.io,
|
|
});
|
|
}
|
|
|
|
async function readSlQueryFile(path: string): Promise<SemanticLayerQueryInput> {
|
|
const parsed = JSON.parse(await readFile(path, 'utf-8')) as unknown;
|
|
if (!parsed || typeof parsed !== 'object' || Array.isArray(parsed)) {
|
|
throw new Error(`${path} must contain a JSON object.`);
|
|
}
|
|
return parsed as SemanticLayerQueryInput;
|
|
}
|
|
|
|
export async function runKtxSl(args: KtxSlArgs, io: KtxSlIo = process, deps: KtxSlDeps = {}): Promise<number> {
|
|
try {
|
|
const project = await (deps.loadProject ?? loadKtxProject)({ projectDir: args.projectDir });
|
|
if (args.command === 'list') {
|
|
const sources = await listLocalSlSources(project, { connectionId: args.connectionId });
|
|
await printSlSources({
|
|
rows: sources,
|
|
emptyMessage: `No semantic-layer sources found in ${project.projectDir}`,
|
|
command: 'sl list',
|
|
output: args.output,
|
|
json: args.json,
|
|
io,
|
|
});
|
|
return 0;
|
|
}
|
|
if (args.command === 'search') {
|
|
const resolver = deps.resolveEmbeddingProvider ?? resolveProjectEmbeddingProvider;
|
|
const resolution = await resolver(project, {
|
|
mode: 'use-if-running',
|
|
cliVersion: args.cliVersion,
|
|
io,
|
|
});
|
|
const embeddingService = resolutionToEmbeddingPort(resolution);
|
|
const search = deps.searchLocalSlSources ?? defaultSearchLocalSlSources;
|
|
const sources = await search(project, {
|
|
connectionId: args.connectionId,
|
|
query: args.query,
|
|
embeddingService,
|
|
limit: args.limit,
|
|
});
|
|
if (sources.length === 0 && resolution.kind === 'managed-unavailable' && !args.json) {
|
|
const { SYMBOLS } = await import('./io/symbols.js');
|
|
io.stderr.write(`embeddings: unavailable ${SYMBOLS.emDash} ${resolution.reason}\n`);
|
|
}
|
|
await printSlSources({
|
|
rows: sources,
|
|
emptyMessage: `No semantic-layer sources matched "${args.query}" in ${project.projectDir}`,
|
|
emptyHint: 'Run `ktx sl` to inspect available sources.',
|
|
command: 'sl search',
|
|
output: args.output,
|
|
json: args.json,
|
|
io,
|
|
});
|
|
return 0;
|
|
}
|
|
if (args.command === 'validate') {
|
|
const source = await readLocalSlSource(project, {
|
|
connectionId: args.connectionId,
|
|
sourceName: args.sourceName,
|
|
});
|
|
if (!source) {
|
|
throw new Error(`Semantic-layer source "${args.connectionId}/${args.sourceName}" was not found`);
|
|
}
|
|
const result = await validateLocalSlSource(source.yaml, {
|
|
project,
|
|
connectionId: args.connectionId,
|
|
sourceName: args.sourceName,
|
|
});
|
|
if (!result.valid) {
|
|
for (const error of result.errors) {
|
|
io.stderr.write(`${error}\n`);
|
|
}
|
|
return 1;
|
|
}
|
|
io.stdout.write(`Valid semantic-layer source: ${args.connectionId}/${args.sourceName}\n`);
|
|
return 0;
|
|
}
|
|
if (args.command === 'query') {
|
|
const query = args.query ?? (args.queryFile ? await readSlQueryFile(args.queryFile) : undefined);
|
|
if (!query) {
|
|
throw new Error('sl query requires query input from --query-file or at least one --measure');
|
|
}
|
|
const compute = deps.createSemanticLayerCompute
|
|
? deps.createSemanticLayerCompute()
|
|
: await (deps.createManagedSemanticLayerCompute ?? createManagedPythonSemanticLayerComputePort)({
|
|
cliVersion: args.cliVersion,
|
|
installPolicy: args.runtimeInstallPolicy,
|
|
io,
|
|
});
|
|
const queryExecutor = args.execute ? (deps.createQueryExecutor ?? createDefaultLocalQueryExecutor)() : undefined;
|
|
const result = await compileLocalSlQuery(project as KtxLocalProject, {
|
|
connectionId: args.connectionId,
|
|
query,
|
|
compute,
|
|
execute: args.execute,
|
|
maxRows: args.maxRows,
|
|
queryExecutor,
|
|
});
|
|
if (args.format === 'sql') {
|
|
io.stdout.write(`${result.sql}\n`);
|
|
return 0;
|
|
}
|
|
io.stdout.write(`${JSON.stringify(result, null, 2)}\n`);
|
|
return 0;
|
|
}
|
|
const _exhaustive: never = args;
|
|
throw new Error(`Unsupported sl command: ${JSON.stringify(_exhaustive)}`);
|
|
} catch (error) {
|
|
io.stderr.write(`${error instanceof Error ? error.message : String(error)}\n`);
|
|
return 1;
|
|
}
|
|
}
|