Skip to content

🎥 Make videos programmatically with React

Scope client render invalidation to suppressed files

Jonny Burgera7a1a262b347
diff --git a/packages/studio-server/src/preview-server/api-routes.ts b/packages/studio-server/src/preview-server/api-routes.ts
index 3a791b040a..3fc085078e 100644
--- a/packages/studio-server/src/preview-server/api-routes.ts
+++ b/packages/studio-server/src/preview-server/api-routes.ts
@@ -27,6 +27,7 @@ import {duplicateJsxNodeHandler} from './routes/duplicate-jsx-node';
import {findInFileHandler} from './routes/find-in-file';
import {insertElementHandler} from './routes/insert-element';
import {insertJsxElementHandler} from './routes/insert-jsx-element';
+import {invalidateBundleHandler} from './routes/invalidate-bundle';
import {logStudioErrorHandler} from './routes/log-studio-error';
import {moveKeyframesHandler} from './routes/move-keyframes';
import {openInEditorHandler} from './routes/open-in-editor';
@@ -68,7 +69,7 @@ import {handleUpgradeRemotion} from './routes/upgrade-remotion';
type StandardApiRoute = Exclude<
keyof ApiRoutes,
- '/api/install-package' | '/api/invalidate-bundle' | '/api/update-config'
+ '/api/install-package' | '/api/update-config'
>;
export const allApiRoutes: {
@@ -77,6 +78,7 @@ export const allApiRoutes: {
ApiRoutes[key]['Response']
>;
} = {
+ '/api/invalidate-bundle': invalidateBundleHandler,
'/api/composition-component-info': compositionComponentInfoHandler,
'/api/copy-render-output-to-asset': copyRenderOutputToAssetHandler,
'/api/convert-figma-clipboard-to-svg': convertFigmaClipboardToSvgHandler,
diff --git a/packages/studio-server/src/preview-server/routes/invalidate-bundle.ts b/packages/studio-server/src/preview-server/routes/invalidate-bundle.ts
index 8d3a626afd..77549d4eb5 100644
--- a/packages/studio-server/src/preview-server/routes/invalidate-bundle.ts
+++ b/packages/studio-server/src/preview-server/routes/invalidate-bundle.ts
@@ -1,25 +1,13 @@
import type {ApiRoutes} from '@remotion/studio-shared';
import type {ApiHandler} from '../api-types';
-import {consumeSuppressedFilesForRebuild} from '../watch-ignore-next-change';
+import {invalidatePreviouslySuppressedFiles} from '../watch-ignore-next-change';
import {withSourceFileWriteQueue} from './source-file-write-queue';
-export const invalidateBundleHandler = (
- params: Parameters<
- ApiHandler<
- ApiRoutes['/api/invalidate-bundle']['Request'],
- ApiRoutes['/api/invalidate-bundle']['Response']
- >
- >[0] & {
- readonly invalidateBundle: (files: string[]) => Promise<void>;
- },
-) => {
+export const invalidateBundleHandler: ApiHandler<
+ ApiRoutes['/api/invalidate-bundle']['Request'],
+ ApiRoutes['/api/invalidate-bundle']['Response']
+> = () => {
return withSourceFileWriteQueue(async () => {
- const files = consumeSuppressedFilesForRebuild();
- if (files.length === 0) {
- return {didInvalidate: false};
- }
-
- await params.invalidateBundle(files);
- return {didInvalidate: true};
+ return {didInvalidate: await invalidatePreviouslySuppressedFiles()};
});
};
diff --git a/packages/studio-server/src/preview-server/start-server.ts b/packages/studio-server/src/preview-server/start-server.ts
index 163973d565..aabd44ca0a 100644
--- a/packages/studio-server/src/preview-server/start-server.ts
+++ b/packages/studio-server/src/preview-server/start-server.ts
@@ -243,37 +243,7 @@ export const startServer = async (options: {
setWatchIgnoreNextChangePlugin(watchIgnorePlugin);
const wdmMiddleware = wdm(compiler, options.logLevel);
- const filesToInvalidate = new Set<string>();
- let latestStats: webpack.Stats | null = null;
- compiler.hooks.invalid.tap('remotion-manual-invalidation', () => {
- latestStats = null;
- });
- compiler.hooks.watchRun.tap('remotion-manual-invalidation', () => {
- if (filesToInvalidate.size === 0 || !compiler) {
- return;
- }
-
- compiler.modifiedFiles = new Set([
- ...(compiler.modifiedFiles ?? []),
- ...filesToInvalidate,
- ]);
- for (const file of filesToInvalidate) {
- compiler.inputFileSystem?.purge?.(file);
- compiler.fileTimestamps?.delete(file);
- }
-
- filesToInvalidate.clear();
- });
- compiler.hooks.done.tap('remotion-manual-invalidation', (stats) => {
- latestStats = stats;
- });
-
- const invalidateBundle = (files: string[] = []) => {
- const requireSuccessfulBuild = files.length > 0;
- for (const file of files) {
- filesToInvalidate.add(file);
- }
-
+ const invalidateBundle = () => {
return new Promise<void>((resolve, reject) => {
const watching = compiler?.watching;
if (!watching) {
@@ -287,14 +257,6 @@ export const startServer = async (options: {
return;
}
- if (
- requireSuccessfulBuild &&
- (!latestStats || latestStats.hasErrors())
- ) {
- reject(new Error('Fix the compilation errors before exporting'));
- return;
- }
-
resolve();
});
});
diff --git a/packages/studio-server/src/preview-server/watch-ignore-next-change.ts b/packages/studio-server/src/preview-server/watch-ignore-next-change.ts
index 0b07c24678..1b5af70d91 100644
--- a/packages/studio-server/src/preview-server/watch-ignore-next-change.ts
+++ b/packages/studio-server/src/preview-server/watch-ignore-next-change.ts
@@ -13,9 +13,27 @@ export const suppressBundlerUpdateForFile = (absolutePath: string): void => {
currentPlugin?.ignoreNextChange(absolutePath);
};
-export const consumeSuppressedFilesForRebuild = (): string[] => {
- return currentPlugin?.consumeSuppressedFilesForRebuild() ?? [];
-};
+export const invalidatePreviouslySuppressedFiles =
+ async (): Promise<boolean> => {
+ if (!currentPlugin) {
+ return false;
+ }
+
+ const files = currentPlugin.consumeSuppressedFilesForRebuild();
+ const now = new Date();
+ const touchedFiles = await Promise.all(
+ files.map(async (file) => {
+ try {
+ await fs.utimes(file, now, now);
+ return true;
+ } catch {
+ return false;
+ }
+ }),
+ );
+
+ return touchedFiles.some(Boolean);
+ };
// Why do we need this?
// Consider we have a <Sequence>.
@@ -28,18 +46,5 @@ export const consumeSuppressedFilesForRebuild = (): string[] => {
// --> When reloading the Studio, it is a good idea to reset Webpack to a non-hacked state.
export const reloadPreviouslySuppressedFiles = async (): Promise<void> => {
- if (!currentPlugin) {
- return;
- }
-
- const files = currentPlugin.consumeSuppressedFilesForRebuild();
-
- const now = new Date();
- await Promise.all(
- files.map(async (file) => {
- try {
- await fs.utimes(file, now, now);
- } catch {}
- }),
- );
+ await invalidatePreviouslySuppressedFiles();
};
diff --git a/packages/studio-server/src/routes.ts b/packages/studio-server/src/routes.ts
index fb9617fcee..d6f53eb9f3 100644
--- a/packages/studio-server/src/routes.ts
+++ b/packages/studio-server/src/routes.ts
@@ -41,7 +41,6 @@ import type {LiveEventsServer} from './preview-server/live-events';
import {fetchFolder, getFiles} from './preview-server/public-folder';
import {handleAppIcon} from './preview-server/routes/app-icon';
import {handleInstallPackage} from './preview-server/routes/install-dependency';
-import {invalidateBundleHandler} from './preview-server/routes/invalidate-bundle';
import {getEditorName} from './preview-server/routes/open-in-editor';
import {updateConfigHandler} from './preview-server/routes/update-config';
import {serveStatic} from './preview-server/serve-static';
@@ -465,7 +464,7 @@ export const handleRoutes = ({
getDefaultCodingAgent: () => DefaultCodingAgent | null;
getDefaultEditor: () => DefaultEditor | null;
configFile: string | null;
- invalidateBundle: (files?: string[]) => Promise<void>;
+ invalidateBundle: () => Promise<void>;
}): Promise<void> => {
const url = new URL(request.url as string, 'http://localhost');
@@ -597,27 +596,6 @@ export const handleRoutes = ({
});
}
- if (url.pathname === '/api/invalidate-bundle') {
- return handleRequest<
- ApiRoutes['/api/invalidate-bundle']['Request'],
- ApiRoutes['/api/invalidate-bundle']['Response']
- >({
- remotionRoot,
- entryPoint,
- handler: (params) =>
- invalidateBundleHandler({...params, invalidateBundle}),
- request,
- response,
- logLevel,
- methods,
- binariesDirectory,
- publicDir,
- configFile,
- getDefaultCodingAgent,
- getDefaultEditor,
- });
- }
-
for (const [key, value] of Object.entries(allApiRoutes)) {
if (url.pathname === key) {
return handleRequest({