🎥 Make videos programmatically with React
fix(lambda): allow custom s3 output provider with default key (Fixes #5227)
smartcalsystems-sketch140b07ea4850
diff --git a/packages/lambda/src/cli/commands/render/render.ts b/packages/lambda/src/cli/commands/render/render.tsindex 9a7af4b5ec..0e4e2537c0 100644--- a/packages/lambda/src/cli/commands/render/render.ts+++ b/packages/lambda/src/cli/commands/render/render.ts@@ -416,7 +416,7 @@ export const renderCommand = async ({typeof resolvedOutName === 'object' && resolvedOutName !== null? {bucketName: resolvedOutName.bucketName,- keyPrefix: resolvedOutName.key,+ keyPrefix: resolvedOutName.key ?? '',s3OutputProvider: resolvedOutName.s3OutputProvider,}: resolvedOutName,diff --git a/packages/serverless-client/src/constants.ts b/packages/serverless-client/src/constants.tsindex f354c1141f..3eee0632a8 100644--- a/packages/serverless-client/src/constants.ts+++ b/packages/serverless-client/src/constants.ts@@ -59,7 +59,7 @@ export type OutNameInput<Provider extends CloudProvider> =| string| {bucketName: string;- key: string;+ key?: string;s3OutputProvider?: CustomCredentials<Provider>;};@@ -373,7 +373,7 @@ export type OutNameInputWithoutCredentials =| string| {bucketName: string;- key: string;+ key?: string;s3OutputProvider?: CustomCredentialsWithoutSensitiveData;};@@ -389,6 +389,7 @@ export const customOutName = <Provider extends CloudProvider>(renderId: string,bucketName: string,name: OutNameInput<Provider>,+ defaultKey?: string,): OutNameOutput<Provider> => {if (typeof name === 'string') {return {@@ -398,8 +399,15 @@ export const customOutName = <Provider extends CloudProvider>(};}+ const resolvedKey = name.key ?? defaultKey;+ if (typeof resolvedKey !== 'string') {+ throw new TypeError(+ 'The S3 key must be specified or a default key must be available.',+ );+ }+return {- key: name.key,+ key: resolvedKey,renderBucketName: name.bucketName,customCredentials: name.s3OutputProvider ?? null,};diff --git a/packages/serverless-client/src/expected-out-name.ts b/packages/serverless-client/src/expected-out-name.tsindex 0581988944..f55ee794b7 100644--- a/packages/serverless-client/src/expected-out-name.ts+++ b/packages/serverless-client/src/expected-out-name.ts@@ -77,7 +77,38 @@ export const getExpectedOutName = <Provider extends CloudProvider>({separateAudioTo: separateAudioFilename?.toLowerCase() ?? null,bucketNamePrefix,});- return customOutName(renderMetadata.renderId, bucketName, outNameValue);++ const defaultKey = (() => {+ if (output === 'separate-audio') {+ return null;+ }++ if (renderMetadata.type === 'still') {+ return outStillName(+ renderMetadata.renderId,+ renderMetadata.imageFormat,+ );+ }++ if (renderMetadata.type === 'video') {+ return outName(+ renderMetadata.renderId,+ NoReactAPIs.getFileExtensionFromCodec(+ renderMetadata.codec as Codec,+ separateAudioFilename === null ? renderMetadata.audioCodec : null,+ ),+ );+ }++ return null;+ })();++ return customOutName(+ renderMetadata.renderId,+ bucketName,+ outNameValue,+ defaultKey ?? undefined,+ );}if (output === 'separate-audio') {diff --git a/packages/serverless-client/src/test/expected-out-name.test.ts b/packages/serverless-client/src/test/expected-out-name.test.tsindex f370efe4cd..0c95b5bfca 100644--- a/packages/serverless-client/src/test/expected-out-name.test.ts+++ b/packages/serverless-client/src/test/expected-out-name.test.ts@@ -137,6 +137,87 @@ test('Should preserve custom provider regions outside the built-in AWS list', ()});});+test('Should default key when outName specifies custom s3OutputProvider without key for video', () => {+ const newRenderMetadata: RenderMetadata<MockProvider> = {+ ...testRenderMetadata,+ outName: {+ bucketName: 'renders-dev.mykaraoke.video',+ s3OutputProvider: {+ endpoint: 'https://fly.storage.tigris.dev',+ },+ },+ privacy: 'private',+ };++ expect(+ getExpectedOutName({+ output: 'main',+ renderMetadata: newRenderMetadata,+ bucketName,+ customCredentials: {+ endpoint: 'https://fly.storage.tigris.dev',+ accessKeyId: 'access-key',+ secretAccessKey: 'secret-key',+ region: 'auto',+ forcePathStyle: false,+ },+ bucketNamePrefix: 'remotionlambda-',+ }),+ ).toEqual({+ customCredentials: {+ endpoint: 'https://fly.storage.tigris.dev',+ accessKeyId: 'access-key',+ secretAccessKey: 'secret-key',+ region: 'auto',+ forcePathStyle: false,+ },+ renderBucketName: 'renders-dev.mykaraoke.video',+ key: 'renders/9n8dsfafs/out.mp4',+ });+});++test('Should default key when outName specifies custom s3OutputProvider without key for still', () => {+ const newRenderMetadata: RenderMetadata<MockProvider> = {+ ...testRenderMetadata,+ type: 'still',+ codec: null,+ imageFormat: 'png',+ outName: {+ bucketName: 'renders-dev.mykaraoke.video',+ s3OutputProvider: {+ endpoint: 'https://fly.storage.tigris.dev',+ },+ },+ privacy: 'no-acl',+ };++ expect(+ getExpectedOutName({+ output: 'main',+ renderMetadata: newRenderMetadata,+ bucketName,+ customCredentials: {+ endpoint: 'https://fly.storage.tigris.dev',+ accessKeyId: 'access-key',+ secretAccessKey: 'secret-key',+ region: 'auto',+ forcePathStyle: true,+ },+ bucketNamePrefix: 'remotionlambda-',+ }),+ ).toEqual({+ customCredentials: {+ endpoint: 'https://fly.storage.tigris.dev',+ accessKeyId: 'access-key',+ secretAccessKey: 'secret-key',+ region: 'auto',+ forcePathStyle: true,+ },+ renderBucketName: 'renders-dev.mykaraoke.video',+ key: 'renders/9n8dsfafs/out.png',+ });+});+test('For stills', () => {const newRenderMetadata: RenderMetadata<MockProvider> = {...testRenderMetadata,diff --git a/packages/serverless-client/src/validate-outname.ts b/packages/serverless-client/src/validate-outname.tsindex b8e4dc4e60..289d7bca67 100644--- a/packages/serverless-client/src/validate-outname.ts+++ b/packages/serverless-client/src/validate-outname.ts@@ -38,7 +38,10 @@ export const validateOutname = ({}if (typeof outName !== 'string') {- validateS3Key(outName.key);+ if (typeof outName.key !== 'undefined') {+ validateS3Key(outName.key);+ }+validateBucketName({bucketName: outName.bucketName,bucketNamePrefix,