🎥 Make videos programmatically with React
@remotion/browser-studio: Add Studio loading progress bar
Jonny Burger1e8de67a5776
diff --git a/packages/browser-studio/e2e/browser-studio.test.ts b/packages/browser-studio/e2e/browser-studio.test.tsindex e4dd251d97..c020794b0d 100644--- a/packages/browser-studio/e2e/browser-studio.test.ts+++ b/packages/browser-studio/e2e/browser-studio.test.ts@@ -92,9 +92,25 @@ test('loads Browser Studio, opens external links, and can add, delete, and dupliconst workspacePackageRequests: string[] = [];let vendorBundleStartedBeforeIframe = false;let rejectPageError: (error: Error) => void = () => undefined;+ let markVendorBundleRequestStarted: () => void = () => undefined;+ let releaseVendorBundleRequest: () => void = () => undefined;const pageError = new Promise<never>((_resolve, reject) => {rejectPageError = reject;});+ const vendorBundleRequestStarted = new Promise<void>((resolve) => {+ markVendorBundleRequestStarted = resolve;+ });+ const waitBeforeServingVendorBundle = new Promise<void>((resolve) => {+ releaseVendorBundleRequest = resolve;+ });+ const client = await page.context().newCDPSession(page);+ await client.send('Network.enable');+ await client.send('Network.emulateNetworkConditions', {+ downloadThroughput: 10 * 1024 * 1024,+ latency: 0,+ offline: false,+ uploadThroughput: 10 * 1024 * 1024,+ });page.on('request', (request) => {const requestUrl = new URL(request.url());if (requestUrl.searchParams.has('browserStudioVendor')) {@@ -130,10 +146,26 @@ test('loads Browser Studio, opens external links, and can add, delete, and dupliawait page.context().route('https://remotion.dev/**', async (route) => {await route.fulfill({body: 'About Remotion', contentType: 'text/html'});});+ await page.context().route(/\.mjs\?browserStudioVendor$/, async (route) => {+ markVendorBundleRequestStarted();+ await waitBeforeServingVendorBundle;+ await route.continue();+ });await Promise.race([(async () => {- await page.goto('/');+ await page.goto('/', {waitUntil: 'commit'});+ await vendorBundleRequestStarted;+ const loadingProgress = page.getByRole('progressbar', {+ name: 'Loading Studio',+ });+ await expect(loadingProgress).toBeVisible({timeout: 5000});+ releaseVendorBundleRequest();+ await expect(loadingProgress).toHaveAttribute(+ 'aria-valuenow',+ /[1-9]\d*/,+ {timeout: 10_000},+ );const studio = page.frameLocator('iframe');await expect(studio.getByTitle('/project').getByText('MyComp'),diff --git a/packages/browser-studio/src/BrowserStudio.tsx b/packages/browser-studio/src/BrowserStudio.tsxindex d3aa798309..79bb3eb6bc 100644--- a/packages/browser-studio/src/BrowserStudio.tsx+++ b/packages/browser-studio/src/BrowserStudio.tsx@@ -12,8 +12,8 @@ import {} from './browser-studio-project-controller';import {browserStudioDependencyVersions} from './dependency-versions';import {studioRenderEntryExternal} from './dev/studio-render-entry-external';+import {LoadingProgress} from './LoadingProgress';import {deleteBrowserStudioProjectStorage} from './opfs-public-files';-import {Spinner} from './Spinner';import type {BrowserStudioDependencyResolution,BrowserStudioProps,@@ -152,6 +152,7 @@ export const BrowserStudio: React.FC<BrowserStudioProps> = ({const [state, setState] = useState<CompileState>(makeInitialState);const [iframeHtml, setIframeHtml] = useState<string | null>(null);const [iframeLoaded, setIframeLoaded] = useState(false);+ const [loadingProgress, setLoadingProgress] = useState<number | null>(null);const installedDependencyResolutionsRef = useRef<Record<string, BrowserStudioDependencyResolution>>({});@@ -366,11 +367,58 @@ export const BrowserStudio: React.FC<BrowserStudioProps> = ({remotionPackageSource.version ===browserStudioDependencyVersions.remotion;const useVendorBundle = !hasVendorOverride && releaseMatchesVendor;+ const downloadProgress: Record<+ 'vendor-bundle' | 'rspack-wasm',+ {loadedBytes: number; totalBytes: number | null} | null+ > = {+ 'rspack-wasm': {loadedBytes: 0, totalBytes: null},+ 'vendor-bundle': useVendorBundle+ ? {loadedBytes: 0, totalBytes: null}+ : null,+ };+ const updateLoadingProgress = ({+ asset,+ loadedBytes,+ totalBytes,+ }: {+ asset: 'vendor-bundle' | 'rspack-wasm';+ loadedBytes: number;+ totalBytes: number | null;+ }) => {+ if (didCancel) {+ return;+ }++ downloadProgress[asset] = {loadedBytes, totalBytes};+ const assets = Object.values(downloadProgress).filter(+ (progress) => progress !== null,+ );+ if (assets.some((progress) => progress.totalBytes === null)) {+ setLoadingProgress(null);+ return;+ }++ const total = assets.reduce(+ (sum, progress) => sum + (progress.totalBytes ?? 0),+ 0,+ );+ const loaded = assets.reduce(+ (sum, progress) =>+ sum + Math.min(progress.loadedBytes, progress.totalBytes ?? 0),+ 0,+ );+ setLoadingProgress(total === 0 ? null : Math.min(0.95, loaded / total));+ };++ setLoadingProgress(null);// Start the large, stable vendor download alongside the compiler. The// iframe later executes these same bytes from a Blob URL, avoiding a// second request after compilation finishes.+ const vendorBundleAbortController = new AbortController();const vendorBundlePromise = useVendorBundle- ? fetch(localVendorEntryWithMarker)+ ? fetch(localVendorEntryWithMarker, {+ signal: vendorBundleAbortController.signal,+ }).then(async (response) => {if (!response.ok) {throw new Error(@@ -378,9 +426,66 @@ export const BrowserStudio: React.FC<BrowserStudioProps> = ({);}- const blob = await response.blob();+ const contentLength = Number(+ response.headers.get('content-length'),+ );+ const totalBytes =+ Number.isFinite(contentLength) && contentLength > 0+ ? contentLength+ : null;+ updateLoadingProgress({+ asset: 'vendor-bundle',+ loadedBytes: 0,+ totalBytes,+ });+ if (!response.body) {+ const fallbackBlob = await response.blob();+ updateLoadingProgress({+ asset: 'vendor-bundle',+ loadedBytes: fallbackBlob.size,+ totalBytes: totalBytes ?? fallbackBlob.size,+ });+ return {+ blob: fallbackBlob.slice(+ 0,+ fallbackBlob.size,+ 'text/javascript',+ ),+ type: 'success' as const,+ };+ }++ const reader = response.body.getReader();+ const chunks: BlobPart[] = [];+ let loadedBytes = 0;+ let lastProgressUpdate = 0;+ while (true) {+ const result = await reader.read();+ if (result.done) {+ break;+ }++ chunks.push(result.value);+ loadedBytes += result.value.byteLength;+ const now = performance.now();+ if (now - lastProgressUpdate >= 50) {+ lastProgressUpdate = now;+ updateLoadingProgress({+ asset: 'vendor-bundle',+ loadedBytes,+ totalBytes,+ });+ }+ }++ const vendorBlob = new Blob(chunks, {type: 'text/javascript'});+ updateLoadingProgress({+ asset: 'vendor-bundle',+ loadedBytes,+ totalBytes: totalBytes ?? loadedBytes,+ });return {- blob: blob.slice(0, blob.size, 'text/javascript'),+ blob: vendorBlob,type: 'success' as const,};})@@ -419,6 +524,11 @@ export const BrowserStudio: React.FC<BrowserStudioProps> = ({return;}+ if (response.type === 'load-progress') {+ updateLoadingProgress(response);+ return;+ }+if (response.type === 'building') {setCompileState({status: 'compiling'});return;@@ -519,6 +629,7 @@ export const BrowserStudio: React.FC<BrowserStudioProps> = ({});setIframeHtml(html);+ setLoadingProgress(1);setCompileState({status: 'compiled', warnings: response.warnings});};@@ -541,6 +652,7 @@ export const BrowserStudio: React.FC<BrowserStudioProps> = ({return () => {didCancel = true;+ vendorBundleAbortController.abort();if (vendorBundleUrl) {URL.revokeObjectURL(vendorBundleUrl);}@@ -693,7 +805,7 @@ export const BrowserStudio: React.FC<BrowserStudioProps> = ({) : null}{state.status === 'compiling' && iframeHtml === null ? (<div style={overlayStyle}>- <Spinner duration={0.5} size={14} />+ <LoadingProgress progress={loadingProgress} /></div>) : null}{state.status === 'error' ? (diff --git a/packages/browser-studio/src/LoadingProgress.tsx b/packages/browser-studio/src/LoadingProgress.tsxnew file mode 100644index 0000000000..e117253459--- /dev/null+++ b/packages/browser-studio/src/LoadingProgress.tsx@@ -0,0 +1,72 @@+import React from 'react';++const loadingProgressAnimation = '__remotion_loading_progress_animation';++const wrapperStyle: React.CSSProperties = {+ width: 240,+};++const labelRowStyle: React.CSSProperties = {+ color: '#a6a7a9',+ display: 'flex',+ fontSize: 12,+ justifyContent: 'space-between',+ marginBottom: 10,+};++const trackStyle: React.CSSProperties = {+ backgroundColor: '#292929',+ borderRadius: 2,+ height: 4,+ overflow: 'hidden',+ position: 'relative',+ width: '100%',+};++const fillStyle: React.CSSProperties = {+ backgroundColor: '#0b84f3',+ borderRadius: 2,+ height: '100%',+ transition: 'width 100ms linear',+};++export const LoadingProgress: React.FC<{+ readonly progress: number | null;+}> = ({progress}) => {+ const percentage = progress === null ? null : Math.round(progress * 100);++ return (+ <div style={wrapperStyle}>+ <style type="text/css">{`+ @keyframes ${loadingProgressAnimation} {+ 0% { transform: translateX(-100%); }+ 100% { transform: translateX(333%); }+ }+ `}</style>+ <div style={labelRowStyle}>+ <span>Loading Studio</span>+ {percentage === null ? null : <span>{percentage}%</span>}+ </div>+ <div+ aria-label="Loading Studio"+ aria-valuemax={100}+ aria-valuemin={0}+ aria-valuenow={percentage ?? undefined}+ role="progressbar"+ style={trackStyle}+ >+ <div+ style={+ progress === null+ ? {+ ...fillStyle,+ animation: `${loadingProgressAnimation} 1.1s ease-in-out infinite`,+ width: '30%',+ }+ : {...fillStyle, width: `${percentage}%`}+ }+ />+ </div>+ </div>+ );+};diff --git a/packages/browser-studio/src/Spinner.tsx b/packages/browser-studio/src/Spinner.tsxdeleted file mode 100644index 33462ea3f9..0000000000--- a/packages/browser-studio/src/Spinner.tsx+++ /dev/null@@ -1,60 +0,0 @@-import React, {useMemo} from 'react';--const lightText = '#A6A7A9';-const viewBox = 100;-const lines = 8;-const className = '__remotion_spinner_line';-const remotionSpinnerAnimation = '__remotion_spinner_animation';--// Generated from https://github.com/remotion-dev/template-next/commit/9282c93f7c51ada31a42e18a94680fa09a14eee3-const translated =- 'M 44 0 L 50 0 a 6 6 0 0 1 6 6 L 56 26 a 6 6 0 0 1 -6 6 L 50 32 a 6 6 0 0 1 -6 -6 L 44 6 a 6 6 0 0 1 6 -6 Z';--export const Spinner: React.FC<{- readonly duration: number;- readonly size: number;-}> = ({duration, size}) => {- const style = useMemo(() => {- return {- height: size,- width: size,- };- }, [size]);-- return (- <>- <style type="text/css">{`- @keyframes ${remotionSpinnerAnimation} {- 0% {- opacity: 1;- }- 100% {- opacity: 0.15;- }- }-- .${className} {- animation: ${remotionSpinnerAnimation} ${duration}s linear infinite;- }- `}</style>- <svg style={style} viewBox={`0 0 ${viewBox} ${viewBox}`}>- {new Array(lines).fill(true).map((_, index) => {- return (- <path- // eslint-disable-next-line react/no-array-index-key- key={index}- className={className}- style={{- animationDelay: `${index * (duration / lines) - duration}s`,- rotate: `${(index * Math.PI * 2) / lines}rad`,- transformOrigin: 'center center',- }}- d={translated}- fill={lightText}- />- );- })}- </svg>- </>- );-};diff --git a/packages/browser-studio/src/browser-studio-worker.ts b/packages/browser-studio/src/browser-studio-worker.tsindex c492eaaed4..f2e1c581a5 100644--- a/packages/browser-studio/src/browser-studio-worker.ts+++ b/packages/browser-studio/src/browser-studio-worker.ts@@ -40,10 +40,104 @@ type CompilerSession = {let rspackBrowserPromise: Promise<typeof RspackBrowser> | null = null;let compilerSession: CompilerSession | null = null;+const postResponse = (response: BrowserStudioWorkerCompileResponse) => {+ self.postMessage(response);+};+const loadRspackBrowser = () => {const workerGlobal = globalThis as Record<string, unknown>;workerGlobal.window ??= globalThis;- rspackBrowserPromise ??= import('@rspack/browser');+ if (!rspackBrowserPromise) {+ const originalFetch = globalThis.fetch.bind(globalThis);+ workerGlobal.fetch = async (+ input: RequestInfo | URL,+ init?: RequestInit,+ ) => {+ const response = await originalFetch(input, init);+ const inputUrl =+ typeof input === 'string'+ ? input+ : input instanceof URL+ ? input.href+ : input.url;+ // Asset filenames may be hashed by the consumer's bundler.+ if (!inputUrl.split(/[?#]/)[0].endsWith('.wasm')) {+ return response;+ }++ const contentLength = Number(response.headers.get('content-length'));+ const totalBytes =+ Number.isFinite(contentLength) && contentLength > 0+ ? contentLength+ : null;+ postResponse({+ asset: 'rspack-wasm',+ loadedBytes: 0,+ totalBytes,+ type: 'load-progress',+ });+ if (!response.body) {+ postResponse({+ asset: 'rspack-wasm',+ loadedBytes: totalBytes ?? 0,+ totalBytes,+ type: 'load-progress',+ });+ return response;+ }++ const reader = response.body.getReader();+ let loadedBytes = 0;+ let lastProgressUpdate = 0;+ const body = new ReadableStream<Uint8Array>({+ async pull(controller) {+ try {+ const result = await reader.read();+ if (result.done) {+ postResponse({+ asset: 'rspack-wasm',+ loadedBytes,+ totalBytes: totalBytes ?? loadedBytes,+ type: 'load-progress',+ });+ controller.close();+ return;+ }++ loadedBytes += result.value.byteLength;+ const now = performance.now();+ if (now - lastProgressUpdate >= 50) {+ lastProgressUpdate = now;+ postResponse({+ asset: 'rspack-wasm',+ loadedBytes,+ totalBytes,+ type: 'load-progress',+ });+ }++ controller.enqueue(result.value);+ } catch (error) {+ controller.error(error);+ }+ },+ cancel(reason) {+ return reader.cancel(reason);+ },+ });++ return new Response(body, {+ headers: response.headers,+ status: response.status,+ statusText: response.statusText,+ });+ };++ rspackBrowserPromise = import('@rspack/browser').finally(() => {+ workerGlobal.fetch = originalFetch;+ });+ }+return rspackBrowserPromise;};@@ -98,10 +192,6 @@ const problemToString = (problem: unknown): string => {return String(problem);};-const postResponse = (response: BrowserStudioWorkerCompileResponse) => {- self.postMessage(response);-};-const applyDependencyResolution = ({name,resolution,diff --git a/packages/browser-studio/src/types.ts b/packages/browser-studio/src/types.tsindex 2e0a8199e5..040dd8b8ef 100644--- a/packages/browser-studio/src/types.ts+++ b/packages/browser-studio/src/types.ts@@ -119,6 +119,12 @@ export type BrowserStudioWorkerCompileResponse =bundle: string;warnings: string[];}+ | {+ type: 'load-progress';+ asset: 'rspack-wasm';+ loadedBytes: number;+ totalBytes: number | null;+ }| {type: 'building';}