inspector/clients/tui/__tests__/PromptTestModal.test.tsx
Cliff Hall f43fafc08b
test(tui): extend coverage gate to Ink components + App.tsx (closes #1501) (#1538)
* 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>
2026-06-29 08:19:12 -04:00

344 lines
9.6 KiB
TypeScript

import React from "react";
import { describe, it, expect, vi, afterEach } 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";
// ScrollView: passthrough so the results JSX actually mounts (and is counted
// for coverage) and the imperative ref API exists for the scroll handlers.
vi.mock("ink-scroll-view", () => import("./helpers/inkScrollViewMock.js"));
// Form: a double that fires onSubmit when the user presses Enter ("\r").
vi.mock("ink-form", () => import("./helpers/inkFormMock.js"));
import { PromptTestModal } from "../src/components/PromptTestModal.js";
// Ink processes stdin keypresses asynchronously — await this after stdin.write
// and let the async getPrompt promise + 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 ENTER = "\r";
const makePrompt = (over: Partial<Prompt> = {}): Prompt =>
({
name: "alpha",
description: "First prompt",
arguments: [{ name: "topic", description: "a topic", required: true }],
...over,
}) as unknown as Prompt;
// Set the value the mock Form submits on Enter; reset afterward so cases
// don't leak into one another.
function setFormSubmitValue(value: Record<string, string> | undefined) {
if (value === undefined) {
delete (globalThis as Record<string, unknown>).__INK_FORM_SUBMIT_VALUE__;
} else {
(globalThis as Record<string, unknown>).__INK_FORM_SUBMIT_VALUE__ = value;
}
}
afterEach(() => {
setFormSubmitValue(undefined);
vi.restoreAllMocks();
});
describe("PromptTestModal", () => {
it("submits the form, calls getPrompt, and shows results (success path)", async () => {
const getPrompt = vi.fn().mockResolvedValue({
result: {
description: "ok",
messages: [{ role: "user", content: { type: "text", text: "hello" } }],
},
});
const inspectorClient = { getPrompt } as unknown as InspectorClient;
const prompt = makePrompt();
// Submit a non-empty value so the "Arguments:" block (input length > 0)
// is rendered in the results view.
setFormSubmitValue({ topic: "weather" });
const { stdin } = render(
<PromptTestModal
prompt={prompt}
inspectorClient={inspectorClient}
width={120}
height={30}
onClose={() => {}}
/>,
);
await tick();
stdin.write(ENTER);
await tick();
await tick();
expect(getPrompt).toHaveBeenCalledWith("alpha", { topic: "weather" });
// Now in results mode — drive every scroll key branch.
stdin.write(DOWN);
await tick();
stdin.write(UP);
await tick();
stdin.write(PAGE_DOWN);
await tick();
stdin.write(PAGE_UP);
await tick();
});
it("renders the loading state while getPrompt is pending", async () => {
let resolveGetPrompt!: (value: { result: { messages: unknown[] } }) => void;
const getPrompt = vi.fn().mockReturnValue(
new Promise<{ result: { messages: unknown[] } }>((resolve) => {
resolveGetPrompt = resolve;
}),
);
const inspectorClient = { getPrompt } as unknown as InspectorClient;
const { stdin } = render(
<PromptTestModal
prompt={makePrompt()}
inspectorClient={inspectorClient}
width={120}
height={30}
onClose={() => {}}
/>,
);
await tick();
stdin.write(ENTER);
// One tick: state has transitioned to "loading" but the promise is still
// pending, so the loading JSX is mounted.
await tick();
expect(getPrompt).toHaveBeenCalledTimes(1);
// Now let it resolve and settle into results.
resolveGetPrompt({ result: { messages: [] } });
await tick();
await tick();
});
it("renders results with no arguments block when submitted value is empty", async () => {
const getPrompt = vi.fn().mockResolvedValue({
result: { messages: [] },
});
const inspectorClient = { getPrompt } as unknown as InspectorClient;
// Default submit value is {} → Object.keys(input).length === 0 branch.
const { stdin } = render(
<PromptTestModal
prompt={makePrompt({ description: undefined })}
inspectorClient={inspectorClient}
width={120}
height={30}
onClose={() => {}}
/>,
);
await tick();
stdin.write(ENTER);
await tick();
await tick();
expect(getPrompt).toHaveBeenCalledTimes(1);
});
it("shows error results when getPrompt rejects with an Error", async () => {
const getPrompt = vi.fn().mockRejectedValue(new Error("boom"));
const inspectorClient = { getPrompt } as unknown as InspectorClient;
setFormSubmitValue({ topic: "x" });
const { stdin } = render(
<PromptTestModal
prompt={makePrompt()}
inspectorClient={inspectorClient}
width={120}
height={30}
onClose={() => {}}
/>,
);
await tick();
stdin.write(ENTER);
await tick();
await tick();
expect(getPrompt).toHaveBeenCalledTimes(1);
// Scroll through the error results to exercise the results scroll branches.
stdin.write(DOWN);
await tick();
});
it("handles a rejected getPrompt that throws a string", async () => {
const getPrompt = vi.fn().mockRejectedValue("string failure");
const inspectorClient = { getPrompt } as unknown as InspectorClient;
const { stdin } = render(
<PromptTestModal
prompt={makePrompt()}
inspectorClient={inspectorClient}
width={120}
height={30}
onClose={() => {}}
/>,
);
await tick();
stdin.write(ENTER);
await tick();
await tick();
expect(getPrompt).toHaveBeenCalledTimes(1);
});
it("handles a rejected getPrompt that throws an object with a message", async () => {
const getPrompt = vi
.fn()
.mockRejectedValue({ message: "obj msg", code: 7 });
const inspectorClient = { getPrompt } as unknown as InspectorClient;
const { stdin } = render(
<PromptTestModal
prompt={makePrompt()}
inspectorClient={inspectorClient}
width={120}
height={30}
onClose={() => {}}
/>,
);
await tick();
stdin.write(ENTER);
await tick();
await tick();
expect(getPrompt).toHaveBeenCalledTimes(1);
});
it("handles a rejected getPrompt that throws an object without a message", async () => {
const getPrompt = vi.fn().mockRejectedValue({ code: 99 });
const inspectorClient = { getPrompt } as unknown as InspectorClient;
const { stdin } = render(
<PromptTestModal
prompt={makePrompt()}
inspectorClient={inspectorClient}
width={120}
height={30}
onClose={() => {}}
/>,
);
await tick();
stdin.write(ENTER);
await tick();
await tick();
expect(getPrompt).toHaveBeenCalledTimes(1);
});
it("handles a rejected getPrompt that throws a non-object, non-string value", async () => {
const getPrompt = vi.fn().mockRejectedValue(42);
const inspectorClient = { getPrompt } as unknown as InspectorClient;
const { stdin } = render(
<PromptTestModal
prompt={makePrompt()}
inspectorClient={inspectorClient}
width={120}
height={30}
onClose={() => {}}
/>,
);
await tick();
stdin.write(ENTER);
await tick();
await tick();
expect(getPrompt).toHaveBeenCalledTimes(1);
});
it("does nothing when inspectorClient is null (early return)", async () => {
const onClose = vi.fn();
const { stdin } = render(
<PromptTestModal
prompt={makePrompt()}
inspectorClient={null}
width={120}
height={30}
onClose={onClose}
/>,
);
await tick();
// Submitting the form hits handleFormSubmit which returns early because
// inspectorClient is null — state stays "form", no crash.
stdin.write(ENTER);
await tick();
await tick();
// Still in form mode: a non-escape key is ignored by the form-state branch.
stdin.write("a");
await tick();
expect(onClose).not.toHaveBeenCalled();
});
it("closes on ESC and resets state", async () => {
const onClose = vi.fn();
const getPrompt = vi.fn().mockResolvedValue({ result: { messages: [] } });
const inspectorClient = { getPrompt } as unknown as InspectorClient;
const { stdin } = render(
<PromptTestModal
prompt={makePrompt()}
inspectorClient={inspectorClient}
width={120}
height={30}
onClose={onClose}
/>,
);
await tick();
// Get into results mode first so the escape-from-results path runs.
stdin.write(ENTER);
await tick();
await tick();
stdin.write(ESC);
await tick();
expect(onClose).toHaveBeenCalledTimes(1);
});
it("unmounts cleanly, running cleanup effects", async () => {
const getPrompt = vi.fn().mockResolvedValue({ result: { messages: [] } });
const inspectorClient = { getPrompt } as unknown as InspectorClient;
const { unmount } = render(
<PromptTestModal
prompt={makePrompt({ arguments: undefined, description: undefined })}
inspectorClient={inspectorClient}
width={120}
height={30}
onClose={() => {}}
/>,
);
await tick();
unmount();
await tick();
expect(true).toBe(true);
});
});