Skip to content

🎥 Make videos programmatically with React

`@remotion/studio`: Batch sequence prop unsubscriptions

JonnyBurger7d197014bcfe
diff --git a/packages/studio-server/src/preview-server/routes/unsubscribe-from-sequence-props.ts b/packages/studio-server/src/preview-server/routes/unsubscribe-from-sequence-props.ts
index ddacf37926..66aed1abb2 100644
--- a/packages/studio-server/src/preview-server/routes/unsubscribe-from-sequence-props.ts
+++ b/packages/studio-server/src/preview-server/routes/unsubscribe-from-sequence-props.ts
@@ -1,29 +1,29 @@
-import type {UnsubscribeFromSequencePropsRequest} from '@remotion/studio-shared';
+import type {UnsubscribeFromSequencePropsBatchRequest} from '@remotion/studio-shared';
import type {ApiHandler} from '../api-types';
import {unsubscribeFromSequencePropsWatchers} from '../sequence-props-watchers';
export const unsubscribeFromSequenceProps: ApiHandler<
- UnsubscribeFromSequencePropsRequest,
+ UnsubscribeFromSequencePropsBatchRequest,
undefined
-> = ({
- input: {
+> = ({input, remotionRoot}) => {
+ for (const {
fileName,
nodePath,
clientId,
sequenceKeys,
assetKeys = [],
effectKeys,
- },
- remotionRoot,
-}) => {
- unsubscribeFromSequencePropsWatchers({
- fileName,
- nodePath: nodePath.nodePath,
- remotionRoot,
- clientId,
- sequenceKeys,
- assetKeys,
- effectKeys,
- });
+ } of input.requests) {
+ unsubscribeFromSequencePropsWatchers({
+ fileName,
+ nodePath: nodePath.nodePath,
+ remotionRoot,
+ clientId,
+ sequenceKeys,
+ assetKeys,
+ effectKeys,
+ });
+ }
+
return Promise.resolve(undefined);
};
diff --git a/packages/studio-server/src/test/subscribe-to-sequence-props.test.ts b/packages/studio-server/src/test/subscribe-to-sequence-props.test.ts
index edeb9b6221..c02183bec9 100644
--- a/packages/studio-server/src/test/subscribe-to-sequence-props.test.ts
+++ b/packages/studio-server/src/test/subscribe-to-sequence-props.test.ts
@@ -2,16 +2,20 @@ import {expect, test} from 'bun:test';
import {mkdtempSync, rmSync, writeFileSync} from 'node:fs';
import {tmpdir} from 'node:os';
import {basename, join} from 'node:path';
-import type {SubscribeToSequencePropsRequest} from '@remotion/studio-shared';
+import type {
+ SubscribeToSequencePropsRequest,
+ UnsubscribeFromSequencePropsRequest,
+} from '@remotion/studio-shared';
import {
createFileWatcherRegistry,
setFileWatcherRegistry,
} from '../file-watcher';
import {subscribeToSequenceProps} from '../preview-server/routes/subscribe-to-sequence-props';
+import {unsubscribeFromSequenceProps} from '../preview-server/routes/unsubscribe-from-sequence-props';
import {unsubscribeClientSequencePropsWatchers} from '../preview-server/sequence-props-watchers';
import {lineColumnToNodePath} from './test-utils';
-test('resolves batched sequence prop subscriptions through the handler', async () => {
+test('subscribes and unsubscribes batched sequence props through the handlers', async () => {
const firstInput = `import {Interactive} from 'remotion';
export const First = () => {
@@ -29,9 +33,21 @@ export const Second = () => {
return <Interactive.Div name="Three" />;
};
`;
- const cleanupFileWatcher = setFileWatcherRegistry(
- createFileWatcherRegistry(),
- );
+ const registry = createFileWatcherRegistry();
+ const unwatchedFiles: string[] = [];
+ const cleanupFileWatcher = setFileWatcherRegistry({
+ ...registry,
+ installFileWatcher: (options) => {
+ const watcher = registry.installFileWatcher(options);
+ return {
+ ...watcher,
+ unwatch: () => {
+ watcher.unwatch();
+ unwatchedFiles.push(options.file);
+ },
+ };
+ },
+ });
const remotionRoot = mkdtempSync(join(tmpdir(), 'remotion-subscriptions-'));
const uniqueSuffix = basename(remotionRoot);
const firstFileName = `First-${uniqueSuffix}.tsx`;
@@ -78,14 +94,13 @@ export const Second = () => {
];
try {
- const response = await subscribeToSequenceProps({
+ const handlerOptions = {
binariesDirectory: null,
configFile: null,
entryPoint: join(remotionRoot, firstFileName),
getDefaultCodingAgent: () => null,
getDefaultEditor: () => null,
- input: {requests},
- logLevel: 'error',
+ logLevel: 'error' as const,
methods: {
addJob: () => undefined,
cancelJob: () => undefined,
@@ -95,6 +110,10 @@ export const Second = () => {
remotionRoot,
request: {} as never,
response: {} as never,
+ };
+ const response = await subscribeToSequenceProps({
+ ...handlerOptions,
+ input: {requests},
});
const expectedNodePaths = [
lineColumnToNodePath(firstInput, 6),
@@ -103,6 +122,7 @@ export const Second = () => {
lineColumnToNodePath(secondInput, 4),
];
const expectedNames = ['One', 'Two', 'Three', 'Three'];
+ const unsubscriptions: UnsubscribeFromSequencePropsRequest[] = [];
expect(response.results).toHaveLength(requests.length);
for (const [index, result] of response.results.entries()) {
if (!result.success) {
@@ -115,7 +135,34 @@ export const Second = () => {
keyframeDisplayOffsetAdjustment: null,
codeValue: expectedNames[index],
});
+ unsubscriptions.push({
+ fileName: requests[index].fileName,
+ nodePath: result.nodePath,
+ clientId,
+ sequenceKeys: requestBase.keys,
+ assetKeys: requestBase.assetKeys,
+ effectKeys: requestBase.effects,
+ });
}
+
+ await unsubscribeFromSequenceProps({
+ ...handlerOptions,
+ input: {requests: unsubscriptions.slice(0, 3)},
+ });
+ // The duplicate subscription to the second file keeps its watcher alive.
+ expect(unwatchedFiles).toEqual([
+ join(remotionRoot, firstFileName),
+ join(remotionRoot, firstFileName),
+ ]);
+ await unsubscribeFromSequenceProps({
+ ...handlerOptions,
+ input: {requests: unsubscriptions.slice(3)},
+ });
+ expect(unwatchedFiles).toEqual([
+ join(remotionRoot, firstFileName),
+ join(remotionRoot, firstFileName),
+ join(remotionRoot, secondFileName),
+ ]);
} finally {
unsubscribeClientSequencePropsWatchers(clientId);
cleanupFileWatcher();
diff --git a/packages/studio-shared/src/api-requests.ts b/packages/studio-shared/src/api-requests.ts
index a3a7b9fb52..064e224f20 100644
--- a/packages/studio-shared/src/api-requests.ts
+++ b/packages/studio-shared/src/api-requests.ts
@@ -494,6 +494,10 @@ export type UnsubscribeFromSequencePropsRequest = {
effectKeys: string[][];
};
+export type UnsubscribeFromSequencePropsBatchRequest = {
+ requests: UnsubscribeFromSequencePropsRequest[];
+};
+
export type GoogleFontSourceEdit = {
fontFamily: string;
importName: string;
@@ -1598,7 +1602,7 @@ export const studioOperations = {
SubscribeToSequencePropsBatchResponse
>({mutatesSource: false}),
'/api/unsubscribe-from-sequence-props': new StudioOperation<
- UnsubscribeFromSequencePropsRequest,
+ UnsubscribeFromSequencePropsBatchRequest,
undefined
>({mutatesSource: false}),
'/api/save-sequence-props': new StudioOperation<
diff --git a/packages/studio-shared/src/index.ts b/packages/studio-shared/src/index.ts
index 3c046a229d..14b6f636fb 100644
--- a/packages/studio-shared/src/index.ts
+++ b/packages/studio-shared/src/index.ts
@@ -169,6 +169,7 @@ export {
UndoResponse,
UnsubscribeFromDefaultPropsRequest,
UnsubscribeFromFileExistenceRequest,
+ UnsubscribeFromSequencePropsBatchRequest,
UnsubscribeFromSequencePropsRequest,
UpdateAvailableRequest,
UpdateAvailableResponse,
diff --git a/packages/studio/src/components/sequence-props-api.ts b/packages/studio/src/components/sequence-props-api.ts
index e2e1012e7e..58a8071fb9 100644
--- a/packages/studio/src/components/sequence-props-api.ts
+++ b/packages/studio/src/components/sequence-props-api.ts
@@ -15,8 +15,18 @@ type PendingSequencePropsSubscription = {
reject: (error: unknown) => void;
};
+type PendingSequencePropsUnsubscription = {
+ request: UnsubscribeFromSequencePropsRequest;
+ resolve: (response: undefined) => void;
+ reject: (error: unknown) => void;
+};
+
let pendingSequencePropsSubscriptions: PendingSequencePropsSubscription[] = [];
let sequencePropsSubscriptionTimer: ReturnType<typeof setTimeout> | null = null;
+let pendingSequencePropsUnsubscriptions: PendingSequencePropsUnsubscription[] =
+ [];
+let sequencePropsUnsubscriptionTimer: ReturnType<typeof setTimeout> | null =
+ null;
const flushSequencePropsSubscriptions = () => {
sequencePropsSubscriptionTimer = null;
@@ -82,7 +92,33 @@ export const unsubscribeFromSequenceProps = (
request: UnsubscribeFromSequencePropsRequest,
): Promise<undefined> => {
const browserStudioOperations = getBrowserStudioOperations();
- return browserStudioOperations
- ? browserStudioOperations.unsubscribeFromSequenceProps(request)
- : callApi('/api/unsubscribe-from-sequence-props', request);
+ if (browserStudioOperations) {
+ return browserStudioOperations.unsubscribeFromSequenceProps(request);
+ }
+
+ return new Promise((resolve, reject) => {
+ pendingSequencePropsUnsubscriptions.push({request, resolve, reject});
+ if (sequencePropsUnsubscriptionTimer === null) {
+ sequencePropsUnsubscriptionTimer = setTimeout(() => {
+ sequencePropsUnsubscriptionTimer = null;
+ const pending = pendingSequencePropsUnsubscriptions;
+ pendingSequencePropsUnsubscriptions = [];
+
+ callApi('/api/unsubscribe-from-sequence-props', {
+ requests: pending.map((item) => item.request),
+ }).then(
+ () => {
+ for (const item of pending) {
+ item.resolve(undefined);
+ }
+ },
+ (error) => {
+ for (const item of pending) {
+ item.reject(error);
+ }
+ },
+ );
+ }, 0);
+ }
+ });
};
diff --git a/packages/studio/src/test/source-subscription-churn.test.tsx b/packages/studio/src/test/source-subscription-churn.test.tsx
index c38741513c..3d31c35cba 100644
--- a/packages/studio/src/test/source-subscription-churn.test.tsx
+++ b/packages/studio/src/test/source-subscription-churn.test.tsx
@@ -1,7 +1,11 @@
import {expect, test} from 'bun:test';
import {readFileSync} from 'node:fs';
import {CodemodsInternals} from '@remotion/codemods';
-import type {SubscribeToSequencePropsBatchRequest} from '@remotion/studio-shared';
+import type {
+ SubscribeToSequencePropsBatchRequest,
+ UnsubscribeFromSequencePropsBatchRequest,
+ UnsubscribeFromSequencePropsRequest,
+} from '@remotion/studio-shared';
import {act, render, waitFor} from '@testing-library/react';
import {useContext, useState, type ContextType} from 'react';
import {
@@ -82,6 +86,7 @@ const Fixture = () => (
test('parent previews keep source subscriptions stable while mounted instances evaluate shared source', async () => {
const previousFetch = globalThis.fetch;
const requests: string[] = [];
+ const unsubscriptionBatches: UnsubscribeFromSequencePropsRequest[][] = [];
const subscriptions: ReturnType<
typeof CodemodsInternals.computeSequencePropsSubscriptionFromContent
>[] = [];
@@ -107,6 +112,10 @@ test('parent previews keep source subscriptions stable while mounted instances e
const endpoint = String(input);
requests.push(endpoint);
if (endpoint === '/api/unsubscribe-from-sequence-props') {
+ const unsubscribeBody = JSON.parse(
+ String(init?.body),
+ ) as UnsubscribeFromSequencePropsBatchRequest;
+ unsubscriptionBatches.push(unsubscribeBody.requests);
return Promise.resolve(Response.json({success: true}));
}
@@ -325,15 +334,16 @@ test('parent previews keep source subscriptions stable while mounted instances e
await act(async () => {
rendered?.unmount();
await Promise.resolve();
+ await new Promise((resolve) => setTimeout(resolve, 0));
});
globalThis.fetch = previousFetch;
sourceLineOffset = 0;
}
- // Verify that unsubscribe traffic is actually observed by the test.
- expect(
- requests.filter(
- (endpoint) => endpoint === '/api/unsubscribe-from-sequence-props',
- ),
- ).toHaveLength(subscriptions.filter((result) => result.success).length);
+ // Refresh cleanup and final unmount each send one batch, preserving every release.
+ expect(unsubscriptionBatches).toHaveLength(2);
+ expect(unsubscriptionBatches.at(-1)).toHaveLength(4);
+ expect(unsubscriptionBatches.flat()).toHaveLength(
+ subscriptions.filter((result) => result.success).length,
+ );
});