Fix bug where environment variables for an emulated function did not consider emulators running remotely. (#5269)

#5079 refactored the way to set environment variables on Functions Emulator. As implemented, the refactored function does not consider "remote" emulators i.e. emulator started by another instance of `emulators:start` command. This broke users who relies this to connect `functions:shell` command to the remote emulators.

Fixes #5225

Author: taeold

CHANGELOG.md

@@ -3,3 +3,4 @@
 - Support Next.js Middleware (#5320)
 - Log the reason for a Cloud Function if needed in Next.js (#5320)
 - Fixed service enablement when installing extensions with v2 functions (#5338)
+- Fix bug where functions:shell command didn't connect to emulators running on other processes. (#5269)

scripts/triggers-end-to-end-tests/tests.ts

@@ -330,7 +330,8 @@ async function runScript(script: string, extraEnv: Record<string, string>): Prom
 
   const env: NodeJS.ProcessEnv = { ...process.env, ...extraEnv };
 
-  setEnvVarsForEmulators(env);
+  const emulatorInfos = EmulatorRegistry.listRunningWithInfo();
+  setEnvVarsForEmulators(env, emulatorInfos);
 
   const proc = childProcess.spawn(script, {
     stdio: ["inherit", "inherit", "inherit"] as childProcess.StdioOptions,

src/emulator/commandUtils.ts

@@ -1,47 +1,43 @@
 import { Constants } from "./constants";
-import { Emulators } from "./types";
-import { EmulatorRegistry } from "./registry";
+import { EmulatorInfo, Emulators } from "./types";
+import { formatHost } from "./functionsEmulatorShared";
 
 /**
  * Adds or replaces emulator-related env vars (for Admin SDKs, etc.).
  * @param env a `process.env`-like object or Record to be modified
+ * @param emulators the emulator info to use
  */
-export function setEnvVarsForEmulators(env: Record<string, string | undefined>): void {
-  if (EmulatorRegistry.isRunning(Emulators.DATABASE)) {
-    env[Constants.FIREBASE_DATABASE_EMULATOR_HOST] = EmulatorRegistry.url(Emulators.DATABASE).host;
-  }
-
-  if (EmulatorRegistry.isRunning(Emulators.FIRESTORE)) {
-    const { host } = EmulatorRegistry.url(Emulators.FIRESTORE);
-    env[Constants.FIRESTORE_EMULATOR_HOST] = host;
-    env[Constants.FIRESTORE_EMULATOR_ENV_ALT] = host;
-  }
-
-  if (EmulatorRegistry.isRunning(Emulators.STORAGE)) {
-    const { host } = EmulatorRegistry.url(Emulators.STORAGE);
-    env[Constants.FIREBASE_STORAGE_EMULATOR_HOST] = host;
-    // The protocol is required for the Google Cloud Storage Node.js Client SDK.
-    env[Constants.CLOUD_STORAGE_EMULATOR_HOST] = `http://${host}`;
-  }
-
-  if (EmulatorRegistry.isRunning(Emulators.AUTH)) {
-    env[Constants.FIREBASE_AUTH_EMULATOR_HOST] = EmulatorRegistry.url(Emulators.AUTH).host;
-  }
-
-  if (EmulatorRegistry.isRunning(Emulators.HUB)) {
-    env[Constants.FIREBASE_EMULATOR_HUB] = EmulatorRegistry.url(Emulators.HUB).host;
-  }
-
-  const pubsubEmulator = EmulatorRegistry.isRunning(Emulators.PUBSUB);
-  if (pubsubEmulator) {
-    env[Constants.PUBSUB_EMULATOR_HOST] = EmulatorRegistry.url(Emulators.PUBSUB).host;
-  }
-
-  if (EmulatorRegistry.isRunning(Emulators.EVENTARC)) {
-    // The protocol is required for the Firebase Admin Node.js SDK for Eventarc.
-    // https://github.com/firebase/firebase-admin-node/blob/ee60cd1acb8722ba4081b9837d2f90101e2b3227/src/eventarc/eventarc-client-internal.ts#L105
-    env[Constants.CLOUD_EVENTARC_EMULATOR_HOST] = `http://${
-      EmulatorRegistry.url(Emulators.EVENTARC).host
-    }`;
+export function setEnvVarsForEmulators(
+  env: Record<string, string | undefined>,
+  emulators: EmulatorInfo[]
+): void {
+  for (const emu of emulators) {
+    const host = formatHost(emu);
+    switch (emu.name) {
+      case Emulators.FIRESTORE:
+        env[Constants.FIRESTORE_EMULATOR_HOST] = host;
+        env[Constants.FIRESTORE_EMULATOR_ENV_ALT] = host;
+        break;
+      case Emulators.DATABASE:
+        env[Constants.FIREBASE_DATABASE_EMULATOR_HOST] = host;
+        break;
+      case Emulators.STORAGE:
+        env[Constants.FIREBASE_STORAGE_EMULATOR_HOST] = host;
+        // The protocol is required for the Google Cloud Storage Node.js Client SDK.
+        env[Constants.CLOUD_STORAGE_EMULATOR_HOST] = `http://${host}`;
+        break;
+      case Emulators.AUTH:
+        env[Constants.FIREBASE_AUTH_EMULATOR_HOST] = host;
+        break;
+      case Emulators.HUB:
+        env[Constants.FIREBASE_EMULATOR_HUB] = host;
+        break;
+      case Emulators.PUBSUB:
+        env[Constants.PUBSUB_EMULATOR_HOST] = host;
+        break;
+      case Emulators.EVENTARC:
+        env[Constants.CLOUD_EVENTARC_EMULATOR_HOST] = `http://${host}`;
+        break;
+    }
   }
 }

src/emulator/env.ts

@@ -116,7 +116,7 @@ export interface FunctionsEmulatorArgs {
   quiet?: boolean;
   disabledRuntimeFeatures?: FunctionsRuntimeFeatures;
   debugPort?: number;
-  remoteEmulators?: { [key: string]: EmulatorInfo };
+  remoteEmulators?: Record<string, EmulatorInfo>;
   adminSdkConfig?: AdminSdkConfig;
   projectAlias?: string;
 }
@@ -1160,7 +1160,11 @@ export class FunctionsEmulator implements EmulatorInstance {
       enableCors: true,
     });
 
-    setEnvVarsForEmulators(envs);
+    let emulatorInfos = EmulatorRegistry.listRunningWithInfo();
+    if (this.args.remoteEmulators) {
+      emulatorInfos = emulatorInfos.concat(Object.values(this.args.remoteEmulators));
+    }
+    setEnvVarsForEmulators(envs, emulatorInfos);
 
     if (this.args.debugPort) {
       // Start runtime in debug mode to allow triggers to share single runtime process.