ktx/packages/cli/test/setup-prompts.test.ts
Andrey Avtomonov 663eaff940
feat(cli): setup progress spinners, Tab-to-select, and banner polish (#296)
* fix(cli): double the height of the setup banner t crossbar

* fix(cli): unify setup multi-select hints and make Tab the select key

The six interactive multi-select surfaces in `ktx setup` documented three
different hint voices, one had no hint at all, and they named two different
select keys (Space vs Tab). Tab is the only key that can toggle selection
without colliding with type-to-search input, so make it the single documented
select key everywhere and compose every hint from one shared fragment
vocabulary in prompt-navigation.ts.

- Register `updateSettings({ aliases: { tab: 'space' } })` so Tab toggles flat
  multiselects; the alias applies only to non-text prompts, leaving typed
  search input (schema/Notion) untouched.
- Add the missing hint to the agent-targets prompt and drop the stray
  "Space to select … Esc …" info line plus the now-dead writeSetupInfo helper.
- Replace the schema-scope ad-hoc hint with the searchable-multiselect voice
  and standardize "filter" -> "search" vocabulary.
- Delete DEFAULT_TREE_PICKER_HELP_TEXT and the unused TreePickerChrome.helpText
  seam; render the shared tree hint instead.

* refactor(cli): show LLM check progress for every setup backend

Rename runLlmHealthCheckWithProgress to validateModelWithProgress and
wrap the Claude subscription and Codex auth probes in the same spinner
progress as the Anthropic API and Vertex backends, so each backend shows
consistent "Checking <provider> LLM" output during setup.

* feat(cli): add ktx-orange progress spinners to setup steps

Add a shared runWithCliSpinner helper and a TTY-aware createCliSpinner:
an animated clack spinner in a terminal, and a static stderr-only spinner
before raw-mode pickers (the table tree picker and demo tour), where the
animated spinner's stdin grab would otherwise corrupt the next prompt.

Wrap the slow setup waits in progress spinners: managed runtime install,
embedding daemon start + first-run model download, embeddings health
check, the connection-test gate, and source validation / dbt clone /
Metabase discovery. Recolor every spinner frame from clack's magenta to
the ktx mascot orange (#FF8A4C) via the static helper and clack's
styleFrame option.
2026-06-12 16:43:10 +02:00

271 lines
9.4 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import { settings } from '@clack/core';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import {
createKtxSetupPromptAdapter,
type KtxSetupPromptOption,
} from '../src/setup-prompts.js';
const mocks = vi.hoisted(() => {
const cancelSymbol = Symbol('cancel');
return {
cancelSymbol,
cancel: vi.fn(),
confirm: vi.fn(),
intro: vi.fn(),
isCancel: vi.fn((value: unknown): value is symbol => value === cancelSymbol),
log: { info: vi.fn() },
multiselect: vi.fn(),
autocomplete: vi.fn(),
autocompleteMultiselect: vi.fn(),
note: vi.fn(),
revealPassword: vi.fn(),
select: vi.fn(),
text: vi.fn(),
withSetupInterruptConfirmation: vi.fn((prompt: () => Promise<unknown>) => prompt()),
};
});
vi.mock('@clack/prompts', () => ({
cancel: mocks.cancel,
confirm: mocks.confirm,
intro: mocks.intro,
isCancel: mocks.isCancel,
log: mocks.log,
multiselect: mocks.multiselect,
autocomplete: mocks.autocomplete,
autocompleteMultiselect: mocks.autocompleteMultiselect,
note: mocks.note,
select: mocks.select,
text: mocks.text,
}));
vi.mock('../src/reveal-password-prompt.js', () => ({
revealPassword: mocks.revealPassword,
}));
vi.mock('../src/setup-interrupt.js', () => ({
withSetupInterruptConfirmation: mocks.withSetupInterruptConfirmation,
}));
describe('setup prompt adapter', () => {
beforeEach(() => {
mocks.cancel.mockReset();
mocks.confirm.mockReset();
mocks.intro.mockReset();
mocks.isCancel.mockClear();
mocks.log.info.mockReset();
mocks.multiselect.mockReset();
mocks.autocomplete.mockReset();
mocks.autocompleteMultiselect.mockReset();
mocks.note.mockReset();
mocks.revealPassword.mockReset();
mocks.select.mockReset();
mocks.text.mockReset();
mocks.withSetupInterruptConfirmation.mockClear();
});
it('registers Tab as a Space alias so flat multiselects toggle on Tab', () => {
// Importing the adapter module runs updateSettings({ aliases: { tab: 'space' } }).
// clack remaps Tabâ†Space on non-text prompts, which is what toggles a flat
// multiselect option; text inputs set _track, so their typed Tab is untouched.
expect(settings.aliases.get('tab')).toBe('space');
});
it('passes select hint and disabled options through Clack and delegates cancellation handling', async () => {
mocks.select.mockResolvedValueOnce('openai');
const adapter = createKtxSetupPromptAdapter({ selectCancelValue: 'back' });
const options: KtxSetupPromptOption[] = [
{ value: 'local', label: 'Local embeddings', disabled: true },
{ value: 'openai', label: 'OpenAI embeddings', hint: 'recommended' },
];
await expect(
adapter.select({
message: 'Which embedding option should ktx use?\n\nktx uses embeddings for search.',
options,
}),
).resolves.toBe('openai');
expect(mocks.withSetupInterruptConfirmation).toHaveBeenCalledTimes(1);
expect(mocks.select).toHaveBeenCalledWith({
message: 'Which embedding option should ktx use?\n\nktx uses embeddings for search.\n',
options,
});
});
it('maps select cancellation to the configured sentinel', async () => {
mocks.select.mockResolvedValueOnce(mocks.cancelSymbol);
const adapter = createKtxSetupPromptAdapter({
selectCancelValue: 'exit',
cancelOnSelectCancel: false,
});
await expect(adapter.select({ message: 'What do you want to do?', options: [] })).resolves.toBe('exit');
expect(mocks.cancel).not.toHaveBeenCalled();
});
it('decorates text and password prompts with setup navigation copy', async () => {
mocks.text.mockResolvedValueOnce('analytics-ktx');
mocks.revealPassword.mockResolvedValueOnce('secret');
const adapter = createKtxSetupPromptAdapter({ selectCancelValue: 'back' });
await expect(adapter.text({ message: 'Project folder path', placeholder: './analytics-ktx' })).resolves.toBe(
'analytics-ktx',
);
await expect(adapter.password({ message: 'Anthropic API key' })).resolves.toBe('secret');
expect(mocks.text).toHaveBeenCalledWith({
message: 'Project folder path\nâ” Press Escape to go back.\nâ”',
placeholder: './analytics-ktx',
});
expect(mocks.revealPassword).toHaveBeenCalledWith({
message: 'Anthropic API key\nâ” Press Escape to go back.\nâ”',
});
});
it('passes multiselect hint and disabled options through Clack', async () => {
mocks.multiselect.mockResolvedValueOnce(['postgres']);
const adapter = createKtxSetupPromptAdapter({
selectCancelValue: 'back',
multiselectCancelValue: 'back',
confirmEmptyOptionalMultiselect: true,
});
const options: KtxSetupPromptOption[] = [
{ value: 'postgres', label: 'PostgreSQL', hint: 'recommended' },
{ value: 'snowflake', label: 'Snowflake', disabled: true },
];
await expect(adapter.multiselect({ message: 'Which primary sources?', options, required: true })).resolves.toEqual([
'postgres',
]);
expect(mocks.multiselect).toHaveBeenCalledWith({
message: 'Which primary sources?',
options,
required: true,
});
});
it('confirms an empty optional multiselect and retries when skip is declined', async () => {
mocks.multiselect.mockResolvedValueOnce([]).mockResolvedValueOnce(['postgres']);
mocks.confirm.mockResolvedValueOnce(false);
const adapter = createKtxSetupPromptAdapter({
selectCancelValue: 'back',
multiselectCancelValue: 'back',
confirmEmptyOptionalMultiselect: true,
});
await expect(adapter.multiselect({ message: 'Which primary sources?', options: [], required: false })).resolves.toEqual([
'postgres',
]);
expect(mocks.confirm).toHaveBeenCalledWith({ message: 'Nothing selected. Skip this step?', initialValue: false });
expect(mocks.multiselect).toHaveBeenCalledTimes(2);
});
it('maps multiselect cancellation to the configured back value', async () => {
mocks.multiselect.mockResolvedValueOnce(mocks.cancelSymbol);
const adapter = createKtxSetupPromptAdapter({
selectCancelValue: 'back',
multiselectCancelValue: 'back',
confirmEmptyOptionalMultiselect: true,
});
await expect(adapter.multiselect({ message: 'Which primary sources?', options: [] })).resolves.toEqual(['back']);
expect(mocks.cancel).toHaveBeenCalledWith('Setup cancelled.');
});
it('returns autocomplete selections and maps cancel to back', async () => {
mocks.autocomplete.mockResolvedValueOnce('analytics');
const adapter = createKtxSetupPromptAdapter({ selectCancelValue: 'back' });
await expect(
adapter.autocomplete({
message: 'Dataset',
placeholder: 'Type to search',
options: [{ value: 'analytics', label: 'analytics' }],
}),
).resolves.toBe('analytics');
mocks.autocomplete.mockResolvedValueOnce(mocks.cancelSymbol);
await expect(
adapter.autocomplete({
message: 'Dataset',
options: [{ value: 'analytics', label: 'analytics' }],
}),
).resolves.toBe('back');
});
it('returns autocomplete multiselect selections and maps cancel to back', async () => {
mocks.autocompleteMultiselect.mockResolvedValueOnce(['analytics', 'mart']);
const adapter = createKtxSetupPromptAdapter({ selectCancelValue: 'back', multiselectCancelValue: 'back' });
await expect(
adapter.autocompleteMultiselect({
message: 'Datasets',
placeholder: 'Type to filter',
options: [
{ value: 'analytics', label: 'analytics', hint: 'suggested' },
{ value: 'mart', label: 'mart' },
],
initialValues: ['analytics'],
}),
).resolves.toEqual(['analytics', 'mart']);
mocks.autocompleteMultiselect.mockResolvedValueOnce(mocks.cancelSymbol);
await expect(
adapter.autocompleteMultiselect({
message: 'Datasets',
options: [{ value: 'analytics', label: 'analytics' }],
}),
).resolves.toEqual(['back']);
});
it('keeps setup intro and note plain for non-stream output', async () => {
const { createKtxSetupUiAdapter } = await import('../src/setup-prompts.js');
const chunks: string[] = [];
const io = {
stdout: {
isTTY: true,
write(chunk: string) {
chunks.push(chunk);
},
},
stderr: { write: vi.fn() },
};
const ui = createKtxSetupUiAdapter();
ui.intro('ktx setup', io);
ui.note(' $ ktx status', 'What you can do next', io);
expect(chunks.join('')).toBe('ktx setup\n\nWhat you can do next:\n $ ktx status\n');
expect(mocks.intro).not.toHaveBeenCalled();
expect(mocks.note).not.toHaveBeenCalled();
});
it('uses Clack intro and note for writable TTY output', async () => {
const { createKtxSetupUiAdapter } = await import('../src/setup-prompts.js');
const output = {
columns: 80,
isTTY: true,
on: vi.fn(),
write: vi.fn(),
};
const io = {
stdout: output,
stderr: { write: vi.fn() },
};
const ui = createKtxSetupUiAdapter();
ui.intro('ktx setup', io);
ui.note(' $ ktx status', 'What you can do next', io);
const bannerWrite = output.write.mock.calls.map((call) => String(call[0])).join('');
expect(bannerWrite).toContain('██');
expect(bannerWrite).toContain('context layer for data agents');
expect(mocks.intro).toHaveBeenCalledWith('ktx setup', { output });
expect(mocks.note).toHaveBeenCalledWith(' $ ktx status', 'What you can do next', { output });
});
});