* Add Playwright E2E tests with screenshot golden testing - Add E2E tests for all 8 MCP server examples - Screenshot golden images for visual regression testing - CI workflow for running E2E tests - npm scripts: test:e2e, test:e2e:update, test:e2e:ui 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Add default demo code for Three.js example When no code is provided, show a rotating green cube demo. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Add E2E testing documentation to CONTRIBUTING.md 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Update Three.js golden screenshot with 3D cube 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Add explicit permissions to CI workflow Set minimal read-only permissions for security best practices. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Fix test.setTimeout() to be inside describe blocks Playwright requires setTimeout to be called within a test or describe block. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Simplify E2E tests - remove excessive timeouts - Remove explicit setTimeout calls (default 30s is sufficient) - Replace waitForTimeout(5000/6000) with proper waitForAppLoad() - Wait for inner iframe visibility instead of fixed delays - Keep only 500ms stabilization for screenshot animations 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Auto-generate missing snapshots in CI Use updateSnapshots: 'missing' in CI to handle cross-platform screenshot differences (macOS vs Linux). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Use platform-agnostic golden screenshots - Remove -chromium-darwin suffix from snapshot filenames - Configure snapshotPathTemplate for cross-platform compatibility - Increase tolerance to 5% for rendering differences between platforms 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Refactor tests to use forEach instead of for-of loop May help with Playwright test discovery issues in CI. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Use npm ci and list reporter in CI - Use npm ci for exact package versions - Use --reporter=list instead of html to avoid potential re-evaluation issues - Only upload test-results on failure 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Exclude e2e tests from bun test Run bun test only on src/ directory to avoid running Playwright tests with Bun's test runner. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Fix prettier formatting 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Add interaction tests for basic server apps Test that clicking buttons in the MCP App triggers the corresponding host callbacks: - Send Message → host logs "Message from MCP App" - Send Log → host logs "Log message from MCP App" - Open Link → host logs "Open link request" Tests both React and Vanilla JS implementations. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Mask dynamic content in E2E screenshot tests Add Playwright mask option to handle servers with dynamic/random content: - basic-react/vanillajs: mask server time display - system-monitor: mask CPU chart, memory stats, uptime - cohort-heatmap: mask heatmap grid (random data) - customer-segmentation: mask scatter chart (random data) This addresses PR feedback about handling examples with non-deterministic output. Masking replaces the previous 10% tolerance with proper exclusion of dynamic elements, allowing tighter 1% tolerance for the rest of the UI. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Add wiki-explorer to E2E tests with default URL param - Add default URL "https://en.wikipedia.org/wiki/Model_Context_Protocol" to wiki-explorer-server's get-first-degree-links tool inputSchema - Update basic-host to automatically populate input field with tool defaults extracted from inputSchema.properties - Add wiki-explorer-server to E2E test suite with dynamic masking for the force-directed graph 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Use .default() for threejs tool schema instead of .optional() This exposes the default code and height values in the JSON Schema, allowing basic-host to auto-populate the input field with defaults. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Enable parallel E2E tests with timeouts and canvas masking - Enable fullyParallel with 4 workers locally (2 in CI) - Add 30s timeout per test - Mask threejs canvas for stable screenshots - Update snapshots to reflect default values in input fields 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Add pre-commit check for private registry URLs in package-lock.json Same check as in CI to catch issues before push. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Increase screenshot diff tolerance to 6% for cross-platform rendering Font rendering differs between macOS and Linux, causing ~5% pixel differences. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Revert pre-commit artifactory check (moved to separate PR #133) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Format threejs server.ts 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * Update CONTRIBUTING.md to reflect platform-agnostic screenshots 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> * fix(e2e): use factory pattern for MCP servers to support parallel connections McpServer only supports one transport at a time. When multiple browser contexts connected in parallel, calling server.connect(transport) for each session overwrote the previous transport's callbacks, causing connection corruption and test timeouts. Changes: - server-utils.ts: accept factory function instead of single instance - All 9 example servers: wrap server creation in createServer() function - playwright.config.ts: re-enable parallel execution (4 workers) - servers.spec.ts: add toBeEnabled wait for server connection - Update screenshot baselines for basic-vanillajs and cohort-heatmap 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude <noreply@anthropic.com>
362 lines
11 KiB
TypeScript
362 lines
11 KiB
TypeScript
import type { Tool } from "@modelcontextprotocol/sdk/types.js";
|
||
import { Component, type ErrorInfo, type ReactNode, StrictMode, Suspense, use, useEffect, useMemo, useRef, useState } from "react";
|
||
import { createRoot } from "react-dom/client";
|
||
import { callTool, connectToServer, hasAppHtml, initializeApp, loadSandboxProxy, log, newAppBridge, type ServerInfo, type ToolCallInfo } from "./implementation";
|
||
import styles from "./index.module.css";
|
||
|
||
|
||
/**
|
||
* Extract default values from a tool's JSON Schema inputSchema.
|
||
* Returns a formatted JSON string with defaults, or "{}" if none found.
|
||
*/
|
||
function getToolDefaults(tool: Tool | undefined): string {
|
||
if (!tool?.inputSchema?.properties) return "{}";
|
||
|
||
const defaults: Record<string, unknown> = {};
|
||
for (const [key, prop] of Object.entries(tool.inputSchema.properties)) {
|
||
if (prop && typeof prop === "object" && "default" in prop) {
|
||
defaults[key] = prop.default;
|
||
}
|
||
}
|
||
|
||
return Object.keys(defaults).length > 0
|
||
? JSON.stringify(defaults, null, 2)
|
||
: "{}";
|
||
}
|
||
|
||
|
||
// Host passes serversPromise to CallToolPanel
|
||
interface HostProps {
|
||
serversPromise: Promise<ServerInfo[]>;
|
||
}
|
||
|
||
type ToolCallEntry = ToolCallInfo & { id: number };
|
||
let nextToolCallId = 0;
|
||
|
||
function Host({ serversPromise }: HostProps) {
|
||
const [toolCalls, setToolCalls] = useState<ToolCallEntry[]>([]);
|
||
const [destroyingIds, setDestroyingIds] = useState<Set<number>>(new Set());
|
||
|
||
const requestClose = (id: number) => {
|
||
setDestroyingIds((s) => new Set(s).add(id));
|
||
};
|
||
|
||
const completeClose = (id: number) => {
|
||
setDestroyingIds((s) => {
|
||
const next = new Set(s);
|
||
next.delete(id);
|
||
return next;
|
||
});
|
||
setToolCalls((calls) => calls.filter((c) => c.id !== id));
|
||
};
|
||
|
||
return (
|
||
<>
|
||
{toolCalls.map((info) => (
|
||
<ToolCallInfoPanel
|
||
key={info.id}
|
||
toolCallInfo={info}
|
||
isDestroying={destroyingIds.has(info.id)}
|
||
onRequestClose={() => requestClose(info.id)}
|
||
onCloseComplete={() => completeClose(info.id)}
|
||
/>
|
||
))}
|
||
<CallToolPanel
|
||
serversPromise={serversPromise}
|
||
addToolCall={(info) => setToolCalls([...toolCalls, { ...info, id: nextToolCallId++ }])}
|
||
/>
|
||
</>
|
||
);
|
||
}
|
||
|
||
|
||
// CallToolPanel renders the unified form with Suspense around ServerSelect
|
||
interface CallToolPanelProps {
|
||
serversPromise: Promise<ServerInfo[]>;
|
||
addToolCall: (info: ToolCallInfo) => void;
|
||
}
|
||
function CallToolPanel({ serversPromise, addToolCall }: CallToolPanelProps) {
|
||
const [selectedServer, setSelectedServer] = useState<ServerInfo | null>(null);
|
||
const [selectedTool, setSelectedTool] = useState("");
|
||
const [inputJson, setInputJson] = useState("{}");
|
||
|
||
const toolNames = selectedServer ? Array.from(selectedServer.tools.keys()) : [];
|
||
|
||
const isValidJson = useMemo(() => {
|
||
try {
|
||
JSON.parse(inputJson);
|
||
return true;
|
||
} catch {
|
||
return false;
|
||
}
|
||
}, [inputJson]);
|
||
|
||
const handleServerSelect = (server: ServerInfo) => {
|
||
setSelectedServer(server);
|
||
const [firstTool] = server.tools.keys();
|
||
setSelectedTool(firstTool ?? "");
|
||
// Set input JSON to tool defaults (if any)
|
||
setInputJson(getToolDefaults(server.tools.get(firstTool ?? "")));
|
||
};
|
||
|
||
const handleToolSelect = (toolName: string) => {
|
||
setSelectedTool(toolName);
|
||
// Set input JSON to tool defaults (if any)
|
||
setInputJson(getToolDefaults(selectedServer?.tools.get(toolName)));
|
||
};
|
||
|
||
const handleSubmit = () => {
|
||
if (!selectedServer) return;
|
||
const toolCallInfo = callTool(selectedServer, selectedTool, JSON.parse(inputJson));
|
||
addToolCall(toolCallInfo);
|
||
};
|
||
|
||
return (
|
||
<div className={styles.callToolPanel}>
|
||
<form onSubmit={(e) => { e.preventDefault(); handleSubmit(); }}>
|
||
<label>
|
||
Server
|
||
<Suspense fallback={<select disabled><option>Loading...</option></select>}>
|
||
<ServerSelect serversPromise={serversPromise} onSelect={handleServerSelect} />
|
||
</Suspense>
|
||
</label>
|
||
<label>
|
||
Tool
|
||
<select
|
||
className={styles.toolSelect}
|
||
value={selectedTool}
|
||
onChange={(e) => handleToolSelect(e.target.value)}
|
||
>
|
||
{selectedServer && toolNames.map((name) => (
|
||
<option key={name} value={name}>{name}</option>
|
||
))}
|
||
</select>
|
||
</label>
|
||
<label>
|
||
Input
|
||
<textarea
|
||
className={styles.toolInput}
|
||
aria-invalid={!isValidJson}
|
||
value={inputJson}
|
||
onChange={(e) => setInputJson(e.target.value)}
|
||
/>
|
||
</label>
|
||
<button type="submit" disabled={!selectedTool || !isValidJson}>
|
||
Call Tool
|
||
</button>
|
||
</form>
|
||
</div>
|
||
);
|
||
}
|
||
|
||
|
||
// ServerSelect calls use() and renders the server <select>
|
||
interface ServerSelectProps {
|
||
serversPromise: Promise<ServerInfo[]>;
|
||
onSelect: (server: ServerInfo) => void;
|
||
}
|
||
function ServerSelect({ serversPromise, onSelect }: ServerSelectProps) {
|
||
const servers = use(serversPromise);
|
||
const [selectedIndex, setSelectedIndex] = useState(0);
|
||
|
||
useEffect(() => {
|
||
if (servers.length > selectedIndex) {
|
||
onSelect(servers[selectedIndex]);
|
||
}
|
||
}, [servers]);
|
||
|
||
if (servers.length === 0) {
|
||
return <select disabled><option>No servers configured</option></select>;
|
||
}
|
||
|
||
return (
|
||
<select
|
||
value={selectedIndex}
|
||
onChange={(e) => {
|
||
const newIndex = Number(e.target.value);
|
||
setSelectedIndex(newIndex);
|
||
onSelect(servers[newIndex]);
|
||
}}
|
||
>
|
||
{servers.map((server, i) => (
|
||
<option key={i} value={i}>{server.name}</option>
|
||
))}
|
||
</select>
|
||
);
|
||
}
|
||
|
||
|
||
interface ToolCallInfoPanelProps {
|
||
toolCallInfo: ToolCallInfo;
|
||
isDestroying?: boolean;
|
||
onRequestClose?: () => void;
|
||
onCloseComplete?: () => void;
|
||
}
|
||
function ToolCallInfoPanel({ toolCallInfo, isDestroying, onRequestClose, onCloseComplete }: ToolCallInfoPanelProps) {
|
||
const isApp = hasAppHtml(toolCallInfo);
|
||
|
||
// For non-app tool calls, close immediately when isDestroying becomes true
|
||
useEffect(() => {
|
||
if (isDestroying && !isApp) {
|
||
onCloseComplete?.();
|
||
}
|
||
}, [isDestroying, isApp, onCloseComplete]);
|
||
|
||
return (
|
||
<div
|
||
className={styles.toolCallInfoPanel}
|
||
style={isDestroying ? { opacity: 0.5, pointerEvents: "none" } : undefined}
|
||
>
|
||
<div className={styles.inputInfoPanel}>
|
||
<h2>
|
||
<span>{toolCallInfo.serverInfo.name}</span>
|
||
<span className={styles.toolName}>{toolCallInfo.tool.name}</span>
|
||
{onRequestClose && !isDestroying && (
|
||
<button
|
||
className={styles.closeButton}
|
||
onClick={onRequestClose}
|
||
title="Close"
|
||
>
|
||
×
|
||
</button>
|
||
)}
|
||
</h2>
|
||
<JsonBlock value={toolCallInfo.input} />
|
||
</div>
|
||
<div className={styles.outputInfoPanel}>
|
||
<ErrorBoundary>
|
||
<Suspense fallback="Loading...">
|
||
{
|
||
isApp
|
||
? <AppIFramePanel
|
||
toolCallInfo={toolCallInfo}
|
||
isDestroying={isDestroying}
|
||
onTeardownComplete={onCloseComplete}
|
||
/>
|
||
: <ToolResultPanel toolCallInfo={toolCallInfo} />
|
||
}
|
||
</Suspense>
|
||
</ErrorBoundary>
|
||
</div>
|
||
</div>
|
||
);
|
||
}
|
||
|
||
|
||
function JsonBlock({ value }: { value: object }) {
|
||
return (
|
||
<pre className={styles.jsonBlock}>
|
||
<code>{JSON.stringify(value, null, 2)}</code>
|
||
</pre>
|
||
);
|
||
}
|
||
|
||
|
||
interface AppIFramePanelProps {
|
||
toolCallInfo: Required<ToolCallInfo>;
|
||
isDestroying?: boolean;
|
||
onTeardownComplete?: () => void;
|
||
}
|
||
function AppIFramePanel({ toolCallInfo, isDestroying, onTeardownComplete }: AppIFramePanelProps) {
|
||
const iframeRef = useRef<HTMLIFrameElement | null>(null);
|
||
const appBridgeRef = useRef<ReturnType<typeof newAppBridge> | null>(null);
|
||
|
||
useEffect(() => {
|
||
const iframe = iframeRef.current!;
|
||
loadSandboxProxy(iframe).then((firstTime) => {
|
||
// The `firstTime` check guards against React Strict Mode's double
|
||
// invocation (mount → unmount → remount simulation in development).
|
||
// Outside of Strict Mode, this `useEffect` runs only once per
|
||
// `toolCallInfo`.
|
||
if (firstTime) {
|
||
const appBridge = newAppBridge(toolCallInfo.serverInfo, iframe);
|
||
appBridgeRef.current = appBridge;
|
||
initializeApp(iframe, appBridge, toolCallInfo);
|
||
}
|
||
});
|
||
}, [toolCallInfo]);
|
||
|
||
// Graceful teardown: wait for guest to respond before unmounting
|
||
// This follows the spec: "Host SHOULD wait for a response before tearing
|
||
// down the resource (to prevent data loss)."
|
||
useEffect(() => {
|
||
if (!isDestroying) return;
|
||
|
||
if (!appBridgeRef.current) {
|
||
// Bridge not ready yet (e.g., user closed before iframe loaded)
|
||
onTeardownComplete?.();
|
||
return;
|
||
}
|
||
|
||
log.info("Sending teardown notification to MCP App");
|
||
appBridgeRef.current.sendResourceTeardown({})
|
||
.catch((err) => {
|
||
log.warn("Teardown request failed (app may have already closed):", err);
|
||
})
|
||
.finally(() => {
|
||
onTeardownComplete?.();
|
||
});
|
||
}, [isDestroying, onTeardownComplete]);
|
||
|
||
return (
|
||
<div className={styles.appIframePanel}>
|
||
<iframe ref={iframeRef} />
|
||
</div>
|
||
);
|
||
}
|
||
|
||
|
||
interface ToolResultPanelProps {
|
||
toolCallInfo: ToolCallInfo;
|
||
}
|
||
function ToolResultPanel({ toolCallInfo }: ToolResultPanelProps) {
|
||
const result = use(toolCallInfo.resultPromise);
|
||
return <JsonBlock value={result} />;
|
||
}
|
||
|
||
|
||
interface ErrorBoundaryProps {
|
||
children: ReactNode;
|
||
}
|
||
interface ErrorBoundaryState {
|
||
hasError: boolean;
|
||
error: unknown;
|
||
}
|
||
class ErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryState> {
|
||
state: ErrorBoundaryState = { hasError: false, error: undefined };
|
||
|
||
// Called during render phase - must be pure (no side effects)
|
||
// Note: error is `unknown` because JS allows throwing any value
|
||
static getDerivedStateFromError(error: unknown): ErrorBoundaryState {
|
||
return { hasError: true, error };
|
||
}
|
||
|
||
// Called during commit phase - can have side effects (logging, etc.)
|
||
componentDidCatch(error: unknown, errorInfo: ErrorInfo): void {
|
||
log.error("Caught:", error, errorInfo.componentStack);
|
||
}
|
||
|
||
render(): ReactNode {
|
||
if (this.state.hasError) {
|
||
const { error } = this.state;
|
||
const message = error instanceof Error ? error.message : String(error);
|
||
return <div className={styles.error}><strong>ERROR:</strong> {message}</div>;
|
||
}
|
||
return this.props.children;
|
||
}
|
||
}
|
||
|
||
|
||
async function connectToAllServers(): Promise<ServerInfo[]> {
|
||
const serverUrlsResponse = await fetch("/api/servers");
|
||
const serverUrls = (await serverUrlsResponse.json()) as string[];
|
||
return Promise.all(serverUrls.map((url) => connectToServer(new URL(url))));
|
||
}
|
||
|
||
createRoot(document.getElementById("root")!).render(
|
||
<StrictMode>
|
||
<ErrorBoundary>
|
||
<Host serversPromise={connectToAllServers()} />
|
||
</ErrorBoundary>
|
||
</StrictMode>,
|
||
);
|