Fix listening on a socket

Author: code-asher

src/node/app.ts

@@ -67,8 +67,10 @@ export const createApp = async (args: DefaultedArgs): Promise<[Express, Express,
 /**
  * Get the address of a server as a string (protocol *is* included) while
  * ensuring there is one (will throw if there isn't).
+ *
+ * The address might be a URL or it might be a pipe or socket path.
  */
-export const ensureAddress = (server: http.Server, protocol: string): URL => {
+export const ensureAddress = (server: http.Server, protocol: string): URL | string => {
   const addr = server.address()
 
   if (!addr) {
@@ -79,7 +81,8 @@ export const ensureAddress = (server: http.Server, protocol: string): URL => {
     return new URL(`${protocol}://${addr.address}:${addr.port}`)
   }
 
-  return new URL(addr)
+  // If this is a string then it is a pipe or Unix socket.
+  return addr
 }
 
 /**

src/node/coder_cloud.ts

@@ -33,9 +33,11 @@ function runAgent(...args: string[]): Promise<void> {
   })
 }
 
-export function coderCloudBind(csAddr: string, serverName = ""): Promise<void> {
-  // addr needs to be in host:port format.
-  // So we trim the protocol.
-  csAddr = csAddr.replace(/^https?:\/\//, "")
-  return runAgent("bind", `--code-server-addr=${csAddr}`, serverName)
+export function coderCloudBind(address: URL | string, serverName = ""): Promise<void> {
+  if (typeof address === "string") {
+    throw new Error("Cannot link socket paths")
+  }
+
+  // Address needs to be in hostname:port format without the protocol.
+  return runAgent("bind", `--code-server-addr=${address.host}`, serverName)
 }

src/node/link.ts

@@ -2,8 +2,13 @@ import { logger } from "@coder/logger"
 import { ChildProcessWithoutNullStreams, spawn } from "child_process"
 import path from "path"
 
-export function startLink(port: number): ChildProcessWithoutNullStreams {
-  logger.debug(`running link targetting ${port}`)
+export function startLink(address: URL | string): ChildProcessWithoutNullStreams {
+  if (typeof address === "string") {
+    throw new Error("Cannot link socket paths")
+  }
+
+  const port = parseInt(address.port, 10)
+  logger.debug(`running link targeting ${port}`)
 
   return spawn(path.resolve(__dirname, "../../lib/linkup"), ["--devurl", `code:${port}:code-server`], {
     shell: false,

src/node/main.ts

@@ -152,26 +152,24 @@ export const runCodeServer = async (
   }
 
   if (args.link) {
-    await coderCloudBind(serverAddress.host, args.link.value)
+    await coderCloudBind(serverAddress, args.link.value)
     logger.info("  - Connected to cloud agent")
   }
 
   let linkAgent: undefined | ChildProcessWithoutNullStreams
 
   try {
-    linkAgent = startLink(parseInt(serverAddress.port, 10))
+    const linkAgent = startLink(serverAddress)
+    linkAgent.on("error", (error) => {
+      logger.debug("[Link daemon]", field("error", error))
+    })
+    linkAgent.on("close", (code) => {
+      logger.debug("[Link daemon]", field("code", `Closed with code ${code}`))
+    })
   } catch (error) {
     logger.debug("Failed to start link daemon!", error as any)
   }
 
-  linkAgent?.on("error", (error) => {
-    logger.debug("[Link daemon]", field("error", error))
-  })
-
-  linkAgent?.on("close", (code) => {
-    logger.debug("[Link daemon]", field("code", `Closed with code ${code}`))
-  })
-
   if (args.enable && args.enable.length > 0) {
     logger.info("Enabling the following experimental features:")
     args.enable.forEach((feature) => {
@@ -187,14 +185,9 @@ export const runCodeServer = async (
     )
   }
 
-  if (!args.socket && args.open) {
-    // The web socket doesn't seem to work if browsing with 0.0.0.0.
-    if (serverAddress.hostname === "0.0.0.0") {
-      serverAddress.hostname = "localhost"
-    }
-
+  if (args.open) {
     try {
-      await open(serverAddress.toString())
+      await open(serverAddress)
       logger.info(`Opened ${serverAddress}`)
     } catch (error) {
       logger.error("Failed to open", field("address", serverAddress.toString()), field("error", error))

src/node/util.ts

@@ -393,19 +393,27 @@ export const isWsl = async (): Promise<boolean> => {
 }
 
 /**
- * Try opening a URL using whatever the system has set for opening URLs.
+ * Try opening an address using whatever the system has set for opening URLs.
  */
-export const open = async (url: string): Promise<void> => {
+export const open = async (address: URL | string): Promise<void> => {
+  if (typeof address === "string") {
+    throw new Error("Cannot open socket paths")
+  }
+  // Web sockets do not seem to work if browsing with 0.0.0.0.
+  const url = new URL(address)
+  if (url.hostname === "0.0.0.0") {
+    url.hostname = "localhost"
+  }
   const args = [] as string[]
   const options = {} as cp.SpawnOptions
   const platform = (await isWsl()) ? "wsl" : process.platform
   let command = platform === "darwin" ? "open" : "xdg-open"
   if (platform === "win32" || platform === "wsl") {
     command = platform === "wsl" ? "cmd.exe" : "cmd"
     args.push("/c", "start", '""', "/b")
-    url = url.replace(/&/g, "^&")
+    url.search = url.search.replace(/&/g, "^&")
   }
-  const proc = cp.spawn(command, [...args, url], options)
+  const proc = cp.spawn(command, [...args, url.toString()], options)
   await new Promise<void>((resolve, reject) => {
     proc.on("error", reject)
     proc.on("close", (code) => {

test/utils/httpserver.ts

@@ -101,6 +101,9 @@ export class HttpServer {
    */
   public fetch(requestPath: string, opts?: RequestInit): Promise<Response> {
     const address = ensureAddress(this.hs, "http")
+    if (typeof address === "string") {
+      throw new Error("Cannot fetch socket path")
+    }
     address.pathname = requestPath
 
     return nodeFetch(address.toString(), opts)
@@ -111,6 +114,9 @@ export class HttpServer {
    */
   public ws(requestPath: string): Websocket {
     const address = ensureAddress(this.hs, "ws")
+    if (typeof address === "string") {
+      throw new Error("Cannot open websocket to socket path")
+    }
     address.pathname = requestPath
 
     return new Websocket(address.toString())