mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +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.
245 lines
10 KiB
Bash
Executable file
245 lines
10 KiB
Bash
Executable file
#!/usr/bin/env bash
|
|
set -euo pipefail
|
|
|
|
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
|
EXAMPLE_DIR="$(cd "$SCRIPT_DIR/.." && pwd)"
|
|
KTX_ROOT="$(cd "$EXAMPLE_DIR/../.." && pwd)"
|
|
COMPOSE_FILE="$EXAMPLE_DIR/docker-compose.yml"
|
|
PROJECT_PARENT="${KTX_POSTGRES_HISTORIC_PROJECT_PARENT:-$(mktemp -d)}"
|
|
PROJECT_DIR="$PROJECT_PARENT/postgres-historic-ktx"
|
|
KTX_BIN="$KTX_ROOT/packages/cli/dist/bin.js"
|
|
MAX_STAGE_SECONDS="${KTX_POSTGRES_HISTORIC_MAX_STAGE_SECONDS:-60}"
|
|
export KTX_RUNTIME_ROOT="$PROJECT_PARENT/managed-runtime"
|
|
unset KTX_DAEMON_URL
|
|
unset KTX_SQL_ANALYSIS_URL
|
|
|
|
cleanup() {
|
|
if [[ -f "$KTX_BIN" ]]; then
|
|
node "$KTX_BIN" dev runtime stop >/dev/null 2>&1 || true
|
|
fi
|
|
if [[ "${KTX_POSTGRES_HISTORIC_KEEP_DOCKER:-0}" != "1" ]]; then
|
|
docker compose -f "$COMPOSE_FILE" down -v >/dev/null 2>&1 || true
|
|
fi
|
|
}
|
|
trap cleanup EXIT
|
|
|
|
latest_manifest() {
|
|
find "$PROJECT_DIR/raw-sources/warehouse/historic-sql" -name manifest.json | sort | tail -n 1
|
|
}
|
|
|
|
assert_unified_snapshot() {
|
|
local manifest_path="$1"
|
|
node - "$manifest_path" <<'NODE'
|
|
const { dirname, join } = require('node:path');
|
|
const { existsSync, readFileSync, readdirSync } = require('node:fs');
|
|
|
|
const manifestPath = process.argv[2];
|
|
const manifest = JSON.parse(readFileSync(manifestPath, 'utf8'));
|
|
function assert(condition, message) {
|
|
if (!condition) throw new Error(message);
|
|
}
|
|
|
|
assert(manifest.source === 'historic-sql', `Expected source historic-sql, got ${manifest.source}`);
|
|
assert(manifest.dialect === 'postgres', `Expected dialect postgres, got ${manifest.dialect}`);
|
|
assert(Number.isInteger(manifest.snapshotRowCount) && manifest.snapshotRowCount > 0, 'Expected snapshotRowCount > 0');
|
|
assert(Number.isInteger(manifest.touchedTableCount) && manifest.touchedTableCount > 0, 'Expected touchedTableCount > 0');
|
|
assert(Number.isInteger(manifest.parseFailures), 'Expected numeric parseFailures');
|
|
assert(Array.isArray(manifest.warnings), 'Expected warnings array');
|
|
assert(Array.isArray(manifest.probeWarnings), 'Expected probeWarnings array');
|
|
const legacyKeys = [
|
|
['de', 'graded'],
|
|
['baseline', 'FirstRun'],
|
|
['pgServer', 'Version'],
|
|
['stats', 'ResetAt'],
|
|
['templates'],
|
|
].map((parts) => parts.join(''));
|
|
for (const legacyKey of legacyKeys) {
|
|
assert(!(legacyKey in manifest), `Legacy manifest key is still present: ${legacyKey}`);
|
|
}
|
|
|
|
function assertPatternShards(root) {
|
|
const shardDir = join(root, 'patterns-input');
|
|
assert(existsSync(shardDir), 'Expected patterns-input shard directory');
|
|
const shardFiles = readdirSync(shardDir)
|
|
.filter((file) => /^part-\d{4}\.json$/.test(file))
|
|
.sort()
|
|
.map((file) => `patterns-input/${file}`);
|
|
assert(shardFiles.length > 0, 'Expected at least one pattern shard file');
|
|
|
|
for (const shardFile of shardFiles) {
|
|
const shard = JSON.parse(readFileSync(join(root, shardFile), 'utf8'));
|
|
assert(Array.isArray(shard.templates), `${shardFile}: expected templates array`);
|
|
assert(shard.templates.length > 0, `${shardFile}: expected at least one template`);
|
|
assert(
|
|
shard.templates.every((template) => Array.isArray(template.tablesTouched) && template.tablesTouched.length >= 2),
|
|
`${shardFile}: expected only cross-table pattern candidates`,
|
|
);
|
|
}
|
|
|
|
return shardFiles;
|
|
}
|
|
|
|
const root = dirname(manifestPath);
|
|
const tableDir = join(root, 'tables');
|
|
const tableFiles = readdirSync(tableDir).filter((file) => file.endsWith('.json')).sort();
|
|
assert(tableFiles.length === manifest.touchedTableCount, `Expected ${manifest.touchedTableCount} table files, got ${tableFiles.length}`);
|
|
|
|
const firstTable = JSON.parse(readFileSync(join(tableDir, tableFiles[0]), 'utf8'));
|
|
assert(typeof firstTable.table === 'string' && firstTable.table.length > 0, 'Expected staged table name');
|
|
assert(firstTable.stats && typeof firstTable.stats.executionsBucket === 'string', 'Expected bucketed table stats');
|
|
assert(firstTable.columnsByClause && typeof firstTable.columnsByClause === 'object', 'Expected columnsByClause object');
|
|
assert(Array.isArray(firstTable.observedJoins), 'Expected observedJoins array');
|
|
assert(Array.isArray(firstTable.topTemplates) && firstTable.topTemplates.length > 0, 'Expected topTemplates');
|
|
|
|
const patterns = JSON.parse(readFileSync(join(root, 'patterns-input.json'), 'utf8'));
|
|
assert(Array.isArray(patterns.templates) && patterns.templates.length > 0, 'Expected patterns-input audit templates');
|
|
assert(
|
|
patterns.templates.every((template) => Array.isArray(template.tablesTouched) && template.tablesTouched.length > 0),
|
|
'Expected every audit pattern template to have touched tables',
|
|
);
|
|
const shardFiles = assertPatternShards(root);
|
|
assert(
|
|
shardFiles.length <= patterns.templates.length,
|
|
`Expected shard count ${shardFiles.length} to be no greater than audit template count ${patterns.templates.length}`,
|
|
);
|
|
NODE
|
|
}
|
|
|
|
assert_stage_record() {
|
|
local record_path="$1"
|
|
local label="$2"
|
|
local expected_work_units="$3"
|
|
node - "$record_path" "$label" "$expected_work_units" "$MAX_STAGE_SECONDS" <<'NODE'
|
|
const { readFileSync } = require('node:fs');
|
|
|
|
const record = JSON.parse(readFileSync(process.argv[2], 'utf8'));
|
|
const label = process.argv[3];
|
|
const expectedWorkUnits = process.argv[4];
|
|
const maxSeconds = Number(process.argv[5]);
|
|
function assert(condition, message) {
|
|
if (!condition) throw new Error(message);
|
|
}
|
|
|
|
assert(record.status === 'done', `${label}: expected status done, got ${record.status}`);
|
|
assert(record.adapter === 'historic-sql', `${label}: expected historic-sql adapter`);
|
|
assert(record.connectionId === 'warehouse', `${label}: expected warehouse connection`);
|
|
assert(record.rawFileCount >= 4, `${label}: expected manifest, audit patterns input, pattern shard, and at least one table file`);
|
|
assert(Array.isArray(record.errors) && record.errors.length === 0, `${label}: expected no errors`);
|
|
|
|
if (expectedWorkUnits === 'zero') {
|
|
assert(record.workUnitCount === 0, `${label}: expected zero WorkUnits, got ${record.workUnitCount}`);
|
|
assert(Array.isArray(record.workUnits) && record.workUnits.length === 0, `${label}: expected empty workUnits`);
|
|
} else if (expectedWorkUnits === 'nonzero') {
|
|
assert(record.workUnitCount > 0, `${label}: expected nonzero WorkUnits`);
|
|
const patternUnits = record.workUnits.filter((unit) => /^historic-sql-patterns-part-\d{4}$/.test(unit.unitKey));
|
|
const patternShardRawFilePattern = new RegExp('^patterns-input/part-\\d{4}\\.json$');
|
|
assert(patternUnits.length > 0, `${label}: expected sharded patterns WorkUnit`);
|
|
for (const unit of patternUnits) {
|
|
assert(
|
|
unit.rawFiles.some((rawFile) => patternShardRawFilePattern.test(rawFile)),
|
|
`${label}: expected ${unit.unitKey} to read a pattern shard`,
|
|
);
|
|
assert(
|
|
!unit.rawFiles.includes('patterns-input.json'),
|
|
`${label}: expected ${unit.unitKey} not to schedule the full audit patterns input`,
|
|
);
|
|
}
|
|
assert(record.workUnits.some((unit) => unit.unitKey.startsWith('historic-sql-table-')), `${label}: expected table WorkUnit`);
|
|
} else {
|
|
throw new Error(`${label}: unknown expected work unit mode ${expectedWorkUnits}`);
|
|
}
|
|
|
|
const elapsedMs = Date.parse(record.completedAt) - Date.parse(record.startedAt);
|
|
assert(Number.isFinite(elapsedMs) && elapsedMs >= 0, `${label}: invalid elapsed time`);
|
|
assert(elapsedMs <= maxSeconds * 1000, `${label}: stage-only ingest took ${elapsedMs}ms, over ${maxSeconds}s`);
|
|
NODE
|
|
}
|
|
|
|
run_historic_stage_only() {
|
|
local job_id="$1"
|
|
local record_path="$2"
|
|
node - "$KTX_ROOT" "$PROJECT_DIR" "$job_id" "$record_path" <<'NODE'
|
|
const { writeFile } = await import('node:fs/promises');
|
|
const { join } = await import('node:path');
|
|
|
|
const ktxRoot = process.argv[2];
|
|
const projectDir = process.argv[3];
|
|
const jobId = process.argv[4];
|
|
const recordPath = process.argv[5];
|
|
const { loadKtxProject } = await import(join(ktxRoot, 'packages/context/dist/project/index.js'));
|
|
const { runLocalStageOnlyIngest } = await import(join(ktxRoot, 'packages/context/dist/ingest/index.js'));
|
|
const { createKtxCliLocalIngestAdapters } = await import(join(ktxRoot, 'packages/cli/dist/local-adapters.js'));
|
|
const { getKtxCliPackageInfo } = await import(join(ktxRoot, 'packages/cli/dist/index.js'));
|
|
|
|
const project = await loadKtxProject({ projectDir });
|
|
const cliVersion = getKtxCliPackageInfo().version;
|
|
const managedRuntimeIo = { stdout: process.stdout, stderr: process.stderr };
|
|
const adapters = createKtxCliLocalIngestAdapters(project, {
|
|
historicSqlConnectionId: 'warehouse',
|
|
managedDaemon: {
|
|
cliVersion,
|
|
installPolicy: 'auto',
|
|
io: managedRuntimeIo,
|
|
},
|
|
});
|
|
const adapter = adapters.find((candidate) => candidate.source === 'historic-sql');
|
|
if (!adapter) throw new Error('historic-sql adapter was not registered for local run');
|
|
const record = await runLocalStageOnlyIngest({
|
|
project,
|
|
adapters,
|
|
adapter: 'historic-sql',
|
|
connectionId: 'warehouse',
|
|
trigger: 'manual_resync',
|
|
jobId,
|
|
});
|
|
await writeFile(recordPath, `${JSON.stringify(record, null, 2)}\n`, 'utf8');
|
|
console.log(`${record.syncId} workUnits=${record.workUnitCount}`);
|
|
NODE
|
|
}
|
|
|
|
cd "$KTX_ROOT"
|
|
pnpm --filter @kaelio/ktx run build
|
|
|
|
docker compose -f "$COMPOSE_FILE" up -d --wait
|
|
"$EXAMPLE_DIR/scripts/generate-workload.sh" base
|
|
|
|
export WAREHOUSE_DATABASE_URL="${WAREHOUSE_DATABASE_URL:-postgresql://ktx_reader:ktx_reader@127.0.0.1:55432/analytics}" # pragma: allowlist secret
|
|
node "$KTX_BIN" --project-dir "$PROJECT_DIR" setup \
|
|
--new \
|
|
--skip-agents \
|
|
--skip-llm \
|
|
--skip-embeddings \
|
|
--skip-sources \
|
|
--database postgres \
|
|
--new-database-connection-id warehouse \
|
|
--database-url env:WAREHOUSE_DATABASE_URL \
|
|
--database-schema public \
|
|
--enable-query-history \
|
|
--query-history-min-executions 2 \
|
|
--yes \
|
|
--no-input
|
|
|
|
node "$KTX_BIN" dev runtime install --yes
|
|
node "$KTX_BIN" dev runtime start
|
|
|
|
FIRST_RECORD="$PROJECT_PARENT/first-record.json"
|
|
run_historic_stage_only "historic-first-$$" "$FIRST_RECORD"
|
|
FIRST_MANIFEST="$(latest_manifest)"
|
|
assert_unified_snapshot "$FIRST_MANIFEST"
|
|
assert_stage_record "$FIRST_RECORD" first nonzero
|
|
|
|
UNCHANGED_RECORD="$PROJECT_PARENT/unchanged-record.json"
|
|
run_historic_stage_only "historic-unchanged-$$" "$UNCHANGED_RECORD"
|
|
UNCHANGED_MANIFEST="$(latest_manifest)"
|
|
assert_unified_snapshot "$UNCHANGED_MANIFEST"
|
|
assert_stage_record "$UNCHANGED_RECORD" unchanged zero
|
|
|
|
"$EXAMPLE_DIR/scripts/generate-workload.sh" extra
|
|
CHANGED_RECORD="$PROJECT_PARENT/changed-record.json"
|
|
run_historic_stage_only "historic-changed-$$" "$CHANGED_RECORD"
|
|
CHANGED_MANIFEST="$(latest_manifest)"
|
|
assert_unified_snapshot "$CHANGED_MANIFEST"
|
|
assert_stage_record "$CHANGED_RECORD" changed nonzero
|
|
|
|
echo "Postgres historic SQL smoke passed"
|
|
echo "Project dir: $PROJECT_DIR"
|