Skip to content

🎥 Make videos programmatically with React

Move committed metadata reading into SDK

Jonny Burgerfb74cbb36b16
diff --git a/packages/core/src/committed-metadata.ts b/packages/core/src/committed-metadata.ts
index 67a2a1e677..858f143623 100644
--- a/packages/core/src/committed-metadata.ts
+++ b/packages/core/src/committed-metadata.ts
@@ -8,6 +8,7 @@ import type {
import type {AnyComposition, TSequence} from './CompositionManager.js';
import type {TFolder} from './Folder.js';
+const COMMITTED_METADATA_PROP = '_remotionCommitMetadata';
export const COMMIT_ORDER_EVENT = 'remotion:commit-order';
export const COMMIT_REGISTRATION_ERROR_EVENT =
'remotion:commit-registration-error';
@@ -104,7 +105,7 @@ export const withCommittedMetadata = <T>(
provider: Provider<T>,
): ProviderExoticComponent<
ProviderProps<T> & {
- readonly _remotionCommitMetadata: CommittedMetadata | null;
+ readonly [COMMITTED_METADATA_PROP]: CommittedMetadata | null;
}
> => provider;
@@ -114,19 +115,8 @@ 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,
+ metadataProp: COMMITTED_METADATA_PROP as typeof COMMITTED_METADATA_PROP,
eventName: COMMIT_ORDER_EVENT,
installationMarker: COMMIT_OBSERVER_INSTALLATION_MARKER,
failureMarker: COMMIT_OBSERVER_FAILURE_MARKER,
diff --git a/packages/core/src/test/composition-manager-order.test.tsx b/packages/core/src/test/composition-manager-order.test.tsx
index 2a012eaa2d..1e796cd57a 100644
--- a/packages/core/src/test/composition-manager-order.test.tsx
+++ b/packages/core/src/test/composition-manager-order.test.tsx
@@ -4,6 +4,7 @@ import React, {useContext} from 'react';
import {
CommittedMetadataInternals,
type CommittedCompositionSnapshot,
+ type CommittedMetadata,
} from '../committed-metadata.js';
import {Composition} from '../Composition.js';
import {compositionsRef, type AnyComposition} from '../CompositionManager.js';
@@ -94,9 +95,13 @@ test('applies committed composition and folder order', async () => {
null;
while (pending.length > 0) {
const node = pending.pop()!;
- const metadata = CommittedMetadataInternals.getMetadata(
- node.memoizedProps,
- );
+ const metadata =
+ typeof node.memoizedProps === 'object' && node.memoizedProps !== null
+ ? (Reflect.get(
+ node.memoizedProps,
+ CommittedMetadataInternals.metadataProp,
+ ) as CommittedMetadata | null | undefined)
+ : null;
if (metadata?.type === 'composition-manager') {
onCommit = metadata.onCommit;
} else if (metadata?.type === 'composition') {
diff --git a/packages/sdk/src/install-fiber-sequence-order-observer.ts b/packages/sdk/src/install-fiber-sequence-order-observer.ts
index 19f3c9befa..a07c038fbd 100644
--- a/packages/sdk/src/install-fiber-sequence-order-observer.ts
+++ b/packages/sdk/src/install-fiber-sequence-order-observer.ts
@@ -1,4 +1,4 @@
-import type {RefObject} from 'react';
+import type {ComponentProps, RefObject} from 'react';
import type {AnyComposition, TSequence} from 'remotion';
import {Internals} from 'remotion';
@@ -32,7 +32,24 @@ type HookTarget = Window &
__REACT_DEVTOOLS_GLOBAL_HOOK__?: DevToolsHook;
};
-const {installationMarker} = Internals.CommittedMetadataInternals;
+const {installationMarker, metadataProp} = Internals.CommittedMetadataInternals;
+
+type CommittedMetadata = NonNullable<
+ ComponentProps<
+ typeof Internals.CommittedMetadataProvider
+ >[typeof metadataProp]
+>;
+
+const getCommittedMetadata = (props: unknown): CommittedMetadata | null => {
+ if (typeof props !== 'object' || props === null) {
+ return null;
+ }
+
+ const metadata: unknown = Reflect.get(props, metadataProp);
+ return typeof metadata === 'object' && metadata !== null
+ ? (metadata as CommittedMetadata)
+ : null;
+};
type CommittedSequenceRegistration = {
readonly onCommit: (
@@ -147,9 +164,7 @@ export const collectCommitOrderFromFiber = (
currentCompositionManagerId: string | null,
outlineCollectors: readonly (Element | Text)[][] | null,
) => {
- const metadata = Internals.CommittedMetadataInternals.getMetadata(
- fiber.memoizedProps,
- );
+ const metadata = getCommittedMetadata(fiber.memoizedProps);
const sequenceManagerId =
metadata?.type === 'sequence-manager'
? metadata.id