inspector/clients/web/src/components/groups/PendingClientRequestModal/PendingClientRequestModal.test.tsx
Cliff Hall 9b2c188d11
Some checks failed
Run install, format, lint, build, and test on every push / build (push) Has been cancelled
Run install, format, lint, build, and test on every push / publish (push) Has been cancelled
Run install, format, lint, build, and test on every push / publish-github-container-registry (push) Has been cancelled
MRTR: drive input_required manually to keep pending-request UX (#1704) (#1719)
* MRTR: drive input_required manually to keep pending-request UX (#1704)

Follow-up to #1627/#1705. Instead of letting the SDK auto-fulfil the modern
(2026-07-28) MRTR retry loop, InspectorClient now drives it itself so the
Inspector keeps its pending-request UX, owns the loop, and shows era-accurate
semantics.

Core (core/mcp/inspectorClient.ts):
- Construct the SDK Client with `inputRequired: { autoFulfill: false }`
  (unconditional; a no-op on legacy, which never returns input_required).
- New `requestWithInputRequired()` driver: issues the request with
  `allowInputRequired` + `withInputRequired(schema)`, and while the result is
  `input_required`, fulfils each embedded request through the SAME pending
  sampling/elicitation plumbing, then retries the original call with
  `inputResponses` + the echoed `requestState` on a fresh id, bounded by
  MRTR_MAX_ROUNDS.
- Route tools/call, prompts/get, and resources/read through the driver.
- Embedded roots/list is auto-answered from configured roots (no pending UX);
  decline/cancel is echoed to the server (not treated as an abort); a tool-call
  abort mid-round settles the pending request and surfaces
  ToolCallCancelledError.
- Extract shared `enqueuePendingSample`/`enqueuePendingElicitation` helpers used
  by both the legacy inbound handlers and the driver; add a per-request `origin`
  ("server-request" | "input-required") to the pending wrappers.

Web UI:
- New `MrtrOriginNote` element shows an "input_required — your answer returns as
  a retry" note on a modern MRTR round; legacy panels are unchanged.
- Thread `origin` App -> PendingClientRequestModal -> the sampling/elicitation
  panels (and the inline panels).

Test servers: new MRTR presets (multi-round, roots, sampling, loop, edge-case
param shaping). Integration tests cover the manual round-trip (asserting the
pending UI pauses and the retry carries inputResponses + requestState on a new
id), multi-round, roots auto-answer, sampling, decline-echoed, maxRounds bound,
abort mid-round, and requestState-only/inputRequests-only param shaping.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XNdjEPKLG637X8YmhDiEk5

* Review: clarify sampling-reject and between-rounds abort comments (#1704)

Address review nits on PR #1719 (comment-only, no behavior change):
- enqueuePendingSample docstring: sampling has no decline/cancel action; the
  panel either sends a result (resolve) or Rejects (reject → fails the call).
  The shared "declined/cancelled resolves" wording was accurate only for the
  elicitation case.
- callToolWithRetries abort comment: note the between-rounds case — when the
  abort lands while an MRTR round awaits an embedded pending request there is no
  in-flight SDK request, so nothing is sent on the wire; the outcome
  (ToolCallCancelledError, no failed-call record) is identical.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XNdjEPKLG637X8YmhDiEk5

* test-servers: add mrtr-showcase config exercising every MRTR preset (#1704)

A single modern-era streamable-HTTP server (port 3111) bundling all six MRTR
presets — mrtr_confirm, mrtr_two_step, mrtr_sample, mrtr_roots, mrtr_edge,
mrtr_loop — for manual testing of the manual-driving pending-request UX across
single-round, multi-round, sampling, roots, param-shaping, and maxRounds paths.
Document it in the README alongside modern-mrtr-http.json.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XNdjEPKLG637X8YmhDiEk5

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-17 23:15:19 -04:00

321 lines
11 KiB
TypeScript

import { describe, it, expect, vi, beforeEach } from "vitest";
import userEvent from "@testing-library/user-event";
import type {
CreateMessageRequestParams,
ElicitRequestFormParams,
} from "@modelcontextprotocol/client";
import { renderWithMantine, screen } from "../../../test/renderWithMantine";
import {
PendingClientRequestModal,
type PendingClientRequestContent,
} from "./PendingClientRequestModal";
const samplingRequest: CreateMessageRequestParams = {
messages: [
{
role: "user",
content: { type: "text", text: "What is the capital of France?" },
},
],
maxTokens: 1024,
};
const formRequest: ElicitRequestFormParams = {
message: "Please provide your name.",
requestedSchema: {
type: "object",
properties: { name: { type: "string", title: "Name" } },
},
};
const samplingContent: PendingClientRequestContent = {
kind: "sampling",
id: "sampling-1",
request: samplingRequest,
origin: "server-request",
};
const formContent: PendingClientRequestContent = {
kind: "elicitation-form",
id: "elicitation-1",
request: formRequest,
origin: "server-request",
};
const urlContent: PendingClientRequestContent = {
kind: "elicitation-url",
id: "elicitation-2",
message: "Authorize access in your browser.",
url: "https://example.com/authorize",
origin: "server-request",
};
const baseProps = {
serverName: "Everything Server",
queuePosition: "1 of 1",
onSamplingRespond: vi.fn(),
onSamplingReject: vi.fn(),
onElicitationRespond: vi.fn(),
};
beforeEach(() => {
vi.clearAllMocks();
});
describe("PendingClientRequestModal", () => {
it("renders nothing when there is no active request", () => {
renderWithMantine(
<PendingClientRequestModal {...baseProps} request={null} />,
);
expect(screen.queryByText("Sampling Request")).not.toBeInTheDocument();
expect(screen.queryByText("Elicitation Request")).not.toBeInTheDocument();
});
it("renders the sampling title, queue position, and panel", () => {
renderWithMantine(
<PendingClientRequestModal {...baseProps} request={samplingContent} />,
);
expect(screen.getByText("Sampling Request")).toBeInTheDocument();
expect(screen.getByText("1 of 1")).toBeInTheDocument();
expect(
screen.getByText("The server is requesting an LLM completion."),
).toBeInTheDocument();
// Legacy server-request origin: no MRTR note.
expect(screen.queryByText("input_required")).not.toBeInTheDocument();
});
it("shows the MRTR note when the request is a modern input_required round", () => {
renderWithMantine(
<PendingClientRequestModal
{...baseProps}
request={{ ...samplingContent, origin: "input-required" }}
/>,
);
expect(screen.getByText("input_required")).toBeInTheDocument();
expect(screen.getByText(/sent back as a retry/i)).toBeInTheDocument();
});
it("sends the default stub sampling result when the draft is untouched", async () => {
const user = userEvent.setup();
renderWithMantine(
<PendingClientRequestModal {...baseProps} request={samplingContent} />,
);
await user.click(screen.getByRole("button", { name: "Send Response" }));
expect(baseProps.onSamplingRespond).toHaveBeenCalledWith({
model: "stub-model",
stopReason: "endTurn",
role: "assistant",
content: { type: "text", text: "" },
});
});
it("sends the edited sampling draft", async () => {
const user = userEvent.setup();
renderWithMantine(
<PendingClientRequestModal {...baseProps} request={samplingContent} />,
);
const textarea = screen
.getAllByRole("textbox")
.find((el) => el.tagName === "TEXTAREA") as HTMLTextAreaElement;
await user.type(textarea, "Paris");
await user.click(screen.getByRole("button", { name: "Send Response" }));
expect(baseProps.onSamplingRespond).toHaveBeenCalledWith(
expect.objectContaining({
content: { type: "text", text: "Paris" },
}),
);
});
it("rejects the sampling request", async () => {
const user = userEvent.setup();
renderWithMantine(
<PendingClientRequestModal {...baseProps} request={samplingContent} />,
);
await user.click(screen.getByRole("button", { name: "Reject" }));
expect(baseProps.onSamplingReject).toHaveBeenCalledTimes(1);
});
it("resolves a request only once when the action is double-clicked", async () => {
const user = userEvent.setup();
renderWithMantine(
<PendingClientRequestModal {...baseProps} request={samplingContent} />,
);
const sendResponse = screen.getByRole("button", { name: "Send Response" });
await user.click(sendResponse);
// After the first dispatch the actions lock (busy); a second click no-ops.
await user.click(sendResponse);
expect(baseProps.onSamplingRespond).toHaveBeenCalledTimes(1);
expect(
screen.getByRole("button", { name: "Send Response" }),
).toBeDisabled();
expect(screen.getByRole("button", { name: "Reject" })).toBeDisabled();
});
it("renders the elicitation form with the server name warning", () => {
renderWithMantine(
<PendingClientRequestModal {...baseProps} request={formContent} />,
);
expect(screen.getByText("Elicitation Request")).toBeInTheDocument();
expect(screen.getByText(/Please provide your name/)).toBeInTheDocument();
expect(screen.getByText(/Everything Server/)).toBeInTheDocument();
});
it("accepts a form elicitation on submit", async () => {
const user = userEvent.setup();
renderWithMantine(
<PendingClientRequestModal {...baseProps} request={formContent} />,
);
await user.click(screen.getByRole("button", { name: "Submit" }));
expect(baseProps.onElicitationRespond).toHaveBeenCalledWith({
action: "accept",
content: {},
});
});
it("includes untouched schema defaults in the submitted content", async () => {
const user = userEvent.setup();
const formWithDefaults: PendingClientRequestContent = {
kind: "elicitation-form",
id: "elicitation-defaults",
request: {
message: "Confirm your preferences.",
requestedSchema: {
type: "object",
properties: {
firstLine: {
type: "string",
title: "First line",
default: "It was a dark and stormy night.",
},
integer: { type: "integer", title: "Integer", default: 42 },
name: { type: "string", title: "Name" },
},
},
},
origin: "server-request",
};
renderWithMantine(
<PendingClientRequestModal {...baseProps} request={formWithDefaults} />,
);
// Submit without touching any field: the default-only fields must still be
// sent (the v1-parity bug this guards against dropped them).
await user.click(screen.getByRole("button", { name: "Submit" }));
expect(baseProps.onElicitationRespond).toHaveBeenCalledWith({
action: "accept",
content: {
firstLine: "It was a dark and stormy night.",
integer: 42,
},
});
});
it("declines a form elicitation", async () => {
const user = userEvent.setup();
renderWithMantine(
<PendingClientRequestModal {...baseProps} request={formContent} />,
);
await user.click(screen.getByRole("button", { name: "Decline" }));
expect(baseProps.onElicitationRespond).toHaveBeenCalledWith({
action: "decline",
});
});
it("cancels a form elicitation", async () => {
const user = userEvent.setup();
renderWithMantine(
<PendingClientRequestModal {...baseProps} request={formContent} />,
);
await user.click(screen.getByRole("button", { name: "Cancel" }));
expect(baseProps.onElicitationRespond).toHaveBeenCalledWith({
action: "cancel",
});
});
it("opens the URL into a waiting state without resolving the elicitation", async () => {
const user = userEvent.setup();
const openSpy = vi.spyOn(window, "open").mockReturnValue(null);
renderWithMantine(
<PendingClientRequestModal {...baseProps} request={urlContent} />,
);
// Before opening there is no completion action.
expect(
screen.queryByRole("button", { name: "I've completed it" }),
).not.toBeInTheDocument();
await user.click(screen.getByRole("button", { name: "Open in Browser" }));
expect(openSpy).toHaveBeenCalledWith(
"https://example.com/authorize",
"_blank",
"noopener,noreferrer",
);
// Opening alone must not resolve the elicitation; it only reveals the
// explicit completion step.
expect(baseProps.onElicitationRespond).not.toHaveBeenCalled();
expect(
screen.getByRole("button", { name: "I've completed it" }),
).toBeInTheDocument();
openSpy.mockRestore();
});
it("accepts a URL elicitation only after the user confirms completion", async () => {
const user = userEvent.setup();
const openSpy = vi.spyOn(window, "open").mockReturnValue(null);
renderWithMantine(
<PendingClientRequestModal {...baseProps} request={urlContent} />,
);
await user.click(screen.getByRole("button", { name: "Open in Browser" }));
await user.click(screen.getByRole("button", { name: "I've completed it" }));
expect(baseProps.onElicitationRespond).toHaveBeenCalledWith({
action: "accept",
});
openSpy.mockRestore();
});
it("copies the URL to the clipboard", async () => {
const user = userEvent.setup();
const writeText = vi.fn().mockResolvedValue(undefined);
Object.defineProperty(navigator, "clipboard", {
value: { writeText },
configurable: true,
});
renderWithMantine(
<PendingClientRequestModal {...baseProps} request={urlContent} />,
);
await user.click(screen.getByRole("button", { name: "Copy URL" }));
expect(writeText).toHaveBeenCalledWith("https://example.com/authorize");
});
it("reveals the completion step after Copy URL so a copy-paste flow can accept", async () => {
const user = userEvent.setup();
Object.defineProperty(navigator, "clipboard", {
value: { writeText: vi.fn().mockResolvedValue(undefined) },
configurable: true,
});
renderWithMantine(
<PendingClientRequestModal {...baseProps} request={urlContent} />,
);
// Before copying there is no completion action.
expect(
screen.queryByRole("button", { name: "I've completed it" }),
).not.toBeInTheDocument();
await user.click(screen.getByRole("button", { name: "Copy URL" }));
await user.click(screen.getByRole("button", { name: "I've completed it" }));
expect(baseProps.onElicitationRespond).toHaveBeenCalledWith({
action: "accept",
});
});
it("cancels a URL elicitation after opening without sending accept", async () => {
const user = userEvent.setup();
const openSpy = vi.spyOn(window, "open").mockReturnValue(null);
renderWithMantine(
<PendingClientRequestModal {...baseProps} request={urlContent} />,
);
await user.click(screen.getByRole("button", { name: "Open in Browser" }));
await user.click(screen.getByRole("button", { name: "Cancel" }));
expect(baseProps.onElicitationRespond).toHaveBeenCalledTimes(1);
expect(baseProps.onElicitationRespond).toHaveBeenCalledWith({
action: "cancel",
});
openSpy.mockRestore();
});
});