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.
197 lines
6.5 KiB
TypeScript
197 lines
6.5 KiB
TypeScript
import { beforeEach, describe, expect, it, vi } from 'vitest';
|
|
import { createDefaultKtxMcpServer } from './context/mcp/server.js';
|
|
import { createLocalProjectMcpContextPorts } from './context/mcp/local-project-ports.js';
|
|
import { createLocalProjectMemoryIngest } from './context/memory/local-memory.js';
|
|
import { resolveProjectEmbeddingProvider } from './embedding-resolution.js';
|
|
import { createKtxCliScanConnector } from './local-scan-connectors.js';
|
|
import { createKtxMcpServerFactory } from './mcp-server-factory.js';
|
|
|
|
type FakeEmbeddingProvider = {
|
|
maxBatchSize: number;
|
|
embed(text: string): Promise<number[]>;
|
|
embedMany(texts: string[]): Promise<number[][]>;
|
|
};
|
|
|
|
const mocks = vi.hoisted(() => ({
|
|
queryExecutor: { execute: vi.fn() },
|
|
semanticLayerCompute: { validateSources: vi.fn(), generateSources: vi.fn(), query: vi.fn() },
|
|
sqlAnalysis: { analyzeForFingerprint: vi.fn(), analyzeBatch: vi.fn(), validateReadOnly: vi.fn() },
|
|
memoryIngest: { ingest: vi.fn(), status: vi.fn(), waitForRun: vi.fn() },
|
|
}));
|
|
|
|
vi.mock('./context/llm/embedding-port.js', () => ({
|
|
KtxIngestEmbeddingPortAdapter: class {
|
|
readonly maxBatchSize: number;
|
|
|
|
constructor(private readonly provider: FakeEmbeddingProvider) {
|
|
this.maxBatchSize = provider.maxBatchSize;
|
|
}
|
|
|
|
computeEmbedding(text: string): Promise<number[]> {
|
|
return this.provider.embed(text);
|
|
}
|
|
|
|
computeEmbeddingsBulk(texts: string[]): Promise<number[][]> {
|
|
return this.provider.embedMany(texts);
|
|
}
|
|
},
|
|
}));
|
|
|
|
vi.mock('./context/mcp/server.js', () => ({
|
|
createDefaultKtxMcpServer: vi.fn(() => ({ kind: 'mcp-server' })),
|
|
}));
|
|
|
|
vi.mock('./context/mcp/local-project-ports.js', () => ({
|
|
createLocalProjectMcpContextPorts: vi.fn(() => ({ context_tool: { name: 'context_tool' } })),
|
|
}));
|
|
|
|
vi.mock('./context/memory/local-memory.js', () => ({
|
|
createLocalProjectMemoryIngest: vi.fn(() => mocks.memoryIngest),
|
|
}));
|
|
|
|
vi.mock('./embedding-resolution.js', () => ({
|
|
resolveProjectEmbeddingProvider: vi.fn(),
|
|
}));
|
|
|
|
vi.mock('./ingest-query-executor.js', () => ({
|
|
createKtxCliIngestQueryExecutor: vi.fn(() => mocks.queryExecutor),
|
|
}));
|
|
|
|
vi.mock('./local-scan-connectors.js', () => ({
|
|
createKtxCliScanConnector: vi.fn(() => ({ source: 'fake-scan-connector' })),
|
|
}));
|
|
|
|
vi.mock('./managed-python-command.js', () => ({
|
|
createManagedPythonSemanticLayerComputePort: vi.fn(async () => mocks.semanticLayerCompute),
|
|
}));
|
|
|
|
vi.mock('./managed-python-http.js', () => ({
|
|
createManagedDaemonSqlAnalysisPort: vi.fn(() => mocks.sqlAnalysis),
|
|
}));
|
|
|
|
const project = {
|
|
projectDir: '/work/project',
|
|
configPath: '/work/project/ktx.yaml',
|
|
config: {},
|
|
coreConfig: {},
|
|
git: {},
|
|
fileStore: {},
|
|
};
|
|
|
|
const io = {
|
|
stdout: { write: vi.fn() },
|
|
stderr: { write: vi.fn() },
|
|
};
|
|
|
|
describe('createKtxMcpServerFactory', () => {
|
|
beforeEach(() => {
|
|
vi.clearAllMocks();
|
|
});
|
|
|
|
it('passes a resolved embedding provider to MCP context ports and memory ingest', async () => {
|
|
const provider = {
|
|
maxBatchSize: 4,
|
|
embed: vi.fn(async () => [0.2, 0.4]),
|
|
embedMany: vi.fn(async () => [[0.2, 0.4]]),
|
|
};
|
|
vi.mocked(resolveProjectEmbeddingProvider).mockResolvedValue({ kind: 'configured', provider } as never);
|
|
|
|
const factory = await createKtxMcpServerFactory({
|
|
project: project as never,
|
|
projectDir: project.projectDir,
|
|
cliVersion: '0.5.0',
|
|
io,
|
|
});
|
|
|
|
const contextOptions = vi.mocked(createLocalProjectMcpContextPorts).mock.calls[0][1] as {
|
|
embeddingService: {
|
|
computeEmbedding(text: string): Promise<number[]>;
|
|
computeEmbeddingsBulk(texts: string[]): Promise<number[][]>;
|
|
};
|
|
queryExecutor: unknown;
|
|
semanticLayerCompute: unknown;
|
|
sqlAnalysis: unknown;
|
|
localScan: {
|
|
createConnector(connectionId: string): Promise<unknown>;
|
|
};
|
|
};
|
|
await expect(contextOptions.embeddingService.computeEmbedding('gross revenue')).resolves.toEqual([0.2, 0.4]);
|
|
await expect(contextOptions.embeddingService.computeEmbeddingsBulk(['gross revenue'])).resolves.toEqual([[0.2, 0.4]]);
|
|
await expect(contextOptions.localScan.createConnector('warehouse')).resolves.toEqual({
|
|
source: 'fake-scan-connector',
|
|
});
|
|
|
|
expect(provider.embed).toHaveBeenCalledWith('gross revenue');
|
|
expect(provider.embedMany).toHaveBeenCalledWith(['gross revenue']);
|
|
expect(createKtxCliScanConnector).toHaveBeenCalledWith(project, 'warehouse');
|
|
expect(contextOptions).toMatchObject({
|
|
queryExecutor: mocks.queryExecutor,
|
|
semanticLayerCompute: mocks.semanticLayerCompute,
|
|
sqlAnalysis: mocks.sqlAnalysis,
|
|
});
|
|
expect(createLocalProjectMemoryIngest).toHaveBeenCalledWith(
|
|
project,
|
|
expect.objectContaining({
|
|
embeddingProvider: provider,
|
|
queryExecutor: mocks.queryExecutor,
|
|
semanticLayerCompute: mocks.semanticLayerCompute,
|
|
}),
|
|
);
|
|
|
|
expect(factory()).toEqual({ kind: 'mcp-server' });
|
|
expect(createDefaultKtxMcpServer).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
contextTools: expect.objectContaining({
|
|
context_tool: { name: 'context_tool' },
|
|
memoryIngest: mocks.memoryIngest,
|
|
}),
|
|
}),
|
|
);
|
|
});
|
|
|
|
it('uses null embedding ports when no configured provider is available', async () => {
|
|
vi.mocked(resolveProjectEmbeddingProvider).mockResolvedValue({ kind: 'managed-unavailable' } as never);
|
|
|
|
await createKtxMcpServerFactory({
|
|
project: project as never,
|
|
projectDir: project.projectDir,
|
|
cliVersion: '0.5.0',
|
|
io,
|
|
});
|
|
|
|
expect(vi.mocked(createLocalProjectMcpContextPorts).mock.calls[0][1]).toMatchObject({
|
|
embeddingService: null,
|
|
});
|
|
expect(createLocalProjectMemoryIngest).toHaveBeenCalledWith(
|
|
project,
|
|
expect.objectContaining({
|
|
embeddingProvider: null,
|
|
}),
|
|
);
|
|
});
|
|
|
|
it('omits memory ingest and logs when memory ingest construction fails', async () => {
|
|
vi.mocked(resolveProjectEmbeddingProvider).mockResolvedValue({ kind: 'disabled' } as never);
|
|
vi.mocked(createLocalProjectMemoryIngest).mockImplementationOnce(() => {
|
|
throw new Error('missing local memory prerequisites');
|
|
});
|
|
|
|
const factory = await createKtxMcpServerFactory({
|
|
project: project as never,
|
|
projectDir: project.projectDir,
|
|
cliVersion: '0.5.0',
|
|
io,
|
|
});
|
|
|
|
factory();
|
|
|
|
expect(io.stderr.write).toHaveBeenCalledWith(
|
|
'KTX MCP memory_ingest disabled: missing local memory prerequisites\n',
|
|
);
|
|
expect(createDefaultKtxMcpServer).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
contextTools: { context_tool: { name: 'context_tool' } },
|
|
}),
|
|
);
|
|
});
|
|
});
|