[FDC] Print a warning if the FDC env override didn't match anything (#8677)

Author: fredzqm

src/init/features/dataconnect/index.ts

@@ -19,7 +19,7 @@ import { Schema, Service, File, Platform } from "../../../dataconnect/types";
 import { parseCloudSQLInstanceName, parseServiceName } from "../../../dataconnect/names";
 import { logger } from "../../../logger";
 import { readTemplateSync } from "../../../templates";
-import { logBullet, envOverride } from "../../../utils";
+import { logBullet, logWarning, envOverride } from "../../../utils";
 import { isBillingEnabled } from "../../../gcp/cloudbilling";
 import * as sdk from "./sdk";
 import { getPlatformFromFolder } from "../../../dataconnect/fileUtils";
@@ -30,11 +30,6 @@ const SCHEMA_TEMPLATE = readTemplateSync("init/dataconnect/schema.gql");
 const QUERIES_TEMPLATE = readTemplateSync("init/dataconnect/queries.gql");
 const MUTATIONS_TEMPLATE = readTemplateSync("init/dataconnect/mutations.gql");
 
-// serviceEnvVar is used by Firebase Console to specify which service to import.
-// It should be in the form <location>/<serviceId>
-// It must be an existing service - if set to anything else, we'll ignore it.
-const serviceEnvVar = () => envOverride("FDC_CONNECTOR", "") || envOverride("FDC_SERVICE", "");
-
 export interface RequiredInfo {
   serviceId: string;
   locationId: string;
@@ -318,23 +313,37 @@ interface serviceAndSchema {
   schema?: Schema;
 }
 
+/**
+ * Picks create new service or an existing service from the list of services.
+ *
+ * Firebase Console can provide `FDC_CONNECTOR` or `FDC_SERVICE` environment variable.
+ * If either is present, chooseExistingService try to match it with any existing service
+ * and short-circuit the prompt.
+ *
+ * `FDC_SERVICE` should have the format `<location>/<serviceId>`.
+ * `FDC_CONNECTOR` should have the same `<location>/<serviceId>/<connectorId>`.
+ * @param existing
+ */
 async function chooseExistingService(
   existing: serviceAndSchema[],
 ): Promise<serviceAndSchema | undefined> {
-  const [serviceLocationFromEnvVar, serviceIdFromEnvVar] = serviceEnvVar().split("/");
-  const serviceFromEnvVar = existing.find((s) => {
-    const serviceName = parseServiceName(s.service.name);
-    return (
-      serviceName.serviceId === serviceIdFromEnvVar &&
-      serviceName.location === serviceLocationFromEnvVar
-    );
-  });
-  if (serviceFromEnvVar) {
-    // FDC_CONNECTOR or FDC_SERVICE env var match an existing service.
-    logBullet(
-      `Picking up the existing service ${clc.bold(serviceLocationFromEnvVar + "/" + serviceIdFromEnvVar)}.`,
-    );
-    return serviceFromEnvVar;
+  const serviceEnvVar = envOverride("FDC_CONNECTOR", "") || envOverride("FDC_SERVICE", "");
+  if (serviceEnvVar) {
+    const [serviceLocationFromEnvVar, serviceIdFromEnvVar] = serviceEnvVar.split("/");
+    const serviceFromEnvVar = existing.find((s) => {
+      const serviceName = parseServiceName(s.service.name);
+      return (
+        serviceName.serviceId === serviceIdFromEnvVar &&
+        serviceName.location === serviceLocationFromEnvVar
+      );
+    });
+    if (serviceFromEnvVar) {
+      logBullet(
+        `Picking up the existing service ${clc.bold(serviceLocationFromEnvVar + "/" + serviceIdFromEnvVar)}.`,
+      );
+      return serviceFromEnvVar;
+    }
+    logWarning(`Unable to pick up an existing service based on FDC_SERVICE=${serviceEnvVar}.`);
   }
   const choices: Array<{ name: string; value: serviceAndSchema | undefined }> = existing.map(
     (s) => {

src/init/features/dataconnect/sdk.ts

@@ -26,14 +26,9 @@ import {
 import { DataConnectEmulator } from "../../../emulator/dataconnectEmulator";
 import { FirebaseError } from "../../../error";
 import { camelCase, snakeCase, upperFirst } from "lodash";
-import { logSuccess, logBullet, promptForDirectory, envOverride } from "../../../utils";
+import { logSuccess, logBullet, promptForDirectory, envOverride, logWarning } from "../../../utils";
 import { getGlobalDefaultAccount } from "../../../auth";
 
-// connectorEnvVar is used by Firebase Console to specify which connector to setup.
-// It should be in the form <connectorId>.
-// It's common to provide both FDC_SERVICE and FDC_CONNECTOR environment variables
-const connectorEnvVar = () => envOverride("FDC_CONNECTOR", "");
-
 export const FDC_APP_FOLDER = "_FDC_APP_FOLDER";
 export type SDKInfo = {
   connectorYamlContents: string;
@@ -146,17 +141,31 @@ interface connectorChoice {
   value: ConnectorInfo;
 }
 
+/**
+ * Picks an existing connector from those present in the local workspace.
+ *
+ * Firebase Console can provide `FDC_CONNECTOR` environment variable.
+ * If its is present, chooseExistingConnector try to match it with any existing connectors
+ * and short-circuit the prompt.
+ *
+ * `FDC_CONNECTOR` should have the same `<location>/<serviceId>/<connectorId>`.
+ * @param choices
+ */
 async function chooseExistingConnector(choices: connectorChoice[]): Promise<ConnectorInfo> {
   if (choices.length === 1) {
     // Only one connector available, use it.
     return choices[0].value;
   }
-  const nameFromEnvVar = connectorEnvVar();
-  const existingConnector = choices.find((c) => c.name === nameFromEnvVar);
-  if (existingConnector) {
-    // FDC_CONNECTOR env var match an existing connector.
-    logBullet(`Picking up the existing connector ${clc.bold(nameFromEnvVar)}.`);
-    return existingConnector.value;
+  const connectorEnvVar = envOverride("FDC_CONNECTOR", "");
+  if (connectorEnvVar) {
+    const existingConnector = choices.find((c) => c.name === connectorEnvVar);
+    if (existingConnector) {
+      logBullet(`Picking up the existing connector ${clc.bold(connectorEnvVar)}.`);
+      return existingConnector.value;
+    }
+    logWarning(
+      `Unable to pick up an existing connector based on FDC_CONNECTOR=${connectorEnvVar}.`,
+    );
   }
   return await select<ConnectorInfo>({
     message: "Which connector do you want set up a generated SDK for?",