Catch OSX port 5000 in-use

CHANGELOG.md

@@ -1,6 +1,7 @@
 - Fix URL with wrong host returned in storage resumable upload (#4374).
 - Fixes Firestore emulator transaction expiration and reused bug.
 - Fixes Firestore emulator deadlock bug. [#2452](https://github.com/firebase/firebase-tools/issues/2452)
+- Ensure that the hosting emulator port is not claimed by OSX (#4415).
 - Improves support for prerelease versions in `ext:dev:publish` (#4244).
 - Fixes console error on large uploads to Storage Emulator (#4407).
 - Fixes cross-platform incompatibility with Storage Emulator exports (#4411).

src/serve/hosting.ts

@@ -15,6 +15,7 @@ import { Writable } from "stream";
 import { EmulatorLogger } from "../emulator/emulatorLogger";
 import { Emulators } from "../emulator/types";
 import { createDestroyer } from "../utils";
+import { execSync } from "child_process";
 
 const MAX_PORT_ATTEMPTS = 10;
 let attempts = 0;
@@ -44,6 +45,34 @@ function startServer(options: any, config: any, port: number, init: TemplateServ
     stream: morganStream,
   });
 
+  const portInUse = () => {
+    const message = "Port " + options.port + " is not available.";
+    logger.log("WARN", clc.yellow("hosting: ") + message + " Trying another port...");
+    if (attempts < MAX_PORT_ATTEMPTS) {
+      // Another project that's running takes up to 4 ports: 1 hosting port and 3 functions ports
+      attempts++;
+      startServer(options, config, port + 5, init);
+    } else {
+      logger.log("WARN", message);
+      throw new FirebaseError("Could not find an open port for hosting development server.", {
+        exit: 1,
+      });
+    }
+  };
+
+  // On OSX, some ports may be reserved by the OS in a way that node http doesn't detect.
+  // Starting in MacOS 12.3 it does this with port 5000 our default port. This is a bad
+  // enough devexp that we should special case and ensure it's available.
+  if (process.platform === "darwin") {
+    try {
+      execSync(`lsof -i :${port}`);
+      portInUse();
+      return;
+    } catch (e) {
+      // if lsof errored the port is NOT in use, continue
+    }
+  }
+
   const server = superstatic({
     debug: false,
     port: port,
@@ -85,18 +114,7 @@ function startServer(options: any, config: any, port: number, init: TemplateServ
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   server.on("error", (err: any) => {
     if (err.code === "EADDRINUSE") {
-      const message = "Port " + options.port + " is not available.";
-      logger.log("WARN", clc.yellow("hosting: ") + message + " Trying another port...");
-      if (attempts < MAX_PORT_ATTEMPTS) {
-        // Another project that's running takes up to 4 ports: 1 hosting port and 3 functions ports
-        attempts++;
-        startServer(options, config, port + 5, init);
-      } else {
-        logger.log("WARN", message);
-        throw new FirebaseError("Could not find an open port for hosting development server.", {
-          exit: 1,
-        });
-      }
+      portInUse();
     } else {
       throw new FirebaseError(
         "An error occurred while starting the hosting development server:\n\n" + err.toString(),