Skip to content

🎥 Make videos programmatically with React

6.0 KB
Raw Blame
import {expect, test} from 'bun:test';
import {StudioProtocolInternals, type MakeDragDataInput} from '../index';

const inputs: MakeDragDataInput[] = [
	{
		type: 'asset',
		assetPath: 'nested/image.png',
		width: 1920,
		height: 1080,
		durationInSeconds: 5,
	},
	{
		type: 'component',
		componentName: 'Circle',
		dimensions: {width: 200, height: 200},
		importName: 'Circle',
		importPath: '@remotion/shapes',
		props: [{name: 'radius', value: 100}],
	},
	{
		type: 'effect',
		name: 'brightness',
		importPath: '@remotion/effects/brightness',
		config: {
			brightness: 1.2,
			channels: ['red', 'green', 'blue'],
			settings: {enabled: true, fallback: null},
		},
	},
	{
		type: 'element',
		dependencies: [{name: '@remotion/google-fonts', version: null}],
		slug: 'overlays/lower-third',
		displayName: 'Lower Third',
		sourceCode: 'export const LowerThird = () => null;',
		dimensions: {width: 900, height: 260},
		durationInFrames: 90,
	},
	{
		type: 'render-output',
		outputPath: 'out/video.mp4',
		fileName: 'video.mp4',
	},
	{
		type: 'sfx',
		name: 'Whip',
		url: 'https://remotion.media/whip.wav',
	},
];

test('constructs and parses all drag data families', () => {
	for (const input of inputs) {
		const constructed = StudioProtocolInternals.makeDragData(input);
		const parsed = StudioProtocolInternals.parseDragData(constructed);

		expect(parsed?.type).toBe(input.type);
		expect(parsed?.data).toEqual(constructed.data);
		expect(constructed.mimeType).toStartWith(
			'application/vnd.remotion.drag+json;v=1;type=',
		);
		expect(JSON.parse(constructed.payload)).toBeObject();
	}
});

test('puts preview metadata in the same MIME type as the payload', () => {
	const constructed = StudioProtocolInternals.makeDragData({
		type: 'component',
		componentName: 'Circle',
		dimensions: {width: 200, height: 200},
		importName: 'Circle',
		importPath: '@remotion/shapes',
		props: [],
	});

	expect(constructed.mimeType).toBe(
		'application/vnd.remotion.drag+json;v=1;type=component;width=200;height=200',
	);
	expect(
		StudioProtocolInternals.getDragPreviewMetadata([
			'text/plain',
			constructed.mimeType,
		]),
	).toEqual({
		type: 'component',
		mimeType: constructed.mimeType,
		width: 200,
		height: 200,
	});
});

test('requires asset metadata and accepts explicit null values', () => {
	const constructed = StudioProtocolInternals.makeDragData({
		type: 'asset',
		assetPath: 'unresolved.png',
		width: null,
		height: null,
		durationInSeconds: null,
	});

	expect(constructed.mimeType).toBe(
		'application/vnd.remotion.drag+json;v=1;type=asset',
	);
	expect(StudioProtocolInternals.parseDragData(constructed)?.preview).toEqual({
		type: 'asset',
	});
	expect(() =>
		// @ts-expect-error JavaScript callers can omit required asset metadata.
		StudioProtocolInternals.makeDragData({
			type: 'asset',
			assetPath: 'missing-metadata.png',
		}),
	).toThrow('must be set to a value or null');
	expect(() =>
		StudioProtocolInternals.makeDragData({
			type: 'asset',
			assetPath: 'partially-resolved.png',
			width: 1920,
			height: null,
			durationInSeconds: null,
		}),
	).toThrow('must either both be numbers or both be null');
});

test('requires a duration for element drags', () => {
	const constructed = StudioProtocolInternals.makeDragData({
		type: 'element',
		dependencies: [],
		slug: 'titles/lower-third',
		displayName: 'Lower Third',
		sourceCode: 'export const LowerThird = () => null;',
		dimensions: null,
		durationInFrames: 90,
	});

	expect(constructed.mimeType).toContain(';duration=90');
	expect(
		StudioProtocolInternals.parseDragData({
			mimeType: 'application/vnd.remotion.drag+json;v=1;type=element',
			payload: constructed.payload,
		}),
	).toBe(null);
	expect(() =>
		// @ts-expect-error JavaScript callers can omit the required duration.
		StudioProtocolInternals.makeDragData({
			type: 'element',
			dependencies: [],
			slug: 'titles/lower-third',
			displayName: 'Lower Third',
			sourceCode: 'export const LowerThird = () => null;',
			dimensions: null,
		}),
	).toThrow('durationInFrames must be an integer');
});

test('rejects malformed and mismatched drag data', () => {
	expect(() =>
		StudioProtocolInternals.makeDragData({
			type: 'effect',
			name: 'brightness',
			importPath: '@remotion/effects/brightness',
			config: {brightness: Number.POSITIVE_INFINITY},
		}),
	).toThrow('Effect config must contain only finite JSON values');
	expect(
		StudioProtocolInternals.parseDragData({
			mimeType: 'application/vnd.remotion.drag+json;v=1;type=effect',
			payload:
				'{"type":"remotion-effect","version":1,"effect":{"name":"brightness","importPath":"@remotion/effects/brightness","config":{"brightness":1e400}}}',
		}),
	).toBe(null);

	const renderOutput = StudioProtocolInternals.makeDragData({
		type: 'render-output',
		outputPath: 'out/video.mp4',
		fileName: 'video.mp4',
	});

	expect(
		StudioProtocolInternals.parseDragData({
			mimeType: renderOutput.mimeType,
			payload: JSON.stringify({...renderOutput.data, fileName: '../video.mp4'}),
		}),
	).toBe(null);

	expect(
		StudioProtocolInternals.parseDragData({
			mimeType:
				'application/vnd.remotion.drag+json;v=1;type=component;width=10;height=10',
			payload: JSON.stringify({
				type: 'remotion-component',
				version: 1,
				component: {
					componentName: 'Circle',
					dimensions: {width: 20, height: 20},
					importName: 'Circle',
					importPath: '@remotion/shapes',
					props: [],
				},
			}),
		}),
	).toBe(null);

	const invalidMimeTypes = [
		'application/vnd.remotion.drag+json;v=2;type=component',
		'application/vnd.remotion.drag+json;v=1;type=composition',
		'application/vnd.remotion.drag+json;v=1;type=unknown',
		'application/vnd.remotion.drag+json;v=1;type=element;width=1920',
		'application/vnd.remotion.drag+json;v=1;type=effect;duration=10',
		'application/vnd.remotion.drag+json;v=1;type=composition;secret=value',
	];

	for (const mimeType of invalidMimeTypes) {
		expect(StudioProtocolInternals.getDragPreviewMetadata([mimeType])).toBe(
			null,
		);
		expect(
			StudioProtocolInternals.parseDragData({mimeType, payload: '{}'}),
		).toBe(null);
	}
});