Skip to content

🎥 Make videos programmatically with React

Replace commit order markers with provider metadata

Jonny Burger72fc6e5dd056
diff --git a/packages/core/src/Composition.tsx b/packages/core/src/Composition.tsx
index ec2d3d8e6d..eea90cd96e 100644
--- a/packages/core/src/Composition.tsx
+++ b/packages/core/src/Composition.tsx
@@ -14,6 +14,11 @@ import {
CanUseRemotionHooksProvider,
} from './CanUseRemotionHooks.js';
import type {Codec} from './codec.js';
+import {
+ CommittedMetadataProvider,
+ type CommittedMetadata,
+} from './committed-metadata.js';
+import {useCommittedCompositionEntry} from './composition-registry-fallback.js';
import {CompositionRenderErrorContext} from './composition-render-error-context.js';
import {CompositionErrorBoundary} from './CompositionErrorBoundary.js';
import type {AnyComposition, TComposition} from './CompositionManager.js';
@@ -28,7 +33,6 @@ import type {InferProps, PropsIfHasProps} from './props-if-has-props.js';
import type {ProResProfile} from './prores-profile.js';
import type {PixelFormat, VideoImageFormat} from './render-types.js';
import {useResolvedVideoConfig} from './ResolveCompositionConfig.js';
-import {CompositionOrderMarker} from './sequence-order-marker.js';
import {useDelayRender} from './use-delay-render.js';
import {useLazyComponent} from './use-lazy-component.js';
import {useRemotionEnvironment} from './use-remotion-environment.js';
@@ -232,6 +236,12 @@ const InnerComposition = <
stack,
]);
+ const metadata = useMemo<Extract<CommittedMetadata, {type: 'composition'}>>(
+ () => ({type: 'composition', id, value: registration}),
+ [id, registration],
+ );
+ useCommittedCompositionEntry(metadata);
+
const resolved = useResolvedVideoConfig(id);
const {setError, clearError} = useContext(CompositionRenderErrorContext);
@@ -247,9 +257,9 @@ const InnerComposition = <
clearError();
}, [clearError]);
const wrapRegistration = (content: React.ReactNode) => (
- <CompositionOrderMarker compositionId={id} registration={registration}>
+ <CommittedMetadataProvider value={null} _remotionCommitMetadata={metadata}>
{content}
- </CompositionOrderMarker>
+ </CommittedMetadataProvider>
);
if (
diff --git a/packages/core/src/CompositionManagerProvider.tsx b/packages/core/src/CompositionManagerProvider.tsx
index 4098c50336..bc0c7b1a99 100644
--- a/packages/core/src/CompositionManagerProvider.tsx
+++ b/packages/core/src/CompositionManagerProvider.tsx
@@ -5,6 +5,10 @@ import {
useRef,
useState,
} from 'react';
+import {
+ getFolderOrderId,
+ type CommittedCompositionSnapshot,
+} from './committed-metadata.js';
import {compositionsRef, type AnyComposition} from './CompositionManager';
import type {
AssetPreviewMetadata,
@@ -23,10 +27,6 @@ import {
createRegistryStore,
reconcileRegistryEntries,
} from './registry-store.js';
-import {
- getFolderOrderId,
- type CommittedCompositionSnapshot,
-} from './sequence-order-marker.js';
import {useSyncExternalStore} from './use-sync-external-store.js';
export const CompositionManagerProvider = ({
diff --git a/packages/core/src/CompositionRegistryProvider.tsx b/packages/core/src/CompositionRegistryProvider.tsx
index 13488658ed..fb91563207 100644
--- a/packages/core/src/CompositionRegistryProvider.tsx
+++ b/packages/core/src/CompositionRegistryProvider.tsx
@@ -6,24 +6,28 @@ import {
useRef,
useState,
} from 'react';
-import {
- CompositionRegistryFallbackContext,
- type CommittedCompositionEntry,
-} from './composition-registry-fallback.js';
-import type {AnyComposition} from './CompositionManager.js';
-import type {TFolder} from './Folder.js';
import {
COMMIT_REGISTRATION_ERROR_EVENT,
- CompositionManagerOrderMarker,
getCompositionAndFolderOrderKey,
getFolderOrderId,
isCommitRegistrationObserverInstalled,
+ withCommittedMetadata,
+ type CommittedMetadata,
type CommittedCompositionSnapshot,
-} from './sequence-order-marker.js';
+} from './committed-metadata.js';
+import {
+ CompositionRegistryFallbackContext,
+ type CommittedCompositionEntry,
+} from './composition-registry-fallback.js';
+import type {AnyComposition} from './CompositionManager.js';
+import type {TFolder} from './Folder.js';
import {useRemotionEnvironment} from './use-remotion-environment.js';
const useIsomorphicLayoutEffect =
typeof window === 'undefined' ? useEffect : useLayoutEffect;
+const CompositionRegistryFallbackProvider = withCommittedMetadata(
+ CompositionRegistryFallbackContext.Provider,
+);
// Every consumer receives a complete committed snapshot. The fallback changes
// how descriptors are captured, rather than exposing a second registration API.
@@ -191,21 +195,23 @@ export const CompositionRegistryProvider: React.FC<{
}
};
}, [isStudio, useCommitObserver]);
- const providers = (
- <CompositionRegistryFallbackContext.Provider
+ const metadata = useMemo<CommittedMetadata | null>(
+ () =>
+ isStudio
+ ? {
+ type: 'composition-manager',
+ id: managerId,
+ onCommit: useCommitObserver ? onObservedSnapshot : null,
+ }
+ : null,
+ [isStudio, managerId, onObservedSnapshot, useCommitObserver],
+ );
+ return (
+ <CompositionRegistryFallbackProvider
value={useCommitObserver ? null : fallbackRegistry}
+ _remotionCommitMetadata={metadata}
>
{children}
- </CompositionRegistryFallbackContext.Provider>
- );
- return isStudio ? (
- <CompositionManagerOrderMarker
- managerId={managerId}
- onCommitRegistrations={useCommitObserver ? onObservedSnapshot : null}
- >
- {providers}
- </CompositionManagerOrderMarker>
- ) : (
- providers
+ </CompositionRegistryFallbackProvider>
);
};
diff --git a/packages/core/src/Folder.tsx b/packages/core/src/Folder.tsx
index 626d5bf2a0..333fef593f 100644
--- a/packages/core/src/Folder.tsx
+++ b/packages/core/src/Folder.tsx
@@ -1,6 +1,11 @@
import type {FC, ReactNode} from 'react';
import {createContext, useContext, useMemo} from 'react';
-import {FolderOrderMarker, getFolderOrderId} from './sequence-order-marker.js';
+import {
+ getFolderOrderId,
+ withCommittedMetadata,
+ type CommittedMetadata,
+} from './committed-metadata.js';
+import {useCommittedCompositionEntry} from './composition-registry-fallback.js';
import {truthy} from './truthy.js';
import {validateFolderName} from './validation/validate-folder-name.js';
@@ -20,6 +25,7 @@ export const FolderContext = createContext<FolderContextType>({
folderName: null,
parentName: null,
});
+const FolderContextProvider = withCommittedMetadata(FolderContext.Provider);
/*
* @description By wrapping a <Composition /> inside a <Folder />, you can visually categorize it in your sidebar, should you have many compositions.
@@ -53,15 +59,18 @@ export const Folder: FC<{
[name, parentName, stack],
);
- const folder = (
- <FolderContext.Provider value={value}>{children}</FolderContext.Provider>
+ const metadata = useMemo<Extract<CommittedMetadata, {type: 'folder'}>>(
+ () => ({
+ type: 'folder',
+ id: getFolderOrderId({name, parent: parentName}),
+ value: registration,
+ }),
+ [name, parentName, registration],
);
+ useCommittedCompositionEntry(metadata);
return (
- <FolderOrderMarker
- folderId={getFolderOrderId({name, parent: parentName})}
- registration={registration}
- >
- {folder}
- </FolderOrderMarker>
+ <FolderContextProvider value={value} _remotionCommitMetadata={metadata}>
+ {children}
+ </FolderContextProvider>
);
};
diff --git a/packages/core/src/Sequence.tsx b/packages/core/src/Sequence.tsx
index 4bbb04a5f3..e4edf6855e 100644
--- a/packages/core/src/Sequence.tsx
+++ b/packages/core/src/Sequence.tsx
@@ -10,6 +10,10 @@ import React, {
useState,
} from 'react';
import {AbsoluteFillElement} from './AbsoluteFillElement.js';
+import {
+ withCommittedMetadata,
+ type CommittedMetadata,
+} from './committed-metadata.js';
import type {
LoopDisplay,
SequenceControls,
@@ -35,7 +39,6 @@ import {
resolveSequenceCrop,
validateSequenceCrop,
} from './sequence-crop.js';
-import {SequenceOrderMarker} from './sequence-order-marker.js';
import {
SequenceOutlineContext,
SequenceOutlineInternals,
@@ -58,6 +61,7 @@ import {ENABLE_V5_BREAKING_CHANGES} from './v5-flag.js';
import {withInteractivitySchema} from './with-interactivity-schema.js';
const SeriesContentVisibilityContext = createContext(true);
+const SequenceContextProvider = withCommittedMetadata(SequenceContext.Provider);
const EMPTY_EFFECTS: readonly EffectDefinition<unknown>[] = [];
type EffectDefinitionsWithRuntimeValues =
@@ -855,15 +859,27 @@ const RegularSequenceRefForwardingFunction: React.ForwardRefRenderFunction<
);
}
+ const metadata = useMemo<CommittedMetadata | null>(
+ () =>
+ shouldDiscoverOutline || registration !== null
+ ? {
+ type: 'sequence',
+ id,
+ value: registration,
+ outlineChildrenRef: automaticOutlineRef,
+ }
+ : null,
+ [automaticOutlineRef, id, registration, shouldDiscoverOutline],
+ );
+
if (hidden) {
return shouldDiscoverOutline || registration !== null ? (
- <SequenceOrderMarker
- sequenceId={id}
- registration={registration}
- outlineChildrenRef={automaticOutlineRef}
+ <SequenceContextProvider
+ value={contextValue}
+ _remotionCommitMetadata={metadata}
>
{null}
- </SequenceOrderMarker>
+ </SequenceContextProvider>
) : null;
}
@@ -887,7 +903,10 @@ const RegularSequenceRefForwardingFunction: React.ForwardRefRenderFunction<
</AbsoluteFillElement>
);
const sequenceContent = (
- <SequenceContext.Provider value={contextValue}>
+ <SequenceContextProvider
+ value={contextValue}
+ _remotionCommitMetadata={metadata}
+ >
{retainSeriesRegistration ? (
<SeriesContentVisibilityContext.Provider value={content !== null}>
{renderedContent}
@@ -895,7 +914,7 @@ const RegularSequenceRefForwardingFunction: React.ForwardRefRenderFunction<
) : (
renderedContent
)}
- </SequenceContext.Provider>
+ </SequenceContextProvider>
);
// Keep the provider mounted when track grouping changes so clip state survives.
const sequence = (
@@ -911,17 +930,7 @@ const RegularSequenceRefForwardingFunction: React.ForwardRefRenderFunction<
</TimelineTrackContext.Provider>
);
- return shouldDiscoverOutline || registration !== null ? (
- <SequenceOrderMarker
- sequenceId={id}
- registration={registration}
- outlineChildrenRef={automaticOutlineRef}
- >
- {sequence}
- </SequenceOrderMarker>
- ) : (
- sequence
- );
+ return sequence;
};
const RegularSequence = forwardRef(RegularSequenceRefForwardingFunction);
diff --git a/packages/core/src/SequenceManager.tsx b/packages/core/src/SequenceManager.tsx
index 60b41639ec..ba9d639681 100644
--- a/packages/core/src/SequenceManager.tsx
+++ b/packages/core/src/SequenceManager.tsx
@@ -1,4 +1,13 @@
import React, {useCallback, useContext, useMemo, useRef, useState} from 'react';
+import {
+ COMMIT_ORDER_EVENT,
+ COMMIT_REGISTRATION_ERROR_EVENT,
+ isCommitRegistrationObserverInstalled,
+ withCommittedMetadata,
+ type CommittedMetadata,
+ type CommitOrderEventDetail,
+ type CommittedSequenceSnapshot,
+} from './committed-metadata.js';
import type {TSequence} from './CompositionManager.js';
import {
areRegistryEntriesEqual,
@@ -6,14 +15,6 @@ import {
reconcileRegistryEntries,
type RegistryStore,
} from './registry-store.js';
-import {
- COMMIT_ORDER_EVENT,
- COMMIT_REGISTRATION_ERROR_EVENT,
- isCommitRegistrationObserverInstalled,
- SequenceManagerOrderMarker,
- type CommitOrderEventDetail,
- type CommittedSequenceSnapshot,
-} from './sequence-order-marker.js';
import {useRemotionEnvironment} from './use-remotion-environment.js';
import type {
CanUpdateSequencePropStatus,
@@ -99,6 +100,9 @@ export const SequenceManagerRefContext =
React.createContext<SequenceManagerRef>({
current: [],
});
+const SequenceManagerRefProvider = withCommittedMetadata(
+ SequenceManagerRefContext.Provider,
+);
export const SequenceRegistrationContext = React.createContext(false);
@@ -1152,8 +1156,27 @@ export const SequenceManagerProvider: React.FC<{
[setDragOverridesBatch, setEffectDragOverridesBatch],
);
- const providers = (
- <SequenceManagerRefContext.Provider value={sequencesRef}>
+ const metadata = useMemo<CommittedMetadata | null>(
+ () =>
+ shouldObserveCommits
+ ? {
+ type: 'sequence-manager',
+ id: sequenceManagerId,
+ onCommit: commitRegistrationEnabled ? onCommitRootSequences : null,
+ }
+ : null,
+ [
+ commitRegistrationEnabled,
+ onCommitRootSequences,
+ sequenceManagerId,
+ shouldObserveCommits,
+ ],
+ );
+ return (
+ <SequenceManagerRefProvider
+ value={sequencesRef}
+ _remotionCommitMetadata={metadata}
+ >
<SequenceRegistryScopeContext.Provider value={registryScope}>
<NativeSequenceManagerProvider value={sequenceManagerContext}>
<SequenceManagerActionsContext.Provider value={actions}>
@@ -1192,20 +1215,7 @@ export const SequenceManagerProvider: React.FC<{
</SequenceManagerActionsContext.Provider>
</NativeSequenceManagerProvider>
</SequenceRegistryScopeContext.Provider>
- </SequenceManagerRefContext.Provider>
- );
-
- return shouldObserveCommits ? (
- <SequenceManagerOrderMarker
- managerId={sequenceManagerId}
- onCommitSequences={
- commitRegistrationEnabled ? onCommitRootSequences : null
- }
- >
- {providers}
- </SequenceManagerOrderMarker>
- ) : (
- providers
+ </SequenceManagerRefProvider>
);
};
diff --git a/packages/core/src/audio/AudioForPreview.tsx b/packages/core/src/audio/AudioForPreview.tsx
index 8ccd8c4d11..8fb5e05472 100644
--- a/packages/core/src/audio/AudioForPreview.tsx
+++ b/packages/core/src/audio/AudioForPreview.tsx
@@ -9,11 +9,14 @@ import React, {
useRef,
useState,
} from 'react';
+import {
+ CommittedMetadataProvider,
+ type CommittedMetadata,
+} from '../committed-metadata.js';
import {getCrossOriginValue} from '../get-cross-origin-value.js';
import {useLogLevel} from '../log-level-context.js';
import {usePreload} from '../prefetch.js';
import {random} from '../random.js';
-import {SequenceOrderMarker} from '../sequence-order-marker.js';
import {SequenceContext} from '../SequenceContext.js';
import {useVolume} from '../use-amplification.js';
import {useMediaInTimelineRegistration} from '../use-media-in-timeline.js';
@@ -277,15 +280,27 @@ const AudioForDevelopmentForwardRefFunction: React.ForwardRefRenderFunction<
};
}, [audioRef, src]);
+ const metadata = useMemo<CommittedMetadata | null>(
+ () =>
+ isStudio || registration !== null
+ ? {
+ type: 'sequence',
+ id: timelineId,
+ value: registration,
+ outlineChildrenRef: null,
+ }
+ : null,
+ [isStudio, registration, timelineId],
+ );
+
if (initialShouldPreMountAudioElements) {
return isStudio || registration !== null ? (
- <SequenceOrderMarker
- sequenceId={timelineId}
- registration={registration}
- outlineChildrenRef={null}
+ <CommittedMetadataProvider
+ value={null}
+ _remotionCommitMetadata={metadata}
>
{null}
- </SequenceOrderMarker>
+ </CommittedMetadataProvider>
) : null;
}
@@ -299,13 +314,9 @@ const AudioForDevelopmentForwardRefFunction: React.ForwardRefRenderFunction<
);
return isStudio || registration !== null ? (
- <SequenceOrderMarker
- sequenceId={timelineId}
- registration={registration}
- outlineChildrenRef={null}
- >
+ <CommittedMetadataProvider value={null} _remotionCommitMetadata={metadata}>
{audio}
- </SequenceOrderMarker>
+ </CommittedMetadataProvider>
) : (
audio
);
diff --git a/packages/core/src/committed-metadata.ts b/packages/core/src/committed-metadata.ts
new file mode 100644
index 0000000000..14fd890753
--- /dev/null
+++ b/packages/core/src/committed-metadata.ts
@@ -0,0 +1,138 @@
+import {createContext} from 'react';
+import type {
+ Provider,
+ ProviderExoticComponent,
+ ProviderProps,
+ RefObject,
+} from 'react';
+import type {AnyComposition, TSequence} from './CompositionManager.js';
+import type {TFolder} from './Folder.js';
+
+export const COMMIT_ORDER_EVENT = 'remotion:commit-order';
+export const COMMIT_REGISTRATION_ERROR_EVENT =
+ 'remotion:commit-registration-error';
+const COMMIT_OBSERVER_INSTALLATION_MARKER = Symbol.for(
+ 'remotion.commit-order-observer-installed',
+);
+const COMMIT_OBSERVER_FAILURE_MARKER = Symbol.for(
+ 'remotion.commit-registration-observer-failed',
+);
+
+export const isCommitRegistrationObserverInstalled = () => {
+ if (typeof window === 'undefined') {
+ return false;
+ }
+
+ const hook = Reflect.get(window, '__REACT_DEVTOOLS_GLOBAL_HOOK__');
+ 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
+ );
+};
+
+export type CompositionAndFolderOrderItem =
+ | {readonly type: 'composition'; readonly id: string}
+ | {readonly type: 'folder'; readonly id: string};
+
+export const getCompositionAndFolderOrderKey = (
+ item: CompositionAndFolderOrderItem,
+) => `${item.type}:${item.id}`;
+
+export type CommitOrderEventDetail = {
+ readonly sequenceManagers: readonly {
+ readonly managerId: string;
+ readonly sequenceIds: readonly string[];
+ }[];
+ readonly compositionManagers: readonly {
+ readonly managerId: string;
+ readonly compositionAndFolderOrder: readonly CompositionAndFolderOrderItem[];
+ }[];
+};
+
+export const getFolderOrderId = ({
+ name,
+ parent,
+}: {
+ readonly name: string;
+ readonly parent: string | null;
+}) => [parent, name].filter(Boolean).join('/');
+
+export type CommittedSequenceSnapshot = {
+ readonly sequences: readonly TSequence[];
+ readonly sequenceIds: readonly string[];
+};
+
+export type CommittedCompositionSnapshot = {
+ readonly compositions: readonly AnyComposition[];
+ readonly folders: readonly TFolder[];
+ readonly orderIds: readonly string[];
+};
+
+export type CommittedMetadata =
+ | {
+ readonly type: 'sequence';
+ readonly id: string;
+ readonly value: TSequence | null;
+ readonly outlineChildrenRef: RefObject<Element | null> | null;
+ }
+ | {
+ readonly type: 'composition';
+ readonly id: string;
+ readonly value: AnyComposition;
+ }
+ | {readonly type: 'folder'; readonly id: string; readonly value: TFolder}
+ | {
+ readonly type: 'sequence-manager';
+ readonly id: string;
+ readonly onCommit:
+ | ((
+ sequences: readonly TSequence[],
+ sequenceIds: readonly string[],
+ ) => void)
+ | null;
+ }
+ | {
+ readonly type: 'composition-manager';
+ readonly id: string;
+ readonly onCommit:
+ | ((snapshot: CommittedCompositionSnapshot) => void)
+ | null;
+ };
+
+// This is the same provider, with an additional private prop type. Metadata
+// stays outside its context value, so edits do not notify context consumers.
+export const withCommittedMetadata = <T>(
+ provider: Provider<T>,
+): ProviderExoticComponent<
+ ProviderProps<T> & {
+ readonly _remotionCommitMetadata: CommittedMetadata | null;
+ }
+> => provider;
+
+// Leaves without an existing provider still need a committed Fiber when their
+// content is null. Its constant context value never carries registry metadata.
+export const CommittedMetadataProvider = withCommittedMetadata(
+ createContext(null).Provider,
+);
+
+const getCommittedMetadata = (props: unknown): CommittedMetadata | null => {
+ if (typeof props !== 'object' || props === null) {
+ return null;
+ }
+
+ const metadata: unknown = Reflect.get(props, '_remotionCommitMetadata');
+ return typeof metadata === 'object' && metadata !== null
+ ? (metadata as CommittedMetadata)
+ : null;
+};
+
+export const CommittedMetadataInternals = {
+ getMetadata: getCommittedMetadata,
+ eventName: COMMIT_ORDER_EVENT,
+ installationMarker: COMMIT_OBSERVER_INSTALLATION_MARKER,
+ failureMarker: COMMIT_OBSERVER_FAILURE_MARKER,
+ registrationErrorEventName: COMMIT_REGISTRATION_ERROR_EVENT,
+};
diff --git a/packages/core/src/internals.ts b/packages/core/src/internals.ts
index 2057ea0bba..b4cf86c8a0 100644
--- a/packages/core/src/internals.ts
+++ b/packages/core/src/internals.ts
@@ -23,6 +23,11 @@ import {
CanUseRemotionHooks,
CanUseRemotionHooksProvider,
} from './CanUseRemotionHooks.js';
+import {
+ CommittedMetadataInternals,
+ CommittedMetadataProvider,
+ withCommittedMetadata,
+} from './committed-metadata.js';
import {CompositionRenderErrorContext} from './composition-render-error-context.js';
import {type CompProps} from './Composition.js';
import type {
@@ -181,10 +186,6 @@ import {
OverrideIdsToNodePathsGettersContext,
OverrideIdsToNodePathsSettersContext,
} from './sequence-node-path.js';
-import {
- CommitOrderInternals,
- SequenceOrderMarker,
-} from './sequence-order-marker.js';
import {
SequenceOutlineContext,
SequenceOutlineInternals,
@@ -338,7 +339,8 @@ 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 = {
- SequenceOrderMarker,
+ CommittedMetadataProvider,
+ withCommittedMetadata,
evaluateSourceNumericValue,
evaluateSourcePropStatuses,
AbsoluteFillElement,
@@ -381,7 +383,7 @@ export const Internals = {
useSequenceManagerSequences,
SequenceRegistrationContext,
DisableSequenceRegistrationProvider,
- CommitOrderInternals,
+ CommittedMetadataInternals,
SequenceOutlineInternals,
SequenceOutlineContext,
SequenceStackTracesUpdateContext,
diff --git a/packages/core/src/sequence-order-marker.tsx b/packages/core/src/sequence-order-marker.tsx
deleted file mode 100644
index 4da2ec214e..0000000000
--- a/packages/core/src/sequence-order-marker.tsx
+++ /dev/null
@@ -1,179 +0,0 @@
-import type React from 'react';
-import {useMemo} from 'react';
-import {useCommittedCompositionEntry} from './composition-registry-fallback.js';
-import type {AnyComposition, TSequence} from './CompositionManager.js';
-import type {TFolder} from './Folder.js';
-
-export const SEQUENCE_ORDER_MARKER = Symbol.for(
- 'remotion.sequence-order-marker',
-);
-export const SEQUENCE_MANAGER_ORDER_MARKER = Symbol.for(
- 'remotion.sequence-manager-order-marker',
-);
-export const COMPOSITION_ORDER_MARKER = Symbol.for(
- 'remotion.composition-order-marker',
-);
-export const FOLDER_ORDER_MARKER = Symbol.for('remotion.folder-order-marker');
-export const COMPOSITION_MANAGER_ORDER_MARKER = Symbol.for(
- 'remotion.composition-manager-order-marker',
-);
-export const COMMIT_ORDER_EVENT = 'remotion:commit-order';
-export const COMMIT_REGISTRATION_ERROR_EVENT =
- 'remotion:commit-registration-error';
-const COMMIT_OBSERVER_INSTALLATION_MARKER = Symbol.for(
- 'remotion.commit-order-observer-installed',
-);
-const COMMIT_OBSERVER_FAILURE_MARKER = Symbol.for(
- 'remotion.commit-registration-observer-failed',
-);
-
-export const isCommitRegistrationObserverInstalled = () => {
- if (typeof window === 'undefined') {
- return false;
- }
-
- const hook = Reflect.get(window, '__REACT_DEVTOOLS_GLOBAL_HOOK__');
- 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
- );
-};
-
-export type CompositionAndFolderOrderItem =
- | {readonly type: 'composition'; readonly id: string}
- | {readonly type: 'folder'; readonly id: string};
-
-export const getCompositionAndFolderOrderKey = (
- item: CompositionAndFolderOrderItem,
-) => `${item.type}:${item.id}`;
-
-export type CommitOrderEventDetail = {
- readonly sequenceManagers: readonly {
- readonly managerId: string;
- readonly sequenceIds: readonly string[];
- }[];
- readonly compositionManagers: readonly {
- readonly managerId: string;
- readonly compositionAndFolderOrder: readonly CompositionAndFolderOrderItem[];
- }[];
-};
-
-export const getFolderOrderId = ({
- name,
- parent,
-}: {
- readonly name: string;
- readonly parent: string | null;
-}) => [parent, name].filter(Boolean).join('/');
-
-export type CommittedSequenceSnapshot = {
- readonly sequences: readonly TSequence[];
- readonly sequenceIds: readonly string[];
-};
-
-export type CommittedCompositionSnapshot = {
- readonly compositions: readonly AnyComposition[];
- readonly folders: readonly TFolder[];
- readonly orderIds: readonly string[];
-};
-
-export const SequenceOrderMarker: React.FC<{
- readonly children: React.ReactNode;
- readonly sequenceId: string;
- readonly registration: TSequence | null;
- readonly outlineChildrenRef: React.RefObject<Element | null> | null;
-}> = ({children}) => children;
-
-Object.defineProperty(SequenceOrderMarker, SEQUENCE_ORDER_MARKER, {
- value: true,
-});
-
-export const SequenceManagerOrderMarker: React.FC<{
- readonly children: React.ReactNode;
- readonly managerId: string;
- readonly onCommitSequences:
- | ((
- sequences: readonly TSequence[],
- sequenceIds: readonly string[],
- ) => void)
- | null;
-}> = ({children}) => children;
-
-Object.defineProperty(
- SequenceManagerOrderMarker,
- SEQUENCE_MANAGER_ORDER_MARKER,
- {
- value: true,
- },
-);
-
-export const CompositionOrderMarker: React.FC<{
- readonly children: React.ReactNode;
- readonly compositionId: string;
- readonly registration: AnyComposition | null;
-}> = ({children, registration}) => {
- useCommittedCompositionEntry(
- useMemo(
- () =>
- registration === null
- ? null
- : {type: 'composition' as const, value: registration},
- [registration],
- ),
- );
- return children;
-};
-
-Object.defineProperty(CompositionOrderMarker, COMPOSITION_ORDER_MARKER, {
- value: true,
-});
-
-export const FolderOrderMarker: React.FC<{
- readonly children: React.ReactNode;
- readonly folderId: string;
- readonly registration: TFolder | null;
-}> = ({children, registration}) => {
- useCommittedCompositionEntry(
- useMemo(
- () =>
- registration === null
- ? null
- : {type: 'folder' as const, value: registration},
- [registration],
- ),
- );
- return children;
-};
-
-Object.defineProperty(FolderOrderMarker, FOLDER_ORDER_MARKER, {
- value: true,
-});
-
-export const CompositionManagerOrderMarker: React.FC<{
- readonly children: React.ReactNode;
- readonly managerId: string;
- readonly onCommitRegistrations:
- | ((snapshot: CommittedCompositionSnapshot) => void)
- | null;
-}> = ({children}) => children;
-
-Object.defineProperty(
- CompositionManagerOrderMarker,
- COMPOSITION_MANAGER_ORDER_MARKER,
- {value: true},
-);
-
-export const CommitOrderInternals = {
- compositionManagerMarker: COMPOSITION_MANAGER_ORDER_MARKER,
- compositionMarker: COMPOSITION_ORDER_MARKER,
- folderMarker: FOLDER_ORDER_MARKER,
- sequenceManagerMarker: SEQUENCE_MANAGER_ORDER_MARKER,
- sequenceMarker: SEQUENCE_ORDER_MARKER,
- eventName: COMMIT_ORDER_EVENT,
- installationMarker: COMMIT_OBSERVER_INSTALLATION_MARKER,
- failureMarker: COMMIT_OBSERVER_FAILURE_MARKER,
- registrationErrorEventName: COMMIT_REGISTRATION_ERROR_EVENT,
-};
diff --git a/packages/core/src/test/composition-manager-order.test.tsx b/packages/core/src/test/composition-manager-order.test.tsx
index f018b0b168..5630c5cdfa 100644
--- a/packages/core/src/test/composition-manager-order.test.tsx
+++ b/packages/core/src/test/composition-manager-order.test.tsx
@@ -1,6 +1,10 @@
import {afterEach, expect, test} from 'bun:test';
import {act, cleanup, render, waitFor} from '@testing-library/react';
import React, {useContext} from 'react';
+import {
+ CommittedMetadataInternals,
+ type CommittedCompositionSnapshot,
+} from '../committed-metadata.js';
import {Composition} from '../Composition.js';
import type {AnyComposition} from '../CompositionManager.js';
import type {CompositionManagerContext} from '../CompositionManagerContext.js';
@@ -8,13 +12,6 @@ import {CompositionManager} from '../CompositionManagerContext.js';
import {CompositionManagerProvider} from '../CompositionManagerProvider.js';
import {Folder, type TFolder} from '../Folder.js';
import {RemotionEnvironmentContext} from '../remotion-environment-context.js';
-import {
- CommitOrderInternals,
- CompositionManagerOrderMarker,
- CompositionOrderMarker,
- FolderOrderMarker,
- type CommittedCompositionSnapshot,
-} from '../sequence-order-marker.js';
afterEach(() => {
cleanup();
@@ -25,7 +22,7 @@ const AnyComp: React.FC = () => null;
test('applies committed composition and folder order', async () => {
const previousHook = Reflect.get(window, '__REACT_DEVTOOLS_GLOBAL_HOOK__');
Reflect.set(window, '__REACT_DEVTOOLS_GLOBAL_HOOK__', {
- [CommitOrderInternals.installationMarker]: true,
+ [CommittedMetadataInternals.installationMarker]: true,
});
let context: CompositionManagerContext | null = null;
const CaptureContext: React.FC = () => {
@@ -76,7 +73,6 @@ test('applies committed composition and folder order', async () => {
// ReactDOM has already initialized without this test's DevTools hook.
// Deliver the committed descriptors at the observer's manager boundary.
type Fiber = {
- readonly type: unknown;
readonly memoizedProps: unknown;
readonly child: Fiber | null;
readonly sibling: Fiber | null;
@@ -98,26 +94,15 @@ test('applies committed composition and folder order', async () => {
null;
while (pending.length > 0) {
const node = pending.pop()!;
- if (node.type === CompositionManagerOrderMarker) {
- onCommit = (
- node.memoizedProps as React.ComponentProps<
- typeof CompositionManagerOrderMarker
- >
- ).onCommitRegistrations;
- } else if (node.type === CompositionOrderMarker) {
- const {registration} = node.memoizedProps as React.ComponentProps<
- typeof CompositionOrderMarker
- >;
- if (registration !== null) {
- compositions.push(registration);
- }
- } else if (node.type === FolderOrderMarker) {
- const {registration} = node.memoizedProps as React.ComponentProps<
- typeof FolderOrderMarker
- >;
- if (registration !== null) {
- folders.push(registration);
- }
+ const metadata = CommittedMetadataInternals.getMetadata(
+ node.memoizedProps,
+ );
+ if (metadata?.type === 'composition-manager') {
+ onCommit = metadata.onCommit;
+ } else if (metadata?.type === 'composition') {
+ compositions.push(metadata.value);
+ } else if (metadata?.type === 'folder') {
+ folders.push(metadata.value);
}
if (node.sibling !== null) {
diff --git a/packages/core/src/use-media-in-timeline.ts b/packages/core/src/use-media-in-timeline.ts
index f57cf8923c..7e4e129a3e 100644
--- a/packages/core/src/use-media-in-timeline.ts
+++ b/packages/core/src/use-media-in-timeline.ts
@@ -350,7 +350,7 @@ export const useMediaInTimelineRegistration = ({
};
// Outline-only helper. Internal registration consumers use the full descriptor
-// returned by useMediaInTimelineRegistration and render SequenceOrderMarker.
+// returned by useMediaInTimelineRegistration and attach committed metadata.
export const useMediaInTimeline = (
props: Parameters<typeof useMediaInTimelineRegistration>[0],
) => useMediaInTimelineRegistration(props).automaticOutlineRef;
diff --git a/packages/core/src/video/VideoForPreview.tsx b/packages/core/src/video/VideoForPreview.tsx
index e80b6a1474..69ec3fe636 100644
--- a/packages/core/src/video/VideoForPreview.tsx
+++ b/packages/core/src/video/VideoForPreview.tsx
@@ -13,11 +13,14 @@ import {SharedAudioContext} from '../audio/shared-audio-tags.js';
import {makeSharedElementSourceNode} from '../audio/shared-element-source-node.js';
import {useFrameForVolumeProp} from '../audio/use-audio-frame.js';
import {useMediaAudioState} from '../audio/use-media-audio-state.js';
+import {
+ CommittedMetadataProvider,
+ type CommittedMetadata,
+} from '../committed-metadata.js';
import {getCrossOriginValue} from '../get-cross-origin-value.js';
import {useLogLevel, useMountTime} from '../log-level-context.js';
import {playbackLogging} from '../playback-logging.js';
import {usePreload} from '../prefetch.js';
-import {SequenceOrderMarker} from '../sequence-order-marker.js';
import {SequenceContext} from '../SequenceContext.js';
import {useVolume} from '../use-amplification.js';
import {useMediaInTimelineRegistration} from '../use-media-in-timeline.js';
@@ -371,14 +374,23 @@ const VideoForDevelopmentRefForwardingFunction: React.ForwardRefRenderFunction<
/>
);
+ const metadata = useMemo<CommittedMetadata | null>(
+ () =>
+ isStudio || automaticOutlineRef || registration !== null
+ ? {
+ type: 'sequence',
+ id: timelineId,
+ value: registration,
+ outlineChildrenRef: automaticOutlineRef,
+ }
+ : null,
+ [automaticOutlineRef, isStudio, registration, timelineId],
+ );
+
return isStudio || automaticOutlineRef || registration !== null ? (
- <SequenceOrderMarker
- sequenceId={timelineId}
- registration={registration}
- outlineChildrenRef={automaticOutlineRef}
- >
+ <CommittedMetadataProvider value={null} _remotionCommitMetadata={metadata}>
{video}
- </SequenceOrderMarker>
+ </CommittedMetadataProvider>
) : (
video
);
diff --git a/packages/core/src/wrap-remotion-context.tsx b/packages/core/src/wrap-remotion-context.tsx
index 5691b0620c..deaf673eda 100644
--- a/packages/core/src/wrap-remotion-context.tsx
+++ b/packages/core/src/wrap-remotion-context.tsx
@@ -5,6 +5,12 @@
import React, {useCallback, useMemo, useRef, useState} from 'react';
import {BufferingContextReact} from './buffering.js';
import {CanUseRemotionHooks} from './CanUseRemotionHooks.js';
+import {
+ COMMIT_REGISTRATION_ERROR_EVENT,
+ isCommitRegistrationObserverInstalled,
+ withCommittedMetadata,
+ type CommittedMetadata,
+} from './committed-metadata.js';
import type {TSequence} from './CompositionManager.js';
import {CompositionManager} from './CompositionManagerContext.js';
import {LogLevelContext} from './log-level-context.js';
@@ -12,11 +18,6 @@ import {PreloadContext} from './prefetch-state.js';
import {RemotionEnvironmentContext} from './remotion-environment-context.js';
import {RenderAssetManager} from './RenderAssetManager.js';
import {ResolveCompositionContext} from './ResolveCompositionConfig.js';
-import {
- COMMIT_REGISTRATION_ERROR_EVENT,
- isCommitRegistrationObserverInstalled,
- SequenceManagerOrderMarker,
-} from './sequence-order-marker.js';
import {SequenceContext} from './SequenceContext.js';
import {
SequenceManagerActionsContext,
@@ -123,6 +124,10 @@ export interface RemotionContextProviderProps {
readonly children: React.ReactNode;
}
+const SequenceRegistryScopeProvider = withCommittedMetadata(
+ SequenceRegistryScopeContext.Provider,
+);
+
const ForwardedSequenceRegistry: React.FC<RemotionContextProviderProps> = ({
contexts,
children,
@@ -194,7 +199,7 @@ const ForwardedSequenceRegistry: React.FC<RemotionContextProviderProps> = ({
return () => {
unmountedRef.current = true;
window.removeEventListener(COMMIT_REGISTRATION_ERROR_EVENT, onFailure);
- // Strict Mode and Fast Refresh restart effects without removing the marker.
+ // Strict Mode and Fast Refresh restart effects without removing the provider.
queueMicrotask(() => {
if (
activeRegistryRef.current !== registry ||
@@ -205,25 +210,31 @@ const ForwardedSequenceRegistry: React.FC<RemotionContextProviderProps> = ({
});
};
}, [scope, scopeId, registry, commitRegistrationEnabled]);
+ const metadata = useMemo<CommittedMetadata>(
+ () => ({
+ type: 'sequence-manager',
+ id: scopeId,
+ onCommit: commitRegistrationEnabled ? onCommitSequences : null,
+ }),
+ [commitRegistrationEnabled, onCommitSequences, scopeId],
+ );
return (
- <SequenceManagerOrderMarker
- managerId={scopeId}
- onCommitSequences={commitRegistrationEnabled ? onCommitSequences : null}
+ <SequenceRegistryScopeProvider
+ value={scope}
+ _remotionCommitMetadata={metadata}
>
- <SequenceRegistryScopeContext.Provider value={scope}>
- <SequenceManagerActionsContext.Provider
- value={contexts.sequenceManagerActionsContext}
- >
- <SequenceRegistryContext.Provider value={registry}>
- <SequenceCommitRegistrationContext.Provider
- value={commitRegistrationEnabled}
- >
- {children}
- </SequenceCommitRegistrationContext.Provider>
- </SequenceRegistryContext.Provider>
- </SequenceManagerActionsContext.Provider>
- </SequenceRegistryScopeContext.Provider>
- </SequenceManagerOrderMarker>
+ <SequenceManagerActionsContext.Provider
+ value={contexts.sequenceManagerActionsContext}
+ >
+ <SequenceRegistryContext.Provider value={registry}>
+ <SequenceCommitRegistrationContext.Provider
+ value={commitRegistrationEnabled}
+ >
+ {children}
+ </SequenceCommitRegistrationContext.Provider>
+ </SequenceRegistryContext.Provider>
+ </SequenceManagerActionsContext.Provider>
+ </SequenceRegistryScopeProvider>
);
};
diff --git a/packages/sdk/src/install-fiber-sequence-order-observer.ts b/packages/sdk/src/install-fiber-sequence-order-observer.ts
index 62dde6e4e9..217bc774e2 100644
--- a/packages/sdk/src/install-fiber-sequence-order-observer.ts
+++ b/packages/sdk/src/install-fiber-sequence-order-observer.ts
@@ -4,10 +4,8 @@ import {Internals} from 'remotion';
type Fiber = {
readonly child: Fiber | null;
- readonly elementType: unknown;
readonly memoizedProps: unknown;
readonly sibling: Fiber | null;
- readonly type: unknown;
readonly tag: number | null;
readonly stateNode: unknown;
readonly memoizedState: unknown;
@@ -34,7 +32,7 @@ type HookTarget = Window &
__REACT_DEVTOOLS_GLOBAL_HOOK__?: DevToolsHook;
};
-const {installationMarker} = Internals.CommitOrderInternals;
+const {installationMarker} = Internals.CommittedMetadataInternals;
type CommittedSequenceRegistration = {
readonly onCommit: (
@@ -90,26 +88,6 @@ type CompositionAndFolderOrderItem =
| {readonly type: 'composition'; readonly id: string}
| {readonly type: 'folder'; readonly id: string};
-const hasMarker = (candidate: unknown, marker: symbol): boolean => {
- return (
- (typeof candidate === 'function' ||
- (typeof candidate === 'object' && candidate !== null)) &&
- Reflect.get(candidate, marker) === true
- );
-};
-
-const getStringProp = (props: unknown, key: string): string | null => {
- if (typeof props !== 'object' || props === null) {
- return null;
- }
-
- const value = Reflect.get(props, key);
- return typeof value === 'string' ? value : null;
-};
-
-const hasFiberMarker = (fiber: Fiber, marker: symbol) =>
- hasMarker(fiber.type, marker) || hasMarker(fiber.elementType, marker);
-
export const collectCommitOrderFromFiber = (
root: FiberRoot,
registrations: Map<string, CommittedSequenceRegistration> | null = null,
@@ -174,33 +152,27 @@ export const collectCommitOrderFromFiber = (
currentCompositionManagerId: string | null,
outlineCollectors: readonly (Element | Text)[][] | null,
) => {
- const isSequenceManagerMarker = hasFiberMarker(
- fiber,
- Internals.CommitOrderInternals.sequenceManagerMarker,
+ const metadata = Internals.CommittedMetadataInternals.getMetadata(
+ fiber.memoizedProps,
);
- const sequenceManagerId = isSequenceManagerMarker
- ? getStringProp(fiber.memoizedProps, 'managerId')
- : currentSequenceManagerId;
-
+ const sequenceManagerId =
+ metadata?.type === 'sequence-manager'
+ ? metadata.id
+ : currentSequenceManagerId;
if (
- isSequenceManagerMarker &&
- sequenceManagerId !== null &&
- !sequencesByManager.has(sequenceManagerId)
+ metadata?.type === 'sequence-manager' &&
+ !sequencesByManager.has(metadata.id)
) {
- const previous = previousRegistrations?.get(sequenceManagerId) ?? null;
- const props = fiber.memoizedProps;
- const onCommit =
- typeof props === 'object' && props !== null
- ? Reflect.get(props, 'onCommitSequences')
- : null;
- sequencesByManager.set(sequenceManagerId, {
+ const previous = previousRegistrations?.get(metadata.id) ?? null;
+ const {onCommit} = metadata;
+ sequencesByManager.set(metadata.id, {
sequenceIds: createCommitSnapshotCollector(
previous?.sequenceIds ?? null,
),
registration:
- registrations !== null && typeof onCommit === 'function'
+ registrations !== null && onCommit !== null
? {
- onCommit: onCommit as CommittedSequenceRegistration['onCommit'],
+ onCommit,
sequences: createCommitSnapshotCollector(
previous?.sequences ?? null,
),
@@ -210,32 +182,23 @@ export const collectCommitOrderFromFiber = (
});
}
- const isCompositionManagerMarker = hasFiberMarker(
- fiber,
- Internals.CommitOrderInternals.compositionManagerMarker,
- );
- const compositionManagerId = isCompositionManagerMarker
- ? getStringProp(fiber.memoizedProps, 'managerId')
- : currentCompositionManagerId;
+ const compositionManagerId =
+ metadata?.type === 'composition-manager'
+ ? metadata.id
+ : currentCompositionManagerId;
if (
- isCompositionManagerMarker &&
- compositionManagerId !== null &&
- !compositionsAndFoldersByManager.has(compositionManagerId)
+ metadata?.type === 'composition-manager' &&
+ !compositionsAndFoldersByManager.has(metadata.id)
) {
const previous =
- previousCompositionRegistrations?.get(compositionManagerId) ?? null;
- const props = fiber.memoizedProps;
- const onCommit =
- typeof props === 'object' && props !== null
- ? Reflect.get(props, 'onCommitRegistrations')
- : null;
- compositionsAndFoldersByManager.set(compositionManagerId, {
+ previousCompositionRegistrations?.get(metadata.id) ?? null;
+ const {onCommit} = metadata;
+ compositionsAndFoldersByManager.set(metadata.id, {
order: [],
registration:
- compositionRegistrations !== null && typeof onCommit === 'function'
+ compositionRegistrations !== null && onCommit !== null
? {
- onCommit:
- onCommit as CommittedCompositionRegistration['onCommit'],
+ onCommit,
previous,
compositions: createCommitSnapshotCollector(
previous?.snapshot.compositions ?? null,
@@ -251,76 +214,25 @@ export const collectCommitOrderFromFiber = (
});
}
- const isSequenceMarker = hasFiberMarker(
- fiber,
- Internals.CommitOrderInternals.sequenceMarker,
- );
- if (isSequenceMarker) {
- const props = fiber.memoizedProps;
- if (sequenceManagerId !== null) {
- const sequenceId = getStringProp(fiber.memoizedProps, 'sequenceId');
- if (sequenceId !== null) {
- const manager = sequencesByManager.get(sequenceManagerId);
- manager?.sequenceIds.push(sequenceId);
- const registration =
- typeof props === 'object' && props !== null
- ? (Reflect.get(props, 'registration') as
- | TSequence
- | null
- | undefined)
- : null;
- if (registration) {
- manager?.registration?.sequences.push(registration);
- }
- }
- }
- }
-
- if (
- hasFiberMarker(fiber, Internals.CommitOrderInternals.compositionMarker) &&
- compositionManagerId !== null
- ) {
- const id = getStringProp(fiber.memoizedProps, 'compositionId');
- if (id !== null) {
- const manager =
- compositionsAndFoldersByManager.get(compositionManagerId);
- manager?.order.push({type: 'composition', id});
- manager?.registration?.orderIds.push(`composition:${id}`);
- const registration =
- typeof fiber.memoizedProps === 'object' &&
- fiber.memoizedProps !== null
- ? (Reflect.get(
- fiber.memoizedProps,
- 'registration',
- ) as AnyComposition | null)
- : null;
- if (registration) {
- manager?.registration?.compositions.push(registration);
- }
+ if (metadata?.type === 'sequence' && sequenceManagerId !== null) {
+ const manager = sequencesByManager.get(sequenceManagerId);
+ manager?.sequenceIds.push(metadata.id);
+ if (metadata.value !== null) {
+ manager?.registration?.sequences.push(metadata.value);
}
}
if (
- hasFiberMarker(fiber, Internals.CommitOrderInternals.folderMarker) &&
+ (metadata?.type === 'composition' || metadata?.type === 'folder') &&
compositionManagerId !== null
) {
- const id = getStringProp(fiber.memoizedProps, 'folderId');
- if (id !== null) {
- const manager =
- compositionsAndFoldersByManager.get(compositionManagerId);
- manager?.order.push({type: 'folder', id});
- manager?.registration?.orderIds.push(`folder:${id}`);
- const registration =
- typeof fiber.memoizedProps === 'object' &&
- fiber.memoizedProps !== null
- ? (Reflect.get(
- fiber.memoizedProps,
- 'registration',
- ) as FolderRegistration | null)
- : null;
- if (registration) {
- manager?.registration?.folders.push(registration);
- }
+ const manager = compositionsAndFoldersByManager.get(compositionManagerId);
+ manager?.order.push({type: metadata.type, id: metadata.id});
+ manager?.registration?.orderIds.push(`${metadata.type}:${metadata.id}`);
+ if (metadata.type === 'composition') {
+ manager?.registration?.compositions.push(metadata.value);
+ } else {
+ manager?.registration?.folders.push(metadata.value);
}
}
@@ -340,16 +252,9 @@ export const collectCommitOrderFromFiber = (
: tag === 4
? []
: outlineCollectors;
- if (isSequenceMarker) {
- const props = fiber.memoizedProps;
- const outlineRef =
- typeof props === 'object' && props !== null
- ? (Reflect.get(props, 'outlineChildrenRef') as
- | RefObject<Element | null>
- | null
- | undefined)
- : null;
- if (outlineRef) {
+ if (metadata?.type === 'sequence') {
+ const outlineRef = metadata.outlineChildrenRef;
+ if (outlineRef !== null) {
const nodes: (Element | Text)[] = [];
outlineNodesByRef.set(outlineRef, nodes);
if (childOutlineCollectors !== null) {
@@ -543,12 +448,12 @@ export const installFiberCommitOrderObserver = (
} catch {
// A registration collection or delivery failure permanently selects effect
// fallback for this hook. Retrying registration would risk repeated teardown.
- hook[Internals.CommitOrderInternals.failureMarker] = true;
+ hook[Internals.CommittedMetadataInternals.failureMarker] = true;
order = null;
try {
target.dispatchEvent(
new CustomEvent(
- Internals.CommitOrderInternals.registrationErrorEventName,
+ Internals.CommittedMetadataInternals.registrationErrorEventName,
),
);
} catch {
@@ -564,7 +469,7 @@ export const installFiberCommitOrderObserver = (
) {
try {
target.dispatchEvent(
- new CustomEvent(Internals.CommitOrderInternals.eventName, {
+ new CustomEvent(Internals.CommittedMetadataInternals.eventName, {
detail: {
sequenceManagers: order.sequenceManagers,
compositionManagers: order.compositionManagers,
diff --git a/packages/sdk/src/use-canvas-outline-measurements.ts b/packages/sdk/src/use-canvas-outline-measurements.ts
index 7ee14c68af..b8f6442657 100644
--- a/packages/sdk/src/use-canvas-outline-measurements.ts
+++ b/packages/sdk/src/use-canvas-outline-measurements.ts
@@ -108,7 +108,7 @@ export const useCanvasOutlineMeasurements = ({
if (hasAutomaticTargets) {
latestUpdateRef.current = scheduleUpdate;
ownerWindow?.addEventListener(
- Internals.CommitOrderInternals.eventName,
+ Internals.CommittedMetadataInternals.eventName,
scheduleUpdate,
);
scheduleUpdate();
@@ -119,7 +119,7 @@ export const useCanvasOutlineMeasurements = ({
return () => {
active = false;
ownerWindow?.removeEventListener(
- Internals.CommitOrderInternals.eventName,
+ Internals.CommittedMetadataInternals.eventName,
scheduleUpdate,
);
latestUpdateRef.current = () => undefined;
diff --git a/packages/studio/src/test/fiber-sequence-order-observer.test.ts b/packages/studio/src/test/fiber-sequence-order-observer.test.ts
index dbab280c9f..fa4d3f713e 100644
--- a/packages/studio/src/test/fiber-sequence-order-observer.test.ts
+++ b/packages/studio/src/test/fiber-sequence-order-observer.test.ts
@@ -7,21 +7,17 @@ const {collectCommitOrderFromFiber, installFiberCommitOrderObserver} =
type TestFiber = {
child: TestFiber | null;
- elementType: unknown;
memoizedProps: unknown;
sibling: TestFiber | null;
- type: unknown;
tag: number | null;
stateNode: unknown;
memoizedState: unknown;
};
const makeFiber = ({
- type = null,
props = {},
children = [],
}: {
- type?: unknown;
props?: unknown;
children?: TestFiber[];
} = {}): TestFiber => {
@@ -31,22 +27,14 @@ const makeFiber = ({
return {
child: children[0] ?? null,
- elementType: type,
memoizedProps: props,
sibling: null,
- type,
tag: null,
stateNode: null,
memoizedState: null,
};
};
-const makeMarker = (marker: symbol) => {
- const Marker = () => null;
- Object.defineProperty(Marker, marker, {value: true});
- return Marker;
-};
-
const originalHook = Reflect.get(window, '__REACT_DEVTOOLS_GLOBAL_HOOK__');
afterEach(() => {
@@ -58,51 +46,80 @@ afterEach(() => {
});
test('collects sequence, composition, and folder order per manager', () => {
- const SequenceManagerMarker = makeMarker(
- Internals.CommitOrderInternals.sequenceManagerMarker,
- );
- const CompositionManagerMarker = makeMarker(
- Internals.CommitOrderInternals.compositionManagerMarker,
- );
- const SequenceMarker = makeMarker(
- Internals.CommitOrderInternals.sequenceMarker,
- );
- const CompositionMarker = makeMarker(
- Internals.CommitOrderInternals.compositionMarker,
- );
- const FolderMarker = makeMarker(Internals.CommitOrderInternals.folderMarker);
const root = {
current: makeFiber({
children: [
makeFiber({
- type: CompositionManagerMarker,
- props: {managerId: 'compositions'},
+ props: {
+ _remotionCommitMetadata: {
+ type: 'composition-manager',
+ id: 'compositions',
+ onCommit: null,
+ },
+ },
children: [
makeFiber({
- type: SequenceManagerMarker,
- props: {managerId: 'sequences'},
+ props: {
+ _remotionCommitMetadata: {
+ type: 'sequence-manager',
+ id: 'sequences',
+ onCommit: null,
+ },
+ },
children: [
makeFiber({
- type: FolderMarker,
- props: {folderId: 'group'},
+ props: {
+ _remotionCommitMetadata: {
+ type: 'folder',
+ id: 'group',
+ value: {
+ name: 'group',
+ parent: null,
+ order: null,
+ stack: null,
+ },
+ },
+ },
children: [
makeFiber({
- type: CompositionMarker,
- props: {compositionId: 'inside'},
+ props: {
+ _remotionCommitMetadata: {
+ type: 'composition',
+ id: 'inside',
+ value: {id: 'inside'},
+ },
+ },
}),
],
}),
makeFiber({
- type: CompositionMarker,
- props: {compositionId: 'outside'},
+ props: {
+ _remotionCommitMetadata: {
+ type: 'composition',
+ id: 'outside',
+ value: {id: 'outside'},
+ },
+ },
}),
makeFiber({
- type: SequenceMarker,
- props: {sequenceId: 'left'},
+ props: {
+ _remotionCommitMetadata: {
+ type: 'sequence',
+ id: 'left',
+ value: null,
+ outlineChildrenRef: null,
+ },
+ },
}),
makeFiber({
- type: SequenceMarker,
- props: {sequenceId: 'right'},
+ props: {
+ _remotionCommitMetadata: {
+ type: 'sequence',
+ id: 'right',
+ value: null,
+ outlineChildrenRef: null,
+ },
+ },
}),
],
}),
@@ -131,22 +148,27 @@ test('collects sequence, composition, and folder order per manager', () => {
});
test('chains the existing commit hook and emits the committed order once', () => {
- const ManagerMarker = makeMarker(
- Internals.CommitOrderInternals.sequenceManagerMarker,
- );
- const SequenceMarker = makeMarker(
- Internals.CommitOrderInternals.sequenceMarker,
- );
const root = {
current: makeFiber({
children: [
makeFiber({
- type: ManagerMarker,
- props: {managerId: 'manager-a'},
+ props: {
+ _remotionCommitMetadata: {
+ type: 'sequence-manager',
+ id: 'manager-a',
+ onCommit: null,
+ },
+ },
children: [
makeFiber({
- type: SequenceMarker,
- props: {sequenceId: 'first'},
+ props: {
+ _remotionCommitMetadata: {
+ type: 'sequence',
+ id: 'first',
+ value: null,
+ outlineChildrenRef: null,
+ },
+ },
}),
],
}),
@@ -167,7 +189,10 @@ test('chains the existing commit hook and emits the committed order once', () =>
events.push((event as CustomEvent).detail);
};
- window.addEventListener(Internals.CommitOrderInternals.eventName, onOrder);
+ window.addEventListener(
+ Internals.CommittedMetadataInternals.eventName,
+ onOrder,
+ );
try {
expect(installFiberCommitOrderObserver(window)).toBe(true);
@@ -176,7 +201,7 @@ test('chains the existing commit hook and emits the committed order once', () =>
hook.onCommitFiberRoot(1, root, null, false);
} finally {
window.removeEventListener(
- Internals.CommitOrderInternals.eventName,
+ Internals.CommittedMetadataInternals.eventName,
onOrder,
);
}