Skip to content

🎥 Make videos programmatically with React

`remotion`: Fix crashes when reactivating hidden sequences

Igor Samokhovets83dbecee4650
diff --git a/packages/core/src/SequenceActivityBoundary.tsx b/packages/core/src/SequenceActivityBoundary.tsx
index 16b30faaee..eba4f140c3 100644
--- a/packages/core/src/SequenceActivityBoundary.tsx
+++ b/packages/core/src/SequenceActivityBoundary.tsx
@@ -1,7 +1,8 @@
-import React, {useContext, useMemo} from 'react';
+import React, {useContext, useMemo, useState} from 'react';
import {
SequenceActivityAbsoluteTimeContext,
SequenceActivityDormantContext,
+ SequenceActivityGenerationContext,
SequenceActivitySuspensionContext,
SequenceActivityTimelineContext,
} from './sequence-activity-context.js';
@@ -92,6 +93,17 @@ export const SequenceActivityBoundary: React.FC<{
readonly frame: number;
}> = ({children, dormant, frame}) => {
const parentDormant = useContext(SequenceActivityDormantContext);
+ const parentGeneration = useContext(SequenceActivityGenerationContext);
+ const [activity, setActivity] = useState({dormant, generation: 0});
+ if (activity.dormant !== dormant) {
+ // Hidden trees can suspend before SequenceContent renders null. Give
+ // resource-owning content a fresh identity even if that render is skipped.
+ setActivity({
+ dormant,
+ generation: activity.generation + (dormant ? 1 : 0),
+ });
+ }
+
const timeline = useContext(
parentDormant ? SequenceActivityTimelineContext : TimelineContext,
);
@@ -134,9 +146,13 @@ export const SequenceActivityBoundary: React.FC<{
<React.Activity
mode={dormant && !parentDormant ? 'hidden' : 'visible'}
>
- <SuspendSequenceActivity dormant={dormant}>
- {children}
- </SuspendSequenceActivity>
+ <SequenceActivityGenerationContext.Provider
+ value={parentGeneration + activity.generation}
+ >
+ <SuspendSequenceActivity dormant={dormant}>
+ {children}
+ </SuspendSequenceActivity>
+ </SequenceActivityGenerationContext.Provider>
</React.Activity>
</AbsoluteTimeContext.Provider>
</TimelineContext.Provider>
diff --git a/packages/core/src/sequence-activity-context.ts b/packages/core/src/sequence-activity-context.ts
index 9f0b0e71d5..63d6b8c810 100644
--- a/packages/core/src/sequence-activity-context.ts
+++ b/packages/core/src/sequence-activity-context.ts
@@ -1,4 +1,4 @@
-import {createContext, useContext} from 'react';
+import {createContext, createElement, Fragment, useContext} from 'react';
import type {TimelineContextValue} from './TimelineContext.js';
export {DEFAULT_SEQUENCE_ACTIVITY_LIMIT} from './sequence-activity-defaults.js';
@@ -7,6 +7,7 @@ export {DEFAULT_SEQUENCE_ACTIVITY_LIMIT} from './sequence-activity-defaults.js';
// when the sequence manager falls back to effects.
export const SequenceActivityContext = createContext(false);
export const SequenceActivityDormantContext = createContext(false);
+export const SequenceActivityGenerationContext = createContext(0);
export const SequenceActivitySuspensionContext = createContext(false);
export const SequenceActivitySettingsContext = createContext<{
readonly limit: number;
@@ -23,5 +24,7 @@ export const SequenceActivityAbsoluteTimeContext =
export const SequenceContent: React.FC<{
readonly children: React.ReactNode;
}> = ({children}) => {
- return useContext(SequenceActivityDormantContext) ? null : children;
+ const dormant = useContext(SequenceActivityDormantContext);
+ const generation = useContext(SequenceActivityGenerationContext);
+ return dormant ? null : createElement(Fragment, {key: generation}, children);
};
diff --git a/packages/maptiler/src/MapRegion.tsx b/packages/maptiler/src/MapRegion.tsx
index 22b66b067c..a551aac56e 100644
--- a/packages/maptiler/src/MapRegion.tsx
+++ b/packages/maptiler/src/MapRegion.tsx
@@ -288,6 +288,11 @@ const MapRegionDrawing = ({
}
return () => {
+ // The viewport's layout cleanup may already have removed the map.
+ if (!map.style) {
+ return;
+ }
+
if (map.getLayer(outlineSourceId)) {
map.removeLayer(outlineSourceId);
}
diff --git a/packages/maptiler/src/MapRoute.tsx b/packages/maptiler/src/MapRoute.tsx
index f1d36a2150..eb0bca0d2e 100644
--- a/packages/maptiler/src/MapRoute.tsx
+++ b/packages/maptiler/src/MapRoute.tsx
@@ -227,6 +227,11 @@ const MapRouteDrawing = ({
}
return () => {
+ // The viewport's layout cleanup may already have removed the map.
+ if (!map.style) {
+ return;
+ }
+
if (map.getLayer(sourceId)) {
map.removeLayer(sourceId);
}
diff --git a/packages/maptiler/src/MapViewport.tsx b/packages/maptiler/src/MapViewport.tsx
index d5f82187ac..ef59ffd8a2 100644
--- a/packages/maptiler/src/MapViewport.tsx
+++ b/packages/maptiler/src/MapViewport.tsx
@@ -4,6 +4,7 @@ import type {ComponentType, CSSProperties, FC, ReactNode} from 'react';
import {useLayoutEffect, useMemo, useRef, useState} from 'react';
import {
Interactive,
+ Internals,
useDelayRender,
type InteractiveBaseProps,
type InteractiveCropProps,
@@ -550,7 +551,11 @@ const MapViewportContent: FC<MapViewportContentProps> = ({
export const MapViewport: ComponentType<MapViewportProps> =
Interactive.withSchema({
- Component: MapViewportContent,
+ Component: (props: MapViewportContentProps) => (
+ <Internals.SequenceContent>
+ <MapViewportContent {...props} />
+ </Internals.SequenceContent>
+ ),
componentName: '<MapViewport>',
schema: mapViewportSchema,
wrapInSequence: true,
diff --git a/packages/maptiler/src/use-map-premounting.ts b/packages/maptiler/src/use-map-premounting.ts
index 07d0aada26..3bca5ef1a4 100644
--- a/packages/maptiler/src/use-map-premounting.ts
+++ b/packages/maptiler/src/use-map-premounting.ts
@@ -14,7 +14,8 @@ export const useMapPremounting = (getLayerIds: () => string[]) => {
layerIdsRef.current = getLayerIds;
const applyPremountVisibility = useCallback(() => {
- if (!map) {
+ // Passive effects may flush after the viewport's layout cleanup.
+ if (!map || !map.style) {
return;
}
diff --git a/packages/three/src/ThreeCanvas.tsx b/packages/three/src/ThreeCanvas.tsx
index 955cfc0b09..9a730d0622 100644
--- a/packages/three/src/ThreeCanvas.tsx
+++ b/packages/three/src/ThreeCanvas.tsx
@@ -1,5 +1,9 @@
import type {RootState} from '@react-three/fiber';
-import {Canvas, useThree} from '@react-three/fiber';
+import {
+ Canvas,
+ events as createPointerEvents,
+ useThree,
+} from '@react-three/fiber';
import React, {
useCallback,
useEffect,
@@ -78,6 +82,7 @@ const ThreeCanvasContent = (props: ThreeCanvasInternalsProps) => {
style,
resize,
frameloop,
+ events = createPointerEvents,
onCreated,
FrameRenderer,
advanceOnCreated,
@@ -88,6 +93,23 @@ const ThreeCanvasContent = (props: ThreeCanvasInternalsProps) => {
const {delayRender, continueRender} = useDelayRender();
const contexts = Internals.useRemotionContexts();
const frame = useCurrentFrame();
+ const createEvents = useCallback<NonNullable<ThreeCanvasProps['events']>>(
+ (store) => {
+ const manager = events(store);
+ const {connect} = manager;
+ return {
+ ...manager,
+ connect: (target) => {
+ // R3F can finish configuring an async renderer after the Canvas
+ // unmounts. Its default event source ref is null by then.
+ if (target) {
+ connect?.(target);
+ }
+ },
+ };
+ },
+ [events],
+ );
// Taken at commit and released on unmount, so a canvas that unmounts before it is
// created, or a render React discards, does not leave the hold open.
@@ -165,6 +187,7 @@ const ThreeCanvasContent = (props: ThreeCanvasInternalsProps) => {
style={actualStyle}
{...rest}
resize={{offsetSize: true, ...resize}}
+ events={createEvents}
frameloop={isRendering ? 'never' : (frameloop ?? 'always')}
onCreated={remotion_onCreated}
>
@@ -236,7 +259,12 @@ export const ThreeCanvasInternals = ({
_remotionInternalIsPremounting={premountingActive}
_remotionInternalIsPostmounting={postmountingActive}
>
- <ThreeCanvasContent {...props} style={premountingStyle ?? undefined} />
+ <Internals.SequenceContent>
+ <ThreeCanvasContent
+ {...props}
+ style={premountingStyle ?? undefined}
+ />
+ </Internals.SequenceContent>
</Sequence>
</Freeze>
);