Skip to content

🎥 Make videos programmatically with React

`@remotion/studio`: Hide updates in unsupported modes

Jonny Burgerda61aad72432
diff --git a/packages/example/e2e/studio.test.mts b/packages/example/e2e/studio.test.mts
index 32ddaa20a8..23cd011227 100644
--- a/packages/example/e2e/studio.test.mts
+++ b/packages/example/e2e/studio.test.mts
@@ -3476,6 +3476,60 @@ test.describe('visual mode', () => {
await page.locator('[data-timeline-scrubber]').click();
await expect(currentTime).not.toHaveAttribute('aria-label', '0');
+
+ await page.keyboard.type('?');
+ const settingsDialog = page.getByRole('dialog');
+ await expect(
+ settingsDialog.getByText('Keyboard shortcuts', {exact: true}),
+ ).toBeVisible();
+ await expect(
+ settingsDialog.getByRole('button', {name: 'Updates', exact: true}),
+ ).toHaveCount(0);
+ });
+
+ test('should hide updates when the preview server disconnects', async ({
+ page,
+ }) => {
+ await page.addInitScript(() => {
+ const NativeEventSource = window.EventSource;
+ window.EventSource = class extends NativeEventSource {
+ constructor(url: string | URL, eventSourceInitDict?: EventSourceInit) {
+ super(url, eventSourceInitDict);
+ (
+ window as typeof window & {
+ remotion_e2eEventSource: EventSource;
+ }
+ ).remotion_e2eEventSource = this;
+ }
+ };
+ });
+ await page.goto(`${STUDIO_URL}/schema-test`);
+ await expect(
+ page.getByRole('button', {name: '0', exact: true}),
+ ).toBeVisible({timeout: 15_000});
+
+ await page.keyboard.type('?');
+ const settingsDialog = page.getByRole('dialog');
+ await expect(
+ settingsDialog.getByRole('button', {name: 'Updates', exact: true}),
+ ).toBeVisible();
+
+ await page.evaluate(() => {
+ (
+ window as typeof window & {
+ remotion_e2eEventSource: EventSource;
+ }
+ ).remotion_e2eEventSource.dispatchEvent(new Event('error'));
+ });
+ await expect(
+ page.getByText('The studio server has disconnected.', {exact: false}),
+ ).toBeVisible({timeout: 15_000});
+ await expect(
+ settingsDialog.getByRole('button', {name: 'Updates', exact: true}),
+ ).toHaveCount(0);
+ await expect(
+ settingsDialog.getByText('Keyboard shortcuts', {exact: true}),
+ ).toBeVisible();
});
test('should preview and place Canvas drops at the playhead', async ({
diff --git a/packages/studio/src/components/MenuToolbar.tsx b/packages/studio/src/components/MenuToolbar.tsx
index 14f8a5ca22..91dce8e0de 100644
--- a/packages/studio/src/components/MenuToolbar.tsx
+++ b/packages/studio/src/components/MenuToolbar.tsx
@@ -2,6 +2,7 @@ import type {SetStateAction} from 'react';
import React, {useCallback, useContext, useMemo, useState} from 'react';
import {cmdOrCtrlCharacter} from '../error-overlay/remotion-overlay/ShortcutHint';
import {getBrowserStudioOperations} from '../helpers/browser-studio-operations';
+import {canShowUpdates} from '../helpers/can-show-updates';
import {StudioServerConnectionCtx} from '../helpers/client-id';
import {BACKGROUND, BORDER_BLACK, WHITE} from '../helpers/colors';
import {useMobileLayout} from '../helpers/mobile-layout';
@@ -54,6 +55,11 @@ export const MenuToolbar: React.FC<{
!readOnlyStudio ||
(previewServerState.type === 'connected' &&
browserStudioOperations !== null);
+ const showUpdates = canShowUpdates({
+ connectionStatus: previewServerState.type,
+ isBrowserStudio: browserStudioOperations !== null,
+ readOnlyStudio,
+ });
const mobileLayout = useMobileLayout();
@@ -197,7 +203,7 @@ export const MenuToolbar: React.FC<{
);
})}
</div>
- {readOnlyStudio || browserStudioOperations ? null : <UpdateCheck />}
+ {showUpdates ? <UpdateCheck /> : null}
</div>
{mobileLayout ? null : <div style={flex} />}
<MenuBuildIndicator mobileLayout={mobileLayout} />
diff --git a/packages/studio/src/components/SettingsModal.tsx b/packages/studio/src/components/SettingsModal.tsx
index c957a8b477..0a9e2d29be 100644
--- a/packages/studio/src/components/SettingsModal.tsx
+++ b/packages/studio/src/components/SettingsModal.tsx
@@ -1,8 +1,16 @@
-import React, {useCallback, useContext, useEffect, useState} from 'react';
+import React, {
+ useCallback,
+ useContext,
+ useEffect,
+ useLayoutEffect,
+ useState,
+} from 'react';
import {
canInstallPackages,
getBrowserStudioOperations,
} from '../helpers/browser-studio-operations';
+import {canShowUpdates} from '../helpers/can-show-updates';
+import {StudioServerConnectionCtx} from '../helpers/client-id';
import {AppsIcon} from '../icons/apps';
import {CloudDownloadIcon} from '../icons/cloud-download';
import {KeyboardIcon} from '../icons/keyboard';
@@ -87,15 +95,23 @@ export const SettingsModal: React.FC<{
}> = ({initialPublicLicenseKey, initialTab}) => {
const {setSelectedModal} = useContext(SetSelectedModalContext);
const {setPublicLicenseKey} = useSettings();
+ const {previewServerState} = useContext(StudioServerConnectionCtx);
const isBrowserStudio = getBrowserStudioOperations() !== null;
+ const showUpdates = canShowUpdates({
+ connectionStatus: previewServerState.type,
+ isBrowserStudio,
+ readOnlyStudio: window.remotion_isReadOnlyStudio,
+ });
const packageManager =
window.remotion_packageManager === 'unknown'
? null
: window.remotion_packageManager;
const showPackages =
canInstallPackages() && (isBrowserStudio || packageManager !== null);
- const [tab, setTab] = useState<SettingsTab>(initialTab);
- const [openedTabs, setOpenedTabs] = useState<SettingsTab[]>([initialTab]);
+ const safeInitialTab =
+ initialTab === 'updates' && !showUpdates ? 'shortcuts' : initialTab;
+ const [tab, setTab] = useState<SettingsTab>(safeInitialTab);
+ const [openedTabs, setOpenedTabs] = useState<SettingsTab[]>([safeInitialTab]);
const [packagesFooterContainer, setPackagesFooterContainer] =
useState<HTMLDivElement | null>(null);
@@ -112,6 +128,11 @@ export const SettingsModal: React.FC<{
return [...currentOpenedTabs, newTab];
});
}, []);
+ useLayoutEffect(() => {
+ if (!showUpdates && tab === 'updates') {
+ selectTab('shortcuts');
+ }
+ }, [selectTab, showUpdates, tab]);
useEffect(() => {
setPublicLicenseKey(initialPublicLicenseKey);
}, [initialPublicLicenseKey, setPublicLicenseKey]);
@@ -218,7 +239,7 @@ export const SettingsModal: React.FC<{
License
</VerticalTab>
)}
- {isBrowserStudio ? null : (
+ {showUpdates ? (
<VerticalTab
style={horizontalTab}
selected={tab === 'updates'}
@@ -231,7 +252,7 @@ export const SettingsModal: React.FC<{
>
Updates
</VerticalTab>
- )}
+ ) : null}
</div>
{openedTabs.includes('packages') ? (
<div style={tab === 'packages' ? optionsPanel : hiddenPanel}>
@@ -289,7 +310,7 @@ export const SettingsModal: React.FC<{
<StudioSettings />
</div>
) : null}
- {openedTabs.includes('updates') ? (
+ {showUpdates && openedTabs.includes('updates') ? (
<div
style={tab === 'updates' ? settingsOptionsPanel : hiddenPanel}
className={VERTICAL_SCROLLBAR_CLASSNAME}
diff --git a/packages/studio/src/components/UpdateStatusContext.tsx b/packages/studio/src/components/UpdateStatusContext.tsx
index 589a02400c..3f0d50c428 100644
--- a/packages/studio/src/components/UpdateStatusContext.tsx
+++ b/packages/studio/src/components/UpdateStatusContext.tsx
@@ -8,6 +8,8 @@ import React, {
} 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 {updateAvailable} from './RenderQueue/actions';
// Keep in sync with packages/bugs/api/[v].ts
@@ -31,12 +33,21 @@ const UpdateStatusContext = createContext<UpdateStatusContextValue | null>(
export const UpdateStatusProvider: React.FC<{
readonly children: React.ReactNode;
}> = ({children}) => {
+ const {previewServerState} = useContext(StudioServerConnectionCtx);
const [info, setInfo] = useState<UpdateAvailableResponse | null>(null);
const [knownBugs, setKnownBugs] = useState<Bug[] | null>(null);
const [error, setError] = useState<string | null>(null);
+ const showUpdates = canShowUpdates({
+ connectionStatus: previewServerState.type,
+ isBrowserStudio: getBrowserStudioOperations() !== null,
+ readOnlyStudio: window.remotion_isReadOnlyStudio,
+ });
useEffect(() => {
- if (getBrowserStudioOperations() !== null) {
+ if (!showUpdates) {
+ setInfo(null);
+ setKnownBugs(null);
+ setError(null);
return;
}
@@ -76,7 +87,7 @@ export const UpdateStatusProvider: React.FC<{
updateController.abort();
bugsController.abort();
};
- }, []);
+ }, [showUpdates]);
const value = useMemo<UpdateStatusContextValue>(() => {
return {error, info, knownBugs};
diff --git a/packages/studio/src/helpers/can-show-updates.ts b/packages/studio/src/helpers/can-show-updates.ts
new file mode 100644
index 0000000000..be2ed70bc5
--- /dev/null
+++ b/packages/studio/src/helpers/can-show-updates.ts
@@ -0,0 +1,15 @@
+import type {PreviewServerConnectionState} from './preview-server-events';
+
+export const canShowUpdates = ({
+ connectionStatus,
+ isBrowserStudio,
+ readOnlyStudio,
+}: {
+ readonly connectionStatus: PreviewServerConnectionState['type'];
+ readonly isBrowserStudio: boolean;
+ readonly readOnlyStudio: boolean;
+}) => {
+ return (
+ connectionStatus === 'connected' && !isBrowserStudio && !readOnlyStudio
+ );
+};
diff --git a/packages/studio/src/test/can-show-updates.test.ts b/packages/studio/src/test/can-show-updates.test.ts
new file mode 100644
index 0000000000..4c107b46fb
--- /dev/null
+++ b/packages/studio/src/test/can-show-updates.test.ts
@@ -0,0 +1,37 @@
+import {expect, test} from 'bun:test';
+import {canShowUpdates} from '../helpers/can-show-updates';
+
+test('only shows updates in a connected, writable desktop Studio', () => {
+ expect(
+ canShowUpdates({
+ connectionStatus: 'connected',
+ isBrowserStudio: false,
+ readOnlyStudio: false,
+ }),
+ ).toBe(true);
+
+ for (const environment of [
+ {
+ connectionStatus: 'connected' as const,
+ isBrowserStudio: false,
+ readOnlyStudio: true,
+ },
+ {
+ connectionStatus: 'connected' as const,
+ isBrowserStudio: true,
+ readOnlyStudio: false,
+ },
+ {
+ connectionStatus: 'disconnected' as const,
+ isBrowserStudio: false,
+ readOnlyStudio: false,
+ },
+ {
+ connectionStatus: 'init' as const,
+ isBrowserStudio: false,
+ readOnlyStudio: false,
+ },
+ ]) {
+ expect(canShowUpdates(environment)).toBe(false);
+ }
+});