Skip to content

🎥 Make videos programmatically with React

@remotion/lambda-client: Count props size in bytes before sending them inline

parbhatkapila43dce3bbfac39
diff --git a/packages/lambda-client/src/get-compositions-on-lambda.ts b/packages/lambda-client/src/get-compositions-on-lambda.ts
index dc3c824339..60042ef77e 100644
--- a/packages/lambda-client/src/get-compositions-on-lambda.ts
+++ b/packages/lambda-client/src/get-compositions-on-lambda.ts
@@ -9,6 +9,7 @@ import {
VERSION,
compressInputProps,
getNeedsToUpload,
+ getSizeInBytes,
serializeOrThrow,
} from '@remotion/serverless-client';
import {awsImplementation} from './aws-provider';
@@ -65,8 +66,8 @@ export const getCompositionsOnLambda = async ({
needsToUpload: getNeedsToUpload({
type: 'video-or-audio',
sizes: [
- stringifiedInputProps.length,
- JSON.stringify(envVariables).length,
+ getSizeInBytes(stringifiedInputProps),
+ getSizeInBytes(JSON.stringify(envVariables)),
],
providerSpecifics: awsImplementation,
}),
diff --git a/packages/lambda-client/src/make-lambda-payload.ts b/packages/lambda-client/src/make-lambda-payload.ts
index 49ebc1bd22..42a700d4ff 100644
--- a/packages/lambda-client/src/make-lambda-payload.ts
+++ b/packages/lambda-client/src/make-lambda-payload.ts
@@ -26,6 +26,7 @@ import {
compressInputProps,
ENABLE_V5_BREAKING_CHANGES,
getNeedsToUpload,
+ getSizeInBytes,
serializeOrThrow,
ServerlessRoutines,
validateDownloadBehavior,
@@ -184,8 +185,8 @@ export const makeLambdaRenderMediaPayload = async ({
needsToUpload: getNeedsToUpload({
type: 'video-or-audio',
sizes: [
- stringifiedInputProps.length,
- JSON.stringify(envVariables).length,
+ getSizeInBytes(stringifiedInputProps),
+ getSizeInBytes(JSON.stringify(envVariables)),
],
providerSpecifics: awsImplementation,
}),
@@ -319,8 +320,8 @@ export const makeLambdaRenderStillPayload = async ({
needsToUpload: getNeedsToUpload({
type: 'still',
sizes: [
- stringifiedInputProps.length,
- JSON.stringify(envVariables).length,
+ getSizeInBytes(stringifiedInputProps),
+ getSizeInBytes(JSON.stringify(envVariables)),
],
providerSpecifics: awsImplementation,
}),
diff --git a/packages/lambda-client/src/test/inline-props-size.test.ts b/packages/lambda-client/src/test/inline-props-size.test.ts
new file mode 100644
index 0000000000..75d009c7e3
--- /dev/null
+++ b/packages/lambda-client/src/test/inline-props-size.test.ts
@@ -0,0 +1,40 @@
+import {expect, spyOn, test} from 'bun:test';
+import {awsImplementation} from '../aws-provider';
+import {makeLambdaRenderMediaPayload} from '../make-lambda-payload';
+import {renderMediaOnLambdaOptionalToRequired} from '../render-media-on-lambda';
+
+const makePayload = async (inputProps: Record<string, unknown>) => {
+ const writeFile = spyOn(awsImplementation, 'writeFile').mockImplementation(
+ () => Promise.resolve(),
+ );
+ try {
+ const payload = await makeLambdaRenderMediaPayload(
+ renderMediaOnLambdaOptionalToRequired({
+ region: 'us-east-1',
+ functionName: 'test-function',
+ serveUrl: 'https://example.com',
+ composition: 'test-composition',
+ codec: 'h264',
+ inputProps,
+ forceBucketName: 'remotionlambda-test',
+ }),
+ );
+ return {payload, uploads: writeFile.mock.calls.length};
+ } finally {
+ writeFile.mockRestore();
+ }
+};
+
+test('uploads CJK props that fit by character count but not by bytes', async () => {
+ const {payload, uploads} = await makePayload({text: 'å­—'.repeat(90_000)});
+
+ expect(payload.inputProps.type).toBe('bucket-url');
+ expect(uploads).toBe(1);
+});
+
+test('keeps ASCII props under the inline limit inline', async () => {
+ const {payload, uploads} = await makePayload({text: 'a'.repeat(190_000)});
+
+ expect(payload.inputProps.type).toBe('payload');
+ expect(uploads).toBe(0);
+});
diff --git a/packages/serverless-client/src/get-size-in-bytes.ts b/packages/serverless-client/src/get-size-in-bytes.ts
new file mode 100644
index 0000000000..9d137bdd57
--- /dev/null
+++ b/packages/serverless-client/src/get-size-in-bytes.ts
@@ -0,0 +1,3 @@
+export const getSizeInBytes = (str: string) => {
+ return Buffer.byteLength(str);
+};
diff --git a/packages/serverless-client/src/index.ts b/packages/serverless-client/src/index.ts
index 0ec555fa9e..246b45cf2e 100644
--- a/packages/serverless-client/src/index.ts
+++ b/packages/serverless-client/src/index.ts
@@ -91,6 +91,7 @@ export {
} from './get-or-create-bucket';
export {getOverallProgressFromStorage} from './get-overall-progress-from-storage';
export {getRemotionVersionFromIndexHtml} from './get-remotion-version-from-index-html';
+export {getSizeInBytes} from './get-size-in-bytes';
export {inputPropsKey, resolvedPropsKey} from './input-props-keys';
export {inspectErrors} from './inspect-error';
export {makeBucketName} from './make-bucket-name';
diff --git a/packages/serverless-client/src/test/validate-webhook.test.ts b/packages/serverless-client/src/test/validate-webhook.test.ts
new file mode 100644
index 0000000000..9c2bcf2229
--- /dev/null
+++ b/packages/serverless-client/src/test/validate-webhook.test.ts
@@ -0,0 +1,14 @@
+import {expect, test} from 'bun:test';
+import {validateWebhook} from '../validate-webhook';
+
+test('rejects customData over 1024 bytes even if under 1024 characters', () => {
+ expect(() =>
+ validateWebhook({
+ url: 'https://example.com/webhook',
+ secret: null,
+ customData: {text: 'å­—'.repeat(500)},
+ }),
+ ).toThrow(
+ 'Webhook "customData" must be less than 1024 bytes. Current size: 1511 bytes.',
+ );
+});
diff --git a/packages/serverless-client/src/validate-webhook.ts b/packages/serverless-client/src/validate-webhook.ts
index f400d049d5..d770445883 100644
--- a/packages/serverless-client/src/validate-webhook.ts
+++ b/packages/serverless-client/src/validate-webhook.ts
@@ -1,4 +1,5 @@
import type {WebhookOption} from './constants';
+import {getSizeInBytes} from './get-size-in-bytes';
export const MAX_WEBHOOK_CUSTOM_DATA_SIZE = 1024;
@@ -8,7 +9,7 @@ export const validateWebhook = (webhook?: WebhookOption | null) => {
}
if (webhook.customData) {
- const size = JSON.stringify(webhook.customData).length;
+ const size = getSizeInBytes(JSON.stringify(webhook.customData));
if (size > MAX_WEBHOOK_CUSTOM_DATA_SIZE) {
throw new Error(
`Webhook "customData" must be less than ${MAX_WEBHOOK_CUSTOM_DATA_SIZE} bytes. Current size: ${size} bytes.`,
diff --git a/packages/serverless/src/handlers/launch.ts b/packages/serverless/src/handlers/launch.ts
index 67e04629f3..9a40ecf7a3 100644
--- a/packages/serverless/src/handlers/launch.ts
+++ b/packages/serverless/src/handlers/launch.ts
@@ -28,6 +28,7 @@ import {
rendersPrefix,
getExpectedOutName,
getNeedsToUpload,
+ getSizeInBytes,
MAX_FUNCTIONS_PER_RENDER,
OutputFileAccessDeniedError,
rendererTransportPrefix,
@@ -395,11 +396,11 @@ const innerLaunchHandler = async <Provider extends CloudProvider>({
const needsToUpload = getNeedsToUpload({
type: 'video-or-audio',
sizes: [
- serializedResolved.length,
+ getSizeInBytes(serializedResolved),
params.inputProps.type === 'bucket-url'
- ? params.inputProps.hash.length
- : params.inputProps.payload.length,
- JSON.stringify(params.envVariables).length,
+ ? getSizeInBytes(params.inputProps.hash)
+ : getSizeInBytes(params.inputProps.payload),
+ getSizeInBytes(JSON.stringify(params.envVariables)),
],
providerSpecifics,
});