use 127.0.0.1 (ipv4) everywhere, instead of "localhost" which is inconsistent and does break

Author: williamstein

src/packages/api-client/README.md

@@ -10,7 +10,7 @@ the settings of your project.
 ```sh
 export PROJECT_ID=6640ddad-4bdd-4745-8e63-8db74686a20e
 export API_KEY=sk-FcnRs3NxsTZROgbF000001
-export API_SERVER=http://localhost:9001
+export API_SERVER=http://127.0.0.1:9001
 ```
 
 The run code in node from the shell in the current directory:

src/packages/backend/tcp/locked-socket.ts

@@ -67,7 +67,7 @@ It is not used in any other way.
 */
 export async function connectToLockedSocket({
   port,
-  host = "localhost",
+  host = "127.0.0.1",
   token,
   timeout = 5, // in seconds (not milliseconds)
 }: {

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

@@ -60,7 +60,7 @@ export default function init({ projectControl, isPersonal }: Options) {
     if (req.headers["cookie"] != null) {
       let cookie;
       ({ cookie, remember_me, api_key } = stripRememberMeCookie(
-        req.headers["cookie"]
+        req.headers["cookie"],
       ));
       req.headers["cookie"] = cookie;
     }
@@ -71,7 +71,7 @@ export default function init({ projectControl, isPersonal }: Options) {
       // definitely block access.  4xx since this is a *client* problem.
       const url = await siteUrl();
       throw Error(
-        `Please login to <a target='_blank' href='${url}'>${url}</a> with cookies enabled, then refresh this page.`
+        `Please login to <a target='_blank' href='${url}'>${url}</a> with cookies enabled, then refresh this page.`,
       );
     }
 
@@ -94,15 +94,15 @@ export default function init({ projectControl, isPersonal }: Options) {
       dbg("using cached proxy");
       proxy = cache.get(target);
     } else {
-      dbg("make a new proxy server to", target);
+      logger.debug("make a new proxy server to", target);
       proxy = createProxyServer({
         ws: false,
         target,
         timeout: 60000,
       });
       // and cache it.
       cache.set(target, proxy);
-      dbg("created new 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 = () => {
@@ -111,11 +111,14 @@ export default function init({ projectControl, isPersonal }: Options) {
       };
 
       proxy.on("error", (e) => {
-        dbg("http proxy error event (ending proxy)", e);
+        logger.debug("http proxy error event (ending proxy)", e);
         remove_from_cache();
       });
 
-      proxy.on("close", remove_from_cache);
+      proxy.on("close", () => {
+        logger.debug("http proxy close event (ending proxy)");
+        remove_from_cache();
+      });
     }
 
     if (internal_url != null) {

src/packages/project/http-api/get-syncdoc-history.ts

@@ -2,7 +2,7 @@
 
 EXAMPLE:
 
-~$ curl   -u `cat .smc/secret_token`: -d path=a.md http://localhost:`cat .smc/api-server.port`/api/v1/get-syncdoc-history -d patches | python -m json.tool
+~$ curl   -u `cat .smc/secret_token`: -d path=a.md http://127.0.0.1:`cat .smc/api-server.port`/api/v1/get-syncdoc-history -d patches | python -m json.tool
 
 If you get an error about no hubs connected, then edit a file in the project
 in a browser to cause a connection to happen.   Also, a.md need to be a file that

src/packages/project/http-api/server.ts

@@ -20,7 +20,7 @@ import type { Request } from "express";
 import express from "express";
 import RateLimit from "express-rate-limit";
 import { writeFile } from "node:fs";
-
+import { getOptions } from "@cocalc/project/init-program";
 import { getClient } from "@cocalc/project/client";
 import { apiServerPortFile } from "@cocalc/project/data";
 import { getSecretToken } from "@cocalc/project/servers/secret-token";
@@ -43,7 +43,8 @@ export default async function init(): Promise<void> {
   dbg("configuring server...");
   configure(app, dbg);
 
-  const server = app.listen(0, "localhost");
+  const options = getOptions();
+  const server = app.listen(0, options.hostname);
   await once(server, "listening");
   const address = server.address();
   if (address == null || typeof address == "string") {
@@ -53,7 +54,7 @@ export default async function init(): Promise<void> {
   dbg(`writing port to file "${apiServerPortFile}"`);
   await callback(writeFile, apiServerPortFile, `${port}`);
 
-  dbg(`express server successfully listening at http://localhost:${port}`);
+  dbg(`express server successfully listening at http://${options.hostname}:${port}`);
 }
 
 function configure(server: express.Application, dbg: Function): void {

src/packages/project/info-json.ts

@@ -33,10 +33,10 @@ export default async function init() {
     // earlier, there was eth0, but newer Ubuntu's on GCP have ens4
     const nics = networkInterfaces();
     const mynic = nics.eth0 ?? nics.ens4;
-    host = mynic?.[0].address ?? "localhost";
+    host = mynic?.[0].address ?? "127.0.0.1";
   } else {
     // for a single machine (e.g., cocalc-docker)
-    host = "localhost";
+    host = "127.0.0.1";
   }
   INFO = {
     project_id,

src/packages/project/init-program.ts

@@ -22,14 +22,17 @@ interface Options {
 const DEFAULTS: Options = {
   hubPort: 0,
   browserPort: 0,
-  // It's important to make the hostname 'localhost' instead of '127.0.0.1',
-  // since we use 'localhost' in packages/server/projects/control/util.ts
+  // It's important to make the hostname '127.0.0.1' instead of 'localhost',
+  // and also be consistent with packages/server/projects/control/util.ts
   // The distinction can of course matter, e.g,. using '127.0.0.1' causes
   // our server to ONLY listen on ipv4, but the client will try 'localhost'
   // which on some hosts will resolve to an ipv6 address ::1 first and that
-  // fails.  By listening on localhost, I think our project will listen on
-  // both ipv4 and ipv6 if they are available.
-  hostname: "localhost",
+  // fails.  There's no way to just easily listen on both ipv4 and ipv6 interfaces.
+  // I noticed that with express if you use localhost you get ipv6 only, and
+  // with node-http-proxy if you use localhost you get ipv4 only, so things are
+  // just totally broken.  So we explicitly use 127.0.0.1 to force things to
+  // be consistent.
+  hostname: "127.0.0.1",
   kucalc: false,
   daemon: false,
   sshd: false,

src/packages/server/projects/control/util.ts

@@ -281,7 +281,7 @@ export async function getState(HOME: string): Promise<ProjectState> {
   logger.debug(`getState("${HOME}")`);
   try {
     return {
-      ip: "localhost",
+      ip: "127.0.0.1",
       state: (await isProjectRunning(HOME)) ? "running" : "opened",
       time: new Date(),
     };

src/packages/sync-client/scratch/primus.ts

@@ -87,7 +87,7 @@ export function project({
   project_id: string;
   port: number;
 }) {
-  const url = `http://localhost:${port}`;
+  const url = `http://127.0.0.1:${port}`;
   const opts = {
     pathname: join(appBasePath, project_id, "raw/.smc/ws"),
     transformer: "websockets",

src/packages/sync-client/scratch/ws.ts

@@ -33,7 +33,7 @@ export function server() {
 }
 
 export function client() {
-  const ws = new WebSocket("ws://localhost:8080");
+  const ws = new WebSocket("ws://127.0.0.1:8080");
   ws.onmessage = (event) => {
     console.log(`Client Received message: ${event.data}`);
   };

src/workspaces.py

@@ -12,6 +12,7 @@
  - This should always work:  "mypy workspaces.py"
 """
 
+
 import argparse, json, os, platform, shutil, subprocess, sys, time
 
 from typing import Any, Optional, Callable, List