Skip to content

🎥 Make videos programmatically with React

`@remotion/studio`: Add interactive Remotion upgrades

Jonny Burger4eeb2bdff577
diff --git a/packages/cli/src/studio.ts b/packages/cli/src/studio.ts
index b175e01889..e91c5ad794 100644
--- a/packages/cli/src/studio.ts
+++ b/packages/cli/src/studio.ts
@@ -345,7 +345,7 @@ export const studioCommand = async (
configFile,
});
- if (result.type === 'already-running') {
+ if (result.type !== 'restarted') {
return;
}
diff --git a/packages/example/e2e/upgrade-remotion.test.mts b/packages/example/e2e/upgrade-remotion.test.mts
new file mode 100644
index 0000000000..482a897aa6
--- /dev/null
+++ b/packages/example/e2e/upgrade-remotion.test.mts
@@ -0,0 +1,145 @@
+import {spawn} from 'node:child_process';
+import {createServer} from 'node:net';
+import {expect, test} from '@playwright/test';
+import {e2eEntryPoint, exampleDir, remotionBin} from './constants.mts';
+
+test('upgrade progress survives closing settings and offers a graceful shutdown', async ({
+ page,
+}) => {
+ test.setTimeout(120_000);
+ const portServer = createServer();
+ await new Promise<void>((resolve) =>
+ portServer.listen(0, '127.0.0.1', resolve),
+ );
+ const address = portServer.address();
+ if (!address || typeof address === 'string') throw new Error('No test port');
+ await new Promise<void>((resolve) => portServer.close(() => resolve()));
+ const studioUrl = `http://localhost:${address.port}`;
+ const studio = spawn(
+ remotionBin,
+ [
+ 'studio',
+ e2eEntryPoint,
+ '--port',
+ String(address.port),
+ '--no-open',
+ '--force-new',
+ ],
+ {cwd: exampleDir, stdio: 'pipe'},
+ );
+ let logs = '';
+ studio.stdout.on('data', (data: Buffer) => {
+ logs += data.toString();
+ });
+ studio.stderr.on('data', (data: Buffer) => {
+ logs += data.toString();
+ });
+ const exited = new Promise<number | null>((resolve) =>
+ studio.once('exit', resolve),
+ );
+ try {
+ await expect.poll(() => logs, {timeout: 60000}).toContain('Built in');
+ await page.route('**/api/update-available', (route) =>
+ route.fulfill({
+ json: {
+ success: true,
+ data: {
+ currentVersion: '4.0.520',
+ latestVersion: '4.0.521',
+ updateAvailable: true,
+ skillsUpdateAvailable: false,
+ timedOut: false,
+ packageManager: 'bun',
+ },
+ },
+ }),
+ );
+ await page.route('**/api/release-notes', (route) =>
+ route.fulfill({
+ json: {success: true, data: {releases: [], hasMore: false}},
+ }),
+ );
+ await page.route('https://bugs.remotion.dev/**', (route) =>
+ route.fulfill({json: {bugs: []}}),
+ );
+ // Avoid changing the example project's dependencies. The server integration test
+ // covers this request through the real CLI and package-manager boundary.
+ let finishUpgrade: () => void = () => undefined;
+ const upgradeFinished = new Promise<void>((resolve) => {
+ finishUpgrade = resolve;
+ });
+ let attempts = 0;
+ await page.route('**/api/upgrade-remotion', async (route) => {
+ expect(route.request().postDataJSON()).toEqual({version: '4.0.521'});
+ attempts++;
+ if (attempts === 1) {
+ await route.fulfill({
+ json: {success: false, error: 'Installation failed. Try again.'},
+ });
+ return;
+ }
+ await upgradeFinished;
+ await route.fulfill({json: {success: true, data: {}}});
+ });
+ await page.goto(studioUrl);
+ const openSettings = async () => {
+ await page.keyboard.press('ControlOrMeta+k');
+ const switcher = page.getByRole('dialog');
+ await switcher.getByRole('textbox').fill('> Settings');
+ await switcher.getByText('Settings...', {exact: true}).click();
+ await page
+ .getByRole('dialog')
+ .getByText('Updates', {exact: true})
+ .click();
+ };
+ await openSettings();
+ const dialog = page.getByRole('dialog');
+ await dialog.getByRole('button', {name: 'Upgrade to 4.0.521'}).click();
+ await expect(
+ dialog.getByText('Installation failed. Try again.', {exact: true}),
+ ).toBeVisible();
+ await dialog.getByRole('button', {name: 'Upgrade to 4.0.521'}).click();
+ await expect(
+ dialog.getByText('Upgrading Remotion...', {exact: true}),
+ ).toBeVisible();
+ await page.keyboard.press('Escape');
+ await openSettings();
+ await expect(
+ dialog.getByText('Upgrading Remotion...', {exact: true}),
+ ).toBeVisible();
+ finishUpgrade();
+ await expect(
+ dialog.getByText('Remotion has been upgraded.', {exact: true}),
+ ).toBeVisible();
+ await dialog
+ .getByRole('button', {name: 'Shut down Studio', exact: true})
+ .click();
+ await expect(
+ dialog.getByText(
+ 'Studio is shutting down. Run your Studio start command again in the terminal to use the new version.',
+ {exact: true},
+ ),
+ ).toBeVisible();
+ await expect.poll(() => logs).toContain('Shutting down Studio...');
+ expect(await exited).toBe(0);
+ await expect
+ .poll(async () => {
+ try {
+ await fetch(studioUrl);
+ return false;
+ } catch {
+ return true;
+ }
+ })
+ .toBe(true);
+ await expect(
+ dialog.getByText(
+ 'Studio is shutting down. Run your Studio start command again in the terminal to use the new version.',
+ {exact: true},
+ ),
+ ).toBeVisible();
+ } finally {
+ if (studio.exitCode === null) studio.kill('SIGTERM');
+ await exited;
+ }
+});
diff --git a/packages/studio-server/src/preview-server/api-routes.ts b/packages/studio-server/src/preview-server/api-routes.ts
index 748f3b7831..f47df69391 100644
--- a/packages/studio-server/src/preview-server/api-routes.ts
+++ b/packages/studio-server/src/preview-server/api-routes.ts
@@ -49,6 +49,7 @@ import {handleRestartStudio} from './routes/restart-studio';
import {saveEffectPropsHandler} from './routes/save-effect-props';
import {saveMultipleEffectPropsHandler} from './routes/save-multiple-effect-props';
import {saveSequencePropsHandler} from './routes/save-sequence-props';
+import {handleShutdownStudio} from './routes/shutdown-studio';
import {splitJsxSequenceHandler} from './routes/split-jsx-sequence';
import {splitVideoFromAudioHandler} from './routes/split-video-from-audio';
import {subscribeToDefaultProps} from './routes/subscribe-to-default-props';
@@ -64,6 +65,7 @@ import {updateDefaultPropsHandler} from './routes/update-default-props';
import {updateEffectKeyframeSettingsHandler} from './routes/update-effect-keyframe-settings';
import {updateElementInstallTargetHandler} from './routes/update-element-install-target';
import {updateSequenceKeyframeSettingsHandler} from './routes/update-sequence-keyframe-settings';
+import {handleUpgradeRemotion} from './routes/upgrade-remotion';
type StandardApiRoute = Exclude<keyof ApiRoutes, '/api/update-config'>;
@@ -124,6 +126,8 @@ export const allApiRoutes: {
'/api/project-info': projectInfoHandler,
'/api/delete-static-file': deleteStaticFileHandler,
'/api/rename-static-file': renameStaticFileHandler,
+ '/api/upgrade-remotion': handleUpgradeRemotion,
+ '/api/shutdown-studio': handleShutdownStudio,
'/api/restart-studio': handleRestartStudio,
'/api/default-coding-agent-info': getDefaultCodingAgentInfoHandler,
'/api/default-editor-info': getDefaultEditorInfoHandler,
diff --git a/packages/studio-server/src/preview-server/close-and-restart.ts b/packages/studio-server/src/preview-server/close-and-restart.ts
index 28a344939e..a21371f9b3 100644
--- a/packages/studio-server/src/preview-server/close-and-restart.ts
+++ b/packages/studio-server/src/preview-server/close-and-restart.ts
@@ -1,14 +1,16 @@
-const resolveFunctions: ((value: void) => void | PromiseLike<void>)[] = [];
+type StudioAction = 'restart' | 'shutdown';
+const resolveFunctions: ((value: StudioAction) => void)[] = [];
export const noOpUntilRestart = () => {
- return new Promise<void>((resolve) => {
+ return new Promise<StudioAction>((resolve) => {
resolveFunctions.push(resolve);
});
};
export const signalRestart = () => {
- resolveFunctions.forEach((f) => {
- f();
- });
- resolveFunctions.length = 0;
+ resolveFunctions.splice(0).forEach((resolve) => resolve('restart'));
+};
+
+export const signalShutdown = () => {
+ resolveFunctions.splice(0).forEach((resolve) => resolve('shutdown'));
};
diff --git a/packages/studio-server/src/preview-server/routes/shutdown-studio.ts b/packages/studio-server/src/preview-server/routes/shutdown-studio.ts
new file mode 100644
index 0000000000..5c233f4dd9
--- /dev/null
+++ b/packages/studio-server/src/preview-server/routes/shutdown-studio.ts
@@ -0,0 +1,8 @@
+import type {ApiHandler} from '../api-types';
+import {signalShutdown} from '../close-and-restart';
+
+export const handleShutdownStudio: ApiHandler<{}, {}> = ({response}) => {
+ // Flush the acknowledgement before closing the HTTP and live-event connections.
+ response.once('finish', signalShutdown);
+ return Promise.resolve({});
+};
diff --git a/packages/studio-server/src/preview-server/routes/upgrade-remotion.ts b/packages/studio-server/src/preview-server/routes/upgrade-remotion.ts
new file mode 100644
index 0000000000..ae76c7fb25
--- /dev/null
+++ b/packages/studio-server/src/preview-server/routes/upgrade-remotion.ts
@@ -0,0 +1,63 @@
+import {spawn} from 'node:child_process';
+import path from 'node:path';
+import {RenderInternals} from '@remotion/renderer';
+import type {ApiRoutes} from '@remotion/studio-shared';
+import type {ApiHandler} from '../api-types';
+
+let upgrading = false;
+
+export const handleUpgradeRemotion: ApiHandler<
+ ApiRoutes['/api/upgrade-remotion']['Request'],
+ ApiRoutes['/api/upgrade-remotion']['Response']
+> = async ({remotionRoot, logLevel, input: {version}}) => {
+ if (typeof version !== 'string' || !/^\d+\.\d+\.\d+$/.test(version)) {
+ throw new Error('Invalid Remotion version.');
+ }
+
+ if (upgrading) {
+ throw new Error('A Remotion upgrade is already in progress.');
+ }
+
+ upgrading = true;
+ try {
+ const cliPackage = require.resolve('@remotion/cli/package.json', {
+ paths: [remotionRoot],
+ });
+ const cli = path.join(path.dirname(cliPackage), 'remotion-cli.js');
+ await new Promise<void>((resolve, reject) => {
+ const child = spawn(
+ process.execPath,
+ [cli, 'upgrade', `--version=${version}`],
+ {
+ cwd: remotionRoot,
+ stdio: ['ignore', 'pipe', 'pipe'],
+ env: {...process.env, CI: '1'},
+ },
+ );
+ let output = '';
+ const onOutput = (chunk: Buffer) => {
+ const message = chunk.toString();
+ output = (output + message).slice(-8000);
+ RenderInternals.Log.info({indent: false, logLevel}, message.trimEnd());
+ };
+
+ child.stdout.on('data', onOutput);
+ child.stderr.on('data', onOutput);
+ child.on('error', reject);
+ child.on('close', (code, signal) => {
+ if (code === 0) {
+ resolve();
+ } else {
+ reject(
+ new Error(
+ `Remotion upgrade failed (exit code ${code}, signal ${signal}).\n${output}`,
+ ),
+ );
+ }
+ });
+ });
+ return {};
+ } finally {
+ upgrading = false;
+ }
+};
diff --git a/packages/studio-server/src/start-studio.ts b/packages/studio-server/src/start-studio.ts
index bae43ea261..c6b6e34b5d 100644
--- a/packages/studio-server/src/start-studio.ts
+++ b/packages/studio-server/src/start-studio.ts
@@ -34,7 +34,10 @@ import {startServer} from './preview-server/start-server';
import {printServerReadyComment, setServerReadyComment} from './server-ready';
import {watchRootFile} from './watch-root-file';
-export type StartStudioResult = {type: 'restarted'} | {type: 'already-running'};
+export type StartStudioResult =
+ | {type: 'restarted'}
+ | {type: 'already-running'}
+ | {type: 'shutdown'};
export const startStudio = async ({
browserArgs,
@@ -234,6 +237,7 @@ export const startStudio = async ({
logLevel,
});
+ let action: 'restart' | 'shutdown';
try {
await maybeOpenBrowser({
browserArgs,
@@ -243,19 +247,25 @@ export const startStudio = async ({
logLevel,
});
- await noOpUntilRestart();
+ action = await noOpUntilRestart();
} finally {
openBrowserShortcut.cleanup();
}
RenderInternals.Log.info(
{indent: false, logLevel},
- 'Closing server to restart...',
+ action === 'shutdown'
+ ? 'Shutting down Studio...'
+ : 'Closing server to restart...',
);
await liveEventsServer.closeConnections();
cleanupLiveEventsListener();
await close();
+ if (action === 'shutdown') {
+ return {type: 'shutdown'};
+ }
+
RenderInternals.Log.info(
{indent: false, logLevel},
RenderInternals.chalk.blue('Restarting server...'),
diff --git a/packages/studio-server/src/test/upgrade-remotion.test.ts b/packages/studio-server/src/test/upgrade-remotion.test.ts
new file mode 100644
index 0000000000..3041ecc931
--- /dev/null
+++ b/packages/studio-server/src/test/upgrade-remotion.test.ts
@@ -0,0 +1,134 @@
+import {expect, test} from 'bun:test';
+import {
+ chmod,
+ mkdir,
+ mkdtemp,
+ readFile,
+ realpath,
+ rm,
+ symlink,
+ writeFile,
+} from 'node:fs/promises';
+import {createServer} from 'node:http';
+import {tmpdir} from 'node:os';
+import path from 'node:path';
+import {allApiRoutes} from '../preview-server/api-routes';
+import {noOpUntilRestart} from '../preview-server/close-and-restart';
+import {handleRequest} from '../preview-server/handler';
+
+// Run the actual upgrade CLI, replacing only the external package manager.
+test.skipIf(process.platform === 'win32')(
+ 'Studio upgrades through the CLI, reports installation failures, and acknowledges shutdown',
+ async () => {
+ const root = await mkdtemp(path.join(tmpdir(), 'studio-upgrade-'));
+ const previousPath = process.env.PATH;
+ const bin = path.join(root, 'bin');
+ await mkdir(bin);
+ await mkdir(path.join(root, 'node_modules/@remotion'), {recursive: true});
+ await symlink(
+ path.resolve(__dirname, '../../../cli'),
+ path.join(root, 'node_modules/@remotion/cli'),
+ );
+ await writeFile(
+ path.join(root, 'package.json'),
+ JSON.stringify({
+ dependencies: {remotion: '4.0.1', '@remotion/cli': '4.0.1'},
+ }),
+ );
+ await writeFile(path.join(root, 'package-lock.json'), '{}');
+ const npm = path.join(bin, 'npm');
+ await writeFile(
+ npm,
+ `#!${process.execPath}
+const fs = require('node:fs');
+if (process.argv[2] === 'view') {
+ console.log('{}');
+} else {
+ fs.writeFileSync('install-call.json', JSON.stringify({cwd: process.cwd(), args: process.argv.slice(2)}));
+ if (fs.existsSync('fail')) {
+ process.stderr.write('Package manager rejected the upgrade\\n');
+ process.stdout.end();
+ setTimeout(() => process.exit(1), 100);
+ }
+}
+`,
+ );
+ await chmod(npm, 0o755);
+ process.env.PATH = `${bin}${path.delimiter}${previousPath}`;
+ const server = createServer((request, response) => {
+ const handler =
+ request.url === '/api/shutdown-studio'
+ ? allApiRoutes['/api/shutdown-studio']
+ : allApiRoutes['/api/upgrade-remotion'];
+ handleRequest({
+ request,
+ response,
+ handler,
+ remotionRoot: root,
+ entryPoint: '',
+ logLevel: 'error',
+ publicDir: root,
+ binariesDirectory: null,
+ configFile: null,
+ getDefaultCodingAgent: () => null,
+ getDefaultEditor: () => null,
+ methods: {
+ addJob: () => undefined,
+ cancelJob: () => undefined,
+ removeJob: () => undefined,
+ },
+ }).catch(() => response.end());
+ });
+ try {
+ await new Promise<void>((resolve) =>
+ server.listen(0, '127.0.0.1', resolve),
+ );
+ const address = server.address();
+ if (!address || typeof address === 'string') throw new Error('No port');
+ const origin = `http://127.0.0.1:${address.port}`;
+ const request = async (endpoint: string, body: object) => {
+ const response = await fetch(`${origin}${endpoint}`, {
+ method: 'POST',
+ headers: {origin, 'content-type': 'application/json'},
+ body: JSON.stringify(body),
+ });
+ return response.json();
+ };
+
+ expect(
+ await request('/api/upgrade-remotion', {version: '4.0.521; echo bad'}),
+ ).toMatchObject({success: false, error: 'Invalid Remotion version.'});
+ expect(
+ await request('/api/upgrade-remotion', {version: '4.0.521'}),
+ ).toEqual({success: true, data: {}});
+ const call = JSON.parse(
+ await readFile(path.join(root, 'install-call.json'), 'utf8'),
+ );
+ expect(call.cwd).toBe(await realpath(root));
+ expect(call.args).toContain('[email protected]');
+ expect(call.args).toContain('@remotion/[email protected]');
+ await writeFile(path.join(root, 'fail'), '');
+ const failed = await request('/api/upgrade-remotion', {
+ version: '4.0.521',
+ });
+ expect(failed.success).toBe(false);
+ expect(failed.error).toContain('Package manager rejected the upgrade');
+ await rm(path.join(root, 'fail'));
+ expect(
+ await request('/api/upgrade-remotion', {version: '4.0.521'}),
+ ).toEqual({success: true, data: {}});
+ const shutdown = noOpUntilRestart();
+ expect(await request('/api/shutdown-studio', {})).toEqual({
+ success: true,
+ data: {},
+ });
+ expect(await shutdown).toBe('shutdown');
+ } finally {
+ process.env.PATH = previousPath;
+ server.closeAllConnections();
+ await new Promise<void>((resolve) => server.close(() => resolve()));
+ await rm(root, {recursive: true, force: true});
+ }
+ },
+ 30000,
+);
diff --git a/packages/studio-shared/src/api-requests.ts b/packages/studio-shared/src/api-requests.ts
index 22c0c503c6..06b2bc6a3a 100644
--- a/packages/studio-shared/src/api-requests.ts
+++ b/packages/studio-shared/src/api-requests.ts
@@ -1423,6 +1423,8 @@ export type ApiRoutes = {
CopyRenderOutputToAssetRequest,
CopyRenderOutputToAssetResponse
>;
+ '/api/upgrade-remotion': ReqAndRes<{version: string}, {}>;
+ '/api/shutdown-studio': ReqAndRes<{}, {}>;
'/api/restart-studio': ReqAndRes<RestartStudioRequest, RestartStudioResponse>;
'/api/update-config': ReqAndRes<UpdateConfigRequest, UpdateConfigResponse>;
'/api/default-editor-info': ReqAndRes<
diff --git a/packages/studio/src/components/SettingsModal.tsx b/packages/studio/src/components/SettingsModal.tsx
index 0a9e2d29be..f2c808c929 100644
--- a/packages/studio/src/components/SettingsModal.tsx
+++ b/packages/studio/src/components/SettingsModal.tsx
@@ -43,6 +43,7 @@ import {SkillsSettings} from './SkillsSettings';
import {StudioSettings} from './StudioSettings';
import {VerticalTab} from './Tabs/vertical';
import {UpdatesSettings} from './UpdatesSettings';
+import {useUpdateStatus} from './UpdateStatusContext';
type SettingsTab =
| 'apps'
@@ -97,11 +98,14 @@ export const SettingsModal: React.FC<{
const {setPublicLicenseKey} = useSettings();
const {previewServerState} = useContext(StudioServerConnectionCtx);
const isBrowserStudio = getBrowserStudioOperations() !== null;
- const showUpdates = canShowUpdates({
- connectionStatus: previewServerState.type,
- isBrowserStudio,
- readOnlyStudio: window.remotion_isReadOnlyStudio,
- });
+ const {upgradeState} = useUpdateStatus();
+ const showUpdates =
+ upgradeState !== 'idle' ||
+ canShowUpdates({
+ connectionStatus: previewServerState.type,
+ isBrowserStudio,
+ readOnlyStudio: window.remotion_isReadOnlyStudio,
+ });
const packageManager =
window.remotion_packageManager === 'unknown'
? null
diff --git a/packages/studio/src/components/UpdateStatusContext.tsx b/packages/studio/src/components/UpdateStatusContext.tsx
index 3f0d50c428..f328771a99 100644
--- a/packages/studio/src/components/UpdateStatusContext.tsx
+++ b/packages/studio/src/components/UpdateStatusContext.tsx
@@ -1,15 +1,18 @@
import type {UpdateAvailableResponse} from '@remotion/studio-shared';
import React, {
createContext,
+ useCallback,
useContext,
useEffect,
useMemo,
+ useRef,
useState,
} from 'react';
import {VERSION} from 'remotion';
import {getBrowserStudioOperations} from '../helpers/browser-studio-operations';
import {canShowUpdates} from '../helpers/can-show-updates';
import {StudioServerConnectionCtx} from '../helpers/client-id';
+import {callApi} from './call-api';
import {updateAvailable} from './RenderQueue/actions';
// Keep in sync with packages/bugs/api/[v].ts
@@ -20,7 +23,18 @@ export type Bug = {
versions: string[];
};
+type UpgradeState =
+ | 'idle'
+ | 'upgrading'
+ | 'upgraded'
+ | 'shutting-down'
+ | 'shutdown';
+
type UpdateStatusContextValue = {
+ readonly upgradeState: UpgradeState;
+ readonly upgradeError: string | null;
+ readonly upgrade: (version: string) => Promise<void>;
+ readonly shutdown: () => Promise<void>;
readonly error: string | null;
readonly info: UpdateAvailableResponse | null;
readonly knownBugs: Bug[] | null;
@@ -34,6 +48,45 @@ export const UpdateStatusProvider: React.FC<{
readonly children: React.ReactNode;
}> = ({children}) => {
const {previewServerState} = useContext(StudioServerConnectionCtx);
+ const [upgradeState, setUpgradeState] = useState<UpgradeState>('idle');
+ const [upgradeError, setUpgradeError] = useState<string | null>(null);
+ const busy = useRef(false);
+ const upgrade = useCallback(async (version: string) => {
+ if (busy.current) {
+ return;
+ }
+
+ busy.current = true;
+ setUpgradeState('upgrading');
+ setUpgradeError(null);
+ try {
+ await callApi('/api/upgrade-remotion', {version});
+ setUpgradeState('upgraded');
+ } catch (err) {
+ setUpgradeError((err as Error).message);
+ setUpgradeState('idle');
+ } finally {
+ busy.current = false;
+ }
+ }, []);
+ const shutdown = useCallback(async () => {
+ if (busy.current) {
+ return;
+ }
+
+ busy.current = true;
+ setUpgradeState('shutting-down');
+ setUpgradeError(null);
+ try {
+ await callApi('/api/shutdown-studio', {});
+ setUpgradeState('shutdown');
+ } catch (err) {
+ setUpgradeError((err as Error).message);
+ setUpgradeState('upgraded');
+ } finally {
+ busy.current = false;
+ }
+ }, []);
const [info, setInfo] = useState<UpdateAvailableResponse | null>(null);
const [knownBugs, setKnownBugs] = useState<Bug[] | null>(null);
const [error, setError] = useState<string | null>(null);
@@ -90,8 +143,16 @@ export const UpdateStatusProvider: React.FC<{
}, [showUpdates]);
const value = useMemo<UpdateStatusContextValue>(() => {
- return {error, info, knownBugs};
- }, [error, info, knownBugs]);
+ return {
+ error,
+ info,
+ knownBugs,
+ upgradeState,
+ upgradeError,
+ upgrade,
+ shutdown,
+ };
+ }, [error, info, knownBugs, upgradeState, upgradeError, upgrade, shutdown]);
return (
<UpdateStatusContext.Provider value={value}>
diff --git a/packages/studio/src/components/UpdatesSettings.tsx b/packages/studio/src/components/UpdatesSettings.tsx
index 990bf0d269..83febeaba2 100644
--- a/packages/studio/src/components/UpdatesSettings.tsx
+++ b/packages/studio/src/components/UpdatesSettings.tsx
@@ -16,6 +16,7 @@ import {ClipboardIcon} from '../icons/clipboard';
import type {RenderInlineAction} from './InlineAction';
import {InlineAction} from './InlineAction';
import {KnownBugs} from './KnownBugs';
+import {ModalButton} from './ModalButton';
import {ValidationMessage} from './NewComposition/ValidationMessage';
import {showNotification} from './Notifications/NotificationCenter';
import {getReleaseNotes} from './RenderQueue/actions';
@@ -232,7 +233,15 @@ const RenderedReleaseNotes: React.FC<{
export const UpdatesSettings: React.FC = () => {
const {remotionSkillsInfo} = useSettings();
- const {error, info, knownBugs} = useUpdateStatus();
+ const {
+ error,
+ info,
+ knownBugs,
+ upgradeState,
+ upgradeError,
+ upgrade,
+ shutdown,
+ } = useUpdateStatus();
const [releaseNotes, setReleaseNotes] = useState<
| (GetReleaseNotesResponse & {
currentVersion: string;
@@ -298,6 +307,50 @@ export const UpdatesSettings: React.FC = () => {
return <ClipboardIcon color={color} style={copyIcon} />;
}, []);
+ const onUpgrade = useCallback(() => {
+ if (info) {
+ upgrade(info.latestVersion);
+ }
+ }, [info, upgrade]);
+
+ if (upgradeState !== 'idle') {
+ return (
+ <div style={container}>
+ <div style={title}>
+ {upgradeState === 'upgrading'
+ ? 'Upgrading Remotion...'
+ : 'Remotion has been upgraded.'}
+ </div>
+ <div style={text}>
+ {upgradeState === 'upgrading'
+ ? 'This may take a few minutes. You can follow the progress in your terminal.'
+ : upgradeState === 'shutdown'
+ ? 'Studio is shutting down. Run your Studio start command again in the terminal to use the new version.'
+ : 'Restart Studio to use the new version. Shut down the server below, then run your Studio start command again in the terminal.'}
+ </div>
+ {upgradeState === 'upgraded' || upgradeState === 'shutting-down' ? (
+ <div style={{marginTop: 12}}>
+ <ModalButton
+ onClick={shutdown}
+ disabled={upgradeState === 'shutting-down'}
+ >
+ {upgradeState === 'shutting-down'
+ ? 'Shutting down...'
+ : 'Shut down Studio'}
+ </ModalButton>
+ </div>
+ ) : null}
+ {upgradeError ? (
+ <ValidationMessage
+ message={upgradeError}
+ type="error"
+ align="flex-start"
+ />
+ ) : null}
+ </div>
+ );
+ }
+
if (info === null) {
return (
<div style={container}>
@@ -339,6 +392,23 @@ export const UpdatesSettings: React.FC = () => {
return (
<div style={container}>
+ {info.updateAvailable && info.packageManager !== 'unknown' ? (
+ <div style={{paddingTop: 12}}>
+ <ModalButton onClick={onUpgrade}>
+ Upgrade to {info.latestVersion}
+ </ModalButton>
+ <div style={{...text, marginTop: 8}}>
+ You will need to restart Studio after upgrading.
+ </div>
+ </div>
+ ) : null}
+ {upgradeError ? (
+ <ValidationMessage
+ message={upgradeError}
+ type="error"
+ align="flex-start"
+ />
+ ) : null}
{hasKnownBugs && info.updateAvailable ? (
<>
<div style={title}>
@@ -347,13 +417,11 @@ export const UpdatesSettings: React.FC = () => {
</div>
<KnownBugs bugs={knownBugs ?? []} />
<div style={{height: '20px'}} />
- <div style={text}>
- To update, run the following {updateActionType}:
- </div>
+ <div style={text}>Or run the following {updateActionType}:</div>
</>
) : info.updateAvailable ? (
<div style={titleBeforeCommand}>
- A new Remotion update is available. Run the following{' '}
+ A new Remotion update is available. You can also run the following{' '}
{updateActionType}:
</div>
) : (