@remotion/cloudrun 4.0.246 → 4.0.248

package/.turbo/turbo-make.log

@@ -1,6 +1,6 @@
 
 
-> @remotion/cloudrun@4.0.245 make /Users/jonathanburger/remotion/packages/cloudrun
+> @remotion/cloudrun@4.0.247 make /Users/jonathanburger/remotion/packages/cloudrun
 > tsc -d && bun build.ts
 
-[6.63ms] Made reproducible build with gtar
+[9.50ms] Made reproducible build with gtar

package/dist/api/render-media-on-cloudrun.d.ts

@@ -1,6 +1,7 @@
 import type { AudioCodec, ChromiumOptions, FrameRange, LogLevel, PixelFormat, ProResProfile, ToOptions, VideoImageFormat } from '@remotion/renderer';
 import type { BrowserSafeApis } from '@remotion/renderer/client';
-import type { CloudRunCrashResponse, DownloadBehavior, RenderMediaOnCloudrunOutput } from '../functions/helpers/payloads';
+import type { z } from 'zod';
+import type { CloudRunCrashResponse, CloudRunPayload, DownloadBehavior, RenderMediaOnCloudrunOutput } from '../functions/helpers/payloads';
 import type { GcpRegion } from '../pricing/gcp-regions';
 import type { CloudrunCodec } from '../shared/validate-gcp-codec';
 type InternalRenderMediaOnCloudrun = {
@@ -32,6 +33,8 @@ type InternalRenderMediaOnCloudrun = {
     logLevel: LogLevel;
     downloadBehavior: DownloadBehavior;
     metadata?: Record<string, string> | null;
+    renderIdOverride: z.infer<typeof CloudRunPayload>['renderIdOverride'];
+    renderStatusWebhook: z.infer<typeof CloudRunPayload>['renderStatusWebhook'];
 } & Partial<ToOptions<typeof BrowserSafeApis.optionsMap.renderMediaOnCloudRun>>;
 export type RenderMediaOnCloudrunInput = {
     cloudRunUrl?: string;
@@ -44,6 +47,7 @@ export type RenderMediaOnCloudrunInput = {
     forceBucketName?: string;
     outName?: string;
     updateRenderProgress?: (progress: number, error?: boolean) => void;
+    renderId: string | undefined;
     codec: CloudrunCodec;
     audioCodec?: AudioCodec;
     encodingMaxRate?: string | null;
@@ -61,8 +65,10 @@ export type RenderMediaOnCloudrunInput = {
     preferLossless?: boolean;
     downloadBehavior?: DownloadBehavior;
     metadata?: Record<string, string> | null;
+    renderIdOverride?: z.infer<typeof CloudRunPayload>['renderIdOverride'];
+    renderStatusWebhook?: z.infer<typeof CloudRunPayload>['renderStatusWebhook'];
 } & Partial<ToOptions<typeof BrowserSafeApis.optionsMap.renderMediaOnCloudRun>>;
-declare const internalRenderMediaOnCloudrunRaw: ({ cloudRunUrl, serviceName, region, serveUrl, composition, inputProps, codec, forceBucketName, privacy, outName, updateRenderProgress, jpegQuality, audioCodec, audioBitrate, videoBitrate, encodingMaxRate, encodingBufferSize, proResProfile, x264Preset, crf, pixelFormat, imageFormat, scale, everyNthFrame, numberOfGifLoops, frameRange, envVariables, chromiumOptions, muted, forceWidth, forceHeight, logLevel, delayRenderTimeoutInMilliseconds, concurrency, enforceAudioTrack, preferLossless, offthreadVideoCacheSizeInBytes, colorSpace, downloadBehavior, metadata, }: InternalRenderMediaOnCloudrun) => Promise<RenderMediaOnCloudrunOutput | CloudRunCrashResponse>;
+declare const internalRenderMediaOnCloudrunRaw: ({ cloudRunUrl, serviceName, region, serveUrl, composition, inputProps, codec, forceBucketName, privacy, outName, updateRenderProgress, renderIdOverride, renderStatusWebhook, jpegQuality, audioCodec, audioBitrate, videoBitrate, encodingMaxRate, encodingBufferSize, proResProfile, x264Preset, crf, pixelFormat, imageFormat, scale, everyNthFrame, numberOfGifLoops, frameRange, envVariables, chromiumOptions, muted, forceWidth, forceHeight, logLevel, delayRenderTimeoutInMilliseconds, concurrency, enforceAudioTrack, preferLossless, offthreadVideoCacheSizeInBytes, colorSpace, downloadBehavior, metadata, }: InternalRenderMediaOnCloudrun) => Promise<RenderMediaOnCloudrunOutput | CloudRunCrashResponse>;
 export declare const internalRenderMediaOnCloudrun: typeof internalRenderMediaOnCloudrunRaw;
-export declare const renderMediaOnCloudrun: ({ cloudRunUrl, serviceName, region, serveUrl, composition, inputProps, codec, forceBucketName, privacy, outName, updateRenderProgress, jpegQuality, audioCodec, audioBitrate, videoBitrate, encodingMaxRate, encodingBufferSize, proResProfile, x264Preset, crf, pixelFormat, imageFormat, scale, everyNthFrame, numberOfGifLoops, frameRange, envVariables, chromiumOptions, muted, forceWidth, forceHeight, logLevel, delayRenderTimeoutInMilliseconds, concurrency, enforceAudioTrack, preferLossless, offthreadVideoCacheSizeInBytes, colorSpace, downloadBehavior, metadata, }: RenderMediaOnCloudrunInput) => Promise<RenderMediaOnCloudrunOutput | CloudRunCrashResponse>;
+export declare const renderMediaOnCloudrun: ({ cloudRunUrl, serviceName, region, serveUrl, composition, inputProps, codec, forceBucketName, privacy, outName, updateRenderProgress, jpegQuality, audioCodec, audioBitrate, videoBitrate, encodingMaxRate, encodingBufferSize, proResProfile, x264Preset, crf, pixelFormat, imageFormat, scale, everyNthFrame, numberOfGifLoops, frameRange, envVariables, chromiumOptions, muted, forceWidth, forceHeight, logLevel, delayRenderTimeoutInMilliseconds, concurrency, enforceAudioTrack, preferLossless, offthreadVideoCacheSizeInBytes, colorSpace, downloadBehavior, metadata, renderIdOverride, renderStatusWebhook, }: RenderMediaOnCloudrunInput) => Promise<RenderMediaOnCloudrunOutput | CloudRunCrashResponse>;
 export {};

package/dist/api/render-media-on-cloudrun.js

@@ -10,7 +10,7 @@ const validate_serveurl_1 = require("../shared/validate-serveurl");
 const get_or_create_bucket_1 = require("./get-or-create-bucket");
 const get_auth_client_for_url_1 = require("./helpers/get-auth-client-for-url");
 const get_cloudrun_endpoint_1 = require("./helpers/get-cloudrun-endpoint");
-const internalRenderMediaOnCloudrunRaw = async ({ cloudRunUrl, serviceName, region, serveUrl, composition, inputProps, codec, forceBucketName, privacy, outName, updateRenderProgress, jpegQuality, audioCodec, audioBitrate, videoBitrate, encodingMaxRate, encodingBufferSize, proResProfile, x264Preset, crf, pixelFormat, imageFormat, scale, everyNthFrame, numberOfGifLoops, frameRange, envVariables, chromiumOptions, muted, forceWidth, forceHeight, logLevel, delayRenderTimeoutInMilliseconds, concurrency, enforceAudioTrack, preferLossless, offthreadVideoCacheSizeInBytes, colorSpace, downloadBehavior, metadata, }) => {
+const internalRenderMediaOnCloudrunRaw = async ({ cloudRunUrl, serviceName, region, serveUrl, composition, inputProps, codec, forceBucketName, privacy, outName, updateRenderProgress, renderIdOverride, renderStatusWebhook, jpegQuality, audioCodec, audioBitrate, videoBitrate, encodingMaxRate, encodingBufferSize, proResProfile, x264Preset, crf, pixelFormat, imageFormat, scale, everyNthFrame, numberOfGifLoops, frameRange, envVariables, chromiumOptions, muted, forceWidth, forceHeight, logLevel, delayRenderTimeoutInMilliseconds, concurrency, enforceAudioTrack, preferLossless, offthreadVideoCacheSizeInBytes, colorSpace, downloadBehavior, metadata, }) => {
     const actualCodec = (0, validate_gcp_codec_1.validateCloudrunCodec)(codec);
     (0, validate_serveurl_1.validateServeUrl)(serveUrl);
     if (privacy)
@@ -64,6 +64,8 @@ const internalRenderMediaOnCloudrunRaw = async ({ cloudRunUrl, serviceName, regi
         clientVersion: version_1.VERSION,
         downloadBehavior,
         metadata: metadata !== null && metadata !== void 0 ? metadata : null,
+        renderIdOverride,
+        renderStatusWebhook,
     };
     const client = await (0, get_auth_client_for_url_1.getAuthClientForUrl)(cloudRunEndpoint);
     const postResponse = await client.request({
@@ -133,7 +135,7 @@ exports.internalRenderMediaOnCloudrun = (0, error_handling_1.wrapWithErrorHandli
  * @description Initiates a media rendering process on the Remotion Cloud Run service, facilitating configurations like service region, project composition, and output settings.
  * @see [Documentation](https://remotion.dev/docs/cloudrun/rendermediaoncloudrun)
  */
-const renderMediaOnCloudrun = ({ cloudRunUrl, serviceName, region, serveUrl, composition, inputProps, codec, forceBucketName, privacy, outName, updateRenderProgress, jpegQuality, audioCodec, audioBitrate, videoBitrate, encodingMaxRate, encodingBufferSize, proResProfile, x264Preset, crf, pixelFormat, imageFormat, scale, everyNthFrame, numberOfGifLoops, frameRange, envVariables, chromiumOptions, muted, forceWidth, forceHeight, logLevel, delayRenderTimeoutInMilliseconds, concurrency, enforceAudioTrack, preferLossless, offthreadVideoCacheSizeInBytes, colorSpace, downloadBehavior, metadata, }) => {
+const renderMediaOnCloudrun = ({ cloudRunUrl, serviceName, region, serveUrl, composition, inputProps, codec, forceBucketName, privacy, outName, updateRenderProgress, jpegQuality, audioCodec, audioBitrate, videoBitrate, encodingMaxRate, encodingBufferSize, proResProfile, x264Preset, crf, pixelFormat, imageFormat, scale, everyNthFrame, numberOfGifLoops, frameRange, envVariables, chromiumOptions, muted, forceWidth, forceHeight, logLevel, delayRenderTimeoutInMilliseconds, concurrency, enforceAudioTrack, preferLossless, offthreadVideoCacheSizeInBytes, colorSpace, downloadBehavior, metadata, renderIdOverride, renderStatusWebhook, }) => {
     return (0, exports.internalRenderMediaOnCloudrun)({
         cloudRunUrl: cloudRunUrl !== null && cloudRunUrl !== void 0 ? cloudRunUrl : undefined,
         serviceName: serviceName !== null && serviceName !== void 0 ? serviceName : undefined,
@@ -178,6 +180,8 @@ const renderMediaOnCloudrun = ({ cloudRunUrl, serviceName, region, serveUrl, com
             type: 'play-in-browser',
         },
         metadata: metadata !== null && metadata !== void 0 ? metadata : null,
+        renderIdOverride: renderIdOverride !== null && renderIdOverride !== void 0 ? renderIdOverride : undefined,
+        renderStatusWebhook: renderStatusWebhook !== null && renderStatusWebhook !== void 0 ? renderStatusWebhook : undefined,
     });
 };
 exports.renderMediaOnCloudrun = renderMediaOnCloudrun;

package/dist/api/render-still-on-cloudrun.d.ts

@@ -1,6 +1,7 @@
 import type { ChromiumOptions, StillImageFormat, ToOptions } from '@remotion/renderer';
 import { BrowserSafeApis } from '@remotion/renderer/client';
-import type { DownloadBehavior } from '../functions/helpers/payloads';
+import type { z } from 'zod';
+import type { CloudRunPayload, DownloadBehavior } from '../functions/helpers/payloads';
 import type { GcpRegion } from '../pricing/gcp-regions';
 type MandatoryParameters = {
     region: GcpRegion;
@@ -22,6 +23,8 @@ type OptionalParameters = {
     forceHeight: number | null;
     indent: boolean;
     downloadBehavior: DownloadBehavior;
+    renderIdOverride: z.infer<typeof CloudRunPayload>['renderIdOverride'];
+    renderStatusWebhook: z.infer<typeof CloudRunPayload>['renderStatusWebhook'];
 } & ToOptions<typeof BrowserSafeApis.optionsMap.renderStillOnCloudRun>;
 export type RenderStillOnCloudrunInput = Partial<OptionalParameters> & MandatoryParameters;
 export declare const renderStillOnCloudrun: (options: RenderStillOnCloudrunInput) => Promise<{

package/dist/api/render-still-on-cloudrun.js

@@ -35,7 +35,7 @@ const get_cloudrun_endpoint_1 = require("./helpers/get-cloudrun-endpoint");
  * @param params.metadata Metadata to be attached to the output file.
  * @returns {Promise<RenderStillOnCloudrunOutput>} See documentation for detailed structure
  */
-const internalRenderStillOnCloudRun = async ({ cloudRunUrl, serviceName, region, serveUrl, composition, inputProps, forceBucketName, privacy, outName, imageFormat, envVariables, frame, jpegQuality, chromiumOptions, scale, forceWidth, forceHeight, logLevel, delayRenderTimeoutInMilliseconds, offthreadVideoCacheSizeInBytes, downloadBehavior, }) => {
+const internalRenderStillOnCloudRun = async ({ cloudRunUrl, serviceName, region, serveUrl, composition, inputProps, forceBucketName, privacy, outName, imageFormat, envVariables, frame, jpegQuality, chromiumOptions, scale, forceWidth, forceHeight, logLevel, delayRenderTimeoutInMilliseconds, offthreadVideoCacheSizeInBytes, downloadBehavior, renderIdOverride, renderStatusWebhook, }) => {
     (0, validate_serveurl_1.validateServeUrl)(serveUrl);
     if (privacy)
         (0, validate_privacy_1.validatePrivacy)(privacy);
@@ -70,6 +70,8 @@ const internalRenderStillOnCloudRun = async ({ cloudRunUrl, serviceName, region,
         offthreadVideoCacheSizeInBytes,
         clientVersion: version_1.VERSION,
         downloadBehavior,
+        renderIdOverride,
+        renderStatusWebhook,
     };
     const client = await (0, get_auth_client_for_url_1.getAuthClientForUrl)(cloudRunEndpoint);
     const postResponse = await client.request({
@@ -129,7 +131,7 @@ const internalRenderStillOnCloudRun = async ({ cloudRunUrl, serviceName, region,
 };
 const errorHandled = (0, error_handling_1.wrapWithErrorHandling)(internalRenderStillOnCloudRun);
 const renderStillOnCloudrun = (options) => {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v;
     return errorHandled({
         chromiumOptions: (_a = options.chromiumOptions) !== null && _a !== void 0 ? _a : {},
         cloudRunUrl: (_b = options.cloudRunUrl) !== null && _b !== void 0 ? _b : null,
@@ -153,6 +155,8 @@ const renderStillOnCloudrun = (options) => {
         serveUrl: options.serveUrl,
         serviceName: (_s = options.serviceName) !== null && _s !== void 0 ? _s : null,
         downloadBehavior: (_t = options.downloadBehavior) !== null && _t !== void 0 ? _t : { type: 'play-in-browser' },
+        renderIdOverride: (_u = options.renderIdOverride) !== null && _u !== void 0 ? _u : undefined,
+        renderStatusWebhook: (_v = options.renderStatusWebhook) !== null && _v !== void 0 ? _v : undefined,
     });
 };
 exports.renderStillOnCloudrun = renderStillOnCloudrun;

package/dist/api/test/payloads.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/api/test/payloads.test.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const bun_test_1 = require("bun:test");
+const payloads_1 = require("../../functions/helpers/payloads");
+(0, bun_test_1.test)('CloudRunPayload should work with and without optional webhook fields', () => {
+    const basePayload = {
+        type: 'still',
+        serveUrl: 'https://example.com',
+        composition: 'my-comp',
+        imageFormat: 'png',
+        scale: 1,
+        privacy: 'public',
+        envVariables: {},
+        outputBucket: 'my-bucket',
+        frame: 0,
+        delayRenderTimeoutInMilliseconds: 30000,
+        logLevel: 'info',
+        clientVersion: '1.0.0',
+        downloadBehavior: { type: 'play-in-browser' },
+        outName: null,
+        offthreadVideoCacheSizeInBytes: null,
+        serializedInputPropsWithCustomSchema: JSON.stringify({}),
+    };
+    const withWebhook = {
+        ...basePayload,
+        renderIdOverride: 'custom-render-id',
+        renderStatusWebhook: {
+            url: 'https://webhook.example.com',
+            headers: { 'x-custom-header': 'value' },
+            data: { key: 'value' },
+        },
+    };
+    const withoutWebhook = basePayload;
+    const parsedWithWebhook = payloads_1.CloudRunPayload.safeParse(withWebhook);
+    const parsedWithoutWebhook = payloads_1.CloudRunPayload.safeParse(withoutWebhook);
+    (0, bun_test_1.expect)(parsedWithWebhook.success).toBe(true);
+    (0, bun_test_1.expect)(parsedWithoutWebhook.success).toBe(true);
+    if (parsedWithWebhook.success) {
+        (0, bun_test_1.expect)(parsedWithWebhook.data.renderIdOverride).toBe('custom-render-id');
+        (0, bun_test_1.expect)(parsedWithWebhook.data.renderStatusWebhook).toEqual({
+            url: 'https://webhook.example.com',
+            headers: { 'x-custom-header': 'value' },
+            data: { key: 'value' },
+        });
+    }
+    if (parsedWithoutWebhook.success) {
+        (0, bun_test_1.expect)(parsedWithoutWebhook.data.renderIdOverride).toBeUndefined();
+        (0, bun_test_1.expect)(parsedWithoutWebhook.data.renderStatusWebhook).toBeUndefined();
+    }
+});

package/dist/cli/args.d.ts

@@ -13,6 +13,8 @@ type servicesCommandLineOptions = {
     ['out-name']: string | undefined;
     ['output-bucket']: string;
     ['output-folder-path']: string;
+    webhook: string;
+    ['render-id-override']: string;
 };
 export declare const parsedCloudrunCli: servicesCommandLineOptions & import("minimist").ParsedArgs;
 export declare const forceFlagProvided: boolean;

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

@@ -16,7 +16,7 @@ const renderArgsCheck_1 = require("./helpers/renderArgsCheck");
 exports.RENDER_COMMAND = 'render';
 const { audioBitrateOption, x264Option, offthreadVideoCacheSizeInBytesOption, scaleOption, crfOption, jpegQualityOption, videoBitrateOption, enforceAudioOption, mutedOption, colorSpaceOption, numberOfGifLoopsOption, enableMultiprocessOnLinuxOption, glOption, headlessOption, encodingMaxRateOption, encodingBufferSizeOption, delayRenderTimeoutInMillisecondsOption, binariesDirectoryOption, metadataOption, } = client_1.BrowserSafeApis.options;
 const renderCommand = async (args, remotionRoot, logLevel) => {
-    var _a, _b;
+    var _a, _b, _c;
     const { serveUrl, cloudRunUrl, outName, forceBucketName, downloadName, privacy, region, } = await (0, renderArgsCheck_1.renderArgsCheck)(exports.RENDER_COMMAND, args, logLevel);
     const { value: codec, source: codecReason } = client_1.BrowserSafeApis.options.videoCodecOption.getValue({
         commandLine: cli_1.CliInternals.parsedCli,
@@ -104,6 +104,7 @@ const renderCommand = async (args, remotionRoot, logLevel) => {
                 logLevel,
                 quiet: cli_1.CliInternals.quietFlagProvided(),
             }),
+            chromeMode: 'headless-shell',
         });
         composition = compositionId;
     }
@@ -236,6 +237,15 @@ ${downloadName ? `		Downloaded File = ${downloadName}` : ''}
         indent: false,
         downloadBehavior: { type: 'play-in-browser' },
         metadata,
+        renderIdOverride: (_c = args_1.parsedCloudrunCli['render-id-override']) !== null && _c !== void 0 ? _c : null,
+        renderStatusWebhook: args_1.parsedCloudrunCli.webhook
+            ? {
+                url: args_1.parsedCloudrunCli.webhook,
+                headers: {},
+                data: null,
+                webhookProgressInterval: null,
+            }
+            : null,
     });
     if (res.type === 'crash') {
         (0, cloudrun_crash_logs_1.displayCrashLogs)(res, logLevel);

package/dist/cli/commands/still.js

@@ -92,6 +92,7 @@ const stillCommand = async (args, remotionRoot, logLevel) => {
                 logLevel,
                 quiet: cli_1.CliInternals.quietFlagProvided(),
             }),
+            chromeMode: 'headless-shell',
         });
         composition = compositionId;
     }

package/dist/functions/helpers/get-composition-from-body.js

@@ -27,6 +27,7 @@ const getCompositionFromBody = async (body) => {
             throw new Error('Should not download a browser in Cloud Run');
         },
         onServeUrlVisited: () => undefined,
+        chromeMode: 'headless-shell',
     });
     if (propsSize > 10000000) {
         renderer_1.RenderInternals.Log.warn({ indent: false, logLevel: body.logLevel }, `The props of your composition are large (${propsSize} bytes). This may cause slowdown.`);

package/dist/functions/helpers/payloads.d.ts

@@ -88,6 +88,23 @@ export declare const CloudRunPayload: z.ZodDiscriminatedUnion<"type", [z.ZodObje
         fileName: string | null;
     }>]>;
     metadata: z.ZodNullable<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
+    renderIdOverride: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    renderStatusWebhook: z.ZodNullable<z.ZodOptional<z.ZodObject<{
+        url: z.ZodString;
+        headers: z.ZodRecord<z.ZodString, z.ZodString>;
+        data: z.ZodAny;
+        webhookProgressInterval: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        headers: Record<string, string>;
+        data?: any;
+        webhookProgressInterval?: number | null | undefined;
+    }, {
+        url: string;
+        headers: Record<string, string>;
+        data?: any;
+        webhookProgressInterval?: number | null | undefined;
+    }>>>;
 }, "strip", z.ZodTypeAny, {
     type: "media";
     serveUrl: string;
@@ -138,6 +155,13 @@ export declare const CloudRunPayload: z.ZodDiscriminatedUnion<"type", [z.ZodObje
     outName?: string | undefined;
     privacy?: "public" | "private" | undefined;
     metadata?: Record<string, string> | null | undefined;
+    renderIdOverride?: string | null | undefined;
+    renderStatusWebhook?: {
+        url: string;
+        headers: Record<string, string>;
+        data?: any;
+        webhookProgressInterval?: number | null | undefined;
+    } | null | undefined;
 }, {
     type: "media";
     serveUrl: string;
@@ -188,6 +212,13 @@ export declare const CloudRunPayload: z.ZodDiscriminatedUnion<"type", [z.ZodObje
     outName?: string | undefined;
     privacy?: "public" | "private" | undefined;
     metadata?: Record<string, string> | null | undefined;
+    renderIdOverride?: string | null | undefined;
+    renderStatusWebhook?: {
+        url: string;
+        headers: Record<string, string>;
+        data?: any;
+        webhookProgressInterval?: number | null | undefined;
+    } | null | undefined;
 }>, z.ZodObject<{
     type: z.ZodLiteral<"still">;
     serveUrl: z.ZodString;
@@ -243,6 +274,23 @@ export declare const CloudRunPayload: z.ZodDiscriminatedUnion<"type", [z.ZodObje
         fileName: string | null;
     }>]>;
     metadata: z.ZodNullable<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>>;
+    renderIdOverride: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    renderStatusWebhook: z.ZodNullable<z.ZodOptional<z.ZodObject<{
+        url: z.ZodString;
+        headers: z.ZodRecord<z.ZodString, z.ZodString>;
+        data: z.ZodAny;
+        webhookProgressInterval: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        headers: Record<string, string>;
+        data?: any;
+        webhookProgressInterval?: number | null | undefined;
+    }, {
+        url: string;
+        headers: Record<string, string>;
+        data?: any;
+        webhookProgressInterval?: number | null | undefined;
+    }>>>;
 }, "strip", z.ZodTypeAny, {
     type: "still";
     serveUrl: string;
@@ -276,6 +324,13 @@ export declare const CloudRunPayload: z.ZodDiscriminatedUnion<"type", [z.ZodObje
         userAgent?: string | null | undefined;
     } | undefined;
     metadata?: Record<string, string> | null | undefined;
+    renderIdOverride?: string | null | undefined;
+    renderStatusWebhook?: {
+        url: string;
+        headers: Record<string, string>;
+        data?: any;
+        webhookProgressInterval?: number | null | undefined;
+    } | null | undefined;
 }, {
     type: "still";
     serveUrl: string;
@@ -309,6 +364,13 @@ export declare const CloudRunPayload: z.ZodDiscriminatedUnion<"type", [z.ZodObje
         userAgent?: string | null | undefined;
     } | undefined;
     metadata?: Record<string, string> | null | undefined;
+    renderIdOverride?: string | null | undefined;
+    renderStatusWebhook?: {
+        url: string;
+        headers: Record<string, string>;
+        data?: any;
+        webhookProgressInterval?: number | null | undefined;
+    } | null | undefined;
 }>]>;
 declare const renderFailResponsePayload: z.ZodObject<{
     type: z.ZodLiteral<"error">;

package/dist/functions/helpers/payloads.js

@@ -67,6 +67,16 @@ exports.CloudRunPayload = zod_1.z.discriminatedUnion('type', [
         clientVersion: zod_1.z.string(),
         downloadBehavior,
         metadata: zod_1.z.record(zod_1.z.string()).optional().nullable(),
+        renderIdOverride: zod_1.z.string().optional().nullable(),
+        renderStatusWebhook: zod_1.z
+            .object({
+            url: zod_1.z.string(),
+            headers: zod_1.z.record(zod_1.z.string()),
+            data: zod_1.z.any(),
+            webhookProgressInterval: zod_1.z.number().min(0).max(1).optional().nullable(),
+        })
+            .optional()
+            .nullable(),
     }),
     zod_1.z.object({
         type: zod_1.z.literal('still'),
@@ -90,6 +100,16 @@ exports.CloudRunPayload = zod_1.z.discriminatedUnion('type', [
         clientVersion: zod_1.z.string(),
         downloadBehavior,
         metadata: zod_1.z.record(zod_1.z.string()).optional().nullable(),
+        renderIdOverride: zod_1.z.string().optional().nullable(),
+        renderStatusWebhook: zod_1.z
+            .object({
+            url: zod_1.z.string(),
+            headers: zod_1.z.record(zod_1.z.string()),
+            data: zod_1.z.any(),
+            webhookProgressInterval: zod_1.z.number().min(0).max(1).optional().nullable(),
+        })
+            .optional()
+            .nullable(),
     }),
 ]);
 // eslint-disable-next-line @typescript-eslint/no-unused-vars

package/dist/functions/render-media-single-thread.js

@@ -10,7 +10,7 @@ const get_composition_from_body_1 = require("./helpers/get-composition-from-body
 const get_download_behavior_setting_1 = require("./helpers/get-download-behavior-setting");
 const write_cloudrun_error_1 = require("./helpers/write-cloudrun-error");
 const renderMediaSingleThread = async (body, res) => {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
     if (body.type !== 'media') {
         throw new Error('expected type media');
     }
@@ -20,14 +20,16 @@ const renderMediaSingleThread = async (body, res) => {
         }
         throw new Error(`Version mismatch: When calling renderMediaOnCloudRun(), you called a service, which has the version ${version_1.VERSION}, but the @remotion/cloudrun package you used to invoke the function has version ${version_1.VERSION}. Deploy a new service and use it to call renderMediaOnCloudrun().`);
     }
-    const renderId = (0, random_hash_1.randomHash)({ randomInTests: true });
+    const renderId = (_a = body.renderIdOverride) !== null && _a !== void 0 ? _a : (0, random_hash_1.randomHash)({ randomInTests: true });
     try {
         const composition = await (0, get_composition_from_body_1.getCompositionFromBody)(body);
         const defaultOutName = `out.${renderer_1.RenderInternals.getFileExtensionFromCodec(body.codec, body.audioCodec)}`;
         const tempFilePath = `/tmp/${defaultOutName}`;
         let previousProgress = 0.02;
+        let lastWebhookProgress = 0;
         let writingProgress = Promise.resolve();
         const onProgress = ({ progress, renderedFrames, encodedFrames, }) => {
+            var _a;
             if (previousProgress !== progress) {
                 renderer_1.RenderInternals.Log.info({ indent: false, logLevel: body.logLevel }, 'Render progress:', renderedFrames, 'frames rendered', encodedFrames, 'frames encoded', Math.round(progress * 100), '%');
                 writingProgress = writingProgress.then(() => {
@@ -37,6 +39,31 @@ const renderMediaSingleThread = async (body, res) => {
                         });
                     });
                 });
+                if (body.renderStatusWebhook) {
+                    const interval = (_a = body.renderStatusWebhook.webhookProgressInterval) !== null && _a !== void 0 ? _a : 0.1; // Default 10% intervals
+                    const shouldCallWebhook = progress === 1 || // Always call on completion
+                        lastWebhookProgress === 0 || // Always call first time
+                        progress - lastWebhookProgress >= interval; // Call if interval exceeded
+                    if (shouldCallWebhook) {
+                        fetch(body.renderStatusWebhook.url, {
+                            method: 'POST',
+                            headers: {
+                                ...body.renderStatusWebhook.headers,
+                                'Content-Type': 'application/json',
+                            },
+                            body: JSON.stringify({
+                                ...body.renderStatusWebhook.data,
+                                progress,
+                                renderId,
+                                renderedFrames,
+                                encodedFrames,
+                            }),
+                        }).catch((err) => {
+                            renderer_1.RenderInternals.Log.warn({ indent: false, logLevel: body.logLevel }, 'Failed to call webhook:', err);
+                        });
+                        lastWebhookProgress = progress;
+                    }
+                }
                 previousProgress = progress;
             }
         };
@@ -44,7 +71,7 @@ const renderMediaSingleThread = async (body, res) => {
         const actualChromiumOptions = {
             ...body.chromiumOptions,
             // Override the `null` value, which might come from CLI with swANGLE
-            gl: (_b = (_a = body.chromiumOptions) === null || _a === void 0 ? void 0 : _a.gl) !== null && _b !== void 0 ? _b : 'swangle',
+            gl: (_c = (_b = body.chromiumOptions) === null || _b === void 0 ? void 0 : _b.gl) !== null && _c !== void 0 ? _c : 'swangle',
             enableMultiProcessOnLinux: true,
         };
         const onArtifact = () => {
@@ -53,8 +80,8 @@ const renderMediaSingleThread = async (body, res) => {
         await renderer_1.RenderInternals.internalRenderMedia({
             composition: {
                 ...composition,
-                height: (_c = body.forceHeight) !== null && _c !== void 0 ? _c : composition.height,
-                width: (_d = body.forceWidth) !== null && _d !== void 0 ? _d : composition.width,
+                height: (_d = body.forceHeight) !== null && _d !== void 0 ? _d : composition.height,
+                width: (_e = body.forceWidth) !== null && _e !== void 0 ? _e : composition.width,
             },
             serveUrl: body.serveUrl,
             codec: body.codec,
@@ -65,17 +92,17 @@ const renderMediaSingleThread = async (body, res) => {
                 indent: undefined,
                 staticBase: null,
             }).serializedString,
-            jpegQuality: (_e = body.jpegQuality) !== null && _e !== void 0 ? _e : renderer_1.RenderInternals.DEFAULT_JPEG_QUALITY,
+            jpegQuality: (_f = body.jpegQuality) !== null && _f !== void 0 ? _f : renderer_1.RenderInternals.DEFAULT_JPEG_QUALITY,
             audioCodec: body.audioCodec,
-            audioBitrate: (_f = body.audioBitrate) !== null && _f !== void 0 ? _f : null,
+            audioBitrate: (_g = body.audioBitrate) !== null && _g !== void 0 ? _g : null,
             videoBitrate: body.videoBitrate,
             encodingMaxRate: body.encodingMaxRate,
             encodingBufferSize: body.encodingBufferSize,
             crf: body.crf,
-            pixelFormat: (_g = body.pixelFormat) !== null && _g !== void 0 ? _g : renderer_1.RenderInternals.DEFAULT_PIXEL_FORMAT,
-            imageFormat: (_h = body.imageFormat) !== null && _h !== void 0 ? _h : renderer_1.RenderInternals.DEFAULT_VIDEO_IMAGE_FORMAT,
+            pixelFormat: (_h = body.pixelFormat) !== null && _h !== void 0 ? _h : renderer_1.RenderInternals.DEFAULT_PIXEL_FORMAT,
+            imageFormat: (_j = body.imageFormat) !== null && _j !== void 0 ? _j : renderer_1.RenderInternals.DEFAULT_VIDEO_IMAGE_FORMAT,
             scale: body.scale,
-            proResProfile: (_j = body.proResProfile) !== null && _j !== void 0 ? _j : undefined,
+            proResProfile: (_k = body.proResProfile) !== null && _k !== void 0 ? _k : undefined,
             x264Preset: body.x264Preset,
             everyNthFrame: body.everyNthFrame,
             numberOfGifLoops: body.numberOfGifLoops,
@@ -86,9 +113,9 @@ const renderMediaSingleThread = async (body, res) => {
             muted: body.muted,
             logLevel: body.logLevel,
             browserExecutable: null,
-            timeoutInMilliseconds: (_k = body.delayRenderTimeoutInMilliseconds) !== null && _k !== void 0 ? _k : renderer_1.RenderInternals.DEFAULT_TIMEOUT,
+            timeoutInMilliseconds: (_l = body.delayRenderTimeoutInMilliseconds) !== null && _l !== void 0 ? _l : renderer_1.RenderInternals.DEFAULT_TIMEOUT,
             cancelSignal: undefined,
-            concurrency: (_l = body.concurrency) !== null && _l !== void 0 ? _l : null,
+            concurrency: (_m = body.concurrency) !== null && _m !== void 0 ? _m : null,
             disallowParallelEncoding: false,
             enforceAudioTrack: body.enforceAudioTrack,
             ffmpegOverride: undefined,
@@ -113,15 +140,16 @@ const renderMediaSingleThread = async (body, res) => {
                 throw new Error('Should not download a browser in Cloud Run');
             },
             onArtifact,
-            metadata: (_m = body.metadata) !== null && _m !== void 0 ? _m : null,
+            metadata: (_o = body.metadata) !== null && _o !== void 0 ? _o : null,
             hardwareAcceleration: 'disable',
+            chromeMode: 'headless-shell',
         });
         const storage = new storage_1.Storage();
         const publicUpload = body.privacy === 'public' || !body.privacy;
         const uploadedResponse = await storage
             .bucket(body.outputBucket)
             .upload(tempFilePath, {
-            destination: `renders/${renderId}/${(_o = body.outName) !== null && _o !== void 0 ? _o : defaultOutName}`,
+            destination: `renders/${renderId}/${(_p = body.outName) !== null && _p !== void 0 ? _p : defaultOutName}`,
             predefinedAcl: publicUpload ? 'publicRead' : 'projectPrivate',
             metadata: (0, get_download_behavior_setting_1.getDownloadBehaviorSetting)(body.downloadBehavior),
         });

package/dist/functions/render-still-single-thread.js

@@ -11,7 +11,7 @@ const get_composition_from_body_1 = require("./helpers/get-composition-from-body
 const get_download_behavior_setting_1 = require("./helpers/get-download-behavior-setting");
 const write_cloudrun_error_1 = require("./helpers/write-cloudrun-error");
 const renderStillSingleThread = async (body, res) => {
-    var _a, _b, _c, _d, _e, _f;
+    var _a, _b, _c, _d, _e, _f, _g;
     if (body.type !== 'still') {
         throw new Error('expected type still');
     }
@@ -21,7 +21,7 @@ const renderStillSingleThread = async (body, res) => {
         }
         throw new Error(`Version mismatch: When calling renderMediaOnCloudRun(), you called a service, which has the version ${version_1.VERSION}, but the @remotion/cloudrun package you used to invoke the function has version ${version_1.VERSION}. Deploy a new service and use it to call renderMediaOnCloudrun().`);
     }
-    const renderId = (0, random_hash_1.randomHash)({ randomInTests: true });
+    const renderId = (_a = body.renderIdOverride) !== null && _a !== void 0 ? _a : (0, random_hash_1.randomHash)({ randomInTests: true });
     try {
         log_1.Log.verbose({ indent: false, logLevel: body.logLevel }, 'Rendering still frame', body);
         const composition = await (0, get_composition_from_body_1.getCompositionFromBody)(body);
@@ -30,14 +30,14 @@ const renderStillSingleThread = async (body, res) => {
         const actualChromiumOptions = {
             ...body.chromiumOptions,
             // Override the `null` value, which might come from CLI with swANGLE
-            gl: (_b = (_a = body.chromiumOptions) === null || _a === void 0 ? void 0 : _a.gl) !== null && _b !== void 0 ? _b : 'swangle',
+            gl: (_c = (_b = body.chromiumOptions) === null || _b === void 0 ? void 0 : _b.gl) !== null && _c !== void 0 ? _c : 'swangle',
             enableMultiProcessOnLinux: true,
         };
         await renderer_1.RenderInternals.internalRenderStill({
             composition: {
                 ...composition,
-                height: (_c = body.forceHeight) !== null && _c !== void 0 ? _c : composition.height,
-                width: (_d = body.forceWidth) !== null && _d !== void 0 ? _d : composition.width,
+                height: (_d = body.forceHeight) !== null && _d !== void 0 ? _d : composition.height,
+                width: (_e = body.forceWidth) !== null && _e !== void 0 ? _e : composition.width,
             },
             serveUrl: body.serveUrl,
             output: tempFilePath,
@@ -47,7 +47,7 @@ const renderStillSingleThread = async (body, res) => {
                 indent: undefined,
                 staticBase: null,
             }).serializedString,
-            jpegQuality: (_e = body.jpegQuality) !== null && _e !== void 0 ? _e : renderer_1.RenderInternals.DEFAULT_JPEG_QUALITY,
+            jpegQuality: (_f = body.jpegQuality) !== null && _f !== void 0 ? _f : renderer_1.RenderInternals.DEFAULT_JPEG_QUALITY,
             imageFormat: body.imageFormat,
             scale: body.scale,
             envVariables: body.envVariables,
@@ -72,6 +72,7 @@ const renderStillSingleThread = async (body, res) => {
             onArtifact: () => {
                 throw new Error('Emitting artifacts is not supported in Cloud Run');
             },
+            chromeMode: 'headless-shell',
         });
         log_1.Log.info({ indent: false, logLevel: body.logLevel }, 'Still rendered');
         const storage = new storage_1.Storage();
@@ -79,7 +80,7 @@ const renderStillSingleThread = async (body, res) => {
         const uploadedResponse = await storage
             .bucket(body.outputBucket)
             .upload(tempFilePath, {
-            destination: `renders/${renderId}/${(_f = body.outName) !== null && _f !== void 0 ? _f : 'out.png'}`,
+            destination: `renders/${renderId}/${(_g = body.outName) !== null && _g !== void 0 ? _g : 'out.png'}`,
             predefinedAcl: publicUpload ? 'publicRead' : 'projectPrivate',
             metadata: (0, get_download_behavior_setting_1.getDownloadBehaviorSetting)(body.downloadBehavior),
         });

package/dist/index.d.ts

@@ -16,7 +16,7 @@ import type { GcpRegion } from './pricing/gcp-regions';
 /**
  * @deprecated  Import this from `@remotion/cloudrun/client` instead
  */
-declare const renderMediaOnCloudrun: ({ cloudRunUrl, serviceName, region, serveUrl, composition, inputProps, codec, forceBucketName, privacy, outName, updateRenderProgress, jpegQuality, audioCodec, audioBitrate, videoBitrate, encodingMaxRate, encodingBufferSize, proResProfile, x264Preset, crf, pixelFormat, imageFormat, scale, everyNthFrame, numberOfGifLoops, frameRange, envVariables, chromiumOptions, muted, forceWidth, forceHeight, logLevel, delayRenderTimeoutInMilliseconds, concurrency, enforceAudioTrack, preferLossless, offthreadVideoCacheSizeInBytes, colorSpace, downloadBehavior, metadata, }: RenderMediaOnCloudrunInput) => Promise<RenderMediaOnCloudrunOutput | import("./functions/helpers/payloads").CloudRunCrashResponse>;
+declare const renderMediaOnCloudrun: ({ cloudRunUrl, serviceName, region, serveUrl, composition, inputProps, codec, forceBucketName, privacy, outName, updateRenderProgress, jpegQuality, audioCodec, audioBitrate, videoBitrate, encodingMaxRate, encodingBufferSize, proResProfile, x264Preset, crf, pixelFormat, imageFormat, scale, everyNthFrame, numberOfGifLoops, frameRange, envVariables, chromiumOptions, muted, forceWidth, forceHeight, logLevel, delayRenderTimeoutInMilliseconds, concurrency, enforceAudioTrack, preferLossless, offthreadVideoCacheSizeInBytes, colorSpace, downloadBehavior, metadata, renderIdOverride, renderStatusWebhook, }: RenderMediaOnCloudrunInput) => Promise<RenderMediaOnCloudrunOutput | import("./functions/helpers/payloads").CloudRunCrashResponse>;
 /**
  * @deprecated  Import this from `@remotion/cloudrun/client` instead
  */

package/package.json

@@ -3,7 +3,7 @@
     "url": "https://github.com/remotion-dev/remotion/tree/main/packages/cloudrun"
   },
   "name": "@remotion/cloudrun",
-  "version": "4.0.246",
+  "version": "4.0.248",
   "description": "Render Remotion videos on Google Cloud Run",
   "main": "dist/index.js",
   "sideEffects": false,
@@ -16,16 +16,16 @@
     "@google-cloud/logging": "^11.1.0",
     "google-auth-library": "^8.7.0",
     "zod": "3.22.3",
-    "@remotion/bundler": "4.0.246",
-    "@remotion/cli": "4.0.246",
-    "@remotion/renderer": "4.0.246",
-    "remotion": "4.0.246"
+    "@remotion/bundler": "4.0.248",
+    "@remotion/cli": "4.0.248",
+    "remotion": "4.0.248",
+    "@remotion/renderer": "4.0.248"
   },
   "devDependencies": {
     "@types/minimist": "1.2.2",
     "eslint": "9.14.0",
-    "@remotion/compositor-linux-x64-gnu": "4.0.246",
-    "@remotion/eslint-config-internal": "4.0.246"
+    "@remotion/eslint-config-internal": "4.0.248",
+    "@remotion/compositor-linux-x64-gnu": "4.0.248"
   },
   "exports": {
     "./package.json": "./package.json",