WIP: Manage GCB connection resources more carefully.

src/gcp/cloudbuild.ts

@@ -85,14 +85,15 @@ interface LinkableRepositories {
 export async function createConnection(
   projectId: string,
   location: string,
-  connectionId: string
+  connectionId: string,
+  githubConfig: GitHubConfig = {}
 ): Promise<Operation> {
   const res = await client.post<
     Omit<Omit<Connection, "name">, ConnectionOutputOnlyFields>,
     Operation
   >(
     `projects/${projectId}/locations/${location}/connections`,
-    { githubConfig: {} },
+    { githubConfig },
     { queryParams: { connectionId } }
   );
   return res.body;

src/init/features/frameworks/index.ts

@@ -1,170 +1,171 @@
 import * as clc from "colorette";
 import * as utils from "../../../utils";
-import { logger } from "../../../logger";
-import { promptOnce } from "../../../prompt";
-import { DEFAULT_REGION, ALLOWED_REGIONS } from "./constants";
 import * as repo from "./repo";
-import { Backend, BackendOutputOnlyFields } from "../../../gcp/frameworks";
-import { Repository } from "../../../gcp/cloudbuild";
 import * as poller from "../../../operation-poller";
-import { frameworksOrigin } from "../../../api";
 import * as gcp from "../../../gcp/frameworks";
-import { API_VERSION } from "../../../gcp/frameworks";
-import { FirebaseError } from "../../../error";
+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";
 
 const frameworksPollerOptions: Omit<poller.OperationPollerOptions, "operationResourceName"> = {
-  apiOrigin: frameworksOrigin,
-  apiVersion: API_VERSION,
-  masterTimeout: 25 * 60 * 1_000,
-  maxBackoff: 10_000,
+    apiOrigin: frameworksOrigin,
+    apiVersion: API_VERSION,
+    masterTimeout: 25 * 60 * 1_000,
+    maxBackoff: 10_000,
 };
 
 /**
  * Setup new frameworks project.
  */
 export async function doSetup(setup: any, projectId: string): Promise<void> {
-  setup.frameworks = {};
+    setup.frameworks = {};
 
-  utils.logBullet("First we need a few details to create your backend.");
+    utils.logBullet("First we need a few details to create your backend.");
 
-  await promptOnce(
-    {
-      name: "serviceName",
-      type: "input",
-      default: "acme-inc-web",
-      message: "Create a name for your backend [1-30 characters]",
-    },
-    setup.frameworks
-  );
+    await promptOnce(
+        {
+            name: "serviceName",
+            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
-  );
+    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}.`);
+    utils.logSuccess(`Region set to ${setup.frameworks.region}.`);
 
-  const backend: Backend | undefined = await getOrCreateBackend(projectId, setup);
-  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}`
-    );
-    logger.info();
-  }
+    const backend: Backend | undefined = await getOrCreateBackend(projectId, setup);
+
+    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}`
+        );
+        logger.info();
+    }
 }
 
 function toBackend(cloudBuildConnRepo: Repository): Omit<Backend, BackendOutputOnlyFields> {
-  return {
-    codebase: {
-      repository: `${cloudBuildConnRepo.name}`,
-      rootDirectory: "/",
-    },
-    labels: {},
-  };
+    return {
+        codebase: {
+            repository: `${cloudBuildConnRepo.name}`,
+            rootDirectory: "/",
+        },
+        labels: {},
+    };
 }
 
 /**
  * Creates backend if it doesn't exist.
  */
 export async function getOrCreateBackend(
-  projectId: string,
-  setup: any
+    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}`
-      );
+    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;
+    return undefined;
 }
 
 async function getExistingBackend(
-  projectId: string,
-  setup: any,
-  location: string
+    projectId: string,
+    setup: any,
+    location: 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;
+    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;
     }
-    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;
+    return backend;
 }
 
 /**
  * Creates backend object from long running operations.
  */
 export async function createBackend(
-  projectId: string,
-  location: string,
-  backendReqBoby: Omit<Backend, BackendOutputOnlyFields>,
-  backendId: string
+    projectId: string,
+    location: string,
+    backendReqBoby: Omit<Backend, BackendOutputOnlyFields>,
+    backendId: string
 ): Promise<Backend> {
-  const op = await gcp.createBackend(projectId, location, backendReqBoby, backendId);
-  const backend = await poller.pollOperation<Backend>({
-    ...frameworksPollerOptions,
-    pollerName: `create-${projectId}-${location}-${backendId}`,
-    operationResourceName: op.name,
-  });
+    const op = await gcp.createBackend(projectId, location, backendReqBoby, backendId);
+    const backend = await poller.pollOperation<Backend>({
+        ...frameworksPollerOptions,
+        pollerName: `create-${projectId}-${location}-${backendId}`,
+        operationResourceName: op.name,
+    });
 
-  return backend;
+    return backend;
 }