🎥 Make videos programmatically with React
Move conditional output support behind provider interface
JonnyBurgere9f6d39786e2
diff --git a/packages/lambda-client/src/aws-provider.ts b/packages/lambda-client/src/aws-provider.tsindex 8e5cd993e5..1773c79006 100644--- a/packages/lambda-client/src/aws-provider.ts+++ b/packages/lambda-client/src/aws-provider.ts@@ -115,6 +115,8 @@ export const awsImplementation: ProviderSpecifics<AwsProvider> = {randomHash: randomHashImplementation,readFile: lambdaReadFileImplementation,writeFile: lambdaWriteFileImplementation,+ supportsConditionalOutput: ({customCredentials}) =>+ customCredentials === null,writeFileIfNotExists: lambdaWriteFileIfNotExistsImplementation,headFile: lambdaHeadFileImplementation,convertToServeUrl: convertToServeUrlImplementation,diff --git a/packages/lambda-client/src/head-file.ts b/packages/lambda-client/src/head-file.tsindex 28ecfbd09d..30101d1c2b 100644--- a/packages/lambda-client/src/head-file.ts+++ b/packages/lambda-client/src/head-file.ts@@ -1,4 +1,5 @@import {HeadObjectCommand} from '@aws-sdk/client-s3';+import {OutputFileAccessDeniedError} from '@remotion/serverless-client';import type {ProviderSpecifics} from '@remotion/serverless-client';import type {AwsProvider} from './aws-provider';import {getS3Client} from './get-s3-client';@@ -16,16 +17,40 @@ export const lambdaHeadFileImplementation: ProviderSpecifics<AwsProvider>['headFLastModified?: Date | undefined;ContentLength?: number | undefined;}> => {- const head = await getS3Client({- region,- customCredentials,- forcePathStyle,- requestHandler,- }).send(- new HeadObjectCommand({- Bucket: bucketName,- Key: key,- }),- );- return {...head, renderId: head.Metadata?.['remotion-render-id'] ?? null};+ try {+ const head = await getS3Client({+ region,+ customCredentials,+ forcePathStyle,+ requestHandler,+ }).send(+ new HeadObjectCommand({+ Bucket: bucketName,+ Key: key,+ }),+ );+ return {...head, renderId: head.Metadata?.['remotion-render-id'] ?? null};+ } catch (err) {+ if (+ (err as Error).message === 'UnknownError' ||+ (err as {$metadata: {httpStatusCode: number}}).$metadata+ ?.httpStatusCode === 403+ ) {+ const ErrorClass =+ (err as {$metadata: {httpStatusCode: number} | undefined}).$metadata+ ?.httpStatusCode === 403+ ? OutputFileAccessDeniedError+ : Error;+ throw new ErrorClass(+ `Unable to access item "${key}" from bucket "${bucketName}" ${+ customCredentials?.endpoint+ ? `(S3 Endpoint = ${customCredentials?.endpoint})`+ : ''+ } - got a 403 error when heading the file. Check your credentials and permissions. The Lambda role must have permission for both "s3:GetObject" and "s3:ListBucket" actions.`,+ {cause: err},+ );+ }++ throw err;+ }};diff --git a/packages/lambda-client/src/test/write-file.test.ts b/packages/lambda-client/src/test/write-file.test.tsindex 82d1e022f2..fc3662673b 100644--- a/packages/lambda-client/src/test/write-file.test.ts+++ b/packages/lambda-client/src/test/write-file.test.ts@@ -1,8 +1,11 @@import {beforeAll, expect, mock, test} from 'bun:test';import {Readable} from 'node:stream';+import {OutputFileAccessDeniedError} from '@remotion/serverless-client';+import {lambdaHeadFileImplementation} from '../head-file';import type {lambdaWriteFileImplementation as LambdaWriteFileImplementation} from '../write-file';const uploadDone = mock();+const send = mock();mock.module('@aws-sdk/lib-storage', () => ({Upload: class {@@ -12,7 +15,7 @@ mock.module('@aws-sdk/lib-storage', () => ({mock.module('../get-s3-client', () => ({getS3Client: () => ({- send: mock(),+ send,}),}));@@ -50,3 +53,25 @@ test('does not retry a failed upload with a consumed Readable', async () => {expect(thrownError).toBe(originalError);expect(uploadDone).toHaveBeenCalledTimes(1);});++test('normalizes denied destination reads without masking unexpected storage failures', async () => {+ for (const status of [403, 500]) {+ const error = Object.assign(new Error('Storage request failed'), {+ $metadata: {httpStatusCode: status},+ });+ send.mockRejectedValueOnce(error);+ const result = lambdaHeadFileImplementation({+ bucketName: 'output-bucket',+ key: 'video.mp4',+ region: 'us-east-1',+ customCredentials: null,+ forcePathStyle: false,+ requestHandler: null,+ });+ if (status === 403) {+ await expect(result).rejects.toBeInstanceOf(OutputFileAccessDeniedError);+ } else {+ await expect(result).rejects.toBe(error);+ }+ }+});diff --git a/packages/lambda/src/test/integration/renders/write-only-bucket.test.ts b/packages/lambda/src/test/integration/renders/write-only-bucket.test.tsindex da6a8c837c..696d718b74 100644--- a/packages/lambda/src/test/integration/renders/write-only-bucket.test.ts+++ b/packages/lambda/src/test/integration/renders/write-only-bucket.test.ts@@ -5,7 +5,10 @@ import path from 'node:path';import {bundle} from '@remotion/bundler';import {LambdaClientInternals} from '@remotion/lambda-client';import {RenderInternals} from '@remotion/renderer';-import {ServerlessRoutines} from '@remotion/serverless';+import {+ OutputFileAccessDeniedError,+ ServerlessRoutines,+} from '@remotion/serverless';import {mockImplementation} from '../../mocks/mock-implementation';import {readMockS3File} from '../../mocks/mock-store';import {waitUntilDone} from '../wait-until-done';@@ -19,14 +22,16 @@ test.each([1, 2])(const key = 'output.mp4';const originalHead = mockImplementation.headFile;const originalConditionalWrite = mockImplementation.writeFileIfNotExists;+ const capabilitySpy = spyOn(+ mockImplementation,+ 'supportsConditionalOutput',+ );let destinationChecks = 0;const headSpy = spyOn(mockImplementation, 'headFile').mockImplementation((input) => {if (input.bucketName === destination) {destinationChecks++;- throw Object.assign(new Error('Forbidden'), {- $metadata: {httpStatusCode: 403},- });+ throw new OutputFileAccessDeniedError('s3:GetObject access denied');}return originalHead(input);@@ -102,6 +107,11 @@ test.each([1, 2])().toBe(false);expect(destinationChecks).toBeGreaterThanOrEqual(2);+ // The provider can reject a destination even when it implements conditional writes.+ capabilitySpy.mockReturnValue(false);+ await expect(render(false)).rejects.toThrow('s3:GetObject');+ capabilitySpy.mockReturnValue(true);+// Without conditional uploads, denied preflight reads must remain fatal.mockImplementation.writeFileIfNotExists = null;await expect(render(false)).rejects.toThrow('s3:GetObject');@@ -118,6 +128,7 @@ test.each([1, 2])(}} finally {mockImplementation.writeFileIfNotExists = originalConditionalWrite;+ capabilitySpy.mockRestore();headSpy.mockRestore();await close?.();fs.rmSync(temp, {recursive: true, force: true});diff --git a/packages/lambda/src/test/mocks/mock-implementation.ts b/packages/lambda/src/test/mocks/mock-implementation.tsindex f563acac38..869b4f7496 100644--- a/packages/lambda/src/test/mocks/mock-implementation.ts+++ b/packages/lambda/src/test/mocks/mock-implementation.ts@@ -118,6 +118,7 @@ export const mockImplementation: ProviderSpecifics<AwsProvider> = {});return Promise.resolve(undefined);},+ supportsConditionalOutput: () => true,writeFileIfNotExists: async ({body,bucketName,diff --git a/packages/serverless-client/src/find-output-file-in-bucket.ts b/packages/serverless-client/src/find-output-file-in-bucket.tsindex fdd4ec89cb..e5063acf1b 100644--- a/packages/serverless-client/src/find-output-file-in-bucket.ts+++ b/packages/serverless-client/src/find-output-file-in-bucket.ts@@ -63,26 +63,6 @@ export const findOutputFileInBucket = async <Provider extends CloudProvider>({return null;}- if (- (err as Error).message === 'UnknownError' ||- (err as {$metadata: {httpStatusCode: number}}).$metadata- ?.httpStatusCode === 403- ) {- const ErrorClass =- (err as {$metadata: {httpStatusCode: number} | undefined}).$metadata- ?.httpStatusCode === 403- ? OutputFileAccessDeniedError- : Error;- throw new ErrorClass(- `Unable to access item "${key}" from bucket "${renderBucketName}" ${- customCredentials?.endpoint- ? `(S3 Endpoint = ${customCredentials?.endpoint})`- : ''- } - got a 403 error when heading the file. Check your credentials and permissions. The Lambda role must have permission for both "s3:GetObject" and "s3:ListBucket" actions.`,- {cause: err},- );- }-throw err;}};diff --git a/packages/serverless-client/src/provider-implementation.ts b/packages/serverless-client/src/provider-implementation.tsindex e030481e96..38048b94e7 100644--- a/packages/serverless-client/src/provider-implementation.ts+++ b/packages/serverless-client/src/provider-implementation.ts@@ -249,9 +249,15 @@ export type ProviderSpecifics<Provider extends CloudProvider> = {randomHash: RandomHash;readFile: ReadFile<Provider>;writeFile: WriteFile<Provider>;+ // Whether this destination supports atomic create-only output uploads.+ supportsConditionalOutput: (params: {+ customCredentials: CustomCredentials<Provider> | null;+ }) => boolean;writeFileIfNotExists:| ((params: WriteFileInput<Provider> & {renderId: string}) => Promise<void>)| null;+ // Normalize permission failures to OutputFileAccessDeniedError and missing files+ // to an error named NotFound. Other errors must propagate unchanged.headFile: HeadFile<Provider>;convertToServeUrl: ConvertToServeUrl<Provider>;printLoggingHelper: boolean;diff --git a/packages/serverless-client/src/test/progress.test.ts b/packages/serverless-client/src/test/progress.test.tsindex 4261848fc0..f0e05b6ab1 100644--- a/packages/serverless-client/src/test/progress.test.ts+++ b/packages/serverless-client/src/test/progress.test.ts@@ -2,6 +2,7 @@ import {expect, test} from 'bun:test';import {Readable} from 'node:stream';import {overallProgressKey} from '../constants';import {getExpectedOutName} from '../expected-out-name';+import {OutputFileAccessDeniedError} from '../find-output-file-in-bucket';import type {OverallRenderProgress} from '../overall-render-progress';import {getProgress} from '../progress';import type {@@ -165,6 +166,7 @@ const makeProviderSpecifics = ({serverStorageProductName: () => 'S3',validateDeleteAfter: () => undefined,writeFile: () => Promise.resolve(),+ supportsConditionalOutput: () => true,writeFileIfNotExists: null,headFile: onHeadFile,};@@ -305,9 +307,7 @@ test('getProgress falls back to persisted progress when destination reads are deonHeadFile: () => {heads++;return Promise.reject(- Object.assign(new Error('Forbidden'), {- $metadata: {httpStatusCode: 403},- }),+ new OutputFileAccessDeniedError('Destination read access denied'),);},});diff --git a/packages/serverless/src/handlers/launch.ts b/packages/serverless/src/handlers/launch.tsindex 2eda4d89b5..0ca6793155 100644--- a/packages/serverless/src/handlers/launch.ts+++ b/packages/serverless/src/handlers/launch.ts@@ -348,7 +348,9 @@ const innerLaunchHandler = async <Provider extends CloudProvider>({const renderMetadata: RenderMetadata<Provider> = {outputFileIsConditional:!params.overwrite &&- getCredentialsFromOutName(params.outName ?? null) === null &&+ providerSpecifics.supportsConditionalOutput({+ customCredentials: getCredentialsFromOutName(params.outName ?? null),+ }) &&providerSpecifics.writeFileIfNotExists !== null,startedDate,totalChunks: chunks.length,diff --git a/packages/serverless/src/test/overall-render-progress.test.ts b/packages/serverless/src/test/overall-render-progress.test.tsindex 1ff50fbc24..1762305466 100644--- a/packages/serverless/src/test/overall-render-progress.test.ts+++ b/packages/serverless/src/test/overall-render-progress.test.ts@@ -58,6 +58,7 @@ const makeProviderSpecifics = ({serverStorageProductName: () => 'S3',validateDeleteAfter: () => undefined,writeFile,+ supportsConditionalOutput: () => true,writeFileIfNotExists: null,};};