mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-22 08:38:08 +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.
230 lines
10 KiB
TypeScript
230 lines
10 KiB
TypeScript
import { join } from 'node:path';
|
|
import { describe, expect, it } from 'vitest';
|
|
import { chunkLookmlProject } from './chunk.js';
|
|
import { type ParsedLookmlProject, parseLookmlStagedDir } from './parse.js';
|
|
|
|
const FIXTURE_ROOT = join(__dirname, '../../../../test/fixtures/lookml');
|
|
|
|
describe('chunkLookmlProject — first run', () => {
|
|
it('single-model bundle → 1 WU with model + all views in rawFiles', async () => {
|
|
const stagedDir = join(FIXTURE_ROOT, 'single-model');
|
|
const project = await parseLookmlStagedDir(stagedDir);
|
|
const result = chunkLookmlProject(project);
|
|
expect(result.workUnits).toHaveLength(1);
|
|
const wu = result.workUnits[0];
|
|
expect(wu.unitKey).toBe('lookml-orders');
|
|
expect(wu.rawFiles.sort()).toEqual(['orders.model.lkml', 'views/customers.view.lkml', 'views/orders.view.lkml']);
|
|
expect(wu.peerFileIndex).toEqual([]);
|
|
expect(wu.dependencyPaths).toEqual([]);
|
|
expect(result.eviction).toBeUndefined();
|
|
});
|
|
|
|
it('multi-model bundle → 1 WU per model; shared view owned by lex-first model; others see it in dependencyPaths + peerFileIndex is pathless-index', async () => {
|
|
const stagedDir = join(FIXTURE_ROOT, 'multi-model');
|
|
const project = await parseLookmlStagedDir(stagedDir);
|
|
const result = chunkLookmlProject(project);
|
|
expect(result.workUnits).toHaveLength(2);
|
|
const marketing = result.workUnits.find((wu) => wu.unitKey === 'lookml-marketing');
|
|
const orders = result.workUnits.find((wu) => wu.unitKey === 'lookml-orders');
|
|
expect(marketing).toBeDefined();
|
|
expect(orders).toBeDefined();
|
|
if (!marketing || !orders) {
|
|
throw new Error('expected marketing and orders work units');
|
|
}
|
|
|
|
// marketing sorts before orders → marketing owns shared_dims
|
|
expect(marketing.rawFiles).toContain('views/shared_dims.view.lkml');
|
|
expect(marketing.rawFiles).toContain('views/campaigns.view.lkml');
|
|
expect(marketing.rawFiles).toContain('marketing.model.lkml');
|
|
expect(marketing.rawFiles).not.toContain('views/orders.view.lkml');
|
|
expect(marketing.dependencyPaths).toEqual([]);
|
|
|
|
// orders does NOT own shared_dims — it's in dependencyPaths (read-only upstream).
|
|
expect(orders.rawFiles).not.toContain('views/shared_dims.view.lkml');
|
|
expect(orders.dependencyPaths).toEqual(['views/shared_dims.view.lkml']);
|
|
expect(orders.rawFiles).toContain('views/orders.view.lkml');
|
|
expect(orders.rawFiles).toContain('orders.model.lkml');
|
|
|
|
// Each WU's peerFileIndex lists the OTHER model's files (paths-only index).
|
|
expect(orders.peerFileIndex).toContain('marketing.model.lkml');
|
|
expect(orders.peerFileIndex).toContain('views/campaigns.view.lkml');
|
|
// Dependency paths should not be duplicated into peerFileIndex.
|
|
expect(orders.peerFileIndex).not.toContain('views/shared_dims.view.lkml');
|
|
});
|
|
|
|
it('extends-chain fixture: single WU contains base + orders + orders_ext; chain order visible via graph', async () => {
|
|
const stagedDir = join(FIXTURE_ROOT, 'extends-chain');
|
|
const project = await parseLookmlStagedDir(stagedDir);
|
|
const result = chunkLookmlProject(project);
|
|
// One model ("orders") includes views/*.view.lkml — so all three views land in its WU.
|
|
expect(result.workUnits).toHaveLength(1);
|
|
const wu = result.workUnits[0];
|
|
expect(wu.unitKey).toBe('lookml-orders');
|
|
expect(wu.rawFiles.sort()).toEqual([
|
|
'orders.model.lkml',
|
|
'views/base.view.lkml',
|
|
'views/orders.view.lkml',
|
|
'views/orders_ext.view.lkml',
|
|
]);
|
|
expect(wu.dependencyPaths).toEqual([]); // all ancestors already in rawFiles on first run
|
|
expect(wu.notes).toMatch(/orders/);
|
|
});
|
|
|
|
it('is deterministic: two calls on the same project return structurally identical WorkUnits', async () => {
|
|
const stagedDir = join(FIXTURE_ROOT, 'multi-model');
|
|
const project = await parseLookmlStagedDir(stagedDir);
|
|
const r1 = chunkLookmlProject(project);
|
|
const r2 = chunkLookmlProject(project);
|
|
expect(r1.workUnits).toEqual(r2.workUnits);
|
|
});
|
|
|
|
it('unitKey is model-name-derived (stable across parse+chunk cycles and across re-syncs)', async () => {
|
|
const project = await parseLookmlStagedDir(join(FIXTURE_ROOT, 'multi-model'));
|
|
const { workUnits } = chunkLookmlProject(project);
|
|
expect(workUnits.map((wu) => wu.unitKey).sort()).toEqual(['lookml-marketing', 'lookml-orders']);
|
|
});
|
|
|
|
it('marks mismatched model WorkUnits as SL-disallowed and keeps wiki ingest enabled', () => {
|
|
const project: ParsedLookmlProject = {
|
|
models: [
|
|
{
|
|
path: 'b2b.model.lkml',
|
|
name: 'b2b',
|
|
includes: ['views/orders.view.lkml'],
|
|
explores: ['orders'],
|
|
connectionName: 'wrong_connection',
|
|
},
|
|
],
|
|
views: [{ path: 'views/orders.view.lkml', name: 'orders', extendsFrom: [], rawSqlTableName: 'public.orders' }],
|
|
dashboards: [],
|
|
allPaths: ['b2b.model.lkml', 'views/orders.view.lkml'],
|
|
};
|
|
|
|
const result = chunkLookmlProject(project, { mismatchedModelNames: new Set(['b2b']) });
|
|
const wu = result.workUnits[0];
|
|
|
|
expect(wu.unitKey).toBe('lookml-b2b');
|
|
expect(wu.rawFiles).toEqual(['b2b.model.lkml', 'views/orders.view.lkml']);
|
|
expect(wu.slDisallowed).toBe(true);
|
|
expect(wu.slDisallowedReason).toBe('lookml_connection_mismatch');
|
|
expect(wu.notes).toContain('[LOOKML SL WRITES DISALLOWED]');
|
|
expect(wu.notes).toContain('reason: lookml_connection_mismatch');
|
|
expect(wu.notes).toContain('Do not call sl_write_source or sl_edit_source for this WorkUnit.');
|
|
});
|
|
});
|
|
|
|
describe('chunkLookmlProject — re-sync', () => {
|
|
it("modified file in one model only emits that model's WU", async () => {
|
|
const stagedDir = join(FIXTURE_ROOT, 'multi-model');
|
|
const project = await parseLookmlStagedDir(stagedDir);
|
|
const result = chunkLookmlProject(project, {
|
|
diffSet: {
|
|
added: [],
|
|
modified: ['views/campaigns.view.lkml'],
|
|
deleted: [],
|
|
unchanged: [
|
|
'marketing.model.lkml',
|
|
'orders.model.lkml',
|
|
'views/orders.view.lkml',
|
|
'views/shared_dims.view.lkml',
|
|
],
|
|
},
|
|
});
|
|
expect(result.workUnits).toHaveLength(1);
|
|
expect(result.workUnits[0].unitKey).toBe('lookml-marketing');
|
|
});
|
|
|
|
it("added file under a model emits that model's WU with the new path in rawFiles", async () => {
|
|
const stagedDir = join(FIXTURE_ROOT, 'single-model');
|
|
const project = await parseLookmlStagedDir(stagedDir);
|
|
const result = chunkLookmlProject(project, {
|
|
diffSet: {
|
|
added: ['views/customers.view.lkml'],
|
|
modified: [],
|
|
deleted: [],
|
|
unchanged: ['orders.model.lkml', 'views/orders.view.lkml'],
|
|
},
|
|
});
|
|
expect(result.workUnits).toHaveLength(1);
|
|
expect(result.workUnits[0].rawFiles).toContain('views/customers.view.lkml');
|
|
});
|
|
|
|
it('widens dependencyPaths with transitive extends ancestors on re-sync', async () => {
|
|
const stagedDir = join(FIXTURE_ROOT, 'extends-chain');
|
|
const project = await parseLookmlStagedDir(stagedDir);
|
|
// Only orders_ext is touched; base and orders are upstream ancestors.
|
|
// Because the single-model WU's rawFiles ALREADY include all three on first run,
|
|
// they remain in rawFiles — dependencyPaths stays empty. Widening matters when
|
|
// re-sync drops some files from rawFiles, which doesn't apply for a monolithic
|
|
// single-model WU. Assert the baseline invariant.
|
|
const result = chunkLookmlProject(project, {
|
|
diffSet: {
|
|
added: [],
|
|
modified: ['views/orders_ext.view.lkml'],
|
|
deleted: [],
|
|
unchanged: ['orders.model.lkml', 'views/base.view.lkml', 'views/orders.view.lkml'],
|
|
},
|
|
});
|
|
expect(result.workUnits).toHaveLength(1);
|
|
const wu = result.workUnits[0];
|
|
expect(wu.rawFiles).toContain('views/orders_ext.view.lkml');
|
|
// Ancestors already in rawFiles → not duplicated into dependencyPaths.
|
|
expect(wu.dependencyPaths).toEqual([]);
|
|
});
|
|
|
|
it('widens dependencyPaths when an ancestor is OUTSIDE the WU (synthesized cross-model case)', () => {
|
|
// Synthesize a scenario in-memory: two models, "a" owns base.view.lkml,
|
|
// "b" owns derived.view.lkml which extends base. A diff that only touches
|
|
// derived.view.lkml should widen b's WU with base.view.lkml in dependencyPaths
|
|
// if base lives outside b's rawFiles. In practice with the current emit rules,
|
|
// base.view.lkml would already be in dependencyPaths because model b lists
|
|
// base.view.lkml under its `include:`. Here we confirm the widening is idempotent.
|
|
const project: ParsedLookmlProject = {
|
|
models: [
|
|
{ path: 'a.model.lkml', name: 'a', includes: ['views/base.view.lkml'], explores: [], connectionName: null },
|
|
{
|
|
path: 'b.model.lkml',
|
|
name: 'b',
|
|
includes: ['views/base.view.lkml', 'views/derived.view.lkml'],
|
|
explores: [],
|
|
connectionName: null,
|
|
},
|
|
],
|
|
views: [
|
|
{ path: 'views/base.view.lkml', name: 'base', extendsFrom: [], rawSqlTableName: null },
|
|
{ path: 'views/derived.view.lkml', name: 'derived', extendsFrom: ['base'], rawSqlTableName: null },
|
|
],
|
|
dashboards: [],
|
|
allPaths: ['a.model.lkml', 'b.model.lkml', 'views/base.view.lkml', 'views/derived.view.lkml'],
|
|
};
|
|
const result = chunkLookmlProject(project, {
|
|
diffSet: {
|
|
added: [],
|
|
modified: ['views/derived.view.lkml'],
|
|
deleted: [],
|
|
unchanged: ['a.model.lkml', 'b.model.lkml', 'views/base.view.lkml'],
|
|
},
|
|
});
|
|
const b = result.workUnits.find((wu) => wu.unitKey === 'lookml-b');
|
|
expect(b).toBeDefined();
|
|
if (!b) {
|
|
throw new Error('expected lookml-b work unit');
|
|
}
|
|
expect(b.dependencyPaths).toContain('views/base.view.lkml');
|
|
});
|
|
|
|
it('passes through diffSet.deleted as an EvictionUnit', async () => {
|
|
const project = await parseLookmlStagedDir(join(FIXTURE_ROOT, 'single-model'));
|
|
const result = chunkLookmlProject(project, {
|
|
diffSet: {
|
|
added: [],
|
|
modified: [],
|
|
deleted: ['views/zombie.view.lkml'],
|
|
unchanged: ['orders.model.lkml', 'views/customers.view.lkml', 'views/orders.view.lkml'],
|
|
},
|
|
});
|
|
expect(result.eviction).toEqual({ deletedRawPaths: ['views/zombie.view.lkml'] });
|
|
// No WU emitted because no current files are touched.
|
|
expect(result.workUnits).toEqual([]);
|
|
});
|
|
});
|