🎥 Make videos programmatically with React
Preserve original errors in client-side rendering
Jonny Burger8945b90ae488
diff --git a/packages/core/src/cancel-render.ts b/packages/core/src/cancel-render.tsindex 913a5fa929..a645aeffc5 100644--- a/packages/core/src/cancel-render.ts+++ b/packages/core/src/cancel-render.ts@@ -65,6 +65,9 @@ export function cancelRenderInternal(}if (scope) {+ // Server rendering reads the stack across Puppeteer. Browser rendering can+ // keep the original Error in this realm, including its cause chain.+ scope.remotion_cancelledErrorObject = error;scope.remotion_cancelledError = getErrorStackWithMessage(error);}diff --git a/packages/core/src/delay-render.ts b/packages/core/src/delay-render.tsindex 8f45714348..e6196fe0dc 100644--- a/packages/core/src/delay-render.ts+++ b/packages/core/src/delay-render.ts@@ -34,6 +34,7 @@ export type DelayRenderScope = {remotion_attempt: number;remotion_delayRenderHandles: number[];remotion_cancelledError?: string;+ remotion_cancelledErrorObject?: Error;};if (typeof window !== 'undefined') {@@ -107,9 +108,9 @@ export const delayRenderInternal = ({// in client-side rendering, don't throw (would be uncaught from setTimeout)if (environment.isClientSideRendering) {- scope.remotion_cancelledError = getErrorStackWithMessage(- Error(message),- );+ const error = Error(message);+ scope.remotion_cancelledErrorObject = error;+ scope.remotion_cancelledError = getErrorStackWithMessage(error);} else {cancelRenderInternal(scope, Error(message));}diff --git a/packages/core/src/index.ts b/packages/core/src/index.tsindex ba1618585e..c787f41450 100644--- a/packages/core/src/index.ts+++ b/packages/core/src/index.ts@@ -62,6 +62,7 @@ declare global {};remotion_delayRenderHandles: number[];remotion_cancelledError: string | undefined;+ remotion_cancelledErrorObject: Error | undefined;remotion_getCompositionNames: () => string[];// Fallback list of seen composition IDs, populated as early as possible by <Composition>remotion_seenCompositionIds: string[];diff --git a/packages/media/src/video-extraction/add-broadcast-channel-listener.ts b/packages/media/src/video-extraction/add-broadcast-channel-listener.tsindex 847371bf18..0d4a80f247 100644--- a/packages/media/src/video-extraction/add-broadcast-channel-listener.ts+++ b/packages/media/src/video-extraction/add-broadcast-channel-listener.ts@@ -123,6 +123,9 @@ export const addBroadcastChannelListener = () => {});if (result.type === 'cannot-decode') {+ // This transport is used by the server's Chromium rendering tabs,+ // whose structured clone preserves Error causes, including DOMExceptions.+ // Firefox/Safari client-side rendering bypasses this channel entirely.const cannotDecodeResponse: MessageFromMainTab = {type: 'response-cannot-decode',error: result.error,diff --git a/packages/media/src/video-extraction/extract-frame-via-broadcast-channel.ts b/packages/media/src/video-extraction/extract-frame-via-broadcast-channel.tsindex d99cd08989..9dcd0fb4eb 100644--- a/packages/media/src/video-extraction/extract-frame-via-broadcast-channel.ts+++ b/packages/media/src/video-extraction/extract-frame-via-broadcast-channel.ts@@ -69,6 +69,9 @@ export const extractFrameViaBroadcastChannel = async ({requestInit?: MediaRequestInit;mediaCache: MediaCache;}): Promise<ExtractFrameViaBroadcastChannelResult> => {+ // Client-side renders, including Firefox and Safari, extract media in this+ // realm. They never clone errors through BroadcastChannel, preserving causes.+ // Only secondary tabs in the server's Chromium renderer use the channel below.if (isClientSideRendering || window.remotion_isMainTab) {return extractFrameAndAudio({sampleRate,diff --git a/packages/web-renderer/src/test/cancel-render.test.tsx b/packages/web-renderer/src/test/cancel-render.test.tsxindex 8d48df8594..88d24cbc20 100644--- a/packages/web-renderer/src/test/cancel-render.test.tsx+++ b/packages/web-renderer/src/test/cancel-render.test.tsx@@ -1,10 +1,21 @@import {useEffect, useState} from 'react';import {useDelayRender} from 'remotion';import {expect, test} from 'vitest';+import {renderMediaOnWeb} from '../render-media-on-web';import {renderStillOnWeb} from '../render-still-on-web';import '../symbol-dispose';-test('should be able to cancel render', async () => {+test('preserves the original cancellation error and its causes', async () => {+ const decoderError = new DOMException(+ 'Decoder allocation failed',+ 'EncodingError',+ );+ const mediaError = new Error('Video decoding failed at 0.5s', {+ cause: decoderError,+ });+ const error = new Error('This should be the error message', {+ cause: mediaError,+ });const Component: React.FC = () => {const {delayRender, cancelRender} = useDelayRender();@@ -13,7 +24,7 @@ test('should be able to cancel render', async () => {useEffect(() => {Promise.resolve().then(() => {try {- cancelRender(new Error('This should be the error message'));+ cancelRender(error);} catch {// cancelRender throws, we catch it here}@@ -23,19 +34,30 @@ test('should be able to cancel render', async () => {return null;};+ const composition = {+ component: Component,+ id: 'cancel-render-test',+ width: 100,+ height: 100,+ fps: 30,+ durationInFrames: 30,+ };+await expect(renderStillOnWeb({licenseKey: 'free-license',- composition: {- component: Component,- id: 'cancel-render-test',- width: 100,- height: 100,- fps: 30,- durationInFrames: 30,- },+ composition,frame: 20,inputProps: {},}),- ).rejects.toThrow(/This should be the error message/);+ ).rejects.toBe(error);++ await expect(+ renderMediaOnWeb({+ licenseKey: 'free-license',+ composition,+ inputProps: {},+ container: 'webm',+ }),+ ).rejects.toBe(error);});diff --git a/packages/web-renderer/src/wait-for-ready.ts b/packages/web-renderer/src/wait-for-ready.tsindex e77cf1bc9d..ef9155841a 100644--- a/packages/web-renderer/src/wait-for-ready.ts+++ b/packages/web-renderer/src/wait-for-ready.ts@@ -45,6 +45,14 @@ export const waitForReady = ({if (scope.remotion_cancelledError !== undefined) {cancelled = true;internalState?.addWaitForReadyTime(performance.now() - start);+ // No serialization is needed for browser rendering. Reject with the+ // original Error so its identity, cause chain and custom fields survive.+ if (scope.remotion_cancelledErrorObject) {+ reject(scope.remotion_cancelledErrorObject);+ return;+ }++ // Keep accepting cancellations from core versions that only store a stack.const stack = scope.remotion_cancelledError;const message = stack.split('\n')[0].replace(/^Error: /, '');const error = new Error(message);