Skip to content

🎥 Make videos programmatically with React

Remove output render ID metadata and recovery matching

JonnyBurgeraf1f2aba3f90
diff --git a/packages/lambda-client/src/head-file.ts b/packages/lambda-client/src/head-file.ts
index 30101d1c2b..47905f832e 100644
--- a/packages/lambda-client/src/head-file.ts
+++ b/packages/lambda-client/src/head-file.ts
@@ -13,7 +13,6 @@ export const lambdaHeadFileImplementation: ProviderSpecifics<AwsProvider>['headF
forcePathStyle,
requestHandler,
}): Promise<{
- renderId: string | null;
LastModified?: Date | undefined;
ContentLength?: number | undefined;
}> => {
@@ -29,7 +28,7 @@ export const lambdaHeadFileImplementation: ProviderSpecifics<AwsProvider>['headF
Key: key,
}),
);
- return {...head, renderId: head.Metadata?.['remotion-render-id'] ?? null};
+ return head;
} catch (err) {
if (
(err as Error).message === 'UnknownError' ||
diff --git a/packages/lambda-client/src/write-file.ts b/packages/lambda-client/src/write-file.ts
index ab2f9d33ee..4470bd98ba 100644
--- a/packages/lambda-client/src/write-file.ts
+++ b/packages/lambda-client/src/write-file.ts
@@ -29,8 +29,8 @@ const tryLambdaWriteFile = async ({
forcePathStyle,
storageClass,
requestHandler,
- renderId,
-}: WriteFileInput<AwsProvider> & {renderId: string | null}): Promise<void> => {
+ ifNotExists,
+}: WriteFileInput<AwsProvider> & {ifNotExists: boolean}): Promise<void> => {
const client = getS3Client({
region,
customCredentials: customCredentials as CustomCredentials<AwsProvider>,
@@ -54,8 +54,7 @@ const tryLambdaWriteFile = async ({
ContentType: mimeTypes.lookup(key) || 'application/octet-stream',
ContentDisposition: getContentDispositionHeader(downloadBehavior),
StorageClass: storageClass ?? undefined,
- IfNoneMatch: renderId === null ? undefined : '*',
- Metadata: renderId === null ? undefined : {'remotion-render-id': renderId},
+ IfNoneMatch: ifNotExists ? '*' : undefined,
};
// Determine file size
@@ -84,7 +83,7 @@ const tryLambdaWriteFile = async ({
.$metadata?.httpStatusCode;
// lib-storage does not abort when CompleteMultipartUpload rejects a condition.
if (
- renderId !== null &&
+ ifNotExists &&
upload.uploadId &&
(status === 412 || status === 409)
) {
@@ -113,7 +112,7 @@ const tryLambdaWriteFile = async ({
const writeFileWithRetries = async (
params: WriteFileInput<AwsProvider> & {
retries?: number;
- renderId: string | null;
+ ifNotExists: boolean;
},
): Promise<void> => {
const remainingRetries = params.retries ?? 2;
@@ -121,7 +120,7 @@ const writeFileWithRetries = async (
await tryLambdaWriteFile(params);
} catch (err) {
if (
- params.renderId !== null &&
+ params.ifNotExists &&
(err as {$metadata: {httpStatusCode: number} | undefined}).$metadata
?.httpStatusCode === 412
) {
@@ -157,14 +156,14 @@ const writeFileWithRetries = async (
export const lambdaWriteFileImplementation = (
params: WriteFileInput<AwsProvider> & {retries?: number},
-): Promise<void> => writeFileWithRetries({...params, renderId: null});
+): Promise<void> => writeFileWithRetries({...params, ifNotExists: false});
export const lambdaWriteFileIfNotExistsImplementation = (
- params: WriteFileInput<AwsProvider> & {renderId: string},
+ params: WriteFileInput<AwsProvider>,
): Promise<void> => {
if (params.customCredentials !== null) {
throw new Error('Conditional output uploads are only supported for AWS S3');
}
- return writeFileWithRetries(params);
+ return writeFileWithRetries({...params, ifNotExists: true});
};
diff --git a/packages/lambda/src/test/mocks/mock-implementation.ts b/packages/lambda/src/test/mocks/mock-implementation.ts
index 869b4f7496..ab6a9cb729 100644
--- a/packages/lambda/src/test/mocks/mock-implementation.ts
+++ b/packages/lambda/src/test/mocks/mock-implementation.ts
@@ -22,8 +22,6 @@ import {
writeMockS3File,
} from './mock-store';
-const conditionalRenderIds = new Map<string, string>();
-
export const mockImplementation: ProviderSpecifics<AwsProvider> = {
getAccountId: () =>
Promise.resolve('aws:iam::123456789'.match(/aws:iam::([0-9]+)/)?.[1]!),
@@ -108,7 +106,6 @@ export const mockImplementation: ProviderSpecifics<AwsProvider> = {
return Promise.resolve(createReadStream(tmp));
},
writeFile: async ({body, bucketName, key, privacy, region}) => {
- conditionalRenderIds.delete(`${region}/${bucketName}/${key}`);
await writeMockS3File({
body,
bucketName,
@@ -119,14 +116,7 @@ export const mockImplementation: ProviderSpecifics<AwsProvider> = {
return Promise.resolve(undefined);
},
supportsConditionalOutput: () => true,
- writeFileIfNotExists: async ({
- body,
- bucketName,
- key,
- privacy,
- region,
- renderId,
- }) => {
+ writeFileIfNotExists: async ({body, bucketName, key, privacy, region}) => {
const content = await streamToUint8Array(body);
if (readMockS3File({region, bucketName, key})) {
throw new Error(
@@ -135,7 +125,6 @@ export const mockImplementation: ProviderSpecifics<AwsProvider> = {
}
await writeMockS3File({body: content, bucketName, key, privacy, region});
- conditionalRenderIds.set(`${region}/${bucketName}/${key}`, renderId);
},
headFile: ({bucketName, key, region}) => {
const read = readMockS3File({
@@ -150,8 +139,6 @@ export const mockImplementation: ProviderSpecifics<AwsProvider> = {
}
return Promise.resolve({
- renderId:
- conditionalRenderIds.get(`${region}/${bucketName}/${key}`) ?? null,
ContentLength: read.content.toString().length,
LastModified: new Date(),
});
diff --git a/packages/serverless-client/src/find-output-file-in-bucket.ts b/packages/serverless-client/src/find-output-file-in-bucket.ts
index e5063acf1b..be9e0db301 100644
--- a/packages/serverless-client/src/find-output-file-in-bucket.ts
+++ b/packages/serverless-client/src/find-output-file-in-bucket.ts
@@ -7,7 +7,6 @@ import type {CloudProvider} from './types';
export type OutputFileMetadata = {
url: string;
sizeInBytes: number | null;
- renderId: string | null;
};
export class OutputFileAccessDeniedError extends Error {}
@@ -49,7 +48,6 @@ export const findOutputFileInBucket = async <Provider extends CloudProvider>({
});
return {
- renderId: metadata.renderId ?? null,
url: providerSpecifics.getOutputUrl({
renderMetadata,
bucketName,
diff --git a/packages/serverless-client/src/progress.ts b/packages/serverless-client/src/progress.ts
index e16fb8db08..c269689145 100644
--- a/packages/serverless-client/src/progress.ts
+++ b/packages/serverless-client/src/progress.ts
@@ -281,11 +281,7 @@ export const getProgress = async <Provider extends CloudProvider>({
throw err;
});
- if (
- outputFile &&
- (!renderMetadata.outputFileIsConditional ||
- outputFile.renderId === renderId)
- ) {
+ if (outputFile) {
const outData = getExpectedOutName({
renderMetadata,
bucketName,
diff --git a/packages/serverless-client/src/provider-implementation.ts b/packages/serverless-client/src/provider-implementation.ts
index 38048b94e7..11a0656428 100644
--- a/packages/serverless-client/src/provider-implementation.ts
+++ b/packages/serverless-client/src/provider-implementation.ts
@@ -103,7 +103,6 @@ type ConvertToServeUrl<Provider extends CloudProvider> = (params: {
}) => string;
type HeadFileOutput = {
- renderId: string | null;
LastModified?: Date | undefined;
ContentLength?: number | undefined;
};
@@ -253,9 +252,7 @@ export type ProviderSpecifics<Provider extends CloudProvider> = {
supportsConditionalOutput: (params: {
customCredentials: CustomCredentials<Provider> | null;
}) => boolean;
- writeFileIfNotExists:
- | ((params: WriteFileInput<Provider> & {renderId: string}) => Promise<void>)
- | null;
+ writeFileIfNotExists: WriteFile<Provider> | null;
// Normalize permission failures to OutputFileAccessDeniedError and missing files
// to an error named NotFound. Other errors must propagate unchanged.
headFile: HeadFile<Provider>;
diff --git a/packages/serverless-client/src/render-metadata.ts b/packages/serverless-client/src/render-metadata.ts
index 9db007724d..70e8aed9ac 100644
--- a/packages/serverless-client/src/render-metadata.ts
+++ b/packages/serverless-client/src/render-metadata.ts
@@ -50,7 +50,7 @@ export type RenderMetadata<Provider extends CloudProvider> = Discriminated & {
region: Provider['region'];
renderId: string;
outName: OutNameInputWithoutCredentials | undefined;
- // Conditional outputs carry the render ID so recovery cannot use another render's file.
+ // Whether the final upload must create a new object without overwriting.
outputFileIsConditional: boolean | null;
privacy: Privacy;
deleteAfter: DeleteAfter | null;
diff --git a/packages/serverless-client/src/test/progress.test.ts b/packages/serverless-client/src/test/progress.test.ts
index f0e05b6ab1..2c642d26af 100644
--- a/packages/serverless-client/src/test/progress.test.ts
+++ b/packages/serverless-client/src/test/progress.test.ts
@@ -178,7 +178,7 @@ test('getProgress treats an existing output file as finished if postRenderData w
billingCurrency: 'CNY',
onHeadFile: ({bucketName: headedBucketName, key}) => {
headedFiles.push({bucketName: headedBucketName, key});
- return Promise.resolve({ContentLength: 1234, renderId: null});
+ return Promise.resolve({ContentLength: 1234});
},
renderProgress: null,
});
@@ -226,7 +226,7 @@ test('getProgress estimates costs from invoked lambdas only', async () => {
priceInputs.push(input);
return input.durationInMilliseconds;
},
- onHeadFile: () => Promise.resolve({ContentLength: 0, renderId: null}),
+ onHeadFile: () => Promise.resolve({ContentLength: 0}),
renderProgress: null,
});
@@ -334,36 +334,6 @@ test('getProgress falls back to persisted progress when destination reads are de
expect(heads).toBe(2);
});
-test('getProgress only recovers a conditional output belonging to this render', async () => {
- for (const outputRenderId of [null, 'another-render', renderId]) {
- const providerSpecifics = makeProviderSpecifics({
- renderProgress: {
- ...progress,
- renderMetadata: {...renderMetadata, outputFileIsConditional: true},
- },
- onHeadFile: () =>
- Promise.resolve({renderId: outputRenderId, ContentLength: 1234}),
- });
- const result = await getProgress({
- bucketName,
- renderId,
- customCredentials: null,
- expectedBucketOwner: null,
- forcePathStyle: false,
- functionName: renderMetadata.functionName,
- memorySizeInMb: 2048,
- providerSpecifics,
- region: 'eu-central-1',
- requestHandler: null,
- timeoutInMilliseconds: 120000,
- });
- expect(result.done).toBe(outputRenderId === renderId);
- expect(result.outputSizeInBytes).toBe(
- outputRenderId === renderId ? 1234 : null,
- );
- }
-});
-
test('getProgress preserves upload failures and unexpected storage errors', async () => {
const uploadFailure = {
type: 'stitcher' as const,
diff --git a/packages/serverless/src/finish-render.ts b/packages/serverless/src/finish-render.ts
index 86ba242248..7e5a374c2e 100644
--- a/packages/serverless/src/finish-render.ts
+++ b/packages/serverless/src/finish-render.ts
@@ -86,10 +86,7 @@ export const finishRender = async <Provider extends CloudProvider>({
);
}
- await providerSpecifics.writeFileIfNotExists({
- ...writeOptions,
- renderId: renderMetadata.renderId,
- });
+ await providerSpecifics.writeFileIfNotExists(writeOptions);
} else {
await providerSpecifics.writeFile(writeOptions);
}
@@ -122,7 +119,6 @@ export const finishRender = async <Provider extends CloudProvider>({
errorExplanations,
timeToDelete: (await cleanupProm).reduce((a, b) => Math.max(a, b), 0),
outputFile: {
- renderId: renderMetadata.renderId,
sizeInBytes: outputSize,
url: outputUrl,
},
diff --git a/packages/serverless/src/test/overall-render-progress.test.ts b/packages/serverless/src/test/overall-render-progress.test.ts
index 1762305466..8b6f362493 100644
--- a/packages/serverless/src/test/overall-render-progress.test.ts
+++ b/packages/serverless/src/test/overall-render-progress.test.ts
@@ -48,7 +48,7 @@ const makeProviderSpecifics = ({
getMaxNonInlinePayloadSizePerFunction: () => 0,
getMaxStillInlinePayloadSize: () => 0,
getOutputUrl: () => ({key: 'out.mp4', url: 'https://example.com/out.mp4'}),
- headFile: () => Promise.resolve({renderId: null}),
+ headFile: () => Promise.resolve({}),
isFlakyError: () => false,
listObjects: () => Promise.resolve([]),
parseFunctionName: () => null,