Skip to content

Commit d93b769

Browse files
fix(studio): a stalled font or asset no longer leaves the preview empty or drops reloads (#5370)
* fix(studio): a stalled font or asset no longer leaves the preview empty or drops reloads * fix(studio): a page's own late load no longer counts as replaced content * refactor(studio): one announcement owns when a preview page has loaded * fix(studio): let hosts with their own player announce a new preview page * fix(studio): a late ready from the replaced preview page no longer claims the new page * refactor(studio): keep the Player doc comment on Player
1 parent 063c2f8 commit d93b769

11 files changed

Lines changed: 135 additions & 17 deletions

File tree

‎packages/studio/src/components/editor/LayersPanel.test.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import type { DomEditLayerItem } from "./domEditingTypes";
99
import { createRafThrottle, LayersPanel, sortLayersByZIndex } from "./LayersPanel";
1010
import { isLayerDraggable } from "./useLayerDrag";
1111
import { liveTime } from "../../player";
12-
import { sceneSwapFor } from "../../player/sceneSwap";
12+
import { announcePreviewDocumentLoaded, sceneSwapFor } from "../../player/sceneSwap";
1313

1414
(globalThis as unknown as { IS_REACT_ACT_ENVIRONMENT: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
1515

@@ -284,12 +284,12 @@ describe("LayersPanel preview promotion", () => {
284284
mocks.collect.mockClear();
285285

286286
act(() => {
287-
a.dispatchEvent(new Event("load"));
287+
announcePreviewDocumentLoaded(a);
288288
});
289289
expect(mocks.collect).not.toHaveBeenCalled();
290290

291291
act(() => {
292-
b.dispatchEvent(new Event("load"));
292+
announcePreviewDocumentLoaded(b);
293293
});
294294
expect(collectedRootIds()).toEqual(["b"]);
295295
});
@@ -325,7 +325,7 @@ describe("LayersPanel preview promotion", () => {
325325
mocks.previewIframeRef.current = iframe;
326326
usePreviewIframeStore.setState({ iframe });
327327
act(() => root.render(createElement(LayersPanel)));
328-
act(() => void iframe.dispatchEvent(new Event("load")));
328+
act(() => void announcePreviewDocumentLoaded(iframe));
329329

330330
const rows = [...host.querySelectorAll("[data-layer-index]")];
331331
expect(rows).toHaveLength(2);

‎packages/studio/src/components/editor/LayersPanel.tsx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,8 @@ interface CollapsedState {
8989
[key: string]: boolean;
9090
}
9191

92-
/** Studio state the panel reads; passed by hosts outside Studio's providers. Keep previewIframeRef stable,
93-
* and bump refreshKey when the preview document is rebuilt without an iframe load. */
92+
/** Studio state the panel reads; passed by hosts outside Studio's providers. Keep previewIframeRef stable;
93+
* a host with its own player calls announcePreviewDocumentLoaded on each new page, or bumps refreshKey. */
9494
export type LayersPanelHost = Pick<
9595
StudioShellValue,
9696
"previewIframeRef" | "activeCompPath" | "showToast"

‎packages/studio/src/components/editor/TopologyLens.test.tsx‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import { createRoot, type Root } from "react-dom/client";
55
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
66
import { studioEditLifecycle, type StudioWriteResult } from "../../webmcp/writeCoordinator";
77
import { usePreviewIframeStore } from "../../player/store/previewIframeStore";
8+
import { announcePreviewDocumentLoaded } from "../../player/sceneSwap";
89
import { TopologyLens } from "./TopologyLens";
910

1011
(globalThis as unknown as { IS_REACT_ACT_ENVIRONMENT: boolean }).IS_REACT_ACT_ENVIRONMENT = true;
@@ -259,7 +260,7 @@ describe("TopologyLens", () => {
259260
mount();
260261
begin();
261262

262-
act(() => iframe?.dispatchEvent(new Event("load")));
263+
act(() => announcePreviewDocumentLoaded(iframe!));
263264
expect(host?.querySelector('[data-topology-lens="hidden"]')).not.toBeNull();
264265

265266
begin();
@@ -286,7 +287,7 @@ describe("TopologyLens", () => {
286287
root = null;
287288

288289
expect(vi.getTimerCount()).toBe(1);
289-
expect(removeListener).toHaveBeenCalledWith("load", expect.any(Function));
290+
expect(removeListener).toHaveBeenCalledWith("hf-preview-document-loaded", expect.any(Function));
290291
expect(studioEditLifecycle.getSnapshot()).toMatchObject({ phase: "dispatching" });
291292
act(() => vi.advanceTimersByTime(0));
292293
expect(vi.getTimerCount()).toBe(0);
@@ -312,10 +313,10 @@ describe("TopologyLens", () => {
312313
ref.current = b;
313314
usePreviewIframeStore.getState().setIframe(b);
314315
});
315-
act(() => a.dispatchEvent(new Event("load")));
316+
act(() => announcePreviewDocumentLoaded(a));
316317
expect(host.querySelector('[data-topology-lens="hidden"]')).toBeNull();
317318

318-
act(() => b.dispatchEvent(new Event("load")));
319+
act(() => announcePreviewDocumentLoaded(b));
319320
expect(host.querySelector('[data-topology-lens="hidden"]')).not.toBeNull();
320321
usePreviewIframeStore.setState({ iframe: null });
321322
});

‎packages/studio/src/hooks/useConsoleErrorCapture.test.tsx‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import React, { act } from "react";
44
import { createRoot, type Root } from "react-dom/client";
55
import { afterEach, expect, it } from "vitest";
66
import { STUDIO_PREVIEW_ERRORS } from "@hyperframes/core/studio-preview-mark";
7+
import { announcePreviewDocumentLoaded } from "../player/sceneSwap";
78
import { useConsoleErrorCapture } from "./useConsoleErrorCapture";
89

910
Object.assign(globalThis, { IS_REACT_ACT_ENVIRONMENT: true });
@@ -36,7 +37,7 @@ it("shows the errors a preview raised before its load, once each", async () => {
3637
root = createRoot(document.createElement("div"));
3738
await act(async () => root?.render(React.createElement(Harness, { iframe })));
3839
Object.assign(previewWindow, { [STUDIO_PREVIEW_ERRORS]: [raisedBeforeLoad] });
39-
await act(async () => iframe.dispatchEvent(new Event("load")));
40+
await act(async () => announcePreviewDocumentLoaded(iframe));
4041

4142
expect(shown()).toEqual([raisedBeforeLoad]);
4243
});
@@ -79,9 +80,27 @@ it("clears a document's errors when its load replaces it, and when the preview g
7980
previewWindow.dispatchEvent(new ErrorEvent("error", { message: "Uncaught Error: old" })),
8081
);
8182
Object.assign(previewWindow, { [STUDIO_PREVIEW_ERRORS]: ["Uncaught Error: new"] });
82-
await act(async () => iframe.dispatchEvent(new Event("load")));
83+
await act(async () => announcePreviewDocumentLoaded(iframe));
8384
expect(shown()).toEqual(["Uncaught Error: new"]);
8485

8586
await act(async () => root?.render(React.createElement(NullableHarness, { frame: null })));
8687
expect(capture.consoleErrors).toBeNull();
88+
await act(async () => announcePreviewDocumentLoaded(iframe));
89+
expect(capture.consoleErrors).toBeNull();
90+
});
91+
92+
it("keeps a page's errors through its own late load, and clears them for the next announced page", async () => {
93+
const { iframe, previewWindow } = previewFrame();
94+
root = createRoot(document.createElement("div"));
95+
await act(async () => root?.render(React.createElement(Harness, { iframe })));
96+
await act(async () =>
97+
previewWindow.dispatchEvent(new ErrorEvent("error", { message: "Uncaught Error: kept" })),
98+
);
99+
100+
await act(async () => iframe.dispatchEvent(new Event("load")));
101+
expect(shown()).toEqual(["Uncaught Error: kept"]);
102+
103+
Object.assign(previewWindow, { [STUDIO_PREVIEW_ERRORS]: ["Uncaught Error: new page"] });
104+
await act(async () => announcePreviewDocumentLoaded(iframe));
105+
expect(shown()).toEqual(["Uncaught Error: new page"]);
87106
});

‎packages/studio/src/hooks/useConsoleErrorCapture.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import { useCallback, useEffect, useRef, useState } from "react";
22
import { STUDIO_PREVIEW_ERRORS } from "@hyperframes/core/studio-preview-mark";
3+
import { onPreviewDocumentLoaded } from "../player/sceneSwap";
34
import type { LintFinding } from "../components/LintModal";
45

56
/**
@@ -73,9 +74,9 @@ export function useConsoleErrorCapture(previewIframe: HTMLIFrameElement | null)
7374
};
7475

7576
attachErrorCapture();
76-
previewIframe.addEventListener("load", attachErrorCapture);
77+
const stopLoaded = onPreviewDocumentLoaded(previewIframe, attachErrorCapture);
7778
return () => {
78-
previewIframe.removeEventListener("load", attachErrorCapture);
79+
stopLoaded();
7980
detachErrorCapture();
8081
};
8182
}, [previewIframe, resetErrors]);

‎packages/studio/src/index.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,7 @@ export type { UseClipboardOptions } from "./hooks/useClipboard";
202202
export { useDomEditSession } from "./hooks/useDomEditSession";
203203
export type { UseDomEditSessionParams } from "./hooks/useDomEditSession";
204204
export { useLivePreviewIframe } from "./hooks/useLivePreviewIframe";
205+
export { announcePreviewDocumentLoaded } from "./player/sceneSwap";
205206
export type { PreviewPromotion } from "./player/sceneSwap";
206207
export { usePreviewPersistence } from "./hooks/usePreviewPersistence";
207208
export type { UsePreviewPersistenceParams } from "./hooks/usePreviewPersistence";

‎packages/studio/src/player/components/Player.test.ts‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import {
1010
shouldShowCompositionLoadingOverlay,
1111
} from "./Player";
1212
import { usePlayerStore } from "../store/playerStore";
13+
import { onPreviewDocumentLoaded } from "../sceneSwap";
1314

1415
vi.mock("@hyperframes/player", () => ({}));
1516

@@ -196,6 +197,49 @@ describe("callbacks after the player is already mounted", () => {
196197
expect(first).not.toHaveBeenCalled();
197198
});
198199

200+
it("loads the preview on the runtime's ready while a stalled font holds the window's load", async () => {
201+
const onLoad = vi.fn();
202+
const { player } = await mountPlayer({ onLoad });
203+
const iframe = (player as TestHyperframesPlayer).iframeElement;
204+
let page = {};
205+
Object.defineProperty(iframe, "contentDocument", { get: () => page });
206+
Object.defineProperty(iframe, "contentWindow", { get: () => ({ __playerReady: true }) });
207+
const announced = vi.fn();
208+
onPreviewDocumentLoaded(iframe, announced);
209+
210+
act(() => void player.dispatchEvent(new Event("ready")));
211+
expect(onLoad).toHaveBeenCalledTimes(1);
212+
213+
act(() => void iframe.dispatchEvent(new Event("load")));
214+
act(() => void player.dispatchEvent(new Event("ready")));
215+
expect(onLoad).toHaveBeenCalledTimes(1);
216+
217+
page = {};
218+
act(() => void player.dispatchEvent(new Event("ready")));
219+
expect(onLoad).toHaveBeenCalledTimes(2);
220+
expect(announced).toHaveBeenCalledTimes(2);
221+
});
222+
223+
it("leaves a ready that arrives before the page's runtime boots to the page's own load", async () => {
224+
const onLoad = vi.fn();
225+
const { player } = await mountPlayer({ onLoad });
226+
const iframe = (player as TestHyperframesPlayer).iframeElement;
227+
const page = {};
228+
let runtime: { __playerReady?: boolean } = {};
229+
Object.defineProperty(iframe, "contentDocument", { get: () => page });
230+
Object.defineProperty(iframe, "contentWindow", { get: () => runtime });
231+
232+
act(() => void player.dispatchEvent(new Event("ready")));
233+
expect(onLoad).not.toHaveBeenCalled();
234+
235+
act(() => void iframe.dispatchEvent(new Event("load")));
236+
expect(onLoad).toHaveBeenCalledTimes(1);
237+
238+
runtime = { __playerReady: true };
239+
act(() => void player.dispatchEvent(new Event("ready")));
240+
expect(onLoad).toHaveBeenCalledTimes(1);
241+
});
242+
199243
it("reports the preview error cause", async () => {
200244
const onPreviewError = vi.fn();
201245
const { player } = await mountPlayer({ onPreviewError });

‎packages/studio/src/player/components/Player.tsx‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ import { useMountEffect } from "../../hooks/useMountEffect";
55
import { applyPreviewVariablesToUrl } from "../../hooks/previewVariablesStore";
66
import { HyperframesLoader } from "../../components/ui";
77
import { usePlayerStore } from "../store/playerStore";
8+
import { announcePreviewDocumentLoaded } from "../sceneSwap";
9+
import type { IframeWindow } from "../lib/playbackTypes";
810
// Importing "@hyperframes/player" registers a class extending HTMLElement at
911
// module load, which throws under SSR, hence the dynamic import behind a
1012
// `typeof window` guard. Kicking it here rather than in the mount effect puts
@@ -128,6 +130,9 @@ export function hasUnloadedAssets(iframe: HTMLIFrameElement, lastResult: boolean
128130
}
129131
}
130132

133+
const runtimeBootedIn = (iframe: HTMLIFrameElement) =>
134+
(iframe.contentWindow as IframeWindow | null)?.__playerReady === true;
135+
131136
/**
132137
* Renders a composition preview using the <hyperframes-player> web component.
133138
*
@@ -228,9 +233,11 @@ export const Player = forwardRef<HTMLIFrameElement, PlayerProps>(
228233
const loading = getShaderTransitionLoading(event);
229234
if (loading !== null) setShaderTransitionLoading(loading);
230235
};
236+
let loadedDocument: Document | null = null;
231237
const handleReady = () => {
232238
setPreviewError(null);
233239
setCompositionLoading(false);
240+
if (iframe.contentDocument && runtimeBootedIn(iframe)) handleLoad();
234241
};
235242
const handlePainted = () => {
236243
setPainted(true);
@@ -243,6 +250,9 @@ export const Player = forwardRef<HTMLIFrameElement, PlayerProps>(
243250
setCompositionLoading(false);
244251
};
245252
const handleLoad = () => {
253+
const doc = iframe.contentDocument;
254+
if (doc && doc === loadedDocument) return;
255+
loadedDocument = doc;
246256
loadCountRef.current++;
247257
setLoaded(true);
248258
setPreviewError(null);
@@ -258,6 +268,7 @@ export const Player = forwardRef<HTMLIFrameElement, PlayerProps>(
258268
container.addEventListener("animationend", onEnd, { once: true });
259269
}
260270
onLoadRef.current();
271+
announcePreviewDocumentLoaded(iframe);
261272

262273
// Show a loading overlay until every `<video>`/`<audio>` and Lottie
263274
// asset is ready. Without this users can click play before audio has

‎packages/studio/src/player/lib/playbackTypes.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ export interface ClipManifest {
5959

6060
export type IframeWindow = Window & {
6161
__player?: RuntimePlaybackAdapter;
62+
__playerReady?: boolean;
6263
__timeline?: TimelineLike;
6364
__timelines?: Record<string, TimelineLike>;
6465
__clipManifest?: ClipManifest;

‎packages/studio/src/player/sceneSwap.test.ts‎

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
// @vitest-environment happy-dom
22
import { afterEach, describe, expect, it, vi } from "vitest";
3-
import { SCENE_SWAP_MS, sceneSwapFor } from "./sceneSwap";
3+
import {
4+
SCENE_SWAP_MS,
5+
announcePreviewDocumentLoaded,
6+
onPreviewContentReplaced,
7+
sceneSwapFor,
8+
} from "./sceneSwap";
49

510
afterEach(() => {
611
vi.useRealTimers();
@@ -93,3 +98,24 @@ describe("sceneSwapFor", () => {
9398
expect(swap).toHaveBeenCalledWith("<html></html>", expect.anything());
9499
});
95100
});
101+
102+
describe("onPreviewContentReplaced", () => {
103+
it("reports Player's document-loaded announcement and a scene swap, never a raw load", () => {
104+
const iframe = document.createElement("iframe");
105+
const replaced = vi.fn();
106+
const stop = onPreviewContentReplaced(iframe, replaced);
107+
108+
iframe.dispatchEvent(new Event("load"));
109+
expect(replaced).not.toHaveBeenCalled();
110+
111+
announcePreviewDocumentLoaded(iframe);
112+
expect(replaced).toHaveBeenCalledTimes(1);
113+
114+
iframe.dispatchEvent(new Event("hf-scenes-swapped"));
115+
expect(replaced).toHaveBeenCalledTimes(2);
116+
117+
stop();
118+
announcePreviewDocumentLoaded(iframe);
119+
expect(replaced).toHaveBeenCalledTimes(2);
120+
});
121+
});

0 commit comments

Comments
 (0)