* test(tui): cover useSelectableList hook + leaf Ink components (#1501) Add ink-testing-library and renderer-based tests for useSelectableList, SelectableItem, and Tabs. Widen the vitest include glob to .test.tsx and lift these files from the interim React-surface coverage exclusion. The blanket src/components/**/*.tsx exclude is expanded into an explicit per-file list so remaining components can be lifted incrementally. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * test(tui): add ink-scroll-view passthrough mock for renderer tests (#1501) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * test(tui): add ink-form passthrough mock for modal renderer tests (#1501) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * test(tui): cover all Ink tab + modal components via renderer tests (#1501) Add ink-testing-library tests for the 12 Ink components (InfoTab, AuthTab, ResourcesTab, PromptsTab, ToolsTab, NotificationsTab, HistoryTab, RequestsTab, and the Tool/Resource/Prompt test modals + DetailsModal), mounting them through the ink-scroll-view / ink-form passthrough doubles and driving keypresses via stdin. Modal components render position:absolute (empty frame under the test renderer) so their tests assert on behavior — injected InspectorClient fakes and onClose — while the passthrough ScrollView still mounts the inner JSX for coverage. Lift these 12 components from the interim React-surface exclusion in vitest.config.ts; only App.tsx remains excluded. All files clear the uniform 90/90/90/90 per-file gate. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * test(tui): add App.tsx renderer-test harness + foundation tests (#1501) Mock the full @inspector/core surface (InspectorClient, the 7 managed-state classes, the 8 react hooks, transport + auth) behind a controllable harness, plus the ink-scroll-view/ink-form passthroughs, so App renders under ink-testing-library and its keyboard state machine can be driven via stdin. Concurrent ink mounts share raw-mode stdin, so each render is unmounted in afterEach. Foundation covers server-list nav, tab accelerators, connect/ disconnect, OAuth-tab gating, and connected-status rendering (~50% baseline). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * test(tui): cover App.tsx via mocked-core renderer tests; lift final exclusion (#1501) Extend App.test.tsx to 67 tests driving the keyboard state machine, tab content, modals, OAuth flows, and connect/disconnect across the controllable @inspector/core mock. App.tsx now clears the 90/90/90/90 per-file gate (94.6/90.6/94.5/96.6). Remove the last React-surface exclusion (src/App.tsx) from clients/tui/vitest.config.ts. The whole clients/tui/src tree is now under the uniform per-file coverage gate with no React-surface exclusions, completing the interim-scope lift from #1484. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * test(tui): raise stdout max-listeners in App test to silence warning (#1501) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * test(tui): raise App.tsx branch coverage >90 and de-flake coverage runs (#1501) Add targeted App.tsx tests for the OAuth handlers' non-Error throw arms (quick onCallback, guided start/advance, run-to-completion) and a re-entrant quick-auth guard, lifting App.tsx branch coverage 90.6% -> 91.48% for a safer margin above the 90 gate. Harden the App renderer tests against the heavier v8 coverage instrumentation, where React+ink's multi-macrotask render scheduling races fixed ticks: - press() now settles two ticks per key so focus/tab changes flush before the next key is routed (ink re-subscribes useInput on re-render); - expectFrame()/waitUntil() poll for frame content and async flow state (callbackServer opts) instead of asserting after a single fixed tick; - ResourcesTab's content-clear test polls for fetched content likewise. Plain 'npm test' (the CI path) was already stable; this makes the local coverage gate stable too (13/13 clean runs vs ~2/8 flaky before). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * test(tui): de-flake component renderer tests under slow CI (#1501) CI flaked on AuthTab's 'renders quick auth results' under the plain test run: its oauthFlowState is populated by a post-mount useEffect reading the inspectorClient, and a single-macrotask tick can race that effect -> setState -> re-render chain on a slow/loaded CI runner. Make each component test file's tick() flush several macrotask cycles so such chains settle deterministically before assertions (no test relies on precise tick timing — no fake timers / debounce). App.test.tsx already polls via expectFrame/waitUntil and passed CI, so it's unchanged. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> * test(tui): address review — shared setupFile for max-listeners, consume-once ink-form global (#1501) Review follow-ups on #1538 (both non-blocking cleanups): - Hoist process.std{out,in}.setMaxListeners into a shared vitest setupFile (__tests__/setup.ts) wired via setupFiles, so every renderer test file inherits it and the MaxListenersExceededWarning is silenced across the whole suite — not just App.test.tsx. Remove the per-file call. - Make the ink-form double consume (clear) __INK_FORM_SUBMIT_VALUE__ on submit, eliminating the latent cross-test coupling on the shared global regardless of how the modal test files are organized. No production code changed; suite + coverage gate stay green (App.tsx 94.8/91.5/94.5/96.6), and the warning no longer prints. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
0b0bd40e5d
commit
f43fafc08b
1 changed files with 5252 additions and 28 deletions
291
clients/tui/__tests__/PromptsTab.test.tsx
Normal file
291
clients/tui/__tests__/PromptsTab.test.tsx
Normal file
|
|
@ -0,0 +1,291 @@
|
|||
import React from "react";
|
||||
import { describe, it, expect, vi } from "vitest";
|
||||
import { render } from "ink-testing-library";
|
||||
import type { InspectorClient } from "@inspector/core/mcp/index.js";
|
||||
import type { Prompt } from "@modelcontextprotocol/sdk/types.js";
|
||||
|
||||
// MUST mock ink-scroll-view: the real ScrollView renders a placeholder minimap
|
||||
// in the non-TTY test env and never mounts its children. This passthrough
|
||||
// renders children directly and stubs scrollBy/scrollTo/getViewportHeight.
|
||||
vi.mock("ink-scroll-view", () => import("./helpers/inkScrollViewMock.js"));
|
||||
|
||||
import { PromptsTab } from "../src/components/PromptsTab.js";
|
||||
|
||||
// Ink processes stdin keypresses asynchronously — await this after stdin.write
|
||||
// and after rerender() before asserting. The longer delay also lets the async
|
||||
// getPrompt IIFE + setState settle.
|
||||
const tick = async () => {
|
||||
// Flush several macrotask cycles so an effect -> setState -> re-render chain
|
||||
// settles before assertions, even on slow/loaded CI (a single tick can race).
|
||||
for (let i = 0; i < 8; i++)
|
||||
await new Promise((resolve) => setTimeout(resolve, 4));
|
||||
};
|
||||
|
||||
const ESC = String.fromCharCode(27);
|
||||
const UP = `${ESC}[A`;
|
||||
const DOWN = `${ESC}[B`;
|
||||
const PAGE_UP = `${ESC}[5~`;
|
||||
const PAGE_DOWN = `${ESC}[6~`;
|
||||
|
||||
const makePrompt = (over: Partial<Prompt> = {}): Prompt =>
|
||||
({
|
||||
name: "alpha",
|
||||
description: "First prompt",
|
||||
...over,
|
||||
}) as unknown as Prompt;
|
||||
|
||||
// p0: full prompt with multi-line description + three argument variants
|
||||
// (description present / `type` fallback / "string" fallback)
|
||||
// p1: prompt with no description and no arguments (absent branches)
|
||||
// p2: empty name → "Prompt N" fallback label + index key
|
||||
// p3: trailing prompt for scroll-window coverage
|
||||
const prompts: Prompt[] = [
|
||||
makePrompt({
|
||||
name: "alpha",
|
||||
description: "Line one\nLine two",
|
||||
arguments: [
|
||||
{ name: "withDesc", description: "the description" },
|
||||
{ name: "withType", type: "number" } as never,
|
||||
{ name: "bare" },
|
||||
],
|
||||
}),
|
||||
makePrompt({ name: "beta", description: undefined, arguments: undefined }),
|
||||
makePrompt({ name: "", description: "gamma desc" }),
|
||||
makePrompt({ name: "delta", description: "Delta desc" }),
|
||||
];
|
||||
|
||||
describe("PromptsTab", () => {
|
||||
it("renders empty state when there are no prompts", () => {
|
||||
const { lastFrame } = render(
|
||||
<PromptsTab
|
||||
prompts={[]}
|
||||
inspectorClient={null}
|
||||
width={120}
|
||||
height={30}
|
||||
/>,
|
||||
);
|
||||
const frame = lastFrame() ?? "";
|
||||
expect(frame).toContain("Prompts (0)");
|
||||
expect(frame).toContain("No prompts available");
|
||||
expect(frame).toContain("Select a prompt to view details");
|
||||
});
|
||||
|
||||
it("renders a populated list with the first prompt selected (unfocused)", () => {
|
||||
const { lastFrame } = render(
|
||||
<PromptsTab
|
||||
prompts={prompts}
|
||||
inspectorClient={null}
|
||||
width={120}
|
||||
height={30}
|
||||
/>,
|
||||
);
|
||||
const frame = lastFrame() ?? "";
|
||||
expect(frame).toContain("Prompts (4)");
|
||||
expect(frame).toContain("alpha");
|
||||
expect(frame).toContain("beta");
|
||||
// empty-name prompt falls back to "Prompt N"
|
||||
expect(frame).toContain("Prompt 3");
|
||||
expect(frame).toContain("▶ ");
|
||||
// selected prompt details (cyan branch since details not focused)
|
||||
expect(frame).toContain("Line one");
|
||||
expect(frame).toContain("Line two");
|
||||
// arguments + their three description fallbacks
|
||||
expect(frame).toContain("Arguments:");
|
||||
expect(frame).toContain("the description");
|
||||
expect(frame).toContain("number");
|
||||
expect(frame).toContain("bare: string");
|
||||
expect(frame).toContain("[Enter to Get Prompt]");
|
||||
});
|
||||
|
||||
it("moves selection down/up with arrow keys when the list is focused", async () => {
|
||||
const { lastFrame, stdin } = render(
|
||||
<PromptsTab
|
||||
prompts={prompts}
|
||||
inspectorClient={null}
|
||||
width={120}
|
||||
height={30}
|
||||
focusedPane="list"
|
||||
/>,
|
||||
);
|
||||
// up at the top boundary: no movement
|
||||
stdin.write(UP);
|
||||
await tick();
|
||||
// down moves selection to "beta" (no description, no arguments)
|
||||
stdin.write(DOWN);
|
||||
await tick();
|
||||
let frame = lastFrame() ?? "";
|
||||
expect(frame).toContain("beta");
|
||||
expect(frame).not.toContain("Arguments:");
|
||||
// back up to alpha
|
||||
stdin.write(UP);
|
||||
await tick();
|
||||
frame = lastFrame() ?? "";
|
||||
expect(frame).toContain("Line one");
|
||||
});
|
||||
|
||||
it("scrolls the visible window when navigating past the viewport", async () => {
|
||||
// height 9 → visibleCount = 2; 4 prompts force firstVisible to advance
|
||||
const { lastFrame, stdin } = render(
|
||||
<PromptsTab
|
||||
prompts={prompts}
|
||||
inspectorClient={null}
|
||||
width={120}
|
||||
height={9}
|
||||
focusedPane="list"
|
||||
/>,
|
||||
);
|
||||
// Overshoot: the downArrow guard clamps at the last index, so extra
|
||||
// presses are harmless and absorb any dropped first keypress.
|
||||
stdin.write(DOWN);
|
||||
await tick();
|
||||
stdin.write(DOWN);
|
||||
await tick();
|
||||
stdin.write(DOWN);
|
||||
await tick();
|
||||
stdin.write(DOWN);
|
||||
await tick();
|
||||
const frame = lastFrame() ?? "";
|
||||
expect(frame).toContain("delta");
|
||||
// down boundary: pressing down again does nothing
|
||||
stdin.write(DOWN);
|
||||
await tick();
|
||||
expect(lastFrame() ?? "").toContain("delta");
|
||||
});
|
||||
|
||||
it("calls onFetchPrompt when Enter is pressed on a prompt with arguments", async () => {
|
||||
const onFetchPrompt = vi.fn();
|
||||
const inspectorClient = {
|
||||
getPrompt: vi.fn(),
|
||||
} as unknown as InspectorClient;
|
||||
const { stdin } = render(
|
||||
<PromptsTab
|
||||
prompts={prompts}
|
||||
inspectorClient={inspectorClient}
|
||||
width={120}
|
||||
height={30}
|
||||
focusedPane="list"
|
||||
onFetchPrompt={onFetchPrompt}
|
||||
/>,
|
||||
);
|
||||
stdin.write("\r");
|
||||
await tick();
|
||||
expect(onFetchPrompt).toHaveBeenCalledWith(prompts[0]);
|
||||
});
|
||||
|
||||
it("fetches directly and calls onViewDetails when Enter is pressed on an argument-less prompt", async () => {
|
||||
const onFetchPrompt = vi.fn();
|
||||
const onViewDetails = vi.fn();
|
||||
const result = { messages: [] };
|
||||
const getPrompt = vi.fn().mockResolvedValue({ result });
|
||||
const inspectorClient = { getPrompt } as unknown as InspectorClient;
|
||||
const noArgPrompt = makePrompt({ name: "solo", arguments: undefined });
|
||||
const { stdin } = render(
|
||||
<PromptsTab
|
||||
prompts={[noArgPrompt]}
|
||||
inspectorClient={inspectorClient}
|
||||
width={120}
|
||||
height={30}
|
||||
focusedPane="list"
|
||||
onFetchPrompt={onFetchPrompt}
|
||||
onViewDetails={onViewDetails}
|
||||
/>,
|
||||
);
|
||||
stdin.write("\r");
|
||||
await tick();
|
||||
expect(getPrompt).toHaveBeenCalledWith("solo");
|
||||
expect(onFetchPrompt).not.toHaveBeenCalled();
|
||||
expect(onViewDetails).toHaveBeenCalledWith(
|
||||
expect.objectContaining({ name: "solo", result }),
|
||||
);
|
||||
});
|
||||
|
||||
it("renders the Error message when getPrompt rejects with an Error", async () => {
|
||||
const getPrompt = vi.fn().mockRejectedValue(new Error("boom failure"));
|
||||
const inspectorClient = { getPrompt } as unknown as InspectorClient;
|
||||
const noArgPrompt = makePrompt({ name: "solo", arguments: undefined });
|
||||
const { lastFrame, stdin } = render(
|
||||
<PromptsTab
|
||||
prompts={[noArgPrompt]}
|
||||
inspectorClient={inspectorClient}
|
||||
width={120}
|
||||
height={30}
|
||||
focusedPane="list"
|
||||
onFetchPrompt={vi.fn()}
|
||||
onViewDetails={vi.fn()}
|
||||
/>,
|
||||
);
|
||||
stdin.write("\r");
|
||||
await tick();
|
||||
expect(lastFrame() ?? "").toContain("boom failure");
|
||||
});
|
||||
|
||||
it("falls back to a generic Error message when getPrompt rejects with a non-Error", async () => {
|
||||
const getPrompt = vi.fn().mockRejectedValue("oops");
|
||||
const inspectorClient = { getPrompt } as unknown as InspectorClient;
|
||||
const noArgPrompt = makePrompt({ name: "solo", arguments: undefined });
|
||||
const { lastFrame, stdin } = render(
|
||||
<PromptsTab
|
||||
prompts={[noArgPrompt]}
|
||||
inspectorClient={inspectorClient}
|
||||
width={120}
|
||||
height={30}
|
||||
focusedPane="list"
|
||||
onFetchPrompt={vi.fn()}
|
||||
onViewDetails={vi.fn()}
|
||||
/>,
|
||||
);
|
||||
stdin.write("\r");
|
||||
await tick();
|
||||
expect(lastFrame() ?? "").toContain("Failed to get prompt");
|
||||
});
|
||||
|
||||
it("handles details-pane scrolling, footer, and zoom shortcut", async () => {
|
||||
const onViewDetails = vi.fn();
|
||||
const { lastFrame, stdin } = render(
|
||||
<PromptsTab
|
||||
prompts={prompts}
|
||||
inspectorClient={null}
|
||||
width={120}
|
||||
height={30}
|
||||
focusedPane="details"
|
||||
onViewDetails={onViewDetails}
|
||||
/>,
|
||||
);
|
||||
// footer only shows while the details pane is focused
|
||||
expect(lastFrame() ?? "").toContain("↑/↓ to scroll, + to zoom");
|
||||
// scroll keys (exercise scrollBy / pageUp / pageDown branches)
|
||||
stdin.write(UP);
|
||||
await tick();
|
||||
stdin.write(DOWN);
|
||||
await tick();
|
||||
stdin.write(PAGE_UP);
|
||||
await tick();
|
||||
stdin.write(PAGE_DOWN);
|
||||
await tick();
|
||||
// "+" opens the full-screen modal
|
||||
stdin.write("+");
|
||||
await tick();
|
||||
expect(onViewDetails).toHaveBeenCalledWith(prompts[0]);
|
||||
});
|
||||
|
||||
it("does not fire input handlers when a modal is open", async () => {
|
||||
const onFetchPrompt = vi.fn();
|
||||
const inspectorClient = {
|
||||
getPrompt: vi.fn(),
|
||||
} as unknown as InspectorClient;
|
||||
const { stdin } = render(
|
||||
<PromptsTab
|
||||
prompts={prompts}
|
||||
inspectorClient={inspectorClient}
|
||||
width={120}
|
||||
height={30}
|
||||
focusedPane="list"
|
||||
onFetchPrompt={onFetchPrompt}
|
||||
modalOpen={true}
|
||||
/>,
|
||||
);
|
||||
stdin.write("\r");
|
||||
await tick();
|
||||
expect(onFetchPrompt).not.toHaveBeenCalled();
|
||||
});
|
||||
});
|
||||
Loading…
Reference in a new issue