Skip to content

Commit 0985b45

Browse files
perf(studio): let a paused preview check in once a second instead of every 80 ms (#4512)
* perf(studio): let a paused preview check in once a second instead of every 80 ms * fix(studio): settle a loaded preview on the next frame, not the next runtime post * fix(studio): stop waiting for a preview load when the player unmounts * fix(studio): stop waiting for a preview load when the player resets * refactor(studio): keep the load retry within the file's comment share
1 parent 416d009 commit 0985b45

5 files changed

Lines changed: 75 additions & 21 deletions

File tree

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,11 @@ describe("preview errors", () => {
127127
root = null;
128128
});
129129

130+
it("puts the preview on the player's once-a-second paused heartbeat", async () => {
131+
const { player } = await mountPlayer();
132+
expect(player.hasAttribute("low-power-idle")).toBe(true);
133+
});
134+
130135
it("attaches lifecycle listeners before navigating the player", async () => {
131136
await mountPlayer();
132137
const srcIndex = lifecycleLog.indexOf("src");

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -317,6 +317,7 @@ export const Player = forwardRef<HTMLIFrameElement, PlayerProps>(
317317

318318
player.setAttribute("shader-capture-scale", "1");
319319
player.setAttribute("shader-loading", "player");
320+
player.setAttribute("low-power-idle", "");
320321
player.setAttribute("width", String(portrait ? 1080 : 1920));
321322
player.setAttribute("height", String(portrait ? 1920 : 1080));
322323
player.style.width = "100%";

‎packages/studio/src/player/hooks/useTimelinePlayer.play.test.ts‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,42 @@ it.each([30, 0])(
9595
},
9696
);
9797

98+
it("settles a load whose runtime learns its duration after its only readiness post", async () => {
99+
const { api, root } = renderTimelinePlayerHarness();
100+
let duration = 0;
101+
const { adapter, win } = makeAdapterWindow();
102+
adapter.getDuration = () => duration;
103+
act(() => {
104+
api.iframeRef.current = makeFakeIframe(win);
105+
api.onIframeLoad();
106+
});
107+
postFromRuntime(win, { type: "state" });
108+
expect(adapter.pause).not.toHaveBeenCalled();
109+
110+
// No further post comes: a paused low-power preview checks in only once a second.
111+
duration = 30;
112+
await act(() => new Promise((resolve) => requestAnimationFrame(() => resolve(undefined))));
113+
expect(adapter.pause).toHaveBeenCalled();
114+
act(() => root.unmount());
115+
});
116+
117+
it.each(["unmounts", "resets"])("stops retrying a pending load once the player %s", async (how) => {
118+
const { api, root } = renderTimelinePlayerHarness();
119+
const { adapter, win } = makeAdapterWindow();
120+
let lookups = 0;
121+
adapter.getDuration = () => (lookups++, 0);
122+
act(() => {
123+
api.iframeRef.current = makeFakeIframe(win);
124+
api.onIframeLoad();
125+
});
126+
postFromRuntime(win, { type: "state" });
127+
act(() => (how === "resets" ? api.resetPlayer() : root.unmount()));
128+
const atStop = lookups;
129+
await new Promise((resolve) => requestAnimationFrame(() => requestAnimationFrame(resolve)));
130+
expect(lookups).toBe(atStop);
131+
if (how === "resets") act(() => root.unmount());
132+
});
133+
98134
it("does not let the blank page's load step enable Play for the preview that replaces it", async () => {
99135
const { api, root } = renderTimelinePlayerHarness();
100136
// The iframe's first load is about:blank, before the runtime exists; its load step waits for runtime messages.

‎packages/studio/src/player/hooks/useTimelinePlayer.ts‎

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -362,21 +362,25 @@ export function useTimelinePlayer({
362362
seek,
363363
});
364364

365-
const { processTimelineMessageRef, enrichMissingCompositionsRef, onIframeLoad } =
366-
useTimelineSyncCallbacks({
367-
iframeRef,
368-
probeIntervalRef,
369-
pendingSeekRef,
370-
isRefreshingRef,
371-
getAdapter,
372-
syncTimelineElements,
373-
setDuration,
374-
setCurrentTime,
375-
requestTimelineReady,
376-
setIsPlaying,
377-
attachIframeShortcutListeners,
378-
applyPreviewAudioState,
379-
});
365+
const {
366+
processTimelineMessageRef,
367+
enrichMissingCompositionsRef,
368+
onIframeLoad,
369+
cancelPendingLoad,
370+
} = useTimelineSyncCallbacks({
371+
iframeRef,
372+
probeIntervalRef,
373+
pendingSeekRef,
374+
isRefreshingRef,
375+
getAdapter,
376+
syncTimelineElements,
377+
setDuration,
378+
setCurrentTime,
379+
requestTimelineReady,
380+
setIsPlaying,
381+
attachIframeShortcutListeners,
382+
applyPreviewAudioState,
383+
});
380384

381385
// Full-reload edits load behind a hidden shadow iframe (useShadowPreviewReload.ts).
382386
const {
@@ -494,16 +498,16 @@ export function useTimelinePlayer({
494498
stopReverseLoop();
495499
stopScrubPreviewAudio();
496500
releaseStaticSeekCache(staticSeekAdapterRef, staticSeekWarnedRef);
497-
if (probeIntervalRef.current) clearInterval(probeIntervalRef.current);
501+
cancelPendingLoad();
498502
};
499503
});
500504

501505
const resetPlayer = useCallback(() => {
502506
stopRAFLoop();
503507
stopReverseLoop();
504-
if (probeIntervalRef.current) clearInterval(probeIntervalRef.current);
508+
cancelPendingLoad();
505509
usePlayerStore.getState().reset();
506-
}, [stopRAFLoop, stopReverseLoop]);
510+
}, [stopRAFLoop, stopReverseLoop, cancelPendingLoad]);
507511

508512
useEffect(() => {
509513
return usePlayerStore.subscribe((state, prev) => {

‎packages/studio/src/player/hooks/useTimelineSyncCallbacks.ts‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -309,28 +309,36 @@ export function useTimelineSyncCallbacks({
309309
// Listen for those instead of polling.
310310
const iframe = iframeRef.current;
311311
let settled = false;
312+
let retryFrame = 0;
313+
const stopWaiting = () => {
314+
window.removeEventListener("message", onMessage);
315+
cancelAnimationFrame(retryFrame);
316+
};
312317

313318
const trySettle = () => {
314319
if (settled) return;
315320
if (initializeAdapter(context)) {
316321
settled = true;
317-
window.removeEventListener("message", onMessage);
322+
stopWaiting();
318323
if (probeIntervalRef.current) clearInterval(probeIntervalRef.current);
324+
return;
319325
}
326+
cancelAnimationFrame(retryFrame);
327+
retryFrame = requestAnimationFrame(trySettle);
320328
};
321329

322330
const onMessage = (e: MessageEvent) => {
323331
if (isPreviewReadinessMessage(e, iframe)) trySettle();
324332
};
325333
window.addEventListener("message", onMessage);
326-
stopWaitingRef.current = () => window.removeEventListener("message", onMessage);
334+
stopWaitingRef.current = stopWaiting;
327335

328336
// Safety net: if no message arrives within 5s, try one last time then give up.
329337
probeIntervalRef.current = setTimeout(() => {
330338
if (!settled) {
331339
trySettle();
332340
}
333-
window.removeEventListener("message", onMessage);
341+
stopWaiting();
334342
if (!settled) onLoadGiveUp?.(context);
335343
revealIframe(iframeRef.current);
336344
}, 5000) as unknown as ReturnType<typeof setInterval>;

0 commit comments

Comments
 (0)