code-server/packages/server/src/cli.ts

import { field, logger } from "@coder/logger";
import { ServerMessage, SharedProcessActiveMessage } from "@coder/protocol/src/proto";
import { Command, flags } from "@oclif/command";
import * as fs from "fs";
import * as os from "os";
import * as path from "path";
import * as WebSocket from "ws";
import { createApp } from "./server";
import { requireModule } from "./vscode/bootstrapFork";
import { SharedProcess, SharedProcessState } from "./vscode/sharedProcess";
import { setup as setupNativeModules } from './modules';
import { fillFs } from './fill';

export class Entry extends Command {

	public static description = "Start your own self-hosted browser-accessible VS Code";
	public static flags = {
		cert: flags.string(),
		"cert-key": flags.string(),
		"data-dir": flags.string({ char: "d" }),
		help: flags.help(),
		host: flags.string({ char: "h", default: "0.0.0.0" }),
		open: flags.boolean({ char: "o", description: "Open in browser on startup" }),
		port: flags.integer({ char: "p", default: 8080, description: "Port to bind on" }),
		version: flags.version({ char: "v" }),

		// Dev flags
		"bootstrap-fork": flags.string({ hidden: true }),
		env: flags.string({ hidden: true }),
	};
	public static args = [{
		name: "workdir",
		description: "Specify working dir",
		default: (): string => process.cwd(),
	}];

	public async run(): Promise<void> {
		try {
			/**
			 * Suuuper janky
			 * Comes from - https://github.com/nexe/nexe/issues/524
			 * Seems to cleanup by removing this path immediately
			 * If any native module is added its assumed this pathname
			 * will change.
			 */
			require("spdlog");
			const nodePath = path.join(process.cwd(), "e91a410b");
			fs.unlinkSync(path.join(nodePath, "spdlog.node"));
			fs.rmdirSync(nodePath);
		} catch (ex) {
			logger.warn("Failed to remove extracted dependency.", field("dependency", "spdlog"), field("error", ex.message));
		}

		if (process.env.CLI) {
			fillFs();
		}

		const { args, flags } = this.parse(Entry);

		if (flags.env) {
			Object.assign(process.env, JSON.parse(flags.env));
		}

		const builtInExtensionsDir = path.join(process.env.BUILD_DIR || path.join(__dirname, ".."), "build/extensions");
		if (flags["bootstrap-fork"]) {
			const modulePath = flags["bootstrap-fork"];
			if (!modulePath) {
				logger.error("No module path specified to fork!");
				process.exit(1);
			}

			return requireModule(modulePath, builtInExtensionsDir);
		}

		const dataDir = flags["data-dir"] || path.join(os.homedir(), ".vscode-online");
		const workingDir = args["workdir"];

		if (process.env.BUILD_DIR && process.env.BUILD_DIR.startsWith(workingDir)) {
			logger.error("Cannot run binary inside of BUILD_DIR", field("build_dir", process.env.BUILD_DIR), field("cwd", process.cwd()));
			process.exit(1);
		}

		if (!fs.existsSync(dataDir)) {
			fs.mkdirSync(dataDir);
		}
		setupNativeModules(dataDir);

		const logDir = path.join(dataDir, "logs", new Date().toISOString().replace(/[-:.TZ]/g, ""));
		process.env.VSCODE_LOGS = logDir;

		logger.info("\u001B[1mvscode-remote v1.0.0");
		// TODO: fill in appropriate doc url
		logger.info("Additional documentation: https://coder.com/docs");
		logger.info("Initializing", field("data-dir", dataDir), field("working-dir", workingDir), field("log-dir", logDir));
		const sharedProcess = new SharedProcess(dataDir, builtInExtensionsDir);
		logger.info("Starting shared process...", field("socket", sharedProcess.socketPath));
		const sendSharedProcessReady = (socket: WebSocket): void => {
			const active = new SharedProcessActiveMessage();
			active.setSocketPath(sharedProcess.socketPath);
			active.setLogPath(logDir);
			const serverMessage = new ServerMessage();
			serverMessage.setSharedProcessActive(active);
			socket.send(serverMessage.serializeBinary());
		};
		sharedProcess.onState((event) => {
			if (event.state === SharedProcessState.Stopped) {
				logger.error("Shared process stopped. Restarting...", field("error", event.error));
			} else if (event.state === SharedProcessState.Starting) {
				logger.info("Starting shared process...");
			} else if (event.state === SharedProcessState.Ready) {
				logger.info("Shared process is ready!");
				app.wss.clients.forEach((c) => sendSharedProcessReady(c));
			}
		});

		const app = createApp((app) => {
			app.use((req, res, next) => {
				res.on("finish", () => {
					logger.debug(`\u001B[1m${req.method} ${res.statusCode} \u001B[0m${req.url}`, field("host", req.hostname), field("ip", req.ip));
				});

				next();
			});
			if ((process.env.CLI === "false" || !process.env.CLI) && !process.env.SERVE_STATIC) {
				const webpackConfig = require(path.join(__dirname, "..", "..", "web", "webpack.dev.config.js"));
				const compiler = require("webpack")(webpackConfig);
				app.use(require("webpack-dev-middleware")(compiler, {
					logger,
					publicPath: webpackConfig.output.publicPath,
					stats: webpackConfig.stats,
				}));
				app.use(require("webpack-hot-middleware")(compiler));
			}
		}, {
				builtInExtensionsDirectory: builtInExtensionsDir,
				dataDirectory: dataDir,
				workingDirectory: workingDir,
			});

		logger.info("Starting webserver...", field("host", flags.host), field("port", flags.port));
		app.server.listen(flags.port, flags.host);
		let clientId = 1;
		app.wss.on("connection", (ws, req) => {
			const id = clientId++;

			if (sharedProcess.state === SharedProcessState.Ready) {
				sendSharedProcessReady(ws);
			}

			logger.info(`WebSocket opened \u001B[0m${req.url}`, field("client", id), field("ip", req.socket.remoteAddress));

			ws.on("close", (code) => {
				logger.info(`WebSocket closed \u001B[0m${req.url}`, field("client", id), field("code", code));
			});
		});

		if (!flags["cert-key"] && !flags.cert) {
			logger.warn("No certificate specified. \u001B[1mThis could be insecure.");
			// TODO: fill in appropriate doc url
			logger.warn("Documentation on securing your setup: https://coder.com/docs");
		}

		logger.info(" ");
		logger.info("Password:\u001B[1m 023450wf09");
		logger.info(" ");
		logger.info("Started (click the link below to open):");
		logger.info(`http://localhost:${flags.port}/`);
		logger.info(" ");
	}

}

Entry.run(undefined, {
	root: process.env.BUILD_DIR as string || __dirname,
	//@ts-ignore
}).catch(require("@oclif/errors/handle"));