2026-05-10 23:12:26 +02:00
import { mkdir , mkdtemp , rm , writeFile } from 'node:fs/promises' ;
import { tmpdir } from 'node:os' ;
import { join } from 'node:path' ;
chore(workspace): gate dead-code with knip production mode (#196)
* 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.
2026-05-21 15:28:58 +02:00
import type { AgentRunnerPort } from '../../context/llm/runtime-port.js' ;
import { initKtxProject , type KtxLocalProject , loadKtxProject } from '../../context/project/project.js' ;
2026-05-13 13:43:23 +02:00
import { afterEach , beforeEach , describe , expect , it , vi } from 'vitest' ;
2026-05-10 23:12:26 +02:00
import { FakeSourceAdapter } from './adapters/fake/fake.adapter.js' ;
import { createLocalBundleIngestRuntime } from './local-bundle-runtime.js' ;
type RuntimeWithConnectionDeps = {
deps : {
connections : {
listEnabledConnections ( ids : string [ ] ) : Promise < Array < { id : string ; name : string ; connectionType : string } > > ;
getConnectionById ( connectionId : string ) : Promise < { id : string ; name : string ; connectionType : string } | null > ;
2026-05-13 13:43:23 +02:00
executeQuery ( connectionId : string , sql : string ) : Promise < unknown > ;
2026-05-10 23:12:26 +02:00
} ;
} ;
} ;
2026-05-18 13:38:06 +02:00
type RuntimeWithSlValidationDeps = {
deps : {
slValidator : {
validateSingleSource (
deps : unknown ,
connectionId : string ,
sourceName : string ,
) : Promise < { errors : string [ ] ; warnings : string [ ] } > ;
} ;
} ;
} ;
type RuntimeWithSettingsDeps = {
deps : {
settings : Record < string , unknown > ;
} ;
} ;
2026-05-16 12:06:34 +02:00
function testAgentRunner ( ) : AgentRunnerPort {
return { runLoop : vi.fn ( ) . mockResolvedValue ( { stopReason : 'natural' as const } ) } ;
}
2026-05-10 23:12:26 +02:00
describe ( 'createLocalBundleIngestRuntime' , ( ) = > {
let tempDir : string ;
2026-05-10 23:51:24 +02:00
let project : KtxLocalProject ;
2026-05-10 23:12:26 +02:00
beforeEach ( async ( ) = > {
2026-05-10 23:51:24 +02:00
tempDir = await mkdtemp ( join ( tmpdir ( ) , 'ktx-local-bundle-runtime-' ) ) ;
2026-05-10 23:12:26 +02:00
const projectDir = join ( tempDir , 'project' ) ;
2026-05-14 17:39:31 +02:00
await initKtxProject ( { projectDir } ) ;
2026-05-10 23:12:26 +02:00
await writeFile (
2026-05-10 23:51:24 +02:00
join ( projectDir , 'ktx.yaml' ) ,
2026-05-10 23:12:26 +02:00
[
'connections:' ,
' warehouse:' ,
' driver: postgres' ,
'ingest:' ,
' adapters:' ,
' - fake' ,
' embeddings:' ,
2026-05-19 16:40:01 +02:00
' backend: none' ,
2026-05-10 23:12:26 +02:00
'' ,
] . join ( '\n' ) ,
'utf-8' ,
) ;
2026-05-10 23:51:24 +02:00
project = await loadKtxProject ( { projectDir } ) ;
2026-05-10 23:12:26 +02:00
} ) ;
afterEach ( async ( ) = > {
await rm ( tempDir , { recursive : true , force : true } ) ;
} ) ;
it ( 'requires an agent runner or configured local ingest LLM' , ( ) = > {
expect ( ( ) = >
createLocalBundleIngestRuntime ( {
project ,
adapters : [ new FakeSourceAdapter ( ) ] ,
} ) ,
2026-05-12 10:26:07 +02:00
) . toThrow (
[
2026-05-16 12:06:34 +02:00
'ktx ingest requires llm.provider.backend: anthropic, vertex, gateway, or claude-code, or an injected agentRunner.' ,
'Configure a local Claude Code session or API-backed LLM, then rerun ingest:' ,
` ktx setup --project-dir ${ project . projectDir } --llm-backend claude-code --no-input ` ,
2026-05-19 19:23:35 +02:00
` ktx setup --project-dir ${ project . projectDir } --llm-backend anthropic --anthropic-api-key-env ANTHROPIC_API_KEY --llm-model claude-sonnet-4-6 --no-input ` ,
2026-05-12 10:26:07 +02:00
] . join ( '\n' ) ,
) ;
2026-05-10 23:12:26 +02:00
} ) ;
2026-05-16 12:06:34 +02:00
it ( 'uses a runtime-backed agent runner when claude-code is configured' , ( ) = > {
const runtime = {
generateText : vi.fn ( ) ,
generateObject : vi.fn ( ) ,
runAgentLoop : vi.fn ( async ( ) = > ( { stopReason : 'natural' as const } ) ) ,
} ;
project . config . llm = {
provider : { backend : 'claude-code' } ,
models : { default : 'sonnet' } ,
promptCaching : { enabled : false } ,
} ;
const createLlmRuntime = vi . fn ( ( ) = > runtime ) ;
const created = createLocalBundleIngestRuntime ( {
project ,
adapters : [ new FakeSourceAdapter ( ) ] ,
createLlmRuntime ,
} ) ;
expect ( created ) . toBeDefined ( ) ;
expect ( createLlmRuntime ) . toHaveBeenCalledWith (
project . config . llm ,
expect . objectContaining ( { projectDir : project.projectDir } ) ,
) ;
} ) ;
2026-05-21 10:38:23 +02:00
it ( 'warns when embeddings are configured but no embedding provider is supplied' , ( ) = > {
const logger = { log : vi.fn ( ) , warn : vi.fn ( ) , error : vi.fn ( ) } ;
project . config . ingest . embeddings = {
backend : 'openai' ,
model : 'text-embedding-3-small' ,
dimensions : 1536 ,
} ;
createLocalBundleIngestRuntime ( {
project ,
adapters : [ new FakeSourceAdapter ( ) ] ,
agentRunner : testAgentRunner ( ) ,
logger : logger as never ,
} ) ;
expect ( logger . warn ) . toHaveBeenCalledWith (
'[local-bundle-runtime] embeddings backend "openai" is configured but no embedding provider was passed; embedding-dependent stages will run against a no-op embedding port.' ,
) ;
} ) ;
2026-05-10 23:12:26 +02:00
it ( 'builds runner deps with local SQLite stores and context tools enabled' , async ( ) = > {
2026-05-16 12:06:34 +02:00
const agentRunner = testAgentRunner ( ) ;
2026-05-10 23:12:26 +02:00
const runtime = createLocalBundleIngestRuntime ( {
project ,
adapters : [ new FakeSourceAdapter ( ) ] ,
agentRunner ,
jobIdFactory : ( ) = > 'job-1' ,
} ) ;
expect ( runtime . nextJobId ( ) ) . toBe ( 'job-1' ) ;
2026-05-10 23:51:24 +02:00
expect ( runtime . storage . resolvePullDir ( 'job-1' ) ) . toBe ( join ( project . projectDir , '.ktx/cache/local-ingest/job-1/pull' ) ) ;
2026-05-10 23:12:26 +02:00
expect ( runtime . storage . resolveUploadDir ( 'job-1' ) ) . toBe (
2026-05-10 23:51:24 +02:00
join ( project . projectDir , '.ktx/cache/local-ingest/job-1/upload' ) ,
2026-05-10 23:12:26 +02:00
) ;
expect ( runtime . storage . resolveTranscriptDir ( 'job-1' ) ) . toBe (
2026-05-10 23:51:24 +02:00
join ( project . projectDir , '.ktx/ingest-transcripts/job-1' ) ,
2026-05-10 23:12:26 +02:00
) ;
await mkdir ( runtime . storage . resolveUploadDir ( 'job-1' ) , { recursive : true } ) ;
} ) ;
it ( 'exposes canonical warehouse connection types to local ingest SL tools' , async ( ) = > {
project . config . connections . warehouse = {
driver : 'postgres' ,
url : 'postgresql://readonly@db.example.test/analytics' ,
} ;
project . config . connections . bq = {
driver : 'bigquery' ,
project_id : 'acme' ,
dataset_id : 'warehouse' ,
} ;
2026-05-16 12:06:34 +02:00
const agentRunner = testAgentRunner ( ) ;
2026-05-10 23:12:26 +02:00
const runtime = createLocalBundleIngestRuntime ( {
project ,
adapters : [ new FakeSourceAdapter ( ) ] ,
agentRunner ,
} ) ;
const connections = ( runtime . runner as unknown as RuntimeWithConnectionDeps ) . deps . connections ;
await expect ( connections . getConnectionById ( 'warehouse' ) ) . resolves . toMatchObject ( {
id : 'warehouse' ,
connectionType : 'POSTGRESQL' ,
} ) ;
await expect ( connections . listEnabledConnections ( [ 'warehouse' , 'bq' ] ) ) . resolves . toEqual ( [
{ id : 'warehouse' , name : 'warehouse' , connectionType : 'POSTGRESQL' } ,
{ id : 'bq' , name : 'bq' , connectionType : 'BIGQUERY' } ,
] ) ;
} ) ;
2026-05-18 13:38:06 +02:00
it ( 'validates manifest-backed scan sources during local ingest gates' , async ( ) = > {
await project . fileStore . writeFile (
'semantic-layer/warehouse/_schema/public.yaml' ,
[
'tables:' ,
' payments:' ,
' table: public.payments' ,
' columns:' ,
' - name: payment_id' ,
' type: string' ,
' - name: amount' ,
' type: number' ,
'' ,
] . join ( '\n' ) ,
'ktx' ,
'ktx@example.com' ,
'Add warehouse manifest' ,
) ;
const agentRunner = testAgentRunner ( ) ;
const runtime = createLocalBundleIngestRuntime ( {
project ,
adapters : [ new FakeSourceAdapter ( ) ] ,
agentRunner ,
} ) ;
const deps = ( runtime . runner as unknown as RuntimeWithSlValidationDeps ) . deps ;
await expect ( deps . slValidator . validateSingleSource ( deps , 'warehouse' , 'payments' ) ) . resolves . toEqual ( {
errors : [ ] ,
warnings : expect.any ( Array ) ,
} ) ;
} ) ;
it ( 'does not mask malformed direct overlays with manifest-backed fallback validation' , async ( ) = > {
await project . fileStore . writeFile (
'semantic-layer/warehouse/_schema/public.yaml' ,
[
'tables:' ,
' payments:' ,
' table: public.payments' ,
' columns:' ,
' - name: payment_id' ,
' type: string' ,
'' ,
] . join ( '\n' ) ,
'ktx' ,
'ktx@example.com' ,
'Add warehouse manifest' ,
) ;
await project . fileStore . writeFile (
'semantic-layer/warehouse/payments.yaml' ,
[ 'name: payments' , 'columns:' , ' - [' , '' ] . join ( '\n' ) ,
'ktx' ,
'ktx@example.com' ,
'Add malformed overlay' ,
) ;
const agentRunner = testAgentRunner ( ) ;
const runtime = createLocalBundleIngestRuntime ( {
project ,
adapters : [ new FakeSourceAdapter ( ) ] ,
agentRunner ,
} ) ;
const deps = ( runtime . runner as unknown as RuntimeWithSlValidationDeps ) . deps ;
await expect ( deps . slValidator . validateSingleSource ( deps , 'warehouse' , 'payments' ) ) . resolves . toEqual ( {
errors : [ expect . stringContaining ( 'invalid YAML' ) ] ,
warnings : [ ] ,
} ) ;
} ) ;
2026-05-13 13:43:23 +02:00
it ( 'passes project connection config to local ingest query executors' , async ( ) = > {
2026-05-16 12:06:34 +02:00
const agentRunner = testAgentRunner ( ) ;
2026-05-13 13:43:23 +02:00
const queryExecutor = {
execute : vi.fn ( async ( ) = > ( {
headers : [ 'answer' ] ,
rows : [ [ 1 ] ] ,
totalRows : 1 ,
command : 'SELECT' ,
rowCount : 1 ,
} ) ) ,
} ;
const runtime = createLocalBundleIngestRuntime ( {
project ,
adapters : [ new FakeSourceAdapter ( ) ] ,
agentRunner ,
queryExecutor ,
} ) ;
const connections = ( runtime . runner as unknown as RuntimeWithConnectionDeps ) . deps . connections ;
await expect ( connections . executeQuery ( 'warehouse' , 'select 1' ) ) . resolves . toMatchObject ( {
headers : [ 'answer' ] ,
} ) ;
expect ( queryExecutor . execute ) . toHaveBeenCalledWith ( {
connectionId : 'warehouse' ,
projectDir : project.projectDir ,
connection : project.config.connections.warehouse ,
sql : 'select 1' ,
} ) ;
} ) ;
2026-05-18 13:38:06 +02:00
it ( 'defaults local bundle ingest to isolated diffs without a shared-worktree fallback setting' , ( ) = > {
const runtime = createLocalBundleIngestRuntime ( {
project ,
adapters : [ new FakeSourceAdapter ( ) ] ,
agentRunner : testAgentRunner ( ) ,
} ) ;
const settings = ( runtime . runner as unknown as RuntimeWithSettingsDeps ) . deps . settings ;
const fallbackSettingKey = [ 'sharedWorktree' , 'SourceKeys' ] . join ( '' ) ;
expect ( settings ) . not . toHaveProperty ( fallbackSettingKey ) ;
expect ( Object . keys ( settings ) . sort ( ) ) . toEqual ( [
'ingestTraceLevel' ,
'memoryIngestionModel' ,
'probeRowCount' ,
'workUnitFailureMode' ,
'workUnitMaxConcurrency' ,
'workUnitStepBudget' ,
] ) ;
} ) ;
2026-05-10 23:12:26 +02:00
it ( 'accepts a debug LLM request file when constructing the default agent runner' , async ( ) = > {
await writeFile (
2026-05-10 23:51:24 +02:00
join ( project . projectDir , 'ktx.yaml' ) ,
2026-05-10 23:12:26 +02:00
[
'connections:' ,
' warehouse:' ,
' driver: postgres' ,
'llm:' ,
' provider:' ,
' backend: gateway' ,
' gateway:' ,
' base_url: https://gateway.example/v1' ,
' models:' ,
' default: anthropic/claude-sonnet-4-6' ,
'ingest:' ,
' adapters:' ,
' - fake' ,
' embeddings:' ,
2026-05-19 16:40:01 +02:00
' backend: none' ,
2026-05-10 23:12:26 +02:00
'' ,
] . join ( '\n' ) ,
'utf-8' ,
) ;
2026-05-10 23:51:24 +02:00
project = await loadKtxProject ( { projectDir : project.projectDir } ) ;
2026-05-10 23:12:26 +02:00
const runtime = createLocalBundleIngestRuntime ( {
project ,
adapters : [ new FakeSourceAdapter ( ) ] ,
2026-05-10 23:51:24 +02:00
llmDebugRequestFile : join ( project . projectDir , '.ktx' , 'llm-debug.jsonl' ) ,
2026-05-10 23:12:26 +02:00
} ) ;
2026-05-10 23:51:24 +02:00
expect ( runtime . storage . resolvePullDir ( 'job-1' ) ) . toBe ( join ( project . projectDir , '.ktx/cache/local-ingest/job-1/pull' ) ) ;
2026-05-10 23:12:26 +02:00
} ) ;
} ) ;