🎥 Make videos programmatically with React
Confirm commit observation per root and preserve effect replay
Jonny Burgerff64893bcc01
diff --git a/packages/core/src/CompositionManagerProvider.tsx b/packages/core/src/CompositionManagerProvider.tsxindex 4755233325..754f17267d 100644--- a/packages/core/src/CompositionManagerProvider.tsx+++ b/packages/core/src/CompositionManagerProvider.tsx@@ -32,7 +32,7 @@ import {CompositionManagerOrderMarker,getCompositionAndFolderOrderKey,getFolderOrderId,- isCommitRegistrationObserverAvailable,+ isCommitRegistrationObserverInstalled,COMMIT_ORDER_EVENT,type CommitOrderEventDetail,type CommittedCompositionSnapshot,@@ -59,8 +59,9 @@ export const CompositionManagerProvider = ({const {isStudio} = useRemotionEnvironment();const [compositionManagerId] = useState(() => String(Math.random()));const [commitRegistrationEnabled, setCommitRegistrationEnabled] = useState(- () => isStudio && isCommitRegistrationObserverAvailable(),+ () => isStudio && isCommitRegistrationObserverInstalled(),);+ const observedCommitRef = useRef(false);const pendingRegistrationsRef = useRef<CommittedCompositionSnapshot | null>(null,);@@ -329,7 +330,7 @@ export const CompositionManagerProvider = ({observerFailedRef.current = true;pendingRegistrationsRef.current = null;queueMicrotask(() => {- if (unmounted) {+ if (unmountedRef.current) {return;}@@ -357,6 +358,8 @@ export const CompositionManagerProvider = ({return;}+ observedCommitRef.current = true;+const orderIds = managerOrder.compositionAndFolderOrder.map(getCompositionAndFolderOrderKey,);@@ -441,11 +444,17 @@ export const CompositionManagerProvider = ({COMMIT_REGISTRATION_ERROR_EVENT,onRegistrationError,);+ if (commitRegistrationEnabled) {+ queueMicrotask(() => {+ if (!unmounted && !observedCommitRef.current) {+ onRegistrationError();+ }+ });+ }return () => {unmounted = true;unmountedRef.current = true;- pendingRegistrationsRef.current = null;window.removeEventListener(COMMIT_ORDER_EVENT, onCommitOrder);window.removeEventListener(COMMIT_REGISTRATION_ERROR_EVENT,diff --git a/packages/core/src/SequenceManager.tsx b/packages/core/src/SequenceManager.tsxindex 4be8b47fe2..fcde65d99b 100644--- a/packages/core/src/SequenceManager.tsx+++ b/packages/core/src/SequenceManager.tsx@@ -9,7 +9,7 @@ import {import {COMMIT_ORDER_EVENT,COMMIT_REGISTRATION_ERROR_EVENT,- isCommitRegistrationObserverAvailable,+ isCommitRegistrationObserverInstalled,SequenceManagerOrderMarker,type CommitOrderEventDetail,type CommittedSequenceSnapshot,@@ -78,6 +78,7 @@ const subscribeToNoRegistry = () => () => undefined;const getEmptySequences = () => defaultSequenceManager.sequences;export const SequenceCommitRegistrationContext = React.createContext(false);export const SequenceRegistryScopeContext = React.createContext<{+ readonly commitRegistrationRequested: boolean;readonly onCommitSequences: (scopeId: string,sequences: readonly TSequence[],@@ -431,8 +432,10 @@ export const SequenceManagerProvider: React.FC<{const shouldObserveCommits = isStudio || sequenceRegistrationEnabled;const [sequenceManagerId] = useState(() => String(Math.random()));const [commitRegistrationEnabled, setCommitRegistrationEnabled] = useState(- () => shouldObserveCommits && isCommitRegistrationObserverAvailable(),+ () => shouldObserveCommits && isCommitRegistrationObserverInstalled(),);+ const observedCommitRef = useRef(false);+ const rootObservationFailedRef = useRef(false);const committedRegistrationIdsRef = useRef<ReadonlySet<string>>(new Set());const committedDescriptorsRef = useRef<ReadonlyMap<string, TSequence>>(new Map(),@@ -875,13 +878,19 @@ export const SequenceManagerProvider: React.FC<{[sequenceManagerId, setSequences],);const onCommitRootSequences = useCallback(- (sequences: readonly TSequence[], sequenceIds: readonly string[]) =>- onCommitSequences(sequenceManagerId, sequences, sequenceIds),+ (sequences: readonly TSequence[], sequenceIds: readonly string[]) => {+ if (!rootObservationFailedRef.current) {+ onCommitSequences(sequenceManagerId, sequences, sequenceIds);+ }+ },[onCommitSequences, sequenceManagerId],);const registryScope = useMemo(- () => ({onCommitSequences}),- [onCommitSequences],+ () => ({+ onCommitSequences,+ commitRegistrationRequested: shouldObserveCommits,+ }),+ [onCommitSequences, shouldObserveCommits],);useIsomorphicLayoutEffect(() => {@@ -899,7 +908,7 @@ export const SequenceManagerProvider: React.FC<{registrationObserverFailedRef.current = true;pendingCommittedSequencesRef.current.clear();queueMicrotask(() => {- if (unmounted) {+ if (registrationUnmountedRef.current) {return;}@@ -914,10 +923,6 @@ export const SequenceManagerProvider: React.FC<{};const onCommitOrder = (event: Event) => {- if (commitRegistrationEnabled) {- return;- }-const {detail} = event as CustomEvent<CommitOrderEventDetail>;const managerOrder = detail.sequenceManagers.find((item) => item.managerId === sequenceManagerId,@@ -926,6 +931,11 @@ export const SequenceManagerProvider: React.FC<{return;}+ observedCommitRef.current = true;+ if (commitRegistrationEnabled) {+ return;+ }+const previousOrder = committedOrderIdsRef.current;if (previousOrder === managerOrder.sequenceIds ||@@ -974,10 +984,28 @@ export const SequenceManagerProvider: React.FC<{COMMIT_REGISTRATION_ERROR_EVENT,onRegistrationError,);+ if (commitRegistrationEnabled) {+ // React invokes its commit hook after layout effects. Installation alone+ // does not prove this renderer connected to the hook during initialization.+ queueMicrotask(() => {+ if (+ unmounted ||+ observedCommitRef.current ||+ registrationObserverFailedRef.current+ ) {+ return;+ }++ rootObservationFailedRef.current = true;+ onCommitSequences(sequenceManagerId, [], []);+ setCommitRegistrationEnabled(false);+ });+ }+return () => {unmounted = true;registrationUnmountedRef.current = true;- pendingCommittedSequencesRef.current.clear();+ // Effect replay must not discard a snapshot already collected by React.window.removeEventListener(COMMIT_ORDER_EVENT, onCommitOrder);window.removeEventListener(COMMIT_REGISTRATION_ERROR_EVENT,@@ -989,6 +1017,7 @@ export const SequenceManagerProvider: React.FC<{sequenceManagerId,setSequences,commitRegistrationEnabled,+ onCommitSequences,]);const registerSequence = useCallback(@@ -1183,7 +1212,7 @@ export const SequenceManagerProvider: React.FC<{const SequenceManagerProviderWithActions: React.FC<React.ProviderProps<SequenceManagerContext>> = ({value, children}) => {- const [useCommittedManager] = useState(isCommitRegistrationObserverAvailable);+ const [useCommittedManager] = useState(isCommitRegistrationObserverInstalled);const [registry] = useState(() => createRegistryStore(value.sequences));useIsomorphicLayoutEffect(() => {if (!useCommittedManager) {diff --git a/packages/core/src/sequence-order-marker.tsx b/packages/core/src/sequence-order-marker.tsxindex b603c799f9..2293529be9 100644--- a/packages/core/src/sequence-order-marker.tsx+++ b/packages/core/src/sequence-order-marker.tsx@@ -25,7 +25,7 @@ const COMMIT_OBSERVER_FAILURE_MARKER = Symbol.for('remotion.commit-registration-observer-failed',);-export const isCommitRegistrationObserverAvailable = () => {+export const isCommitRegistrationObserverInstalled = () => {if (typeof window === 'undefined') {return false;}@@ -34,6 +34,7 @@ export const isCommitRegistrationObserverAvailable = () => {return (typeof hook === 'object' &&hook !== null &&+ Reflect.get(hook, 'isDisabled') !== true &&Reflect.get(hook, COMMIT_OBSERVER_INSTALLATION_MARKER) === true &&Reflect.get(hook, COMMIT_OBSERVER_FAILURE_MARKER) !== true);diff --git a/packages/core/src/wrap-remotion-context.tsx b/packages/core/src/wrap-remotion-context.tsxindex c3f944616e..02b75cffc7 100644--- a/packages/core/src/wrap-remotion-context.tsx+++ b/packages/core/src/wrap-remotion-context.tsx@@ -2,7 +2,7 @@// such as in React Three Fiber. All the contexts need to be passed again// for them to be useable-import React, {useCallback, useMemo, useState} from 'react';+import React, {useCallback, useMemo, useRef, useState} from 'react';import {BufferingContextReact} from './buffering.js';import {CanUseRemotionHooks} from './CanUseRemotionHooks.js';import type {TSequence} from './CompositionManager.js';@@ -14,7 +14,10 @@ import {RenderAssetManager} from './RenderAssetManager.js';import {ResolveCompositionContext} from './ResolveCompositionConfig.js';import {COMMIT_REGISTRATION_ERROR_EVENT,+ COMMIT_ORDER_EVENT,+ isCommitRegistrationObserverInstalled,SequenceManagerOrderMarker,+ type CommitOrderEventDetail,} from './sequence-order-marker.js';import {SequenceContext} from './SequenceContext.js';import {@@ -54,9 +57,6 @@ export function useRemotionContexts() {const sequenceRegistryScopeContext = React.useContext(SequenceRegistryScopeContext,);- const sequenceCommitRegistrationContext = React.useContext(- SequenceCommitRegistrationContext,- );const sequenceRegistrationContext = React.useContext(SequenceRegistrationContext,);@@ -88,7 +88,6 @@ export function useRemotionContexts() {sequenceManagerRefContext,sequenceRegistryContext,sequenceRegistryScopeContext,- sequenceCommitRegistrationContext,sequenceRegistrationContext,disableSequenceRegistrationContext,remotionEnvironmentContext,@@ -111,7 +110,6 @@ export function useRemotionContexts() {sequenceManagerRefContext,sequenceRegistryContext,sequenceRegistryScopeContext,- sequenceCommitRegistrationContext,sequenceRegistrationContext,disableSequenceRegistrationContext,remotionEnvironmentContext,@@ -132,16 +130,26 @@ const ForwardedSequenceRegistry: React.FC<RemotionContextProviderProps> = ({children,}) => {const [scopeId] = useState(() => String(Math.random()));- const [observerFailed, setObserverFailed] = useState(false);+ const [observerAvailable, setObserverAvailable] = useState(+ isCommitRegistrationObserverInstalled,+ );+ const observedCommitRef = useRef(false);+ const observerFailedRef = useRef(false);+ const unmountedRef = useRef(false);+ const lifetimeRef = useRef(0);const registry = contexts.sequenceRegistryContext;const scope = contexts.sequenceRegistryScopeContext;+ const activeRegistryRef = useRef(registry);const commitRegistrationEnabled =- contexts.sequenceCommitRegistrationContext &&+ scope?.commitRegistrationRequested === true &®istry !== null &&- scope !== null &&- !observerFailed;+ observerAvailable;const onCommitSequences = useCallback((sequences: readonly TSequence[], sequenceIds: readonly string[]) => {+ if (observerFailedRef.current && sequenceIds.length > 0) {+ return;+ }+scope?.onCommitSequences(scopeId, sequences, sequenceIds);},[scope, scopeId],@@ -153,18 +161,60 @@ const ForwardedSequenceRegistry: React.FC<RemotionContextProviderProps> = ({return;}- let unmounted = false;- const onFailure = () =>+ const lifetime = ++lifetimeRef.current;+ unmountedRef.current = false;+ activeRegistryRef.current = registry;+ const onFailure = () => {+ if (observerFailedRef.current) {+ return;+ }++ observerFailedRef.current = true;queueMicrotask(() => {- if (!unmounted) setObserverFailed(true);+ scope.onCommitSequences(scopeId, [], []);+ // Release this root's committed records before its effects take over.+ queueMicrotask(() => {+ if (!unmountedRef.current) setObserverAvailable(false);+ });});+ };++ const onCommitOrder = (event: Event) => {+ const {detail} = event as CustomEvent<CommitOrderEventDetail>;+ if (detail.sequenceManagers.some((item) => item.managerId === scopeId)) {+ observedCommitRef.current = true;+ }+ };++ window.addEventListener(COMMIT_ORDER_EVENT, onCommitOrder);window.addEventListener(COMMIT_REGISTRATION_ERROR_EVENT, onFailure);+ if (commitRegistrationEnabled) {+ queueMicrotask(() => {+ if (+ lifetimeRef.current === lifetime &&+ !unmountedRef.current &&+ !observedCommitRef.current+ ) {+ onFailure();+ }+ });+ }+return () => {- unmounted = true;+ unmountedRef.current = true;+ window.removeEventListener(COMMIT_ORDER_EVENT, onCommitOrder);window.removeEventListener(COMMIT_REGISTRATION_ERROR_EVENT, onFailure);- scope.onCommitSequences(scopeId, [], []);+ // Strict Mode and Fast Refresh restart effects without removing the marker.+ queueMicrotask(() => {+ if (+ activeRegistryRef.current !== registry ||+ (lifetimeRef.current === lifetime && unmountedRef.current)+ ) {+ scope.onCommitSequences(scopeId, [], []);+ }+ });};- }, [scope, scopeId]);+ }, [scope, scopeId, registry, commitRegistrationEnabled]);return (<SequenceManagerOrderMarkermanagerId={scopeId}