Fix data connect emulator listen address. (#7211)

* Fix data connect emulator listen address.

* Add PR link to CHANGELOG.md.

Author: yuchenshi

CHANGELOG.md

@@ -1,2 +1,3 @@
 - Fixes an issue where dataconnect:sql:migrate still prompts for confirmation even with `--force`. (#7208)
 - Update to Firebase Data Connect Emulator version 1.1.18 which contains code generation bug fixes, surfacing schema migration errors when a diff remains after migration, and a fix to allow the local connection string to be empty at startup.
+- Fixes an issue where the dataconnect emulator listens on all addresses by default instead of just localhost (#7211).

src/commands/dataconnect-sdk-generate.ts

@@ -2,7 +2,7 @@ import * as path from "path";
 
 import { Command } from "../command";
 import { Options } from "../options";
-import { DataConnectEmulator, DataConnectEmulatorArgs } from "../emulator/dataconnectEmulator";
+import { DataConnectEmulator } from "../emulator/dataconnectEmulator";
 import { needProjectId } from "../projectUtils";
 import { load } from "../dataconnect/load";
 import { readFirebaseJson } from "../dataconnect/fileUtils";
@@ -21,16 +21,12 @@ export const command = new Command("dataconnect:sdk:generate")
         configDir = path.resolve(path.join(cwd), configDir);
       }
       const serviceInfo = await load(projectId, service.location, configDir);
-      const args: DataConnectEmulatorArgs = {
-        projectId,
-        configDir,
-        auto_download: true,
-        rc: options.rc,
-        locationId: service.location,
-      };
-      const dataconnectEmulator = new DataConnectEmulator(args);
       for (const conn of serviceInfo.connectorInfo) {
-        const output = await dataconnectEmulator.generate(conn.connectorYaml.connectorId);
+        const output = await DataConnectEmulator.generate({
+          configDir,
+          locationId: service.location,
+          connectorId: conn.connectorYaml.connectorId,
+        });
         logger.info(output);
         logger.info(`Generated SDKs for ${conn.connectorYaml.connectorId}`);
       }

src/dataconnect/build.ts

@@ -1,20 +1,11 @@
-import { DataConnectEmulator, DataConnectEmulatorArgs } from "../emulator/dataconnectEmulator";
+import { DataConnectEmulator } from "../emulator/dataconnectEmulator";
 import { Options } from "../options";
 import { FirebaseError } from "../error";
 import { prettify } from "./graphqlError";
 import { DeploymentMetadata } from "./types";
 
 export async function build(options: Options, configDir: string): Promise<DeploymentMetadata> {
-  // We can build even if there is no project declared.
-  const projectId = options.project ?? "demo-test";
-  const args: DataConnectEmulatorArgs = {
-    projectId,
-    configDir,
-    auto_download: true,
-    rc: options.rc,
-  };
-  const dataconnectEmulator = new DataConnectEmulator(args);
-  const buildResult = await dataconnectEmulator.build();
+  const buildResult = await DataConnectEmulator.build({ configDir });
   if (buildResult?.errors?.length) {
     throw new FirebaseError(
       `There are errors in your schema and connector files:\n${buildResult.errors.map(prettify).join("\n")}`,

src/emulator/controller.ts

@@ -821,7 +821,6 @@ export async function startAll(
   }
 
   if (listenForEmulator.dataconnect) {
-    const dataConnectAddr = legacyGetFirstAddr(Emulators.DATACONNECT);
     const config = readFirebaseJson(options.config);
     if (!config.length) {
       throw new FirebaseError("No Data Connect service found in firebase.json");
@@ -836,8 +835,7 @@ export async function startAll(
       configDir = path.resolve(path.join(cwd), configDir);
     }
     const dataConnectEmulator = new DataConnectEmulator({
-      host: dataConnectAddr.host,
-      port: dataConnectAddr.port,
+      listen: listenForEmulator.dataconnect,
       projectId,
       auto_download: true,
       configDir,

src/emulator/dataconnectEmulator.ts

@@ -3,32 +3,39 @@ import * as childProcess from "child_process";
 import { dataConnectLocalConnString } from "../api";
 import { Constants } from "./constants";
 import { getPID, start, stop, downloadIfNecessary } from "./downloadableEmulators";
-import { EmulatorInfo, EmulatorInstance, Emulators } from "./types";
+import { EmulatorInfo, EmulatorInstance, Emulators, ListenSpec } from "./types";
 import { FirebaseError } from "../error";
 import { EmulatorLogger } from "./emulatorLogger";
 import { RC } from "../rc";
 import { BuildResult, requiresVector } from "../dataconnect/types";
+import { listenSpecsToString } from "./portUtils";
 
 export interface DataConnectEmulatorArgs {
   projectId?: string;
-  port?: number;
-  host?: string;
-  configDir?: string;
+  listen: ListenSpec[];
+  configDir: string;
   locationId?: string;
   auto_download?: boolean;
   rc: RC;
 }
 
-const grpcDefaultPort = 9510;
+export interface DataConnectGenerateArgs {
+  configDir: string;
+  locationId: string;
+  connectorId: string;
+}
+
+export interface DataConnectBuildArgs {
+  configDir: string;
+}
 
 export class DataConnectEmulator implements EmulatorInstance {
   constructor(private args: DataConnectEmulatorArgs) {}
   private logger = EmulatorLogger.forEmulator(Emulators.DATACONNECT);
 
   async start(): Promise<void> {
-    const port = this.args.port || Constants.getDefaultPort(Emulators.DATACONNECT);
     this.logger.log("DEBUG", `Using Postgres connection string: ${this.getLocalConectionString()}`);
-    const info = await this.build();
+    const info = await DataConnectEmulator.build({ configDir: this.args.configDir });
     if (requiresVector(info.metadata)) {
       if (Constants.isDemoProject(this.args.projectId)) {
         this.logger.logLabeled(
@@ -46,8 +53,7 @@ export class DataConnectEmulator implements EmulatorInstance {
     }
     return start(Emulators.DATACONNECT, {
       ...this.args,
-      http_port: port,
-      grpc_port: grpcDefaultPort,
+      listen: listenSpecsToString(this.args.listen),
       config_dir: this.args.configDir,
       local_connection_string: this.getLocalConectionString(),
       project_id: this.args.projectId,
@@ -65,13 +71,11 @@ export class DataConnectEmulator implements EmulatorInstance {
   }
 
   getInfo(): EmulatorInfo {
-    const host = this.args.host || Constants.getDefaultHost();
-    const port = this.args.port || Constants.getDefaultPort(Emulators.DATACONNECT);
-
     return {
       name: this.getName(),
-      host,
-      port,
+      listen: this.args.listen,
+      host: this.args.listen[0].address,
+      port: this.args.listen[0].port,
       pid: getPID(Emulators.DATACONNECT),
       timeout: 10_000,
     };
@@ -80,26 +84,33 @@ export class DataConnectEmulator implements EmulatorInstance {
     return Emulators.DATACONNECT;
   }
 
-  async generate(connectorId: string): Promise<string> {
+  static async generate(args: DataConnectGenerateArgs): Promise<string> {
     const commandInfo = await downloadIfNecessary(Emulators.DATACONNECT);
     const cmd = [
       "generate",
-      `--service_location=${this.args.locationId}`,
-      `--config_dir=${this.args.configDir}`,
-      `--connector_id=${connectorId}`,
+      `--service_location=${args.locationId}`,
+      `--config_dir=${args.configDir}`,
+      `--connector_id=${args.connectorId}`,
     ];
     const res = childProcess.spawnSync(commandInfo.binary, cmd, { encoding: "utf-8" });
     if (res.error) {
-      throw new FirebaseError(`Error starting up Data Connect emulator: ${res.error}`);
+      throw new FirebaseError(`Error starting up Data Connect generate: ${res.error.message}`, {
+        original: res.error,
+      });
     }
     return res.stdout;
   }
 
-  async build(): Promise<BuildResult> {
+  static async build(args: DataConnectBuildArgs): Promise<BuildResult> {
     const commandInfo = await downloadIfNecessary(Emulators.DATACONNECT);
-    const cmd = ["build", `--config_dir=${this.args.configDir}`];
+    const cmd = ["build", `--config_dir=${args.configDir}`];
 
     const res = childProcess.spawnSync(commandInfo.binary, cmd, { encoding: "utf-8" });
+    if (res.error) {
+      throw new FirebaseError(`Error starting up Data Connect build: ${res.error.message}`, {
+        original: res.error,
+      });
+    }
     if (res.stderr) {
       throw new FirebaseError(
         `Unable to build your Data Connect schema and connectors: ${res.stderr}`,

src/emulator/downloadableEmulators.ts

@@ -281,7 +281,7 @@ const Commands: { [s in DownloadableEmulators]: DownloadableEmulatorCommand } =
   dataconnect: {
     binary: getExecPath(Emulators.DATACONNECT),
     args: ["dev"],
-    optionalArgs: ["http_port", "grpc_port", "config_dir", "local_connection_string", "project_id"],
+    optionalArgs: ["listen", "config_dir", "local_connection_string", "project_id"],
     joinArgs: true,
     shell: true,
   },

src/emulator/portUtils.ts

@@ -184,7 +184,9 @@ const EMULATOR_CAN_LISTEN_ON_PRIMARY_ONLY: Record<PortName, boolean> = {
   firestore: true,
   "firestore.websocket": true,
   pubsub: true,
-  dataconnect: true,
+
+  // External processes that accepts multiple listen specs.
+  dataconnect: false,
 
   // Listening on multiple addresses to maximize the chance of discovery.
   hub: false,
@@ -463,3 +465,15 @@ function listenSpec(lookup: dns.LookupAddress, port: number): ListenSpec {
     port: port,
   };
 }
+
+/**
+ * Return a comma-separated list of host:port from specs.
+ */
+export function listenSpecsToString(specs: ListenSpec[]): string {
+  return specs
+    .map((spec) => {
+      const host = spec.family === "IPv4" ? spec.address : `[${spec.address}]`;
+      return `${host}:${spec.port}`;
+    })
+    .join(",");
+}