Skip to content

Commit bd279db

Browse files
committed
fix(player): queue every player event behind the update that raised it
1 parent 47e8f4e commit bd279db

2 files changed

Lines changed: 35 additions & 13 deletions

File tree

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2336,6 +2336,22 @@ describe("HyperframesPlayer runtime ready handshake", () => {
23362336
]);
23372337
});
23382338

2339+
it("keeps ready ahead of the events it causes on an opaque-origin timeline", () => {
2340+
Object.defineProperty(player.iframe, "contentDocument", {
2341+
configurable: true,
2342+
get: () => null,
2343+
});
2344+
player.setAttribute("autoplay", "");
2345+
const seen: string[] = [];
2346+
for (const type of ["ready", "assetsready", "play"]) {
2347+
player.addEventListener(type, () => seen.push(type));
2348+
}
2349+
2350+
player._onMessage(timelineMessage(120));
2351+
2352+
expect(seen).toEqual(["ready", "assetsready", "play"]);
2353+
});
2354+
23392355
it("fires the probe path's resize only once ready is set", () => {
23402356
const seen: string[] = [];
23412357
player.addEventListener("resize", () => seen.push(`resize ready=${player.ready}`));

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

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ class HyperframesPlayer extends HTMLElement {
157157
this.shaderLoader = new ShaderLoaderState(loaderElements);
158158

159159
this._media = new ParentMediaManager({
160-
dispatchEvent: (e) => this.dispatchEvent(e),
160+
dispatchEvent: (e) => this._emit(e),
161161
getMuted: () => this.muted,
162162
getVolume: () => this._volume,
163163
getPlaybackRate: () => this.playbackRate,
@@ -169,7 +169,7 @@ class HyperframesPlayer extends HTMLElement {
169169
onTimeUpdate: (currentTime, duration) => {
170170
this._currentTime = currentTime;
171171
this.controlsApi?.updateTime(currentTime, duration);
172-
this.dispatchEvent(new CustomEvent("timeupdate", { detail: { currentTime } }));
172+
this._emit(new CustomEvent("timeupdate", { detail: { currentTime } }));
173173
},
174174
getLoop: () => this.loop,
175175
restart: () => {
@@ -180,14 +180,14 @@ class HyperframesPlayer extends HTMLElement {
180180
if (this._media.audioOwner === "parent") this._media.pauseAll();
181181
this._paused = true;
182182
this.controlsApi?.updatePlaying(false);
183-
this.dispatchEvent(new Event("ended"));
183+
this._emit(new Event("ended"));
184184
},
185185
onEnded: () => this.loop,
186186
});
187187

188188
this.probe = new CompositionProbe(this.iframe, {
189189
onReady: (result) => this._onProbeReady(result),
190-
onError: (message) => this.dispatchEvent(new CustomEvent("error", { detail: { message } })),
190+
onError: (message) => this._emit(new CustomEvent("error", { detail: { message } })),
191191
});
192192

193193
this.addEventListener("click", (event) => {
@@ -294,7 +294,7 @@ class HyperframesPlayer extends HTMLElement {
294294
this._sendControl("set-playback-rate", { playbackRate: rate });
295295
this._directTimelineAdapter?.timeScale?.(rate);
296296
this.controlsApi?.updateSpeed(rate);
297-
this.dispatchEvent(new Event("ratechange"));
297+
this._emit(new Event("ratechange"));
298298
break;
299299
}
300300
case "muted":
@@ -309,7 +309,7 @@ class HyperframesPlayer extends HTMLElement {
309309
this._media.updateVolume(v);
310310
this._sendControl("set-volume", { volume: v });
311311
this.controlsApi?.updateVolume(v);
312-
this.dispatchEvent(new Event("volumechange"));
312+
this._emit(new Event("volumechange"));
313313
break;
314314
}
315315
case "audio-src":
@@ -398,7 +398,7 @@ class HyperframesPlayer extends HTMLElement {
398398
}
399399
if (this._media.audioOwner === "parent") this._media.playAll();
400400
this.controlsApi?.updatePlaying(true);
401-
if (!queuedForReady) this.dispatchEvent(new Event("play"));
401+
if (!queuedForReady) this._emit(new Event("play"));
402402
if (directTimelineStarted && this._directTimelineAdapter) {
403403
this._directTimelineClock.start(
404404
this._directTimelineAdapter,
@@ -420,7 +420,7 @@ class HyperframesPlayer extends HTMLElement {
420420
if (this._media.audioOwner === "parent") this._media.pauseAll();
421421
this._paused = true;
422422
this.controlsApi?.updatePlaying(false);
423-
this.dispatchEvent(new Event("pause"));
423+
this._emit(new Event("pause"));
424424
}
425425

426426
stopMedia() {
@@ -631,7 +631,7 @@ class HyperframesPlayer extends HTMLElement {
631631
this._setIframeMediaMuted(val !== null);
632632
this._sendControl("set-muted", { muted: val !== null });
633633
this.controlsApi?.updateMuted(val !== null);
634-
this.dispatchEvent(new Event("volumechange"));
634+
this._emit(new Event("volumechange"));
635635
}
636636

637637
/**
@@ -768,7 +768,7 @@ class HyperframesPlayer extends HTMLElement {
768768
private _resolveRuntimeDataDelivery(channel: unknown, requestId: unknown): void {
769769
const pending = this._takeRuntimeDataDelivery(channel, requestId);
770770
if (!pending) return;
771-
this.dispatchEvent(
771+
this._emit(
772772
new CustomEvent("runtimedataapplied", {
773773
detail: { channel, requestId: pending.requestId },
774774
}),
@@ -778,7 +778,7 @@ class HyperframesPlayer extends HTMLElement {
778778
private _rejectRuntimeDataDelivery(channel: unknown, requestId: unknown, message: unknown): void {
779779
const pending = this._takeRuntimeDataDelivery(channel, requestId);
780780
if (!pending) return;
781-
this.dispatchEvent(
781+
this._emit(
782782
new CustomEvent("runtimedataerror", {
783783
detail: {
784784
channel,
@@ -1126,11 +1126,11 @@ class HyperframesPlayer extends HTMLElement {
11261126
this._assetsReady = true;
11271127
this.removeAttribute(ASSETS_LOADING_ATTR);
11281128
this.shaderLoader.hideAssetsLoading();
1129-
this.dispatchEvent(new Event("assetsready"));
1129+
this._emit(new Event("assetsready"));
11301130
this.shaderLoader.whenHidden(() => {
11311131
if (generation !== this._assetsGeneration) return;
11321132
this._painted = true;
1133-
this.dispatchEvent(new Event("painted"));
1133+
this._emit(new Event("painted"));
11341134
});
11351135
if (this._pendingPlay) this.play();
11361136
}
@@ -1192,6 +1192,11 @@ class HyperframesPlayer extends HTMLElement {
11921192
/** Runs one update (a runtime message, a probe result), then fires the events it raised,
11931193
* so every listener sees the whole update applied. */
11941194
private _applyThenEmit(apply: () => void): void {
1195+
// A nested update joins the outer one's queue.
1196+
if (this._queuedEvents) {
1197+
apply();
1198+
return;
1199+
}
11951200
const queue: Event[] = [];
11961201
this._queuedEvents = queue;
11971202
try {
@@ -1202,6 +1207,7 @@ class HyperframesPlayer extends HTMLElement {
12021207
}
12031208
}
12041209

1210+
/** Every event the player raises goes through here, so an update's events keep their order. */
12051211
private _emit(event: Event): void {
12061212
if (this._queuedEvents) this._queuedEvents.push(event);
12071213
else this.dispatchEvent(event);

0 commit comments

Comments
 (0)