Skip to content

🎥 Make videos programmatically with React

Remove shared render readiness optimization

Jonny Burger142cc7284c65
diff --git a/packages/core/src/delay-render.ts b/packages/core/src/delay-render.ts
index 01490e839f..8f45714348 100644
--- a/packages/core/src/delay-render.ts
+++ b/packages/core/src/delay-render.ts
@@ -12,7 +12,6 @@ import {getRemotionEnvironment} from './get-remotion-environment.js';
import type {LogLevel} from './log.js';
import {Log} from './log.js';
import type {RemotionEnvironment} from './remotion-environment-context.js';
-import {notifyRenderReady} from './render-ready.js';
import {truthy} from './truthy.js';
export {
@@ -195,9 +194,6 @@ export const continueRenderInternal = ({
if (scope.remotion_delayRenderHandles.length === 0) {
scope.remotion_renderReady = true;
- if (environment.isRendering) {
- notifyRenderReady(scope);
- }
}
};
diff --git a/packages/core/src/internals.ts b/packages/core/src/internals.ts
index 764180ed39..799757d281 100644
--- a/packages/core/src/internals.ts
+++ b/packages/core/src/internals.ts
@@ -158,7 +158,6 @@ import {getRoot, waitForRoot} from './register-root.js';
import type {RemotionEnvironment} from './remotion-environment-context.js';
import {RemotionEnvironmentContext} from './remotion-environment-context.js';
import {RemotionRootContexts} from './RemotionRoot.js';
-import {subscribeToRenderReady} from './render-ready.js';
import {
makeRenderResourceManager,
RenderResourceManagerContext,
@@ -346,7 +345,6 @@ const compositionSelectorRef = createRef<{
// Mark them as Internals so use don't assume this is public
// API and are less likely to use it
export const Internals = {
- subscribeToRenderReady,
CommittedMetadataProvider,
withCommittedMetadata,
DefaultPremountContext,
diff --git a/packages/core/src/no-react.ts b/packages/core/src/no-react.ts
index 440c06bbeb..0ee1fc48ef 100644
--- a/packages/core/src/no-react.ts
+++ b/packages/core/src/no-react.ts
@@ -2,7 +2,6 @@ import {
evaluateSourceNumericValue,
evaluateSourcePropStatuses,
} from './evaluate-source-expressions.js';
-import {RENDER_READY_EVENT} from './render-ready.js';
export type {
ArtifactAsset,
AudioOrVideoAsset,
@@ -63,7 +62,6 @@ import {getExpectedMediaFrameUncorrected} from './video/get-current-time';
import {getOffthreadVideoSource} from './video/offthread-video-source';
export const NoReactInternals = {
- RENDER_READY_EVENT,
DEFAULT_PREMOUNT_IN_SECONDS,
validateDefaultPremountInSeconds,
evaluateSourceNumericValue,
diff --git a/packages/core/src/render-ready.ts b/packages/core/src/render-ready.ts
deleted file mode 100644
index 707271f605..0000000000
--- a/packages/core/src/render-ready.ts
+++ /dev/null
@@ -1,28 +0,0 @@
-import type {DelayRenderScope} from './delay-render.js';
-
-export const RENDER_READY_EVENT = 'remotion-render-ready';
-
-const listeners = new WeakMap<DelayRenderScope, Set<() => void>>();
-
-export const subscribeToRenderReady = (
- scope: DelayRenderScope,
- listener: () => void,
-) => {
- let scopedListeners = listeners.get(scope);
- if (!scopedListeners) {
- scopedListeners = new Set();
- listeners.set(scope, scopedListeners);
- }
-
- scopedListeners.add(listener);
- return () => {
- scopedListeners.delete(listener);
- };
-};
-
-export const notifyRenderReady = (scope: DelayRenderScope) => {
- listeners.get(scope)?.forEach((listener) => listener());
- if (typeof window !== 'undefined' && scope === window) {
- window.dispatchEvent(new Event(RENDER_READY_EVENT));
- }
-};
diff --git a/packages/renderer/src/browser/DOMWorld.ts b/packages/renderer/src/browser/DOMWorld.ts
index 390437e48d..d760d9d8dd 100644
--- a/packages/renderer/src/browser/DOMWorld.ts
+++ b/packages/renderer/src/browser/DOMWorld.ts
@@ -122,13 +122,11 @@ export class DOMWorld {
timeout,
pageFunction,
title,
- wakeUpEvent,
}: {
browser: HeadlessBrowser;
timeout: number | null;
pageFunction: Function | string;
title: string;
- wakeUpEvent: string | null;
}): WaitTask {
return new WaitTask({
domWorld: this,
@@ -136,7 +134,6 @@ export class DOMWorld {
title,
timeout,
args: [],
- wakeUpEvent,
browser,
});
}
@@ -149,7 +146,6 @@ interface WaitTaskOptions {
timeout: number | null;
browser: HeadlessBrowser;
args: SerializableOrJSHandle[];
- wakeUpEvent: string | null;
}
const noop = (): void => undefined;
@@ -159,7 +155,6 @@ class WaitTask {
#timeout: number | null;
#predicateBody: string;
#args: SerializableOrJSHandle[];
- #wakeUpEvent: string | null;
#runCount = 0;
#resolve: (x: JSHandle) => void = noop;
#reject: (x: Error) => void = noop;
@@ -182,7 +177,6 @@ class WaitTask {
this.#timeout = options.timeout;
this.#predicateBody = getPredicateBody(options.predicateBody);
this.#args = options.args;
- this.#wakeUpEvent = options.wakeUpEvent;
this.#runCount = 0;
this.#domWorld._waitTasks.add(this);
@@ -244,7 +238,6 @@ class WaitTask {
waitForPredicatePageFunction,
this.#predicateBody,
this.#timeout,
- this.#wakeUpEvent,
...this.#args,
);
} catch (error_) {
@@ -354,77 +347,32 @@ class WaitTask {
function waitForPredicatePageFunction(
predicateBody: string,
timeout: number,
- wakeUpEvent: string | null,
...args: unknown[]
): Promise<unknown> {
// eslint-disable-next-line no-new-func
const predicate = new Function('...args', predicateBody);
+ let timedOut = false;
+ if (timeout) {
+ setTimeout(() => {
+ timedOut = true;
+ }, timeout);
+ }
- return new Promise<JSHandle | undefined>((resolve, reject) => {
- let finished = false;
- let checking = false;
- let rafId: number | null = null;
- let timeoutId: ReturnType<typeof setTimeout> | null = null;
-
- const cleanup = () => {
- finished = true;
- if (rafId !== null) {
- cancelAnimationFrame(rafId);
- }
-
- if (timeoutId !== null) {
- clearTimeout(timeoutId);
- }
-
- if (wakeUpEvent !== null) {
- window.removeEventListener(wakeUpEvent, onReady);
- }
- };
-
- const check = async () => {
- if (finished || checking) {
+ return new Promise<JSHandle | undefined>((resolve) => {
+ async function onRaf(): Promise<void> {
+ if (timedOut) {
+ resolve(undefined);
return;
}
- checking = true;
- try {
- const success = await predicate(...args);
- if (!finished && success) {
- cleanup();
- resolve(success);
- }
- } catch (error) {
- cleanup();
- reject(error);
- } finally {
- checking = false;
- }
- };
-
- const onReady = () => {
- // Let effects finish replacing handles before testing readiness.
- queueMicrotask(check);
- };
-
- async function onRaf(): Promise<void> {
- await check();
- if (!finished) {
- rafId = requestAnimationFrame(onRaf);
+ const success = await predicate(...args);
+ if (success) {
+ resolve(success);
+ } else {
+ requestAnimationFrame(onRaf);
}
}
- if (timeout) {
- timeoutId = setTimeout(() => {
- cleanup();
- resolve(undefined);
- }, timeout);
- }
-
- if (wakeUpEvent !== null) {
- window.addEventListener(wakeUpEvent, onReady);
- }
-
- // Keep polling for errors and for bundles predating the ready event.
onRaf();
});
}
diff --git a/packages/renderer/src/seek-to-frame.ts b/packages/renderer/src/seek-to-frame.ts
index 8b7135451b..b9f173bcca 100644
--- a/packages/renderer/src/seek-to-frame.ts
+++ b/packages/renderer/src/seek-to-frame.ts
@@ -1,4 +1,3 @@
-import {NoReactInternals} from 'remotion/no-react';
import {BrowserEmittedEvents} from './browser/Browser';
import type {Page} from './browser/BrowserPage';
import {PageEmittedEvents} from './browser/BrowserPage';
@@ -68,7 +67,6 @@ export const waitForReady = ({
const waitForReadyProm = new Promise<JSHandle>((resolve, reject) => {
const waitTask = page.mainFrame()._mainWorld.waitForFunction({
browser: page.browser,
- wakeUpEvent: NoReactInternals.RENDER_READY_EVENT,
// Increase timeout so the delayRender() timeout fires earlier
timeout: timeoutInMilliseconds + 3000,
pageFunction: `window.remotion_renderReady === true ? "${readyToken}" : window.remotion_cancelledError !== undefined ? "${cancelledToken}" : false`,
diff --git a/packages/web-renderer/.npmignore b/packages/web-renderer/.npmignore
index 8fe4c13e9c..5266d4b003 100644
--- a/packages/web-renderer/.npmignore
+++ b/packages/web-renderer/.npmignore
@@ -5,5 +5,6 @@ src
.turbo
bundle.ts
vitest.config.ts
+vitest.html-in-canvas.config.ts
.vitest-attachments
-dist/test
\ No newline at end of file
+dist/test
diff --git a/packages/web-renderer/src/test/delay-render.test.tsx b/packages/web-renderer/src/test/delay-render.test.tsx
index 64f13735e1..15023344f8 100644
--- a/packages/web-renderer/src/test/delay-render.test.tsx
+++ b/packages/web-renderer/src/test/delay-render.test.tsx
@@ -14,18 +14,12 @@ test('should be able to use delayRender()', async () => {
useEffect(() => {
setTimeout(() => {
+ flushSync(() => {
+ setData(true);
+ });
continueRender(handle);
- // Replacing the last handle in the same task must not expose the
- // intermediate red frame to an event-driven readiness waiter.
- const nextHandle = delayRender('Loading the next piece of data');
- setTimeout(() => {
- flushSync(() => {
- setData(true);
- });
- continueRender(nextHandle);
- }, 50);
}, 50);
- }, [continueRender, delayRender, handle]);
+ }, [continueRender, handle]);
return data ? (
<svg viewBox="0 0 100 100" style={{backgroundColor: 'green'}} />
diff --git a/packages/web-renderer/src/wait-for-ready.ts b/packages/web-renderer/src/wait-for-ready.ts
index 2b1d7a52bd..e77cf1bc9d 100644
--- a/packages/web-renderer/src/wait-for-ready.ts
+++ b/packages/web-renderer/src/wait-for-ready.ts
@@ -1,5 +1,5 @@
/* eslint-disable @typescript-eslint/no-use-before-define */
-import {Internals, type DelayRenderScope} from 'remotion';
+import type {DelayRenderScope} from 'remotion';
import type {BackgroundKeepalive} from './background-keepalive';
import type {InternalState} from './internal-state';
import {withResolvers} from './with-resolvers';
@@ -22,43 +22,29 @@ export const waitForReady = ({
const start = performance.now();
const {promise, resolve, reject} = withResolvers<void>();
- let completed = false;
- let rafId: number | null = null;
- const unsubscribe = Internals.subscribeToRenderReady(scope, () => {
- // A layout effect may clear an old handle and open a new one in the
- // same commit. Check after that stack has finished.
- queueMicrotask(check);
- });
-
- const finish = () => {
- completed = true;
- unsubscribe();
- if (rafId !== null) {
- cancelAnimationFrame(rafId);
- }
-
- internalState?.addWaitForReadyTime(performance.now() - start);
- };
+ let cancelled = false;
const check = () => {
- if (completed) {
+ if (cancelled) {
return;
}
if (signal?.aborted) {
- finish();
+ cancelled = true;
+ internalState?.addWaitForReadyTime(performance.now() - start);
reject(new Error(`${apiName}() was cancelled`));
return;
}
if (scope.remotion_renderReady === true) {
- finish();
+ internalState?.addWaitForReadyTime(performance.now() - start);
resolve();
return;
}
if (scope.remotion_cancelledError !== undefined) {
- finish();
+ cancelled = true;
+ internalState?.addWaitForReadyTime(performance.now() - start);
const stack = scope.remotion_cancelledError;
const message = stack.split('\n')[0].replace(/^Error: /, '');
const error = new Error(message);
@@ -68,7 +54,8 @@ export const waitForReady = ({
}
if (performance.now() - start > timeoutInMilliseconds + 3000) {
- finish();
+ cancelled = true;
+ internalState?.addWaitForReadyTime(performance.now() - start);
reject(
new Error(
Object.values(scope.remotion_delayRenderTimeouts)
@@ -76,14 +63,17 @@ export const waitForReady = ({
.join(', '),
),
);
+ return;
}
+
+ scheduleNextCheck();
};
// schedule both raf and worker timer - whichever fires first wins.
// when tab is visible, raf fires first. when backgrounded, worker wins.
const scheduleNextCheck = () => {
const rafTick = new Promise<void>((res) => {
- rafId = requestAnimationFrame(() => res());
+ requestAnimationFrame(() => res());
});
// browsers throttle RAF when tab is backgrounded, so race against worker
@@ -91,24 +81,11 @@ export const waitForReady = ({
? Promise.race([rafTick, keepalive.waitForTick()])
: rafTick;
- backgroundSafeTick.then(() => {
- if (rafId !== null) {
- cancelAnimationFrame(rafId);
- rafId = null;
- }
-
- check();
- if (!completed) {
- scheduleNextCheck();
- }
- });
+ backgroundSafeTick.then(check);
};
// check immediately first - if already ready, don't wait for RAF
check();
- if (!completed) {
- scheduleNextCheck();
- }
return promise;
};