* feat(apps): add AppRenderer element with imperative ref (#1262) Introduces a thin host-side shell for embedded MCP Apps. The renderer owns the iframe element and the AppBridge lifecycle; the wiring layer constructs the bridge from the active MCP Client via bridgeFactory and drives input/result/cancellation through the imperative ref handle. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * review: address PR feedback on AppRenderer - Document BridgeFactory stability requirement (unstable identity thrashes the iframe on every render). - Null bridgeRef synchronously inside teardown() before awaiting disposal, so a concurrent unmount cleanup cannot dispose the same bridge twice. - Comment the iframe trust model: the outer frame loads the inspector's trusted same-origin sandbox-proxy, which sandboxes the actual app content. Adding `sandbox` to this frame would block the postMessage bridge. - Rename `Error` story export to `BridgeError` to avoid shadowing the global Error constructor; drop the `globalThis.Error` workaround. - Comment flushAsync to explain the two-tick microtask budget. - Add unmount-while-tearing-down test to lock in the no-double-dispose guarantee. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
1ffcdc38ca
commit
323f42d11c
1 changed files with 672 additions and 0 deletions
150
clients/web/src/components/elements/AppRenderer/AppRenderer.tsx
Normal file
150
clients/web/src/components/elements/AppRenderer/AppRenderer.tsx
Normal file
|
|
@ -0,0 +1,150 @@
|
|||
import { Box } from "@mantine/core";
|
||||
import { useEffect, useImperativeHandle, useRef, type Ref } from "react";
|
||||
import type { AppBridge } from "@modelcontextprotocol/ext-apps/app-bridge";
|
||||
import type { CallToolResult, Tool } from "@modelcontextprotocol/sdk/types.js";
|
||||
|
||||
/**
|
||||
* Constructs the `AppBridge` for a freshly mounted sandbox iframe. Wrap with
|
||||
* `useCallback` (or hoist out of render) — the renderer treats a new factory
|
||||
* identity as a signal to tear down the current bridge and rebuild, so an
|
||||
* unstable factory will thrash the iframe on every render.
|
||||
*/
|
||||
export type BridgeFactory = (
|
||||
iframe: HTMLIFrameElement,
|
||||
) => AppBridge | Promise<AppBridge>;
|
||||
|
||||
export interface AppRendererHandle {
|
||||
sendToolInput(args: Record<string, unknown>): Promise<void>;
|
||||
sendToolResult(result: CallToolResult): Promise<void>;
|
||||
sendToolCancelled(reason: string): Promise<void>;
|
||||
teardown(): Promise<void>;
|
||||
}
|
||||
|
||||
export interface AppRendererProps {
|
||||
sandboxPath: string;
|
||||
tool: Tool;
|
||||
bridgeFactory: BridgeFactory;
|
||||
onError?: (err: Error) => void;
|
||||
ref?: Ref<AppRendererHandle>;
|
||||
}
|
||||
|
||||
function toError(err: unknown): Error {
|
||||
return err instanceof Error ? err : new Error(String(err));
|
||||
}
|
||||
|
||||
async function disposeBridge(bridge: AppBridge): Promise<void> {
|
||||
// Best-effort: still close the transport even if teardownResource fails,
|
||||
// otherwise the iframe unmount would leak MessagePort listeners.
|
||||
try {
|
||||
await bridge.teardownResource({});
|
||||
} catch {
|
||||
/* swallow — closing transport below is the load-bearing step */
|
||||
}
|
||||
try {
|
||||
await bridge.close();
|
||||
} catch {
|
||||
/* swallow — already disposing */
|
||||
}
|
||||
}
|
||||
|
||||
export function AppRenderer({
|
||||
sandboxPath,
|
||||
tool,
|
||||
bridgeFactory,
|
||||
onError,
|
||||
ref,
|
||||
}: AppRendererProps) {
|
||||
const iframeRef = useRef<HTMLIFrameElement | null>(null);
|
||||
const bridgeRef = useRef<AppBridge | null>(null);
|
||||
const teardownStartedRef = useRef(false);
|
||||
const onErrorRef = useRef(onError);
|
||||
useEffect(() => {
|
||||
onErrorRef.current = onError;
|
||||
});
|
||||
|
||||
useEffect(() => {
|
||||
const iframe = iframeRef.current;
|
||||
if (!iframe) return;
|
||||
|
||||
let cancelled = false;
|
||||
teardownStartedRef.current = false;
|
||||
|
||||
let pending: Promise<AppBridge>;
|
||||
try {
|
||||
pending = Promise.resolve(bridgeFactory(iframe));
|
||||
} catch (err) {
|
||||
onErrorRef.current?.(toError(err));
|
||||
return () => {
|
||||
cancelled = true;
|
||||
};
|
||||
}
|
||||
|
||||
pending
|
||||
.then((bridge) => {
|
||||
if (cancelled) {
|
||||
void disposeBridge(bridge);
|
||||
return;
|
||||
}
|
||||
bridgeRef.current = bridge;
|
||||
})
|
||||
.catch((err) => {
|
||||
if (!cancelled) onErrorRef.current?.(toError(err));
|
||||
});
|
||||
|
||||
return () => {
|
||||
cancelled = true;
|
||||
const bridge = bridgeRef.current;
|
||||
bridgeRef.current = null;
|
||||
if (bridge) void disposeBridge(bridge);
|
||||
};
|
||||
}, [bridgeFactory, sandboxPath]);
|
||||
|
||||
useImperativeHandle(
|
||||
ref,
|
||||
() => ({
|
||||
async sendToolInput(args) {
|
||||
const bridge = bridgeRef.current;
|
||||
if (!bridge) return;
|
||||
await bridge.sendToolInput({ arguments: args });
|
||||
},
|
||||
async sendToolResult(result) {
|
||||
const bridge = bridgeRef.current;
|
||||
if (!bridge) return;
|
||||
await bridge.sendToolResult(result);
|
||||
},
|
||||
async sendToolCancelled(reason) {
|
||||
const bridge = bridgeRef.current;
|
||||
if (!bridge) return;
|
||||
await bridge.sendToolCancelled({ reason });
|
||||
},
|
||||
async teardown() {
|
||||
const bridge = bridgeRef.current;
|
||||
if (!bridge || teardownStartedRef.current) return;
|
||||
teardownStartedRef.current = true;
|
||||
// Null the ref synchronously so a concurrent unmount cleanup cannot
|
||||
// see a still-live bridge and dispose it a second time.
|
||||
bridgeRef.current = null;
|
||||
await disposeBridge(bridge);
|
||||
},
|
||||
}),
|
||||
[],
|
||||
);
|
||||
|
||||
// The iframe deliberately has no `sandbox` attribute: `sandboxPath` resolves
|
||||
// to the inspector's own bundled sandbox-proxy page (trusted, same-origin),
|
||||
// which then loads the untrusted MCP App content into a nested sandboxed
|
||||
// iframe. Sandboxing this outer frame would block the postMessage bridge
|
||||
// that `AppBridge` relies on.
|
||||
return (
|
||||
<Box
|
||||
component="iframe"
|
||||
ref={iframeRef}
|
||||
src={sandboxPath}
|
||||
title={tool.title ?? tool.name}
|
||||
w="100%"
|
||||
h="100%"
|
||||
bd={0}
|
||||
display="block"
|
||||
/>
|
||||
);
|
||||
}
|
||||
Loading…
Reference in a new issue