@remotion/cloudrun 4.1.0-alpha5 → 4.1.0-alpha7

package/.turbo/turbo-build.log

@@ -1,13 +1,13 @@
 
-> @remotion/cloudrun@3.3.101 build /Users/jonathanburger/remotion-v4/packages/cloudrun
+> @remotion/cloudrun@3.3.101 build /Users/jonathanburger/remotion/packages/cloudrun
 > tsc -d && cp src/shared/sa-permissions.json dist/shared/sa-permissions.json && pnpm run buildContainer && pnpm run tarInstaller
 
 
-> @remotion/cloudrun@3.3.101 buildContainer /Users/jonathanburger/remotion-v4/packages/cloudrun
+> @remotion/cloudrun@3.3.101 buildContainer /Users/jonathanburger/remotion/packages/cloudrun
 > ts-node src/admin/bundle-renderLogic.ts
 
 distribution bundled.
 
-> @remotion/cloudrun@3.3.101 tarInstaller /Users/jonathanburger/remotion-v4/packages/cloudrun
+> @remotion/cloudrun@3.3.101 tarInstaller /Users/jonathanburger/remotion/packages/cloudrun
 > ts-node src/admin/bundle-installer.ts
 

package/dist/api/helpers/construct-service-deploy-request.js

@@ -20,7 +20,7 @@ const constructServiceTemplate = ({ memoryLimit, cpuLimit, timeoutSeconds, minIn
         },
         containers: [
             {
-                image: `us-docker.pkg.dev/remotion-dev/cloud-run/render:${version_1.VERSION}`,
+                image: `us-docker.pkg.dev/remotion-dev/production/render:${version_1.VERSION}`,
                 resources: {
                     limits: {
                         memory: memoryLimit,

package/dist/api/helpers/extract-mem-from-url.d.ts

@@ -0,0 +1 @@
+export declare function extractMemoryFromURL(url: string): string | undefined;

package/dist/api/helpers/extract-mem-from-url.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractMemoryFromURL = void 0;
+function extractMemoryFromURL(url) {
+    const regex = /mem(.*?)-/;
+    const match = url.match(regex);
+    return match ? match[1] : undefined;
+}
+exports.extractMemoryFromURL = extractMemoryFromURL;

package/dist/api/helpers/extract-time-from-url.d.ts

@@ -0,0 +1 @@
+export declare function extractTimeoutFromURL(url: string): number | undefined;

package/dist/api/helpers/extract-time-from-url.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractTimeoutFromURL = void 0;
+function extractTimeoutFromURL(url) {
+    const firstTIndex = url.indexOf('-t');
+    if (firstTIndex !== -1) {
+        const substrAfterT = url.substring(firstTIndex + 2);
+        const numberStr = substrAfterT.split('-')[0];
+        return parseInt(numberStr, 10);
+    }
+    return undefined;
+}
+exports.extractTimeoutFromURL = extractTimeoutFromURL;

package/dist/api/helpers/get-cloud-logging-client.d.ts

@@ -0,0 +1 @@
+export declare const getCloudLoggingClient: () => any;

package/dist/api/helpers/get-cloud-logging-client.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCloudLoggingClient = void 0;
+const logging_1 = require("@google-cloud/logging");
+const { LoggingServiceV2Client } = logging_1.v2;
+const getCloudLoggingClient = () => {
+    return new LoggingServiceV2Client({
+        projectId: process.env.REMOTION_GCP_PROJECT_ID,
+        credentials: {
+            client_email: process.env.REMOTION_GCP_CLIENT_EMAIL,
+            private_key: process.env.REMOTION_GCP_PRIVATE_KEY,
+        },
+    });
+};
+exports.getCloudLoggingClient = getCloudLoggingClient;

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

@@ -1,5 +1,5 @@
 import type { ChromiumOptions, FrameRange, LogLevel } from '@remotion/renderer';
-import type { RenderMediaOnCloudrunOutput } from '../functions/helpers/payloads';
+import type { CloudRunCrashResponse, RenderMediaOnCloudrunOutput } from '../functions/helpers/payloads';
 import type { GcpRegion } from '../pricing/gcp-regions';
 import type { CloudrunCodec } from '../shared/validate-gcp-codec';
 export declare type RenderMediaOnCloudrunInput = {
@@ -12,7 +12,7 @@ export declare type RenderMediaOnCloudrunInput = {
     privacy?: 'public' | 'private';
     forceBucketName?: string;
     outName?: string;
-    updateRenderProgress?: (progress: number) => void;
+    updateRenderProgress?: (progress: number, error?: boolean) => void;
     codec: CloudrunCodec;
     audioCodec?: 'mp3' | 'aac' | 'pcm-16' | 'opus';
     jpegQuality?: number;
@@ -70,9 +70,9 @@ export declare type RenderMediaOnCloudrunInput = {
  * @param params.forceHeight Overrides default composition height.
  * @param params.logLevel Level of logging that Cloud Run service should perform. Default "info".
  * @param params.delayRenderTimeoutInMilliseconds A number describing how long the render may take to resolve all delayRender() calls before it times out.
- * @param params.concurrency By default, each Cloud Run service renders with concurrency 1 (one open browser tab). You may use the option to customize this value.
+ * @param params.concurrency By default, each Cloud Run service renders with concurrency 100% (equal to number of available cores). You may use the option to customize this value.
  * @param params.enforceAudioTrack Render a silent audio track if there wouldn't be any otherwise.
  * @param params.preferLossless Uses a lossless audio codec, if one is available for the codec. If you set audioCodec, it takes priority over preferLossless.
  * @returns {Promise<RenderMediaOnCloudrunOutput>} See documentation for detailed structure
  */
-export declare const renderMediaOnCloudrun: ({ cloudRunUrl, serviceName, region, serveUrl, composition, inputProps, codec, forceBucketName, privacy, outName, updateRenderProgress, jpegQuality, audioCodec, audioBitrate, videoBitrate, proResProfile, crf, pixelFormat, imageFormat, scale, everyNthFrame, numberOfGifLoops, frameRange, envVariables, chromiumOptions, muted, forceWidth, forceHeight, logLevel, delayRenderTimeoutInMilliseconds, concurrency, enforceAudioTrack, preferLossless, }: RenderMediaOnCloudrunInput) => Promise<RenderMediaOnCloudrunOutput>;
+export declare const renderMediaOnCloudrun: ({ cloudRunUrl, serviceName, region, serveUrl, composition, inputProps, codec, forceBucketName, privacy, outName, updateRenderProgress, jpegQuality, audioCodec, audioBitrate, videoBitrate, proResProfile, crf, pixelFormat, imageFormat, scale, everyNthFrame, numberOfGifLoops, frameRange, envVariables, chromiumOptions, muted, forceWidth, forceHeight, logLevel, delayRenderTimeoutInMilliseconds, concurrency, enforceAudioTrack, preferLossless, }: RenderMediaOnCloudrunInput) => Promise<RenderMediaOnCloudrunOutput | CloudRunCrashResponse>;

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

@@ -41,7 +41,7 @@ const get_cloudrun_endpoint_1 = require("./helpers/get-cloudrun-endpoint");
  * @param params.forceHeight Overrides default composition height.
  * @param params.logLevel Level of logging that Cloud Run service should perform. Default "info".
  * @param params.delayRenderTimeoutInMilliseconds A number describing how long the render may take to resolve all delayRender() calls before it times out.
- * @param params.concurrency By default, each Cloud Run service renders with concurrency 1 (one open browser tab). You may use the option to customize this value.
+ * @param params.concurrency By default, each Cloud Run service renders with concurrency 100% (equal to number of available cores). You may use the option to customize this value.
  * @param params.enforceAudioTrack Render a silent audio track if there wouldn't be any otherwise.
  * @param params.preferLossless Uses a lossless audio codec, if one is available for the codec. If you set audioCodec, it takes priority over preferLossless.
  * @returns {Promise<RenderMediaOnCloudrunOutput>} See documentation for detailed structure
@@ -99,6 +99,8 @@ const renderMediaOnCloudrun = async ({ cloudRunUrl, serviceName, region, serveUr
     const renderResponse = await new Promise((resolve, reject) => {
         // TODO: Add any sort of type safety
         let response;
+        const startTime = Date.now();
+        const formattedStartTime = new Date().toISOString();
         const stream = postResponse.data;
         stream.on('data', (chunk) => {
             const chunkResponse = JSON.parse(chunk.toString());
@@ -110,7 +112,20 @@ const renderMediaOnCloudrun = async ({ cloudRunUrl, serviceName, region, serveUr
             }
         });
         stream.on('end', () => {
-            if (response.status !== 'success') {
+            if (!response) {
+                const crashTime = Date.now();
+                const formattedCrashTime = new Date().toISOString();
+                updateRenderProgress === null || updateRenderProgress === void 0 ? void 0 : updateRenderProgress(0, true);
+                resolve({
+                    status: 'crash',
+                    cloudRunEndpoint,
+                    message: 'Service crashed without sending a response. Check the logs in GCP console.',
+                    requestStartTime: formattedStartTime,
+                    requestCrashTime: formattedCrashTime,
+                    requestElapsedTimeInSeconds: (crashTime - startTime) / 1000,
+                });
+            }
+            else if (response.status !== 'success' && response.status !== 'crash') {
                 throw new Error(response.stack);
             }
             resolve(response);

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

@@ -7,6 +7,9 @@ const render_media_on_cloudrun_1 = require("../../../api/render-media-on-cloudru
 const config_1 = require("@remotion/cli/config");
 const renderer_1 = require("@remotion/renderer");
 const download_file_1 = require("../../../api/download-file");
+const extract_mem_from_url_1 = require("../../../api/helpers/extract-mem-from-url");
+const extract_time_from_url_1 = require("../../../api/helpers/extract-time-from-url");
+const get_cloud_logging_client_1 = require("../../../api/helpers/get-cloud-logging-client");
 const validate_serveurl_1 = require("../../../shared/validate-serveurl");
 const args_1 = require("../../args");
 const log_1 = require("../../log");
@@ -94,9 +97,17 @@ ${downloadName ? `		Downloaded File = ${downloadName}` : ''}
                 : cli_1.CliInternals.chalk.gray(`${renderProgress.doneIn}ms`),
         ].join(' '), false);
     };
-    const updateRenderProgress = (progress) => {
-        renderProgress.progress = progress;
-        updateProgress();
+    const updateRenderProgress = (progress, error) => {
+        if (error) {
+            // exiting progress and adding space
+            log_1.Log.info(`
+		
+		`);
+        }
+        else {
+            renderProgress.progress = progress;
+            updateProgress();
+        }
     };
     const res = await (0, render_media_on_cloudrun_1.renderMediaOnCloudrun)({
         cloudRunUrl,
@@ -134,12 +145,61 @@ ${downloadName ? `		Downloaded File = ${downloadName}` : ''}
         enforceAudioTrack,
         preferLossless: false,
     });
-    renderProgress.doneIn = Date.now() - renderStart;
-    updateProgress();
-    log_1.Log.info(`
+    if (res.status === 'crash') {
+        let timeoutPreMsg = '';
+        const timeout = (0, extract_time_from_url_1.extractTimeoutFromURL)(res.cloudRunEndpoint);
+        const memoryLimit = (0, extract_mem_from_url_1.extractMemoryFromURL)(res.cloudRunEndpoint);
+        if (timeout && res.requestElapsedTimeInSeconds + 10 > timeout) {
+            timeoutPreMsg = `Render call likely timed out. Service timeout is ${timeout} seconds, and render took at least ${res.requestElapsedTimeInSeconds.toFixed(1)} seconds.\n`;
+        }
+        else {
+            timeoutPreMsg = `Crash unlikely due to timeout. Render took ${res.requestElapsedTimeInSeconds.toFixed(1)} seconds, below the timeout of ${timeout} seconds.\n`;
+        }
+        log_1.Log.error(`Error rendering on Cloud Run. The Cloud Run service did not return a response.\n
+${timeoutPreMsg}The crash may be due to the service exceeding its memory limit of ${memoryLimit}.
+Full logs are available at https://console.cloud.google.com/run?project=${process.env.REMOTION_GCP_PROJECT_ID}\n`);
+        const cloudLoggingClient = (0, get_cloud_logging_client_1.getCloudLoggingClient)();
+        const listLogEntriesRequest = {
+            resourceNames: [`projects/${process.env.REMOTION_GCP_PROJECT_ID}`],
+            filter: `logName=projects/${process.env.REMOTION_GCP_PROJECT_ID}/logs/run.googleapis.com%2Fvarlog%2Fsystem AND (severity=WARNING OR severity=ERROR) AND timestamp >= "${res.requestStartTime}"`,
+        };
+        const logCheckCountdown = cli_1.CliInternals.createOverwriteableCliOutput({
+            quiet: cli_1.CliInternals.quietFlagProvided(),
+            cancelSignal: null,
+            updatesDontOverwrite: false,
+            indent: false,
+        });
+        await (() => {
+            return new Promise((resolve) => {
+                let timeLeft = 30;
+                const intervalId = setInterval(() => {
+                    logCheckCountdown.update(`GCP Cloud Logging takes time to ingest and index logs.\nFetching recent error/warning logs in ${timeLeft} seconds`, false);
+                    timeLeft--;
+                    if (timeLeft < 0) {
+                        logCheckCountdown.update('Fetching logs...\n\n', false);
+                        clearInterval(intervalId);
+                        resolve();
+                    }
+                }, 1000);
+            });
+        })();
+        const iterableLogListEntries = await cloudLoggingClient.listLogEntriesAsync(listLogEntriesRequest);
+        for await (const logResponse of iterableLogListEntries) {
+            const responseDate = new Date(Number(logResponse.timestamp.seconds) * 1000 +
+                Number(logResponse.timestamp.nanos) / 1000000);
+            const convertedDate = responseDate.toLocaleString();
+            log_1.Log.info(convertedDate);
+            log_1.Log.info(logResponse.textPayload);
+            log_1.Log.info();
+        }
+    }
+    else if (res.status === 'success') {
+        renderProgress.doneIn = Date.now() - renderStart;
+        updateProgress();
+        log_1.Log.info(`
 		
 		`);
-    log_1.Log.info(cli_1.CliInternals.chalk.blueBright(`
+        log_1.Log.info(cli_1.CliInternals.chalk.blueBright(`
 ${res.publicUrl ? `Public URL = ${decodeURIComponent(res.publicUrl)}` : ``}
 Cloud Storage Uri = ${res.cloudStorageUri}
 Size (KB) = ${Math.round(Number(res.size) / 1000)}
@@ -148,15 +208,16 @@ Privacy = ${res.privacy}
 Render ID = ${res.renderId}
 Codec = ${codec} (${codecReason})
       `.trim()));
-    if (downloadName) {
-        log_1.Log.info('');
-        log_1.Log.info('downloading file...');
-        const destination = await (0, download_file_1.downloadFile)({
-            bucketName: res.bucketName,
-            gsutilURI: res.cloudStorageUri,
-            downloadName,
-        });
-        log_1.Log.info(cli_1.CliInternals.chalk.blueBright(`Downloaded file to ${destination}!`));
+        if (downloadName) {
+            log_1.Log.info('');
+            log_1.Log.info('downloading file...');
+            const destination = await (0, download_file_1.downloadFile)({
+                bucketName: res.bucketName,
+                gsutilURI: res.cloudStorageUri,
+                downloadName,
+            });
+            log_1.Log.info(cli_1.CliInternals.chalk.blueBright(`Downloaded file to ${destination}!`));
+        }
     }
 };
 exports.renderCommand = renderCommand;

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

@@ -221,12 +221,12 @@ declare const renderFailResponsePayload: z.ZodObject<{
     stack: string;
 }>;
 declare const renderStillOnCloudrunResponsePayload: z.ZodObject<{
+    status: z.ZodLiteral<"success">;
     publicUrl: z.ZodNullable<z.ZodOptional<z.ZodString>>;
     cloudStorageUri: z.ZodString;
     size: z.ZodNumber;
     bucketName: z.ZodString;
     renderId: z.ZodString;
-    status: z.ZodLiteral<"success">;
     privacy: z.ZodEnum<["public-read", "project-private"]>;
 }, "strip", z.ZodTypeAny, {
     bucketName: string;
@@ -246,12 +246,12 @@ declare const renderStillOnCloudrunResponsePayload: z.ZodObject<{
     publicUrl?: string | null | undefined;
 }>;
 declare const renderMediaOnCloudrunResponsePayload: z.ZodObject<{
+    status: z.ZodLiteral<"success">;
     publicUrl: z.ZodNullable<z.ZodOptional<z.ZodString>>;
     cloudStorageUri: z.ZodString;
     size: z.ZodNumber;
     bucketName: z.ZodString;
     renderId: z.ZodString;
-    status: z.ZodLiteral<"success">;
     privacy: z.ZodEnum<["public-read", "project-private"]>;
 }, "strip", z.ZodTypeAny, {
     bucketName: string;
@@ -270,8 +270,31 @@ declare const renderMediaOnCloudrunResponsePayload: z.ZodObject<{
     renderId: string;
     publicUrl?: string | null | undefined;
 }>;
+declare const cloudRunCrashResponse: z.ZodObject<{
+    status: z.ZodLiteral<"crash">;
+    cloudRunEndpoint: z.ZodString;
+    message: z.ZodLiteral<"Service crashed without sending a response. Check the logs in GCP console.">;
+    requestStartTime: z.ZodString;
+    requestCrashTime: z.ZodString;
+    requestElapsedTimeInSeconds: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    message: "Service crashed without sending a response. Check the logs in GCP console.";
+    status: "crash";
+    cloudRunEndpoint: string;
+    requestStartTime: string;
+    requestCrashTime: string;
+    requestElapsedTimeInSeconds: number;
+}, {
+    message: "Service crashed without sending a response. Check the logs in GCP console.";
+    status: "crash";
+    cloudRunEndpoint: string;
+    requestStartTime: string;
+    requestCrashTime: string;
+    requestElapsedTimeInSeconds: number;
+}>;
 export declare type CloudRunPayloadType = z.infer<typeof CloudRunPayload>;
 export declare type RenderStillOnCloudrunOutput = z.infer<typeof renderStillOnCloudrunResponsePayload>;
 export declare type RenderMediaOnCloudrunOutput = z.infer<typeof renderMediaOnCloudrunResponsePayload>;
 export declare type ErrorResponsePayload = z.infer<typeof renderFailResponsePayload>;
+export declare type CloudRunCrashResponse = z.infer<typeof cloudRunCrashResponse>;
 export {};

package/dist/functions/helpers/payloads.js

@@ -77,20 +77,28 @@ const renderFailResponsePayload = zod_1.z.object({
     stack: zod_1.z.string(),
 });
 const renderStillOnCloudrunResponsePayload = zod_1.z.object({
+    status: zod_1.z.literal('success'),
     publicUrl: zod_1.z.string().optional().nullable(),
     cloudStorageUri: zod_1.z.string(),
     size: zod_1.z.number(),
     bucketName: zod_1.z.string(),
     renderId: zod_1.z.string(),
-    status: zod_1.z.literal('success'),
     privacy: zod_1.z.enum(['public-read', 'project-private']),
 });
 const renderMediaOnCloudrunResponsePayload = zod_1.z.object({
+    status: zod_1.z.literal('success'),
     publicUrl: zod_1.z.string().optional().nullable(),
     cloudStorageUri: zod_1.z.string(),
     size: zod_1.z.number(),
     bucketName: zod_1.z.string(),
     renderId: zod_1.z.string(),
-    status: zod_1.z.literal('success'),
     privacy: zod_1.z.enum(['public-read', 'project-private']),
 });
+const cloudRunCrashResponse = zod_1.z.object({
+    status: zod_1.z.literal('crash'),
+    cloudRunEndpoint: zod_1.z.string(),
+    message: zod_1.z.literal('Service crashed without sending a response. Check the logs in GCP console.'),
+    requestStartTime: zod_1.z.string().datetime(),
+    requestCrashTime: zod_1.z.string().datetime(),
+    requestElapsedTimeInSeconds: zod_1.z.number(),
+});

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

@@ -6,7 +6,7 @@ const renderer_1 = require("@remotion/renderer");
 const random_hash_1 = require("../shared/random-hash");
 const get_composition_from_body_1 = require("./helpers/get-composition-from-body");
 const renderMediaSingleThread = async (body, res) => {
-    var _a, _b, _c, _d, _e, _f;
+    var _a, _b, _c, _d, _e, _f, _g;
     if (body.type !== 'media') {
         throw new Error('expected type media');
     }
@@ -56,7 +56,7 @@ const renderMediaSingleThread = async (body, res) => {
         browserExecutable: null,
         timeoutInMilliseconds: body.delayRenderTimeoutInMilliseconds,
         cancelSignal: undefined,
-        concurrency: body.concurrency,
+        concurrency: (_f = body.concurrency) !== null && _f !== void 0 ? _f : '100%',
         disallowParallelEncoding: false,
         enforceAudioTrack: body.enforceAudioTrack,
         ffmpegOverride: undefined,
@@ -76,7 +76,7 @@ const renderMediaSingleThread = async (body, res) => {
     const uploadedResponse = await storage
         .bucket(body.outputBucket)
         .upload(tempFilePath, {
-        destination: `renders/${renderId}/${(_f = body.outName) !== null && _f !== void 0 ? _f : 'out.mp4'}`,
+        destination: `renders/${renderId}/${(_g = body.outName) !== null && _g !== void 0 ? _g : 'out.mp4'}`,
         predefinedAcl: publicUpload ? 'publicRead' : 'projectPrivate',
     });
     const uploadedFile = uploadedResponse[0];

package/dist/shared/sa-permissions.json

@@ -55,6 +55,10 @@
         {
             "name": "storage.objects.list",
             "reason": ""
+        },
+        {
+            "name": "logging.logEntries.list",
+            "reason": "Used by the CLI to fetch recent logs if the Cloud Run service crashes, to assist in debugging the root cause."
         }
     ]
 }

package/dist/shared/validate-image-remotion-version.js

@@ -13,7 +13,7 @@ const validateImageRemotionVersion = async () => {
         },
     });
     const listedTags = await client.listTags({
-        parent: 'projects/remotion-dev/locations/us/repositories/cloud-run/packages/render',
+        parent: 'projects/remotion-dev/locations/us/repositories/production/packages/render',
     });
     for (const tag of listedTags[0]) {
         if (version_1.VERSION === ((_a = tag.name) === null || _a === void 0 ? void 0 : _a.split('/').pop())) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remotion/cloudrun",
-  "version": "4.1.0-alpha5",
+  "version": "4.1.0-alpha7",
   "description": "GCP Cloud Run alternative to lambda rendering",
   "main": "dist/index.js",
   "dependencies": {
@@ -9,12 +9,13 @@
     "@google-cloud/run": "^0.4.0",
     "@google-cloud/storage": "^6.9.1",
     "@google-cloud/resource-manager": "^4.3.0",
+    "@google-cloud/logging": "^10.5.0",
     "google-auth-library": "^8.7.0",
     "zod": "^3.21.4",
-    "remotion": "4.1.0-alpha5",
-    "@remotion/renderer": "4.1.0-alpha5",
-    "@remotion/bundler": "4.1.0-alpha5",
-    "@remotion/cli": "4.1.0-alpha5"
+    "@remotion/bundler": "4.1.0-alpha7",
+    "@remotion/cli": "4.1.0-alpha7",
+    "@remotion/renderer": "4.1.0-alpha7",
+    "remotion": "4.1.0-alpha7"
   },
   "devDependencies": {
     "@jonny/eslint-config": "3.0.266",
@@ -26,7 +27,7 @@
     "ts-node": "^10.8.0",
     "typescript": "4.7.2",
     "vitest": "0.24.3",
-    "@remotion/compositor-linux-x64-gnu": "4.1.0-alpha5"
+    "@remotion/compositor-linux-x64-gnu": "4.1.0-alpha7"
   },
   "exports": {
     "./package.json": "./package.json",