🎥 Make videos programmatically with React
fix(media): report terminal preview seek errors through onError
Alec Watts5636ffb67fa8
diff --git a/packages/media/src/audio/audio-for-preview.tsx b/packages/media/src/audio/audio-for-preview.tsxindex 35dd62bb27..c3a8e5032b 100644--- a/packages/media/src/audio/audio-for-preview.tsx+++ b/packages/media/src/audio/audio-for-preview.tsx@@ -142,6 +142,10 @@ const AudioForPreviewAssertedShowing: React.FC<NewAudioForPreviewProps> = ({const initialVolume = useRef(userPreferredVolume);const initialDurationInFrames = useRef(videoConfig.durationInFrames);const initialSequenceOffset = useRef(sequenceOffset);+ const onErrorRef = useRef(onError);+ onErrorRef.current = onError;+ const disallowFallbackRef = useRef(disallowFallbackToHtml5Audio);+ disallowFallbackRef.current = disallowFallbackToHtml5Audio;useCommonEffects({mediaPlayerRef,@@ -217,6 +221,18 @@ const AudioForPreviewAssertedShowing: React.FC<NewAudioForPreviewProps> = ({tagType: 'audio',getEffects: () => [],getEffectChainState: () => null,+ onError: (error) => {+ const [action] = callOnErrorAndResolve({+ onError: onErrorRef.current,+ error,+ disallowFallback: disallowFallbackRef.current,+ isClientSideRendering: false,+ clientSideError: error,+ });+ if (action === 'fallback') {+ setShouldFallbackToNativeAudio(true);+ }+ },});mediaPlayerRef.current = player;diff --git a/packages/media/src/media-player.ts b/packages/media/src/media-player.tsindex 615e2560bb..14e4e4e94e 100644--- a/packages/media/src/media-player.ts+++ b/packages/media/src/media-player.ts@@ -88,6 +88,8 @@ export class MediaPlayer {private premountAwareDelayPlayback: PremountAwareDelayPlayback;private seekPromiseChain: Promise<unknown> = Promise.resolve();+ private terminalError: Error | null = null;+ private onError: ((error: Error) => void) | null;constructor({canvas,@@ -115,6 +117,7 @@ export class MediaPlayer {tagType,getEffects,getEffectChainState,+ onError,}: {canvas: HTMLCanvasElement | OffscreenCanvas | null;src: string;@@ -144,6 +147,7 @@ export class MediaPlayer {width: number,height: number,) => EffectChainState | null;+ onError: ((error: Error) => void) | null;}) {this.canvas = canvas ?? null;this.src = src;@@ -183,6 +187,7 @@ export class MediaPlayer {this.tagType = tagType;this.getEffects = getEffects;this.getEffectChainState = getEffectChainState;+ this.onError = onError;if (canvas) {const context = canvas.getContext('2d', {@@ -212,6 +217,16 @@ export class MediaPlayer {return this.disposed || this.input.disposed === true;}+ private reportTerminalError(error: Error): void {+ if (this.terminalError) {+ return;+ }++ this.terminalError = error;+ this.playing = false;+ this.onError?.(error);+ }+public initialize(startTimeUnresolved: number,initialMuted: boolean,@@ -483,6 +498,10 @@ export class MediaPlayer {};public async seekTo(time: number): Promise<void> {+ if (this.terminalError || this.isDisposalError()) {+ return;+ }+const newTime = this.getTrimmedTime(time);if (newTime === null) {@@ -497,7 +516,7 @@ export class MediaPlayer {unloopedNewTime: number,nonce: Nonce,): Promise<void> {- if (nonce.isStale()) {+ if (nonce.isStale() || this.terminalError || this.isDisposalError()) {return;}@@ -530,16 +549,16 @@ export class MediaPlayer {}),]);} catch (error) {- if (this.isDisposalError()) {+ if (this.isDisposalError() || nonce.isStale()) {return;}- throw error;+ this.reportTerminalError(error as Error);}}public play(): void {- if (this.playing) {+ if (this.playing || this.terminalError) {return;}diff --git a/packages/media/src/test/media-player.test.ts b/packages/media/src/test/media-player.test.tsindex ff494bf1c8..0a1494feec 100644--- a/packages/media/src/test/media-player.test.ts+++ b/packages/media/src/test/media-player.test.ts@@ -34,7 +34,8 @@ const makeSharedAudioContext = (): SharedAudioContextForMediaPlayer => {};const makeAudioPlayer = (- sharedAudioContext: SharedAudioContextForMediaPlayer,+ sharedAudioContext: SharedAudioContextForMediaPlayer | null,+ onError: ((error: Error) => void) | null = null,) => {return new MediaPlayer({canvas: null,@@ -62,6 +63,7 @@ const makeAudioPlayer = (tagType: 'audio',getEffects: () => [],getEffectChainState: () => null,+ onError,});};@@ -165,6 +167,7 @@ test('dispose should immediately unblock playback delays', async () => {tagType: 'video',getEffects: () => [],getEffectChainState: () => null,+ onError: null,});await player.initialize(0, false, 1);@@ -185,3 +188,81 @@ test('dispose should immediately unblock playback delays', async () => {await seekPromise.catch(() => {});});++test.each(['video', 'audio'] as const)(+ 'reports a required %s seek failure once and stops playback and seeking',+ async (tagType) => {+ const onError = vi.fn();+ const player = makeAudioPlayer(null, onError);+ const error = new TypeError('Failed to fetch');+ const seek = vi.fn(() => Promise.reject(error));+ player[`${tagType}IteratorManager`] = {seek} as never;+ player.play();++ await player.seekTo(1);+ player.play();+ await player.seekTo(2);++ expect(onError).toHaveBeenCalledOnce();+ expect(onError).toHaveBeenCalledWith(error);+ expect(seek).toHaveBeenCalledOnce();+ // Inspect playback state without exposing a new public API for this test.+ // eslint-disable-next-line dot-notation+ expect(player['playing']).toBe(false);+ player[`${tagType}IteratorManager`] = null;+ await player.dispose();+ },+);++test('ignores a stale seek failure and allows the newer seek', async () => {+ const onError = vi.fn();+ const player = makeAudioPlayer(null, onError);+ let rejectSeek!: (error: Error) => void;+ const seek = vi+ .fn()+ .mockImplementationOnce(+ () =>+ new Promise<void>((_, reject) => {+ rejectSeek = reject;+ }),+ )+ .mockResolvedValue(undefined);+ player.videoIteratorManager = {seek} as never;++ const first = player.seekTo(1);+ await vi.waitFor(() => expect(seek).toHaveBeenCalledOnce());+ const second = player.seekTo(2);+ rejectSeek(new TypeError('Failed to fetch'));+ await Promise.all([first, second]);++ expect(onError).not.toHaveBeenCalled();+ expect(seek).toHaveBeenCalledTimes(2);+ player.videoIteratorManager = null;+ await player.dispose();+});++test('ignores pending seek failures after disposal and skips new seeks', async () => {+ const onError = vi.fn();+ const player = makeAudioPlayer(null, onError);+ let rejectSeek!: (error: Error) => void;+ const seek = vi.fn(+ () =>+ new Promise<void>((_, reject) => {+ rejectSeek = reject;+ }),+ );+ player.videoIteratorManager = {seek} as never;++ const pending = player.seekTo(1);+ await vi.waitFor(() => expect(seek).toHaveBeenCalledOnce());+ player.videoIteratorManager = null;+ await player.dispose();+ rejectSeek(new TypeError('Failed to fetch'));+ await pending;+ player.videoIteratorManager = {seek} as never;+ await player.seekTo(2);++ expect(onError).not.toHaveBeenCalled();+ expect(seek).toHaveBeenCalledOnce();+ player.videoIteratorManager = null;+});diff --git a/packages/media/src/test/premount-arm-kicks-scheduler.test.ts b/packages/media/src/test/premount-arm-kicks-scheduler.test.tsindex 3b67fcb5a6..0fe259e9f0 100644--- a/packages/media/src/test/premount-arm-kicks-scheduler.test.ts+++ b/packages/media/src/test/premount-arm-kicks-scheduler.test.ts@@ -38,6 +38,7 @@ const makePlayer = ({tagType: 'audio',getEffects: () => [],getEffectChainState: () => null,+ onError: null,});};diff --git a/packages/media/src/test/trim-change-seek.test.ts b/packages/media/src/test/trim-change-seek.test.tsindex 011848ecda..acf6dcf6be 100644--- a/packages/media/src/test/trim-change-seek.test.ts+++ b/packages/media/src/test/trim-change-seek.test.ts@@ -28,6 +28,7 @@ test('setTrimBefore and setTrimAfter should update frame when paused', async ()tagType: 'video',getEffects: () => [],getEffectChainState: () => null,+ onError: null,});await player.initialize(0, false, 1);diff --git a/packages/media/src/video/video-for-preview.tsx b/packages/media/src/video/video-for-preview.tsxindex 44fe8a7bdf..66d57fb905 100644--- a/packages/media/src/video/video-for-preview.tsx+++ b/packages/media/src/video/video-for-preview.tsx@@ -174,6 +174,8 @@ const VideoForPreviewAssertedShowing: React.FC<const onErrorRef = useRef(onError);onErrorRef.current = onError;+ const disallowFallbackRef = useRef(disallowFallbackToOffthreadVideo);+ disallowFallbackRef.current = disallowFallbackToOffthreadVideo;const effectChainStateRef = useRef(effectChainState);effectChainStateRef.current = effectChainState;@@ -298,6 +300,18 @@ const VideoForPreviewAssertedShowing: React.FC<getEffects: () => effectsRef.current,getEffectChainState: (width, height) =>effectChainStateRef.current?.get(width, height)!,+ onError: (error) => {+ const [action] = callOnErrorAndResolve({+ onError: onErrorRef.current,+ error,+ disallowFallback: disallowFallbackRef.current,+ isClientSideRendering: false,+ clientSideError: error,+ });+ if (action === 'fallback') {+ setShouldFallbackToNativeVideo(true);+ }+ },});mediaPlayerRef.current = player;