Skip to content

🎥 Make videos programmatically with React

remotion: Fix image registration loops in read-only Studio

Jonny Burger569d091b1e57
diff --git a/packages/core/src/Img.tsx b/packages/core/src/Img.tsx
index deeac586d0..9db3f276ee 100644
--- a/packages/core/src/Img.tsx
+++ b/packages/core/src/Img.tsx
@@ -2,6 +2,7 @@ import React, {
useCallback,
useContext,
useLayoutEffect,
+ useMemo,
useRef,
useState,
} from 'react';
@@ -384,6 +385,14 @@ const NativeImgInner: React.FC<NativeImgInnerProps> = ({
throw new Error('No "src" prop was passed to <Img>.');
}
+ const isMedia = useMemo(
+ () => ({
+ type: 'image' as const,
+ src,
+ }),
+ [src],
+ );
+
const {
effectivePostmountFor,
effectivePremountFor,
@@ -420,7 +429,7 @@ const NativeImgInner: React.FC<NativeImgInnerProps> = ({
durationInFrames={durationInFrames ?? Infinity}
freeze={freeze}
_remotionInternalDocumentationLink="https://www.remotion.dev/docs/img"
- _remotionInternalIsMedia={{type: 'image', src}}
+ _remotionInternalIsMedia={isMedia}
_remotionInternalPremountDisplay={effectivePremountFor || null}
_remotionInternalPostmountDisplay={effectivePostmountFor || null}
_remotionInternalIsPremounting={premountingActive}
diff --git a/packages/core/src/canvas-image/CanvasImage.tsx b/packages/core/src/canvas-image/CanvasImage.tsx
index d2ec9e1655..af2f1c6592 100644
--- a/packages/core/src/canvas-image/CanvasImage.tsx
+++ b/packages/core/src/canvas-image/CanvasImage.tsx
@@ -567,6 +567,14 @@ const CanvasImageInner = forwardRef<
throw new Error('No "src" prop was passed to <CanvasImage>.');
}
+ const isMedia = useMemo(
+ () => ({
+ type: 'image' as const,
+ src,
+ }),
+ [src],
+ );
+
const memoizedEffectDefinitions = useMemoizedEffectDefinitions(effects);
const actualRef = useRef<HTMLCanvasElement | null>(null);
useImperativeHandle(ref, () => {
@@ -616,7 +624,7 @@ const CanvasImageInner = forwardRef<
}
controls={controls}
_remotionInternalEffects={memoizedEffectDefinitions}
- _remotionInternalIsMedia={{type: 'image', src}}
+ _remotionInternalIsMedia={isMedia}
_remotionInternalPremountDisplay={effectivePremountFor || null}
_remotionInternalPostmountDisplay={effectivePostmountFor || null}
_remotionInternalIsPremounting={premountingActive}
diff --git a/packages/core/src/test/canvas-image.test.tsx b/packages/core/src/test/canvas-image.test.tsx
index b9484d2009..d054d811ba 100644
--- a/packages/core/src/test/canvas-image.test.tsx
+++ b/packages/core/src/test/canvas-image.test.tsx
@@ -9,6 +9,7 @@ import type {
EffectDefinition,
EffectDescriptor,
} from '../effects/effect-types.js';
+import {Img} from '../Img.js';
import {Internals} from '../internals.js';
import type {SequenceContextType} from '../SequenceContext.js';
import {SequenceContext} from '../SequenceContext.js';
@@ -231,6 +232,79 @@ test('<CanvasImage> renders a canvas element with the decoded image dimensions',
});
});
+test('image registrations settle after resizing and update when the source changes', async () => {
+ let renders = 0;
+ const Previews: React.FC<{readonly src: string; readonly width: number}> = ({
+ src,
+ width,
+ }) => {
+ const {sequences} = React.useContext(SequenceManager);
+ renders++;
+ // Fail a passive-effect loop instead of letting it hang the test.
+ if (renders > 20) {
+ throw new Error('Image sequence registrations did not settle');
+ }
+
+ return (
+ <>
+ <Img src={src} name="Native image" alt="Image preview" width={width} />
+ <CanvasImage
+ src={src}
+ name="Canvas image"
+ aria-label="Canvas preview"
+ width={width}
+ height={50}
+ />
+ <output>
+ {sequences
+ .filter((sequence) => sequence.type === 'image')
+ .map((sequence) => `${sequence.displayName}: ${sequence.src}`)
+ .join(' | ')}
+ </output>
+ </>
+ );
+ };
+
+ const renderImages = (src: string, width: number) => (
+ <Internals.RemotionEnvironmentContext
+ value={{...studioEnv, isReadOnlyStudio: true}}
+ >
+ <WrapSequenceContext>
+ <Previews src={src} width={width} />
+ </WrapSequenceContext>
+ </Internals.RemotionEnvironmentContext>
+ );
+ const rendered = render(renderImages('first.png', 100));
+
+ expect(
+ rendered.getByText('Native image: first.png | Canvas image: first.png'),
+ ).toBeTruthy();
+
+ rendered.rerender(renderImages('first.png', 200));
+ expect(rendered.getByAltText('Image preview').getAttribute('width')).toBe(
+ '200',
+ );
+ expect(rendered.getByLabelText('Canvas preview').getAttribute('width')).toBe(
+ '200',
+ );
+
+ rendered.rerender(renderImages('second.png', 200));
+ expect(
+ rendered.getByText('Native image: second.png | Canvas image: second.png'),
+ ).toBeTruthy();
+ expect(rendered.getByAltText('Image preview').getAttribute('src')).toBe(
+ 'second.png',
+ );
+ await waitFor(() => {
+ expect(
+ drawImageCalls.some(
+ ({args}) =>
+ args[0] instanceof MockImage && args[0].src === 'second.png',
+ ),
+ ).toBe(true);
+ });
+});
+
test('<CanvasImage> forwards crossOrigin to its image loader', async () => {
render(
<WrapSequenceContext>