ktx/packages/cli/src/setup-project.test.ts

347 lines
14 KiB
TypeScript
Raw Normal View History

2026-05-10 23:12:26 +02:00
import { mkdir, mkdtemp, readFile, rm, stat, writeFile } from 'node:fs/promises';
import { tmpdir } from 'node:os';
import { join } from 'node:path';
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
import { initKtxProject } from './context/project/project.js';
import { parseKtxProjectConfig } from './context/project/config.js';
import { readKtxSetupState } from './context/project/setup-config.js';
2026-05-10 23:12:26 +02:00
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { gray } from './io/symbols.js';
2026-05-10 23:51:24 +02:00
import { type KtxSetupProjectPromptAdapter, runKtxSetupProjectStep } from './setup-project.js';
2026-05-10 23:12:26 +02:00
function makeIo(options: { stdoutIsTty?: boolean } = {}) {
let stdout = '';
let stderr = '';
return {
io: {
stdout: {
isTTY: options.stdoutIsTty,
write: (chunk: string) => {
stdout += chunk;
},
},
stderr: {
write: (chunk: string) => {
stderr += chunk;
},
},
},
stdout: () => stdout,
stderr: () => stderr,
};
}
function makePromptAdapter(options: { choice?: string; choices?: string[]; textValue?: string; textValues?: string[] }) {
const choices = [...(options.choices ?? (options.choice ? [options.choice] : []))];
const textValues = [...(options.textValues ?? (options.textValue !== undefined ? [options.textValue] : []))];
return {
select: vi.fn(async () => choices.shift() ?? 'exit'),
text: vi.fn(async () => textValues.shift() ?? ''),
cancel: vi.fn(),
2026-05-10 23:51:24 +02:00
} satisfies KtxSetupProjectPromptAdapter;
2026-05-10 23:12:26 +02:00
}
function defaultSubfolderLabel(parentDir: string): string {
const childName = 'ktx-project';
const childDir = join(parentDir, childName);
return `New subfolder (${gray(childDir.slice(0, -childName.length))}${childName})`;
}
2026-05-10 23:12:26 +02:00
describe('setup project step', () => {
let tempDir: string;
beforeEach(async () => {
2026-05-10 23:51:24 +02:00
tempDir = await mkdtemp(join(tmpdir(), 'ktx-setup-project-'));
2026-05-10 23:12:26 +02:00
});
afterEach(async () => {
await rm(tempDir, { recursive: true, force: true });
});
it('creates a new project in non-interactive auto mode with --yes and marks the project step complete', async () => {
2026-05-10 23:12:26 +02:00
const projectDir = join(tempDir, 'warehouse');
const testIo = makeIo();
2026-05-10 23:51:24 +02:00
const result = await runKtxSetupProjectStep(
{ projectDir, mode: 'auto', inputMode: 'disabled', yes: true },
2026-05-10 23:12:26 +02:00
testIo.io,
);
expect(result.status).toBe('ready');
expect(result.projectDir).toBe(projectDir);
expect(await readFile(join(projectDir, 'ktx.yaml'), 'utf-8')).not.toContain('completed_steps:');
expect(await readKtxSetupState(projectDir)).toEqual({ completed_steps: ['project'] });
2026-05-10 23:12:26 +02:00
await expect(stat(join(projectDir, '.git'))).resolves.toBeDefined();
2026-05-10 23:51:24 +02:00
await expect(readFile(join(projectDir, '.ktx/.gitignore'), 'utf-8')).resolves.toContain('secrets/');
2026-05-10 23:12:26 +02:00
expect(testIo.stdout()).toContain(`Project: ${projectDir}`);
expect(testIo.stderr()).toBe('');
});
it('loads an existing project in auto mode and drops config setup progress', async () => {
2026-05-10 23:12:26 +02:00
const projectDir = join(tempDir, 'warehouse');
await initKtxProject({ projectDir });
2026-05-10 23:12:26 +02:00
await writeFile(
2026-05-10 23:51:24 +02:00
join(projectDir, 'ktx.yaml'),
2026-05-10 23:12:26 +02:00
[
'setup:',
' database_connection_ids:',
' - warehouse',
' completed_steps:',
' - llm',
'connections: {}',
].join('\n'),
'utf-8',
);
2026-05-10 23:51:24 +02:00
const result = await runKtxSetupProjectStep(
{ projectDir, mode: 'auto', inputMode: 'disabled', yes: false },
2026-05-10 23:12:26 +02:00
makeIo().io,
);
expect(result.status).toBe('ready');
2026-05-10 23:51:24 +02:00
const config = parseKtxProjectConfig(await readFile(join(projectDir, 'ktx.yaml'), 'utf-8'));
2026-05-10 23:12:26 +02:00
expect(config.setup).toEqual({
database_connection_ids: ['warehouse'],
});
expect(await readFile(join(projectDir, 'ktx.yaml'), 'utf-8')).not.toContain('completed_steps:');
expect(await readKtxSetupState(projectDir)).toEqual({ completed_steps: ['project'] });
2026-05-10 23:12:26 +02:00
});
it('creates a missing auto-mode project only when --yes is present in no-input mode', async () => {
const projectDir = join(tempDir, 'warehouse');
const rejectedIo = makeIo();
const acceptedIo = makeIo();
await expect(
2026-05-10 23:51:24 +02:00
runKtxSetupProjectStep({ projectDir, mode: 'auto', inputMode: 'disabled', yes: false }, rejectedIo.io),
2026-05-10 23:12:26 +02:00
).resolves.toMatchObject({ status: 'missing-input' });
expect(rejectedIo.stderr()).toContain('Missing setup choice: pass --yes');
2026-05-10 23:51:24 +02:00
await expect(stat(join(projectDir, 'ktx.yaml'))).rejects.toThrow();
2026-05-10 23:12:26 +02:00
await expect(
2026-05-10 23:51:24 +02:00
runKtxSetupProjectStep({ projectDir, mode: 'auto', inputMode: 'disabled', yes: true }, acceptedIo.io),
2026-05-10 23:12:26 +02:00
).resolves.toMatchObject({ status: 'ready', projectDir });
2026-05-10 23:51:24 +02:00
await expect(stat(join(projectDir, 'ktx.yaml'))).resolves.toBeDefined();
2026-05-10 23:12:26 +02:00
});
it('fails clearly in no-input auto mode when ktx.yaml is missing and --yes is absent', async () => {
2026-05-10 23:12:26 +02:00
const projectDir = join(tempDir, 'warehouse');
const testIo = makeIo();
await expect(
runKtxSetupProjectStep({ projectDir, mode: 'auto', inputMode: 'disabled', yes: false }, testIo.io),
2026-05-10 23:12:26 +02:00
).resolves.toMatchObject({ status: 'missing-input' });
expect(testIo.stderr()).toContain('Missing setup choice: pass --yes');
2026-05-10 23:12:26 +02:00
});
it('prompts to use the current directory and creates a project in interactive auto mode', async () => {
const projectDir = join(tempDir, 'warehouse');
const prompts = makePromptAdapter({ choice: 'current' });
const testIo = makeIo({ stdoutIsTty: true });
2026-05-10 23:51:24 +02:00
const result = await runKtxSetupProjectStep(
2026-05-10 23:12:26 +02:00
{ projectDir, mode: 'auto', inputMode: 'auto', yes: false },
testIo.io,
{ prompts },
);
expect(result.status).toBe('ready');
expect(result.projectDir).toBe(projectDir);
expect(prompts.select).toHaveBeenCalledWith(
expect.objectContaining({
message: 'Where should KTX create the project?',
2026-05-10 23:12:26 +02:00
options: [
expect.objectContaining({ value: 'current', label: `Current directory (${projectDir})` }),
expect.objectContaining({
value: 'new-default',
label: defaultSubfolderLabel(projectDir),
}),
expect.objectContaining({ value: 'new-custom', label: 'Custom path' }),
2026-05-10 23:12:26 +02:00
expect.objectContaining({ value: 'exit', label: 'Exit' }),
],
}),
);
expect(prompts.text).not.toHaveBeenCalled();
expect(await readFile(join(projectDir, 'ktx.yaml'), 'utf-8')).not.toContain('completed_steps:');
expect(await readKtxSetupState(projectDir)).toEqual({ completed_steps: ['project'] });
2026-05-10 23:12:26 +02:00
});
it('offers an absolute default destination for a new project folder', async () => {
const startDir = join(tempDir, 'start');
2026-05-10 23:51:24 +02:00
const projectDir = join(startDir, 'ktx-project');
const prompts = makePromptAdapter({ choices: ['new-default', 'create'] });
2026-05-10 23:12:26 +02:00
const testIo = makeIo({ stdoutIsTty: true });
2026-05-10 23:51:24 +02:00
const result = await runKtxSetupProjectStep(
2026-05-10 23:12:26 +02:00
{ projectDir: startDir, mode: 'auto', inputMode: 'auto', yes: false },
testIo.io,
{ prompts },
);
expect(result.status).toBe('ready');
expect(result.projectDir).toBe(projectDir);
expect(prompts.select).toHaveBeenNthCalledWith(
1,
2026-05-10 23:12:26 +02:00
expect.objectContaining({
2026-05-10 23:51:24 +02:00
message: 'Where should KTX create the project?',
options: expect.arrayContaining([
expect.objectContaining({
value: 'new-default',
label: defaultSubfolderLabel(startDir),
}),
]),
2026-05-10 23:12:26 +02:00
}),
);
expect(prompts.select).toHaveBeenNthCalledWith(
2,
2026-05-10 23:51:24 +02:00
expect.objectContaining({ message: `Create KTX project at ${projectDir}?` }),
2026-05-10 23:12:26 +02:00
);
expect(prompts.text).not.toHaveBeenCalled();
expect(result.status === 'ready' ? result.project.configPath : '').toBe(join(projectDir, 'ktx.yaml'));
expect(testIo.stdout()).toContain(`│ KTX will create:\n│ ${projectDir}`);
2026-05-10 23:51:24 +02:00
await expect(stat(join(projectDir, 'ktx.yaml'))).resolves.toBeDefined();
2026-05-10 23:12:26 +02:00
});
it('prompts for a custom path and resolves it inside the current setup directory', async () => {
const startDir = join(tempDir, 'start');
2026-05-10 23:51:24 +02:00
const projectDir = join(startDir, 'analytics-ktx');
const prompts = makePromptAdapter({ choices: ['new-custom', 'create'], textValue: 'analytics-ktx' });
2026-05-10 23:12:26 +02:00
2026-05-10 23:51:24 +02:00
const result = await runKtxSetupProjectStep(
2026-05-10 23:12:26 +02:00
{ projectDir: startDir, mode: 'auto', inputMode: 'auto', yes: false },
makeIo({ stdoutIsTty: true }).io,
{ prompts },
);
expect(result.status).toBe('ready');
expect(result.projectDir).toBe(projectDir);
expect(prompts.text).toHaveBeenCalledWith(
expect.objectContaining({
message: 'Project folder path\n│ Press Escape to go back.\n│',
2026-05-10 23:51:24 +02:00
placeholder: './analytics-ktx, ~/analytics-ktx, or /Users/you/projects/analytics-ktx',
2026-05-10 23:12:26 +02:00
}),
);
2026-05-10 23:51:24 +02:00
await expect(stat(join(projectDir, 'ktx.yaml'))).resolves.toBeDefined();
2026-05-10 23:12:26 +02:00
});
it('expands a custom home-directory path before creating a new project', async () => {
const startDir = join(tempDir, 'start');
const homeDir = join(tempDir, 'home');
2026-05-10 23:51:24 +02:00
const projectDir = join(homeDir, 'analytics-ktx');
const prompts = makePromptAdapter({ choices: ['new-custom', 'create'], textValue: '~/analytics-ktx' });
2026-05-10 23:12:26 +02:00
2026-05-10 23:51:24 +02:00
const result = await runKtxSetupProjectStep(
2026-05-10 23:12:26 +02:00
{ projectDir: startDir, mode: 'auto', inputMode: 'auto', yes: false },
makeIo({ stdoutIsTty: true }).io,
{ prompts, homeDir },
);
expect(result.status).toBe('ready');
expect(result.projectDir).toBe(projectDir);
2026-05-10 23:51:24 +02:00
await expect(stat(join(projectDir, 'ktx.yaml'))).resolves.toBeDefined();
2026-05-10 23:12:26 +02:00
});
it('confirms a custom new project path and lets Back return to the project choice', async () => {
const startDir = join(tempDir, 'start');
const homeDir = join(tempDir, 'home');
2026-05-10 23:51:24 +02:00
const customProjectDir = join(homeDir, 'analytics-ktx');
2026-05-10 23:12:26 +02:00
const prompts = makePromptAdapter({
choices: ['new-custom', 'back', 'exit'],
2026-05-10 23:51:24 +02:00
textValue: '~/analytics-ktx',
2026-05-10 23:12:26 +02:00
});
2026-05-10 23:51:24 +02:00
const result = await runKtxSetupProjectStep(
2026-05-10 23:12:26 +02:00
{ projectDir: startDir, mode: 'auto', inputMode: 'auto', yes: false },
makeIo({ stdoutIsTty: true }).io,
{ prompts, homeDir },
);
expect(result.status).toBe('cancelled');
expect(result.projectDir).toBe(startDir);
expect(prompts.select).toHaveBeenNthCalledWith(
2,
2026-05-10 23:12:26 +02:00
expect.objectContaining({
2026-05-10 23:51:24 +02:00
message: `Create KTX project at ${customProjectDir}?`,
2026-05-10 23:12:26 +02:00
options: [
expect.objectContaining({ value: 'create', label: 'Create project' }),
expect.objectContaining({ value: 'choose-another', label: 'Choose another folder' }),
expect.objectContaining({ value: 'back', label: 'Back' }),
],
}),
);
expect(prompts.select).toHaveBeenNthCalledWith(
3,
expect.objectContaining({ message: 'Where should KTX create the project?' }),
2026-05-10 23:12:26 +02:00
);
2026-05-10 23:51:24 +02:00
await expect(stat(join(customProjectDir, 'ktx.yaml'))).rejects.toThrow();
2026-05-10 23:12:26 +02:00
});
it('rejects an empty new folder path without creating a project in the process cwd', async () => {
const startDir = join(tempDir, 'start');
const prompts = makePromptAdapter({ choices: ['new-custom'], textValue: ' ' });
2026-05-10 23:12:26 +02:00
const initProject = vi.fn(async () => {
throw new Error('initProject should not run for an empty path');
});
const testIo = makeIo({ stdoutIsTty: true });
await expect(
2026-05-10 23:51:24 +02:00
runKtxSetupProjectStep(
2026-05-10 23:12:26 +02:00
{ projectDir: startDir, mode: 'auto', inputMode: 'auto', yes: false },
testIo.io,
{ prompts, initProject },
),
).resolves.toMatchObject({ status: 'missing-input', projectDir: startDir });
expect(initProject).not.toHaveBeenCalled();
expect(testIo.stderr()).toContain(
2026-05-10 23:51:24 +02:00
'Enter a relative path like ./analytics-ktx, a home path like ~/analytics-ktx, or an absolute path.',
2026-05-10 23:12:26 +02:00
);
});
2026-05-10 23:51:24 +02:00
it('confirms before creating KTX files inside an existing non-empty folder', async () => {
2026-05-10 23:12:26 +02:00
const startDir = join(tempDir, 'start');
2026-05-10 23:51:24 +02:00
const projectDir = join(startDir, 'analytics-ktx');
2026-05-10 23:12:26 +02:00
await mkdir(projectDir, { recursive: true });
await writeFile(join(projectDir, 'README.md'), 'Existing project notes\n', 'utf-8');
const prompts = makePromptAdapter({ choices: ['new-custom', 'use-existing'], textValue: 'analytics-ktx' });
2026-05-10 23:12:26 +02:00
2026-05-10 23:51:24 +02:00
const result = await runKtxSetupProjectStep(
2026-05-10 23:12:26 +02:00
{ projectDir: startDir, mode: 'auto', inputMode: 'auto', yes: false },
makeIo({ stdoutIsTty: true }).io,
{ prompts },
);
expect(result.status).toBe('ready');
expect(result.projectDir).toBe(projectDir);
expect(prompts.select).toHaveBeenNthCalledWith(
2,
2026-05-10 23:12:26 +02:00
expect.objectContaining({
message: `That folder already exists and is not empty: ${projectDir}`,
options: expect.arrayContaining([
2026-05-10 23:51:24 +02:00
expect.objectContaining({ value: 'use-existing', label: 'Yes, create KTX files there' }),
2026-05-10 23:12:26 +02:00
expect.objectContaining({ value: 'choose-another', label: 'Choose another folder' }),
]),
}),
);
await expect(readFile(join(projectDir, 'README.md'), 'utf-8')).resolves.toBe('Existing project notes\n');
2026-05-10 23:51:24 +02:00
await expect(stat(join(projectDir, 'ktx.yaml'))).resolves.toBeDefined();
2026-05-10 23:12:26 +02:00
});
it('prompts to exit and returns cancelled in interactive auto mode', async () => {
const projectDir = join(tempDir, 'warehouse');
const prompts = makePromptAdapter({ choice: 'exit' });
await expect(
2026-05-10 23:51:24 +02:00
runKtxSetupProjectStep(
2026-05-10 23:12:26 +02:00
{ projectDir, mode: 'auto', inputMode: 'auto', yes: false },
makeIo({ stdoutIsTty: true }).io,
{ prompts },
),
).resolves.toMatchObject({ status: 'cancelled', projectDir });
expect(prompts.cancel).toHaveBeenCalledWith('Setup cancelled.');
expect(prompts.text).not.toHaveBeenCalled();
2026-05-10 23:51:24 +02:00
await expect(stat(join(projectDir, 'ktx.yaml'))).rejects.toThrow();
2026-05-10 23:12:26 +02:00
});
});