improving our use of http-proxy-3 now that I understand this library better

- there was a lot of silliness with close events and close that did
  nothing, since we were never launching a standalone proxy server
- also a lot of silliness involving closing/deleting a ProxyServer
  instance, which is pointless when there is no http server involved
  a proxy is just a lightweight configuration object!

Author: williamstein

src/package.json

@@ -9,6 +9,7 @@
     "build-dev": "./workspaces.py install && ./workspaces.py build --dev",
     "clean": "rm -rf packages/node_modules && ./workspaces.py clean && cd compute/compute && pnpm clean ",
     "hub": "cd packages/hub && npm run hub-project-dev-nobuild",
+    "hub-prod": "cd packages/hub && npm run hub-project-prod-nobuild",
     "rspack": "cd packages/static && pnpm watch",
     "psql": "export PGHOST=${PGHOST:=$INIT_CWD/data/postgres/socket}; PGUSER='smc' psql",
     "database": "cd dev/project && ./start_postgres.py",

src/packages/hub/package.json

@@ -93,7 +93,7 @@
     "hub-project-dev-nobuild": "unset DATA COCALC_ROOT BASE_PATH && export DEBUG=${DEBUG:='cocalc:*,-cocalc:silly:*'} && export PGHOST=${PGHOST:=`realpath $INIT_CWD/../../data/postgres/socket`} && PGUSER='smc'  NODE_ENV=${NODE_ENV:=development} NODE_OPTIONS='--max_old_space_size=8000 --trace-warnings --enable-source-maps --inspect' cocalc-hub-server --mode=single-user --all --hostname=0.0.0.0",
     "hub-personal": "unset DATA COCALC_ROOT BASE_PATH && export DEBUG=${DEBUG:='cocalc:*,-cocalc:silly:*'} && export PGHOST=${PGHOST:=`realpath $INIT_CWD/../../data/postgres/socket`} && PGUSER='smc'  NODE_ENV=${NODE_ENV:=development} NODE_OPTIONS='--max_old_space_size=8000 --trace-warnings --enable-source-maps --inspect' cocalc-hub-server --mode=single-user --all --hostname=0.0.0.0 --personal",
     "hub-project-dev": "pnpm build && NODE_OPTIONS='--inspect' pnpm hub-project-dev-nobuild",
-    "hub-project-prod": "pnpm build && unset DATA COCALC_ROOT BASE_PATH && export DEBUG=${DEBUG:='cocalc:*,-cocalc:silly:*'} && export PGHOST=${PGHOST:=`realpath $INIT_CWD/../../data/postgres/socket`} &&   PGUSER='smc' NODE_ENV=production NODE_OPTIONS='--max_old_space_size=8000 --enable-source-maps' cocalc-hub-server --mode=single-user --all --hostname=0.0.0.0",
+    "hub-project-prod-nobuild": "unset DATA COCALC_ROOT BASE_PATH && export DEBUG=${DEBUG:='cocalc:*,-cocalc:silly:*'} && export PGHOST=${PGHOST:=`realpath $INIT_CWD/../../data/postgres/socket`} &&   PGUSER='smc' NODE_ENV=production NODE_OPTIONS='--max_old_space_size=8000 --enable-source-maps' cocalc-hub-server --mode=single-user --all --hostname=0.0.0.0",
     "hub-docker-dev": "export DEBUG=${DEBUG:='cocalc:*,-cocalc:silly:*'} && COCALC_DOCKER=true NODE_ENV=development PROJECTS=/projects/[project_id] PORT=443 NODE_OPTIONS='--max_old_space_size=8000 --enable-source-maps --trace-warnings --inspect' cocalc-hub-server --mode=multi-user --all --hostname=0.0.0.0 --https-key=/projects/conf/cert/key.pem --https-cert=/projects/conf/cert/cert.pem",
     "hub-docker-prod": "export DEBUG=${DEBUG:='cocalc:*,-cocalc:silly:*'} && COCALC_DOCKER=true NODE_ENV=production PROJECTS=/projects/[project_id] PORT=443 NODE_OPTIONS='--max_old_space_size=8000 --enable-source-maps' cocalc-hub-server --mode=multi-user --all --hostname=0.0.0.0 --https-key=/projects/conf/cert/key.pem --https-cert=/projects/conf/cert/cert.pem",
     "hub-docker-prod-nossl": "export DEBUG=${DEBUG:='cocalc:*,-cocalc:silly:*'} && COCALC_DOCKER=true NODE_ENV=production PROJECTS=/projects/[project_id] PORT=80 NODE_OPTIONS='--max_old_space_size=8000 --enable-source-maps' cocalc-hub-server --mode=multi-user --all --hostname=0.0.0.0",

src/packages/hub/proxy/handle-request.ts

@@ -1,10 +1,10 @@
 /* Handle a proxy request */
 
-import { createProxyServer } from "http-proxy-3";
+import { createProxyServer, type ProxyServer } from "http-proxy-3";
 import LRU from "lru-cache";
 import stripRememberMeCookie from "./strip-remember-me-cookie";
 import { versionCheckFails } from "./version";
-import { getTarget, invalidateTargetCache } from "./target";
+import { getTarget } from "./target";
 import getLogger from "../logger";
 import { stripBasePath } from "./util";
 import { ProjectControlFunction } from "@cocalc/server/projects/control";
@@ -34,14 +34,9 @@ export default function init({ projectControl, isPersonal }: Options) {
    a permissions and security point of view.
 */
 
-  const cache = new LRU({
+  const cache = new LRU<string, ProxyServer>({
     max: 5000,
     ttl: 1000 * 60 * 3,
-    dispose: (proxy) => {
-      // important to close the proxy whenever it gets removed
-      // from the cache, to avoid wasting resources.
-      (proxy as any)?.close();
-    },
   });
 
   async function handleProxyRequest(req, res): Promise<void> {
@@ -158,26 +153,13 @@ export default function init({ projectControl, isPersonal }: Options) {
       proxy = createProxyServer({
         ws: false,
         target,
-        timeout: 60000,
       });
       // and cache it.
       cache.set(target, proxy);
       logger.debug("created new proxy");
-      // setup error handler, so that if something goes wrong with this proxy (it will,
-      // e.g., on project restart), we properly invalidate it.
-      const remove_from_cache = () => {
-        cache.delete(target); // this also closes the proxy.
-        invalidateTargetCache(remember_me, url);
-      };
-
-      proxy.on("error", (e) => {
-        logger.debug("http proxy error event (ending proxy)", e);
-        remove_from_cache();
-      });
 
-      proxy.on("close", () => {
-        logger.debug("http proxy close event (ending proxy)");
-        remove_from_cache();
+      proxy.on("error", (err) => {
+        logger.debug(`http proxy error -- ${err}`);
       });
     }
 

src/packages/hub/proxy/handle-upgrade.ts

@@ -1,6 +1,6 @@
 // Websocket support
 
-import { createProxyServer } from "http-proxy-3";
+import { createProxyServer, type ProxyServer } from "http-proxy-3";
 import LRU from "lru-cache";
 import { getEventListeners } from "node:events";
 import getLogger from "@cocalc/hub/logger";
@@ -16,7 +16,7 @@ export default function init(
   { projectControl, isPersonal, httpServer, listenersHack },
   proxy_regexp: string,
 ) {
-  const cache = new LRU({
+  const cache = new LRU<string, ProxyServer>({
     max: 5000,
     ttl: 1000 * 60 * 3,
   });
@@ -77,17 +77,18 @@ export default function init(
     if (cache.has(target)) {
       dbg("using cache");
       const proxy = cache.get(target);
-      (proxy as any)?.ws(req, socket, head);
+      proxy.ws(req, socket, head);
       return;
     }
 
     dbg("target", target);
     dbg("not using cache");
+
     const proxy = createProxyServer({
       ws: true,
       target,
-      timeout: 3000,
     });
+
     cache.set(target, proxy);
 
     // taken from https://github.com/http-party/node-http-proxy/issues/1401
@@ -107,14 +108,9 @@ export default function init(
     });
 
     proxy.on("error", (err) => {
-      logger.debug(`websocket proxy error, so clearing cache -- ${err}`);
-      cache.delete(target);
-      proxy.close();
-    });
-    proxy.on("close", () => {
-      dbg("websocket proxy closed, so removing from cache");
-      cache.delete(target);
+      logger.debug(`WARNING: websocket proxy error -- ${err}`);
     });
+
     proxy.ws(req, socket, head);
   }
 

src/packages/hub/servers/nats.ts

@@ -10,7 +10,7 @@ $ pnpm nats-server
 
 */
 
-import { createProxyServer } from "http-proxy-3";
+import { createProxyServer, type ProxyServer } from "http-proxy-3";
 import getLogger from "@cocalc/backend/logger";
 import { type Router } from "express";
 import { natsWebsocketServer } from "@cocalc/backend/data";
@@ -22,6 +22,7 @@ import { delay } from "awaiting";
 
 const logger = getLogger("hub:nats");
 
+let proxy: ProxyServer | null = null;
 export async function proxyNatsWebsocket(req, socket, head) {
   const target = natsWebsocketServer;
   logger.debug(`nats proxy -- proxying a connection to ${target}`);
@@ -32,16 +33,19 @@ export async function proxyNatsWebsocket(req, socket, head) {
     socket.destroy();
     return;
   }
-  const proxy = createProxyServer({
-    ws: true,
-    target,
-    timeout: 5000,
-  });
+  if (proxy == null) {
+    // make the proxy server
+    proxy = createProxyServer({
+      ws: true,
+      target,
+    });
+    proxy.on("error", (err) => {
+      logger.debug(`WARNING: nats websocket proxy error -- ${err}`);
+    });
+  }
+
+  // connect the client's socket to nats via the proxy server:
   proxy.ws(req, socket, head);
-  proxy.on("error", (err) => {
-    logger.debug(`nats websocket proxy error, so closing -- ${err}`);
-    proxy.close();
-  });
 
   while (socket.readyState !== socket.CLOSED) {
     if (versionCheckFails(req)) {

src/scripts/g.sh

@@ -16,6 +16,10 @@ unset DEBUG_CONSOLE
 #export NO_RSPACK_DEV_SERVER=yes
 
 while true; do
-  pnpm hub
+  if [ x"$COCALC_PROD_MODE" = "x" ]; then
+      pnpm hub
+  else
+      pnpm hub-prod
+  fi
   sleep 1
 done