mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-19 08:28:06 +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.
299 lines
9.4 KiB
TypeScript
299 lines
9.4 KiB
TypeScript
import { execFile } from 'node:child_process';
|
|
import { mkdir, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises';
|
|
import { tmpdir } from 'node:os';
|
|
import { join, resolve } from 'node:path';
|
|
import { promisify } from 'node:util';
|
|
import { parseKtxProjectConfig } from './context/project/config.js';
|
|
import Database from 'better-sqlite3';
|
|
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
|
|
|
|
const execFileAsync = promisify(execFile);
|
|
const CLI_BIN = resolve(process.cwd(), 'dist/bin.js');
|
|
|
|
interface CliResult {
|
|
code: number;
|
|
stdout: string;
|
|
stderr: string;
|
|
}
|
|
|
|
interface ExecFailure extends Error {
|
|
code?: number;
|
|
stdout?: string;
|
|
stderr?: string;
|
|
}
|
|
|
|
function isExecFailure(error: unknown): error is ExecFailure {
|
|
return error instanceof Error && ('stdout' in error || 'stderr' in error || 'code' in error);
|
|
}
|
|
|
|
async function runBuiltCli(args: string[], options: { cwd?: string; env?: NodeJS.ProcessEnv } = {}): Promise<CliResult> {
|
|
try {
|
|
const result = await execFileAsync(process.execPath, [CLI_BIN, ...args], {
|
|
...(options.cwd ? { cwd: options.cwd } : {}),
|
|
encoding: 'utf8',
|
|
timeout: 20_000,
|
|
env: options.env ?? process.env,
|
|
});
|
|
return {
|
|
code: 0,
|
|
stdout: result.stdout,
|
|
stderr: result.stderr,
|
|
};
|
|
} catch (error) {
|
|
if (!isExecFailure(error)) {
|
|
throw error;
|
|
}
|
|
return {
|
|
code: typeof error.code === 'number' ? error.code : 1,
|
|
stdout: error.stdout ?? '',
|
|
stderr: error.stderr ?? error.message,
|
|
};
|
|
}
|
|
}
|
|
|
|
function createSqliteWarehouse(dbPath: string): void {
|
|
const db = new Database(dbPath);
|
|
try {
|
|
db.exec(`
|
|
PRAGMA foreign_keys = ON;
|
|
CREATE TABLE customers (
|
|
id INTEGER PRIMARY KEY,
|
|
name TEXT NOT NULL
|
|
);
|
|
CREATE TABLE orders (
|
|
id INTEGER PRIMARY KEY,
|
|
customer_id INTEGER NOT NULL,
|
|
total NUMERIC,
|
|
created_at TEXT,
|
|
FOREIGN KEY(customer_id) REFERENCES customers(id)
|
|
);
|
|
INSERT INTO customers (id, name) VALUES (1, 'Ada'), (2, 'Grace');
|
|
INSERT INTO orders (id, customer_id, total, created_at)
|
|
VALUES (10, 1, 42.5, '2026-04-28'), (11, 2, 9.5, '2026-04-29');
|
|
`);
|
|
} finally {
|
|
db.close();
|
|
}
|
|
}
|
|
|
|
async function writeSqliteScanConfig(projectDir: string, dbPath: string, enrich = false): Promise<void> {
|
|
await writeFile(
|
|
join(projectDir, 'ktx.yaml'),
|
|
[
|
|
'connections:',
|
|
' warehouse:',
|
|
' driver: sqlite',
|
|
` path: ${JSON.stringify(dbPath)}`,
|
|
'ingest:',
|
|
' adapters:',
|
|
' - live-database',
|
|
...(enrich
|
|
? [
|
|
'scan:',
|
|
' enrichment:',
|
|
' mode: deterministic',
|
|
' embeddings:',
|
|
' backend: none',
|
|
' dimensions: 6',
|
|
]
|
|
: []),
|
|
'',
|
|
].join('\n'),
|
|
'utf-8',
|
|
);
|
|
}
|
|
|
|
function expectProjectStderr(result: CliResult, projectDir: string): void {
|
|
expect(result).toMatchObject({ code: 0, stderr: `Project: ${projectDir}\n` });
|
|
}
|
|
|
|
function expectSetupStderr(result: CliResult): void {
|
|
expect(result).toMatchObject({ code: 0, stderr: '' });
|
|
}
|
|
|
|
async function runSetupNewProject(projectDir: string): Promise<CliResult> {
|
|
return await runBuiltCli([
|
|
'setup',
|
|
'--project-dir',
|
|
projectDir,
|
|
'--no-input',
|
|
'--yes',
|
|
'--skip-llm',
|
|
'--skip-embeddings',
|
|
'--skip-databases',
|
|
'--skip-sources',
|
|
'--skip-agents',
|
|
]);
|
|
}
|
|
|
|
describe('standalone built ktx CLI smoke', () => {
|
|
let tempDir: string;
|
|
|
|
beforeEach(async () => {
|
|
tempDir = await mkdtemp(join(tmpdir(), 'ktx-standalone-smoke-'));
|
|
});
|
|
|
|
afterEach(async () => {
|
|
await rm(tempDir, { recursive: true, force: true });
|
|
});
|
|
|
|
it('rejects old low-level ingest flags through the built binary', async () => {
|
|
const projectDir = join(tempDir, 'project');
|
|
|
|
const init = await runSetupNewProject(projectDir);
|
|
expectSetupStderr(init);
|
|
expect(init.stdout).toContain(`Project: ${projectDir}`);
|
|
|
|
const reindex = await runBuiltCli(['--project-dir', projectDir, 'admin', 'reindex', '--output', 'plain']);
|
|
expect(reindex.code).toBe(0);
|
|
expect(reindex.stdout).toContain('reindex\t');
|
|
expect(reindex.stderr).toContain('wiki/global');
|
|
|
|
const run = await runBuiltCli([
|
|
'ingest',
|
|
'run',
|
|
'--connection-id',
|
|
'warehouse',
|
|
'--adapter',
|
|
'fake',
|
|
]);
|
|
expect(run).toMatchObject({ code: 1, stdout: '' });
|
|
expect(run.stderr).toContain("unknown option '--adapter'");
|
|
});
|
|
|
|
it('rejects the removed agent command through the built binary', async () => {
|
|
const result = await runBuiltCli(['agent']);
|
|
|
|
expect(result.code).toBe(1);
|
|
expect(result.stdout).toBe('');
|
|
expect(result.stderr).toContain("unknown command 'agent'");
|
|
});
|
|
|
|
it('runs status setup checks through the built binary', async () => {
|
|
const result = await runBuiltCli(['status', '--verbose', '--no-input'], { cwd: tempDir });
|
|
|
|
expect(result.stdout).toMatch(/KTX status/);
|
|
if (result.stdout.includes('No project here yet.')) {
|
|
expect(result.stdout).toContain('ktx setup');
|
|
} else {
|
|
expect(result.stdout).toContain('Node 22+');
|
|
expect(result.stdout).toContain('Workspace-local CLI');
|
|
}
|
|
expect(result.stdout).toContain('Node 22+');
|
|
expect(result.stdout).toContain('Workspace-local CLI');
|
|
expect(result.stderr === '' || result.stderr.startsWith('Project: ')).toBe(true);
|
|
expect([0, 1]).toContain(result.code);
|
|
});
|
|
|
|
it('runs fast public database ingest through the built binary with manifest artifacts', async () => {
|
|
const projectDir = join(tempDir, 'database-ingest-project');
|
|
const init = await runSetupNewProject(projectDir);
|
|
expectSetupStderr(init);
|
|
|
|
const dbPath = join(projectDir, 'warehouse.db');
|
|
createSqliteWarehouse(dbPath);
|
|
await writeSqliteScanConfig(projectDir, dbPath);
|
|
|
|
const connectionTest = await runBuiltCli(['connection', 'test', 'warehouse', '--project-dir', projectDir]);
|
|
expectProjectStderr(connectionTest, projectDir);
|
|
expect(connectionTest.stdout).toContain('Connection test passed: warehouse');
|
|
expect(connectionTest.stdout).toContain('Driver: sqlite');
|
|
expect(connectionTest.stdout).toContain('Status: ok');
|
|
|
|
const ingest = await runBuiltCli(['ingest', 'warehouse', '--project-dir', projectDir, '--fast', '--no-input']);
|
|
expectProjectStderr(ingest, projectDir);
|
|
expect(ingest.stdout).toContain('Ingest finished');
|
|
expect(ingest.stdout).toContain('warehouse');
|
|
expect(ingest.stdout).toContain('Database schema');
|
|
expect(ingest.stdout).toContain('warehouse done');
|
|
expect(ingest.stdout).not.toContain('KTX scan completed');
|
|
|
|
const manifest = await readFile(join(projectDir, 'semantic-layer/warehouse/_schema/public.yaml'), 'utf-8');
|
|
expect(manifest).toContain('customers:');
|
|
expect(manifest).toContain('orders:');
|
|
expect(manifest).toContain('source: formal');
|
|
expect(manifest).not.toContain('ai:');
|
|
}, 30_000);
|
|
|
|
it('parses gateway LLM config and OpenAI enrichment embeddings used by standalone scans without network calls', async () => {
|
|
const projectDir = join(tempDir, 'gateway-config-project');
|
|
await mkdir(projectDir, { recursive: true });
|
|
await writeFile(
|
|
join(projectDir, 'ktx.yaml'),
|
|
[
|
|
'llm:',
|
|
' provider:',
|
|
' backend: gateway',
|
|
' gateway:',
|
|
' api_key: env:AI_GATEWAY_API_KEY', // pragma: allowlist secret
|
|
' models:',
|
|
' default: env:KTX_SCAN_LLM_MODEL',
|
|
'scan:',
|
|
' enrichment:',
|
|
' mode: llm',
|
|
' embeddings:',
|
|
' backend: openai',
|
|
' model: env:KTX_SCAN_EMBEDDING_MODEL',
|
|
' dimensions: 1536',
|
|
' openai:',
|
|
' api_key: env:OPENAI_API_KEY', // pragma: allowlist secret
|
|
' batchSize: 16',
|
|
'',
|
|
].join('\n'),
|
|
'utf8',
|
|
);
|
|
|
|
const config = parseKtxProjectConfig(await readFile(join(projectDir, 'ktx.yaml'), 'utf8'));
|
|
expect(config.llm).toEqual({
|
|
provider: {
|
|
backend: 'gateway',
|
|
gateway: { api_key: 'env:AI_GATEWAY_API_KEY' }, // pragma: allowlist secret
|
|
},
|
|
models: { default: 'env:KTX_SCAN_LLM_MODEL' },
|
|
});
|
|
expect(config.scan.enrichment).toEqual({
|
|
mode: 'llm',
|
|
embeddings: {
|
|
backend: 'openai',
|
|
model: 'env:KTX_SCAN_EMBEDDING_MODEL',
|
|
dimensions: 1536,
|
|
openai: { api_key: 'env:OPENAI_API_KEY' }, // pragma: allowlist secret
|
|
batchSize: 16,
|
|
},
|
|
});
|
|
});
|
|
|
|
it('rejects the removed connection add command through the built binary', async () => {
|
|
const projectDir = join(tempDir, 'notion-project');
|
|
const init = await runSetupNewProject(projectDir);
|
|
expectSetupStderr(init);
|
|
|
|
const add = await runBuiltCli([
|
|
'connection',
|
|
'add',
|
|
'notion',
|
|
'notion-main',
|
|
'--project-dir',
|
|
projectDir,
|
|
'--token-env',
|
|
'NOTION_TOKEN',
|
|
'--crawl-mode',
|
|
'all_accessible',
|
|
'--max-pages',
|
|
'5',
|
|
]);
|
|
|
|
expect(add.code).toBe(1);
|
|
expect(add.stdout).toBe('');
|
|
expect(add.stderr).toMatch(/unknown (command|option)|too many arguments/);
|
|
|
|
const yaml = await readFile(join(projectDir, 'ktx.yaml'), 'utf-8');
|
|
expect(yaml).not.toContain('driver: notion');
|
|
expect(yaml).not.toContain('auth_token_ref: env:NOTION_TOKEN');
|
|
expect(yaml).not.toContain('ntn_');
|
|
|
|
const parsed = parseKtxProjectConfig(yaml);
|
|
expect(parsed.connections['notion-main']).toBeUndefined();
|
|
});
|
|
|
|
});
|