Cloud Run No Build Initial MVP Implementation v2

src/deploy/functions/backend.spec.ts

@@ -94,7 +94,7 @@ describe("Backend", () => {
           },
         },
       ],
-      containerConcurrency: 80,
+      maxInstanceRequestConcurrency: 80,
     },
     generation: 1,
     createTime: "2023-01-01T00:00:00Z",

src/deploy/functions/backend.ts

@@ -195,7 +195,7 @@
   return allMemoryOptions.includes(mem as MemoryOptions);
 }
 
 export function isValidEgressSetting(egress: unknown): egress is VpcEgressSettings {
   return egress === "PRIVATE_RANGES_ONLY" || egress === "ALL_TRAFFIC";
 }
 
@@ -407,6 +407,11 @@
 
     // State of the endpoint.
     state?: EndpointState;
+
+    // Fields for "run" platform (no-build)
+    baseImageUri?: string;
+    command?: string[];
+    args?: string[];
   };
 
 export interface RequiredAPI {
@@ -572,8 +577,8 @@
           existingBackend.endpoints[endpoint.region] || {};
         existingBackend.endpoints[endpoint.region][endpoint.id] = endpoint;
       }
     } catch (err: any) {
       logger.debug(err.message);
       unreachableRegions.run = ["unknown"];
     }
   } else {

src/deploy/functions/build.ts

@@ -226,8 +226,8 @@
 const allMemoryOptions: MemoryOption[] = [128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768];
 
 // Run is an automatic migration from gcfv2 and is not used on the wire.
-export type FunctionsPlatform = Exclude<backend.FunctionsPlatform, "run">;
-export const AllFunctionsPlatforms: FunctionsPlatform[] = ["gcfv1", "gcfv2"];
+export type FunctionsPlatform = backend.FunctionsPlatform;
+export const AllFunctionsPlatforms: FunctionsPlatform[] = ["gcfv1", "gcfv2", "run"];
 export type VpcEgressSetting = backend.VpcEgressSettings;
 export const AllVpcEgressSettings: VpcEgressSetting[] = ["PRIVATE_RANGES_ONLY", "ALL_TRAFFIC"];
 export type IngressSetting = backend.IngressSettings;
@@ -242,7 +242,7 @@
   omit?: Field<boolean>;
 
   // Defaults to "gcfv2". "Run" will be an additional option defined later
-  platform?: "gcfv1" | "gcfv2";
+  platform?: "gcfv1" | "gcfv2" | "run";
 
   // Necessary for the GCF API to determine what code to load with the Functions Framework.
   // Will become optional once "run" is supported as a platform
@@ -287,6 +287,11 @@
   environmentVariables?: Record<string, string | Expression<string>> | null;
   secretEnvironmentVariables?: SecretEnvVar[] | null;
   labels?: Record<string, string | Expression<string>> | null;
+
+  // Fields for "run" platform (no-build)
+  baseImageUri?: string;
+  command?: string[];
+  args?: string[];
 };
 
 type SecretParam = ReturnType<typeof defineSecret>;
@@ -474,7 +479,7 @@
       // List param, we try resolving a String param instead.
       try {
         regions = params.resolveList(bdEndpoint.region, paramValues);
       } catch (err: any) {
         if (err instanceof ExprParseError) {
           regions = [params.resolveString(bdEndpoint.region, paramValues)];
         } else {
@@ -503,6 +508,9 @@
         "environmentVariables",
         "labels",
         "secretEnvironmentVariables",
+        "baseImageUri",
+        "command",
+        "args",
       );
       r.resolveStrings(bkEndpoint, bdEndpoint, "serviceAccount");
 

src/deploy/functions/checkIam.ts

@@ -41,7 +41,7 @@
       ["iam.serviceAccounts.actAs"],
     );
     passed = iamResult.passed;
   } catch (err: any) {
     logger.debug("[functions] service account IAM check errored, deploy may fail:", err);
     // we want to fail this check open and not rethrow since it's informational only
     return;
@@ -52,16 +52,15 @@
       `Missing permissions required for functions deploy. You must have permission ${bold(
         "iam.serviceAccounts.ActAs",
       )} on service account ${bold(saEmail)}.\n\n` +
-        `To address this error, ask a project Owner to assign your account the "Service Account User" role from this URL:\n\n` +
-        `https://console.cloud.google.com/iam-admin/iam?project=${projectId}`,
+      `To address this error, ask a project Owner to assign your account the "Service Account User" role from this URL:\n\n` +
+      `https://console.cloud.google.com/iam-admin/iam?project=${projectId}`,
     );
   }
 }
 
 /**
  * Checks a functions deployment for HTTP function creation, and tests IAM
  * permissions accordingly.
- *
  * @param context The deploy context.
  * @param options The command-wide options object.
  * @param payload The deploy payload.
@@ -74,11 +73,12 @@
   if (!payload.functions) {
     return;
   }
   const filters = context.filters || getEndpointFilters(options, context.config!);
   const wantBackends = Object.values(payload.functions).map(({ wantBackend }) => wantBackend);
   const httpEndpoints = [...flattenArray(wantBackends.map((b) => backend.allEndpoints(b)))]
-    .filter(backend.isHttpsTriggered || backend.isDataConnectGraphqlTriggered)
-    .filter((f) => endpointMatchesAnyFilter(f, filters));
+    .filter((f) => backend.isHttpsTriggered(f) || backend.isDataConnectGraphqlTriggered(f))
+    .filter((f) => endpointMatchesAnyFilter(f, filters))
+    .filter((f) => f.platform !== "run");
 
   const existing = await backend.existingBackend(context);
   const newHttpsEndpoints = httpEndpoints.filter(backend.missingEndpoint(existing));
@@ -97,7 +97,7 @@
   try {
     const iamResult = await iam.testIamPermissions(context.projectId, [PERMISSION]);
     passed = iamResult.passed;
   } catch (e: any) {
     logger.debug(
       "[functions] failed http create setIamPolicy permission check. deploy may fail:",
       e,
@@ -117,8 +117,8 @@
       )} to deploy new HTTPS functions. The permission ${bold(
         PERMISSION,
       )} is required to deploy the following functions:\n\n- ` +
-        newHttpsEndpoints.map((func) => func.id).join("\n- ") +
-        `\n\nTo address this error, please ask a project Owner to assign your account the "Cloud Functions Admin" role at the following URL:\n\nhttps://console.cloud.google.com/iam-admin/iam?project=${context.projectId}`,
+      newHttpsEndpoints.map((func) => func.id).join("\n- ") +
+      `\n\nTo address this error, please ask a project Owner to assign your account the "Cloud Functions Admin" role at the following URL:\n\nhttps://console.cloud.google.com/iam-admin/iam?project=${context.projectId}`,
     );
   }
   logger.debug("[functions] found setIamPolicy permission, proceeding with deploy");
@@ -130,7 +130,7 @@
 }
 
 /** Callback reducer function */
 function reduceEventsToServices(services: Array<Service>, endpoint: backend.Endpoint) {
   const service = serviceForEndpoint(endpoint);
   if (service.requiredProjectBindings && !services.find((s) => s.name === service.name)) {
     services.push(service);
@@ -149,7 +149,7 @@
  * Finds the required project level IAM bindings for the Pub/Sub service agent.
  * If the user enabled Pub/Sub on or before April 8, 2021, then we must enable the token creator role.
  * @param projectNumber project number
  * @param existingPolicy the project level IAM policy
  */
 export function obtainPubSubServiceAgentBindings(projectNumber: string): iam.Binding[] {
   const serviceAccountTokenCreatorBinding: iam.Binding = {
@@ -290,8 +290,8 @@
     utils.logLabeledBullet(
       "functions",
       "Could not verify the necessary IAM configuration for the following newly-integrated services: " +
-        `${newServicesOrEndpoints.join(", ")}` +
-        ". Deployment may fail.",
+      `${newServicesOrEndpoints.join(", ")}` +
+      ". Deployment may fail.",
       "warn",
     );
     return;
@@ -316,8 +316,8 @@
     iam.printManualIamConfig(requiredBindings, projectId, "functions");
     throw new FirebaseError(
       "We failed to modify the IAM policy for the project. The functions " +
-        "deployment requires specific roles to be granted to service agents," +
-        " otherwise the deployment will fail.",
+      "deployment requires specific roles to be granted to service agents," +
+      " otherwise the deployment will fail.",
       { original: err },
     );
   }

src/deploy/functions/deploy.ts

@@ -15,6 +15,7 @@ import * as experiments from "../../experiments";
 import { findEndpoint } from "./backend";
 import { deploy as extDeploy } from "../extensions";
 import { getProjectNumber } from "../../getProjectNumber";
+import * as path from "path";
 
 setGracefulCleanup();
 
@@ -51,10 +52,16 @@ async function uploadSourceV1(
 }
 
 // Trampoline to allow tests to mock out createStream.
+/**
+ *
+ */
 export function createReadStream(filePath: string): NodeJS.ReadableStream {
   return fs.createReadStream(filePath);
 }
 
+/**
+ *
+ */
 export async function uploadSourceV2(
   projectId: string,
   projectNumber: string,
@@ -80,7 +87,9 @@ export async function uploadSourceV2(
   };
 
   // Legacy behavior: use the GCF API
-  if (!experiments.isEnabled("runfunctions")) {
+  // We use BYO bucket if the "runfunctions" experiment is enabled OR if we have any platform: run endpoints.
+  // Otherwise, we use the GCF API.
+  if (!experiments.isEnabled("runfunctions") && !v2Endpoints.some((e) => e.platform === "run")) {
     if (process.env.GOOGLE_CLOUD_QUOTA_PROJECT) {
       logLabeledWarning(
         "functions",
@@ -116,7 +125,7 @@ export async function uploadSourceV2(
       },
     },
   });
-  const objectPath = `${source.functionsSourceV2Hash}.zip`;
+  const objectPath = `${source.functionsSourceV2Hash}${path.extname(source.functionsSourceV2!)}`;
   await gcs.upload(
     uploadOpts,
     `${bucketName}/${objectPath}`,

src/deploy/functions/prepare.ts

@@ -95,7 +95,7 @@
   // ===Phase 1. Load codebases from source with optional runtime config.
   let runtimeConfig: Record<string, unknown> = { firebase: firebaseConfig };
 
-  const targetedCodebaseConfigs = context.config!.filter((cfg) => codebases.includes(cfg.codebase));
+  const targetedCodebaseConfigs = context.config.filter((cfg) => codebases.includes(cfg.codebase));
 
   // Load runtime config if API is enabled and at least one targeted codebase uses it
   if (checkAPIsEnabled[1] && targetedCodebaseConfigs.some(shouldUseRuntimeConfig)) {
@@ -223,7 +223,7 @@
       );
     }
 
-    if (backend.someEndpoint(wantBackend, (e) => e.platform === "gcfv2")) {
+    if (backend.someEndpoint(wantBackend, (e) => e.platform === "gcfv2" || e.platform === "run")) {
       const schPathSet = new Set<string>();
       for (const e of backend.allEndpoints(wantBackend)) {
         if (
@@ -233,11 +233,17 @@
           schPathSet.add(e.dataConnectGraphqlTrigger.schemaFilePath);
         }
       }
+      const configForUpload = shouldUseRuntimeConfig(localCfg) ? runtimeConfig : undefined;
+      const exportType = backend.someEndpoint(wantBackend, (e) => e.platform === "run")
+        ? "tar.gz"
+        : "zip";
       const packagedSource = await prepareFunctionsUpload(
         options.config.projectDir,
         sourceDir,
         localCfg,
         [...schPathSet],
+        configForUpload,
+        { exportType },
       );
       source.functionsSourceV2 = packagedSource?.pathToSource;
       source.functionsSourceV2Hash = packagedSource?.hash;
@@ -490,10 +496,10 @@
     if (firebaseJsonRuntime && !supported.isRuntime(firebaseJsonRuntime as string)) {
       throw new FirebaseError(
         `Functions codebase ${codebase} has invalid runtime ` +
-          `${firebaseJsonRuntime} specified in firebase.json. Valid values are: \n` +
-          Object.keys(supported.RUNTIMES)
-            .map((s) => `- ${s}`)
-            .join("\n"),
+        `${firebaseJsonRuntime} specified in firebase.json. Valid values are: \n` +
+        Object.keys(supported.RUNTIMES)
+          .map((s) => `- ${s}`)
+          .join("\n"),
       );
     }
     const runtimeDelegate = await runtimes.getRuntimeDelegate(delegateContext);

src/deploy/functions/prepareFunctionsUpload.ts

@@ -24,6 +24,9 @@ interface PackagedSourceInfo {
 type SortedConfig = string | { key: string; value: SortedConfig }[];
 
 // TODO(inlined): move to a file that's not about uploading source code
+/**
+ *
+ */
 export async function getFunctionsConfig(projectId: string): Promise<Record<string, unknown>> {
   try {
     return await functionsConfig.materializeAll(projectId);
@@ -37,9 +40,9 @@ export async function getFunctionsConfig(projectId: string): Promise<Record<stri
     if (errorCode === 500 || errorCode === 503) {
       throw new FirebaseError(
         "Cloud Runtime Config is currently experiencing issues, " +
-          "which is preventing your functions from being deployed. " +
-          "Please wait a few minutes and then try to deploy your functions again." +
-          "\nRun `firebase deploy --except functions` if you want to continue deploying the rest of your project.",
+        "which is preventing your functions from being deployed. " +
+        "Please wait a few minutes and then try to deploy your functions again." +
+        "\nRun `firebase deploy --except functions` if you want to continue deploying the rest of your project.",
       );
     }
   }
@@ -61,13 +64,16 @@ async function packageSource(
   config: projectConfig.ValidatedSingle,
   additionalSources: string[],
   runtimeConfig: any,
+  options?: { exportType: "zip" | "tar.gz" },
 ): Promise<PackagedSourceInfo | undefined> {
-  const tmpFile = tmp.fileSync({ prefix: "firebase-functions-", postfix: ".zip" }).name;
+  const exportType = options?.exportType || "zip";
+  const postfix = exportType === "tar.gz" ? ".tar.gz" : ".zip";
+  const tmpFile = tmp.fileSync({ prefix: "firebase-functions-", postfix }).name;
   const fileStream = fs.createWriteStream(tmpFile, {
     flags: "w",
     encoding: "binary",
   });
-  const archive = archiver("zip");
+  const archive = exportType === "tar.gz" ? archiver("tar", { gzip: true }) : archiver("zip");
   const hashes: string[] = [];
 
   // We must ignore firebase-debug.log or weird things happen if
@@ -138,26 +144,33 @@ async function packageSource(
 
   utils.logBullet(
     clc.cyan(clc.bold("functions:")) +
-      " packaged " +
-      clc.bold(sourceDir) +
-      " (" +
-      filesize(archive.pointer()) +
-      ") for uploading",
+    " packaged " +
+    clc.bold(sourceDir) +
+    " (" +
+    filesize(archive.pointer()) +
+    ") for uploading",
   );
   const hash = hashes.join(".");
   return { pathToSource: tmpFile, hash };
 }
 
+/**
+ *
+ */
 export async function prepareFunctionsUpload(
   projectDir: string,
   sourceDir: string,
   config: projectConfig.ValidatedSingle,
   additionalSources: string[],
   runtimeConfig?: backend.RuntimeConfigValues,
+  options?: { exportType: "zip" | "tar.gz" },
 ): Promise<PackagedSourceInfo | undefined> {
-  return packageSource(projectDir, sourceDir, config, additionalSources, runtimeConfig);
+  return packageSource(projectDir, sourceDir, config, additionalSources, runtimeConfig, options);
 }
 
+/**
+ *
+ */
 export function convertToSortedKeyValueArray(config: any): SortedConfig {
   if (typeof config !== "object" || config === null) return config;