Skip to content

🎥 Make videos programmatically with React

`@remotion/bundler`: Reduce Studio Fast Refresh latency

JonnyBurgera5e8d2197a80
diff --git a/packages/bundler/src/fast-refresh/zero-delay-rspack-refresh-loader.ts b/packages/bundler/src/fast-refresh/zero-delay-rspack-refresh-loader.ts
new file mode 100644
index 0000000000..41c4c5f018
--- /dev/null
+++ b/packages/bundler/src/fast-refresh/zero-delay-rspack-refresh-loader.ts
@@ -0,0 +1,22 @@
+import type {LoaderDefinition} from 'webpack';
+
+const rspackReactRefreshDelay = ' }, 30);';
+const zeroDelayReactRefresh = ' }, 0);';
+
+const removeRspackReactRefreshDelay = (source: string) => {
+ const occurrences = source.split(rspackReactRefreshDelay).length - 1;
+
+ if (occurrences !== 1) {
+ throw new Error(
+ `Expected one 30ms React Refresh debounce in @rspack/plugin-react-refresh, found ${occurrences}.`,
+ );
+ }
+
+ return source.replace(rspackReactRefreshDelay, zeroDelayReactRefresh);
+};
+
+const ZeroDelayRspackRefreshLoader: LoaderDefinition = function (source) {
+ return removeRspackReactRefreshDelay(source);
+};
+
+export default ZeroDelayRspackRefreshLoader;
diff --git a/packages/bundler/src/rspack-config.ts b/packages/bundler/src/rspack-config.ts
index 393df2011b..765e7a1a45 100644
--- a/packages/bundler/src/rspack-config.ts
+++ b/packages/bundler/src/rspack-config.ts
@@ -124,6 +124,17 @@ export const rspackConfig = async ({
module: {
rules: [
...getSharedModuleRules(),
+ ...(environment === 'development'
+ ? [
+ {
+ test: /[\\/]@rspack[\\/]plugin-react-refresh[\\/]client[\\/]refreshUtils\.js$/,
+ enforce: 'pre' as const,
+ use: [
+ require.resolve('./fast-refresh/zero-delay-rspack-refresh-loader.js'),
+ ],
+ },
+ ]
+ : []),
{
// Emscripten's main.js spawns Workers of itself via
// new Worker(new URL('./main.js', import.meta.url)).
diff --git a/packages/bundler/src/test/zero-delay-rspack-refresh-loader.test.ts b/packages/bundler/src/test/zero-delay-rspack-refresh-loader.test.ts
new file mode 100644
index 0000000000..82de216c20
--- /dev/null
+++ b/packages/bundler/src/test/zero-delay-rspack-refresh-loader.test.ts
@@ -0,0 +1,62 @@
+import {expect, test} from 'bun:test';
+import {mkdtempSync, readFileSync, rmSync} from 'node:fs';
+import {tmpdir} from 'node:os';
+import path from 'node:path';
+import {createRspackCompiler, rspackConfig} from '../rspack-config';
+
+test('emits a zero-delay Rspack React Refresh runtime', async () => {
+ const outputDirectory = mkdtempSync(
+ path.join(tmpdir(), 'remotion-rspack-refresh-'),
+ );
+ const [, config] = await rspackConfig({
+ entry: require.resolve('@remotion/studio/renderEntry'),
+ userDefinedComponent: require.resolve('@remotion/studio/renderEntry'),
+ outDir: outputDirectory,
+ environment: 'development',
+ bundlerOverride: (configuration) => configuration,
+ rspackOverride: (configuration) => configuration,
+ onProgress: () => undefined,
+ enableCaching: false,
+ remotionRoot: process.cwd(),
+ poll: null,
+ extraPlugins: [],
+ });
+ const compiler = createRspackCompiler(config);
+
+ try {
+ await new Promise<void>((resolve, reject) => {
+ compiler.run((error, stats) => {
+ if (error) {
+ reject(error);
+ return;
+ }
+
+ if (stats?.hasErrors()) {
+ reject(new Error(stats.toString({errors: true})));
+ return;
+ }
+
+ resolve();
+ });
+ });
+
+ const bundle = readFileSync(
+ path.join(outputDirectory, 'bundle.js'),
+ 'utf8',
+ );
+ const refreshRuntimeStart = bundle.indexOf(
+ 'function createDebounceUpdate()',
+ );
+ const refreshRuntime = bundle.slice(
+ refreshRuntimeStart,
+ refreshRuntimeStart + 1500,
+ );
+
+ expect(refreshRuntimeStart).toBeGreaterThan(-1);
+ expect(refreshRuntime).toContain('}, 0);');
+ expect(refreshRuntime).not.toContain('}, 30);');
+ } finally {
+ await new Promise<void>((resolve) => compiler.close(() => resolve()));
+ rmSync(outputDirectory, {recursive: true, force: true});
+ }
+});
diff --git a/packages/studio-server/src/codemods/delete-jsx-node.ts b/packages/studio-server/src/codemods/delete-jsx-node.ts
index ee89997f93..6154defab2 100644
--- a/packages/studio-server/src/codemods/delete-jsx-node.ts
+++ b/packages/studio-server/src/codemods/delete-jsx-node.ts
@@ -17,20 +17,26 @@ export {
export const deleteJsxNodes = ({
input,
nodePaths,
+ onFormatFile,
prettierConfigOverride,
}: {
input: string;
nodePaths: SequenceNodePath[];
+ onFormatFile: ((stage: 'start' | 'complete') => void) | null;
prettierConfigOverride?: Record<string, unknown> | null;
}) =>
deleteJsxNodesCodemod({
input,
nodePaths,
- formatFile: ({contents, prettierConfigOverride: override}) =>
- formatFileContent({
+ formatFile: async ({contents, prettierConfigOverride: override}) => {
+ onFormatFile?.('start');
+ const result = await formatFileContent({
input: contents,
prettierConfigOverride: override,
- }),
+ });
+ onFormatFile?.('complete');
+ return result;
+ },
prettierConfigOverride,
});
diff --git a/packages/studio-server/src/preview-server/hmr-timing.ts b/packages/studio-server/src/preview-server/hmr-timing.ts
new file mode 100644
index 0000000000..5b16ff8bc2
--- /dev/null
+++ b/packages/studio-server/src/preview-server/hmr-timing.ts
@@ -0,0 +1,18 @@
+import {RenderInternals, type LogLevel} from '@remotion/renderer';
+
+export const logHmrTiming = ({
+ detail,
+ logLevel,
+ stage,
+}: {
+ detail: string | null;
+ logLevel: LogLevel;
+ stage: string;
+}) => {
+ const detailSuffix = detail ? ` ${detail}` : '';
+
+ RenderInternals.Log.trace(
+ {indent: false, logLevel},
+ `[hmr-timing] epoch=${Date.now()} monotonic=${performance.now().toFixed(3)} stage=${stage}${detailSuffix}`,
+ );
+};
diff --git a/packages/studio-server/src/preview-server/hot-middleware/index.tsx b/packages/studio-server/src/preview-server/hot-middleware/index.tsx
index ea9931c831..f2b3ebfa8e 100644
--- a/packages/studio-server/src/preview-server/hot-middleware/index.tsx
+++ b/packages/studio-server/src/preview-server/hot-middleware/index.tsx
@@ -8,6 +8,7 @@ import type {webpack} from '@remotion/bundler';
import type {LogLevel} from '@remotion/renderer';
import {RenderInternals} from '@remotion/renderer';
import type {HotMiddlewareMessage, ModuleMap} from '@remotion/studio-shared';
+import {logHmrTiming} from '../hmr-timing';
import type {LiveEventsServer} from '../live-events';
import type {WebpackStats} from './types';
@@ -130,9 +131,17 @@ export const setupWebpackHmr = (
};
compiler.hooks.invalid.tap('remotion', onInvalid);
+ compiler.hooks.watchRun.tap('remotion-hmr-timing', () => {
+ logHmrTiming({detail: null, logLevel, stage: 'compiler-watch-run'});
+ });
compiler.hooks.done.tap('remotion', onDone);
- function onInvalid() {
+ function onInvalid(fileName: string | null, changeTime: number) {
+ logHmrTiming({
+ detail: `file=${fileName ?? 'manual'} changeTime=${changeTime}`,
+ logLevel,
+ stage: 'compiler-invalid',
+ });
latestStats = null;
RenderInternals.Log.info({indent: false, logLevel}, 'Building...');
publishHmr({
@@ -141,9 +150,15 @@ export const setupWebpackHmr = (
}
function onDone(statsResult: webpack.Stats) {
+ logHmrTiming({
+ detail: `reportedBuildDuration=${statsResult.endTime - statsResult.startTime}ms`,
+ logLevel,
+ stage: 'compiler-done',
+ });
// Keep hold of latest stats so they can be propagated to new clients
latestStats = statsResult;
publishStats('built', latestStats, publishHmr);
+ logHmrTiming({detail: null, logLevel, stage: 'hmr-stats-published'});
}
liveEventsServer.addNewClientListener(() => {
diff --git a/packages/studio-server/src/preview-server/routes/delete-jsx-node.ts b/packages/studio-server/src/preview-server/routes/delete-jsx-node.ts
index b706f320a7..94b16f06e8 100644
--- a/packages/studio-server/src/preview-server/routes/delete-jsx-node.ts
+++ b/packages/studio-server/src/preview-server/routes/delete-jsx-node.ts
@@ -9,6 +9,7 @@ import {writeFileAndNotifyFileWatchers} from '../../file-watcher';
import {resolveFileInsideProject} from '../../helpers/resolve-file-inside-project';
import type {ApiHandler} from '../api-types';
import {formatLogFileLocation} from '../format-log-file-location';
+import {logHmrTiming} from '../hmr-timing';
import {broadcastSequenceNodePathMutation} from '../sequence-node-path-mutation';
import {
printUndoHint,
@@ -35,6 +36,12 @@ export const deleteJsxNodeHandler: ApiHandler<
> = ({input: {nodes}, remotionRoot, logLevel}) => {
return withSourceFileWriteQueue(async () => {
try {
+ logHmrTiming({
+ detail: null,
+ logLevel,
+ stage: 'delete-jsx-node-request-start',
+ });
+
if (nodes.length === 0) {
throw new Error('No JSX nodes were specified for deletion');
}
@@ -65,6 +72,13 @@ export const deleteJsxNodeHandler: ApiHandler<
await deleteJsxNodes({
input: fileContents,
nodePaths: fileItems.map((item) => item.nodePath),
+ onFormatFile: (stage) => {
+ logHmrTiming({
+ detail: `file=${fileRelativeToRoot}`,
+ logLevel,
+ stage: `source-file-format-${stage}`,
+ });
+ },
});
return {
@@ -79,6 +93,11 @@ export const deleteJsxNodeHandler: ApiHandler<
};
}),
);
+ logHmrTiming({
+ detail: `files=${updates.length}`,
+ logLevel,
+ stage: 'delete-jsx-node-codemod-complete',
+ });
const nodePathMutation = broadcastSequenceNodePathMutation(
updates.map((update) => ({
absolutePath: update.absolutePath,
@@ -108,12 +127,22 @@ export const deleteJsxNodeHandler: ApiHandler<
nodePathRemappings: update.nodePathRemappings,
});
suppressUndoStackInvalidation(update.absolutePath);
+ logHmrTiming({
+ detail: `file=${update.fileRelativeToRoot}`,
+ logLevel,
+ stage: 'source-file-write-start',
+ });
writeFileAndNotifyFileWatchers({
file: update.absolutePath,
content: update.output,
originatorClientId: undefined,
metadata: {skipSequencePropsUpdate: true},
});
+ logHmrTiming({
+ detail: `file=${update.fileRelativeToRoot}`,
+ logLevel,
+ stage: 'source-file-write-complete',
+ });
const locationLabel = formatLogFileLocation({
remotionRoot,
diff --git a/packages/studio-server/src/test/delete-jsx-node.test.ts b/packages/studio-server/src/test/delete-jsx-node.test.ts
index bc62f72527..0b9e0b5a1d 100644
--- a/packages/studio-server/src/test/delete-jsx-node.test.ts
+++ b/packages/studio-server/src/test/delete-jsx-node.test.ts
@@ -139,6 +139,7 @@ test('deleteJsxNodes removes multiple JSX children in one transform', async () =
lineColumnToNodePath(multipleSiblings, 7),
lineColumnToNodePath(multipleSiblings, 8),
],
+ onFormatFile: null,
});
expect(output).not.toContain('<div');