Add shared process active message (#16)

* Add shared process active message

* Add client function for calling bootstrap fork

Author: kylecarbs

packages/protocol/src/browser/client.ts

@@ -155,6 +155,15 @@ export class Client {
 		return this.doSpawn(modulePath, args, options, true);
 	}
 
+	/**
+	 * VS Code specific.
+	 * Forks a module from bootstrap-fork
+	 * @param modulePath Path of the module
+	 */
+	public bootstrapFork(modulePath: string): ChildProcess {
+		return this.doSpawn(modulePath, [], undefined, true, true);
+	}
+
 	public createConnection(path: string, callback?: () => void): Socket;
 	public createConnection(port: number, callback?: () => void): Socket;
 	public createConnection(target: string | number, callback?: () => void): Socket {
@@ -176,13 +185,14 @@ export class Client {
 		return socket;
 	}
 
-	private doSpawn(command: string, args: string[] = [], options?: SpawnOptions, isFork: boolean = false): ChildProcess {
+	private doSpawn(command: string, args: string[] = [], options?: SpawnOptions, isFork: boolean = false, isBootstrapFork: boolean = true): ChildProcess {
 		const id = this.sessionId++;
 		const newSess = new NewSessionMessage();
 		newSess.setId(id);
 		newSess.setCommand(command);
 		newSess.setArgsList(args);
 		newSess.setIsFork(isFork);
+		newSess.setIsBootstrapFork(isBootstrapFork);
 		if (options) {
 			if (options.cwd) {
 				newSess.setCwd(options.cwd);

packages/protocol/src/node/command.ts

@@ -5,6 +5,7 @@ import * as stream from "stream";
 import { TextEncoder } from "text-encoding";
 import { NewSessionMessage, ServerMessage, SessionDoneMessage, SessionOutputMessage, ShutdownSessionMessage, IdentifySessionMessage, ClientMessage, NewConnectionMessage, ConnectionEstablishedMessage, NewConnectionFailureMessage, ConnectionCloseMessage, ConnectionOutputMessage } from "../proto";
 import { SendableConnection } from "../common/connection";
+import { ServerOptions } from "./server";
 
 export interface Process {
 	stdin?: stream.Writable;
@@ -22,7 +23,7 @@ export interface Process {
 	title?: number;
 }
 
-export const handleNewSession = (connection: SendableConnection, newSession: NewSessionMessage, onExit: () => void): Process => {
+export const handleNewSession = (connection: SendableConnection, newSession: NewSessionMessage, serverOptions: ServerOptions | undefined, onExit: () => void): Process => {
 	let process: Process;
 
 	const env = {} as any;
@@ -44,7 +45,15 @@ export const handleNewSession = (connection: SendableConnection, newSession: New
 		};
 		let proc: cp.ChildProcess;
 		if (newSession.getIsFork()) {
-			proc = cp.fork(newSession.getCommand(), newSession.getArgsList());
+			if (!serverOptions) {
+				throw new Error("No forkProvider set for bootstrap-fork request");
+			}
+
+			if (!serverOptions.forkProvider) {
+				throw new Error("No forkProvider set for server options");
+			}
+
+			proc = serverOptions.forkProvider(newSession);
 		} else {
 			proc = cp.spawn(newSession.getCommand(), newSession.getArgsList(), options);
 		}
@@ -107,7 +116,7 @@ export const handleNewSession = (connection: SendableConnection, newSession: New
 
 export const handleNewConnection = (connection: SendableConnection, newConnection: NewConnectionMessage, onExit: () => void): net.Socket => {
 	const id = newConnection.getId();
-	let socket: net.Socket;	
+	let socket: net.Socket;
 	let didConnect = false;
 	const connectCallback = () => {
 		didConnect = true;
@@ -134,7 +143,7 @@ export const handleNewConnection = (connection: SendableConnection, newConnectio
 			const servMsg = new ServerMessage();
 			servMsg.setConnectionFailure(errMsg);
 			connection.send(servMsg.serializeBinary());
-		
+
 			onExit();
 		}
 	});

packages/protocol/src/node/server.ts

@@ -1,10 +1,11 @@
 import * as os from "os";
+import * as cp from "child_process";
 import * as path from "path";
 import { mkdir } from "fs";
 import { promisify } from "util";
 import { TextDecoder } from "text-encoding";
 import { logger, field } from "@coder/logger";
-import { ClientMessage, WorkingInitMessage, ServerMessage } from "../proto";
+import { ClientMessage, WorkingInitMessage, ServerMessage, NewSessionMessage } from "../proto";
 import { evaluate } from "./evaluate";
 import { ReadWriteConnection } from "../common/connection";
 import { Process, handleNewSession, handleNewConnection } from "./command";
@@ -13,6 +14,8 @@ import * as net from "net";
 export interface ServerOptions {
 	readonly workingDirectory: string;
 	readonly dataDirectory: string;
+
+	forkProvider?(message: NewSessionMessage): cp.ChildProcess;
 }
 
 export class Server {
@@ -22,7 +25,7 @@ export class Server {
 
 	public constructor(
 		private readonly connection: ReadWriteConnection,
-		options?: ServerOptions,
+		private readonly options?: ServerOptions,
 	) {
 		connection.onMessage((data) => {
 			try {
@@ -89,7 +92,7 @@ export class Server {
 		if (message.hasNewEval()) {
 			evaluate(this.connection, message.getNewEval()!);
 		} else if (message.hasNewSession()) {
-			const session = handleNewSession(this.connection, message.getNewSession()!, () => {
+			const session = handleNewSession(this.connection, message.getNewSession()!, this.options, () => {
 				this.sessions.delete(message.getNewSession()!.getId());
 			});
 			this.sessions.set(message.getNewSession()!.getId(), session);

packages/protocol/src/proto/client.proto

@@ -17,8 +17,6 @@ message ClientMessage {
 
 		// node.proto
 		NewEvalMessage new_eval = 9;
-
-		SharedProcessInitMessage shared_process_init = 10;
 	}
 }
 
@@ -39,6 +37,9 @@ message ServerMessage {
 		EvalDoneMessage eval_done = 10;
 
 		WorkingInitMessage init = 11;
+
+		// vscode.proto
+		SharedProcessActiveMessage shared_process_active = 12;
 	}
 }
 

packages/protocol/src/proto/client_pb.d.ts

@@ -52,11 +52,6 @@ export class ClientMessage extends jspb.Message {
   getNewEval(): node_pb.NewEvalMessage | undefined;
   setNewEval(value?: node_pb.NewEvalMessage): void;
 
-  hasSharedProcessInit(): boolean;
-  clearSharedProcessInit(): void;
-  getSharedProcessInit(): vscode_pb.SharedProcessInitMessage | undefined;
-  setSharedProcessInit(value?: vscode_pb.SharedProcessInitMessage): void;
-
   getMsgCase(): ClientMessage.MsgCase;
   serializeBinary(): Uint8Array;
   toObject(includeInstance?: boolean): ClientMessage.AsObject;
@@ -79,7 +74,6 @@ export namespace ClientMessage {
     connectionOutput?: command_pb.ConnectionOutputMessage.AsObject,
     connectionClose?: command_pb.ConnectionCloseMessage.AsObject,
     newEval?: node_pb.NewEvalMessage.AsObject,
-    sharedProcessInit?: vscode_pb.SharedProcessInitMessage.AsObject,
   }
 
   export enum MsgCase {
@@ -93,7 +87,6 @@ export namespace ClientMessage {
     CONNECTION_OUTPUT = 7,
     CONNECTION_CLOSE = 8,
     NEW_EVAL = 9,
-    SHARED_PROCESS_INIT = 10,
   }
 }
 
@@ -153,6 +146,11 @@ export class ServerMessage extends jspb.Message {
   getInit(): WorkingInitMessage | undefined;
   setInit(value?: WorkingInitMessage): void;
 
+  hasSharedProcessActive(): boolean;
+  clearSharedProcessActive(): void;
+  getSharedProcessActive(): vscode_pb.SharedProcessActiveMessage | undefined;
+  setSharedProcessActive(value?: vscode_pb.SharedProcessActiveMessage): void;
+
   getMsgCase(): ServerMessage.MsgCase;
   serializeBinary(): Uint8Array;
   toObject(includeInstance?: boolean): ServerMessage.AsObject;
@@ -177,6 +175,7 @@ export namespace ServerMessage {
     evalFailed?: node_pb.EvalFailedMessage.AsObject,
     evalDone?: node_pb.EvalDoneMessage.AsObject,
     init?: WorkingInitMessage.AsObject,
+    sharedProcessActive?: vscode_pb.SharedProcessActiveMessage.AsObject,
   }
 
   export enum MsgCase {
@@ -192,6 +191,7 @@ export namespace ServerMessage {
     EVAL_FAILED = 9,
     EVAL_DONE = 10,
     INIT = 11,
+    SHARED_PROCESS_ACTIVE = 12,
   }
 }
 

packages/protocol/src/proto/client_pb.js

@@ -13,6 +13,9 @@ message NewSessionMessage {
 	string cwd = 5;
 	TTYDimensions tty_dimensions = 6;
 	bool is_fork = 7;
+	
+	// Janky, but required for having custom handling of the bootstrap fork
+	bool is_bootstrap_fork = 8;
 }
 
 // Sent when starting a session failed.