coderaft 0.0.16 → 0.0.19

package/README.md

@@ -45,9 +45,11 @@ npx coderaft -o .
 ### Docker
 
 ```sh
-docker run -it --rm -p 6063:6063 node:lts-slim npx -y coderaft
+docker run -it --rm -p 6063:6063 -v coderaft:/data ghcr.io/pithings/coderaft
 ```
 
+Based on Alpine with Node.js LTS, bash, corepack (npm/pnpm/yarn) (~65 MB download, ~89 MB final). Data persists in `/data` volume (`/data/workspace` for project files, `/data/home` symlinked to `/root` for configs).
+
 ## Programmatic
 
 ```ts
@@ -137,13 +139,13 @@ interface CodeServerHandle {
 
 ### Server
 
-| Option                        | Description                                    |
-| ----------------------------- | ---------------------------------------------- |
-| `-p, --port <port>`           | Port to listen on (default: `$PORT` or `6063`) |
-| `-H, --host <host>`           | Host/interface to bind                         |
-| `--server-base-path <path>`   | Base path for the web UI (default: `/`)        |
-| `--socket-path <path>`        | Path to a socket file to listen on             |
-| `--print-startup-performance` | Print startup timing to stdout                 |
+| Option                        | Description                                         |
+| ----------------------------- | --------------------------------------------------- |
+| `-p, --port <port>`           | Port to listen on (default: `$PORT` or `6063`)      |
+| `-H, --host <host>`           | Host/interface to bind                              |
+| `--base-url <path>`           | Base URL the server is mounted under (default: `/`) |
+| `--socket-path <path>`        | Path to a socket file to listen on                  |
+| `--print-startup-performance` | Print startup timing to stdout                      |
 
 ### Auth
 

package/code.mjs

@@ -4,7 +4,7 @@ import { tmpdir } from "node:os";
 import { fileURLToPath } from "node:url";
 
 // Auto-updated by scripts/pack.ts
-const codeArchiveHash = "c2f3188affec085e";
+const codeArchiveHash = "30c02e4b77df8ee2";
 
 const archivePath = fileURLToPath(new URL("./code.tar.zst", import.meta.url));
 

package/dist/_chunks/server.mjs

@@ -151,6 +151,7 @@ async function createCodeServer(opts = {}) {
 	const withoutToken = opts.vscode?.["without-connection-token"] === true || !explicitToken && isLocal;
 	const connectionToken = withoutToken ? "" : opts.connectionToken ?? randomUUID();
 	const defaultFolder = opts.defaultFolder ?? process.cwd();
+	const baseURL = normalizeBaseURL(opts.baseURL ?? opts.vscode?.["server-base-path"]);
 	const mintKey = randomBytes(32);
 	process.env.CODE_SERVER_PARENT_PID ??= String(process.pid);
 	cleanupStaleLocks(opts.vscode?.["user-data-dir"] ?? join(_os.homedir(), ".vscode-server-oss", "data"));
@@ -172,6 +173,7 @@ async function createCodeServer(opts = {}) {
 	}
 	const vscodeServer = await (await mod.loadCodeWithNls()).createServer(null, {
 		"default-folder": defaultFolder,
+		...baseURL ? { "server-base-path": baseURL } : {},
 		...withoutToken ? { "without-connection-token": true } : { "connection-token": connectionToken },
 		"reconnection-grace-time": "30",
 		"disable-getting-started-override": true,
@@ -189,7 +191,8 @@ async function createCodeServer(opts = {}) {
 		connectionToken,
 		handleRequest(req, res) {
 			const method = req.method ?? "GET";
-			const url = (req.url ?? "/").split("?")[0];
+			const strippedUrl = stripBaseURL(req.url ?? "/", baseURL);
+			const url = strippedUrl.split("?")[0];
 			if (url === "/manifest.json") {
 				res.writeHead(200, {
 					"Content-Type": "application/manifest+json",
@@ -232,7 +235,7 @@ async function createCodeServer(opts = {}) {
 				return;
 			}
 			if (url === "/login" || url === "/logout") {
-				res.writeHead(302, { Location: "/" });
+				res.writeHead(302, { Location: `${baseURL}/` });
 				res.end();
 				return;
 			}
@@ -242,7 +245,7 @@ async function createCodeServer(opts = {}) {
 				});
 				return;
 			}
-			const proxyMatch = parseProxyPath(req.url ?? "/");
+			const proxyMatch = parseProxyPath(strippedUrl);
 			if (proxyMatch) {
 				const { port: targetPort, path: targetPath } = proxyMatch;
 				proxy.web(req, res, {
@@ -255,7 +258,7 @@ async function createCodeServer(opts = {}) {
 			vscodeServer.handleRequest(req, res);
 		},
 		handleUpgrade(req, socket, _head) {
-			const proxyMatch = parseProxyPath(req.url ?? "/");
+			const proxyMatch = parseProxyPath(stripBaseURL(req.url ?? "/", baseURL));
 			if (proxyMatch) {
 				const { port: targetPort, path: targetPath } = proxyMatch;
 				proxy.ws(req, socket, {
@@ -273,6 +276,7 @@ async function createCodeServer(opts = {}) {
 	};
 }
 async function startCodeServer(opts = {}) {
+	const socketPath = opts.socketPath;
 	const port = opts.port ?? (Number(process.env.PORT) || 6063);
 	const handler = await createCodeServer(opts);
 	const server = createServer((req, res) => {
@@ -281,7 +285,7 @@ async function startCodeServer(opts = {}) {
 	server.on("upgrade", (req, socket, head) => {
 		handler.handleUpgrade(req, socket, head);
 	});
-	const listen = (p) => new Promise((resolve, reject) => {
+	const listenTcp = (p) => new Promise((resolve, reject) => {
 		server.once("error", reject);
 		const cb = () => {
 			server.removeListener("error", reject);
@@ -290,17 +294,31 @@ async function startCodeServer(opts = {}) {
 		if (opts.host) server.listen(p, opts.host, cb);
 		else server.listen(p, cb);
 	});
-	try {
-		await listen(port);
+	const listenSocket = (path) => new Promise((resolve, reject) => {
+		try {
+			unlinkSync(path);
+		} catch {}
+		server.once("error", reject);
+		server.listen(path, () => {
+			server.removeListener("error", reject);
+			resolve();
+		});
+	});
+	if (socketPath) await listenSocket(socketPath);
+	else try {
+		await listenTcp(port);
 	} catch (err) {
-		if (err?.code === "EADDRINUSE") await listen(0);
+		if (err?.code === "EADDRINUSE") await listenTcp(0);
 		else throw err;
 	}
-	const actualPort = server.address().port;
+	const address = server.address();
+	const actualPort = address && typeof address === "object" && "port" in address ? address.port : void 0;
+	const basePath = normalizeBaseURL(opts.baseURL ?? opts.vscode?.["server-base-path"]);
 	return {
 		server,
 		port: actualPort,
-		url: handler.connectionToken ? `http://localhost:${actualPort}/?tkn=${handler.connectionToken}` : `http://localhost:${actualPort}/`,
+		socketPath,
+		url: socketPath ? `unix:${socketPath}` : handler.connectionToken ? `http://localhost:${actualPort}${basePath}/?tkn=${handler.connectionToken}` : `http://localhost:${actualPort}${basePath}/`,
 		connectionToken: handler.connectionToken,
 		async close() {
 			await handler.dispose();
@@ -308,6 +326,9 @@ async function startCodeServer(opts = {}) {
 			await new Promise((resolve, reject) => {
 				server.close((err) => err ? reject(err) : resolve());
 			});
+			if (socketPath) try {
+				unlinkSync(socketPath);
+			} catch {}
 		}
 	};
 }
@@ -364,6 +385,19 @@ function parseProxyPath(url) {
 		path: (match[2] || "/") + query
 	};
 }
+function normalizeBaseURL(input) {
+	if (!input || input === "/") return "";
+	let result = input.trim();
+	if (!result.startsWith("/")) result = "/" + result;
+	while (result.endsWith("/")) result = result.slice(0, -1);
+	return result;
+}
+function stripBaseURL(url, baseURL) {
+	if (!baseURL) return url;
+	if (url === baseURL) return "/";
+	if (url.startsWith(baseURL + "/") || url.startsWith(baseURL + "?")) return url.slice(baseURL.length) || "/";
+	return url;
+}
 function sendJson(res, status, body) {
 	const payload = JSON.stringify(body);
 	res.writeHead(status, {

package/dist/cli.mjs

@@ -12,6 +12,7 @@ const { values, positionals } = parseArgs({
 			type: "string",
 			short: "H"
 		},
+		"base-url": { type: "string" },
 		"server-base-path": { type: "string" },
 		"socket-path": { type: "string" },
 		"print-startup-performance": { type: "boolean" },
@@ -92,7 +93,7 @@ if (values.help) {
   Server:
     -p, --port <port>                    Port to listen on (default: $PORT or 6063)
     -H, --host <host>                    Host/interface to bind
-        --server-base-path <path>        Base path for the web UI (default: /)
+        --base-url <path>                Base URL the server is mounted under (default: /)
         --socket-path <path>             Path to a socket file to listen on
         --print-startup-performance      Print startup timing to stdout
 
@@ -175,7 +176,6 @@ if (values.help) {
 const vscode = {};
 for (const key of [
 	"server-base-path",
-	"socket-path",
 	"print-startup-performance",
 	"connection-token-file",
 	"without-connection-token",
@@ -224,9 +224,22 @@ for (const key of [
 if (values["logs-path"]) vscode.logsPath = values["logs-path"];
 const dir = positionals[0];
 if (dir) vscode["disable-workspace-trust"] = true;
-const handle = await startCodeServer({
+let handle;
+let shuttingDown = false;
+const shutdown = () => {
+	if (shuttingDown) process.exit(0);
+	shuttingDown = true;
+	setTimeout(() => process.exit(0), 3e3).unref();
+	if (handle) handle.close().finally(() => process.exit(0));
+	else process.exit(0);
+};
+process.on("SIGINT", shutdown);
+process.on("SIGTERM", shutdown);
+handle = await startCodeServer({
 	port: values.port ? Number(values.port) : void 0,
 	host: values.host,
+	socketPath: values["socket-path"],
+	baseURL: values["base-url"] ?? values["server-base-path"],
 	defaultFolder: dir || values["default-folder"],
 	connectionToken: values["connection-token"] ?? values.token,
 	vscode
@@ -247,13 +260,4 @@ if (values.open) {
 	else if (platform === "win32") exec(`start chrome --app="${url}" || start msedge --app="${url}" || start "" "${url}"`);
 	else exec(`google-chrome-stable --app="${url}" 2>/dev/null || google-chrome --app="${url}" 2>/dev/null || chromium --app="${url}" 2>/dev/null || xdg-open "${url}"`);
 }
-let shuttingDown = false;
-const shutdown = () => {
-	if (shuttingDown) process.exit(0);
-	shuttingDown = true;
-	setTimeout(() => process.exit(0), 3e3).unref();
-	handle.close().finally(() => process.exit(0));
-};
-process.on("SIGINT", shutdown);
-process.on("SIGTERM", shutdown);
 export {};

package/dist/index.d.mts

@@ -85,12 +85,20 @@ interface CreateCodeServerOptions {
   connectionToken?: string;
   /** Host/interface to bind (used to infer local-only access for token default). */
   host?: string;
+  /**
+   * Base URL the server is mounted under (e.g. `/code`). Defaults to `/`.
+   * Forwarded to VS Code as `server-base-path` and honored by coderaft's own
+   * routes (`/healthz`, `/_static/*`, `/proxy/*`, `/login`, …).
+   */
+  baseURL?: string;
   /** Extra options forwarded to VS Code's `createServer()`. */
   vscode?: VSCodeServerOptions;
 }
 interface StartCodeServerOptions extends CreateCodeServerOptions {
-  /** TCP port to listen on. Defaults to `$PORT` or `6063`. */
+  /** TCP port to listen on. Defaults to `$PORT` or `6063`. Ignored when `socketPath` is set. */
   port?: number;
+  /** Unix socket path to listen on. When set, `port` and `host` are ignored. */
+  socketPath?: string;
 }
 interface CodeServerHandler {
   /** Node-style HTTP request handler (middleware). */
@@ -102,7 +110,10 @@ interface CodeServerHandler {
 }
 interface CodeServerHandle {
   server: Server;
-  port: number;
+  /** TCP port the server is bound to, or `undefined` when listening on a unix socket. */
+  port?: number;
+  /** Unix socket path the server is bound to, or `undefined` when listening on TCP. */
+  socketPath?: string;
   url: string;
   connectionToken: string;
   close(): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "coderaft",
-  "version": "0.0.16",
+  "version": "0.0.19",
   "repository": "pithings/coderaft",
   "bin": {
     "coderaft": "./dist/cli.mjs"