Skip to content

🎥 Make videos programmatically with React

Prevent closing Studio during local jobs

JonnyBurger7c8740fbafaf
diff --git a/packages/studio/src/components/RenderQueue/context.tsx b/packages/studio/src/components/RenderQueue/context.tsx
index 9366fe4fab..8c28025c8c 100644
--- a/packages/studio/src/components/RenderQueue/context.tsx
+++ b/packages/studio/src/components/RenderQueue/context.tsx
@@ -171,6 +171,19 @@ export const RenderQueueContextProvider: React.FC<{
const [videoMattingJobs, setVideoMattingJobs] = useState<VideoMattingJob[]>(
[],
);
+ const hasActiveLocalJob =
+ clientJobs.some(
+ (job) =>
+ job.status === 'idle' ||
+ job.status === 'running' ||
+ job.status === 'saving',
+ ) ||
+ captionJobs.some(
+ (job) => job.status === 'idle' || job.status === 'running',
+ ) ||
+ videoMattingJobs.some(
+ (job) => job.status === 'idle' || job.status === 'running',
+ );
const [currentlyProcessing, setCurrentlyProcessing] = useState<string | null>(
null,
);
@@ -188,6 +201,20 @@ export const RenderQueueContextProvider: React.FC<{
>(null);
const [processorCallbacksVersion, setProcessorCallbacksVersion] = useState(0);
+ useEffect(() => {
+ if (!hasActiveLocalJob) {
+ return;
+ }
+
+ const preventClose = (event: BeforeUnloadEvent) => {
+ event.preventDefault();
+ event.returnValue = '';
+ };
+
+ window.addEventListener('beforeunload', preventClose);
+ return () => window.removeEventListener('beforeunload', preventClose);
+ }, [hasActiveLocalJob]);
+
const getLocalJobStartedAt = useCallback(() => {
const startedAt = Math.max(Date.now(), lastLocalJobStartedAt.current + 1);
lastLocalJobStartedAt.current = startedAt;
diff --git a/packages/studio/src/test/render-queue-scheduler.test.tsx b/packages/studio/src/test/render-queue-scheduler.test.tsx
index 9aa2e84d01..cbf663274d 100644
--- a/packages/studio/src/test/render-queue-scheduler.test.tsx
+++ b/packages/studio/src/test/render-queue-scheduler.test.tsx
@@ -10,6 +10,7 @@ import {
RenderQueueContext,
RenderQueueContextProvider,
} from '../components/RenderQueue/context';
+import type {AddVideoMattingJobParams} from '../components/RenderQueue/video-matting-job-types';
afterEach(cleanup);
@@ -57,6 +58,80 @@ const makeStillParams = (compositionId: string): AddClientStillJobParams => ({
allowHtmlInCanvas: false,
});
+const videoMattingParams: AddVideoMattingJobParams = {
+ audio: 'base',
+ baseOutName: 'video-base.webm',
+ displayName: 'video.mp4',
+ foregroundOutName: 'video-foreground.webm',
+ model: 'ben2-base',
+ src: '/video.mp4',
+ videoBitrate: 'very-high',
+};
+
+const closeIsPrevented = () => {
+ const event = new Event('beforeunload', {cancelable: true});
+ window.dispatchEvent(event);
+ return event.defaultPrevented;
+};
+
+test('prevents closing the tab while browser-local jobs are incomplete', async () => {
+ let currentContext: ContextType<typeof RenderQueueContext> | null = null;
+ const ReadContext = () => {
+ currentContext = useContext(RenderQueueContext);
+ return null;
+ };
+
+ render(
+ <RenderQueueContextProvider>
+ <ReadContext />
+ </RenderQueueContextProvider>,
+ );
+
+ const getContext = () => {
+ if (currentContext === null) {
+ throw new Error('Render queue context is not mounted');
+ }
+
+ return currentContext;
+ };
+
+ expect(closeIsPrevented()).toBe(false);
+ let captionId = '';
+ act(() => {
+ captionId = getContext().addCaptionJob(makeCaptionParams('audio.mp3'));
+ });
+ await waitFor(() => expect(closeIsPrevented()).toBe(true));
+ act(() => getContext().markCaptionJobDone(captionId, 1));
+ await waitFor(() => expect(closeIsPrevented()).toBe(false));
+
+ let videoMattingId = '';
+ act(() => {
+ videoMattingId = getContext().addVideoMattingJob(videoMattingParams);
+ });
+ await waitFor(() => expect(closeIsPrevented()).toBe(true));
+ act(() => getContext().markVideoMattingJobDone(videoMattingId));
+ await waitFor(() => expect(closeIsPrevented()).toBe(false));
+
+ let renderId = '';
+ act(() => {
+ renderId = getContext().addClientStillJob(
+ makeStillParams('composition'),
+ compositionRef,
+ );
+ });
+ await waitFor(() => expect(closeIsPrevented()).toBe(true));
+ act(() => getContext().markClientJobSaving(renderId));
+ expect(closeIsPrevented()).toBe(true);
+ act(() =>
+ getContext().markClientJobDone(renderId, {
+ height: 100,
+ sizeInBytes: 1,
+ width: 100,
+ }),
+ );
+ await waitFor(() => expect(closeIsPrevented()).toBe(false));
+});
+
test('processes client renders and captions in one local FIFO', async () => {
const dateNow = spyOn(Date, 'now').mockReturnValue(1_000);
let currentContext: ContextType<typeof RenderQueueContext> | null = null;