mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +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.
335 lines
11 KiB
JavaScript
335 lines
11 KiB
JavaScript
import assert from 'node:assert/strict';
|
|
import { test } from 'node:test';
|
|
import { runWorkspaceKtx } from './run-ktx.mjs';
|
|
|
|
function freshBuildFs() {
|
|
return {
|
|
stat: async (path) => {
|
|
if (path.endsWith('/.ktx-build-stamp')) {
|
|
return { mtimeMs: 2000, isDirectory: () => false };
|
|
}
|
|
if (path.endsWith('/packages/cli/dist/bin.js')) {
|
|
return { mtimeMs: 2000, isDirectory: () => false };
|
|
}
|
|
return {
|
|
mtimeMs: 1000,
|
|
isDirectory: () => path.endsWith('/src') || path.endsWith('/packages'),
|
|
};
|
|
},
|
|
readdir: async (path) => {
|
|
if (path.endsWith('/packages')) {
|
|
return [{ name: 'cli', isDirectory: () => true }];
|
|
}
|
|
if (path.endsWith('/src')) {
|
|
return [{ name: 'bin.ts', isDirectory: () => false }];
|
|
}
|
|
return [];
|
|
},
|
|
};
|
|
}
|
|
|
|
test('runWorkspaceKtx runs the built CLI when it already exists', async () => {
|
|
const calls = [];
|
|
const logs = [];
|
|
const fs = freshBuildFs();
|
|
|
|
const exitCode = await runWorkspaceKtx(['--version'], {
|
|
rootDir: '/workspace/ktx',
|
|
access: async () => undefined,
|
|
stat: fs.stat,
|
|
readdir: fs.readdir,
|
|
execFile: async (command, args, options) => {
|
|
calls.push({ command, args, cwd: options.cwd });
|
|
return { stdout: '@kaelio/ktx 0.0.0-private\n', stderr: '' };
|
|
},
|
|
stdout: { write: (chunk) => logs.push(['stdout', chunk]) },
|
|
stderr: { write: (chunk) => logs.push(['stderr', chunk]) },
|
|
});
|
|
|
|
assert.equal(exitCode, 0);
|
|
assert.deepEqual(calls, [
|
|
{
|
|
command: process.execPath,
|
|
args: ['/workspace/ktx/packages/cli/dist/bin.js', '--version'],
|
|
cwd: '/workspace/ktx',
|
|
},
|
|
]);
|
|
assert.deepEqual(logs, [['stdout', '@kaelio/ktx 0.0.0-private\n']]);
|
|
});
|
|
|
|
test('runWorkspaceKtx forwards a caller-provided environment to buffered commands', async () => {
|
|
const calls = [];
|
|
const fs = freshBuildFs();
|
|
|
|
const exitCode = await runWorkspaceKtx(['--version'], {
|
|
rootDir: '/workspace/ktx',
|
|
access: async () => undefined,
|
|
stat: fs.stat,
|
|
readdir: fs.readdir,
|
|
env: { PATH: '/bin', GIT_CEILING_DIRECTORIES: '/workspace/ktx/examples' },
|
|
execFile: async (command, args, options) => {
|
|
calls.push({ command, args, cwd: options.cwd, env: options.env });
|
|
return { stdout: '@kaelio/ktx 0.0.0-private\n', stderr: '' };
|
|
},
|
|
stdout: { write: () => undefined },
|
|
stderr: { write: () => undefined },
|
|
});
|
|
|
|
assert.equal(exitCode, 0);
|
|
assert.deepEqual(calls, [
|
|
{
|
|
command: process.execPath,
|
|
args: ['/workspace/ktx/packages/cli/dist/bin.js', '--version'],
|
|
cwd: '/workspace/ktx',
|
|
env: { PATH: '/bin', GIT_CEILING_DIRECTORIES: '/workspace/ktx/examples' },
|
|
},
|
|
]);
|
|
});
|
|
|
|
test('runWorkspaceKtx drops a leading npm argument separator', async () => {
|
|
const calls = [];
|
|
const fs = freshBuildFs();
|
|
|
|
const exitCode = await runWorkspaceKtx(['--', 'connection', 'test', 'warehouse', '--help'], {
|
|
rootDir: '/workspace/ktx',
|
|
access: async () => undefined,
|
|
stat: fs.stat,
|
|
readdir: fs.readdir,
|
|
execFile: async (command, args, options) => {
|
|
calls.push({ command, args, cwd: options.cwd });
|
|
return { stdout: 'Usage: ktx connection test\n', stderr: '' };
|
|
},
|
|
stdout: { write: () => undefined },
|
|
stderr: { write: () => undefined },
|
|
});
|
|
|
|
assert.equal(exitCode, 0);
|
|
assert.deepEqual(calls, [
|
|
{
|
|
command: process.execPath,
|
|
args: ['/workspace/ktx/packages/cli/dist/bin.js', 'connection', 'test', 'warehouse', '--help'],
|
|
cwd: '/workspace/ktx',
|
|
},
|
|
]);
|
|
});
|
|
|
|
test('runWorkspaceKtx builds the workspace CLI before running it when dist is missing', async () => {
|
|
const calls = [];
|
|
const logs = [];
|
|
const writes = [];
|
|
let binExists = false;
|
|
|
|
const exitCode = await runWorkspaceKtx(['setup', 'demo', '--mode', 'replay', '--no-input', '--viz'], {
|
|
rootDir: '/workspace/ktx',
|
|
access: async () => {
|
|
if (!binExists) {
|
|
throw Object.assign(new Error('missing'), { code: 'ENOENT' });
|
|
}
|
|
},
|
|
execFile: async (command, args, options) => {
|
|
calls.push({ command, args, cwd: options.cwd });
|
|
if (command === 'pnpm') {
|
|
binExists = true;
|
|
return { stdout: 'build ok\n', stderr: '' };
|
|
}
|
|
return { stdout: 'Replay complete\n', stderr: '' };
|
|
},
|
|
writeFile: async (path, contents) => {
|
|
writes.push({ path, contents });
|
|
},
|
|
stdout: { write: (chunk) => logs.push(['stdout', chunk]) },
|
|
stderr: { write: (chunk) => logs.push(['stderr', chunk]) },
|
|
});
|
|
|
|
assert.equal(exitCode, 0);
|
|
assert.deepEqual(
|
|
calls.map((call) => [call.command, call.args]),
|
|
[
|
|
['pnpm', ['run', 'build']],
|
|
[
|
|
process.execPath,
|
|
['/workspace/ktx/packages/cli/dist/bin.js', 'setup', 'demo', '--mode', 'replay', '--no-input', '--viz'],
|
|
],
|
|
],
|
|
);
|
|
assert.deepEqual(logs, [
|
|
['stderr', 'KTX CLI build output is missing. Building it now with `pnpm run build`...\n'],
|
|
['stdout', 'build ok\n'],
|
|
['stdout', 'Replay complete\n'],
|
|
]);
|
|
assert.deepEqual(writes, [
|
|
{ path: '/workspace/ktx/packages/cli/dist/.ktx-build-stamp', contents: '' },
|
|
]);
|
|
});
|
|
|
|
test('runWorkspaceKtx rebuilds before running when workspace sources are newer than the build stamp', async () => {
|
|
const calls = [];
|
|
const logs = [];
|
|
const writes = [];
|
|
let sourceMtimeMs = 3000;
|
|
|
|
const exitCode = await runWorkspaceKtx(['status', '--json', '--no-input'], {
|
|
rootDir: '/workspace/ktx',
|
|
access: async () => undefined,
|
|
stat: async (path) => {
|
|
if (path.endsWith('/.ktx-build-stamp')) {
|
|
return { mtimeMs: 2000, isDirectory: () => false };
|
|
}
|
|
if (path.endsWith('/packages/cli/dist/bin.js')) {
|
|
return { mtimeMs: 2000, isDirectory: () => false };
|
|
}
|
|
return {
|
|
mtimeMs: sourceMtimeMs,
|
|
isDirectory: () => path.endsWith('/src') || path.endsWith('/packages'),
|
|
};
|
|
},
|
|
readdir: async (path) => {
|
|
if (path.endsWith('/packages')) {
|
|
return [{ name: 'context', isDirectory: () => true }];
|
|
}
|
|
if (path.endsWith('/src')) {
|
|
return [{ name: 'scan.ts', isDirectory: () => false }];
|
|
}
|
|
return [];
|
|
},
|
|
execFile: async (command, args, options) => {
|
|
calls.push({ command, args, cwd: options.cwd });
|
|
if (command === 'pnpm') {
|
|
sourceMtimeMs = 1000;
|
|
return { stdout: 'build ok\n', stderr: '' };
|
|
}
|
|
return { stdout: '{"status":"ready"}\n', stderr: '' };
|
|
},
|
|
writeFile: async (path, contents) => {
|
|
writes.push({ path, contents });
|
|
},
|
|
stdout: { write: (chunk) => logs.push(['stdout', chunk]) },
|
|
stderr: { write: (chunk) => logs.push(['stderr', chunk]) },
|
|
});
|
|
|
|
assert.equal(exitCode, 0);
|
|
assert.deepEqual(
|
|
calls.map((call) => [call.command, call.args]),
|
|
[
|
|
['pnpm', ['run', 'build']],
|
|
[process.execPath, ['/workspace/ktx/packages/cli/dist/bin.js', 'status', '--json', '--no-input']],
|
|
],
|
|
);
|
|
assert.deepEqual(logs, [
|
|
['stderr', 'KTX CLI build output is stale. Rebuilding it now with `pnpm run build`...\n'],
|
|
['stdout', 'build ok\n'],
|
|
['stdout', '{"status":"ready"}\n'],
|
|
]);
|
|
assert.deepEqual(writes, [
|
|
{ path: '/workspace/ktx/packages/cli/dist/.ktx-build-stamp', contents: '' },
|
|
]);
|
|
});
|
|
|
|
test('runWorkspaceKtx skips rebuild when only bin.js is older than sources but stamp is fresh', async () => {
|
|
const calls = [];
|
|
const logs = [];
|
|
const writes = [];
|
|
|
|
const exitCode = await runWorkspaceKtx(['status'], {
|
|
rootDir: '/workspace/ktx',
|
|
access: async () => undefined,
|
|
stat: async (path) => {
|
|
if (path.endsWith('/.ktx-build-stamp')) {
|
|
return { mtimeMs: 5000, isDirectory: () => false };
|
|
}
|
|
if (path.endsWith('/packages/cli/dist/bin.js')) {
|
|
return { mtimeMs: 1000, isDirectory: () => false };
|
|
}
|
|
return {
|
|
mtimeMs: 3000,
|
|
isDirectory: () => path.endsWith('/src') || path.endsWith('/packages'),
|
|
};
|
|
},
|
|
readdir: async (path) => {
|
|
if (path.endsWith('/packages')) {
|
|
return [{ name: 'cli', isDirectory: () => true }];
|
|
}
|
|
if (path.endsWith('/src')) {
|
|
return [{ name: 'setup.ts', isDirectory: () => false }];
|
|
}
|
|
return [];
|
|
},
|
|
execFile: async (command, args, options) => {
|
|
calls.push({ command, args, cwd: options.cwd });
|
|
return { stdout: 'KTX status\n', stderr: '' };
|
|
},
|
|
writeFile: async (path, contents) => {
|
|
writes.push({ path, contents });
|
|
},
|
|
stdout: { write: (chunk) => logs.push(['stdout', chunk]) },
|
|
stderr: { write: (chunk) => logs.push(['stderr', chunk]) },
|
|
});
|
|
|
|
assert.equal(exitCode, 0);
|
|
assert.deepEqual(
|
|
calls.map((call) => [call.command, call.args]),
|
|
[[process.execPath, ['/workspace/ktx/packages/cli/dist/bin.js', 'status']]],
|
|
);
|
|
assert.deepEqual(writes, []);
|
|
assert.deepEqual(logs, [['stdout', 'KTX status\n']]);
|
|
});
|
|
|
|
test('runWorkspaceKtx rebuilds when stamp is missing even if bin.js exists', async () => {
|
|
const calls = [];
|
|
const logs = [];
|
|
const writes = [];
|
|
|
|
const exitCode = await runWorkspaceKtx(['status'], {
|
|
rootDir: '/workspace/ktx',
|
|
access: async () => undefined,
|
|
stat: async (path) => {
|
|
if (path.endsWith('/.ktx-build-stamp')) {
|
|
throw Object.assign(new Error('missing'), { code: 'ENOENT' });
|
|
}
|
|
if (path.endsWith('/packages/cli/dist/bin.js')) {
|
|
return { mtimeMs: 2000, isDirectory: () => false };
|
|
}
|
|
return {
|
|
mtimeMs: 1000,
|
|
isDirectory: () => path.endsWith('/src') || path.endsWith('/packages'),
|
|
};
|
|
},
|
|
readdir: async (path) => {
|
|
if (path.endsWith('/packages')) {
|
|
return [{ name: 'cli', isDirectory: () => true }];
|
|
}
|
|
if (path.endsWith('/src')) {
|
|
return [{ name: 'bin.ts', isDirectory: () => false }];
|
|
}
|
|
return [];
|
|
},
|
|
execFile: async (command, args, options) => {
|
|
calls.push({ command, args, cwd: options.cwd });
|
|
if (command === 'pnpm') {
|
|
return { stdout: 'build ok\n', stderr: '' };
|
|
}
|
|
return { stdout: 'KTX status\n', stderr: '' };
|
|
},
|
|
writeFile: async (path, contents) => {
|
|
writes.push({ path, contents });
|
|
},
|
|
stdout: { write: (chunk) => logs.push(['stdout', chunk]) },
|
|
stderr: { write: (chunk) => logs.push(['stderr', chunk]) },
|
|
});
|
|
|
|
assert.equal(exitCode, 0);
|
|
assert.deepEqual(
|
|
calls.map((call) => [call.command, call.args]),
|
|
[
|
|
['pnpm', ['run', 'build']],
|
|
[process.execPath, ['/workspace/ktx/packages/cli/dist/bin.js', 'status']],
|
|
],
|
|
);
|
|
assert.deepEqual(logs[0], [
|
|
'stderr',
|
|
'KTX CLI build output is stale. Rebuilding it now with `pnpm run build`...\n',
|
|
]);
|
|
assert.deepEqual(writes, [
|
|
{ path: '/workspace/ktx/packages/cli/dist/.ktx-build-stamp', contents: '' },
|
|
]);
|
|
});
|