Skip to content

🎥 Make videos programmatically with React

Fix Browser Studio composition drag source paths

Jonny Burgere9b8c4311bde
diff --git a/packages/browser-studio/e2e/app.tsx b/packages/browser-studio/e2e/app.tsx
index defaf8cf60..1b21d48fdc 100644
--- a/packages/browser-studio/e2e/app.tsx
+++ b/packages/browser-studio/e2e/app.tsx
@@ -37,6 +37,25 @@ registerRoot(RemotionRoot);
`;
}
+ if (new URLSearchParams(window.location.search).has('composition-drop')) {
+ project.files['/project/src/Root.tsx'] =
+ `import {Composition} from 'remotion';
+import {Parent} from './Parent';
+import {Child} from './Child';
+export const RemotionRoot = () => <>
+ <Composition id="Parent" component={Parent} width={1280} height={720} fps={30} durationInFrames={120} />
+ <Composition id="Child" component={Child} width={320} height={180} fps={30} durationInFrames={30} defaultProps={{text: 'Nested composition'}} />
+</>;
+`;
+ project.files['/project/src/Parent.tsx'] =
+ `import {AbsoluteFill} from 'remotion';
+export const Parent = () => <AbsoluteFill style={{backgroundColor: 'white'}} />;
+`;
+ project.files['/project/src/Child.tsx'] =
+ `export const Child = ({text}: {text: string}) => <div style={{backgroundColor: 'red', width: '100%', height: '100%'}}>{text}</div>;
+`;
+ }
+
const root = document.getElementById('root');
if (!root) {
throw new Error('Could not find root element');
diff --git a/packages/browser-studio/e2e/browser-studio.test.ts b/packages/browser-studio/e2e/browser-studio.test.ts
index 5bf8f58be3..345edf69da 100644
--- a/packages/browser-studio/e2e/browser-studio.test.ts
+++ b/packages/browser-studio/e2e/browser-studio.test.ts
@@ -1346,3 +1346,106 @@ test('clears hover backgrounds even if pointer leave events are lost', async ({
.poll(() => getBackgroundColor(fileMenu))
.toBe('rgba(0, 0, 0, 0)');
});
+
+for (const target of ['canvas', 'timeline'] as const) {
+ test(`drops a sidebar composition onto the ${target} with undo and redo`, async ({
+ page,
+ }) => {
+ const studioApiRequests: string[] = [];
+ page.on('request', (request) => {
+ if (new URL(request.url()).pathname.startsWith('/api/')) {
+ studioApiRequests.push(request.url());
+ }
+ });
+ await page.goto('/?composition-drop');
+ const studio = page.frameLocator('iframe');
+ await studio.locator('[data-compname="Parent"]').click();
+ await waitForBrowserStudioOperations(studio);
+ const canvas = studio.locator('.remotion-studio-composition-container');
+ await expect(canvas).toBeVisible();
+ const before = await page.evaluate(
+ () => window.__browserStudioProject.files['/project/src/Parent.tsx'],
+ );
+ const child = studio.locator('[data-compname="Child"]');
+ const dataTransfer = await child.evaluateHandle(() => new DataTransfer());
+ await child.dispatchEvent('dragstart', {dataTransfer});
+ const dropTarget =
+ target === 'canvas'
+ ? canvas
+ : studio.locator('[data-timeline-scrollable="true"]');
+ const coordinates = await dropTarget.evaluate((element) => {
+ const rect = element.getBoundingClientRect();
+ return {
+ clientX: rect.x + rect.width / 2,
+ clientY: rect.y + rect.height / 2,
+ };
+ });
+ await dropTarget.dispatchEvent('dragover', {...coordinates, dataTransfer});
+ const indicator =
+ target === 'canvas'
+ ? studio.getByTestId('composition-drop-preview')
+ : studio.locator('[data-timeline-asset-drop-indicator="true"]');
+ await expect(indicator).toBeVisible();
+ const placementPreview = await indicator.boundingBox();
+ await dropTarget.dispatchEvent('drop', {...coordinates, dataTransfer});
+ await child.dispatchEvent('dragend', {dataTransfer});
+ await expect
+ .poll(() =>
+ page.evaluate(
+ () => window.__browserStudioProject.files['/project/src/Parent.tsx'],
+ ),
+ )
+ .toContain('<Child');
+ const source = await page.evaluate(
+ () => window.__browserStudioProject.files['/project/src/Parent.tsx'],
+ );
+ expect(source).toContain('durationInFrames={30}');
+ expect(source).toContain('Nested composition');
+ expect(source).toContain('width={320}');
+ expect(source).toContain('height={180}');
+ if (target === 'timeline') {
+ expect(Number(source.match(/from=\{(\d+)\}/)?.[1])).toBeGreaterThan(0);
+ await studio.locator('[data-timeline-scrollable="true"]').click({
+ position: {
+ x: await dropTarget.evaluate((element) => element.clientWidth / 2),
+ y: 5,
+ },
+ });
+ }
+
+ await expect(canvas.getByText('Nested composition')).toBeVisible();
+ if (target === 'canvas') {
+ const rendered = await canvas
+ .getByText('Nested composition')
+ .boundingBox();
+ expect(rendered).not.toBeNull();
+ expect(placementPreview).not.toBeNull();
+ for (const dimension of ['x', 'y', 'width', 'height'] as const) {
+ expect(rendered![dimension]).toBeCloseTo(
+ placementPreview![dimension],
+ 0,
+ );
+ }
+ }
+
+ await studio.getByTitle(/^Undo/).click();
+ await expect
+ .poll(() =>
+ page.evaluate(
+ () => window.__browserStudioProject.files['/project/src/Parent.tsx'],
+ ),
+ )
+ .toBe(before);
+ await expect(canvas.getByText('Nested composition')).toBeHidden();
+ await studio.getByTitle(/^Redo/).click();
+ await expect
+ .poll(() =>
+ page.evaluate(
+ () => window.__browserStudioProject.files['/project/src/Parent.tsx'],
+ ),
+ )
+ .toBe(source);
+ await expect(canvas.getByText('Nested composition')).toBeVisible();
+ expect(studioApiRequests).toEqual([]);
+ });
+}
diff --git a/packages/studio/src/components/CompositionSelectorItem.tsx b/packages/studio/src/components/CompositionSelectorItem.tsx
index 914761f4b9..7197f664c2 100644
--- a/packages/studio/src/components/CompositionSelectorItem.tsx
+++ b/packages/studio/src/components/CompositionSelectorItem.tsx
@@ -15,6 +15,7 @@ import React, {
useState,
} from 'react';
import {type _InternalTypes} from 'remotion';
+import {getBrowserStudioOperations} from '../helpers/browser-studio-operations';
import {StudioServerConnectionCtx} from '../helpers/client-id';
import {
CURRENT_COLOR,
@@ -412,7 +413,12 @@ export const CompositionSelectorItem: React.FC<{
if (item.type === 'composition') {
const compositionDragData = makeCompositionDragData({
- compositionFile: resolvedLocation?.source ?? null,
+ compositionFile:
+ getBrowserStudioOperations()?.getCompositionFile(
+ item.composition.id,
+ ) ??
+ resolvedLocation?.source ??
+ null,
compositionId: item.composition.id,
width: item.composition.width ?? null,
height: item.composition.height ?? null,