@remotion/lambda 3.2.27 → 3.2.28

package/dist/cli/commands/render/render.js

@@ -36,10 +36,16 @@ const renderCommand = async (args) => {
         log_1.Log.info(`${constants_1.BINARY_NAME} ${exports.RENDER_COMMAND} <serve-url> <composition-id> [output-location]`);
         (0, quit_1.quit)(1);
     }
-    const outName = (_a = args[2]) !== null && _a !== void 0 ? _a : null;
-    const { chromiumOptions, codec, crf, envVariables, frameRange, imageFormat, inputProps, logLevel, pixelFormat, proResProfile, puppeteerTimeout, quality, scale, everyNthFrame, numberOfGifLoops, muted, overwrite, } = await cli_1.CliInternals.getCliOptions({
+    const outName = args_1.parsedLambdaCli['out-name'];
+    const downloadName = (_a = args[2]) !== null && _a !== void 0 ? _a : null;
+    const { codec, reason } = cli_1.CliInternals.getFinalCodec({
+        downloadName,
+        outName: outName !== null && outName !== void 0 ? outName : null,
+    });
+    const { chromiumOptions, crf, envVariables, frameRange, imageFormat, inputProps, logLevel, pixelFormat, proResProfile, puppeteerTimeout, quality, scale, everyNthFrame, numberOfGifLoops, muted, overwrite, } = await cli_1.CliInternals.getCliOptions({
         type: 'series',
         isLambda: true,
+        codec,
     });
     const functionName = await (0, find_function_name_1.findFunctionName)();
     const region = (0, get_aws_region_1.getAwsRegion)();
@@ -77,9 +83,10 @@ const renderCommand = async (args) => {
         muted,
         overwrite,
     });
-    const totalSteps = outName ? 5 : 4;
+    const totalSteps = downloadName ? 5 : 4;
     const progressBar = cli_1.CliInternals.createOverwriteableCliOutput(cli_1.CliInternals.quietFlagProvided());
-    log_1.Log.info(cli_1.CliInternals.chalk.gray(`Bucket = ${res.bucketName}, renderId = ${res.renderId}, functionName = ${functionName}`));
+    log_1.Log.info(cli_1.CliInternals.chalk.gray(`bucket = ${res.bucketName}, function = ${functionName}`));
+    log_1.Log.info(cli_1.CliInternals.chalk.gray(`renderId = ${res.renderId}, codec = ${codec} (${reason})`));
     log_1.Log.verbose(`CloudWatch logs (if enabled): ${res.cloudWatchLogs}`);
     const status = await (0, get_render_progress_1.getRenderProgress)({
         functionName,
@@ -117,11 +124,11 @@ const renderCommand = async (args) => {
                 downloadInfo: null,
                 retriesInfo: newStatus.retriesInfo,
             }));
-            if (outName) {
+            if (downloadName) {
                 const downloadStart = Date.now();
                 const { outputPath, sizeInBytes } = await (0, download_media_1.downloadMedia)({
                     bucketName: res.bucketName,
-                    outPath: outName,
+                    outPath: downloadName,
                     region: (0, get_aws_region_1.getAwsRegion)(),
                     renderId: res.renderId,
                     onProgress: ({ downloaded, totalSize }) => {

package/dist/cli/commands/still.js

@@ -15,7 +15,7 @@ const quit_1 = require("../helpers/quit");
 const log_1 = require("../log");
 exports.STILL_COMMAND = 'still';
 const stillCommand = async (args) => {
-    var _a, _b, _c, _d;
+    var _a, _b, _c, _d, _e, _f;
     const serveUrl = args[0];
     if (!serveUrl) {
         log_1.Log.error('No serve URL passed.');
@@ -32,22 +32,32 @@ const stillCommand = async (args) => {
         log_1.Log.info(`${constants_1.BINARY_NAME} ${exports.STILL_COMMAND} <serve-url> <composition-id> [output-location]`);
         (0, quit_1.quit)(1);
     }
-    const outName = (_a = args[2]) !== null && _a !== void 0 ? _a : null;
-    const { chromiumOptions, envVariables, imageFormat, inputProps, logLevel, puppeteerTimeout, quality, stillFrame, scale, } = await cli_1.CliInternals.getCliOptions({
+    const downloadName = (_a = args[2]) !== null && _a !== void 0 ? _a : null;
+    const outName = args_1.parsedLambdaCli['out-name'];
+    const { chromiumOptions, envVariables, inputProps, logLevel, puppeteerTimeout, quality, stillFrame, scale, } = await cli_1.CliInternals.getCliOptions({
         type: 'still',
         isLambda: true,
+        codec: 'h264',
     });
     const functionName = await (0, find_function_name_1.findFunctionName)();
     const maxRetries = (_b = args_1.parsedLambdaCli['max-retries']) !== null && _b !== void 0 ? _b : constants_1.DEFAULT_MAX_RETRIES;
     (0, validate_retries_1.validateMaxRetries)(maxRetries);
     const privacy = (_c = args_1.parsedLambdaCli.privacy) !== null && _c !== void 0 ? _c : constants_1.DEFAULT_OUTPUT_PRIVACY;
     (0, validate_privacy_1.validatePrivacy)(privacy);
+    const { format: imageFormat, source: imageFormatReason } = cli_1.CliInternals.determineFinalImageFormat({
+        downloadName,
+        outName: outName !== null && outName !== void 0 ? outName : null,
+        configImageFormat: (_d = cli_1.ConfigInternals.getUserPreferredImageFormat()) !== null && _d !== void 0 ? _d : null,
+        cliFlag: (_e = cli_1.CliInternals.parsedCli['image-format']) !== null && _e !== void 0 ? _e : null,
+        isLambda: true,
+    });
     try {
+        log_1.Log.info(cli_1.CliInternals.chalk.gray(`functionName = ${functionName}, imageFormat = ${imageFormat} (${imageFormatReason})`));
         const res = await (0, render_still_on_lambda_1.renderStillOnLambda)({
             functionName,
             serveUrl,
             inputProps,
-            imageFormat: imageFormat,
+            imageFormat,
             composition,
             privacy,
             region: (0, get_aws_region_1.getAwsRegion)(),
@@ -56,18 +66,18 @@ const stillCommand = async (args) => {
             frame: stillFrame,
             quality,
             logLevel,
-            outName: args_1.parsedLambdaCli['out-name'],
+            outName,
             chromiumOptions,
             timeoutInMilliseconds: puppeteerTimeout,
             scale,
         });
-        log_1.Log.verbose(cli_1.CliInternals.chalk.gray(`Bucket = ${res.bucketName}, renderId = ${res.renderId}, functionName = ${functionName}`));
+        log_1.Log.info(cli_1.CliInternals.chalk.gray(`Bucket = ${res.bucketName}, renderId = ${res.renderId}`));
         log_1.Log.verbose(`CloudWatch logs (if enabled): ${res.cloudWatchLogs}`);
-        if (outName) {
+        if (downloadName) {
             log_1.Log.info('Finished rendering. Downloading...');
             const { outputPath, sizeInBytes } = await (0, download_media_1.downloadMedia)({
                 bucketName: res.bucketName,
-                outPath: outName,
+                outPath: downloadName,
                 region: (0, get_aws_region_1.getAwsRegion)(),
                 renderId: res.renderId,
             });
@@ -80,7 +90,7 @@ const stillCommand = async (args) => {
         }
     }
     catch (err) {
-        const frames = renderer_1.RenderInternals.parseStack(((_d = err.stack) !== null && _d !== void 0 ? _d : '').split('\n'));
+        const frames = renderer_1.RenderInternals.parseStack(((_f = err.stack) !== null && _f !== void 0 ? _f : '').split('\n'));
         const errorWithStackFrame = new renderer_1.RenderInternals.SymbolicateableError({
             message: err.message,
             frame: null,

package/dist/cli/helpers/determine-image-format.d.ts

@@ -0,0 +1,10 @@
+import type { ImageFormat, StillImageFormat } from '@remotion/renderer';
+export declare const getImageFormat: ({ downloadName, outName, configImageFormat, cliFlag, }: {
+    downloadName: string | null;
+    outName: string | null;
+    configImageFormat: ImageFormat | null;
+    cliFlag: ImageFormat | null;
+}) => {
+    format: StillImageFormat;
+    source: string;
+};

package/dist/cli/helpers/determine-image-format.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getImageFormat = void 0;
+const deriveExtensionFromFilename = (filename) => {
+    if (filename === null || filename === void 0 ? void 0 : filename.endsWith('.png')) {
+        return 'png';
+    }
+    if (filename === null || filename === void 0 ? void 0 : filename.endsWith('.jpg')) {
+        return 'jpeg';
+    }
+    if (filename === null || filename === void 0 ? void 0 : filename.endsWith('.jpeg')) {
+        return 'jpeg';
+    }
+    return null;
+};
+const getImageFormat = ({ downloadName, outName, configImageFormat, cliFlag, }) => {
+    const outNameExtension = deriveExtensionFromFilename(outName);
+    const downloadNameExtension = deriveExtensionFromFilename(downloadName);
+    if (outNameExtension &&
+        downloadNameExtension &&
+        outNameExtension !== downloadNameExtension) {
+        throw new TypeError(`Image format mismatch: ${outName} was given as the S3 output name and ${downloadName} was given as the download name, but the extensions don't match.`);
+    }
+    if (downloadNameExtension) {
+        if (cliFlag && downloadNameExtension !== cliFlag) {
+            throw new TypeError(`Image format mismatch: ${downloadName} was given as the download name, but --image-format=${cliFlag} was passed. The image formats must match.`);
+        }
+        return { format: downloadNameExtension, source: 'Download name extension' };
+    }
+    if (outNameExtension) {
+        if (cliFlag && outNameExtension !== cliFlag) {
+            throw new TypeError(`Image format mismatch: ${outName} was given as the S3 out name, but --image-format=${cliFlag} was passed. The image formats must match.`);
+        }
+        return { format: outNameExtension, source: 'Out name extension' };
+    }
+    if (cliFlag === 'none') {
+        throw new TypeError('The --image-format flag must not be "none" for stills.');
+    }
+    if (cliFlag !== null) {
+        return { format: cliFlag, source: '--image-format flag' };
+    }
+    if (configImageFormat !== null && configImageFormat !== 'none') {
+        return { format: configImageFormat, source: 'Config file' };
+    }
+    return { format: 'png', source: 'Default' };
+};
+exports.getImageFormat = getImageFormat;

package/dist/functions/chunk-optimization/plan-frame-ranges.d.ts

@@ -6,6 +6,9 @@ export declare const planFrameRanges: ({ framesPerLambda, optimization, shouldUs
     frameRange: [number, number];
     everyNthFrame: number;
 }) => {
-    chunks: [number, number][];
+    chunks: [
+        number,
+        number
+    ][];
     didUseOptimization: boolean;
 };

package/dist/functions/launch.js

@@ -108,7 +108,7 @@ const innerLaunchHandler = async (params, options) => {
     if (chunkCount > constants_1.MAX_FUNCTIONS_PER_RENDER) {
         throw new Error(`Too many functions: This render would cause ${chunkCount} functions to spawn. We limit this amount to ${constants_1.MAX_FUNCTIONS_PER_RENDER} functions as more would result in diminishing returns. Values set: frameCount = ${frameCount}, framesPerLambda=${framesPerLambda}. See ${docs_url_1.DOCS_URL}/docs/lambda/concurrency for how this parameter is calculated.`);
     }
-    (0, validate_outname_1.validateOutname)(params.outName);
+    (0, validate_outname_1.validateOutname)(params.outName, params.codec);
     (0, validate_privacy_1.validatePrivacy)(params.privacy);
     renderer_1.RenderInternals.validatePuppeteerTimeout(params.timeoutInMilliseconds);
     const { chunks, didUseOptimization } = (0, plan_frame_ranges_1.planFrameRanges)({

package/dist/shared/invoke-webhook.d.ts

@@ -0,0 +1,23 @@
+import http from 'http';
+import https from 'https';
+/**
+ * @description Calculates cryptographically secure signature for webhooks using Hmac.
+ * @link https://remotion.dev/docs/lambda/validate-webhooks
+ * @param payload Stringified request body to encode in the signature.
+ */
+export declare function calculateSignature(payload: string): string;
+export declare type InvokeWebhookInput = {
+    url: string;
+    type: 'success' | 'error' | 'timeout';
+    renderId: string;
+};
+export declare const mockableHttpClients: {
+    http: typeof http.request;
+    https: typeof https.request;
+};
+/**
+ * @description Calls a webhook.
+ * @link https://remotion.dev/docs/lambda/rendermediaonlambda#webhook
+ * @param params.url URL of webhook to call.
+ */
+export declare function invokeWebhook({ url, type, renderId }: InvokeWebhookInput): Promise<void>;

package/dist/shared/invoke-webhook.js

@@ -0,0 +1,88 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.invokeWebhook = exports.mockableHttpClients = exports.calculateSignature = void 0;
+const Crypto = __importStar(require("crypto"));
+const http_1 = __importDefault(require("http"));
+const https_1 = __importDefault(require("https"));
+/**
+ * @description Calculates cryptographically secure signature for webhooks using Hmac.
+ * @link https://remotion.dev/docs/lambda/validate-webhooks
+ * @param payload Stringified request body to encode in the signature.
+ */
+function calculateSignature(payload) {
+    const secret = 'INSECURE_DEFAULT_SECRET';
+    const hmac = Crypto.createHmac('sha1', secret);
+    const signature = 'sha1=' + hmac.update(payload).digest('hex');
+    return signature;
+}
+exports.calculateSignature = calculateSignature;
+const getWebhookClient = (url) => {
+    if (url.startsWith('https://')) {
+        return exports.mockableHttpClients.https;
+    }
+    if (url.startsWith('http://')) {
+        return exports.mockableHttpClients.http;
+    }
+    throw new Error('Can only request URLs starting with http:// or https://');
+};
+exports.mockableHttpClients = {
+    http: http_1.default.request,
+    https: https_1.default.request,
+};
+/**
+ * @description Calls a webhook.
+ * @link https://remotion.dev/docs/lambda/rendermediaonlambda#webhook
+ * @param params.url URL of webhook to call.
+ */
+function invokeWebhook({ url, type, renderId }) {
+    const payload = JSON.stringify({ result: type, renderId });
+    return new Promise((resolve, reject) => {
+        const req = getWebhookClient(url)(url, {
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+                'X-Remotion-Signature': calculateSignature(payload),
+                'X-Remotion-Status': type,
+            },
+            timeout: 5000,
+        }, (res) => {
+            if (res.statusCode && res.statusCode > 299) {
+                reject(new Error(`Sent a webhook but got a status code of ${res.statusCode}`));
+                return;
+            }
+            resolve();
+        });
+        req.write(payload);
+        req.on('error', (err) => {
+            reject(err);
+        });
+        req.end();
+    });
+}
+exports.invokeWebhook = invokeWebhook;

package/dist/shared/validate-outname.d.ts

@@ -1,2 +1,3 @@
+import type { Codec } from '@remotion/renderer';
 import type { OutNameInputWithoutCredentials } from './constants';
-export declare const validateOutname: (outName: OutNameInputWithoutCredentials | undefined | null) => void;
+export declare const validateOutname: (outName: OutNameInputWithoutCredentials | undefined | null, codec?: Codec) => void;

package/dist/shared/validate-outname.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOutname = void 0;
+const renderer_1 = require("@remotion/renderer");
 const validate_bucketname_1 = require("./validate-bucketname");
 const validateS3Key = (s3Key) => {
     if (typeof s3Key !== 'string') {
@@ -12,11 +13,14 @@ const validateS3Key = (s3Key) => {
             '. Check for invalid characters.');
     }
 };
-const validateOutname = (outName) => {
+const validateOutname = (outName, codec) => {
     if (typeof outName === 'undefined' || outName === null) {
         return;
     }
     if (typeof outName === 'string') {
+        if (codec) {
+            (0, renderer_1.validateOutputFilename)(codec, renderer_1.RenderInternals.getExtensionOfFilename(outName !== null && outName !== void 0 ? outName : null));
+        }
         validateS3Key(outName);
         return;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@remotion/lambda",
-	"version": "3.2.27",
+	"version": "3.2.28",
 	"description": "Distributed renderer for Remotion based on AWS Lambda",
 	"main": "dist/index.js",
 	"sideEffects": false,
@@ -9,7 +9,7 @@
 	},
 	"module": "true",
 	"scripts": {
-		"testintegration": "jest src/test/integration --runInBand",
+		"testintegration": "jest src/test/integration --runInBand --forceExit",
 		"lint": "eslint src --ext ts,tsx",
 		"test": "jest src/test/unit",
 		"watch": "tsc -w",
@@ -32,12 +32,12 @@
 		"@aws-sdk/client-service-quotas": "3.58.0",
 		"@aws-sdk/lib-storage": "3.58.0",
 		"@aws-sdk/s3-request-presigner": "3.58.0",
-		"@remotion/bundler": "3.2.27",
-		"@remotion/cli": "3.2.27",
-		"@remotion/renderer": "3.2.27",
+		"@remotion/bundler": "3.2.28",
+		"@remotion/cli": "3.2.28",
+		"@remotion/renderer": "3.2.28",
 		"aws-policies": "^1.0.1",
 		"mime-types": "2.1.34",
-		"remotion": "3.2.27"
+		"remotion": "3.2.28"
 	},
 	"peerDependencies": {
 		"react": ">=16.8.0",
@@ -62,5 +62,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "662c69bcb2fee4d51553b2f8e61635fb4d6688b1"
+	"gitHead": "49bb70afa503bfb0c89ee51d8bf3386ad1b91ac4"
 }