Switching lots of API name magic strings to <product>Origin (#6805)

Author: joehan

src/api.ts

@@ -189,6 +189,7 @@ export const secretManagerOrigin = utils.envOverride(
   "CLOUD_SECRET_MANAGER_URL",
   "https://secretmanager.googleapis.com",
 );
+export const computeOrigin = utils.envOverride("COMPUTE_URL", "https://compute.googleapis.com");
 export const githubClientId = utils.envOverride("GITHUB_CLIENT_ID", "89cf50f02ac6aaed3484");
 export const githubClientSecret = utils.envOverride(
   "GITHUB_CLIENT_SECRET",

src/deploy/extensions/v2FunctionHelper.ts

@@ -5,6 +5,7 @@ import { FirebaseError } from "../../error";
 import { ensure } from "../../ensureApiEnabled";
 import * as planner from "./planner";
 import { needProjectId } from "../../projectUtils";
+import { computeOrigin } from "../../api";
 
 const SERVICE_AGENT_ROLE = "roles/eventarc.eventReceiver";
 
@@ -21,7 +22,7 @@ export async function checkSpecForV2Functions(i: planner.InstanceSpec): Promise<
  */
 export async function ensureNecessaryV2ApisAndRoles(options: any) {
   const projectId = needProjectId(options);
-  await ensure(projectId, "compute.googleapis.com", "extensions", options.markdown);
+  await ensure(projectId, computeOrigin, "extensions", options.markdown);
   await ensureComputeP4SARole(projectId);
 }
 

src/deploy/functions/ensure.ts

@@ -8,10 +8,10 @@ import { logLabeledBullet, logLabeledSuccess } from "../../utils";
 import { ensureServiceAgentRole } from "../../gcp/secretManager";
 import { getFirebaseProject } from "../../management/projects";
 import { assertExhaustive } from "../../functional";
+import { cloudbuildOrigin } from "../../api";
 import * as backend from "./backend";
 
 const FAQ_URL = "https://firebase.google.com/support/faq#functions-runtime";
-const CLOUD_BUILD_API = "cloudbuild.googleapis.com";
 
 const metadataCallCache: Map<string, Promise<FirebaseProjectMetadata>> = new Map();
 
@@ -74,7 +74,7 @@ function isPermissionError(e: { context?: { body?: { error?: { status?: string }
  */
 export async function cloudBuildEnabled(projectId: string): Promise<void> {
   try {
-    await ensure(projectId, CLOUD_BUILD_API, "functions");
+    await ensure(projectId, cloudbuildOrigin, "functions");
   } catch (e: any) {
     if (isBillingError(e)) {
       throw nodeBillingError(projectId);

src/deploy/functions/prepare.ts

@@ -9,6 +9,15 @@ import * as functionsEnv from "../../functions/env";
 import * as runtimes from "./runtimes";
 import * as validate from "./validate";
 import * as ensure from "./ensure";
+import {
+  functionsOrigin,
+  artifactRegistryDomain,
+  runtimeconfigOrigin,
+  cloudRunApiOrigin,
+  eventarcOrigin,
+  pubsubOrigin,
+  storageOrigin,
+} from "../../api";
 import { Options } from "../../options";
 import {
   EndpointFilter,
@@ -62,15 +71,10 @@ export async function prepare(
 
   // ===Phase 0. Check that minimum APIs required for function deploys are enabled.
   const checkAPIsEnabled = await Promise.all([
-    ensureApiEnabled.ensure(projectId, "cloudfunctions.googleapis.com", "functions"),
-    ensureApiEnabled.check(
-      projectId,
-      "runtimeconfig.googleapis.com",
-      "runtimeconfig",
-      /* silent=*/ true,
-    ),
+    ensureApiEnabled.ensure(projectId, functionsOrigin, "functions"),
+    ensureApiEnabled.check(projectId, runtimeconfigOrigin, "runtimeconfig", /* silent=*/ true),
     ensure.cloudBuildEnabled(projectId),
-    ensureApiEnabled.ensure(projectId, "artifactregistry.googleapis.com", "artifactregistry"),
+    ensureApiEnabled.ensure(projectId, artifactRegistryDomain, "artifactregistry"),
   ]);
 
   // Get the Firebase Config, and set it on each function in the deployment.
@@ -234,12 +238,7 @@ export async function prepare(
     // Note: Some of these are premium APIs that require billing to be enabled.
     // We'd eventually have to add special error handling for billing APIs, but
     // enableCloudBuild is called above and has this special casing already.
-    const V2_APIS = [
-      "run.googleapis.com",
-      "eventarc.googleapis.com",
-      "pubsub.googleapis.com",
-      "storage.googleapis.com",
-    ];
+    const V2_APIS = [cloudRunApiOrigin, eventarcOrigin, pubsubOrigin, storageOrigin];
     const enablements = V2_APIS.map((api) => {
       return ensureApiEnabled.ensure(context.projectId, api, "functions");
     });

src/ensureApiEnabled.ts

@@ -19,16 +19,17 @@ const apiClient = new Client({
 /**
  * Check if the specified API is enabled.
  * @param projectId The project on which to check enablement.
- * @param apiName The name of the API e.g. `someapi.googleapis.com`.
+ * @param apiUri The name of the API e.g. `someapi.googleapis.com`.
  * @param prefix The logging prefix to use when printing messages about enablement.
  * @param silent Whether or not to print log messages.
  */
 export async function check(
   projectId: string,
-  apiName: string,
+  apiUri: string,
   prefix: string,
   silent = false,
 ): Promise<boolean> {
+  const apiName = apiUri.startsWith("http") ? new URL(apiUri).hostname : apiUri;
   const res = await apiClient.get<{ state: string }>(`/projects/${projectId}/services/${apiName}`, {
     headers: { "x-goog-quota-user": `projects/${projectId}` },
     skipLog: { resBody: true },
@@ -148,27 +149,28 @@ async function enableApiWithRetries(
  * Check if an API is enabled on a project, try to enable it if not with polling and retries.
  *
  * @param projectId The project on which to check enablement.
- * @param apiName The name of the API e.g. `someapi.googleapis.com`.
+ * @param apiUri The name of the API e.g. `someapi.googleapis.com`.
  * @param prefix The logging prefix to use when printing messages about enablement.
  * @param silent Whether or not to print log messages.
  */
 export async function ensure(
   projectId: string,
-  apiName: string,
+  apiUri: string,
   prefix: string,
   silent = false,
 ): Promise<void> {
+  const hostname = apiUri.startsWith("http") ? new URL(apiUri).hostname : apiUri;
   if (!silent) {
-    utils.logLabeledBullet(prefix, `ensuring required API ${bold(apiName)} is enabled...`);
+    utils.logLabeledBullet(prefix, `ensuring required API ${bold(hostname)} is enabled...`);
   }
-  const isEnabled = await check(projectId, apiName, prefix, silent);
+  const isEnabled = await check(projectId, hostname, prefix, silent);
   if (isEnabled) {
     return;
   }
   if (!silent) {
-    utils.logLabeledWarning(prefix, `missing required API ${bold(apiName)}. Enabling now...`);
+    utils.logLabeledWarning(prefix, `missing required API ${bold(hostname)}. Enabling now...`);
   }
-  return enableApiWithRetries(projectId, apiName, prefix, silent);
+  return enableApiWithRetries(projectId, hostname, prefix, silent);
 }
 
 /**

src/extensions/extensionsHelper.ts

@@ -13,7 +13,7 @@ marked.setOptions({
   renderer: new TerminalRenderer(),
 });
 
-import { storageOrigin } from "../api";
+import { extensionsOrigin, extensionsPublisherOrigin, storageOrigin } from "../api";
 import { archiveDirectory } from "../archiveDirectory";
 import { convertOfficialExtensionsToList } from "./utils";
 import { getFirebaseConfig } from "../functionsConfig";
@@ -488,25 +488,15 @@ export async function ensureExtensionsApiEnabled(options: any): Promise<void> {
   if (!projectId) {
     return;
   }
-  return await ensure(
-    projectId,
-    "firebaseextensions.googleapis.com",
-    "extensions",
-    options.markdown,
-  );
+  return await ensure(projectId, extensionsOrigin, "extensions", options.markdown);
 }
 
 export async function ensureExtensionsPublisherApiEnabled(options: any): Promise<void> {
   const projectId = getProjectId(options);
   if (!projectId) {
     return;
   }
-  return await ensure(
-    projectId,
-    "firebaseextensionspublisher.googleapis.com",
-    "extensions",
-    options.markdown,
-  );
+  return await ensure(projectId, extensionsPublisherOrigin, "extensions", options.markdown);
 }
 
 /**

src/extensions/secretsUtils.ts

@@ -5,13 +5,14 @@ import { needProjectId } from "../projectUtils";
 import { ExtensionInstance, ExtensionSpec, ParamType } from "./types";
 import * as secretManagerApi from "../gcp/secretManager";
 import { logger } from "../logger";
+import { secretManagerOrigin } from "../api";
 
 export const SECRET_LABEL = "firebase-extensions-managed";
 export const SECRET_ROLE = "secretmanager.secretAccessor";
 
 export async function ensureSecretManagerApiEnabled(options: any): Promise<void> {
   const projectId = needProjectId(options);
-  return await ensure(projectId, "secretmanager.googleapis.com", "extensions", options.markdown);
+  return await ensure(projectId, secretManagerOrigin, "extensions", options.markdown);
 }
 
 export function usesSecrets(spec: ExtensionSpec): boolean {

src/functions/secrets.ts

@@ -4,7 +4,7 @@ import * as gcfV1 from "../gcp/cloudfunctions";
 import * as gcfV2 from "../gcp/cloudfunctionsv2";
 import * as backend from "../deploy/functions/backend";
 import * as ensureApiEnabled from "../ensureApiEnabled";
-import { functionsOrigin, functionsV2Origin } from "../api";
+import { functionsOrigin, functionsV2Origin, secretManagerOrigin } from "../api";
 import {
   createSecret,
   destroySecretVersion,
@@ -78,7 +78,7 @@ function toUpperSnakeCase(key: string): string {
  */
 export function ensureApi(options: any): Promise<void> {
   const projectId = needProjectId(options);
-  return ensureApiEnabled.ensure(projectId, "secretmanager.googleapis.com", "secretmanager", true);
+  return ensureApiEnabled.ensure(projectId, secretManagerOrigin, "secretmanager", true);
 }
 
 /**

src/gcp/apphosting.ts

@@ -7,7 +7,6 @@ import * as deploymentTool from "../deploymentTool";
 import { FirebaseError } from "../error";
 import { DeepOmit, RecursiveKeyOf, assertImplements } from "../metaprogramming";
 
-export const API_HOST = new URL(apphostingOrigin).host;
 export const API_VERSION = "v1alpha";
 
 export const client = new Client({
@@ -503,7 +502,7 @@ export async function listLocations(projectId: string): Promise<Location[]> {
  */
 export async function ensureApiEnabled(options: any): Promise<void> {
   const projectId = needProjectId(options);
-  return await ensure(projectId, API_HOST, "app hosting", true);
+  return await ensure(projectId, apphostingOrigin, "app hosting", true);
 }
 
 /**

src/gcp/storage.ts

@@ -149,7 +149,7 @@ interface StorageServiceAccountResponse {
 }
 
 export async function getDefaultBucket(projectId: string): Promise<string> {
-  await ensure(projectId, "firebasestorage.googleapis.com", "storage", false);
+  await ensure(projectId, firebaseStorageOrigin, "storage", false);
   try {
     const localAPIClient = new Client({ urlPrefix: firebaseStorageOrigin, apiVersion: "v1alpha" });
     const response = await localAPIClient.get<GetDefaultBucketResponse>(