Add arm64 dataconnect binary (#9423)

stephenarosaj · web-flow · commit e15a5275ab40 · 2025-11-04T10:57:35.000-08:00
### Description

* Add `arm64` binary details to `downloadableEmulatorInfo.json`
* Update `downloadableEmulators.ts` to download arm64 binary when a `darwin` `arm64` environment is detected
* Add unit tests to verify correct binary is chosen for certain environments
  * Edit `EmulatorDownloadDetails` to be generated on-demand to facilitate unit testing

### Scenarios Tested

* `linux` environment --&gt; `linux-amd64` binary
* `win32` environment --&gt; `windows-amd64` binary
* `darwin (arm64)` environment --&gt; `macos-arm64` binary
* `darwin (non-arm64)` environment --&gt; `macos-amd64` binary

# commits:
* add unit tests to ensure correct binary is chosen in certain environments

* fix unit tests to properly clean up node process tampering

* update unit tests to mock with sinon

* address comments, make generateDownloadDetails private and switch existing uses to use getDownloadDetails
diff --git a/scripts/emulator-tests/unzipEmulators.spec.ts b/scripts/emulator-tests/unzipEmulators.spec.ts
@@ -2,9 +2,10 @@ import { expect } from "chai";
 import * as fs from "fs";
 import * as path from "path";
 import { unzip } from "../../src/unzip";
-import { DownloadDetails } from "../../src/emulator/downloadableEmulators";
+import { getDownloadDetails } from "../../src/emulator/downloadableEmulators";
 import { Client } from "../../src/apiv2";
 import { tmpdir } from "os";
+import { Emulators } from "../../src/emulator/types";
 
 describe("unzipEmulators", () => {
   let tempDir: string;
@@ -18,10 +19,8 @@ describe("unzipEmulators", () => {
   });
 
   it("should unzip a ui emulator zip file", async () => {
-    const [uiVersion, uiRemoteUrl] = [
-      DownloadDetails.ui.version,
-      DownloadDetails.ui.opts.remoteUrl,
-    ];
+    const downloadDetails = getDownloadDetails(Emulators.UI);
+    const [uiVersion, uiRemoteUrl] = [downloadDetails.version, downloadDetails.opts.remoteUrl];
 
     const uiZipPath = path.join(tempDir, `ui-v${uiVersion}.zip`);
 
@@ -44,9 +43,10 @@ describe("unzipEmulators", () => {
   }).timeout(10000);
 
   it("should unzip a pubsub emulator zip file", async () => {
+    const downloadDetails = getDownloadDetails(Emulators.PUBSUB);
     const [pubsubVersion, pubsubRemoteUrl] = [
-      DownloadDetails.pubsub.version,
-      DownloadDetails.pubsub.opts.remoteUrl,
+      downloadDetails.version,
+      downloadDetails.opts.remoteUrl,
     ];
 
     const pubsubZipPath = path.join(tempDir, `pubsub-emulator-v${pubsubVersion}.zip`);
@@ -97,7 +97,7 @@ async function downloadFile(url: string, targetPath: string): Promise<string> {
       }: ${await res.response.text()}`,
       {
         cause: new Error(
-          `Object DownloadDetails from src${path.sep}emulator${path.sep}downloadableEmulators.ts contains invalid URL: ${url}`,
+          `Object returned by getDownloadDetails() from src${path.sep}emulator${path.sep}downloadableEmulators.ts contains invalid URL: ${url}`,
         ),
       },
     );
diff --git a/src/emulator/downloadableEmulatorInfo.json b/src/emulator/downloadableEmulatorInfo.json
@@ -61,6 +61,14 @@
       "remoteUrl": "https://storage.googleapis.com/firemat-preview-drop/emulator/dataconnect-emulator-macos-amd64-v2.16.0",
       "downloadPathRelativeToCacheDir": "dataconnect-emulator-2.16.0"
     },
+    "darwin_arm64": {
+      "version": "2.16.0",
+      "expectedSize": 29442946,
+      "expectedChecksum": "15a6ee63f48021197df5395455666f29",
+      "expectedChecksumSHA256": "4a3933f55db380f20c478cd1a3cc4da8742da75bdcea589fc6e1f52b18943f48",
+      "remoteUrl": "https://storage.googleapis.com/firemat-preview-drop/emulator/dataconnect-emulator-macos-arm64-v2.16.0",
+      "downloadPathRelativeToCacheDir": "dataconnect-emulator-2.16.0"
+    },
     "win32": {
       "version": "2.16.0",
       "expectedSize": 30456320,
diff --git a/src/emulator/downloadableEmulators.spec.ts b/src/emulator/downloadableEmulators.spec.ts
@@ -5,6 +5,7 @@ import * as fs from "fs-extra";
 
 import * as downloadableEmulators from "./downloadableEmulators";
 import { Emulators } from "./types";
+import * as emulatorUpdateDetails from "./downloadableEmulatorInfo.json";
 
 type DownloadableEmulator = Emulators.FIRESTORE | Emulators.DATABASE | Emulators.PUBSUB;
 
@@ -14,27 +15,16 @@ function checkDownloadPath(name: DownloadableEmulator): void {
 }
 
 describe("downloadDetails", () => {
-  const tempEnvVars: Record<DownloadableEmulator, string> = {
-    firestore: "",
-    database: "",
-    pubsub: "",
-  };
+  let sandbox: sinon.SinonSandbox;
   let chmodStub: sinon.SinonStub;
   beforeEach(() => {
     chmodStub = sinon.stub(fs, "chmodSync").returns();
-    tempEnvVars["firestore"] = process.env["FIRESTORE_EMULATOR_BINARY_PATH"] ?? "";
-    tempEnvVars["database"] = process.env["DATABASE_EMULATOR_BINARY_PATH"] ?? "";
-    tempEnvVars["pubsub"] = process.env["PUBSUB_EMULATOR_BINARY_PATH"] ?? "";
-    delete process.env["FIRESTORE_EMULATOR_BINARY_PATH"];
-    delete process.env["DATABASE_EMULATOR_BINARY_PATH"];
-    delete process.env["PUBSUB_EMULATOR_BINARY_PATH"];
+    sandbox = sinon.createSandbox();
   });
 
   afterEach(() => {
     chmodStub.restore();
-    process.env["FIRESTORE_EMULATOR_BINARY_PATH"] = tempEnvVars["firestore"];
-    process.env["DATABASE_EMULATOR_BINARY_PATH"] = tempEnvVars["database"];
-    process.env["PUBSUB_EMULATOR_BINARY_PATH"] = tempEnvVars["pubsub"];
+    sandbox.restore();
   });
   it("should match the basename of remoteUrl", () => {
     checkDownloadPath(Emulators.FIRESTORE);
@@ -43,9 +33,13 @@ describe("downloadDetails", () => {
   });
 
   it("should apply environment varable overrides", () => {
-    process.env["FIRESTORE_EMULATOR_BINARY_PATH"] = "my/fake/firestore";
-    process.env["DATABASE_EMULATOR_BINARY_PATH"] = "my/fake/database";
-    process.env["PUBSUB_EMULATOR_BINARY_PATH"] = "my/fake/pubsub";
+    sandbox.stub(process, "env").value({
+      ...process.env,
+      FIRESTORE_EMULATOR_BINARY_PATH: "my/fake/firestore",
+      DATABASE_EMULATOR_BINARY_PATH: "my/fake/database",
+      PUBSUB_EMULATOR_BINARY_PATH: "my/fake/pubsub",
+      DATACONNECT_EMULATOR_BINARY_PATH: "my/fake/dataconnect",
+    });
 
     expect(downloadableEmulators.getDownloadDetails(Emulators.FIRESTORE).binaryPath).to.equal(
       "my/fake/firestore",
@@ -56,6 +50,37 @@ describe("downloadDetails", () => {
     expect(downloadableEmulators.getDownloadDetails(Emulators.PUBSUB).binaryPath).to.equal(
       "my/fake/pubsub",
     );
-    expect(chmodStub.callCount).to.equal(3);
+    expect(downloadableEmulators.getDownloadDetails(Emulators.DATACONNECT).binaryPath).to.equal(
+      "my/fake/dataconnect",
+    );
+    expect(chmodStub.callCount).to.equal(4);
+  });
+
+  it("should select the right binary for the host environment", () => {
+    let downloadDetails;
+    sandbox.stub(process, "platform").value("linux");
+    downloadDetails = downloadableEmulators.getDownloadDetails(Emulators.DATACONNECT);
+    expect(downloadDetails.opts.remoteUrl).to.equal(
+      emulatorUpdateDetails.dataconnect.linux.remoteUrl,
+    );
+
+    sandbox.stub(process, "platform").value("win32");
+    downloadDetails = downloadableEmulators.getDownloadDetails(Emulators.DATACONNECT);
+    expect(downloadDetails.opts.remoteUrl).to.equal(
+      emulatorUpdateDetails.dataconnect.win32.remoteUrl,
+    );
+
+    sandbox.stub(process, "platform").value("darwin");
+    sandbox.stub(process, "arch").value("x64");
+    downloadDetails = downloadableEmulators.getDownloadDetails(Emulators.DATACONNECT);
+    expect(downloadDetails.opts.remoteUrl).to.equal(
+      emulatorUpdateDetails.dataconnect.darwin.remoteUrl,
+    );
+
+    sandbox.stub(process, "arch").value("arm64");
+    downloadDetails = downloadableEmulators.getDownloadDetails(Emulators.DATACONNECT);
+    expect(downloadDetails.opts.remoteUrl).to.equal(
+      emulatorUpdateDetails.dataconnect.darwin_arm64.remoteUrl,
+    );
   });
 });
diff --git a/src/emulator/downloadableEmulators.ts b/src/emulator/downloadableEmulators.ts
@@ -40,97 +40,121 @@ const EMULATOR_UPDATE_DETAILS: {
   };
   dataconnect: {
     darwin: EmulatorUpdateDetails;
+    darwin_arm64: EmulatorUpdateDetails;
     win32: EmulatorUpdateDetails;
     linux: EmulatorUpdateDetails;
   };
 } = emulatorUpdateDetails;
 
-const emulatorUiDetails = experiments.isEnabled("emulatoruisnapshot")
-  ? EMULATOR_UPDATE_DETAILS.ui.snapshot
-  : EMULATOR_UPDATE_DETAILS.ui.main;
-const dataconnectDetails =
-  process.platform === "darwin"
-    ? EMULATOR_UPDATE_DETAILS.dataconnect.darwin
-    : process.platform === "win32"
-      ? EMULATOR_UPDATE_DETAILS.dataconnect.win32
-      : EMULATOR_UPDATE_DETAILS.dataconnect.linux;
-export const DownloadDetails: { [s in DownloadableEmulators]: EmulatorDownloadDetails } = {
-  database: {
-    downloadPath: path.join(
-      CACHE_DIR,
-      EMULATOR_UPDATE_DETAILS.database.downloadPathRelativeToCacheDir,
-    ),
-    version: EMULATOR_UPDATE_DETAILS.database.version,
-    opts: {
-      ...EMULATOR_UPDATE_DETAILS.database,
-      cacheDir: CACHE_DIR,
-      namePrefix: "firebase-database-emulator",
-    },
-  },
-  firestore: {
-    downloadPath: path.join(
-      CACHE_DIR,
-      EMULATOR_UPDATE_DETAILS.firestore.downloadPathRelativeToCacheDir,
-    ),
-    version: EMULATOR_UPDATE_DETAILS.firestore.version,
-    opts: {
-      ...EMULATOR_UPDATE_DETAILS.firestore,
-      cacheDir: CACHE_DIR,
-      namePrefix: "cloud-firestore-emulator",
-    },
-  },
-  storage: {
-    downloadPath: path.join(
-      CACHE_DIR,
-      EMULATOR_UPDATE_DETAILS.storage.downloadPathRelativeToCacheDir,
-    ),
-    version: EMULATOR_UPDATE_DETAILS.storage.version,
-    opts: {
-      ...EMULATOR_UPDATE_DETAILS.storage,
-      cacheDir: CACHE_DIR,
-      namePrefix: "cloud-storage-rules-emulator",
-    },
-  },
-  ui: {
-    version: emulatorUiDetails.version,
-    downloadPath: path.join(CACHE_DIR, emulatorUiDetails.downloadPathRelativeToCacheDir),
-    unzipDir: path.join(CACHE_DIR, `ui-v${emulatorUiDetails.version}`),
-    binaryPath: path.join(CACHE_DIR, emulatorUiDetails.binaryPathRelativeToCacheDir!),
-    opts: {
-      ...emulatorUiDetails,
-      cacheDir: CACHE_DIR,
-      skipCache: experiments.isEnabled("emulatoruisnapshot"),
-      skipChecksumAndSize: experiments.isEnabled("emulatoruisnapshot"),
-      namePrefix: "ui",
-    },
-  },
-  pubsub: {
-    downloadPath: path.join(
-      CACHE_DIR,
-      EMULATOR_UPDATE_DETAILS.pubsub.downloadPathRelativeToCacheDir,
-    ),
-    version: EMULATOR_UPDATE_DETAILS.pubsub.version,
-    unzipDir: path.join(CACHE_DIR, `pubsub-emulator-${EMULATOR_UPDATE_DETAILS.pubsub.version}`),
-    binaryPath: path.join(CACHE_DIR, EMULATOR_UPDATE_DETAILS.pubsub.binaryPathRelativeToCacheDir!),
-    opts: {
-      ...EMULATOR_UPDATE_DETAILS.pubsub,
-      cacheDir: CACHE_DIR,
-      namePrefix: "pubsub-emulator",
-    },
-  },
-  dataconnect: {
-    downloadPath: path.join(CACHE_DIR, dataconnectDetails.downloadPathRelativeToCacheDir),
-    version: dataconnectDetails.version,
-    binaryPath: path.join(CACHE_DIR, dataconnectDetails.downloadPathRelativeToCacheDir),
-    opts: {
-      ...dataconnectDetails,
-      cacheDir: CACHE_DIR,
-      skipChecksumAndSize: false,
-      namePrefix: "dataconnect-emulator",
-      auth: false,
-    },
-  },
-};
+/**
+ * generate download details for a single emulator, based on the host environment.
+ * pulls data from `downloadableEmulatorInfo.json`.
+ * @param emulator The name of the downloadable emulator to get details for.
+ * @returns The download details for the specified emulator.
+ */
+function generateDownloadDetails(emulator: DownloadableEmulators): EmulatorDownloadDetails {
+  const emulatorUiDetails = experiments.isEnabled("emulatoruisnapshot")
+    ? EMULATOR_UPDATE_DETAILS.ui.snapshot
+    : EMULATOR_UPDATE_DETAILS.ui.main;
+
+  const dataconnectDetails =
+    process.platform === "darwin"
+      ? process.arch === "arm64"
+        ? EMULATOR_UPDATE_DETAILS.dataconnect.darwin_arm64
+        : EMULATOR_UPDATE_DETAILS.dataconnect.darwin
+      : process.platform === "win32"
+        ? EMULATOR_UPDATE_DETAILS.dataconnect.win32
+        : EMULATOR_UPDATE_DETAILS.dataconnect.linux;
+
+  switch (emulator) {
+    case "database":
+      return {
+        downloadPath: path.join(
+          CACHE_DIR,
+          EMULATOR_UPDATE_DETAILS.database.downloadPathRelativeToCacheDir,
+        ),
+        version: EMULATOR_UPDATE_DETAILS.database.version,
+        opts: {
+          ...EMULATOR_UPDATE_DETAILS.database,
+          cacheDir: CACHE_DIR,
+          namePrefix: "firebase-database-emulator",
+        },
+      };
+    case "firestore":
+      return {
+        downloadPath: path.join(
+          CACHE_DIR,
+          EMULATOR_UPDATE_DETAILS.firestore.downloadPathRelativeToCacheDir,
+        ),
+        version: EMULATOR_UPDATE_DETAILS.firestore.version,
+        opts: {
+          ...EMULATOR_UPDATE_DETAILS.firestore,
+          cacheDir: CACHE_DIR,
+          namePrefix: "cloud-firestore-emulator",
+        },
+      };
+    case "storage":
+      return {
+        downloadPath: path.join(
+          CACHE_DIR,
+          EMULATOR_UPDATE_DETAILS.storage.downloadPathRelativeToCacheDir,
+        ),
+        version: EMULATOR_UPDATE_DETAILS.storage.version,
+        opts: {
+          ...EMULATOR_UPDATE_DETAILS.storage,
+          cacheDir: CACHE_DIR,
+          namePrefix: "cloud-storage-rules-emulator",
+        },
+      };
+    case "ui":
+      return {
+        version: emulatorUiDetails.version,
+        downloadPath: path.join(CACHE_DIR, emulatorUiDetails.downloadPathRelativeToCacheDir),
+        unzipDir: path.join(CACHE_DIR, `ui-v${emulatorUiDetails.version}`),
+        binaryPath: path.join(CACHE_DIR, emulatorUiDetails.binaryPathRelativeToCacheDir!),
+        opts: {
+          ...emulatorUiDetails,
+          cacheDir: CACHE_DIR,
+          skipCache: experiments.isEnabled("emulatoruisnapshot"),
+          skipChecksumAndSize: experiments.isEnabled("emulatoruisnapshot"),
+          namePrefix: "ui",
+        },
+      };
+    case "pubsub":
+      return {
+        downloadPath: path.join(
+          CACHE_DIR,
+          EMULATOR_UPDATE_DETAILS.pubsub.downloadPathRelativeToCacheDir,
+        ),
+        version: EMULATOR_UPDATE_DETAILS.pubsub.version,
+        unzipDir: path.join(CACHE_DIR, `pubsub-emulator-${EMULATOR_UPDATE_DETAILS.pubsub.version}`),
+        binaryPath: path.join(
+          CACHE_DIR,
+          EMULATOR_UPDATE_DETAILS.pubsub.binaryPathRelativeToCacheDir!,
+        ),
+        opts: {
+          ...EMULATOR_UPDATE_DETAILS.pubsub,
+          cacheDir: CACHE_DIR,
+          namePrefix: "pubsub-emulator",
+        },
+      };
+    case "dataconnect":
+      return {
+        downloadPath: path.join(CACHE_DIR, dataconnectDetails.downloadPathRelativeToCacheDir),
+        version: dataconnectDetails.version,
+        binaryPath: path.join(CACHE_DIR, dataconnectDetails.downloadPathRelativeToCacheDir),
+        opts: {
+          ...dataconnectDetails,
+          cacheDir: CACHE_DIR,
+          skipChecksumAndSize: false,
+          namePrefix: "dataconnect-emulator",
+          auth: false,
+        },
+      };
+    default:
+      throw new Error(`Invalid downloadable emulator: ${emulator}`);
+  }
+}
 
 const EmulatorDetails: { [s in DownloadableEmulators]: DownloadableEmulatorDetails } = {
   database: {
@@ -480,7 +504,7 @@ async function _runBinary(
  * @param emulator
  */
 export function getDownloadDetails(emulator: DownloadableEmulators): EmulatorDownloadDetails {
-  const details = DownloadDetails[emulator];
+  const details = generateDownloadDetails(emulator);
   const pathOverride = process.env[`${emulator.toUpperCase()}_EMULATOR_BINARY_PATH`];
   if (pathOverride) {
     const logger = EmulatorLogger.forEmulator(emulator);
diff --git a/src/emulator/types.ts b/src/emulator/types.ts
