mirror of
https://github.com/Kaelio/ktx.git
synced 2026-07-07 11:02:11 +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.
166 lines
4.8 KiB
TypeScript
166 lines
4.8 KiB
TypeScript
import { mkdir, mkdtemp, rm, writeFile } from 'node:fs/promises';
|
|
import { tmpdir } from 'node:os';
|
|
import { join } from 'node:path';
|
|
import { afterEach, beforeEach, describe, expect, it } from 'vitest';
|
|
import { parseLookmlStagedDir } from './parse.js';
|
|
|
|
describe('parseLookmlStagedDir', () => {
|
|
let stagedDir: string;
|
|
|
|
beforeEach(async () => {
|
|
stagedDir = await mkdtemp(join(tmpdir(), 'lkml-parse-'));
|
|
});
|
|
|
|
afterEach(async () => rm(stagedDir, { recursive: true, force: true }));
|
|
|
|
it('parses a single view file and reports it under views with a relative path', async () => {
|
|
await writeFile(
|
|
join(stagedDir, 'customers.view.lkml'),
|
|
`view: customers {
|
|
dimension: id {
|
|
type: number
|
|
primary_key: yes
|
|
sql: \${TABLE}.id ;;
|
|
}
|
|
}
|
|
`,
|
|
'utf-8',
|
|
);
|
|
const result = await parseLookmlStagedDir(stagedDir);
|
|
expect(result.views.map((v) => v.path)).toEqual(['customers.view.lkml']);
|
|
expect(result.views[0].name).toBe('customers');
|
|
expect(result.models).toEqual([]);
|
|
expect(result.dashboards).toEqual([]);
|
|
});
|
|
|
|
it('parses a model file and extracts include globs', async () => {
|
|
await mkdir(join(stagedDir, 'views'), { recursive: true });
|
|
await writeFile(
|
|
join(stagedDir, 'orders.model.lkml'),
|
|
`connection: "my_bq"
|
|
|
|
include: "views/*.view.lkml"
|
|
|
|
explore: orders {}
|
|
`,
|
|
'utf-8',
|
|
);
|
|
await writeFile(
|
|
join(stagedDir, 'views', 'orders.view.lkml'),
|
|
`view: orders {
|
|
sql_table_name: public.orders ;;
|
|
}
|
|
`,
|
|
'utf-8',
|
|
);
|
|
const result = await parseLookmlStagedDir(stagedDir);
|
|
expect(result.models.map((m) => m.path)).toEqual(['orders.model.lkml']);
|
|
expect(result.models[0].name).toBe('orders');
|
|
expect(result.models[0].includes).toEqual(['views/*.view.lkml']);
|
|
expect(result.models[0].explores).toEqual(['orders']);
|
|
expect(result.views.map((v) => v.path)).toEqual(['views/orders.view.lkml']);
|
|
});
|
|
|
|
it('extracts model connection names and raw view sql_table_name declarations', async () => {
|
|
await mkdir(join(stagedDir, 'views'), { recursive: true });
|
|
await writeFile(
|
|
join(stagedDir, 'b2b.model.lkml'),
|
|
`connection: "b2b_sandbox_bq"
|
|
|
|
include: "views/*.view.lkml"
|
|
|
|
explore: orders {}
|
|
`,
|
|
'utf-8',
|
|
);
|
|
await writeFile(
|
|
join(stagedDir, 'views', 'orders.view.lkml'),
|
|
`view: orders {
|
|
sql_table_name: analytics.orders AS o ;;
|
|
}
|
|
`,
|
|
'utf-8',
|
|
);
|
|
|
|
const result = await parseLookmlStagedDir(stagedDir);
|
|
|
|
expect(result.models[0]).toMatchObject({
|
|
path: 'b2b.model.lkml',
|
|
name: 'b2b',
|
|
connectionName: 'b2b_sandbox_bq',
|
|
});
|
|
expect(result.views[0]).toMatchObject({
|
|
path: 'views/orders.view.lkml',
|
|
name: 'orders',
|
|
rawSqlTableName: 'analytics.orders AS o',
|
|
});
|
|
});
|
|
|
|
it('captures extends declarations on views', async () => {
|
|
await writeFile(
|
|
join(stagedDir, 'base.view.lkml'),
|
|
`view: base {
|
|
dimension: id {
|
|
type: number
|
|
primary_key: yes
|
|
sql: \${TABLE}.id ;;
|
|
}
|
|
}
|
|
`,
|
|
'utf-8',
|
|
);
|
|
await writeFile(
|
|
join(stagedDir, 'orders.view.lkml'),
|
|
`view: orders {
|
|
extends: [base]
|
|
sql_table_name: public.orders ;;
|
|
}
|
|
`,
|
|
'utf-8',
|
|
);
|
|
const result = await parseLookmlStagedDir(stagedDir);
|
|
const orders = result.views.find((v) => v.name === 'orders');
|
|
expect(orders).toBeDefined();
|
|
if (!orders) {
|
|
throw new Error('expected orders view');
|
|
}
|
|
expect(orders.extendsFrom).toEqual(['base']);
|
|
});
|
|
|
|
it('collects .dashboard.lkml files structurally (no deep parsing)', async () => {
|
|
await writeFile(join(stagedDir, 'overview.dashboard.lkml'), '- dashboard: overview\n title: Overview\n', 'utf-8');
|
|
const result = await parseLookmlStagedDir(stagedDir);
|
|
expect(result.dashboards.map((d) => d.path)).toEqual(['overview.dashboard.lkml']);
|
|
expect(result.dashboards[0].name).toBe('overview');
|
|
});
|
|
|
|
it('ignores non-.lkml files', async () => {
|
|
await writeFile(join(stagedDir, 'README.md'), '# readme\n', 'utf-8');
|
|
await writeFile(join(stagedDir, 'notes.txt'), 'note\n', 'utf-8');
|
|
const result = await parseLookmlStagedDir(stagedDir);
|
|
expect(result.models).toEqual([]);
|
|
expect(result.views).toEqual([]);
|
|
expect(result.dashboards).toEqual([]);
|
|
});
|
|
|
|
it('returns a sorted deterministic order across runs', async () => {
|
|
await writeFile(
|
|
join(stagedDir, 'zeta.view.lkml'),
|
|
`view: zeta {
|
|
}
|
|
`,
|
|
'utf-8',
|
|
);
|
|
await writeFile(
|
|
join(stagedDir, 'alpha.view.lkml'),
|
|
`view: alpha {
|
|
}
|
|
`,
|
|
'utf-8',
|
|
);
|
|
const r1 = await parseLookmlStagedDir(stagedDir);
|
|
const r2 = await parseLookmlStagedDir(stagedDir);
|
|
expect(r1.views.map((v) => v.path)).toEqual(['alpha.view.lkml', 'zeta.view.lkml']);
|
|
expect(r2.views.map((v) => v.path)).toEqual(r1.views.map((v) => v.path));
|
|
});
|
|
});
|