ktx/packages/cli/src/setup-demo-tour.test.ts
Andrey Avtomonov b00c1a11a9
feat: merge ingest and scan
* docs: add CLI component reuse guidance

* docs: add unified ingest ux design

* Refine unified ingest UX design after adversarial review iteration 1

* Refine unified ingest UX design after adversarial review iteration 2

* Refine unified ingest UX design after adversarial review iteration 3

* feat(cli): route public connection ingest command

* feat(cli): hide standalone scan from public help

* feat(cli): plan public ingest depth and query history

* feat(cli): execute public database ingest facets

* feat(ingest): read connection query history config

* fix(cli): use public ingest wording

* fix(config): stop generating ingest adapter allow lists

* docs: document public ingest command

* test: align ingest surface expectations

* docs: add unified ingest public CLI surface plan

* feat(cli): preflight deep public ingest readiness

* feat(setup): store query history in connection context

* feat(setup): store database context depth

* feat(setup): verify context readiness by database depth

* fix(setup): keep context build foreground only

* fix(config): reject reserved ingest connection ids

* test: close unified ingest v1 expectations

* docs: add unified ingest v1 closure plan

* fix(ingest): bypass adapter allow-list for public source ingest

* fix(ingest): honor query history window intent

* fix(ingest): hide scan internals from public database ingest

* feat(ingest): use foreground view for interactive public ingest

* fix(setup): use schema context and query history wording

* test(cli): verify unified ingest public output

* docs: add unified ingest v1 public output closure plan

* fix(setup): forward query history flags

* fix(setup): prompt for postgres query history

* fix(status): report query history readiness

* fix(ingest): remove legacy public guidance

* fix(ingest): polish foreground retry copy

* docs(examples): use unified query history wording

* chore(ingest): finish public query history cleanup

* docs: add unified ingest v1 query history status cleanup plan

* test(docs): cover unified ingest public docs

* docs: align ingest CLI reference with unified UX

* docs: update context build guides for unified ingest

* docs: update setup and primary source ingest wording

* docs: stop advertising adapter-backed example ingest

* docs: close unified ingest public docs gaps

* docs: add unified ingest v1 docs site closure plan

* fix: render unified ingest foreground warnings

* fix: explain query history schema order

* fix: add public ingest retry guidance

* fix: align setup next steps with unified ingest

* fix: remove scan wording from demo progress

* test: verify unified ingest ux closure

* docs: add unified ingest v1 foreground and retry closure plan

* fix(cli): preserve query-history pull config in public ingest

* fix(cli): omit hidden commands from docs command tree

* test(cli): close unified ingest final public surface checks

* docs: add unified ingest v1 final public surface closure plan

* fix(cli): use public source labels in ingest reports

* fix(cli): suppress low-level public ingest output

* test(cli): verify unified ingest public plain output

* docs: add unified ingest v1 public plain output closure plan

* fix(cli): add public ingest copy sanitizers

* fix(cli): sanitize public ingest progress copy

* fix(cli): rename setup schema scope prompt

* docs(plan): add progress copy closure; test: align setup back-nav fixture

Adds the iter9 plan and updates the setup back-navigation test fixture
to pass disableQueryHistory plus listSchemas/listTables stubs that the
unified ingest setup step now requires.

* docs(plan): add final ux labels plan with narrowed label scans

* fix(cli): aggregate unsupported query-history warnings

* fix(cli): align setup database labels

* test(cli): fix setup database test type-check

* fix(cli): remove primary-source wording from setup output

* test(cli): verify unified ingest setup closure

* docs(plan): add unified ingest v1 verification copy closure plan

* fix(cli): remove top-level scan command

* fix(cli): remove legacy ingest and wiki commands

* Merge scan into ingest flow

* feat(cli): split ingest progress into per-phase rows, rename work units to tasks

Each database target in the unified ingest dashboard now renders one row per
real subprocess (Schema, then Query history when enabled) instead of a single
combined bar. Each phase has its own monotonic 0-100% bar so the progress
never snaps back to zero when historic-sql starts after scan completes.
Completed phases keep their final bar, summary, and elapsed time visible as
an inline audit trail; queued and skipped phases are shown explicitly.

Also rename user-facing "work units" / "Failed work units" to "tasks" /
"Failed tasks" in ingest output and parseIngestSummary. The parser still
accepts the legacy "Work units:" wording in captured output for backward
compat. Internal memory-flow event names and type fields are left alone.

* Fix test harness failures

* Fix CI smoke checks

---------

Co-authored-by: Andrey Avtomonov <7889985+andreybavt@users.noreply.github.com>
2026-05-14 01:43:06 +02:00

282 lines
8.9 KiB
TypeScript

import { describe, expect, it, vi } from 'vitest';
import type { KtxSetupAgentsResult } from './setup-agents.js';
import {
buildDemoReplayTimeline,
DEMO_REPLAY_TARGETS,
renderDemoAgentTransition,
renderDemoBanner,
renderDemoCardContent,
renderDemoCompletionSummary,
runDemoTour,
} from './setup-demo-tour.js';
/** Strip ANSI escape sequences for plain-text assertions. */
function stripAnsi(text: string): string {
return text.replace(/\x1b\[[0-9;]*m/g, '');
}
describe('renderDemoBanner', () => {
it('contains "Demo mode"', () => {
const plain = stripAnsi(renderDemoBanner());
expect(plain).toContain('Demo mode');
});
it('mentions pre-processed data', () => {
const plain = stripAnsi(renderDemoBanner());
expect(plain).toContain('pre-processed');
});
it('mentions read-only', () => {
const plain = stripAnsi(renderDemoBanner());
expect(plain).toContain('read-only');
});
});
describe('renderDemoCardContent', () => {
it('contains the title', () => {
const plain = stripAnsi(renderDemoCardContent('Database connection', ['Postgres']));
expect(plain).toContain('Database connection');
});
it('contains each selection', () => {
const plain = stripAnsi(renderDemoCardContent('Sources', ['dbt', 'metabase']));
expect(plain).toContain('dbt');
expect(plain).toContain('metabase');
});
it('contains navigation hints', () => {
const plain = stripAnsi(renderDemoCardContent('Title', ['a']));
expect(plain).toContain('Press Enter to continue');
expect(plain).toContain('Escape to go back');
});
it('works with multiple selections', () => {
const result = renderDemoCardContent('Pick', ['one', 'two', 'three']);
const plain = stripAnsi(result);
expect(plain).toContain('one');
expect(plain).toContain('two');
expect(plain).toContain('three');
// Each selection gets a ▸ bullet
const bullets = (plain.match(/▸/g) ?? []).length;
expect(bullets).toBe(3);
});
});
describe('renderDemoAgentTransition', () => {
it('contains "Demo project is ready"', () => {
const plain = stripAnsi(renderDemoAgentTransition());
expect(plain).toContain('Demo project is ready');
});
it('mentions connecting an agent', () => {
const plain = stripAnsi(renderDemoAgentTransition());
expect(plain).toContain('connect your agent');
});
});
describe('renderDemoCompletionSummary', () => {
const projectDir = '/tmp/ktx-demo-123';
it('includes the project path', () => {
const plain = stripAnsi(renderDemoCompletionSummary(projectDir, true));
expect(plain).toContain(projectDir);
});
it('includes a temp directory warning', () => {
const plain = stripAnsi(renderDemoCompletionSummary(projectDir, true));
expect(plain).toContain('temporary directory');
});
it('points to ktx setup for real data', () => {
const plain = stripAnsi(renderDemoCompletionSummary(projectDir, true));
expect(plain).toContain('ktx setup');
});
it('shows agent-connected message when installed', () => {
const plain = stripAnsi(renderDemoCompletionSummary(projectDir, true));
expect(plain).toContain('agent is connected');
});
it('includes star headline', () => {
const plain = stripAnsi(renderDemoCompletionSummary(projectDir, true));
expect(plain).toContain('★ KTX demo is ready');
});
it('shows manual instructions when agent not installed', () => {
const plain = stripAnsi(renderDemoCompletionSummary(projectDir, false));
expect(plain).toContain('--agents');
expect(plain).toContain(`--project-dir ${projectDir}`);
});
});
describe('buildDemoReplayTimeline', () => {
const timeline = buildDemoReplayTimeline();
const connectionIds = new Set(timeline.map((e) => e.connectionId));
it('produces events for all 4 targets', () => {
expect(connectionIds.size).toBe(4);
expect(connectionIds).toContain('postgres-warehouse');
expect(connectionIds).toContain('dbt-main');
expect(connectionIds).toContain('metabase-main');
expect(connectionIds).toContain('notion-main');
});
it('all targets end as done', () => {
for (const id of connectionIds) {
const events = timeline.filter((e) => e.connectionId === id);
const last = events[events.length - 1];
expect(last.status).toBe('done');
}
});
it('events are sorted by delayMs', () => {
for (let i = 1; i < timeline.length; i++) {
expect(timeline[i].delayMs).toBeGreaterThanOrEqual(timeline[i - 1].delayMs);
}
});
it('uses schema-context wording for database progress', () => {
const renderedTimeline = timeline
.map((event) => [event.detailLine, event.summaryText].filter(Boolean).join(' '))
.join('\n');
expect(renderedTimeline).toContain('reading schema');
expect(renderedTimeline).toContain('56 tables');
expect(renderedTimeline).not.toContain('scanning');
expect(renderedTimeline).not.toContain('scanned');
});
});
describe('DEMO_REPLAY_TARGETS', () => {
it('has 1 primary source', () => {
expect(DEMO_REPLAY_TARGETS.primarySources).toHaveLength(1);
});
it('has 3 context sources', () => {
expect(DEMO_REPLAY_TARGETS.contextSources).toHaveLength(3);
});
it('primary source is a database-ingest operation', () => {
expect(DEMO_REPLAY_TARGETS.primarySources[0].operation).toBe('database-ingest');
});
it('context sources are source-ingest operations', () => {
for (const source of DEMO_REPLAY_TARGETS.contextSources) {
expect(source.operation).toBe('source-ingest');
}
});
});
describe('runDemoTour', () => {
function createMockIo() {
const chunks: string[] = [];
return {
io: {
stdout: { isTTY: true, columns: 80, write: (chunk: string) => { chunks.push(chunk); } },
stderr: { write: () => {} },
},
chunks,
};
}
it('returns 0 on successful tour with agent installed', async () => {
const { io, chunks } = createMockIo();
const mockAgents = vi.fn().mockResolvedValue({
status: 'ready',
projectDir: '/tmp/test',
installs: [{ target: 'claude-code', scope: 'project', mode: 'cli' }],
} satisfies KtxSetupAgentsResult);
const navigation = vi.fn().mockResolvedValue('forward');
const result = await runDemoTour(
{ inputMode: 'auto' },
io,
{
agents: mockAgents,
waitForNavigation: navigation,
skipReplayAnimation: true,
ensureProject: vi.fn().mockResolvedValue({ projectDir: '/tmp/test' }),
},
);
expect(result).toBe(0);
expect(mockAgents).toHaveBeenCalled();
// Should have rendered completion summary
const allOutput = chunks.join('');
expect(allOutput).toContain('agent is connected');
});
it('handles back navigation from first step by exiting', async () => {
const { io } = createMockIo();
const navigation = vi.fn().mockResolvedValue('back');
const result = await runDemoTour(
{ inputMode: 'auto' },
io,
{
waitForNavigation: navigation,
skipReplayAnimation: true,
ensureProject: vi.fn().mockResolvedValue({ projectDir: '/tmp/test' }),
},
);
expect(result).toBe(0);
// Navigation called once for intro, then exits on back
expect(navigation).toHaveBeenCalledTimes(1);
});
it('goes back from sources to databases', async () => {
const { io } = createMockIo();
let callCount = 0;
const navigation = vi.fn().mockImplementation(() => {
callCount++;
// First call (intro): forward
// Second call (databases): forward
// Third call (sources): back
// Fourth call (databases again): back (exit)
if (callCount <= 2) return Promise.resolve('forward');
return Promise.resolve('back');
});
const result = await runDemoTour(
{ inputMode: 'auto' },
io,
{
waitForNavigation: navigation,
skipReplayAnimation: true,
ensureProject: vi.fn().mockResolvedValue({ projectDir: '/tmp/test' }),
},
);
expect(result).toBe(0);
expect(navigation).toHaveBeenCalledTimes(4);
});
it('handles agent step returning back', async () => {
const { io } = createMockIo();
let navCount = 0;
const navigation = vi.fn().mockImplementation(() => {
navCount++;
// Forward through intro, databases, sources, context
// Then back from context (after agents returns back)
// Then back from sources, then back from databases (exit)
if (navCount <= 4) return Promise.resolve('forward');
return Promise.resolve('back');
});
const mockAgents = vi.fn().mockResolvedValue({
status: 'back',
projectDir: '/tmp/test',
} satisfies KtxSetupAgentsResult);
const result = await runDemoTour(
{ inputMode: 'auto' },
io,
{
agents: mockAgents,
waitForNavigation: navigation,
skipReplayAnimation: true,
ensureProject: vi.fn().mockResolvedValue({ projectDir: '/tmp/test' }),
},
);
expect(result).toBe(0);
});
});