dsh-vscode-workbench 0.1.7 → 0.1.9

package/lib/index.js

@@ -1,11 +1,12 @@
 import { createRequire } from "node:module";
 import { access, lstat, mkdir, open, readFile, readdir, realpath, rename, rm, stat, writeFile } from "node:fs/promises";
-import { dirname, extname, isAbsolute, join, normalize, relative, resolve, sep } from "node:path";
+import { basename, dirname, extname, isAbsolute, join, normalize, relative, resolve, sep } from "node:path";
 import chokidar from "chokidar";
 import { WebSocket, WebSocketServer } from "ws";
 import { createHash, randomUUID } from "node:crypto";
 import { spawn } from "node:child_process";
-import { constants } from "node:fs";
+import { constants, realpathSync } from "node:fs";
+import * as pty from "node-pty";
 //#region src/wire.ts
 var WorkbenchError = class extends Error {
 	code;
@@ -67,23 +68,19 @@ function sendError(res, error) {
 		}
 	});
 }
-function trusted(req, allowed) {
-	const host = req.headers.host;
-	if (host === void 0 || req.headers["sec-fetch-site"] === "cross-site") return false;
-	let hostUrl;
-	try {
-		hostUrl = new URL(`http://${host}`);
-	} catch {
-		return false;
-	}
-	if (!(hostUrl.hostname === "localhost" || hostUrl.hostname === "[::1]" || /^127(?:\.\d{1,3}){3}$/.test(hostUrl.hostname)) && !allowed.some((candidate) => candidate === host || candidate === hostUrl.hostname)) return false;
-	const origin = req.headers.origin;
-	if (origin === void 0) return true;
-	try {
-		return new URL(origin).host === hostUrl.host;
-	} catch {
-		return false;
-	}
+/** Reuse Harness authentication and its deployment-aware Host/Origin fence. */
+function authorize(req, res, connection) {
+	const rejection = connection.requestRejection(req);
+	if (rejection === void 0) return true;
+	const code = rejection === 401 ? "unauthorized" : "forbidden";
+	send(res, rejection, {
+		ok: false,
+		error: {
+			code,
+			message: code
+		}
+	});
+	return false;
 }
 //#endregion
 //#region src/host.ts
@@ -91,8 +88,9 @@ const require = createRequire(import.meta.url);
 const TEXT_LIMIT = 5242880;
 const PROCESS_TIMEOUT = 3e4;
 function cwdFor(ctx, sessionId) {
-	const cwd = ctx.sessions.get(sessionId)?.header.cwd;
-	if (cwd === void 0 || cwd === "") return process.cwd();
+	const session = ctx.sessions.get(sessionId);
+	if (session === void 0) throw new WorkbenchError("session-not-found", "session not found", 404);
+	const cwd = ctx.workingDirectory.get(session);
 	if (!isAbsolute(cwd)) throw new WorkbenchError("cwd-invalid", "session working directory is not absolute");
 	return normalize(cwd);
 }
@@ -231,7 +229,7 @@ async function deleteEntry(cwd, path) {
 		force: false
 	});
 }
-const IMAGE_TYPES = {
+const PREVIEW_TYPES = {
 	".avif": "image/avif",
 	".bmp": "image/bmp",
 	".gif": "image/gif",
@@ -240,18 +238,29 @@ const IMAGE_TYPES = {
 	".jpg": "image/jpeg",
 	".png": "image/png",
 	".svg": "image/svg+xml",
-	".webp": "image/webp"
+	".webp": "image/webp",
+	".pdf": "application/pdf",
+	".doc": "application/msword",
+	".docx": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+	".odt": "application/vnd.oasis.opendocument.text"
 };
-/** Resolve an image inside the workspace for protected browser preview. */
-async function workspaceImage(cwd, path) {
+/** Resolve a supported preview file inside the workspace. */
+async function workspacePreviewFile(cwd, path) {
 	const resolved = await workspacePath(cwd, path);
-	const type = IMAGE_TYPES[extname(resolved.absolute).toLowerCase()];
-	if (type === void 0) throw new WorkbenchError("unsupported-media", "file is not a supported image", 415);
+	const type = PREVIEW_TYPES[extname(resolved.absolute).toLowerCase()];
+	if (type === void 0) throw new WorkbenchError("unsupported-media", "file is not a supported preview format", 415);
 	return {
 		path: resolved.absolute,
 		type
 	};
 }
+/** Resolve the PDF.js worker shipped with this plugin's runtime dependency. */
+function pdfWorkerAsset() {
+	return {
+		path: require.resolve("pdfjs-dist/legacy/build/pdf.worker.min.mjs"),
+		type: "text/javascript; charset=utf-8"
+	};
+}
 function run(command, args, cwd, timeout = PROCESS_TIMEOUT, signal) {
 	return new Promise((resolvePromise, reject) => {
 		const child = spawn(command, args, {
@@ -692,13 +701,229 @@ function monacoAsset(raw) {
 	};
 }
 //#endregion
+//#region src/terminal.ts
+const SENSITIVE = /(api[_-]?key|token|credential|secret|password|passwd|private[_-]?key|^dsh_.*(?:key|token|secret))/i;
+const MAX_TERMINALS = 8;
+const REPLAY_BYTES = 2097152;
+/** Remove credentials while retaining ordinary interactive-shell variables. */
+function sanitizedTerminalEnv(env) {
+	return Object.fromEntries(Object.entries(env).filter(([key, value]) => value !== void 0 && !SENSITIVE.test(key)));
+}
+/** Select the user's interactive shell with platform-specific fallbacks. */
+function defaultTerminalShell(platform = process.platform, env = process.env) {
+	if (platform === "win32") return {
+		shell: env.COMSPEC?.toLowerCase().includes("powershell") ? env.COMSPEC : "powershell.exe",
+		args: ["-NoLogo"]
+	};
+	return {
+		shell: env.SHELL || (platform === "darwin" ? "/bin/zsh" : "/bin/bash"),
+		args: ["-l"]
+	};
+}
+/** Own interactive terminals by their canonical workspace directory. */
+var TerminalManager = class {
+	workspaces = /* @__PURE__ */ new Map();
+	workspace(cwd) {
+		return realpathSync(cwd);
+	}
+	list(cwd) {
+		return [...this.workspaces.get(this.workspace(cwd))?.values() ?? []].map((handle) => ({ ...handle.info }));
+	}
+	create(cwd, title) {
+		const key = this.workspace(cwd);
+		const terminals = this.workspaces.get(key) ?? /* @__PURE__ */ new Map();
+		this.workspaces.set(key, terminals);
+		if (terminals.size >= MAX_TERMINALS) throw new Error(`terminal limit reached (${MAX_TERMINALS})`);
+		const { shell, args } = defaultTerminalShell();
+		const child = pty.spawn(shell, args, {
+			name: "xterm-256color",
+			cols: 80,
+			rows: 24,
+			cwd: key,
+			env: sanitizedTerminalEnv(process.env)
+		});
+		const info = {
+			id: randomUUID(),
+			title: title || basename(shell),
+			cwd: key,
+			running: true,
+			sequence: 0
+		};
+		const handle = {
+			info,
+			process: child,
+			replay: "",
+			listeners: /* @__PURE__ */ new Set()
+		};
+		terminals.set(info.id, handle);
+		child.onData((data) => {
+			info.sequence++;
+			handle.replay += data;
+			if (Buffer.byteLength(handle.replay) > REPLAY_BYTES) handle.replay = handle.replay.slice(-2097152);
+			for (const listener of handle.listeners) listener({
+				sequence: info.sequence,
+				data
+			});
+		});
+		child.onExit(({ exitCode }) => {
+			info.running = false;
+			info.exitCode = exitCode;
+			info.sequence++;
+			const data = `\r\n[process exited with code ${exitCode}]\r\n`;
+			for (const listener of handle.listeners) listener({
+				sequence: info.sequence,
+				data
+			});
+		});
+		return { ...info };
+	}
+	get(cwd, id) {
+		return this.workspaces.get(this.workspace(cwd))?.get(id);
+	}
+	close(cwd, id) {
+		const key = this.workspace(cwd);
+		const terminals = this.workspaces.get(key);
+		const handle = terminals?.get(id);
+		if (handle === void 0 || terminals === void 0) return;
+		terminals.delete(id);
+		try {
+			handle.process.kill();
+		} catch {}
+		if (terminals.size === 0) this.workspaces.delete(key);
+	}
+	rename(cwd, id, title) {
+		const handle = this.get(cwd, id);
+		if (handle === void 0) throw new Error("terminal not found");
+		handle.info.title = title;
+		return { ...handle.info };
+	}
+	dispose() {
+		for (const [cwd, terminals] of this.workspaces) for (const id of terminals.keys()) this.close(cwd, id);
+	}
+};
+function terminalRequestAllowed(req) {
+	const host = req.headers.host;
+	if (host === void 0 || req.headers["sec-fetch-site"] === "cross-site") return false;
+	let hostname;
+	try {
+		hostname = new URL(`http://${host}`).hostname;
+	} catch {
+		return false;
+	}
+	if (hostname !== "localhost" && hostname !== "[::1]" && !hostname.startsWith("127.")) return false;
+	const origin = req.headers.origin;
+	try {
+		return origin === void 0 || new URL(origin).host === host;
+	} catch {
+		return false;
+	}
+}
+/** Register the private local terminal API and WebSocket transport. */
+function installTerminal(ctx) {
+	const manager = new TerminalManager();
+	ctx.effect(() => ctx.webServer.register({
+		kind: "prefix",
+		path: "/dsh-vscode-terminal/api",
+		handler: async (req, res) => {
+			if (!authorize(req, res, ctx.connection)) return;
+			if (!terminalRequestAllowed(req)) return send(res, 403, {
+				ok: false,
+				error: { message: "forbidden" }
+			});
+			if (req.method !== "POST") return send(res, 405, {
+				ok: false,
+				error: { message: "POST required" }
+			});
+			try {
+				const body = await readBody(req);
+				const sessionId = typeof body.sessionId === "string" ? body.sessionId : "";
+				if (sessionId === "") throw new Error("sessionId required");
+				const cwd = cwdFor(ctx, sessionId);
+				const method = new URL(req.url ?? "/", "http://dsh.local").pathname.slice(25);
+				let value;
+				if (method === "list") value = manager.list(cwd);
+				else if (method === "create") value = manager.create(cwd, typeof body.title === "string" ? body.title : void 0);
+				else if (method === "close") {
+					manager.close(cwd, typeof body.id === "string" ? body.id : "");
+					value = manager.list(cwd);
+				} else if (method === "rename") value = manager.rename(cwd, typeof body.id === "string" ? body.id : "", typeof body.title === "string" ? body.title : "");
+				else throw new Error("unknown terminal method");
+				send(res, 200, {
+					ok: true,
+					value
+				});
+			} catch (error) {
+				sendError(res, error);
+			}
+		}
+	}), "dsh-vscode-workbench: terminal API");
+	const webSocket = new WebSocketServer({ noServer: true });
+	ctx.effect(() => ctx.webServer.registerUpgrade({
+		path: "/dsh-vscode-terminal/ws",
+		handler(req, socket, head) {
+			if (ctx.connection.requestRejection(req) !== void 0 || !terminalRequestAllowed(req)) {
+				socket.destroy();
+				return;
+			}
+			webSocket.handleUpgrade(req, socket, head, (connection) => {
+				const url = new URL(req.url ?? "/", "http://dsh.local");
+				const sessionId = url.searchParams.get("sessionId");
+				const id = url.searchParams.get("id");
+				if (sessionId === null || id === null) {
+					connection.close(1008, "sessionId and id required");
+					return;
+				}
+				let handle;
+				try {
+					handle = manager.get(cwdFor(ctx, sessionId), id);
+				} catch {
+					connection.close(1008, "session workspace unavailable");
+					return;
+				}
+				if (handle === void 0) {
+					connection.close(1008, "terminal not found");
+					return;
+				}
+				if (handle.replay !== "") connection.send(JSON.stringify({
+					type: "replay",
+					sequence: handle.info.sequence,
+					data: handle.replay
+				}));
+				const listener = (output) => {
+					if (connection.readyState === WebSocket.OPEN) connection.send(JSON.stringify({
+						type: "output",
+						...output
+					}));
+				};
+				handle.listeners.add(listener);
+				connection.on("message", (raw) => {
+					const text = raw.toString();
+					try {
+						const message = JSON.parse(text);
+						if (message !== null && typeof message === "object" && "type" in message && message.type === "input" && "data" in message && typeof message.data === "string") handle.process.write(message.data);
+						else if (message !== null && typeof message === "object" && "type" in message && message.type === "resize" && "cols" in message && "rows" in message && typeof message.cols === "number" && typeof message.rows === "number") handle.process.resize(Math.max(2, Math.floor(message.cols)), Math.max(2, Math.floor(message.rows)));
+					} catch {
+						handle.process.write(text);
+					}
+				});
+				connection.on("close", () => handle.listeners.delete(listener));
+			});
+		}
+	}), "dsh-vscode-workbench: terminal WebSocket");
+	ctx.effect(() => () => {
+		webSocket.close();
+		manager.dispose();
+	}, "dsh-vscode-workbench: terminal teardown");
+}
+//#endregion
 //#region src/index.ts
 /** DSH host plugin for the VS Code workbench. */
 const name = "dsh-vscode-workbench";
 const inject = [
 	"webServer",
 	"sessions",
-	"webRuntime"
+	"connection",
+	"workingDirectory"
 ];
 async function dispatch(ctx, method, body, signal) {
 	const cwd = cwdFor(ctx, stringField(body, "sessionId"));
@@ -720,15 +945,12 @@ async function dispatch(ctx, method, body, signal) {
 	}
 }
 function apply(ctx) {
+	installTerminal(ctx);
 	ctx.effect(() => ctx.webServer.register({
 		kind: "exact",
 		path: "/dsh-vscode/codicons/codicon.ttf",
 		handler: async (req, res) => {
-			if (!trusted(req, ctx.webRuntime.trustedHosts)) {
-				res.writeHead(403);
-				res.end();
-				return;
-			}
+			if (!authorize(req, res, ctx.connection)) return;
 			try {
 				const asset = codiconAsset();
 				res.writeHead(200, {
@@ -741,17 +963,28 @@ function apply(ctx) {
 			}
 		}
 	}), "dsh-vscode-workbench: Codicon font");
+	ctx.effect(() => ctx.webServer.register({
+		kind: "exact",
+		path: "/dsh-vscode/pdfjs/worker.mjs",
+		handler: async (req, res) => {
+			if (!authorize(req, res, ctx.connection)) return;
+			try {
+				const asset = pdfWorkerAsset();
+				res.writeHead(200, {
+					"content-type": asset.type,
+					"cache-control": "public, max-age=31536000, immutable"
+				});
+				res.end(await readFile(asset.path));
+			} catch (error) {
+				sendError(res, error);
+			}
+		}
+	}), "dsh-vscode-workbench: PDF.js worker");
 	ctx.effect(() => ctx.webServer.register({
 		kind: "prefix",
 		path: "/dsh-vscode/api",
 		handler: async (req, res) => {
-			if (!trusted(req, ctx.webRuntime.trustedHosts)) return send(res, 403, {
-				ok: false,
-				error: {
-					code: "forbidden",
-					message: "forbidden"
-				}
-			});
+			if (!authorize(req, res, ctx.connection)) return;
 			if (req.method !== "POST") return send(res, 405, {
 				ok: false,
 				error: {
@@ -775,13 +1008,7 @@ function apply(ctx) {
 		kind: "exact",
 		path: "/dsh-vscode/upload",
 		handler: async (req, res) => {
-			if (!trusted(req, ctx.webRuntime.trustedHosts)) return send(res, 403, {
-				ok: false,
-				error: {
-					code: "forbidden",
-					message: "forbidden"
-				}
-			});
+			if (!authorize(req, res, ctx.connection)) return;
 			if (req.method !== "POST") return send(res, 405, {
 				ok: false,
 				error: {
@@ -808,17 +1035,13 @@ function apply(ctx) {
 		kind: "prefix",
 		path: "/dsh-vscode/file",
 		handler: async (req, res) => {
-			if (!trusted(req, ctx.webRuntime.trustedHosts)) {
-				res.writeHead(403);
-				res.end();
-				return;
-			}
+			if (!authorize(req, res, ctx.connection)) return;
 			try {
 				const url = new URL(req.url ?? "/", "http://dsh.local");
 				const sessionId = url.searchParams.get("sessionId");
 				const path = url.searchParams.get("path");
 				if (sessionId === null || path === null) throw new WorkbenchError("bad-request", "sessionId and path are required");
-				const asset = await workspaceImage(cwdFor(ctx, sessionId), path);
+				const asset = await workspacePreviewFile(cwdFor(ctx, sessionId), path);
 				res.writeHead(200, {
 					"content-type": asset.type,
 					"x-content-type-options": "nosniff",
@@ -829,16 +1052,12 @@ function apply(ctx) {
 				sendError(res, error);
 			}
 		}
-	}), "dsh-vscode-workbench: image preview");
+	}), "dsh-vscode-workbench: file preview");
 	ctx.effect(() => ctx.webServer.register({
 		kind: "prefix",
 		path: "/dsh-vscode/monaco",
 		handler: async (req, res) => {
-			if (!trusted(req, ctx.webRuntime.trustedHosts)) {
-				res.writeHead(403);
-				res.end();
-				return;
-			}
+			if (!authorize(req, res, ctx.connection)) return;
 			try {
 				const asset = monacoAsset(decodeURIComponent(new URL(req.url ?? "/", "http://dsh.local").pathname.slice(19)));
 				res.writeHead(200, {
@@ -855,7 +1074,7 @@ function apply(ctx) {
 	ctx.effect(() => ctx.webServer.registerUpgrade({
 		path: "/dsh-vscode/ws/files",
 		handler(req, socket, head) {
-			if (!trusted(req, ctx.webRuntime.trustedHosts)) {
+			if (ctx.connection.requestRejection(req) !== void 0) {
 				socket.destroy();
 				return;
 			}
@@ -865,7 +1084,13 @@ function apply(ctx) {
 					ws.close(1008, "sessionId required");
 					return;
 				}
-				const workspace = cwdFor(ctx, sessionId);
+				let workspace;
+				try {
+					workspace = cwdFor(ctx, sessionId);
+				} catch {
+					ws.close(1008, "session workspace unavailable");
+					return;
+				}
 				const watcher = chokidar.watch(workspace, {
 					ignoreInitial: true,
 					ignored: /(^|[/\\])(\.git|node_modules|\.next|\.nuxt|\.turbo|\.vite|coverage)([/\\]|$)/,