Skip to content

Commit b483d05

Browse files
committed
fix(player): decide autoplay after ready listeners run, and restart a loop at time 0
1 parent bd279db commit b483d05

3 files changed

Lines changed: 81 additions & 7 deletions

File tree

‎packages/player/src/hyperframes-player.test.ts‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1404,6 +1404,7 @@ describe("HyperframesPlayer loop end-state handling", () => {
14041404
expect(seek).toHaveBeenCalledWith(0);
14051405
expect(play).toHaveBeenCalled();
14061406
expect(player._paused).toBe(false);
1407+
expect(player._currentTime).toBe(0);
14071408
});
14081409

14091410
it("fires ended and stays paused when a non-looping composition posts its final paused state", () => {
@@ -2352,6 +2353,59 @@ describe("HyperframesPlayer runtime ready handshake", () => {
23522353
expect(seen).toEqual(["ready", "assetsready", "play"]);
23532354
});
23542355

2356+
it("fires an event a ready listener raises after the rest of the update", () => {
2357+
Object.defineProperty(player.iframe, "contentDocument", {
2358+
configurable: true,
2359+
get: () => null,
2360+
});
2361+
player.setAttribute("autoplay", "");
2362+
const seen: string[] = [];
2363+
for (const type of ["ready", "assetsready", "play", "pause"]) {
2364+
player.addEventListener(type, () => seen.push(type));
2365+
}
2366+
player.addEventListener("ready", () => (player as unknown as { pause: () => void }).pause(), {
2367+
once: true,
2368+
});
2369+
2370+
player._onMessage(timelineMessage(120));
2371+
2372+
// Autoplay is decided after `ready`'s listeners, as it was before events were queued.
2373+
expect(seen).toEqual(["ready", "assetsready", "pause", "play"]);
2374+
expect(player.paused).toBe(false);
2375+
});
2376+
2377+
it("keeps autoplay when a ready listener seeks", () => {
2378+
Object.defineProperty(player.iframe, "contentDocument", {
2379+
configurable: true,
2380+
get: () => null,
2381+
});
2382+
player.setAttribute("autoplay", "");
2383+
player.addEventListener(
2384+
"ready",
2385+
() => (player as unknown as { seek: (t: number) => void }).seek(1),
2386+
{
2387+
once: true,
2388+
},
2389+
);
2390+
2391+
player._onMessage(timelineMessage(120));
2392+
2393+
expect(player.paused).toBe(false);
2394+
expect(findControlCalls("play")).toHaveLength(1);
2395+
});
2396+
2397+
it("applies a message a listener delivers inside the update after the first one's events", () => {
2398+
const seen: string[] = [];
2399+
for (const type of ["ready", "durationchange", "scenes"]) {
2400+
player.addEventListener(type, () => seen.push(`${type} d=${player.duration}`));
2401+
}
2402+
player.addEventListener("ready", () => player._onMessage(timelineMessage(180)), { once: true });
2403+
2404+
player._onMessage(timelineMessage(120));
2405+
2406+
expect(seen).toEqual(["ready d=4", "scenes d=6", "durationchange d=6", "scenes d=6"]);
2407+
});
2408+
23552409
it("fires the probe path's resize only once ready is set", () => {
23562410
const seen: string[] = [];
23572411
player.addEventListener("resize", () => seen.push(`resize ready=${player.ready}`));

‎packages/player/src/hyperframes-player.ts‎

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ class HyperframesPlayer extends HTMLElement {
142142
private _runtimeData = new Map<string, unknown>();
143143
private _runtimeDataRequestId = 0;
144144
private _pendingRuntimeData = new Map<string, PendingRuntimeDataDelivery>();
145-
private _queuedEvents: Event[] | null = null;
145+
private _queuedEvents: Array<Event | (() => void)> | null = null;
146146

147147
constructor() {
148148
super();
@@ -1029,7 +1029,7 @@ class HyperframesPlayer extends HTMLElement {
10291029
this._replayBridgeState();
10301030
this._setIframeMediaMuted(this.muted);
10311031
this._waitForAssetsReady(doc, assetsReady);
1032-
if (this.hasAttribute("autoplay") || this._pendingPlay) this.play();
1032+
this._playWhenWanted();
10331033
}
10341034

10351035
private _onProbeReady(result: ProbeResult) {
@@ -1047,7 +1047,7 @@ class HyperframesPlayer extends HTMLElement {
10471047
if (doc) this._media.setupFromIframe(doc);
10481048
this._setIframeMediaMuted(this.muted);
10491049
this._waitForAssetsReady(doc);
1050-
if (this.hasAttribute("autoplay") || this._pendingPlay) this.play();
1050+
this._playWhenWanted();
10511051
}
10521052

10531053
/** Gates play() on composition readiness (media, compute, paint-and-idle),
@@ -1132,7 +1132,9 @@ class HyperframesPlayer extends HTMLElement {
11321132
this._painted = true;
11331133
this._emit(new Event("painted"));
11341134
});
1135-
if (this._pendingPlay) this.play();
1135+
this._afterEvents(() => {
1136+
if (this._pendingPlay) this.play();
1137+
});
11361138
}
11371139

11381140
/** Every host-driven navigation or teardown: the old document's handshake, asset wait and
@@ -1197,16 +1199,34 @@ class HyperframesPlayer extends HTMLElement {
11971199
apply();
11981200
return;
11991201
}
1200-
const queue: Event[] = [];
1202+
const queue: Array<Event | (() => void)> = [];
12011203
this._queuedEvents = queue;
12021204
try {
12031205
apply();
12041206
} finally {
1207+
// Still open while flushing: an event a listener raises goes behind the rest.
1208+
for (let i = 0; i < queue.length; i++) {
1209+
const item = queue[i]!;
1210+
if (item instanceof Event) this.dispatchEvent(item);
1211+
else item();
1212+
}
12051213
this._queuedEvents = null;
1206-
for (const event of queue) this.dispatchEvent(event);
12071214
}
12081215
}
12091216

1217+
/** Runs `action` once the current update's events have fired (at once outside an update). */
1218+
private _afterEvents(action: () => void): void {
1219+
if (this._queuedEvents) this._queuedEvents.push(action);
1220+
else action();
1221+
}
1222+
1223+
/** Autoplay, or a play() made before ready, decided after `ready`'s listeners had their turn. */
1224+
private _playWhenWanted(): void {
1225+
this._afterEvents(() => {
1226+
if (this.hasAttribute("autoplay") || this._pendingPlay) this.play();
1227+
});
1228+
}
1229+
12101230
/** Every event the player raises goes through here, so an update's events keep their order. */
12111231
private _emit(event: Event): void {
12121232
if (this._queuedEvents) this._queuedEvents.push(event);

‎packages/player/src/playback-state.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ export function applyRuntimeStateMessage(
5151
callbacks.play();
5252
// play() sets paused=false; reflect that in the returned state so the
5353
// caller's destructure doesn't overwrite it with the stale nextPaused value.
54-
return { ...current, currentTime, paused: false };
54+
return { ...current, currentTime: 0, paused: false };
5555
}
5656

5757
const next: PlaybackState = { ...current, currentTime, paused: nextPaused };

0 commit comments

Comments
 (0)