Rename frameworks to apphosting.

Author: taeold

src/api.ts

@@ -179,9 +179,9 @@ export const serviceUsageOrigin = utils.envOverride(
   "FIREBASE_SERVICE_USAGE_URL",
   "https://serviceusage.googleapis.com"
 );
-export const frameworksOrigin = utils.envOverride(
-  "FRAMEWORKS_URL",
-  "https://placeholder.googleapis.com"
+export const apphostingOrigin = utils.envOverride(
+  "APPHOSTING_URL",
+  "https://firebaseapphosting.googleapis.com"
 );
 export const githubOrigin = utils.envOverride("GITHUB_URL", "https://github.com");
 export const githubApiOrigin = utils.envOverride("GITHUB_API_URL", "https://api.github.com");

src/commands/frameworks-backends-create.ts renamed to src/commands/apphosting-backends-create.ts

@@ -2,10 +2,10 @@ import { Command } from "../command";
 import { Options } from "../options";
 import { needProjectId } from "../projectUtils";
 import requireInteractive from "../requireInteractive";
-import { doSetup } from "../init/features/frameworks";
-import { ensureApiEnabled } from "../gcp/frameworks";
+import { doSetup } from "../init/features/apphosting";
+import { ensureApiEnabled } from "../gcp/apphosting";
 
-export const command = new Command("backends:create")
+export const command = new Command("apphosting:backends:create")
   .description("Create a backend in a Firebase project")
   .option("-l, --location <location>", "Specify the region of the backend", "")
   .before(ensureApiEnabled)

src/commands/frameworks-backends-delete.ts renamed to src/commands/apphosting-backends-delete.ts

@@ -2,12 +2,11 @@ import { Command } from "../command";
 import { Options } from "../options";
 import { needProjectId } from "../projectUtils";
 import { FirebaseError } from "../error";
-import * as gcp from "../gcp/frameworks";
 import { promptOnce } from "../prompt";
-import * as utils from "../utils";
 import { logger } from "../logger";
-import { DEFAULT_REGION } from "../init/features/frameworks/constants";
-import { ensureApiEnabled } from "../gcp/frameworks";
+import { DEFAULT_REGION } from "../init/features/apphosting/constants";
+import * as utils from "../utils";
+import * as apphosting from "../gcp/apphosting";
 
 const Table = require("cli-table");
 
@@ -21,12 +20,12 @@ const TABLE_HEAD = [
   "Updated Date",
 ];
 
-export const command = new Command("backends:delete")
+export const command = new Command("apphosting:backends:delete")
   .description("Delete a backend from a Firebase project")
   .option("-l, --location <location>", "App Backend location", "")
   .option("-s, --backend <backend>", "Backend Id", "")
   .withForce()
-  .before(ensureApiEnabled)
+  .before(apphosting.ensureApiEnabled)
   .action(async (options: Options) => {
     const projectId = needProjectId(options);
     let location = options.location as string;
@@ -36,7 +35,9 @@ export const command = new Command("backends:delete")
     }
 
     if (!location) {
-      const allowedLocations = (await gcp.listLocations(projectId)).map((loc) => loc.locationId);
+      const allowedLocations = (await apphosting.listLocations(projectId)).map(
+        (loc) => loc.locationId
+      );
       location = await promptOnce({
         name: "region",
         type: "list",
@@ -54,7 +55,7 @@ export const command = new Command("backends:delete")
 
     let backend;
     try {
-      backend = await gcp.getBackend(projectId, location, backendId);
+      backend = await apphosting.getBackend(projectId, location, backendId);
       populateTable(backend, table);
     } catch (err: any) {
       throw new FirebaseError(`No backends found with given parameters. Command aborted.`, {
@@ -79,7 +80,7 @@ export const command = new Command("backends:delete")
     }
 
     try {
-      await gcp.deleteBackend(projectId, location, backendId);
+      await apphosting.deleteBackend(projectId, location, backendId);
       utils.logSuccess(`Successfully deleted the backend: ${backendId}`);
     } catch (err: any) {
       throw new FirebaseError(
@@ -91,7 +92,7 @@ export const command = new Command("backends:delete")
     return backend;
   });
 
-function populateTable(backend: gcp.Backend, table: any) {
+function populateTable(backend: apphosting.Backend, table: any) {
   const [location, , backendId] = backend.name.split("/").slice(3, 6);
   const entry = [
     backendId,

src/commands/frameworks-backends-get.ts renamed to src/commands/apphosting-backends-get.ts

@@ -1,36 +1,35 @@
-import * as gcp from "../gcp/frameworks";
 import { Command } from "../command";
 import { Options } from "../options";
 import { needProjectId } from "../projectUtils";
 import { FirebaseError } from "../error";
 import { logger } from "../logger";
-import { ensureApiEnabled } from "../gcp/frameworks";
 import { logWarning } from "../utils";
+import * as apphosting from "../gcp/apphosting";
 
 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:get <backendId>")
+export const command = new Command("apphosting:backends:get <backendId>")
   .description("Get backend details of a Firebase project")
   .option("-l, --location <location>", "App Backend location", "-")
-  .before(ensureApiEnabled)
+  .before(apphosting.ensureApiEnabled)
   .action(async (backendId: string, options: Options) => {
     const projectId = needProjectId(options);
     const location = options.location as string;
 
-    let backendsList: gcp.Backend[] = [];
+    let backendsList: apphosting.Backend[] = [];
     const table = new Table({
       head: TABLE_HEAD,
       style: { head: ["green"] },
     });
     table.colWidths = COLUMN_LENGTH;
     try {
       if (location !== "-") {
-        const backendInRegion = await gcp.getBackend(projectId, location, backendId);
+        const backendInRegion = await apphosting.getBackend(projectId, location, backendId);
         backendsList.push(backendInRegion);
         populateTable(backendInRegion, table);
       } else {
-        const resp = await gcp.listBackends(projectId, "-");
+        const resp = await apphosting.listBackends(projectId, "-");
         const allBackends = resp.backends || [];
         backendsList = allBackends.filter((bkd) => bkd.name.split("/").pop() === backendId);
         backendsList.forEach((bkd) => populateTable(bkd, table));
@@ -49,7 +48,7 @@ export const command = new Command("backends:get <backendId>")
     return backendsList[0];
   });
 
-function populateTable(backend: gcp.Backend, table: any) {
+function populateTable(backend: apphosting.Backend, table: any) {
   const [location, , backendId] = backend.name.split("/").slice(3, 6);
   const entry = [
     backendId,

src/commands/frameworks-backends-list.ts renamed to src/commands/apphosting-backends-list.ts

@@ -1,18 +1,17 @@
 import { Command } from "../command";
 import { Options } from "../options";
 import { needProjectId } from "../projectUtils";
-import * as gcp from "../gcp/frameworks";
 import { FirebaseError } from "../error";
 import { logger } from "../logger";
-import { ensureApiEnabled } from "../gcp/frameworks";
+import * as apphosting from "../gcp/apphosting";
 
 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")
+export const command = new Command("apphosting:backends:list")
   .description("List backends of a Firebase project.")
   .option("-l, --location <location>", "App Backend location", "-")
-  .before(ensureApiEnabled)
+  .before(apphosting.ensureApiEnabled)
   .action(async (options: Options) => {
     const projectId = needProjectId(options);
     const location = options.location as string;
@@ -21,9 +20,9 @@ export const command = new Command("backends:list")
       style: { head: ["green"] },
     });
     table.colWidths = COLUMN_LENGTH;
-    const backendsList: gcp.Backend[] = [];
+    const backendsList: apphosting.Backend[] = [];
     try {
-      const backendsPerRegion = await gcp.listBackends(projectId, location);
+      const backendsPerRegion = await apphosting.listBackends(projectId, location);
       backendsList.push(...(backendsPerRegion.backends || []));
       populateTable(backendsList, table);
       logger.info(table.toString());
@@ -37,7 +36,7 @@ export const command = new Command("backends:list")
     return backendsList;
   });
 
-function populateTable(backends: gcp.Backend[], table: any) {
+function populateTable(backends: apphosting.Backend[], table: any) {
   for (const backend of backends) {
     const [location, , backendId] = backend.name.split("/").slice(3, 6);
     const entry = [

src/commands/index.ts

@@ -151,12 +151,12 @@ export function load(client: any): any {
     client.internaltesting.functions.discover = loadCommand("internaltesting-functions-discover");
   }
   if (experiments.isEnabled("internalframeworks")) {
-    client.frameworks = {};
-    client.frameworks.backends = {};
-    client.frameworks.backends.list = loadCommand("frameworks-backends-list");
-    client.frameworks.backends.create = loadCommand("frameworks-backends-create");
-    client.frameworks.backends.get = loadCommand("frameworks-backends-get");
-    client.frameworks.backends.delete = loadCommand("frameworks-backends-delete");
+    client.apphosting = {};
+    client.apphosting.backends = {};
+    client.apphosting.backends.list = loadCommand("apphosting-backends-list");
+    client.apphosting.backends.create = loadCommand("apphosting-backends-create");
+    client.apphosting.backends.get = loadCommand("apphosting-backends-get");
+    client.apphosting.backends.delete = loadCommand("apphosting-backends-delete");
   }
   client.login = loadCommand("login");
   client.login.add = loadCommand("login-add");

src/gcp/frameworks.ts renamed to src/gcp/apphosting.ts

@@ -1,13 +1,13 @@
 import { Client } from "../apiv2";
 import { needProjectId } from "../projectUtils";
-import { frameworksOrigin } from "../api";
+import { apphostingOrigin } from "../api";
 import { ensure } from "../ensureApiEnabled";
 
-export const API_HOST = new URL(frameworksOrigin).host;
+export const API_HOST = new URL(apphostingOrigin).host;
 export const API_VERSION = "v1alpha";
 
 const client = new Client({
-  urlPrefix: frameworksOrigin,
+  urlPrefix: apphostingOrigin,
   auth: true,
   apiVersion: API_VERSION,
 });

src/init/features/frameworks/constants.ts renamed to src/init/features/apphosting/constants.ts

@@ -1,38 +1,35 @@
 import * as clc from "colorette";
 import * as repo from "./repo";
 import * as poller from "../../../operation-poller";
-import * as gcp from "../../../gcp/frameworks";
+import * as apphosting from "../../../gcp/apphosting";
 import { logBullet, logSuccess, logWarning } from "../../../utils";
-import { frameworksOrigin } from "../../../api";
-import { Backend, BackendOutputOnlyFields } from "../../../gcp/frameworks";
+import { apphostingOrigin } from "../../../api";
+import { Backend, BackendOutputOnlyFields, API_VERSION } from "../../../gcp/apphosting";
 import { Repository } from "../../../gcp/cloudbuild";
-import { API_VERSION } from "../../../gcp/frameworks";
 import { FirebaseError } from "../../../error";
 import { promptOnce } from "../../../prompt";
 import { DEFAULT_REGION } from "./constants";
 import { ensure } from "../../../ensureApiEnabled";
 
-const frameworksPollerOptions: Omit<poller.OperationPollerOptions, "operationResourceName"> = {
-  apiOrigin: frameworksOrigin,
+const apphostingPollerOptions: Omit<poller.OperationPollerOptions, "operationResourceName"> = {
+  apiOrigin: apphostingOrigin,
   apiVersion: API_VERSION,
   masterTimeout: 25 * 60 * 1_000,
   maxBackoff: 10_000,
 };
 
 /**
- * Setup new frameworks project.
+ * Set up a new App Hosting backend.
  */
 export async function doSetup(setup: any, projectId: string): Promise<void> {
-  setup.frameworks = {};
-
   await Promise.all([
-    ensure(projectId, "cloudbuild.googleapis.com", "frameworks", true),
-    ensure(projectId, "secretmanager.googleapis.com", "frameworks", true),
-    ensure(projectId, "run.googleapis.com", "frameworks", true),
-    ensure(projectId, "artifactregistry.googleapis.com", "frameworks", true),
+    ensure(projectId, "cloudbuild.googleapis.com", "apphosting", true),
+    ensure(projectId, "secretmanager.googleapis.com", "apphosting", true),
+    ensure(projectId, "run.googleapis.com", "apphosting", true),
+    ensure(projectId, "artifactregistry.googleapis.com", "apphosting", true),
   ]);
 
-  const allowedLocations = (await gcp.listLocations(projectId)).map((loc) => loc.locationId);
+  const allowedLocations = (await apphosting.listLocations(projectId)).map((loc) => loc.locationId);
 
   if (setup.location) {
     if (!allowedLocations.includes(setup.location)) {
@@ -57,7 +54,7 @@ export async function doSetup(setup: any, projectId: string): Promise<void> {
       message: "Create a name for your backend [1-30 characters]",
     });
     try {
-      await gcp.getBackend(projectId, location, backendId);
+      await apphosting.getBackend(projectId, location, backendId);
     } catch (err: any) {
       if (err.status === 404) {
         break;
@@ -75,7 +72,7 @@ export async function doSetup(setup: any, projectId: string): Promise<void> {
     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 ${backendId} --project ${projectId}`
+      `View the rollout status by running:\n\tfirebase apphosting:backends:get ${backendId} --project ${projectId}`
     );
   }
 }
@@ -133,9 +130,9 @@ export async function createBackend(
   backendReqBoby: Omit<Backend, BackendOutputOnlyFields>,
   backendId: string
 ): Promise<Backend> {
-  const op = await gcp.createBackend(projectId, location, backendReqBoby, backendId);
+  const op = await apphosting.createBackend(projectId, location, backendReqBoby, backendId);
   const backend = await poller.pollOperation<Backend>({
-    ...frameworksPollerOptions,
+    ...apphostingPollerOptions,
     pollerName: `create-${projectId}-${location}-${backendId}`,
     operationResourceName: op.name,
   });

src/init/features/frameworks/index.ts renamed to src/init/features/apphosting/index.ts

@@ -15,8 +15,8 @@ export interface ConnectionNameParts {
   id: string;
 }
 
-const FRAMEWORKS_CONN_PATTERN = /.+\/frameworks-github-conn-.+$/;
-const FRAMEWORKS_OAUTH_CONN_NAME = "frameworks-github-oauth";
+const APPHOSTING_CONN_PATTERN = /.+\/apphosting-github-conn-.+$/;
+const APPHOSTING_OAUTH_CONN_NAME = "apphosting-github-oauth";
 const CONNECTION_NAME_REGEX =
   /^projects\/(?<projectId>[^\/]+)\/locations\/(?<location>[^\/]+)\/connections\/(?<id>[^\/]+)$/;
 
@@ -69,7 +69,7 @@ function generateRepositoryId(remoteUri: string): string | undefined {
  */
 function generateConnectionId(): string {
   const randomHash = Math.random().toString(36).slice(6);
-  return `frameworks-github-conn-${randomHash}`;
+  return `apphosting-github-conn-${randomHash}`;
 }
 
 /**
@@ -80,13 +80,13 @@ export async function linkGitHubRepository(
   location: string
 ): Promise<gcb.Repository> {
   utils.logBullet(clc.bold(`${clc.yellow("===")} Set up a GitHub connection`));
-  const existingConns = await listFrameworksConnections(projectId);
+  const existingConns = await listAppHostingConnections(projectId);
   if (existingConns.length < 1) {
     const grantSuccess = await promptSecretManagerAdminGrant(projectId);
     if (!grantSuccess) {
       throw new FirebaseError("Insufficient IAM permissions to create a new connection to GitHub");
     }
-    let oauthConn = await getOrCreateConnection(projectId, location, FRAMEWORKS_OAUTH_CONN_NAME);
+    let oauthConn = await getOrCreateConnection(projectId, location, APPHOSTING_OAUTH_CONN_NAME);
     while (oauthConn.installationState.stage === "PENDING_USER_OAUTH") {
       oauthConn = await promptConnectionAuth(oauthConn);
     }
@@ -301,11 +301,11 @@ export async function getOrCreateRepository(
   return repo;
 }
 
-export async function listFrameworksConnections(projectId: string) {
+export async function listAppHostingConnections(projectId: string) {
   const conns = await gcb.listConnections(projectId, "-");
   return conns.filter(
     (conn) =>
-      FRAMEWORKS_CONN_PATTERN.test(conn.name) &&
+      APPHOSTING_CONN_PATTERN.test(conn.name) &&
       conn.installationState.stage === "COMPLETE" &&
       !conn.disabled
   );