Ensure API is enabled for frameworks commands.

Author: taeold

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,6 +7,8 @@ import { promptOnce } from "../prompt";
 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;
@@ -24,6 +26,7 @@ export const command = new Command("backends:delete")
   .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;

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,6 +5,7 @@ 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;
@@ -19,6 +20,7 @@ const TABLE_HEAD = [
 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/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({
@@ -162,3 +165,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");
+}

src/init/features/frameworks/repo.ts

@@ -158,6 +158,14 @@ async function promptRepositoryUri(
 
 async function promptConnectionAuth(conn: gcb.Connection): Promise<gcb.Connection> {
   logger.info("You must authorize the Cloud Build GitHub app.");
+  // TODO: ensure that IAM permission exists
+  // check if getIamPolicy works.
+  //   1. Bail out early, give caution, but proceed
+  // Check if policy exists. Is needed policy is not there
+  // try to set the policy
+  //   2. Bail out early, give caution and guideance
+  //   3. PROCEED
+  // Bail if the user doesn't have permission
   logger.info();
   logger.info("First, sign in to GitHub and authorize Cloud Build GitHub app:");
   const cleanup = await utils.openInBrowserPopup(