Refactor createBackend and other utility functions.

src/commands/frameworks-backends-create.ts

@@ -3,9 +3,11 @@ import { Options } from "../options";
 import { needProjectId } from "../projectUtils";
 import requireInteractive from "../requireInteractive";
 import { doSetup } from "../init/features/frameworks";
+import { ensureApiEnabled } from "../gcp/frameworks";
 
 export const command = new Command("backends:create")
   .description("Create a backend in a Firebase project")
+  .before(ensureApiEnabled)
   .before(requireInteractive)
   .action(async (options: Options) => {
     const projectId = needProjectId(options);

src/commands/frameworks-backends-delete.ts

@@ -7,7 +7,9 @@
 import * as utils from "../utils";
 import { logger } from "../logger";
 import { DEFAULT_REGION, ALLOWED_REGIONS } from "../init/features/frameworks/constants";
+import { ensureApiEnabled } from "../gcp/frameworks";
+
 const Table = require("cli-table");
 
 const COLUMN_LENGTH = 20;
 const TABLE_HEAD = [
@@ -24,6 +26,7 @@
   .option("-l, --location <location>", "App Backend location", "")
   .option("-s, --backend <backend>", "Backend Id", "")
   .withForce()
+  .before(ensureApiEnabled)
   .action(async (options: Options) => {
     const projectId = needProjectId(options);
     let location = options.location as string;
@@ -33,7 +36,7 @@
     }
 
     if (!location) {
       location = await promptOnce({
         name: "region",
         type: "list",
         default: DEFAULT_REGION,
@@ -42,24 +45,24 @@
       });
     }
 
     const table = new Table({
       head: TABLE_HEAD,
       style: { head: ["green"] },
     });
     table.colWidths = COLUMN_LENGTH;
 
     let backend;
     try {
       backend = await gcp.getBackend(projectId, location, backendId);
       populateTable(backend, table);
     } catch (err: any) {
       throw new FirebaseError(`No backends found with given parameters. Command aborted.`, {
         original: err,
       });
     }
 
     utils.logWarning("You are about to permanently delete the backend:");
     logger.info(table.toString());
 
     const confirmDeletion = await promptOnce(
       {

src/commands/frameworks-backends-get.ts

@@ -4,6 +4,8 @@ import { needProjectId } from "../projectUtils";
 import * as gcp from "../gcp/frameworks";
 import { FirebaseError } from "../error";
 import { logger } from "../logger";
+import { ensureApiEnabled } from "../gcp/frameworks";
+
 const Table = require("cli-table");
 const COLUMN_LENGTH = 20;
 const TABLE_HEAD = [
@@ -18,6 +20,7 @@ export const command = new Command("backends:get")
   .description("Get backend details of a Firebase project")
   .option("-l, --location <location>", "App Backend location", "-")
   .option("-b, --backend <backend>", "Backend Id", "")
+  .before(ensureApiEnabled)
   .action(async (options: Options) => {
     const projectId = needProjectId(options);
     const location = options.location as string;

src/commands/frameworks-backends-list.ts

@@ -5,13 +5,15 @@ import * as gcp from "../gcp/frameworks";
 import { FirebaseError } from "../error";
 import { logger } from "../logger";
 import { bold } from "colorette";
+import { ensureApiEnabled } from "../gcp/frameworks";
 
 const Table = require("cli-table");
 const COLUMN_LENGTH = 20;
 const TABLE_HEAD = ["Backend Id", "Repository", "Location", "URL", "Created Date", "Updated Date"];
 export const command = new Command("backends:list")
   .description("List backends of a Firebase project.")
   .option("-l, --location <location>", "App Backend location", "-")
+  .before(ensureApiEnabled)
   .action(async (options: Options) => {
     const projectId = needProjectId(options);
     const location = options.location as string;

src/gcp/cloudbuild.ts

@@ -209,3 +209,10 @@ export async function deleteRepository(
   const res = await client.delete<Operation>(name);
   return res.body;
 }
+
+/**
+ * Returns email associated with the Cloud Build Service Agent.
+ */
+export function serviceAgentEmail(projectNumber: string): string {
+  return `service-${projectNumber}@gcp-sa-cloudbuild.iam.gserviceaccount.com`;
+}

src/gcp/frameworks.ts

@@ -1,6 +1,9 @@
 import { Client } from "../apiv2";
+import { needProjectId } from "../projectUtils";
 import { frameworksOrigin } from "../api";
+import { ensure } from "../ensureApiEnabled";
 
+export const API_HOST = new URL(frameworksOrigin).host;
 export const API_VERSION = "v1alpha";
 
 const client = new Client({
@@ -16,11 +19,20 @@ interface Codebase {
   rootDirectory: string;
 }
 
+/**
+ * Specifies how Backend's data is replicated and served.
+ *   GLOBAL_ACCESS: Stores and serves content from multiple points-of-presence (POP)
+ *   REGIONAL_STRICT: Restricts data and serving infrastructure in Backend's region
+ *
+ */
+export type ServingLocality = "GLOBAL_ACCESS" | "REGIONAL_STRICT";
+
 /** A Backend, the primary resource of Frameworks. */
 export interface Backend {
   name: string;
   mode?: string;
   codebase: Codebase;
+  servingLocality: ServingLocality;
   labels: Record<string, string>;
   createTime: string;
   updateTime: string;
@@ -162,3 +174,11 @@ export async function createBuild(
 
   return res.body;
 }
+
+/**
+ * Ensure that Frameworks API is enabled on the project.
+ */
+export async function ensureApiEnabled(options: any): Promise<void> {
+  const projectId = needProjectId(options);
+  return await ensure(projectId, API_HOST, "frameworks", true);
+}

src/init/features/frameworks/index.ts

@@ -1,14 +1,13 @@
 import * as clc from "colorette";
-import * as utils from "../../../utils";
 import * as repo from "./repo";
 import * as poller from "../../../operation-poller";
 import * as gcp from "../../../gcp/frameworks";
+import { logBullet, logSuccess, logWarning } from "../../../utils";
 import { frameworksOrigin } from "../../../api";
 import { Backend, BackendOutputOnlyFields } from "../../../gcp/frameworks";
 import { Repository } from "../../../gcp/cloudbuild";
 import { API_VERSION } from "../../../gcp/frameworks";
 import { FirebaseError } from "../../../error";
-import { logger } from "../../../logger";
 import { promptOnce } from "../../../prompt";
 import { DEFAULT_REGION, ALLOWED_REGIONS } from "./constants";
 
@@ -25,50 +24,55 @@ const frameworksPollerOptions: Omit<poller.OperationPollerOptions, "operationRes
 export async function doSetup(setup: any, projectId: string): Promise<void> {
   setup.frameworks = {};
 
-  utils.logBullet("First we need a few details to create your backend.");
+  logBullet("First we need a few details to create your backend.");
 
-  await promptOnce(
-    {
-      name: "serviceName",
+  const location = await promptOnce({
+    name: "region",
+    type: "list",
+    default: DEFAULT_REGION,
+    message:
+      "Please select a region " +
+      `(${clc.yellow("info")}: Your region determines where your backend is located):\n`,
+    choices: ALLOWED_REGIONS,
+  });
+
+  logSuccess(`Region set to ${location}.\n`);
+
+  let backendId: string;
+  while (true) {
+    backendId = await promptOnce({
+      name: "backendId",
       type: "input",
       default: "acme-inc-web",
       message: "Create a name for your backend [1-30 characters]",
-    },
-    setup.frameworks
-  );
-
-  await promptOnce(
-    {
-      name: "region",
-      type: "list",
-      default: DEFAULT_REGION,
-      message:
-        "Please select a region " +
-        `(${clc.yellow("info")}: Your region determines where your backend is located):\n`,
-      choices: ALLOWED_REGIONS,
-    },
-    setup.frameworks
-  );
-
-  utils.logSuccess(`Region set to ${setup.frameworks.region}.`);
-
-  const backend: Backend | undefined = await getOrCreateBackend(projectId, setup);
+    });
+    try {
+      await gcp.getBackend(projectId, location, backendId);
+    } catch (err: any) {
+      if (err.status === 404) {
+        break;
+      }
+      throw new FirebaseError(
+        `Failed to check if backend with id ${backendId} already exists in ${location}`,
+        { original: err }
+      );
+    }
+    logWarning(`Backend with id ${backendId} already exists in ${location}`);
+  }
+  const backend: Backend = await onboardBackend(projectId, location, backendId);
 
   if (backend) {
-    logger.info();
-    utils.logSuccess(`Successfully created backend:\n ${backend.name}`);
-    logger.info();
-    utils.logSuccess(`Your site is being deployed at:\n https://${backend.uri}`);
-    logger.info();
-    utils.logSuccess(
-      `View the rollout status by running:\n firebase backends:get --backend=${backend.name}`
+    logSuccess(`Successfully created backend:\n\t${backend.name}`);
+    logSuccess(`Your site is being deployed at:\n\thttps://${backend.uri}`);
+    logSuccess(
+      `View the rollout status by running:\n\tfirebase backends:get --backend=${backend.name}`
     );
-    logger.info();
   }
 }
 
 function toBackend(cloudBuildConnRepo: Repository): Omit<Backend, BackendOutputOnlyFields> {
   return {
+    servingLocality: "GLOBAL_ACCESS",
     codebase: {
       repository: `${cloudBuildConnRepo.name}`,
       rootDirectory: "/",
@@ -78,77 +82,24 @@ function toBackend(cloudBuildConnRepo: Repository): Omit<Backend, BackendOutputO
 }
 
 /**
- * Creates backend if it doesn't exist.
+ * Walkthrough the flow for creating a new backend.
  */
-export async function getOrCreateBackend(
-  projectId: string,
-  setup: any
-): Promise<Backend | undefined> {
-  const location: string = setup.frameworks.region;
-  try {
-    return await getExistingBackend(projectId, setup, location);
-  } catch (err: unknown) {
-    if ((err as FirebaseError).status === 404) {
-      const cloudBuildConnRepo = await repo.linkGitHubRepository(projectId, location);
-      logger.info();
-      await promptOnce(
-        {
-          name: "branchName",
-          type: "input",
-          default: "main",
-          message: "Which branch do you want to deploy?",
-        },
-        setup.frameworks
-      );
-      const backendDetails = toBackend(cloudBuildConnRepo);
-      logger.info(clc.bold(`\n${clc.white("===")} Creating your backend`));
-      return await createBackend(projectId, location, backendDetails, setup.frameworks.serviceName);
-    } else {
-      throw new FirebaseError(
-        `Failed to get or create a backend using the given initialization details: ${err}`
-      );
-    }
-  }
-
-  return undefined;
-}
-
-async function getExistingBackend(
+export async function onboardBackend(
   projectId: string,
-  setup: any,
-  location: string
+  location: string,
+  backendId: string
 ): Promise<Backend> {
-  let backend = await gcp.getBackend(projectId, location, setup.frameworks.serviceName);
-  while (backend) {
-    setup.frameworks.serviceName = undefined;
-    await promptOnce(
-      {
-        name: "existingBackend",
-        type: "confirm",
-        default: true,
-        message:
-          "A backend already exists for the given serviceName, do you want to use existing backend? (yes/no)",
-      },
-      setup.frameworks
-    );
-    if (setup.frameworks.existingBackend) {
-      logger.info("Using the existing backend.");
-      return backend;
-    }
-    await promptOnce(
-      {
-        name: "serviceName",
-        type: "input",
-        default: "acme-inc-web",
-        message: "Please enter a new service name [1-30 characters]",
-      },
-      setup.frameworks
-    );
-    backend = await gcp.getBackend(projectId, location, setup.frameworks.serviceName);
-    setup.frameworks.existingBackend = undefined;
-  }
-
-  return backend;
+  const cloudBuildConnRepo = await repo.linkGitHubRepository(projectId, location);
+  const barnchName = await promptOnce({
+    name: "branchName",
+    type: "input",
+    default: "main",
+    message: "Which branch do you want to deploy?",
+  });
+  // branchName unused for now.
+  void barnchName;
+  const backendDetails = toBackend(cloudBuildConnRepo);
+  return await createBackend(projectId, location, backendDetails, backendId);
 }
 
 /**