fix(remix-dev): re-use REMIX_DEV_SERVER_WS_PORT when reloading config

closes REM-1091 closes #2958 Signed-off-by: Logan McAnsh <[email protected]>
remix-run · May 16, 2022 · 97d385e · 97d385e
1 parent 03b86cc
commit 97d385e
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 5 deletions.
diff --git a/packages/remix-dev/__tests__/readConfig-test.ts b/packages/remix-dev/__tests__/readConfig-test.ts
@@ -52,4 +52,9 @@ describe("readConfig", () => {
     `
     );
   });
+
+  it("returns the same devServerPort value across reloads", async () => {
+    let newConfig = await readConfig(remixRoot);
+    expect(newConfig.devServerPort).toBe(config.devServerPort);
+  });
 });
diff --git a/packages/remix-dev/config.ts b/packages/remix-dev/config.ts
@@ -353,12 +353,19 @@ export async function readConfig(
       path.join("public", "build")
   );
 
-  if (typeof appConfig.devServerPort !== "number") {
-    appConfig.devServerPort = Number(
-      process.env.REMIX_DEV_SERVER_WS_PORT || 8002
-    );
+  let devServerPort: number;
+
+  // check if the port is already in use as this file is reloaded after a dep install or config change
+  if (process.env.REMIX_DEV_SERVER_WS_PORT) {
+    try {
+      devServerPort = Number(process.env.REMIX_DEV_SERVER_WS_PORT);
+    } catch (error: unknown) {
+      // failed to parse the port as a number
+      devServerPort = 8002;
+    }
+  } else {
+    devServerPort = await getPort({ port: appConfig.devServerPort });
   }
-  let devServerPort = await getPort({ port: appConfig.devServerPort });
   // set env variable so un-bundled servers can use it
   process.env.REMIX_DEV_SERVER_WS_PORT = `${devServerPort}`;
   let devServerBroadcastDelay = appConfig.devServerBroadcastDelay || 0;