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 { localConnectionToWarehouseDescriptor } from './context/connections/local-warehouse-descriptor.js';
|
|
|
|
|
import { DEFAULT_METABASE_CLIENT_CONFIG, DefaultMetabaseConnectionClientFactory } from './context/ingest/adapters/metabase/client.js';
|
|
|
|
|
import { DefaultLookerConnectionClientFactory } from './context/ingest/adapters/looker/factory.js';
|
|
|
|
|
import { KtxYamlMetabaseSourceStateReader, LocalMetabaseDiscoveryCache, type LocalMetabaseMappingListRow } from './context/ingest/adapters/metabase/local-source-state-store.js';
|
|
|
|
|
import { LocalLookerRuntimeStore } from './context/ingest/adapters/looker/local-runtime-store.js';
|
|
|
|
|
import { computeLookerMappingDrift, discoverLookerConnections, validateLookerMappings, type LookerMappingClient } from './context/ingest/adapters/looker/mapping.js';
|
|
|
|
|
import { computeMetabaseMappingDrift, discoverMetabaseDatabases, validateMappingPhysicalMatch } from './context/ingest/adapters/metabase/mapping.js';
|
|
|
|
|
import { lookerCredentialsFromLocalConnection } from './context/ingest/adapters/looker/local-looker.adapter.js';
|
|
|
|
|
import { metabaseRuntimeConfigFromLocalConnection } from './context/ingest/adapters/metabase/local-metabase.adapter.js';
|
|
|
|
|
import { planMetabaseFanoutChildren } from './context/ingest/adapters/metabase/fanout-planner.js';
|
|
|
|
|
import { seedLocalMappingStateFromKtxYaml } from './context/ingest/local-mapping-reconcile.js';
|
|
|
|
|
import type { MetabaseRuntimeClient } from './context/ingest/adapters/metabase/client-port.js';
|
|
|
|
|
import { type KtxLocalProject, loadKtxProject } from './context/project/project.js';
|
|
|
|
|
import { ktxLocalStateDbPath } from './context/project/local-state-db.js';
|
2026-05-13 15:04:50 +02:00
|
|
|
import type { KtxCliIo } from './cli-runtime.js';
|
|
|
|
|
import { profileMark } from './startup-profile.js';
|
|
|
|
|
|
|
|
|
|
profileMark('module:source-mapping');
|
|
|
|
|
|
|
|
|
|
export type KtxSourceMappingArgs =
|
|
|
|
|
| { command: 'list'; projectDir: string; connectionId: string; json: boolean }
|
|
|
|
|
| { command: 'refresh'; projectDir: string; connectionId: string; autoAccept: boolean }
|
|
|
|
|
| { command: 'validate'; projectDir: string; connectionId: string };
|
|
|
|
|
|
|
|
|
|
interface KtxSourceMappingDeps {
|
|
|
|
|
createMetabaseClient?: (
|
|
|
|
|
project: KtxLocalProject,
|
|
|
|
|
connectionId: string,
|
|
|
|
|
) => Promise<Pick<MetabaseRuntimeClient, 'getDatabases' | 'cleanup'>>;
|
|
|
|
|
createLookerClient?: (
|
|
|
|
|
project: KtxLocalProject,
|
|
|
|
|
connectionId: string,
|
|
|
|
|
) => Promise<Pick<LookerMappingClient, 'listLookerConnections'> & { cleanup?(): Promise<void> }>;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
async function createDefaultMetabaseClient(
|
|
|
|
|
project: KtxLocalProject,
|
|
|
|
|
connectionId: string,
|
|
|
|
|
): Promise<Pick<MetabaseRuntimeClient, 'getDatabases' | 'cleanup'>> {
|
|
|
|
|
const factory = new DefaultMetabaseConnectionClientFactory(
|
|
|
|
|
(metabaseConnectionId) =>
|
|
|
|
|
metabaseRuntimeConfigFromLocalConnection(metabaseConnectionId, project.config.connections[metabaseConnectionId]),
|
|
|
|
|
DEFAULT_METABASE_CLIENT_CONFIG,
|
|
|
|
|
);
|
|
|
|
|
return factory.createClient(connectionId);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
async function createDefaultLookerClient(
|
|
|
|
|
project: KtxLocalProject,
|
|
|
|
|
connectionId: string,
|
|
|
|
|
): Promise<Pick<LookerMappingClient, 'listLookerConnections'> & { cleanup?(): Promise<void> }> {
|
|
|
|
|
const factory = new DefaultLookerConnectionClientFactory({
|
|
|
|
|
async resolve(lookerConnectionId) {
|
|
|
|
|
return lookerCredentialsFromLocalConnection(lookerConnectionId, project.config.connections[lookerConnectionId]);
|
|
|
|
|
},
|
|
|
|
|
});
|
|
|
|
|
return factory.createClient(connectionId) as unknown as Pick<LookerMappingClient, 'listLookerConnections'> & {
|
|
|
|
|
cleanup?(): Promise<void>;
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function isLookerConnection(project: KtxLocalProject, connectionId: string): boolean {
|
|
|
|
|
return String(project.config.connections[connectionId]?.driver ?? '').toLowerCase() === 'looker';
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function assertMetabaseConnection(project: KtxLocalProject, connectionId: string): void {
|
|
|
|
|
const connection = project.config.connections[connectionId];
|
|
|
|
|
if (!connection || String(connection.driver).toLowerCase() !== 'metabase') {
|
|
|
|
|
throw new Error(`Connection "${connectionId}" is not a Metabase connection`);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function targetPhysicalInfo(project: KtxLocalProject, connectionId: string) {
|
|
|
|
|
const descriptor = localConnectionToWarehouseDescriptor(connectionId, project.config.connections[connectionId]);
|
|
|
|
|
if (!descriptor) {
|
|
|
|
|
return { connection_type: 'UNKNOWN' };
|
|
|
|
|
}
|
|
|
|
|
return {
|
|
|
|
|
connection_type: descriptor.connection_type,
|
|
|
|
|
host: descriptor.host ?? null,
|
|
|
|
|
database: descriptor.database ?? null,
|
|
|
|
|
account: descriptor.account ?? null,
|
|
|
|
|
project_id: descriptor.project_id ?? null,
|
|
|
|
|
dataset_id: descriptor.dataset_id ?? null,
|
|
|
|
|
...descriptor.connection_params,
|
|
|
|
|
};
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function renderMapping(row: LocalMetabaseMappingListRow): string {
|
|
|
|
|
const name = row.metabaseDatabaseName ?? 'unhydrated';
|
|
|
|
|
const target = row.targetConnectionId ?? '[unmapped]';
|
|
|
|
|
return `${row.metabaseDatabaseId} -> ${target} (${name}, sync: ${row.syncEnabled ? 'on' : 'off'}, source: ${
|
|
|
|
|
row.source
|
|
|
|
|
})`;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function renderLookerMapping(row: Awaited<ReturnType<LocalLookerRuntimeStore['listConnectionMappings']>>[number]): string {
|
|
|
|
|
const target = row.ktxConnectionId ?? '[unmapped]';
|
|
|
|
|
const metadata = [row.lookerDialect, row.lookerHost, row.lookerDatabase].filter(Boolean).join(', ');
|
|
|
|
|
return `${row.lookerConnectionName} -> ${target}${metadata ? ` (${metadata}, source: ${row.source})` : ` (source: ${row.source})`}`;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
export async function runKtxSourceMapping(
|
|
|
|
|
args: KtxSourceMappingArgs,
|
|
|
|
|
io: KtxCliIo = process,
|
|
|
|
|
deps: KtxSourceMappingDeps = {},
|
|
|
|
|
): Promise<number> {
|
|
|
|
|
try {
|
|
|
|
|
const project = await loadKtxProject({ projectDir: args.projectDir });
|
|
|
|
|
await seedLocalMappingStateFromKtxYaml(project, args.connectionId);
|
|
|
|
|
if (isLookerConnection(project, args.connectionId)) {
|
|
|
|
|
const store = new LocalLookerRuntimeStore({ dbPath: ktxLocalStateDbPath(project) });
|
|
|
|
|
|
|
|
|
|
if (args.command === 'list') {
|
|
|
|
|
const rows = await store.listConnectionMappings(args.connectionId);
|
|
|
|
|
io.stdout.write(args.json ? `${JSON.stringify(rows, null, 2)}\n` : `${rows.map(renderLookerMapping).join('\n')}\n`);
|
|
|
|
|
return 0;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (args.command === 'refresh') {
|
|
|
|
|
const client = await (deps.createLookerClient ?? createDefaultLookerClient)(project, args.connectionId);
|
|
|
|
|
try {
|
|
|
|
|
const discovered = await discoverLookerConnections(client);
|
|
|
|
|
const drift = computeLookerMappingDrift({
|
|
|
|
|
storedMappings: await store.readMappings(args.connectionId),
|
|
|
|
|
discovered,
|
|
|
|
|
});
|
|
|
|
|
if (args.autoAccept) {
|
|
|
|
|
await store.refreshDiscoveredConnections({ lookerConnectionId: args.connectionId, discovered });
|
|
|
|
|
}
|
|
|
|
|
io.stdout.write(`Discovery: ${discovered.length} ${discovered.length === 1 ? 'connection' : 'connections'}\n`);
|
|
|
|
|
io.stdout.write(`Unmapped discovered: ${drift.unmappedDiscovered.length}\n`);
|
|
|
|
|
io.stdout.write(`Stale mappings: ${drift.staleMappings.length}\n`);
|
|
|
|
|
return 0;
|
|
|
|
|
} finally {
|
|
|
|
|
await client.cleanup?.();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const knownKtxConnectionIds = new Set(Object.keys(project.config.connections));
|
|
|
|
|
const knownConnectionTypes = new Map(
|
|
|
|
|
Object.entries(project.config.connections).map(([id]) => [id, targetPhysicalInfo(project, id).connection_type]),
|
|
|
|
|
);
|
|
|
|
|
const validation = validateLookerMappings({
|
|
|
|
|
mappings: await store.readMappings(args.connectionId),
|
|
|
|
|
knownKtxConnectionIds,
|
|
|
|
|
knownConnectionTypes,
|
|
|
|
|
});
|
|
|
|
|
if (!validation.ok) {
|
|
|
|
|
for (const error of validation.errors) {
|
|
|
|
|
io.stderr.write(`${error.key}: ${error.reason}\n`);
|
|
|
|
|
}
|
|
|
|
|
return 1;
|
|
|
|
|
}
|
|
|
|
|
io.stdout.write(`Mapping validation passed: ${args.connectionId}\n`);
|
|
|
|
|
return 0;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
assertMetabaseConnection(project, args.connectionId);
|
|
|
|
|
const discoveryCache = new LocalMetabaseDiscoveryCache({ dbPath: ktxLocalStateDbPath(project) });
|
|
|
|
|
const store = new KtxYamlMetabaseSourceStateReader(project, { discoveryCache });
|
|
|
|
|
|
|
|
|
|
if (args.command === 'list') {
|
|
|
|
|
const rows = await store.listDatabaseMappings(args.connectionId);
|
|
|
|
|
io.stdout.write(args.json ? `${JSON.stringify(rows, null, 2)}\n` : `${rows.map(renderMapping).join('\n')}\n`);
|
|
|
|
|
return 0;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if (args.command === 'refresh') {
|
|
|
|
|
const client = await (deps.createMetabaseClient ?? createDefaultMetabaseClient)(project, args.connectionId);
|
|
|
|
|
try {
|
|
|
|
|
const discovered = await discoverMetabaseDatabases(client);
|
|
|
|
|
const existing = Object.fromEntries(
|
|
|
|
|
(await store.listDatabaseMappings(args.connectionId)).map((row) => [
|
|
|
|
|
String(row.metabaseDatabaseId),
|
|
|
|
|
row.targetConnectionId,
|
|
|
|
|
]),
|
|
|
|
|
);
|
|
|
|
|
const drift = computeMetabaseMappingDrift({ currentMappings: existing, discovered });
|
|
|
|
|
if (args.autoAccept) {
|
|
|
|
|
await discoveryCache.refreshDiscoveredDatabases({ connectionId: args.connectionId, discovered });
|
|
|
|
|
}
|
|
|
|
|
io.stdout.write(`Discovery: ${discovered.length} ${discovered.length === 1 ? 'database' : 'databases'}\n`);
|
|
|
|
|
io.stdout.write(`Unmapped discovered: ${drift.unmappedDiscovered.length}\n`);
|
|
|
|
|
io.stdout.write(`Stale mappings: ${drift.staleMappings.length}\n`);
|
|
|
|
|
return 0;
|
|
|
|
|
} finally {
|
|
|
|
|
await client.cleanup();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
const rows = await store.listDatabaseMappings(args.connectionId);
|
2026-05-17 19:15:09 +02:00
|
|
|
planMetabaseFanoutChildren({
|
|
|
|
|
metabaseConnectionId: args.connectionId,
|
|
|
|
|
mappings: rows.map((row) => ({
|
|
|
|
|
metabaseDatabaseId: row.metabaseDatabaseId,
|
|
|
|
|
targetConnectionId: row.targetConnectionId,
|
|
|
|
|
syncEnabled: row.syncEnabled,
|
|
|
|
|
})),
|
|
|
|
|
});
|
2026-05-13 15:04:50 +02:00
|
|
|
const failures = rows.flatMap((row) => {
|
|
|
|
|
if (!row.targetConnectionId) {
|
|
|
|
|
return [];
|
|
|
|
|
}
|
|
|
|
|
const reason = validateMappingPhysicalMatch(
|
|
|
|
|
{ metabaseEngine: row.metabaseEngine, metabaseDbName: row.metabaseDbName, metabaseHost: row.metabaseHost },
|
|
|
|
|
project.config.connections[row.targetConnectionId]
|
|
|
|
|
? targetPhysicalInfo(project, row.targetConnectionId)
|
|
|
|
|
: { connection_type: 'UNKNOWN' },
|
|
|
|
|
);
|
|
|
|
|
return reason ? [`${row.metabaseDatabaseId}: ${reason}`] : [];
|
|
|
|
|
});
|
|
|
|
|
if (failures.length > 0) {
|
|
|
|
|
for (const failure of failures) {
|
|
|
|
|
io.stderr.write(`${failure}\n`);
|
|
|
|
|
}
|
|
|
|
|
return 1;
|
|
|
|
|
}
|
|
|
|
|
io.stdout.write(`Mapping validation passed: ${args.connectionId}\n`);
|
|
|
|
|
return 0;
|
|
|
|
|
} catch (error) {
|
|
|
|
|
io.stderr.write(`${error instanceof Error ? error.message : String(error)}\n`);
|
|
|
|
|
return 1;
|
|
|
|
|
}
|
|
|
|
|
}
|