fix: make runtime and buildConfig optional to prevent crash on parallel deploys (#9455)

Make runtime and buildConfig optional for cloud functions.

This prevents the TypeError: Cannot read properties of undefined (reading 'runtime') crash that occurred during parallel deployments when the API returned a function object without buildConfig - which could happen during early part of function creation.

Author: taeold

CHANGELOG.md

@@ -1,3 +1,4 @@
+- Fixed a crash during parallel deployments when buildConfig is empty (#9455)
 - [Added] support for new google-genai plugin during `init genkit` (#8957)
 - Updated to v2.17.1 of the Data Connect emulator, which fixes an admin SDK bug for operation without argument #9449 (#9454).
 - Fixed "Precondition failed" error when updating GCFv2 functions in a FAILED state without code changes.

src/deploy/functions/backend.spec.ts

@@ -281,7 +281,7 @@ describe("Backend", () => {
             cpu: 1,
             httpsTrigger: {},
             runServiceId: HAVE_CLOUD_FUNCTION_V2.serviceConfig?.service,
-            source: HAVE_CLOUD_FUNCTION_V2.buildConfig.source,
+            source: HAVE_CLOUD_FUNCTION_V2.buildConfig?.source,
             uri: HAVE_CLOUD_FUNCTION_V2.serviceConfig?.uri,
           }),
         );

src/deploy/functions/backend.ts

@@ -354,7 +354,7 @@ export type Endpoint = TargetIds &
   Triggered & {
     entryPoint: string;
     platform: FunctionsPlatform;
-    runtime: Runtime;
+    runtime?: Runtime;
 
     // Output only
     // "Codebase" is not part of the container contract. Instead, it's value is provided by firebase.json or derived

src/deploy/functions/release/fabricator.ts

@@ -759,7 +759,7 @@ export class Fabricator {
   }
 
   logOpStart(op: string, endpoint: backend.Endpoint): void {
-    const runtime = RUNTIMES[endpoint.runtime].friendly;
+    const runtime = endpoint.runtime ? RUNTIMES[endpoint.runtime].friendly : "unknown";
     const platform = getHumanFriendlyPlatformName(endpoint.platform);
     const label = helper.getFunctionLabel(endpoint);
     utils.logLabeledBullet(

src/functions/secrets.spec.ts

@@ -556,7 +556,7 @@ describe("functions/secret", () => {
       };
       const fn: Omit<gcf.CloudFunction, gcf.OutputOnlyFields> = {
         name: `projects/${endpoint.project}/locations/${endpoint.region}/functions/${endpoint.id}`,
-        runtime: endpoint.runtime,
+        runtime: endpoint.runtime!,
         entryPoint: endpoint.entryPoint,
         secretEnvironmentVariables: [{ ...sev, version: "2" }],
       };

src/gcp/cloudfunctions.ts

@@ -622,7 +622,7 @@ export function functionFromEndpoint(
     );
   }
 
-  if (!supported.isRuntime(endpoint.runtime)) {
+  if (!endpoint.runtime || !supported.isRuntime(endpoint.runtime)) {
     throw new FirebaseError(
       "Failed internal assertion. Trying to deploy a new function with a deprecated runtime." +
         " This should never happen",

src/gcp/cloudfunctionsv2.spec.ts

@@ -798,6 +798,24 @@ describe("cloudfunctionsv2", () => {
         }),
       ).to.deep.equal(expectedEndpoint);
     });
+
+    it("should convert function without buildConfig", () => {
+      const expectedEndpoint = {
+        ...ENDPOINT,
+        platform: "gcfv2",
+        httpsTrigger: {},
+        uri: GCF_URL,
+        entryPoint: "",
+        runtime: undefined,
+        source: undefined,
+      };
+      expect(
+        cloudfunctionsv2.endpointFromFunction({
+          ...HAVE_CLOUD_FUNCTION_V2,
+          buildConfig: undefined,
+        }),
+      ).to.deep.equal(expectedEndpoint);
+    });
   });
 
   describe("createFunction", () => {

src/gcp/cloudfunctionsv2.ts

@@ -46,7 +46,7 @@ export type RetryPolicy =
 
 /** Settings for building a container out of the customer source. */
 export interface BuildConfig {
-  runtime: supported.Runtime;
+  runtime?: supported.Runtime;
   entryPoint: string;
   source: Source;
   sourceToken?: string;
@@ -158,7 +158,7 @@ export interface EventTrigger {
 interface CloudFunctionBase {
   name: string;
   description?: string;
-  buildConfig: BuildConfig;
+  buildConfig?: BuildConfig;
   serviceConfig?: ServiceConfig;
   eventTrigger?: EventTrigger;
   labels?: Record<string, string> | null;
@@ -172,6 +172,7 @@ export type OutputCloudFunction = CloudFunctionBase & {
 };
 
 export type InputCloudFunction = CloudFunctionBase & {
+  buildConfig: BuildConfig;
   // serviceConfig is required.
   serviceConfig: ServiceConfig;
 };
@@ -228,7 +229,7 @@ function functionsOpLogReject(func: InputCloudFunction, type: string, err: any):
         "Either reduce this function's maximum instances, or request a quota increase on the underlying Cloud Run service " +
         "at https://cloud.google.com/run/quotas.",
     );
-    const suggestedFix = func.buildConfig.runtime.startsWith("python")
+    const suggestedFix = func.buildConfig.runtime?.startsWith("python")
       ? "firebase_functions.options.set_global_options(max_instances=10)"
       : "setGlobalOptions({maxInstances: 10})";
     utils.logLabeledWarning(
@@ -436,7 +437,7 @@ export function functionFromEndpoint(endpoint: backend.Endpoint): InputCloudFunc
     );
   }
 
-  if (!supported.isRuntime(endpoint.runtime)) {
+  if (endpoint.runtime && !supported.isRuntime(endpoint.runtime)) {
     throw new FirebaseError(
       "Failed internal assertion. Trying to deploy a new function with a deprecated runtime." +
         " This should never happen",
@@ -446,7 +447,7 @@ export function functionFromEndpoint(endpoint: backend.Endpoint): InputCloudFunc
   const gcfFunction: InputCloudFunction = {
     name: backend.functionName(endpoint),
     buildConfig: {
-      runtime: endpoint.runtime,
+      runtime: endpoint.runtime || undefined,
       entryPoint: endpoint.entryPoint,
       source: {
         storageSource: endpoint.source?.storageSource,
@@ -664,7 +665,7 @@ export function endpointFromFunction(gcfFunction: OutputCloudFunction): backend.
     trigger = { httpsTrigger: {} };
   }
 
-  if (!supported.isRuntime(gcfFunction.buildConfig.runtime)) {
+  if (gcfFunction.buildConfig?.runtime && !supported.isRuntime(gcfFunction.buildConfig.runtime)) {
     logger.debug("GCFv2 function has a deprecated runtime:", JSON.stringify(gcfFunction, null, 2));
   }
 
@@ -674,9 +675,9 @@ export function endpointFromFunction(gcfFunction: OutputCloudFunction): backend.
     project,
     region,
     ...trigger,
-    entryPoint: gcfFunction.buildConfig.entryPoint,
-    runtime: gcfFunction.buildConfig.runtime,
-    source: gcfFunction.buildConfig.source,
+    entryPoint: gcfFunction.buildConfig?.entryPoint || "",
+    runtime: gcfFunction.buildConfig?.runtime || undefined,
+    source: gcfFunction.buildConfig?.source,
   };
   if (gcfFunction.serviceConfig) {
     proto.copyIfPresent(

src/gcp/runv2.ts

@@ -519,7 +519,7 @@ export function serviceFromEndpoint(
 ): Omit<Service, ServiceOutputFields> {
   const labels: Record<string, string> = {
     ...endpoint.labels,
-    [RUNTIME_LABEL]: endpoint.runtime,
+    ...(endpoint.runtime ? { [RUNTIME_LABEL]: endpoint.runtime } : {}),
     [CLIENT_NAME_LABEL]: "firebase-functions",
   };