mirror of
https://github.com/Kaelio/ktx.git
synced 2026-07-01 08:59:39 +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.
188 lines
7.1 KiB
TypeScript
188 lines
7.1 KiB
TypeScript
import type { SemanticLayerService } from '../../context/sl/semantic-layer.service.js';
|
|
import type { TouchedSlSource } from '../../context/tools/touched-sl-sources.js';
|
|
import type { KnowledgeWikiService } from '../../context/wiki/knowledge-wiki.service.js';
|
|
import { findMissingWikiRefs } from '../wiki/wiki-ref-validation.js';
|
|
import { findInvalidWikiBodyRefs } from './wiki-body-refs.js';
|
|
|
|
interface TouchedValidationResult {
|
|
invalidSources: string[];
|
|
validSources: string[];
|
|
}
|
|
|
|
export interface FinalArtifactGateInput {
|
|
connectionIds: string[];
|
|
changedWikiPageKeys: string[];
|
|
touchedSlSources: TouchedSlSource[];
|
|
wikiService: KnowledgeWikiService;
|
|
semanticLayerService: SemanticLayerService;
|
|
validateTouchedSources(touched: TouchedSlSource[]): Promise<TouchedValidationResult>;
|
|
tableExists(connectionId: string, tableRef: string): Promise<boolean>;
|
|
}
|
|
|
|
export interface ProvenanceRawPathValidationInput {
|
|
rows: Array<{ rawPath: string }>;
|
|
currentRawPaths: Set<string>;
|
|
deletedRawPaths: Set<string>;
|
|
}
|
|
|
|
function parseSlRef(ref: string): { connectionId: string | null; sourceName: string; entityName: string | null } {
|
|
const withoutConnection = ref.includes('/') ? ref.slice(ref.indexOf('/') + 1) : ref;
|
|
const connectionId = ref.includes('/') ? ref.slice(0, ref.indexOf('/')) : null;
|
|
const [sourceName = '', entityName = null] = withoutConnection.split('.', 2);
|
|
return { connectionId, sourceName, entityName };
|
|
}
|
|
|
|
function slEntityNames(source: Awaited<ReturnType<SemanticLayerService['loadAllSources']>>['sources'][number]): Set<string> {
|
|
return new Set([
|
|
...(source.measures ?? []).map((measure) => measure.name),
|
|
...(source.columns ?? []).map((column) => column.name),
|
|
...(source.segments ?? []).map((segment) => segment.name),
|
|
]);
|
|
}
|
|
|
|
function uniqueTouchedSources(sources: TouchedSlSource[]): TouchedSlSource[] {
|
|
const seen = new Set<string>();
|
|
const unique: TouchedSlSource[] = [];
|
|
for (const source of sources) {
|
|
const key = `${source.connectionId}:${source.sourceName}`;
|
|
if (seen.has(key)) {
|
|
continue;
|
|
}
|
|
seen.add(key);
|
|
unique.push(source);
|
|
}
|
|
return unique.sort((left, right) => {
|
|
const byConnection = left.connectionId.localeCompare(right.connectionId);
|
|
return byConnection === 0 ? left.sourceName.localeCompare(right.sourceName) : byConnection;
|
|
});
|
|
}
|
|
|
|
async function expandTouchedSlSourcesWithDirectJoinNeighbors(input: FinalArtifactGateInput): Promise<TouchedSlSource[]> {
|
|
const expanded = [...input.touchedSlSources];
|
|
const touchedByConnection = new Map<string, Set<string>>();
|
|
for (const source of input.touchedSlSources) {
|
|
const bucket = touchedByConnection.get(source.connectionId) ?? new Set<string>();
|
|
bucket.add(source.sourceName);
|
|
touchedByConnection.set(source.connectionId, bucket);
|
|
}
|
|
|
|
for (const connectionId of input.connectionIds) {
|
|
const touched = touchedByConnection.get(connectionId);
|
|
if (!touched || touched.size === 0) {
|
|
continue;
|
|
}
|
|
const { sources } = await input.semanticLayerService.loadAllSources(connectionId);
|
|
for (const source of sources) {
|
|
const sourceIsTouched = touched.has(source.name);
|
|
if (sourceIsTouched) {
|
|
for (const join of source.joins ?? []) {
|
|
expanded.push({ connectionId, sourceName: join.to });
|
|
}
|
|
}
|
|
if ((source.joins ?? []).some((join) => touched.has(join.to))) {
|
|
expanded.push({ connectionId, sourceName: source.name });
|
|
}
|
|
}
|
|
}
|
|
|
|
return uniqueTouchedSources(expanded);
|
|
}
|
|
|
|
async function validateWikiSlRefs(input: FinalArtifactGateInput): Promise<string[]> {
|
|
const errors: string[] = [];
|
|
const sourcesByConnection = new Map<string, Awaited<ReturnType<SemanticLayerService['loadAllSources']>>['sources']>();
|
|
for (const connectionId of input.connectionIds) {
|
|
const { sources } = await input.semanticLayerService.loadAllSources(connectionId);
|
|
sourcesByConnection.set(connectionId, sources);
|
|
}
|
|
|
|
for (const pageKey of input.changedWikiPageKeys) {
|
|
const page = await input.wikiService.readPage('GLOBAL', null, pageKey);
|
|
if (!page) {
|
|
continue;
|
|
}
|
|
for (const ref of page.frontmatter.sl_refs ?? []) {
|
|
const parsed = parseSlRef(ref);
|
|
const candidateConnections = parsed.connectionId ? [parsed.connectionId] : input.connectionIds;
|
|
let source: Awaited<ReturnType<SemanticLayerService['loadAllSources']>>['sources'][number] | undefined;
|
|
for (const connectionId of candidateConnections) {
|
|
source = sourcesByConnection.get(connectionId)?.find((candidate) => candidate.name === parsed.sourceName);
|
|
if (source) {
|
|
break;
|
|
}
|
|
}
|
|
if (!source) {
|
|
errors.push(`${pageKey}: unknown sl_refs entry ${ref}`);
|
|
continue;
|
|
}
|
|
if (parsed.entityName && !slEntityNames(source).has(parsed.entityName)) {
|
|
errors.push(`${pageKey}: unknown sl_refs entity ${ref}`);
|
|
}
|
|
}
|
|
}
|
|
return errors;
|
|
}
|
|
|
|
async function validateWikiRefs(input: FinalArtifactGateInput): Promise<string[]> {
|
|
const dangling: string[] = [];
|
|
for (const pageKey of input.changedWikiPageKeys) {
|
|
const page = await input.wikiService.readPage('GLOBAL', null, pageKey);
|
|
if (!page) {
|
|
continue;
|
|
}
|
|
const missingRefs = await findMissingWikiRefs({
|
|
wikiService: input.wikiService,
|
|
scope: 'GLOBAL',
|
|
scopeId: null,
|
|
pageKey,
|
|
refs: page.frontmatter.refs,
|
|
content: page.content,
|
|
});
|
|
for (const missingRef of missingRefs) {
|
|
dangling.push(`${pageKey} -> ${missingRef}`);
|
|
}
|
|
}
|
|
return dangling;
|
|
}
|
|
|
|
export async function validateFinalIngestArtifacts(input: FinalArtifactGateInput): Promise<void> {
|
|
const touchedWithDependencies = await expandTouchedSlSourcesWithDirectJoinNeighbors(input);
|
|
const validation = await input.validateTouchedSources(touchedWithDependencies);
|
|
const errors: string[] = validation.invalidSources.map((source) => `semantic-layer validation failed for ${source}`);
|
|
errors.push(...(await validateWikiSlRefs(input)));
|
|
const danglingWikiRefs = await validateWikiRefs(input);
|
|
if (danglingWikiRefs.length > 0) {
|
|
errors.push(`wiki references target missing page(s): ${danglingWikiRefs.join(', ')}`);
|
|
}
|
|
|
|
for (const pageKey of input.changedWikiPageKeys) {
|
|
const page = await input.wikiService.readPage('GLOBAL', null, pageKey);
|
|
if (!page) {
|
|
continue;
|
|
}
|
|
errors.push(
|
|
...(await findInvalidWikiBodyRefs({
|
|
pageKey,
|
|
body: page.content,
|
|
visibleConnectionIds: input.connectionIds,
|
|
loadSources: async (connectionId) => {
|
|
const { sources } = await input.semanticLayerService.loadAllSources(connectionId);
|
|
return sources;
|
|
},
|
|
tableExists: input.tableExists,
|
|
})),
|
|
);
|
|
}
|
|
|
|
if (errors.length > 0) {
|
|
throw new Error(`final artifact gates failed:\n${errors.join('\n')}`);
|
|
}
|
|
}
|
|
|
|
export function validateProvenanceRawPaths(input: ProvenanceRawPathValidationInput): void {
|
|
for (const row of input.rows) {
|
|
if (!input.currentRawPaths.has(row.rawPath) && !input.deletedRawPaths.has(row.rawPath)) {
|
|
throw new Error(`provenance row references raw path outside this snapshot: ${row.rawPath}`);
|
|
}
|
|
}
|
|
}
|