Move listen option parsing to separate function

Author: dometto

bin/configurable-http-proxy

@@ -10,6 +10,8 @@ import fs from "node:fs";
 import { Command } from "commander";
 
 import ConfigurableProxy from "../lib/configproxy.js";
+import { parseListenOptions } from "../lib/configproxy.js";
+
 import { defaultLogger } from "../lib/log.js";
 
 import { createRequire } from "node:module";
@@ -282,7 +284,7 @@ options.proxyTimeout = args.proxyTimeout;
 options.keepAliveTimeout = args.keepAliveTimeout;
 
 // metrics options
-options.enableMetrics = !!args.metricsPort;
+options.enableMetrics = !!args.metricsPort || !!args.metricsSocket;
 
 // certs need to be provided for https redirection
 if (!options.ssl && options.redirectPort) {
@@ -323,43 +325,7 @@ options.storageBackend = args.storageBackend;
 
 var proxy = new ConfigurableProxy(options);
 
-var listen = {};
-
-if (args.socket) {
-  listen.proxyTarget = [args.socket];
-  log.warn(
-    "Proxy will listen on UNIX domain socket, --ip and --port options will be ignored."
-  );
-} else {
-  listen.port = parseInt(args.port) || 8000;
-  if (args.ip === "*") {
-    // handle ip=* alias for all interfaces
-    log.warn(
-      "Interpreting ip='*' as all-interfaces. Preferred usage is 0.0.0.0 for all IPv4 or '' for all-interfaces."
-    );
-    args.ip = "";
-  }
-  listen.ip = args.ip;
-  listen.proxyTarget = [listen.port, listen.ip];
-}
-
-if (args.apiSocket) {
-  listen.apiSocket = [args.apiSocket];
-  log.warn(
-    "API server will listen on UNIX domain socket, --api-ip and --api-port options will be ignored."
-  );
-} else {
-  listen.apiTarget = [args.apiPort || (listen.port ? listen.port + 1 : 8001), args.apiIp];
-}
-
-if (args.metricsSocket) {
-  listen.metricsSocket = [args.metricsSocket];
-  log.warn(
-    "Metrics server will listen on UNIX domain socket, --metrics-ip and --metrics-port options will be ignored."
-  );
-} else {
-  listen.metricsTarget = [args.metricsPort, args.metricsIp];
-}
+var listen = parseListenOptions(args);
 
 proxy.proxyServer.listen(...listen.proxyTarget);
 proxy.apiServer.listen(...listen.apiTarget);
@@ -378,7 +344,7 @@ log.info(
   options.apiSsl ? "https" : "http",
   listen.apiTarget.join(":")
 );
-if (listen.metricsPort) {
+if (listen.metricsTarget) {
   log.info("Serve metrics at %s://%s/metrics", "http", listen.metricsTarget.join(":"));
 }
 

lib/configproxy.js

@@ -24,6 +24,48 @@ const require = createRequire(import.meta.url);
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
+export function parseListenOptions(args) {
+  var listen = {};
+
+  if (args.socket) {
+    listen.proxyTarget = [args.socket];
+    log.warn(
+      "Proxy will listen on UNIX domain socket, --ip and --port options will be ignored."
+    );
+  } else {
+    listen.port = parseInt(args.port) || 8000;
+    if (args.ip === "*") {
+      // handle ip=* alias for all interfaces
+      log.warn(
+        "Interpreting ip='*' as all-interfaces. Preferred usage is 0.0.0.0 for all IPv4 or '' for all-interfaces."
+      );
+      args.ip = "";
+    }
+    listen.ip = args.ip;
+    listen.proxyTarget = [listen.port, listen.ip];
+  }
+  
+  if (args.apiSocket) {
+    listen.apiSocket = [args.apiSocket];
+    log.warn(
+      "API server will listen on UNIX domain socket, --api-ip and --api-port options will be ignored."
+    );
+  } else {
+    listen.apiPort = args.apiPort ? parseInt(args.apiPort) : (listen.port ? listen.port + 1 : 8001);
+    listen.apiTarget = [listen.apiPort, args.apiIp];
+  }
+  
+  if (args.metricsSocket) {
+    listen.metricsSocket = [args.metricsSocket];
+    log.warn(
+      "Metrics server will listen on UNIX domain socket, --metrics-ip and --metrics-port options will be ignored."
+    );
+  } else if (args.metricsPort) {
+    listen.metricsTarget = [parseInt(args.metricsPort), args.metricsIp];
+  }
+  return listen;
+}
+
 function bound(that, method) {
   // bind a method, to ensure `this=that` when it is called
   // because prototype languages are bad

lib/testutil.js

@@ -1,17 +1,30 @@
 "use strict";
 
+import fs from "node:fs";
 import http from "node:http";
 import https from "node:https";
 import { WebSocketServer } from "ws";
-import { ConfigurableProxy } from "./configproxy.js";
+import { ConfigurableProxy, parseListenOptions } from "./configproxy.js";
 import { defaultLogger } from "./log.js";
 
 var servers = [];
 
 // TODO: make this an options dict
-export function addTarget(proxy, path, port, websocket, targetPath, sslOptions) {
-  var proto = sslOptions ? "https" : "http";
-  var target = proto + "://127.0.0.1:" + port;
+export function addTarget(proxy, path, port, websocket, targetPath, sslOptions, unixSocketPath) {
+  var proto;
+  var listenTarget;
+  var target;
+
+  if (unixSocketPath) {
+    listenTarget = decodeURIComponent(unixSocketPath);
+    proto = "http";
+    target = "unix+" + proto + "://" + unixSocketPath;
+  } else {
+    proto = sslOptions ? "https" : "http";
+    target = proto + "://" + "127.0.0.1:" + port;
+    listenTarget = port;
+  }
+
   if (targetPath) {
     target = target + targetPath;
   }
@@ -48,7 +61,7 @@ export function addTarget(proxy, path, port, websocket, targetPath, sslOptions)
     });
   }
 
-  server.listen(port);
+  server.listen(listenTarget);
   servers.push(server);
   return proxy.addRoute(path, { target: target }).then(() => {
     // routes are created with an activity timestamp artificially shifted into the past
@@ -87,14 +100,16 @@ export function addTargets(proxy, paths, port) {
   });
 }
 
-export function setupProxy(port, options, paths) {
+export function setupProxy(listenOptions, options, paths) {
   options = options || {};
   options.authToken = "secret";
   options.log = defaultLogger({ level: "error" });
-
+  var listen = parseListenOptions(listenOptions, options.log);
+  var port = listen.port || 8000;
+  var ip = listen.ip;
   var proxy = new ConfigurableProxy(options);
   proxy._setup_timestamp = new Date(new Date().getTime() - 60000);
-  var ip = "127.0.0.1";
+
   var countdown = 2;
   var resolvePromise;
 
@@ -134,10 +149,10 @@ export function setupProxy(port, options, paths) {
   proxy.proxyServer.on("listening", onlisten);
 
   addTargets(proxy, paths || ["/"], port + 2).then(function () {
-    proxy.proxyServer.listen(port, ip);
-    proxy.apiServer.listen(port + 1, ip);
+    proxy.proxyServer.listen(...listen.proxyTarget);
+    proxy.apiServer.listen(...listen.apiTarget);
     if (options.enableMetrics) {
-      proxy.metricsServer.listen(port + 3, ip);
+      proxy.metricsServer.listen(...listen.metricsTarget);
     }
   });
   return p;
@@ -154,7 +169,6 @@ export function teardownServers(callback) {
   };
   for (var i = servers.length - 1; i >= 0; i--) {
     servers[i].close(onclose);
-
     // closeAllConnections is implied in close in node >=19
     // but this avoids waits between all tests with node 18
     servers[i].closeAllConnections();