feat(dataconnect): Update dataconnect:* commands to use flags for --service & --location

CHANGELOG.md

@@ -5,3 +5,4 @@
 - Add a confirmation in `firebase init dataconnect` before asking for app idea description. (#9282)
 - [BREAKING] Removed deprecated `firebase --open-sesame` and `firebase --close-sesame` commands. Use `firebase experiments:enable` and `firebase experiments:disable` instead.
 - [BREAKING] Enforce strict timeout validation for functions. (#9540)
+- [BREAKING] Update `dataconnect:\*` commands to use flags instead of positional arguments for `--service` & `--location`. Changed output type of `dataconnect:sql:migrate --json` (#9312)

src/commands/dataconnect-execute.ts

@@ -2,7 +2,7 @@ import * as clc from "colorette";
 import { Command } from "../command";
 import { Options } from "../options";
 import { getProjectId, needProjectId } from "../projectUtils";
-import { pickService, readGQLFiles, squashGraphQL } from "../dataconnect/load";
+import { pickOneService, readGQLFiles, squashGraphQL } from "../dataconnect/load";
 import { requireAuth } from "../requireAuth";
 import { Constants } from "../emulator/constants";
 import { Client } from "../apiv2";
@@ -207,7 +207,12 @@ export const command = new Command("dataconnect:execute [file] [operationName]")
       }
 
       async function getServiceInfo(): Promise<ServiceInfo> {
-        return pickService(projectId, options.config, serviceId || undefined).catch((e) => {
+        return pickOneService(
+          projectId,
+          options.config,
+          serviceId || undefined,
+          locationId || undefined,
+        ).catch((e: unknown) => {
           if (!(e instanceof FirebaseError)) {
             return Promise.reject(e);
           }

src/commands/dataconnect-sdk-generate.ts

@@ -4,7 +4,7 @@ import { Command } from "../command";
 import { Options } from "../options";
 import { DataConnectEmulator } from "../emulator/dataconnectEmulator";
 import { getProjectId } from "../projectUtils";
-import { loadAll } from "../dataconnect/load";
+import { pickServices } from "../dataconnect/load";
 import { getProjectDefaultAccount } from "../auth";
 import { logBullet, logLabeledSuccess, logWarning } from "../utils";
 import { ServiceInfo } from "../dataconnect/types";
@@ -16,10 +16,18 @@ import { FirebaseError } from "../error";
 import { postInitSaves } from "./init";
 import { EmulatorHub } from "../emulator/hub";
 
-type GenerateOptions = Options & { watch?: boolean };
+type GenerateOptions = Options & { watch?: boolean; service?: string; location?: string };
 
 export const command = new Command("dataconnect:sdk:generate")
-  .description("generate typed SDKs for your Data Connect connectors")
+  .description("generate typed SDKs to use Data Connect in your apps")
+  .option(
+    "--service <serviceId>",
+    "the serviceId of the Data Connect service. If not provided, generates SDKs for all services.",
+  )
+  .option(
+    "--location <location>",
+    "the location of the Data Connect service. Only needed if service ID is used in multiple locations.",
+  )
   .option(
     "--watch",
     "watch for changes to your connector GQL files and regenerate your SDKs when updates occur",
@@ -59,7 +67,7 @@ export const command = new Command("dataconnect:sdk:generate")
       options.config = config;
     }
 
-    let serviceInfosWithSDKs = await loadAllWithSDKs(projectId, config);
+    let serviceInfosWithSDKs = await loadAllWithSDKs(projectId, config, options);
     if (!serviceInfosWithSDKs.length) {
       if (justRanInit || options.nonInteractive) {
         throw new FirebaseError(
@@ -82,7 +90,7 @@ export const command = new Command("dataconnect:sdk:generate")
       await dataconnectSdkInit.askQuestions(setup);
       await dataconnectSdkInit.actuate(setup, config);
       justRanInit = true;
-      serviceInfosWithSDKs = await loadAllWithSDKs(projectId, config);
+      serviceInfosWithSDKs = await loadAllWithSDKs(projectId, config, options);
     }
 
     await generateSDKsInAll(options, serviceInfosWithSDKs, justRanInit);
@@ -91,8 +99,14 @@ export const command = new Command("dataconnect:sdk:generate")
 async function loadAllWithSDKs(
   projectId: string | undefined,
   config: Config,
+  options: GenerateOptions,
 ): Promise<ServiceInfo[]> {
-  const serviceInfos = await loadAll(projectId || EmulatorHub.MISSING_PROJECT_PLACEHOLDER, config);
+  const serviceInfos = await pickServices(
+    projectId || EmulatorHub.MISSING_PROJECT_PLACEHOLDER,
+    config,
+    options.service,
+    options.location,
+  );
   return serviceInfos.filter((serviceInfo) =>
     serviceInfo.connectorInfo.some((c) => {
       return (

src/commands/dataconnect-sql-diff.ts

@@ -3,30 +3,42 @@ import { Options } from "../options";
 import { needProjectId } from "../projectUtils";
 import { ensureApis } from "../dataconnect/ensureApis";
 import { requirePermissions } from "../requirePermissions";
-import { pickService } from "../dataconnect/load";
+import { pickOneService } from "../dataconnect/load";
 import { diffSchema } from "../dataconnect/schemaMigration";
 import { requireAuth } from "../requireAuth";
 import { mainSchema, mainSchemaYaml } from "../dataconnect/types";
 
-export const command = new Command("dataconnect:sql:diff [serviceId]")
+type DiffOptions = Options & { service?: string; location?: string };
+
+export const command = new Command("dataconnect:sql:diff")
   .description(
-    "display the differences between a local Data Connect schema and your CloudSQL database's current schema",
+    "display the differences between the local Data Connect schema and your CloudSQL database's schema",
+  )
+  .option("--service <serviceId>", "the serviceId of the Data Connect service")
+  .option(
+    "--location <location>",
+    "the location of the Data Connect service. Only needed if service ID is used in multiple locations.",
   )
   .before(requirePermissions, [
     "firebasedataconnect.services.list",
     "firebasedataconnect.schemas.list",
     "firebasedataconnect.schemas.update",
   ])
   .before(requireAuth)
-  .action(async (serviceId: string, options: Options) => {
+  .action(async (options: DiffOptions) => {
     const projectId = needProjectId(options);
     await ensureApis(projectId);
-    const serviceInfo = await pickService(projectId, options.config, serviceId);
+    const serviceInfo = await pickOneService(
+      projectId,
+      options.config,
+      options.service,
+      options.location,
+    );
 
     const diffs = await diffSchema(
       options,
       mainSchema(serviceInfo.schemas),
       mainSchemaYaml(serviceInfo.dataConnectYaml).datasource.postgresql?.schemaValidation,
     );
-    return { projectId, serviceId, diffs };
+    return { projectId, diffs };
   });