ktx/packages/cli/test/setup-interrupt.test.ts

113 lines
3.6 KiB
TypeScript
Raw Permalink Normal View History

2026-05-10 23:12:26 +02:00
import { afterEach, describe, expect, it, vi } from 'vitest';
import {
2026-05-10 23:51:24 +02:00
KtxSetupExitError,
2026-05-10 23:12:26 +02:00
withSetupInterruptConfirmation,
type SetupInterruptTracker,
test: split cli tests from source tree (#216) * feat(cli): define full warehouse dialect contract * test(cli): keep dialect edge tests focused * fix(cli): stabilize dialect contract foundation * refactor(connectors): own read-only query preparation * refactor(connectors): resolve dialects through registry * refactor(connectors): keep concrete dialect classes internal * chore(workspace): enforce dialect import boundary * refactor(cli): resolve relationship dialect at scan boundary * refactor(cli): use dialect display parsing for entity details * refactor(cli): use dialect display parsing for warehouse catalog * refactor(cli): use dialect SQL in relationship workflows * test(cli): verify solid dialect scan workflow closure * test: split cli tests from source tree * refactor(cli): standardize BigQuery scope listing * feat(sqlite): implement connector scope listing * test(connectors): cover required table listing * feat(cli): add warehouse driver registry * refactor(setup): route scope discovery through driver registry * refactor(cli): route local query execution through driver registry * refactor(historic-sql): route dialect support through driver registry * refactor(cli): test warehouse connections through driver registry * fix(cli): close driver registry type export gaps * Improve setup daemon diagnostics * refactor(setup): centralize rail-prefixed diagnostics + query-history fallback Extract errorMessage, writePrefixedLines, and flushPrefixedBufferedCommandOutput into clack.ts so the setup wizard, managed daemons, and embedding/agent steps share one rail-formatted writer. setup-databases.ts also adds a "disable query history and retry" option when the schema-context build fails and query history is the likely culprit, surfaced via a new failed-query-history-unavailable status. * fix(cli): carry catalog through the picker so BigQuery/Snowflake/SQL Server scope filters match The setup picker's KtxTableListEntry was a 2-level { schema, name }, so qualifiedTableId always wrote db.name into enabled_tables. When BigQuery, Snowflake, or SQL Server later ran fast ingest, their introspect step filtered the scope set with scopedTableNames(scope, { catalog: projectId|database, db }) — catalog was non-null on the introspect side but null in the scope refs, so every entry was rejected, the live-database adapter staged zero table files, and detect() failed with 'Adapter "live-database" did not recognize fetched source output'. Align the picker boundary with the canonical 3-level KtxTableRef: - Add catalog: string | null to KtxTableListEntry. - BigQuery/Snowflake/SQL Server listTables populate catalog from the resolved projectId / database; Postgres/MySQL/ClickHouse/SQLite set null. - qualifiedTableId emits catalog.schema.name when catalog is non-null (resolveEnabledTables already accepts the 3-part shape) and schemasFromEnabledTables now goes through parseDottedTableEntry so it recovers the schema correctly from both 2-part and 3-part entries. - Export parseDottedTableEntry from enabled-tables.ts (@internal) for picker reuse. Update listTables expectations in all seven connector tests and the setup / picker test fixtures. Add a picker regression test that covers the catalog-bearing round-trip (save + refine). * fix(cli): allow debug telemetry under opt-out env
2026-05-26 08:49:05 +02:00
} from '../src/setup-interrupt.js';
2026-05-10 23:12:26 +02:00
const CANCEL = Symbol('cancel');
function makeTracker(ctrlCValues: boolean[]): SetupInterruptTracker {
return {
track: vi.fn((run) => run()),
wasCtrlC: vi.fn(() => ctrlCValues.shift() ?? false),
};
}
describe('setup interrupt confirmation', () => {
const originalIsTTY = process.stdin.isTTY;
const originalRef = process.stdin.ref;
2026-05-10 23:12:26 +02:00
afterEach(() => {
Object.defineProperty(process.stdin, 'isTTY', { configurable: true, value: originalIsTTY });
Object.defineProperty(process.stdin, 'ref', { configurable: true, value: originalRef });
2026-05-10 23:12:26 +02:00
});
it('fails before opening a prompt when interactive setup has no tty', async () => {
Object.defineProperty(process.stdin, 'isTTY', { configurable: true, value: false });
const prompt = vi.fn(async () => 'continued');
await expect(withSetupInterruptConfirmation(prompt)).rejects.toThrow(
'Interactive setup requires a terminal. Re-run this command in a TTY, or pass --no-input with the required options.',
);
expect(prompt).not.toHaveBeenCalled();
});
it('refs stdin before opening a real interactive prompt', async () => {
const calls: string[] = [];
Object.defineProperty(process.stdin, 'isTTY', { configurable: true, value: true });
Object.defineProperty(process.stdin, 'ref', {
configurable: true,
value: vi.fn(() => {
calls.push('ref');
return process.stdin;
}),
});
const prompt = vi.fn(async () => {
calls.push('prompt');
return 'continued';
});
await expect(withSetupInterruptConfirmation(prompt)).resolves.toBe('continued');
expect(calls).toEqual(['ref', 'prompt']);
});
2026-05-10 23:12:26 +02:00
it('asks before exiting on Ctrl+C and reruns the active prompt when declined', async () => {
const prompt = vi.fn(async () => (prompt.mock.calls.length === 1 ? CANCEL : 'continued'));
const confirmExit = vi.fn(async () => false);
await expect(
withSetupInterruptConfirmation(prompt, {
confirmExit,
isCancel: (value): value is symbol => value === CANCEL,
tracker: makeTracker([true]),
}),
).resolves.toBe('continued');
expect(prompt).toHaveBeenCalledTimes(2);
expect(confirmExit).toHaveBeenCalledTimes(1);
});
it('exits immediately when the confirmation is accepted', async () => {
const prompt = vi.fn(async () => CANCEL);
await expect(
withSetupInterruptConfirmation(prompt, {
confirmExit: vi.fn(async () => true),
isCancel: (value): value is symbol => value === CANCEL,
tracker: makeTracker([true]),
}),
2026-05-10 23:51:24 +02:00
).rejects.toBeInstanceOf(KtxSetupExitError);
2026-05-10 23:12:26 +02:00
});
it('keeps non-Ctrl+C cancellation available for Back and Escape flows', async () => {
const prompt = vi.fn(async () => CANCEL);
const confirmExit = vi.fn(async () => true);
await expect(
withSetupInterruptConfirmation(prompt, {
confirmExit,
isCancel: (value): value is symbol => value === CANCEL,
tracker: makeTracker([false]),
}),
).resolves.toBe(CANCEL);
expect(confirmExit).not.toHaveBeenCalled();
});
it('exits immediately when Ctrl+C is pressed again at the confirmation prompt', async () => {
const prompt = vi.fn(async () => CANCEL);
await expect(
withSetupInterruptConfirmation(prompt, {
confirmExit: vi.fn(async () => CANCEL),
isCancel: (value): value is symbol => value === CANCEL,
tracker: makeTracker([true]),
}),
2026-05-10 23:51:24 +02:00
).rejects.toBeInstanceOf(KtxSetupExitError);
2026-05-10 23:12:26 +02:00
});
});