Skip to content

🎥 Make videos programmatically with React

`@remotion/studio`: Fix blank screen when project imports fail

JonnyBurger44c86b492ecd
diff --git a/packages/browser-studio/src/BrowserStudio.tsx b/packages/browser-studio/src/BrowserStudio.tsx
index cfec5f1e4e..b95f99d191 100644
--- a/packages/browser-studio/src/BrowserStudio.tsx
+++ b/packages/browser-studio/src/BrowserStudio.tsx
@@ -168,6 +168,10 @@ export const BrowserStudio: React.FC<BrowserStudioProps> = ({
const [iframeHtml, setIframeHtml] = useState<string | null>(null);
const [iframeLoaded, setIframeLoaded] = useState(false);
const [loadingProgress, setLoadingProgress] = useState<number | null>(null);
+ const [compileGeneration, setCompileGeneration] = useState(0);
+ const reloadBrowserStudio = useCallback(() => {
+ setCompileGeneration((generation) => generation + 1);
+ }, []);
const installedDependencyResolutionsRef = useRef<
Record<string, BrowserStudioDependencyResolution>
>({});
@@ -178,6 +182,7 @@ export const BrowserStudio: React.FC<BrowserStudioProps> = ({
const initialElementRef = useRef(initialElement);
const lastSentProjectRef = useRef<BrowserStudioProps['project'] | null>(null);
const bundleUrlRef = useRef<string | null>(null);
+ const unsubscribeFromIframeEventsRef = useRef(new Set<() => void>());
const notifyStudioOfPointerLeave = useCallback(() => {
const contentWindow = iframeRef.current?.contentWindow;
contentWindow?.dispatchEvent(new Event(browserStudioPointerLeaveEvent));
@@ -364,6 +369,7 @@ export const BrowserStudio: React.FC<BrowserStudioProps> = ({
useEffect(() => {
let didCancel = false;
+ const iframeEventUnsubscribers = unsubscribeFromIframeEventsRef.current;
const setCompileState = (nextState: CompileState) => {
if (didCancel) {
@@ -374,6 +380,9 @@ export const BrowserStudio: React.FC<BrowserStudioProps> = ({
onCompileStateChangeRef.current?.(nextState);
};
+ setIframeLoaded(false);
+ lastWrittenDocumentRef.current = null;
+ lastWrittenHtmlRef.current = null;
setIframeHtml(null);
setCompileState({status: 'compiling'});
const configuredDependencyResolutions = Object.fromEntries(
@@ -701,17 +710,30 @@ export const BrowserStudio: React.FC<BrowserStudioProps> = ({
return () => {
didCancel = true;
+ for (const unsubscribe of iframeEventUnsubscribers) {
+ unsubscribe();
+ }
+
+ iframeEventUnsubscribers.clear();
+ browserStudioOperations.clearPendingHmrEvent();
+ hmrAssetManager.dispose();
vendorBundleAbortController.abort();
if (vendorBundleUrl) {
URL.revokeObjectURL(vendorBundleUrl);
}
+ if (bundleUrlRef.current) {
+ URL.revokeObjectURL(bundleUrlRef.current);
+ bundleUrlRef.current = null;
+ }
+
workerRef.current = null;
lastSentProjectRef.current = null;
worker.terminate();
};
}, [
browserStudioOperations,
+ compileGeneration,
dependencyResolver,
hmrAssetManager,
publicFileManager,
@@ -813,11 +835,38 @@ export const BrowserStudio: React.FC<BrowserStudioProps> = ({
lastWrittenDocumentRef.current = contentDocument;
lastWrittenHtmlRef.current = iframeHtml;
+ const reloadCurrentStudio = () => {
+ if (
+ iframeRef.current?.contentWindow !== contentWindow ||
+ lastWrittenDocumentRef.current !== contentDocument
+ ) {
+ return;
+ }
+
+ reloadBrowserStudio();
+ };
+
+ const iframeOperations = {
+ ...browserStudioOperations,
+ subscribeToEvent: (
+ listener: Parameters<
+ typeof browserStudioOperations.subscribeToEvent
+ >[0],
+ ) => {
+ const unsubscribe = browserStudioOperations.subscribeToEvent(listener);
+ unsubscribeFromIframeEventsRef.current.add(unsubscribe);
+ return () => {
+ unsubscribeFromIframeEventsRef.current.delete(unsubscribe);
+ unsubscribe();
+ };
+ },
+ };
contentDocument.open();
(contentWindow as BrowserStudioContentWindow).remotion_browserStudioHmr =
hmrAssetManager.bridge;
- contentWindow.remotion_browserStudio = browserStudioOperations;
+ contentWindow.remotion_browserStudio = iframeOperations;
+ contentWindow.remotion_browserStudioReload = reloadCurrentStudio;
contentWindow.remotion_showBrowserStudioExperimentalNotice =
showExperimentalNotice;
contentDocument.write(iframeHtml);
@@ -828,7 +877,8 @@ export const BrowserStudio: React.FC<BrowserStudioProps> = ({
(
activeContentWindow as BrowserStudioContentWindow
).remotion_browserStudioHmr = hmrAssetManager.bridge;
- activeContentWindow.remotion_browserStudio = browserStudioOperations;
+ activeContentWindow.remotion_browserStudio = iframeOperations;
+ activeContentWindow.remotion_browserStudioReload = reloadCurrentStudio;
activeContentWindow.remotion_showBrowserStudioExperimentalNotice =
showExperimentalNotice;
activeContentWindow.dispatchEvent(
@@ -841,6 +891,7 @@ export const BrowserStudio: React.FC<BrowserStudioProps> = ({
iframeHtml,
iframeLoaded,
iframeSrc,
+ reloadBrowserStudio,
showExperimentalNotice,
]);
@@ -848,6 +899,7 @@ export const BrowserStudio: React.FC<BrowserStudioProps> = ({
<div style={containerStyle}>
{iframeHtml ? (
<iframe
+ key={compileGeneration}
ref={iframeRef}
allow="cross-origin-isolated"
onLoad={() => setIframeLoaded(true)}
diff --git a/packages/browser-studio/src/browser-studio-operations.ts b/packages/browser-studio/src/browser-studio-operations.ts
index d46b392fa5..4757498928 100644
--- a/packages/browser-studio/src/browser-studio-operations.ts
+++ b/packages/browser-studio/src/browser-studio-operations.ts
@@ -218,6 +218,7 @@ const runBrowserCompositionEdit = (
};
export type BrowserStudioOperationsController = BrowserStudioOperations & {
+ clearPendingHmrEvent: () => void;
emitEvent: (event: EventSourceEvent) => void;
resetHistory: () => void;
};
@@ -2471,6 +2472,7 @@ export const createBrowserStudioOperations = ({
duplicateNodes,
wrapNode,
effects: effectOperations,
+ clearPendingHmrEvent: controller.clearPendingHmrEvent,
emitEvent: controller.emitEvent,
findInFile: controller.findInFile,
getFileSource: controller.getFileSource,
diff --git a/packages/browser-studio/src/browser-studio-project-controller.ts b/packages/browser-studio/src/browser-studio-project-controller.ts
index efc658962e..c34fb4c3d6 100644
--- a/packages/browser-studio/src/browser-studio-project-controller.ts
+++ b/packages/browser-studio/src/browser-studio-project-controller.ts
@@ -357,6 +357,7 @@ const getFileSource = ({
export type BrowserStudioProjectController = {
applyMutation: (mutation: ProjectMutation) => SequenceNodePathMutation | null;
+ clearPendingHmrEvent: () => void;
deleteStaticFile: BrowserStudioOperations['deleteStaticFile'];
emitEvent: (event: EventSourceEvent) => void;
findInFile: BrowserStudioOperations['findInFile'];
@@ -695,6 +696,9 @@ export const createBrowserStudioProjectController = ({
return Promise.reject(error);
}
},
+ clearPendingHmrEvent: () => {
+ latestHmrEvent = null;
+ },
emitEvent: emit,
findInFile: (request) => {
const contents = getFileSource({
diff --git a/packages/browser-studio/src/browser-studio-vendor-runtime.ts b/packages/browser-studio/src/browser-studio-vendor-runtime.ts
index 03357d7fb1..c095564620 100644
--- a/packages/browser-studio/src/browser-studio-vendor-runtime.ts
+++ b/packages/browser-studio/src/browser-studio-vendor-runtime.ts
@@ -10,6 +10,7 @@ import * as RemotionNoReact from 'remotion/no-react';
import * as RemotionVersion from 'remotion/version';
let studioPromise: Promise<void> | null = null;
+let initializeStudioPreview: (() => void) | null = null;
const makeMutableNamespace = <Namespace extends object>(
namespace: Namespace,
): Namespace => ({
@@ -47,6 +48,13 @@ globalThis.remotion_browserStudioVendor = {
remotion: makeMutableNamespace(Remotion),
remotionNoReact: makeMutableNamespace(RemotionNoReact),
remotionVersion: makeMutableNamespace(RemotionVersion),
+ initializeStudioPreview: () => {
+ if (!initializeStudioPreview) {
+ throw new Error('Browser Studio preview bootstrap was not loaded');
+ }
+
+ initializeStudioPreview();
+ },
startStudio: () => {
studioPromise ??= import('@remotion/studio/previewEntry').then(
() => undefined,
@@ -55,7 +63,13 @@ globalThis.remotion_browserStudioVendor = {
},
};
-export const initializeBrowserStudioVendor = (projectBundleUrl: string) => {
+export const initializeBrowserStudioVendor = async (
+ projectBundleUrl: string,
+) => {
+ // Load the bootstrap after installing the HMR proxy, then let the project's
+ // early entry call it synchronously once its HMR runtime is available.
+ const bootstrap = await import('@remotion/studio/previewBootstrap');
+ initializeStudioPreview = bootstrap.initializeStudioPreview;
return import(projectBundleUrl);
};
@@ -91,6 +105,7 @@ declare global {
remotion: typeof Remotion;
remotionNoReact: typeof RemotionNoReact;
remotionVersion: typeof RemotionVersion;
+ initializeStudioPreview: () => void;
startStudio: () => Promise<void>;
};
}
diff --git a/packages/browser-studio/src/browser-studio-worker.ts b/packages/browser-studio/src/browser-studio-worker.ts
index e30a07bd29..f55fc038de 100644
--- a/packages/browser-studio/src/browser-studio-worker.ts
+++ b/packages/browser-studio/src/browser-studio-worker.ts
@@ -136,19 +136,25 @@ const createCompiler = async ({
});
}
+ // Older custom Studio releases do not expose previewBootstrap. Starting their
+ // preview entry early still installs their error overlay before user imports.
+ const studioBootstrap = useVendorBundle
+ ? browserStudioVirtualFilePaths.studioBootstrap
+ : '@remotion/studio/previewEntry';
const entryPoints = getStudioEntryPoints({
environmentSetup: browserStudioVirtualFilePaths.setupEnvironment,
fastRefreshRuntime: browserStudioVirtualFilePaths.reactRefreshEntry,
reactScan: null,
reactShim: browserStudioVirtualFilePaths.reactShim,
sequenceStackTraces: browserStudioVirtualFilePaths.setupSequenceStackTraces,
+ studioBootstrap,
studioRenderEntry: useVendorBundle
? browserStudioVirtualFilePaths.studioPreviewEntry
: '@remotion/studio/previewEntry',
userDefinedComponent: normalizeVirtualPath(project.entryPoint),
});
entryPoints.splice(
- entryPoints.length - 1,
+ entryPoints.indexOf(studioBootstrap),
0,
browserStudioVirtualFilePaths.browserRequireShim,
);
diff --git a/packages/browser-studio/src/virtual-files.ts b/packages/browser-studio/src/virtual-files.ts
index 04184174db..75e2674967 100644
--- a/packages/browser-studio/src/virtual-files.ts
+++ b/packages/browser-studio/src/virtual-files.ts
@@ -13,6 +13,7 @@ export const browserStudioVirtualFilePaths = {
setupSequenceStackTraces:
'/__remotion_browser_studio__/setup-sequence-stack-traces.ts',
studioPreviewEntry: '/__remotion_browser_studio__/studio-preview-entry.js',
+ studioBootstrap: '/__remotion_browser_studio__/studio-bootstrap.js',
jsxRuntime: '/__remotion_browser_studio__/jsx-runtime.ts',
jsxDevRuntime: '/__remotion_browser_studio__/jsx-dev-runtime.ts',
jsxImportSource: '/__remotion_browser_studio__',
@@ -45,6 +46,8 @@ if (RemotionRefreshRuntime.__remotionReactRefreshWrapped === null) {
return result;
};
}
+
+window.remotion_performReactRefresh = () => RemotionRefreshRuntime.performReactRefresh();
`;
const setupSequenceStackTraces = `import React from 'react';
@@ -152,7 +155,7 @@ globalThis.require = (id) => {
};
`;
-const studioPreviewEntry = `if (!globalThis.remotion_browserStudioVendor) {
+const studioBootstrap = `if (!globalThis.remotion_browserStudioVendor) {
throw new Error('Browser Studio vendor bundle was not loaded');
}
@@ -164,6 +167,10 @@ globalThis.remotion_browserStudioProjectHot = {
status: () => module.hot.status(),
};
+globalThis.remotion_browserStudioVendor.initializeStudioPreview();
+`;
+
+const studioPreviewEntry = `
void globalThis.remotion_browserStudioVendor.startStudio();
`;
@@ -183,6 +190,7 @@ export const getBrowserStudioVirtualFiles = (): Record<string, string> => {
[browserStudioVirtualFilePaths.setupSequenceStackTraces]:
setupSequenceStackTraces,
[browserStudioVirtualFilePaths.studioPreviewEntry]: studioPreviewEntry,
+ [browserStudioVirtualFilePaths.studioBootstrap]: studioBootstrap,
[browserStudioVirtualFilePaths.jsxRuntime]: jsxRuntime,
[browserStudioVirtualFilePaths.jsxDevRuntime]: jsxDevRuntime,
[browserStudioVirtualFilePaths.reactShim]: reactShim,
diff --git a/packages/bundler/src/fast-refresh/notify-on-refresh.ts b/packages/bundler/src/fast-refresh/notify-on-refresh.ts
index 02af53143e..83f432345d 100644
--- a/packages/bundler/src/fast-refresh/notify-on-refresh.ts
+++ b/packages/bundler/src/fast-refresh/notify-on-refresh.ts
@@ -26,3 +26,6 @@ if (RefreshRuntime.__remotionReactRefreshWrapped === null) {
return result;
};
}
+
+window.remotion_performReactRefresh = () =>
+ RefreshRuntime.performReactRefresh();
diff --git a/packages/bundler/src/rspack-config.ts b/packages/bundler/src/rspack-config.ts
index 3feefb120f..ef904f8c2f 100644
--- a/packages/bundler/src/rspack-config.ts
+++ b/packages/bundler/src/rspack-config.ts
@@ -111,6 +111,10 @@ export const rspackConfig = async ({
reactScan: getReactScanEntryPoint(environment),
environmentSetup: require.resolve('./setup-environment'),
sequenceStackTraces: require.resolve('./setup-sequence-stack-traces'),
+ studioBootstrap:
+ environment === 'development'
+ ? require.resolve('./setup-studio')
+ : null,
userDefinedComponent,
reactShim: require.resolve('../react-shim.js'),
studioRenderEntry: entry,
diff --git a/packages/bundler/src/setup-studio.ts b/packages/bundler/src/setup-studio.ts
new file mode 100644
index 0000000000..eb6d44f101
--- /dev/null
+++ b/packages/bundler/src/setup-studio.ts
@@ -0,0 +1,3 @@
+import {initializeStudioPreview} from '@remotion/studio/previewBootstrap';
+
+initializeStudioPreview();
diff --git a/packages/bundler/src/shared-bundler-config.ts b/packages/bundler/src/shared-bundler-config.ts
index 2ed2845f88..c20a6d911c 100644
--- a/packages/bundler/src/shared-bundler-config.ts
+++ b/packages/bundler/src/shared-bundler-config.ts
@@ -75,6 +75,7 @@ export const getResolveConfig = () => ({
[
'@remotion/studio',
'@remotion/studio/internals',
+ '@remotion/studio/previewBootstrap',
'@remotion/studio/previewEntry',
'@remotion/studio/renderEntry',
].flatMap((specifier) => {
diff --git a/packages/bundler/src/webpack-config.ts b/packages/bundler/src/webpack-config.ts
index 84bb2617ba..efb05ee044 100644
--- a/packages/bundler/src/webpack-config.ts
+++ b/packages/bundler/src/webpack-config.ts
@@ -74,6 +74,10 @@ export const webpackConfig = async ({
reactScan: getReactScanEntryPoint(environment),
environmentSetup: require.resolve('./setup-environment'),
sequenceStackTraces: require.resolve('./setup-sequence-stack-traces'),
+ studioBootstrap:
+ environment === 'development'
+ ? require.resolve('./setup-studio')
+ : null,
userDefinedComponent,
reactShim: require.resolve('../react-shim.js'),
studioRenderEntry: entry,
diff --git a/packages/studio-shared/src/get-location-from-build-error.ts b/packages/studio-shared/src/get-location-from-build-error.ts
index b64b3a7deb..c1a8ecb5c5 100644
--- a/packages/studio-shared/src/get-location-from-build-error.ts
+++ b/packages/studio-shared/src/get-location-from-build-error.ts
@@ -44,7 +44,10 @@ export const getLocationFromBuildError = (err: Error): ErrorLocation | null => {
return null;
}
- if (s.includes('webpackMissingModule')) {
+ if (
+ s.includes('webpackMissingModule') ||
+ s.includes('__rspack_missing_module')
+ ) {
return null;
}
diff --git a/packages/studio-shared/src/react-refresh-event.ts b/packages/studio-shared/src/react-refresh-event.ts
index 3db5f9d547..e9e61f810a 100644
--- a/packages/studio-shared/src/react-refresh-event.ts
+++ b/packages/studio-shared/src/react-refresh-event.ts
@@ -1,4 +1,10 @@
import {Internals} from 'remotion';
+declare global {
+ interface Window {
+ remotion_performReactRefresh: (() => unknown) | null;
+ }
+}
+
export const {REACT_REFRESH_STARTED_EVENT, REACT_REFRESH_FINISHED_EVENT} =
Internals;
diff --git a/packages/studio-shared/src/studio-entry-points.ts b/packages/studio-shared/src/studio-entry-points.ts
index bd73df120f..3371e42c70 100644
--- a/packages/studio-shared/src/studio-entry-points.ts
+++ b/packages/studio-shared/src/studio-entry-points.ts
@@ -3,6 +3,7 @@ export type StudioEntryPointPaths = {
reactScan: string | null;
environmentSetup: string;
sequenceStackTraces: string | null;
+ studioBootstrap: string | null;
userDefinedComponent: string;
reactShim: string;
studioRenderEntry: string;
@@ -13,6 +14,7 @@ export const getStudioEntryPoints = ({
reactScan,
environmentSetup,
sequenceStackTraces,
+ studioBootstrap,
userDefinedComponent,
reactShim,
studioRenderEntry,
@@ -24,6 +26,7 @@ export const getStudioEntryPoints = ({
reactScan,
environmentSetup,
sequenceStackTraces,
+ studioBootstrap,
userDefinedComponent,
reactShim,
studioRenderEntry,
diff --git a/packages/studio-shared/src/studio-html.ts b/packages/studio-shared/src/studio-html.ts
index 1e11634b49..2c6a1ac591 100644
--- a/packages/studio-shared/src/studio-html.ts
+++ b/packages/studio-shared/src/studio-html.ts
@@ -5,6 +5,16 @@ import type {PackageManager} from './package-manager';
import type {RenderDefaults} from './render-defaults';
import type {StudioRuntimeConfig} from './studio-runtime-config';
+declare global {
+ interface Window {
+ remotion_browserStudioReload: (() => void) | null;
+ remotion_studioStartup: {
+ takeErrors: () => Error[];
+ dismiss: () => void;
+ } | null;
+ }
+}
+
export type StudioHtmlOptions = {
staticHash: string;
publicPath: string;
@@ -82,6 +92,66 @@ export const studioHtml = ({
isRelativeBundle && publicFolderExists
? `new URL(${JSON.stringify(publicFolderExists)}, window.location.href).pathname`
: JSON.stringify(publicFolderExists);
+ const startupErrorHtml =
+ mode === 'dev'
+ ? `
+ <style>
+ #remotion-studio-startup-reload { appearance: none; background: transparent; border: none; border-radius: 3px; color: #a6a7a9; cursor: default; padding: 8px 16px; font: inherit; }
+ #remotion-studio-startup-reload:hover { color: white; }
+ #remotion-studio-startup-reload:focus { outline: none; box-shadow: none; }
+ #remotion-studio-startup-reload:focus-visible { box-shadow: inset 1px 1px #555, inset -1px -1px #555, inset 1px -1px #555, inset -1px 1px #555; }
+ </style>
+ <div id="remotion-studio-startup-error" role="alert" hidden style="position: fixed; inset: 0; overflow: auto; z-index: 2147483647; box-sizing: border-box; padding: 40px; background: #1f1f1f; color: white; font-family: sans-serif;">
+ <h1 style="margin-top: 0; font-size: 24px;">Studio could not start</h1>
+ <pre id="remotion-studio-startup-error-message" style="white-space: pre-wrap; overflow-wrap: anywhere; font-size: 14px; line-height: 1.5;"></pre>
+ <p>Fix the error in your project, then reload Studio.</p>
+ <button id="remotion-studio-startup-reload" type="button">Reload Studio</button>
+ </div>
+ <script>
+ (function () {
+ var errors = [];
+ var fallback = document.getElementById('remotion-studio-startup-error');
+ var message = document.getElementById('remotion-studio-startup-error-message');
+ function showError(error) {
+ var normalized = error instanceof Error ? error : new Error(String(error));
+ errors.push(normalized);
+ message.textContent = normalized.stack || normalized.message;
+ fallback.hidden = false;
+ }
+ function onError(event) {
+ if (event.target instanceof HTMLScriptElement && event.target.id === '__remotion_bundle') {
+ showError(new Error('Could not load the Studio JavaScript bundle. Check that the Studio server is running and reload the page.'));
+ } else if (event instanceof ErrorEvent) {
+ showError(event.error || new Error(event.message));
+ }
+ }
+ function onUnhandledRejection(event) {
+ showError(event.reason);
+ }
+ window.addEventListener('error', onError, true);
+ window.addEventListener('unhandledrejection', onUnhandledRejection);
+ document.getElementById('remotion-studio-startup-reload').addEventListener('click', function () {
+ if (typeof window.remotion_browserStudioReload === 'function') {
+ window.remotion_browserStudioReload();
+ } else {
+ window.location.reload();
+ }
+ });
+ window.remotion_studioStartup = {
+ takeErrors: function () {
+ return errors.splice(0);
+ },
+ dismiss: function () {
+ window.removeEventListener('error', onError, true);
+ window.removeEventListener('unhandledrejection', onUnhandledRejection);
+ errors.length = 0;
+ fallback.remove();
+ window.remotion_studioStartup = null;
+ }
+ };
+ })();
+ </script>`
+ : '';
return `
<!DOCTYPE html>
@@ -102,6 +172,7 @@ export const studioHtml = ({
<title>${title}</title>
</head>
<body>
+ ${startupErrorHtml}
<script>window.remotion_numberOfAudioTags = ${numberOfAudioTags};</script>
<script>window.remotion_audioLatencyHint = "${audioLatencyHint}";</script>
<script>window.remotion_experimentalKeepAudioContextAlive = ${experimentalKeepAudioContextAlive};</script>
@@ -195,7 +266,7 @@ export const studioHtml = ({
<div id="menuportal-3"></div>
<div id="menuportal-4"></div>
<div id="menuportal-5"></div>
- <script${bundleScriptType === 'module' ? ' type="module"' : ''} src="${scriptUrl}"></script>
+ <script${mode === 'dev' ? ' id="__remotion_bundle"' : ''}${bundleScriptType === 'module' ? ' type="module"' : ''} src="${scriptUrl}"></script>
</body>
</html>
`.trim();
diff --git a/packages/studio/bundle.ts b/packages/studio/bundle.ts
index c138dc728b..788f424b00 100644
--- a/packages/studio/bundle.ts
+++ b/packages/studio/bundle.ts
@@ -47,6 +47,11 @@ await buildPackage({
target: 'browser',
splitting: true,
},
+ {
+ path: 'src/previewBootstrap.ts',
+ target: 'browser',
+ splitting: true,
+ },
{
path: 'src/previewEntry.tsx',
target: 'browser',
diff --git a/packages/studio/package.json b/packages/studio/package.json
index 53d6dff630..4ce151e58b 100644
--- a/packages/studio/package.json
+++ b/packages/studio/package.json
@@ -95,6 +95,12 @@
"module": "./dist/esm/internals.mjs",
"import": "./dist/esm/internals.mjs"
},
+ "./previewBootstrap": {
+ "types": "./dist/previewBootstrap.d.ts",
+ "require": "./dist/previewBootstrap.js",
+ "module": "./dist/esm/previewBootstrap.mjs",
+ "import": "./dist/esm/previewBootstrap.mjs"
+ },
"./previewEntry": {
"types": "./dist/previewEntry.d.ts",
"require": "./dist/previewEntry.js",
@@ -111,6 +117,9 @@
"internals": [
"./dist/internals.d.ts"
],
+ "previewBootstrap": [
+ "./dist/previewBootstrap.d.ts"
+ ],
"previewEntry": [
"./dist/previewEntry.d.ts"
]
diff --git a/packages/studio/src/Studio.tsx b/packages/studio/src/Studio.tsx
index 949fe61da5..f1b8291615 100644
--- a/packages/studio/src/Studio.tsx
+++ b/packages/studio/src/Studio.tsx
@@ -72,6 +72,7 @@ export const Studio: React.FC<{
}> = ({rootComponent, readOnly}) => {
useLayoutEffect(() => {
injectCSS();
+ window.remotion_studioStartup?.dismiss();
}, []);
return (
diff --git a/packages/studio/src/error-overlay/entry-basic.ts b/packages/studio/src/error-overlay/entry-basic.ts
index c2d58fcfdb..fe7506e1fd 100644
--- a/packages/studio/src/error-overlay/entry-basic.ts
+++ b/packages/studio/src/error-overlay/entry-basic.ts
@@ -1,7 +1,5 @@
-import {reloadUrl} from '../helpers/url-state';
-import {didUnmountReactApp, startReportingRuntimeErrors} from './react-overlay';
+import {startReportingRuntimeErrors} from './react-overlay';
import {mountRemotionOverlay} from './remotion-overlay';
-import {setErrorsRef} from './remotion-overlay/Overlay';
declare global {
const __webpack_hash__: unknown;
@@ -19,11 +17,11 @@ declare global {
/**
* The module in question.
*/
- moduleId: number;
+ moduleId: ModuleId;
/**
* For errors: the module id owning the accept handler.
*/
- dependencyId?: number | undefined;
+ dependencyId?: ModuleId | undefined;
/**
* For declined/accepted/unaccepted: the chain from where the update was propagated.
*/
@@ -111,20 +109,6 @@ declare global {
}
export const startErrorOverlay = () => {
- startReportingRuntimeErrors(() => {
- if (__webpack_module__.hot) {
- __webpack_module__.hot.addStatusHandler((status) => {
- if (status === 'apply') {
- if (didUnmountReactApp()) {
- return reloadUrl();
- }
-
- setErrorsRef.current?.setErrors({
- type: 'clear',
- });
- }
- });
- }
- });
+ startReportingRuntimeErrors();
mountRemotionOverlay();
};
diff --git a/packages/studio/src/error-overlay/react-overlay/effects/resolve-file-source.ts b/packages/studio/src/error-overlay/react-overlay/effects/resolve-file-source.ts
index 91b003117e..1f32c64b28 100644
--- a/packages/studio/src/error-overlay/react-overlay/effects/resolve-file-source.ts
+++ b/packages/studio/src/error-overlay/react-overlay/effects/resolve-file-source.ts
@@ -20,9 +20,14 @@ export const resolveFileSource = async (
text = browserSource;
} else {
- text = await (
- await fetch(`/api/file-source?f=${encodeURIComponent(location.fileName)}`)
- ).text();
+ const response = await fetch(
+ `/api/file-source?f=${encodeURIComponent(location.fileName)}`,
+ );
+ if (!response.ok) {
+ throw new Error(`Could not load source for ${location.fileName}`);
+ }
+
+ text = await response.text();
}
const lines = text
diff --git a/packages/studio/src/error-overlay/react-overlay/index.ts b/packages/studio/src/error-overlay/react-overlay/index.ts
index ec8d5ae531..afc1e4b5ad 100644
--- a/packages/studio/src/error-overlay/react-overlay/index.ts
+++ b/packages/studio/src/error-overlay/react-overlay/index.ts
@@ -7,14 +7,10 @@ export const didUnmountReactApp = () => {
return !Internals.getPreviewDomElement()?.hasChildNodes();
};
-export function startReportingRuntimeErrors(onError: () => void) {
+export function startReportingRuntimeErrors() {
if (stopListeningToRuntimeErrors !== null) {
throw new Error('Already listening');
}
- const handleRuntimeError = () => {
- onError();
- };
-
- stopListeningToRuntimeErrors = listenToRuntimeErrors(handleRuntimeError);
+ stopListeningToRuntimeErrors = listenToRuntimeErrors();
}
diff --git a/packages/studio/src/error-overlay/react-overlay/listen-to-runtime-errors.ts b/packages/studio/src/error-overlay/react-overlay/listen-to-runtime-errors.ts
index 8f713cf50c..10feae7156 100644
--- a/packages/studio/src/error-overlay/react-overlay/listen-to-runtime-errors.ts
+++ b/packages/studio/src/error-overlay/react-overlay/listen-to-runtime-errors.ts
@@ -7,7 +7,7 @@
import type {SymbolicatedStackFrame} from '@remotion/studio-shared';
import {reloadUrl} from '../../helpers/url-state';
import {markErrorAsLoggedByServer} from '../error-origin';
-import {setErrorsRef} from '../remotion-overlay/Overlay';
+import {addErrorToOverlay} from '../runtime-error-store';
import {massageWarning} from './effects/format-warning';
import {
permanentRegister as permanentRegisterConsole,
@@ -52,7 +52,7 @@ export const getErrorRecord = async (
};
};
-const crashWithFrames = (crash: () => void) => (error: Error) => {
+const handleRuntimeError = (error: Error) => {
const didHookOrderChange =
error.message.startsWith('Rendered fewer hooks') ||
error.message.startsWith('Rendered more hooks') ||
@@ -78,20 +78,16 @@ const crashWithFrames = (crash: () => void) => (error: Error) => {
reloadUrl();
} else {
- setErrorsRef.current?.addError(error);
-
- crash();
+ addErrorToOverlay(error, null);
}
};
-export function listenToRuntimeErrors(crash: () => void) {
- const crashWithFramesRunTime = crashWithFrames(crash);
-
+export function listenToRuntimeErrors() {
registerError(window, (error) => {
- return crashWithFramesRunTime(error);
+ return handleRuntimeError(error);
});
registerPromise(window, (error) => {
- return crashWithFramesRunTime(error);
+ return handleRuntimeError(error);
});
registerStackTraceLimit();
registerReactStack();
@@ -106,12 +102,12 @@ export function listenToRuntimeErrors(crash: () => void) {
};
markErrorAsLoggedByServer(error);
- crashWithFramesRunTime(error);
+ handleRuntimeError(error);
}
if (d.type === 'build-error') {
markErrorAsLoggedByServer(d.error);
- crashWithFramesRunTime(d.error);
+ handleRuntimeError(d.error);
}
});
diff --git a/packages/studio/src/error-overlay/remotion-overlay/ErrorDisplay.tsx b/packages/studio/src/error-overlay/remotion-overlay/ErrorDisplay.tsx
index 494d4b5c19..5987d35dc1 100644
--- a/packages/studio/src/error-overlay/remotion-overlay/ErrorDisplay.tsx
+++ b/packages/studio/src/error-overlay/remotion-overlay/ErrorDisplay.tsx
@@ -11,6 +11,7 @@ import {
WHITE,
WHITE_ALPHA_60,
} from '../../helpers/colors';
+import {didUnmountReactApp} from '../react-overlay';
import type {ErrorRecord} from '../react-overlay/listen-to-runtime-errors';
import {AskOnDiscord} from './AskOnDiscord';
import {CalculateMetadataErrorExplainer} from './CalculateMetadataErrorExplainer';
@@ -94,6 +95,7 @@ export const ErrorDisplay: React.FC<{
const {previewServerState} = useContext(StudioServerConnectionCtx);
const {canOpenInEditor, defaultEditorId, defaultEditorName} =
useEditorOpening(previewServerState.type === 'connected');
+ const canShowProjectActions = !didUnmountReactApp();
const stackFrames = useMemo(() => {
const withoutReactInternals = display.stackFrames.filter((frame) => {
const fileName = `/${frame.originalFileName?.replaceAll('\\', '/') ?? ''}`;
@@ -169,7 +171,8 @@ export const ErrorDisplay: React.FC<{
<div style={spacer} />
</>
) : null}
- {stackFrames.length > 0 &&
+ {canShowProjectActions &&
+ stackFrames.length > 0 &&
canOpenInEditor &&
defaultEditorId &&
defaultEditorName ? (
@@ -184,12 +187,14 @@ export const ErrorDisplay: React.FC<{
<div style={spacer} />
</>
) : null}
- <CodingAgentButton
- label="Fix with"
- prompt={fixWithAgentPrompt}
- size="default"
- style={codingAgentButton}
- />
+ {canShowProjectActions ? (
+ <CodingAgentButton
+ label="Fix with"
+ prompt={fixWithAgentPrompt}
+ size="default"
+ style={codingAgentButton}
+ />
+ ) : null}
<CopyStackTrace errorText={errorTextForCopy} />
<div style={spacer} />
<SearchGithubIssues
@@ -237,7 +242,11 @@ export const ErrorDisplay: React.FC<{
horizontalSpacing={14}
lineNumberWidth={lineNumberWidth}
defaultFunctionName={'(anonymous function)'}
- editorId={canOpenInEditor ? defaultEditorId : null}
+ editorId={
+ canShowProjectActions && canOpenInEditor
+ ? defaultEditorId
+ : null
+ }
/>
);
})}
diff --git a/packages/studio/src/error-overlay/remotion-overlay/Overlay.tsx b/packages/studio/src/error-overlay/remotion-overlay/Overlay.tsx
index f7027f890b..b597446a1b 100644
--- a/packages/studio/src/error-overlay/remotion-overlay/Overlay.tsx
+++ b/packages/studio/src/error-overlay/remotion-overlay/Overlay.tsx
@@ -1,70 +1,31 @@
-import React, {
- createRef,
- useCallback,
- useImperativeHandle,
- useState,
-} from 'react';
+import React, {useLayoutEffect, useState} from 'react';
import {Internals} from 'remotion';
import {MENU_TOOLBAR_HEIGHT} from '../../components/menu-toolbar-height';
import {SettingsProvider} from '../../components/SettingsContext';
import {PreviewServerConnection} from '../../helpers/client-id';
import {BACKGROUND_HEX, WHITE} from '../../helpers/colors';
import {KeybindingContextProvider} from '../../state/keybindings';
+import {
+ getRuntimeErrors,
+ subscribeToRuntimeErrors,
+} from '../runtime-error-store';
import {ErrorLoader} from './ErrorLoader';
-type SetErrors = {
- setErrors: (errs: State) => void;
- addError: (err: Error) => void;
-};
-
-export const setErrorsRef = createRef<SetErrors>();
-
-type State =
- | {
- type: 'clear';
- }
- | {
- type: 'errors';
- errors: Error[];
- };
-
-const errorsAreTheSame = (first: Error, second: Error) => {
- return first.stack === second.stack && first.message === second.message;
-};
-
const BACKGROUND_COLOR = BACKGROUND_HEX;
export const Overlay: React.FC = () => {
- const [errors, setErrors] = useState<State>({type: 'clear'});
+ const [errors, setErrors] = useState(getRuntimeErrors);
- const addError = useCallback((err: Error) => {
- setErrors((state) => {
- if (state.type === 'errors') {
- if (state.errors.some((e) => errorsAreTheSame(e, err))) {
- return state;
- }
-
- return {
- ...state,
- errors: [...state.errors, err],
- };
- }
-
- return {
- type: 'errors',
- errors: [err],
- };
- });
+ useLayoutEffect(() => {
+ return subscribeToRuntimeErrors(() => setErrors(getRuntimeErrors()));
}, []);
- useImperativeHandle(setErrorsRef, () => {
- return {setErrors, addError};
- }, [addError]);
-
- if (errors.type === 'clear') {
- return null;
- }
+ useLayoutEffect(() => {
+ if (errors.length > 0) {
+ window.remotion_studioStartup?.dismiss();
+ }
+ }, [errors]);
- if (errors.errors.length === 0) {
+ if (errors.length === 0) {
return null;
}
@@ -81,7 +42,7 @@ export const Overlay: React.FC = () => {
height: `calc(100% - ${MENU_TOOLBAR_HEIGHT}px)`,
}}
>
- {errors.errors.map((err, i) => {
+ {errors.map(({error: err}, i) => {
return (
<ErrorLoader
// eslint-disable-next-line react/no-array-index-key
diff --git a/packages/studio/src/error-overlay/runtime-error-store.ts b/packages/studio/src/error-overlay/runtime-error-store.ts
new file mode 100644
index 0000000000..968e43a5ef
--- /dev/null
+++ b/packages/studio/src/error-overlay/runtime-error-store.ts
@@ -0,0 +1,96 @@
+import type {ModuleMap} from '@remotion/studio-shared';
+
+type RuntimeError = {
+ readonly error: Error;
+ readonly moduleIds: ModuleId[] | null;
+};
+
+let errors: RuntimeError[] = [];
+const listeners = new Set<() => void>();
+
+export const getRuntimeErrors = () => errors;
+
+export const subscribeToRuntimeErrors = (listener: () => void) => {
+ listeners.add(listener);
+ // Read again after subscribing so errors between render and commit are kept.
+ listener();
+ return () => {
+ listeners.delete(listener);
+ };
+};
+
+export const addErrorToOverlay = (
+ error: Error,
+ moduleIds: ModuleId[] | null,
+) => {
+ const existing = errors.findIndex(
+ (candidate) =>
+ candidate.error.stack === error.stack &&
+ candidate.error.message === error.message,
+ );
+ const record: RuntimeError = {
+ error,
+ moduleIds: moduleIds ?? errors[existing]?.moduleIds ?? null,
+ };
+ // Replace repeated records too: a repeated error during HMR has not recovered.
+ errors =
+ existing === -1
+ ? [...errors, record]
+ : errors.map((previous, index) =>
+ index === existing ? record : previous,
+ );
+ for (const listener of listeners) {
+ listener();
+ }
+};
+
+export const clearRecoveredRuntimeErrors = ({
+ errorsBeforeUpdate,
+ updatedModules,
+ failedModules,
+ moduleMap,
+ reactRefreshFinished,
+}: {
+ errorsBeforeUpdate: RuntimeError[];
+ updatedModules: ModuleId[];
+ failedModules: Set<ModuleId>;
+ moduleMap: ModuleMap;
+ reactRefreshFinished: boolean;
+}) => {
+ const refreshedProject =
+ reactRefreshFinished &&
+ failedModules.size === 0 &&
+ updatedModules.some((moduleId) => {
+ const name = moduleMap[moduleId] || String(moduleId);
+ return (
+ (name.startsWith('./') ||
+ name.startsWith('../') ||
+ name.startsWith('/') ||
+ name.startsWith('src/')) &&
+ !name.includes('node_modules/') &&
+ !name.includes('!lazy-compilation-proxy')
+ );
+ });
+ const remaining = errors.filter((record) => {
+ if (!errorsBeforeUpdate.includes(record)) {
+ return true;
+ }
+
+ if (record.moduleIds === null) {
+ return !refreshedProject;
+ }
+
+ return (
+ !record.moduleIds.some((id) => updatedModules.includes(id)) ||
+ record.moduleIds.some((id) => failedModules.has(id))
+ );
+ });
+ if (remaining.length === errors.length) {
+ return;
+ }
+
+ errors = remaining;
+ for (const listener of listeners) {
+ listener();
+ }
+};
diff --git a/packages/studio/src/helpers/url-state.ts b/packages/studio/src/helpers/url-state.ts
index 3630f04bed..6879cdb990 100644
--- a/packages/studio/src/helpers/url-state.ts
+++ b/packages/studio/src/helpers/url-state.ts
@@ -39,6 +39,11 @@ export const clearUrl = () => {
};
export const reloadUrl = () => {
+ if (window.remotion_browserStudioReload) {
+ window.remotion_browserStudioReload();
+ return;
+ }
+
window.location.reload();
};
diff --git a/packages/studio/src/hot-middleware-client/process-update.ts b/packages/studio/src/hot-middleware-client/process-update.ts
index cfbea1bf9d..28de9f33f4 100644
--- a/packages/studio/src/hot-middleware-client/process-update.ts
+++ b/packages/studio/src/hot-middleware-client/process-update.ts
@@ -12,6 +12,12 @@
*/
import type {HotMiddlewareOptions, ModuleMap} from '@remotion/studio-shared';
+import {REACT_REFRESH_FINISHED_EVENT} from '@remotion/studio-shared';
+import {
+ addErrorToOverlay,
+ clearRecoveredRuntimeErrors,
+ getRuntimeErrors,
+} from '../error-overlay/runtime-error-store';
import {reloadUrl} from '../helpers/url-state';
if (!__webpack_module__.hot) {
@@ -67,9 +73,8 @@ export const processUpdate = function (
options: HotMiddlewareOptions,
) {
async function check() {
- const cb = function (err: Error | null, updatedModules: ModuleId[] | null) {
- if (err) return handleError(err);
-
+ try {
+ const updatedModules = await __webpack_module__.hot.check(false);
if (!updatedModules) {
if (options.warn) {
console.warn(
@@ -84,35 +89,74 @@ export const processUpdate = function (
return null;
}
- const applyCallback = function (
- applyErr: Error | null,
- renewedModules: ModuleId[],
- ) {
- if (applyErr) return handleError(applyErr);
+ const errorsBeforeUpdate = getRuntimeErrors();
+ const failedModules = new Set<ModuleId>();
+ let reactRefreshFinished = false;
+ const onReactRefreshFinished = () => {
+ reactRefreshFinished = true;
+ };
+
+ window.addEventListener(
+ REACT_REFRESH_FINISHED_EVENT,
+ onReactRefreshFinished,
+ );
+ try {
+ const renewedModules = await __webpack_module__.hot.apply({
+ ...applyOptions,
+ onErrored(data) {
+ const moduleIds = [data.moduleId];
+ if (data.dependencyId !== undefined) {
+ moduleIds.push(data.dependencyId);
+ }
+
+ for (const moduleId of moduleIds) {
+ failedModules.add(moduleId);
+ }
+
+ const error =
+ data.error ??
+ data.originalError ??
+ new Error('Hot update failed');
+ addErrorToOverlay(
+ error instanceof Error ? error : new Error(String(error)),
+ moduleIds,
+ );
+ applyOptions.onErrored?.(data);
+ },
+ });
+ // Rspack schedules its refresh after apply. Flush it now so recovery
+ // follows the refreshed root, including errors from rendering it.
+ try {
+ window.remotion_performReactRefresh?.();
+ } catch (err) {
+ reactRefreshFinished = false;
+ addErrorToOverlay(
+ err instanceof Error ? err : new Error(String(err)),
+ null,
+ );
+ }
+
+ clearRecoveredRuntimeErrors({
+ errorsBeforeUpdate,
+ updatedModules: renewedModules,
+ failedModules,
+ moduleMap,
+ reactRefreshFinished,
+ });
if (!upToDate()) {
check();
}
logUpdates(updatedModules, renewedModules);
- };
-
- const applyResult = __webpack_module__.hot?.apply(applyOptions);
- if ((applyResult as unknown as Promise<unknown>)?.then) {
- // HotModuleReplacement.runtime.js refers to the result as `outdatedModules`
- (applyResult as unknown as Promise<ModuleId[]>)
- .then((outdatedModules) => {
- applyCallback(null, outdatedModules);
- })
- .catch((_err: Error) => applyCallback(_err, []));
+ } finally {
+ window.removeEventListener(
+ REACT_REFRESH_FINISHED_EVENT,
+ onReactRefreshFinished,
+ );
}
- };
-
- try {
- const result = await __webpack_module__.hot?.check(false);
- cb(null, result);
} catch (err) {
- cb(err as Error, []);
+ handleError(err as Error);
}
}
diff --git a/packages/studio/src/initialize-studio-preview.ts b/packages/studio/src/initialize-studio-preview.ts
new file mode 100644
index 0000000000..990f4e631a
--- /dev/null
+++ b/packages/studio/src/initialize-studio-preview.ts
@@ -0,0 +1,41 @@
+import {CanvasInternals} from '@remotion/sdk';
+import {Internals} from 'remotion';
+import {startErrorOverlay} from './error-overlay/entry-basic';
+import {addErrorToOverlay} from './error-overlay/runtime-error-store';
+import {BACKGROUND_HEX} from './helpers/colors';
+import {injectCSS} from './helpers/inject-css';
+import {studioCssVariables} from './helpers/studio-css-variables';
+import {enableHotMiddleware} from './hot-middleware-client/client';
+
+declare global {
+ interface Window {
+ __remotionOverlayStarted: boolean;
+ }
+}
+
+// Initialize before the project entry point so failed imports cannot prevent
+// runtime error reporting and hot reload from initializing.
+export const initializeStudioPreview = () => {
+ if (window.__remotionOverlayStarted) {
+ return;
+ }
+
+ CanvasInternals.installFiberCommitOrderObserver(window);
+ Internals.CSSUtils.injectCSS(studioCssVariables);
+ Internals.CSSUtils.injectCSS(
+ Internals.CSSUtils.makeDefaultPreviewCSS(null, BACKGROUND_HEX),
+ );
+ injectCSS();
+
+ try {
+ startErrorOverlay();
+ enableHotMiddleware();
+ window.__remotionOverlayStarted = true;
+ for (const error of window.remotion_studioStartup?.takeErrors() ?? []) {
+ addErrorToOverlay(error, null);
+ }
+ } catch (err) {
+ // eslint-disable-next-line no-console
+ console.error('Failed to initialize error overlay', err);
+ }
+};
diff --git a/packages/studio/src/previewBootstrap.ts b/packages/studio/src/previewBootstrap.ts
new file mode 100644
index 0000000000..be6502a1bc
--- /dev/null
+++ b/packages/studio/src/previewBootstrap.ts
@@ -0,0 +1 @@
+export {initializeStudioPreview} from './initialize-studio-preview';
diff --git a/packages/studio/src/previewEntry.tsx b/packages/studio/src/previewEntry.tsx
index 4e4efce0f1..de7df4964c 100644
--- a/packages/studio/src/previewEntry.tsx
+++ b/packages/studio/src/previewEntry.tsx
@@ -1,38 +1,12 @@
-import {CanvasInternals} from '@remotion/sdk';
import React from 'react';
import ReactDOM from 'react-dom/client';
import {Internals} from 'remotion';
import {NoReactInternals} from 'remotion/no-react';
import {NoRegisterRoot} from './components/NoRegisterRoot';
-import {startErrorOverlay} from './error-overlay/entry-basic';
-import {BACKGROUND_HEX} from './helpers/colors';
-import {studioCssVariables} from './helpers/studio-css-variables';
-import {enableHotMiddleware} from './hot-middleware-client/client';
+import {initializeStudioPreview} from './initialize-studio-preview';
import {Studio} from './Studio';
-CanvasInternals.installFiberCommitOrderObserver(window);
-
-Internals.CSSUtils.injectCSS(studioCssVariables);
-Internals.CSSUtils.injectCSS(
- Internals.CSSUtils.makeDefaultPreviewCSS(null, BACKGROUND_HEX),
-);
-
-declare global {
- interface Window {
- __remotionOverlayStarted: boolean;
- }
-}
-
-if (!window.__remotionOverlayStarted) {
- window.__remotionOverlayStarted = true;
- try {
- startErrorOverlay();
- enableHotMiddleware();
- } catch (err) {
- // eslint-disable-next-line no-console
- console.error('Failed to initialize error overlay', err);
- }
-}
+initializeStudioPreview();
let root: ReturnType<typeof ReactDOM.createRoot> | null = null;