socket-function 1.2.4 → 1.2.5

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "socket-function",
-	"version": "1.2.4",
+	"version": "1.2.5",
 	"main": "index.js",
 	"license": "MIT",
 	"dependencies": {

package/src/webSocketServer.ts

@@ -20,6 +20,12 @@ import { formatTime } from "./formatting/format";
 import { getExternalIP, testTCPIsListening } from "./networking";
 import { forwardPort } from "./forwardPort";
 
+// When a requested port is taken and useAvailablePortIfPortInUse is set, we scan
+//  upwards from this base instead of binding a random OS-assigned port, so restarts
+//  land on predictable, consistent ports.
+const PORT_SCAN_START = 13000;
+const PORT_SCAN_COUNT = 10000;
+
 export type SocketServerConfig = (
     https.ServerOptions & {
         key: string | Buffer;
@@ -311,52 +317,55 @@ export async function startSocketServer(
 
     let port = config.port;
     if (!SocketFunction.silent) {
-        console.log(yellow(`Trying to listening on ${host}:${port}`));
+        console.log(yellow(`Trying to listen on ${host}:${port}`));
     }
 
-    let listeningPromise = waitUntilListening();
-    listeningPromise.catch(e => { });
-
-    // Return true if we are listening, false if the address is in use, and throws on other errors
-    async function waitUntilListening() {
+    // Attempts to bind realServer to a single port. Resolves true once the server is
+    //  actually listening, false if the port is already in use, and rejects on any
+    //  other error. After an EADDRINUSE the server is still usable, so the caller can
+    //  simply retry listen() on the next candidate.
+    async function tryListen(candidatePort: number): Promise<boolean> {
         return await new Promise<boolean>((resolve, reject) => {
-            realServer.once("error", e => {
-                reject(e);
-            });
-            realServer.once("listening", () => {
-                resolve(false);
-            });
-        });
-    }
-
-    if (config.useAvailablePortIfPortInUse && port) {
-        realServer.listen(port, host);
-        let isListening = await new Promise<boolean>((resolve, reject) => {
-            if (realServer.listening) {
-                resolve(true);
-                return;
+            function cleanup() {
+                realServer.removeListener("error", onError);
+                realServer.removeListener("listening", onListening);
             }
-            realServer.once("error", e => {
-                if (e.message.includes("EADDRINUSE")) {
-                    resolve(true);
+            function onError(e: NodeJS.ErrnoException) {
+                cleanup();
+                if (e.code === "EADDRINUSE" || e.message.includes("EADDRINUSE")) {
+                    resolve(false);
                 } else {
                     reject(e);
                 }
-            });
-            realServer.once("listening", () => {
-                resolve(false);
-            });
+            }
+            function onListening() {
+                cleanup();
+                resolve(true);
+            }
+            realServer.once("error", onError);
+            realServer.once("listening", onListening);
+            realServer.listen(candidatePort, host);
         });
-        if (!isListening) {
-            port = 0;
-            realServer.listen(port, host);
-            listeningPromise = waitUntilListening();
+    }
+
+    let bound = await tryListen(port);
+    if (!bound && config.useAvailablePortIfPortInUse) {
+        for (let candidate = PORT_SCAN_START; candidate < PORT_SCAN_START + PORT_SCAN_COUNT; candidate++) {
+            if (candidate === port) continue;
+            if (await tryListen(candidate)) {
+                bound = true;
+                port = candidate;
+                break;
+            }
         }
-    } else {
-        realServer.listen(port, host);
+        if (!bound) {
+            throw new Error(`Could not find an available port in range ${PORT_SCAN_START}-${PORT_SCAN_START + PORT_SCAN_COUNT - 1} (requested ${config.port})`);
+        }
+    }
+    if (!bound) {
+        throw new Error(`Port ${port} is already in use (set useAvailablePortIfPortInUse to fall back to another port)`);
     }
 
-    await listeningPromise;
     port = (realServer.address() as net.AddressInfo).port;
 
     if (config.autoForwardPort && config.public) {