🎥 Make videos programmatically with React
import {expect, test} from 'bun:test';
import {BrowserSafeApis} from '@remotion/renderer/client';
import {StudioServerInternals} from '@remotion/studio-server';
import type {RspackConfiguration, WebpackConfiguration} from '../config';
import {Config, ConfigInternals} from '../config';
import {getRenderDefaults} from '../get-render-defaults';
test('Studio render defaults keep the startup log level', () => {
ConfigInternals.resetConfigOptions();
Config.setLogLevel('verbose');
expect(getRenderDefaults('warn').logLevel).toBe('warn');
});
test('Element Library configuration must be valid', () => {
ConfigInternals.resetConfigOptions();
expect(() => Config.addElementLibrary({url: '/elements'})).toThrow(
'Config.addElementLibrary() expects an absolute URL',
);
expect(() => Config.addElementLibrary({url: 'file:///tmp/elements'})).toThrow(
'Config.addElementLibrary() only supports HTTP and HTTPS URLs',
);
expect(() =>
Config.addElementLibrary(null as unknown as {url: string}),
).toThrow('Config.addElementLibrary() expects an object');
expect(() =>
Config.addElementLibrary([] as unknown as {url: string}),
).toThrow('Config.addElementLibrary() expects an object, got an array');
expect(() =>
Config.addElementLibrary({url: null as unknown as string}),
).toThrow('Config.addElementLibrary() expects "url" to be a string');
expect(() =>
Config.addElementLibrary({
url: 'https://example.com/elements',
displayName: 123 as unknown as string,
}),
).toThrow(
'Config.addElementLibrary() expects the display name to be a string',
);
expect(() =>
Config.addElementLibrary({
url: 'https://example.com/elements',
displayName: ' ',
}),
).toThrow(
'Config.addElementLibrary() expects the display name to not be empty',
);
});
test('Rspack can be configured using the current and deprecated APIs', () => {
ConfigInternals.resetConfigOptions();
expect(
BrowserSafeApis.options.rspackOption.getValue({commandLine: {}}).value,
).toBe(false);
Config.setRspack(true);
expect(
BrowserSafeApis.options.rspackOption.getValue({commandLine: {}}).value,
).toBe(true);
Config.setExperimentalRspackEnabled(false);
expect(
BrowserSafeApis.options.rspackOption.getValue({commandLine: {}}).value,
).toBe(false);
});
test('reset config options restores defaults before reloading config', async () => {
ConfigInternals.resetConfigOptions();
Config.setStudioPort(4321);
Config.setMaxTimelineTracks(123);
Config.addElementLibrary({
url: 'https://example.com/elements',
displayName: 'Example Elements',
});
Config.setChromiumOpenGlRenderer('angle');
Config.setCrf(12);
Config.setDefaultCodingAgent('codex');
Config.setDefaultEditor('cursor');
Config.setBufferStateDelayInMilliseconds(200);
Config.setAskAIEnabled(false);
Config.setAudioLatencyHint('interactive');
Config.setPreservePitchOnPlayback(false);
Config.setBeepOnFinish(true);
Config.setEnableCrossSiteIsolation(true);
Config.setInteractivityEnabled(false);
Config.setKeyboardShortcutsEnabled(false);
Config.setKeyboardShortcuts({
playPause: {key: 'p'},
quickSwitcher: null,
});
Config.setLogLevel('verbose');
Config.setNumberOfSharedAudioTags(2);
Config.setRspack(true);
Config.setExperimentalKeepAudioContextAlive(true);
Config.overrideBundlerConfig((config, {bundler}) => ({
...config,
name: `shared-${bundler}`,
}));
Config.overrideWebpackConfig((config) => ({
...config,
name: `${config.name}-webpack`,
}));
Config.overrideWebpackConfig((config) => ({
...config,
devtool: 'source-map',
}));
Config.overrideRspackConfig((config) => ({
...config,
name: `${config.name}-rspack`,
}));
expect(ConfigInternals.getStudioPort()).toBe(4321);
expect(StudioServerInternals.getMaxTimelineTracks()).toBe(123);
expect(ConfigInternals.getElementLibraries()).toEqual([
{
displayName: 'Example Elements',
url: 'https://example.com/elements',
captionStylesUrl: null,
},
]);
expect(ConfigInternals.getKeyboardShortcuts()).toEqual({
playPause: {key: 'p'},
quickSwitcher: null,
});
expect(
BrowserSafeApis.options.glOption.getValue({commandLine: {}}).value,
).toBe('angle');
expect(getRenderDefaults('info').crf).toBe(12);
expect(
BrowserSafeApis.options.defaultCodingAgentOption.getValue({
commandLine: {},
}).value,
).toBe('codex');
expect(
BrowserSafeApis.options.defaultEditorOption.getValue({commandLine: {}})
.value,
).toBe('cursor');
expect(ConfigInternals.getBufferStateDelayInMilliseconds()).toBe(200);
expect(BrowserSafeApis.options.askAIOption.getConfigValue()).toBe(false);
expect(
BrowserSafeApis.options.preservePitchOnPlaybackOption.getValue({
commandLine: {},
}).value,
).toBe(false);
expect(BrowserSafeApis.options.audioLatencyHintOption.getConfigValue()).toBe(
'interactive',
);
expect(BrowserSafeApis.options.beepOnFinishOption.getConfigValue()).toBe(
true,
);
expect(
BrowserSafeApis.options.enableCrossSiteIsolationOption.getConfigValue(),
).toBe(true);
expect(BrowserSafeApis.options.interactivityOption.getConfigValue()).toBe(
false,
);
expect(BrowserSafeApis.options.keyboardShortcutsOption.getConfigValue()).toBe(
false,
);
expect(BrowserSafeApis.options.logLevelOption.getConfigValue()).toBe(
'verbose',
);
expect(
BrowserSafeApis.options.numberOfSharedAudioTagsOption.getConfigValue(),
).toBe(2);
expect(BrowserSafeApis.options.rspackOption.getConfigValue()).toBe(true);
expect(StudioServerInternals.getConfiguredMaxTimelineTracks()).toBe(123);
expect(
BrowserSafeApis.options.experimentalKeepAudioContextAliveOption.getValue({
commandLine: {},
}).value,
).toBe(true);
const sharedWebpackConfig = await ConfigInternals.getBundlerOverrideFn()(
{mode: 'development'},
{bundler: 'webpack'},
);
expect(
await ConfigInternals.getWebpackOverrideFn()(
sharedWebpackConfig as WebpackConfiguration,
),
).toEqual({
mode: 'development',
name: 'shared-webpack-webpack',
devtool: 'source-map',
});
const sharedRspackConfig = await ConfigInternals.getBundlerOverrideFn()(
{mode: 'development'},
{bundler: 'rspack'},
);
expect(
await ConfigInternals.getRspackOverrideFn()(
sharedRspackConfig as RspackConfiguration,
),
).toEqual({
mode: 'development',
name: 'shared-rspack-rspack',
});
ConfigInternals.resetConfigOptions();
expect(ConfigInternals.getStudioPort()).toBeUndefined();
expect(StudioServerInternals.getMaxTimelineTracks()).toBeNull();
expect(ConfigInternals.getElementLibraries()).toEqual([]);
expect(
BrowserSafeApis.options.glOption.getValue({commandLine: {}}).value,
).toBeNull();
expect(getRenderDefaults('info').crf).toBeNull();
expect(
BrowserSafeApis.options.defaultCodingAgentOption.getValue({
commandLine: {},
}).value,
).toBeNull();
expect(
BrowserSafeApis.options.defaultEditorOption.getValue({commandLine: {}})
.value,
).toBeNull();
expect(ConfigInternals.getBufferStateDelayInMilliseconds()).toBeNull();
expect(BrowserSafeApis.options.askAIOption.getConfigValue()).toBeNull();
expect(
BrowserSafeApis.options.preservePitchOnPlaybackOption.getConfigValue(),
).toBeNull();
expect(
BrowserSafeApis.options.preservePitchOnPlaybackOption.getValue({
commandLine: {},
}).value,
).toBe(true);
expect(
BrowserSafeApis.options.audioLatencyHintOption.getConfigValue(),
).toBeNull();
expect(
BrowserSafeApis.options.beepOnFinishOption.getConfigValue(),
).toBeNull();
expect(
BrowserSafeApis.options.enableCrossSiteIsolationOption.getConfigValue(),
).toBeNull();
expect(
BrowserSafeApis.options.interactivityOption.getConfigValue(),
).toBeNull();
expect(
BrowserSafeApis.options.keyboardShortcutsOption.getConfigValue(),
).toBeNull();
expect(ConfigInternals.getKeyboardShortcuts()).toBeNull();
expect(BrowserSafeApis.options.logLevelOption.getConfigValue()).toBeNull();
expect(
BrowserSafeApis.options.numberOfSharedAudioTagsOption.getConfigValue(),
).toBeNull();
expect(BrowserSafeApis.options.rspackOption.getConfigValue()).toBeNull();
expect(StudioServerInternals.getConfiguredMaxTimelineTracks()).toBeNull();
expect(
BrowserSafeApis.options.experimentalKeepAudioContextAliveOption.getValue({
commandLine: {},
}).value,
).toBe(false);
expect(
await ConfigInternals.getBundlerOverrideFn()(
{mode: 'development'},
{bundler: 'webpack'},
),
).toEqual({mode: 'development'});
expect(
await ConfigInternals.getWebpackOverrideFn()({mode: 'development'}),
).toEqual({mode: 'development'});
expect(
await ConfigInternals.getRspackOverrideFn()({mode: 'development'}),
).toEqual({mode: 'development'});
expect(
BrowserSafeApis.options.askAIOption.getValue({commandLine: {}}).value,
).toBe(true);
expect(
BrowserSafeApis.options.jpegQualityOption.getValue({commandLine: {}}).value,
).toBe(80);
expect(
BrowserSafeApis.options.noOpenOption.getValue({commandLine: {}}).value,
).toBe(false);
expect(
BrowserSafeApis.options.overwriteOption.getValue({commandLine: {}}, true)
.value,
).toBe(true);
});
test('CLI app flags take precedence over the configured defaults', () => {
ConfigInternals.resetConfigOptions();
Config.setDefaultCodingAgent('codex');
Config.setDefaultEditor({
type: 'custom',
name: 'Acme Editor',
executable: '/opt/acme/editor',
arguments: ['--goto', '%TARGET_PATH%:%LINE_NUMBER%:%COLUMN_NUMBER%'],
});
Config.setExperimentalKeepAudioContextAlive(false);
Config.setPreservePitchOnPlayback(true);
expect(
BrowserSafeApis.options.preservePitchOnPlaybackOption.getValue({
commandLine: {'preserve-pitch-on-playback': false},
}),
).toEqual({source: 'cli', value: false});
expect(
BrowserSafeApis.options.experimentalKeepAudioContextAliveOption.getValue({
commandLine: {'experimental-keep-audio-context-alive': true},
}),
).toEqual({source: 'cli', value: true});
expect(
BrowserSafeApis.options.defaultCodingAgentOption.getValue({
commandLine: {'coding-agent': 'cursor'},
}),
).toEqual({source: 'cli', value: 'cursor'});
expect(
BrowserSafeApis.options.defaultEditorOption.getValue({
commandLine: {editor: 'zed'},
}),
).toEqual({source: 'cli', value: 'zed'});
expect(() => Config.setDefaultCodingAgent('invalid' as 'codex')).toThrow(
'Config.setDefaultCodingAgent() must be one of',
);
expect(() => Config.setDefaultEditor('invalid' as 'cursor')).toThrow(
'Config.setDefaultEditor() must be one of',
);
expect(() =>
Config.setDefaultEditor({
type: 'custom',
name: 'Acme Editor',
executable: '/opt/acme/editor',
arguments: ['--goto'],
}),
).toThrow('Custom editor arguments must include %TARGET_PATH%');
});
test('bundler overrides can be fixed at Studio startup', async () => {
ConfigInternals.resetConfigOptions();
Config.overrideBundlerConfig((config) => ({...config, name: 'startup'}));
Config.overrideRspackConfig((config) => ({
...config,
devtool: 'source-map',
}));
const startupBundlerOverride = ConfigInternals.getBundlerOverrideFn();
const startupRspackOverride = ConfigInternals.getRspackOverrideFn();
Config.overrideBundlerConfig((config) => ({...config, name: 'reloaded'}));
Config.overrideRspackConfig((config) => ({...config, devtool: false}));
const sharedConfig = await startupBundlerOverride(
{mode: 'development'},
{bundler: 'rspack'},
);
expect(
await startupRspackOverride(sharedConfig as RspackConfiguration),
).toEqual({
mode: 'development',
name: 'startup',
devtool: 'source-map',
});
});