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.
167 lines
6.6 KiB
JavaScript
167 lines
6.6 KiB
JavaScript
import assert from 'node:assert/strict';
|
|
import { describe, it } from 'node:test';
|
|
|
|
import { scanFileContent } from './check-boundaries.mjs';
|
|
|
|
function productName() {
|
|
return ['Kae', 'lio'].join('');
|
|
}
|
|
|
|
function lowerProductName() {
|
|
return ['kae', 'lio'].join('');
|
|
}
|
|
|
|
describe('scanFileContent', () => {
|
|
it('rejects source imports from application directories', () => {
|
|
const serverAlias = '@' + 'server/contracts';
|
|
const pythonAppPath = `${['python', 'service'].join('-')}/app/api/endpoints/semantic_layer.py`;
|
|
|
|
const violations = [
|
|
...scanFileContent('packages/cli/src/context/index.ts', `import { orpc } from '${serverAlias}';`),
|
|
...scanFileContent('packages/cli/src/context/index.ts', `import "${pythonAppPath}";`),
|
|
];
|
|
|
|
assert.deepEqual(
|
|
violations.map((violation) => violation.kind),
|
|
['app-import', 'app-import'],
|
|
);
|
|
});
|
|
|
|
it('rejects forbidden product identifiers in code source files', () => {
|
|
const violations = scanFileContent('packages/cli/src/context/index.ts', `export const owner = '${lowerProductName()}';`);
|
|
|
|
assert.equal(violations.length, 1);
|
|
assert.equal(violations[0]?.kind, 'identifier');
|
|
});
|
|
|
|
it('rejects forbidden product identifiers in shipped runtime prompt assets', () => {
|
|
const violations = scanFileContent(
|
|
'packages/cli/src/prompts/memory_agent_bundle_ingest_work_unit.md',
|
|
`Write output for ${productName()}.`,
|
|
);
|
|
|
|
assert.equal(violations.length, 1);
|
|
assert.equal(violations[0]?.kind, 'identifier');
|
|
assert.equal(violations[0]?.file, 'packages/cli/src/prompts/memory_agent_bundle_ingest_work_unit.md');
|
|
});
|
|
|
|
it('rejects forbidden product identifiers in shipped runtime skill assets', () => {
|
|
const violations = scanFileContent(
|
|
'packages/cli/src/skills/metabase_ingest/SKILL.md',
|
|
`Use ${productName()} project conventions.`,
|
|
);
|
|
|
|
assert.equal(violations.length, 1);
|
|
assert.equal(violations[0]?.kind, 'identifier');
|
|
assert.equal(violations[0]?.file, 'packages/cli/src/skills/metabase_ingest/SKILL.md');
|
|
});
|
|
|
|
it('allows product identifiers in docs, examples, and transition metadata', () => {
|
|
const name = productName();
|
|
|
|
assert.equal(scanFileContent('docs/transition.md', name).length, 0);
|
|
assert.equal(scanFileContent('examples/transition.md', name).length, 0);
|
|
assert.equal(scanFileContent('python/ktx-sl/plans/brainstorm.md', name).length, 0);
|
|
assert.equal(scanFileContent('python/ktx-sl/openspec/specs/semantic-layer/spec.md', name).length, 0);
|
|
});
|
|
|
|
it('allows product identifiers in test fixtures', () => {
|
|
const name = lowerProductName();
|
|
|
|
assert.equal(scanFileContent('packages/cli/src/setup.test.ts', `project: ${name}-dev`).length, 0);
|
|
assert.equal(scanFileContent('packages/cli/src/context/ingest/importer.test.ts', `email: system@${name}.dev`).length, 0);
|
|
assert.equal(scanFileContent('python/ktx-daemon/tests/test_package.py', `${name}-ktx`).length, 0);
|
|
});
|
|
|
|
it('allows public package identifiers in release packaging and managed runtime source', () => {
|
|
const name = lowerProductName();
|
|
|
|
assert.equal(scanFileContent('scripts/local-embeddings-runtime-smoke.mjs', `@${name}/ktx`).length, 0);
|
|
assert.equal(scanFileContent('scripts/package-artifacts.test.mjs', `${name}-ktx`).length, 0);
|
|
assert.equal(scanFileContent('scripts/public-npm-release-metadata.mjs', `@${name}/ktx`).length, 0);
|
|
assert.equal(scanFileContent('scripts/semantic-release-config.cjs', `${name}-ktx-`).length, 0);
|
|
assert.equal(scanFileContent('packages/cli/src/release-version.ts', `@${name}/ktx`).length, 0);
|
|
assert.equal(scanFileContent('packages/cli/src/managed-python-runtime.ts', `${name}_ktx`).length, 0);
|
|
assert.equal(scanFileContent('python/ktx-daemon/src/ktx_daemon/__init__.py', `${name}-ktx`).length, 0);
|
|
});
|
|
|
|
it('allows clean source files and clean runtime prompt assets', () => {
|
|
assert.deepEqual(
|
|
scanFileContent('packages/cli/src/context/index.ts', "export const packageName = 'ktx';"),
|
|
[],
|
|
);
|
|
assert.deepEqual(
|
|
scanFileContent('packages/cli/src/prompts/memory_agent_bundle_ingest_work_unit.md', 'Write output for KTX.'),
|
|
[],
|
|
);
|
|
});
|
|
|
|
it('rejects context-owned LLM provider construction outside llm modules', () => {
|
|
const violations = [
|
|
...scanFileContent(
|
|
'packages/cli/src/context/agent/local-llm-provider.ts',
|
|
"import { createAnthropic } from '@ai-sdk/anthropic';",
|
|
),
|
|
...scanFileContent('packages/cli/src/context/scan/local-ai-gateway-enrichment.ts', "import { createGateway } from 'ai';"),
|
|
...scanFileContent('packages/cli/src/context/core/local-embedding-provider.ts', "import { embedMany } from 'ai';"),
|
|
];
|
|
|
|
assert.deepEqual(
|
|
violations.map((violation) => violation.kind),
|
|
['llm-boundary', 'llm-boundary', 'llm-boundary'],
|
|
);
|
|
});
|
|
|
|
it('rejects old KTX LLM port declarations in context', () => {
|
|
const violations = [
|
|
...scanFileContent('packages/cli/src/context/agent/agent-runner.service.ts', 'export interface LlmProviderPort {}'),
|
|
...scanFileContent('packages/cli/src/context/scan/types.ts', 'export interface KtxScanLlmPort {}'),
|
|
...scanFileContent('packages/cli/src/context/agent/gateway-llm-provider.ts', 'export function createGatewayLlmProvider() {}'),
|
|
];
|
|
|
|
assert.deepEqual(
|
|
violations.map((violation) => violation.kind),
|
|
['llm-boundary', 'llm-boundary', 'llm-boundary'],
|
|
);
|
|
});
|
|
|
|
it('rejects getModelByName calls in context production source', () => {
|
|
const violations = scanFileContent(
|
|
'packages/cli/src/context/ingest/page-triage/page-triage.service.ts',
|
|
"const model = this.deps.llmProvider.getModelByName('claude-sonnet-4-6');",
|
|
);
|
|
|
|
assert.equal(violations.length, 1);
|
|
assert.equal(violations[0]?.kind, 'llm-boundary');
|
|
assert.equal(
|
|
violations[0]?.message,
|
|
'Forbidden context getModelByName call; use getModel(role) inside context modules',
|
|
);
|
|
});
|
|
|
|
it('allows role-driven getModel calls, test calls, and provider shape declarations', () => {
|
|
assert.deepEqual(
|
|
scanFileContent(
|
|
'packages/cli/src/context/ingest/page-triage/page-triage.service.ts',
|
|
"const model = this.deps.llmProvider.getModel('triage');",
|
|
),
|
|
[],
|
|
);
|
|
|
|
assert.deepEqual(
|
|
scanFileContent(
|
|
'packages/cli/src/context/ingest/page-triage/page-triage.service.test.ts',
|
|
"const model = this.deps.llmProvider.getModelByName('test-model');",
|
|
),
|
|
[],
|
|
);
|
|
|
|
assert.deepEqual(
|
|
scanFileContent(
|
|
'packages/cli/src/context/scan/local-enrichment.ts',
|
|
'return { getModel() { return model; }, getModelByName() { return model; } };',
|
|
),
|
|
[],
|
|
);
|
|
});
|
|
});
|