ktx/packages/cli/src/context/ingest/report-snapshot.ts
Andrey Avtomonov 2366b00301
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

233 lines
7.8 KiB
TypeScript

import * as z from 'zod';
import { memoryFlowReplayInputSchema } from './memory-flow/schema.js';
import type { IngestReportSnapshot } from './reports.js';
const ingestDiffSummarySchema = z.object({
added: z.number().int(),
modified: z.number().int(),
deleted: z.number().int(),
unchanged: z.number().int(),
});
const ingestActionSchema = z.object({
target: z.enum(['wiki', 'sl']),
type: z.enum(['created', 'updated', 'removed']),
key: z.string(),
detail: z.string(),
targetConnectionId: z.string().nullable().default(null),
rawPaths: z.array(z.string()).optional(),
});
const touchedSlSourceSchema = z.object({
connectionId: z.string().min(1),
sourceName: z.string().min(1),
});
const conflictResolvedSchema = z
.object({
unitKey: z.string().optional(),
kind: z.enum(['structural_duplicate', 'near_duplicate', 'definitional_contradiction', 're_ingest_change']),
contestedKey: z.string().optional(),
artifactKey: z.string(),
detail: z.string(),
flaggedForHuman: z.boolean(),
})
.passthrough();
const evictionAppliedSchema = z
.object({
rawPath: z.string(),
artifactKind: z.enum(['sl', 'wiki']),
artifactKey: z.string(),
action: z.literal('removed'),
reason: z.string(),
})
.passthrough();
const unmappedFallbackSchema = z
.object({
rawPath: z.string(),
reason: z.enum([
'no_connection_mapping',
'looker_template_unresolved',
'derived_table_not_supported',
'no_physical_table',
'multiple_table_references',
'unsupported_dialect',
'parse_error',
'missing_target_table',
]),
detail: z.string().optional(),
fallback: z.enum(['sql_standalone', 'wiki_only', 'flagged']),
})
.passthrough();
const artifactResolutionSchema = z
.object({
rawPath: z.string(),
artifactKind: z.enum(['sl', 'wiki']),
artifactKey: z.string(),
actionType: z.enum(['merged', 'subsumed']),
reason: z.string(),
})
.passthrough();
const provenanceDetailSchema = z.object({
rawPath: z.string(),
artifactKind: z.enum(['sl', 'wiki']).nullable(),
artifactKey: z.string().nullable(),
targetConnectionId: z.string().nullable().default(null),
actionType: z.enum([
'source_created',
'measure_added',
'join_added',
'merged',
'subsumed',
'wiki_written',
'skipped',
]),
});
const toolTranscriptSummarySchema = z.object({
unitKey: z.string(),
path: z.string(),
toolCallCount: z.number().int().min(0),
errorCount: z.number().int().min(0),
toolNames: z.array(z.string()),
});
const sourceFetchIssueKindSchema = z.enum([
'unmapped_looker_connection',
'unparseable_sql_table_name',
'looker_template_unresolved',
'derived_table_not_supported',
'lookml_connection_mismatch',
]);
const sourceFetchIssueSchema = z.object({
rawPath: z.string(),
entityType: z.string(),
entityId: z.string().nullable(),
severity: z.enum(['warning', 'error']),
statusCode: z.number().int().nullable(),
message: z.string(),
retryRecommended: z.boolean(),
kind: sourceFetchIssueKindSchema.optional(),
details: z.record(z.string(), z.unknown()).optional(),
});
const sourceFetchReportSchema = z.object({
status: z.enum(['success', 'partial']),
retryRecommended: z.boolean(),
skipped: z.array(sourceFetchIssueSchema).default([]),
warnings: z.array(sourceFetchIssueSchema).default([]),
});
const ingestReportFailureSchema = z.object({
phase: z.string().min(1),
message: z.string().min(1),
details: z.record(z.string(), z.unknown()).optional(),
});
const finalizationMismatchSchema = z.object({
artifactKind: z.enum(['sl', 'wiki']),
key: z.string().min(1),
direction: z.enum(['missing_from_adapter_declaration', 'extra_in_adapter_declaration']),
});
const finalizationProvenanceExclusionSchema = z.object({
action: ingestActionSchema,
reason: z.enum(['missing_raw_paths', 'raw_path_not_defensible']),
invalidRawPaths: z.array(z.string()).optional(),
});
const finalizationOutcomeSchema = z.object({
sourceKey: z.string().min(1),
status: z.enum(['success', 'failed', 'skipped']),
commitSha: z.string().nullable(),
touchedPaths: z.array(z.string()),
declaredTouchedSources: z.array(touchedSlSourceSchema),
derivedTouchedSources: z.array(touchedSlSourceSchema),
declaredChangedWikiPageKeys: z.array(z.string()),
derivedChangedWikiPageKeys: z.array(z.string()),
mismatches: z.array(finalizationMismatchSchema).default([]),
result: z.unknown().optional(),
errors: z.array(z.string()),
warnings: z.array(z.string()),
actions: z.array(ingestActionSchema).default([]),
provenanceExclusions: z.array(finalizationProvenanceExclusionSchema).default([]),
});
const ingestReportSnapshotSchema = z
.object({
id: z.string().min(1),
runId: z.string().min(1),
jobId: z.string().min(1),
connectionId: z.string().min(1),
sourceKey: z.string().min(1),
createdAt: z.string().min(1),
body: z
.object({
status: z.enum(['completed', 'failed']).optional(),
syncId: z.string().min(1),
diffSummary: ingestDiffSummarySchema,
fetch: sourceFetchReportSchema.optional(),
commitSha: z.string().nullable(),
tracePath: z.string().optional(),
failure: ingestReportFailureSchema.optional(),
isolatedDiff: z
.object({
enabled: z.boolean(),
integrationWorktreePath: z.string().optional(),
ingestionBaseSha: z.string().optional(),
projectionSha: z.string().nullable().optional(),
acceptedPatches: z.number().int().min(0),
textualConflicts: z.number().int().min(0),
semanticConflicts: z.number().int().min(0),
resolverAttempts: z.number().int().min(0).default(0),
resolverRepairs: z.number().int().min(0).default(0),
resolverFailures: z.number().int().min(0).default(0),
gateRepairAttempts: z.number().int().min(0).default(0),
gateRepairs: z.number().int().min(0).default(0),
gateRepairFailures: z.number().int().min(0).default(0),
})
.optional(),
workUnits: z.array(
z.object({
unitKey: z.string().min(1),
rawFiles: z.array(z.string()),
status: z.enum(['success', 'failed']),
reason: z.string().optional(),
actions: z.array(ingestActionSchema),
touchedSlSources: z.array(touchedSlSourceSchema),
slDisallowed: z.boolean().optional(),
slDisallowedReason: z.enum(['lookml_connection_mismatch']).optional(),
}),
),
failedWorkUnits: z.array(z.string()),
reconciliationSkipped: z.boolean(),
reconciliationActions: z.array(ingestActionSchema).default([]),
conflictsResolved: z.array(conflictResolvedSchema).default([]),
evictionsApplied: z.array(evictionAppliedSchema).default([]),
unmappedFallbacks: z.array(unmappedFallbackSchema).default([]),
artifactResolutions: z.array(artifactResolutionSchema).default([]),
evictionInputs: z.array(z.string()),
unresolvedCards: z.array(z.unknown()).default([]),
supersededBy: z.string().nullable().default(null),
overrideOf: z.string().nullable().default(null),
provenanceRows: z.array(provenanceDetailSchema).default([]),
toolTranscripts: z.array(toolTranscriptSummarySchema).default([]),
finalization: finalizationOutcomeSchema.optional(),
memoryFlow: memoryFlowReplayInputSchema.optional(),
})
.passthrough(),
})
.passthrough();
export function parseIngestReportSnapshot(value: unknown): IngestReportSnapshot {
const result = ingestReportSnapshotSchema.safeParse(value);
if (!result.success) {
throw new Error(`Invalid ingest report snapshot: ${z.prettifyError(result.error)}`);
}
return result.data as IngestReportSnapshot;
}