Skip to content

🎥 Make videos programmatically with React

@remotion/studio: Make AI job errors copyable

JonnyBurger038d07bed160
diff --git a/packages/studio/src/components/Modals.tsx b/packages/studio/src/components/Modals.tsx
index b9918826df..7100099cc4 100644
--- a/packages/studio/src/components/Modals.tsx
+++ b/packages/studio/src/components/Modals.tsx
@@ -29,6 +29,7 @@ import QuickSwitcher from './QuickSwitcher/QuickSwitcher';
import {RenderStatusModal} from './RenderModal/RenderStatusModal';
import {RenderModalWithLoader} from './RenderModal/ServerRenderModal';
import {WebRenderModalWithLoader} from './RenderModal/WebRenderModal';
+import {QueueJobErrorModal} from './RenderQueue/QueueJobErrorModal';
import {SettingsModal} from './SettingsModal';
import {SvgImportDialog} from './SvgImportDialog';
import {TranscriptionModalWithOptionalWhisper} from './Transcription/TranscriptionModalWithOptionalWhisper';
@@ -259,6 +260,12 @@ export const Modals: React.FC<{
{modalContextType && modalContextType.type === 'render-progress' && (
<RenderStatusModal jobId={modalContextType.jobId} />
)}
+ {modalContextType && modalContextType.type === 'queue-job-error' ? (
+ <QueueJobErrorModal
+ title={modalContextType.title}
+ error={modalContextType.error}
+ />
+ ) : null}
{modalContextType && modalContextType.type === 'transcribe' ? (
<TranscriptionModalWithOptionalWhisper state={modalContextType} />
) : null}
diff --git a/packages/studio/src/components/RenderQueue/CaptionQueueItem.tsx b/packages/studio/src/components/RenderQueue/CaptionQueueItem.tsx
index 80b7ed73fe..62923fc4e1 100644
--- a/packages/studio/src/components/RenderQueue/CaptionQueueItem.tsx
+++ b/packages/studio/src/components/RenderQueue/CaptionQueueItem.tsx
@@ -27,6 +27,7 @@ import {
renderQueueItemSubtitleStyle,
RENDER_QUEUE_ITEM_SELECTED_CLASSNAME,
} from './item-style';
+import {QueueJobError} from './QueueJobError';
import {SuccessIcon} from './SuccessIcon';
const container: React.CSSProperties = {
@@ -221,9 +222,16 @@ export const CaptionQueueItem: React.FC<{
<div style={right}>
<div style={title}>{job.displayName}</div>
<div style={subtitleContainer}>
- <span style={subtitle} title={message}>
- {message}
- </span>
+ {job.status === 'failed' ? (
+ <QueueJobError
+ error={job.error}
+ modalTitle="Transcription failed"
+ />
+ ) : (
+ <span style={subtitle} title={message}>
+ {message}
+ </span>
+ )}
</div>
</div>
<Spacing x={1} />
diff --git a/packages/studio/src/components/RenderQueue/QueueJobError.tsx b/packages/studio/src/components/RenderQueue/QueueJobError.tsx
new file mode 100644
index 0000000000..30027fb609
--- /dev/null
+++ b/packages/studio/src/components/RenderQueue/QueueJobError.tsx
@@ -0,0 +1,36 @@
+import React, {useCallback, useContext} from 'react';
+import {SetSelectedModalContext} from '../../state/modals';
+import {renderQueueItemSubtitleStyle} from './item-style';
+
+const errorStyle: React.CSSProperties = {
+ ...renderQueueItemSubtitleStyle,
+};
+
+export const QueueJobError: React.FC<{
+ readonly error: {message: string; stack: string | undefined};
+ readonly modalTitle: string;
+}> = ({error, modalTitle}) => {
+ const {setSelectedModal} = useContext(SetSelectedModalContext);
+ const onClick = useCallback(
+ (event: React.MouseEvent<HTMLButtonElement>) => {
+ event.stopPropagation();
+ setSelectedModal({
+ type: 'queue-job-error',
+ title: modalTitle,
+ error: {message: error.message, stack: error.stack ?? null},
+ });
+ },
+ [error, modalTitle, setSelectedModal],
+ );
+
+ return (
+ <button
+ onClick={onClick}
+ type="button"
+ style={errorStyle}
+ title={error.message}
+ >
+ {error.message}
+ </button>
+ );
+};
diff --git a/packages/studio/src/components/RenderQueue/QueueJobErrorModal.tsx b/packages/studio/src/components/RenderQueue/QueueJobErrorModal.tsx
new file mode 100644
index 0000000000..b2b639fdd0
--- /dev/null
+++ b/packages/studio/src/components/RenderQueue/QueueJobErrorModal.tsx
@@ -0,0 +1,71 @@
+import React, {useCallback, useContext} from 'react';
+import {CopyStackTrace} from '../../error-overlay/remotion-overlay/CopyStackTrace';
+import {RENDER_STATUS_BACKGROUND} from '../../helpers/colors';
+import {SetSelectedModalContext} from '../../state/modals';
+import {Button} from '../Button';
+import {Flex, SPACING_UNIT} from '../layout';
+import {HORIZONTAL_SCROLLBAR_CLASSNAME} from '../Menu/is-menu-item';
+import {ModalContainer} from '../ModalContainer';
+import {ModalHeader} from '../ModalHeader';
+
+const container: React.CSSProperties = {
+ padding: 20,
+ maxWidth: 900,
+ paddingTop: 0,
+};
+
+const codeBlock: React.CSSProperties = {
+ backgroundColor: RENDER_STATUS_BACKGROUND,
+ whiteSpace: 'pre',
+ padding: 12,
+ borderRadius: 4,
+ fontFamily: 'monospace',
+ overflow: 'auto',
+ maxHeight: 300,
+};
+
+const spacer: React.CSSProperties = {
+ height: SPACING_UNIT,
+ width: SPACING_UNIT,
+};
+
+const buttonRow: React.CSSProperties = {
+ display: 'flex',
+ flexDirection: 'row',
+ justifyContent: 'flex-end',
+};
+
+export const QueueJobErrorModal: React.FC<{
+ readonly title: string;
+ readonly error: {message: string; stack: string | null};
+}> = ({title, error}) => {
+ const {setSelectedModal} = useContext(SetSelectedModalContext);
+ const onClose = useCallback(() => {
+ setSelectedModal(null);
+ }, [setSelectedModal]);
+ const errorDetails = error.stack?.split('\n')[0].includes(error.message)
+ ? error.stack
+ : [error.message, error.stack].filter(Boolean).join('\n');
+
+ return (
+ <ModalContainer
+ ariaLabel={title}
+ onOutsideClick={onClose}
+ onEscape={onClose}
+ >
+ <ModalHeader title={title} />
+ <div style={container}>
+ <p>The job failed because of the following error:</p>
+ <div className={HORIZONTAL_SCROLLBAR_CLASSNAME} style={codeBlock}>
+ {errorDetails}
+ </div>
+ <div style={spacer} />
+ <div style={buttonRow}>
+ <CopyStackTrace errorText={errorDetails} />
+ <Flex />
+ <Button onClick={onClose}>Close</Button>
+ </div>
+ </div>
+ </ModalContainer>
+ );
+};
diff --git a/packages/studio/src/components/RenderQueue/VideoMattingQueueItem.tsx b/packages/studio/src/components/RenderQueue/VideoMattingQueueItem.tsx
index 9004384efd..b0905a7759 100644
--- a/packages/studio/src/components/RenderQueue/VideoMattingQueueItem.tsx
+++ b/packages/studio/src/components/RenderQueue/VideoMattingQueueItem.tsx
@@ -20,6 +20,7 @@ import {
} from './CircularProgress';
import {RenderQueueContext} from './context';
import {renderQueueItemSubtitleStyle} from './item-style';
+import {QueueJobError} from './QueueJobError';
import {SuccessIcon} from './SuccessIcon';
import type {VideoMattingJob} from './video-matting-job-types';
@@ -197,11 +198,18 @@ export const VideoMattingQueueItem: React.FC<{
<div style={right}>
<div style={title}>{job.displayName}</div>
<div style={subtitles} title={tooltip}>
- {messages.map((message) => (
- <span key={message} style={subtitle}>
- {message}
- </span>
- ))}
+ {job.status === 'failed' ? (
+ <QueueJobError
+ error={job.error}
+ modalTitle="Video matting failed"
+ />
+ ) : (
+ messages.map((message) => (
+ <span key={message} style={subtitle}>
+ {message}
+ </span>
+ ))
+ )}
</div>
</div>
<Spacing x={1} />
diff --git a/packages/studio/src/state/modals.ts b/packages/studio/src/state/modals.ts
index a644e34f69..9d4c970cee 100644
--- a/packages/studio/src/state/modals.ts
+++ b/packages/studio/src/state/modals.ts
@@ -266,6 +266,14 @@ export type ModalState =
type: 'render-progress';
jobId: string;
}
+ | {
+ type: 'queue-job-error';
+ title: string;
+ error: {
+ message: string;
+ stack: string | null;
+ };
+ }
| {
type: 'fix-computed-value';
prop: string;
diff --git a/packages/studio/src/test/queue-job-errors.test.tsx b/packages/studio/src/test/queue-job-errors.test.tsx
new file mode 100644
index 0000000000..c6a0269825
--- /dev/null
+++ b/packages/studio/src/test/queue-job-errors.test.tsx
@@ -0,0 +1,147 @@
+import {afterEach, expect, mock, test} from 'bun:test';
+import {
+ cleanup,
+ fireEvent,
+ render,
+ screen,
+ waitFor,
+ within,
+} from '@testing-library/react';
+import React, {useContext} from 'react';
+import {ModalsProvider} from '../components/ModalsProvider';
+import type {CaptionJob} from '../components/RenderQueue/caption-job-types';
+import {CaptionQueueItem} from '../components/RenderQueue/CaptionQueueItem';
+import {RenderQueueContext} from '../components/RenderQueue/context';
+import {QueueJobErrorModal} from '../components/RenderQueue/QueueJobErrorModal';
+import type {VideoMattingJob} from '../components/RenderQueue/video-matting-job-types';
+import {VideoMattingQueueItem} from '../components/RenderQueue/VideoMattingQueueItem';
+import {SelectedModalContext} from '../state/modals';
+
+const originalClipboard = Object.getOwnPropertyDescriptor(
+ navigator,
+ 'clipboard',
+);
+
+afterEach(() => {
+ cleanup();
+ if (originalClipboard) {
+ Object.defineProperty(navigator, 'clipboard', originalClipboard);
+ } else {
+ Reflect.deleteProperty(navigator, 'clipboard');
+ }
+});
+
+const captionJob: CaptionJob = {
+ id: 'caption-job',
+ type: 'caption',
+ startedAt: 0,
+ src: '/audio.mp3',
+ displayName: 'audio.mp3',
+ audioStreamIndex: null,
+ requestInit: null,
+ outName: 'captions.json',
+ target: null,
+ model: 'tiny.en',
+ language: null,
+ task: 'transcribe',
+ chunkLengthInSeconds: 30,
+ strideLengthInSeconds: 5,
+ forceFullSequences: false,
+ doSample: false,
+ temperature: 1,
+ topK: 50,
+ repetitionPenalty: 1,
+ noRepeatNgramSize: 0,
+ status: 'failed',
+ error: {
+ message: 'Transcription pipeline failed',
+ stack: 'Transcription pipeline failed\n at transcribe.ts:42:1',
+ },
+};
+
+const mattingJob: VideoMattingJob = {
+ id: 'matting-job',
+ type: 'video-matting',
+ startedAt: 0,
+ src: '/video.mp4',
+ displayName: 'video.mp4',
+ baseOutName: 'video-base.webm',
+ foregroundOutName: 'video-foreground.webm',
+ model: 'ben2-base',
+ audio: 'base',
+ videoBitrate: 'medium',
+ target: null,
+ status: 'failed',
+ error: {
+ message: 'Failed to create the LayerNorm shader',
+ stack: 'OrtRun aborted\n at matting.ts:17:1',
+ },
+};
+
+const QueueJobErrorModalRenderer: React.FC = () => {
+ const modal = useContext(SelectedModalContext);
+ if (modal?.type !== 'queue-job-error') {
+ return null;
+ }
+
+ return <QueueJobErrorModal title={modal.title} error={modal.error} />;
+};
+
+test('opens and copies transcription and video matting errors', async () => {
+ const writeText = mock(() => Promise.resolve());
+ Object.defineProperty(navigator, 'clipboard', {
+ configurable: true,
+ value: {writeText},
+ });
+
+ render(
+ <ModalsProvider>
+ <RenderQueueContext.Provider
+ value={
+ {
+ jobs: [],
+ captionJobs: [captionJob],
+ videoMattingJobs: [mattingJob],
+ removeCaptionJob: () => undefined,
+ removeVideoMattingJob: () => undefined,
+ } as never
+ }
+ >
+ <CaptionQueueItem job={captionJob} selected={false} />
+ <VideoMattingQueueItem job={mattingJob} selected={false} />
+ <QueueJobErrorModalRenderer />
+ </RenderQueueContext.Provider>
+ </ModalsProvider>,
+ );
+
+ fireEvent.click(screen.getByRole('button', {name: captionJob.error.message}));
+ const transcriptionDialog = screen.getByRole('dialog', {
+ name: 'Transcription failed',
+ });
+ expect(transcriptionDialog.textContent).toContain(captionJob.error.stack!);
+ fireEvent.click(
+ within(transcriptionDialog).getByRole('button', {name: 'Copy stack'}),
+ );
+ await waitFor(() => {
+ expect(writeText).toHaveBeenCalledWith(captionJob.error.stack!);
+ });
+ fireEvent.click(
+ within(transcriptionDialog).getByRole('button', {name: 'Close'}),
+ );
+
+ fireEvent.click(screen.getByRole('button', {name: mattingJob.error.message}));
+ const mattingDialog = screen.getByRole('dialog', {
+ name: 'Video matting failed',
+ });
+ expect(mattingDialog.textContent).toContain(
+ `${mattingJob.error.message}\n${mattingJob.error.stack}`,
+ );
+ fireEvent.click(
+ within(mattingDialog).getByRole('button', {name: 'Copy stack'}),
+ );
+ await waitFor(() => {
+ expect(writeText).toHaveBeenCalledWith(
+ `${mattingJob.error.message}\n${mattingJob.error.stack}`,
+ );
+ });
+});