Skip to content

Write HTML. Render video. Built for agents.

fix(studio): keep a pick made just before a reload swaps the preview frame (#4888)

Miguel Ángelc967a055fb8c
diff --git a/packages/studio/src/hooks/useElementPicker.test.ts b/packages/studio/src/hooks/useElementPicker.test.ts
index 1823215922..98ae87dda7 100644
--- a/packages/studio/src/hooks/useElementPicker.test.ts
+++ b/packages/studio/src/hooks/useElementPicker.test.ts
@@ -19,6 +19,22 @@ afterEach(() => {
document.body.innerHTML = "";
});
+// The runtime's element-picked message, posted by `from`.
+const picked = (from: Window | null, selector: string) =>
+ act(() => {
+ window.dispatchEvent(
+ new MessageEvent("message", {
+ source: from,
+ data: {
+ source: "hf-preview",
+ type: "element-picked",
+ elementInfo: { selector, tagName: "h1" },
+ ...runtimeProtocolMetadata(30),
+ },
+ }),
+ );
+ });
+
// The preview page: the saved markup plus what the runtime adds to it.
function mountPreview(mounted = ""): HTMLIFrameElement {
const iframe = document.createElement("iframe");
@@ -61,19 +77,7 @@ function mountPicker(
}
root = createRoot(document.createElement("div"));
act(() => root?.render(React.createElement(Harness)));
- act(() => {
- window.dispatchEvent(
- new MessageEvent("message", {
- source: iframe.contentWindow,
- data: {
- source: "hf-preview",
- type: "element-picked",
- elementInfo: { selector, tagName: "h1" },
- ...runtimeProtocolMetadata(30),
- },
- }),
- );
- });
+ picked(iframe.contentWindow, selector);
const picker = () => api as ReturnType<typeof useElementPicker>;
return {
picker,
@@ -170,3 +174,48 @@ describe("an edit to a picked element without an id", () => {
expect(synced).toEqual([]);
});
});
+
+describe("a pick across a reload that swaps the preview frame", () => {
+ function mountSwapping() {
+ const live = mountPreview();
+ const ref: { current: HTMLIFrameElement | null } = { current: live };
+ let api: ReturnType<typeof useElementPicker> | null = null;
+ function Harness() {
+ api = useElementPicker(ref);
+ return null;
+ }
+ root = createRoot(document.createElement("div"));
+ act(() => root?.render(React.createElement(Harness)));
+ return { live, ref, picker: () => api as ReturnType<typeof useElementPicker> };
+ }
+
+ it("keeps a pick posted by the frame it was made in after a new frame took its place", () => {
+ const { live, ref, picker } = mountSwapping();
+ picked(live.contentWindow, "h1");
+ act(() => picker().clearPick());
+ // The reload promotes its frame before the old frame's pick message is handled.
+ const old = live.contentWindow;
+ ref.current = mountPreview();
+ live.remove();
+ picked(old, "h1.next");
+ expect(picker().pickedElement?.selector).toBe("h1.next");
+ });
+
+ it("does not keep trusting a zoomed frame once the zoom is gone", () => {
+ const { picker } = mountSwapping();
+ const zoom = mountPreview();
+ act(() => picker().setActiveIframe(zoom));
+ picked(zoom.contentWindow, "h1");
+ expect(picker().pickedElement?.selector).toBe("h1");
+ act(() => picker().setActiveIframe(null));
+ picked(zoom.contentWindow, "h1.late");
+ expect(picker().pickedElement?.selector).toBe("h1");
+ });
+
+ it("still ignores a frame it never showed", () => {
+ const { picker } = mountSwapping();
+ const stranger = mountPreview();
+ picked(stranger.contentWindow, "h1");
+ expect(picker().pickedElement).toBeNull();
+ });
+});
diff --git a/packages/studio/src/hooks/useElementPicker.ts b/packages/studio/src/hooks/useElementPicker.ts
index bfc33d4726..f4ccfaa557 100644
--- a/packages/studio/src/hooks/useElementPicker.ts
+++ b/packages/studio/src/hooks/useElementPicker.ts
@@ -97,6 +97,8 @@ export function useElementPicker(
setPickedElement(null);
}, []);
+ const windowsThatWerePrimary = useRef(new WeakSet<MessageEventSource>());
+
// Listen for picker messages from the iframe
useMountEffect(() => {
// One guard per message field, then one branch per message type.
@@ -105,10 +107,16 @@ export function useElementPicker(
const data = e.data;
if (data?.source !== "hf-preview") return;
if (!acceptStudioRuntimeMessage(data)) return;
- // Accept events from either the primary iframe or the active override
+ // The primary frame, the active override, or a primary frame a reload just swapped out.
const activeIframe = getActiveIframe();
if (!activeIframe) return;
- if (e.source !== activeIframe.contentWindow && e.source !== iframeRef.current?.contentWindow)
+ if (!e.source) return;
+ if (e.source === iframeRef.current?.contentWindow)
+ windowsThatWerePrimary.current.add(e.source);
+ else if (
+ e.source !== activeIframe.contentWindow &&
+ !windowsThatWerePrimary.current.has(e.source)
+ )
return;
if (data.type === "element-picked" && data.elementInfo) {