Connect message port from window to pty host

Tyriar · Tyriar · commit 3b26dc10c3ac · 2023-05-12T14:57:33.000-07:00
diff --git a/src/vs/platform/terminal/common/terminal.ts b/src/vs/platform/terminal/common/terminal.ts
@@ -207,6 +207,8 @@ export enum TerminalIpcChannels {
 	 * Communicates between the shared process and the pty host process.
 	 */
 	PtyHost = 'ptyHost',
+
+	PtyHostWindow = 'ptyHostWindow',
 	/**
 	 * Deals with logging from the pty host process.
 	 */
diff --git a/src/vs/platform/terminal/electron-main/electronPtyHostStarter.ts b/src/vs/platform/terminal/electron-main/electronPtyHostStarter.ts
@@ -12,6 +12,8 @@ import { IReconnectConstants } from 'vs/platform/terminal/common/terminal';
 import { IPtyHostConnection, IPtyHostStarter } from 'vs/platform/terminal/node/ptyHost';
 import { UtilityProcess } from 'vs/platform/utilityProcess/electron-main/utilityProcess';
 import { Client as MessagePortClient } from 'vs/base/parts/ipc/electron-main/ipc.mp';
+import { MessageChannelMain, MessagePortMain } from 'electron';
+import { assertIsDefined } from 'vs/base/common/types';
 
 export class ElectronPtyHostStarter implements IPtyHostStarter {
 
@@ -51,6 +53,8 @@ export class ElectronPtyHostStarter implements IPtyHostStarter {
 
 		return {
 			client,
+			port,
+			connect: () => assertIsDefined(this.utilityProcess).connect(),
 			dispose: client.dispose,
 			onDidProcessExit: this.utilityProcess.onExit
 		};
diff --git a/src/vs/platform/terminal/node/ptyHost.ts b/src/vs/platform/terminal/node/ptyHost.ts
@@ -9,6 +9,9 @@ import { IChannelClient } from 'vs/base/parts/ipc/common/ipc';
 
 export interface IPtyHostConnection extends IDisposable {
 	readonly client: IChannelClient;
+	// TODO: Type
+	readonly port?: any;
+	connect?(): any;
 	readonly onDidProcessExit: Event<{ code: number; signal: string }>;
 }
 
diff --git a/src/vs/platform/terminal/node/ptyHostMain.ts b/src/vs/platform/terminal/node/ptyHostMain.ts
@@ -21,8 +21,10 @@ import { HeartbeatService } from 'vs/platform/terminal/node/heartbeatService';
 import { PtyService } from 'vs/platform/terminal/node/ptyService';
 import { isUtilityProcess } from 'vs/base/parts/sandbox/node/electronTypes';
 
+const _isUtilityProcess = isUtilityProcess(process);
+
 let server: ChildProcessServer<string> | UtilityProcessServer;
-if (isUtilityProcess(process)) {
+if (_isUtilityProcess) {
 	server = new UtilityProcessServer();
 } else {
 	server = new ChildProcessServer(TerminalIpcChannels.PtyHost);
@@ -53,7 +55,11 @@ delete process.env.VSCODE_RECONNECT_SHORT_GRACE_TIME;
 delete process.env.VSCODE_RECONNECT_SCROLLBACK;
 
 const ptyService = new PtyService(lastPtyId, logService, productService, reconnectConstants);
-server.registerChannel(TerminalIpcChannels.PtyHost, ProxyChannel.fromService(ptyService));
+const ptyServiceChannel = ProxyChannel.fromService(ptyService);
+server.registerChannel(TerminalIpcChannels.PtyHost, ptyServiceChannel);
+if (_isUtilityProcess) {
+	server.registerChannel(TerminalIpcChannels.PtyHostWindow, ptyServiceChannel);
+}
 
 process.once('exit', () => {
 	logService.dispose();
diff --git a/src/vs/platform/terminal/node/ptyHostService.ts b/src/vs/platform/terminal/node/ptyHostService.ts
@@ -3,10 +3,12 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+import { IpcMainEvent, MessagePortMain } from 'electron';
 import { Emitter, Event } from 'vs/base/common/event';
 import { Disposable, toDisposable } from 'vs/base/common/lifecycle';
 import { IProcessEnvironment, OperatingSystem, isWindows } from 'vs/base/common/platform';
 import { ProxyChannel } from 'vs/base/parts/ipc/common/ipc';
+import { validatedIpcMain } from 'vs/base/parts/ipc/electron-main/ipcMain';
 import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
 import { ILogService, ILoggerService } from 'vs/platform/log/common/log';
 import { RemoteLoggerChannelClient } from 'vs/platform/log/common/logIpc';
@@ -94,6 +96,11 @@ export class PtyHostService extends Disposable implements IPtyService {
 		this._resolveVariablesRequestStore = this._register(new RequestStore(undefined, this._logService));
 		this._resolveVariablesRequestStore.onCreateRequest(this._onPtyHostRequestResolveVariables.fire, this._onPtyHostRequestResolveVariables);
 
+		validatedIpcMain.on('vscode:createPtyHostMessageChannel', (e, nonce) => this._onWindowConnection(e, nonce));
+
+		// TODO: Start on demand on first window connection (see SharedProcess.onWindowConnection
+		// TODO: Make direct message port connection to each window when requested
+
 		this._startPtyHost().then(value => {
 			this._connection = value[0];
 			this._proxy = value[1];
@@ -107,6 +114,22 @@ export class PtyHostService extends Disposable implements IPtyService {
 		});
 	}
 
+	private _onWindowConnection(e: IpcMainEvent, nonce: string) {
+		const port = this._connection.connect!() as MessagePortMain;
+
+
+		// Check back if the requesting window meanwhile closed
+		// Since shared process is delayed on startup there is
+		// a chance that the window close before the shared process
+		// was ready for a connection.
+
+		if (e.sender.isDestroyed()) {
+			return port.close();
+		}
+
+		e.sender.postMessage('vscode:createPtyHostMessageChannelResult', nonce, [port]);
+	}
+
 	private get _ignoreProcessNames(): string[] {
 		return this._configurationService.getValue<string[]>(TerminalSettingId.IgnoreProcessNames);
 	}
diff --git a/src/vs/workbench/contrib/terminal/electron-sandbox/localTerminalBackend.ts b/src/vs/workbench/contrib/terminal/electron-sandbox/localTerminalBackend.ts
@@ -14,7 +14,7 @@ import { ILogService } from 'vs/platform/log/common/log';
 import { INotificationService } from 'vs/platform/notification/common/notification';
 import { Registry } from 'vs/platform/registry/common/platform';
 import { IStorageService, StorageScope, StorageTarget } from 'vs/platform/storage/common/storage';
-import { ILocalPtyService, IProcessPropertyMap, IShellLaunchConfig, ITerminalChildProcess, ITerminalEnvironment, ITerminalProcessOptions, ITerminalsLayoutInfo, ITerminalsLayoutInfoById, ProcessPropertyType, TerminalSettingId, TitleEventSource } from 'vs/platform/terminal/common/terminal';
+import { ILocalPtyService, IProcessPropertyMap, IPtyService, IShellLaunchConfig, ITerminalChildProcess, ITerminalEnvironment, ITerminalProcessOptions, ITerminalsLayoutInfo, ITerminalsLayoutInfoById, ProcessPropertyType, TerminalIpcChannels, TerminalSettingId, TitleEventSource } from 'vs/platform/terminal/common/terminal';
 import { IGetTerminalLayoutInfoArgs, IProcessDetails, ISetTerminalLayoutInfoArgs } from 'vs/platform/terminal/common/terminalProcess';
 import { IWorkspaceContextService } from 'vs/platform/workspace/common/workspace';
 import { IWorkbenchContribution } from 'vs/workbench/common/contributions';
@@ -30,6 +30,10 @@ import { IProductService } from 'vs/platform/product/common/productService';
 import { IEnvironmentVariableService } from 'vs/workbench/contrib/terminal/common/environmentVariable';
 import { BaseTerminalBackend } from 'vs/workbench/contrib/terminal/browser/baseTerminalBackend';
 import { getWorkspaceForTerminal } from 'vs/workbench/services/configurationResolver/common/terminalResolver';
+import { INativeWorkbenchEnvironmentService } from 'vs/workbench/services/environment/electron-sandbox/environmentService';
+import { Client as MessagePortClient } from 'vs/base/parts/ipc/common/ipc.mp';
+import { acquirePort } from 'vs/base/parts/ipc/electron-sandbox/ipc.mp';
+import { ProxyChannel } from 'vs/base/parts/ipc/common/ipc';
 
 export class LocalTerminalBackendContribution implements IWorkbenchContribution {
 	constructor(
@@ -66,9 +70,30 @@ class LocalTerminalBackend extends BaseTerminalBackend implements ITerminalBacke
 		@IEnvironmentVariableService private readonly _environmentVariableService: IEnvironmentVariableService,
 		@INotificationService notificationService: INotificationService,
 		@IHistoryService historyService: IHistoryService,
+		@INativeWorkbenchEnvironmentService environmentService: INativeWorkbenchEnvironmentService
 	) {
 		super(_localPtyService, logService, notificationService, historyService, _configurationResolverService, workspaceContextService);
 
+
+
+
+		(async () => {
+			// mark('code/willConnectSharedProcess');
+			// this.logService.trace('Renderer->SharedProcess#connect: before acquirePort');
+			const port = await acquirePort('vscode:createPtyHostMessageChannel', 'vscode:createPtyHostMessageChannelResult');
+			// mark('code/didConnectSharedProcess');
+			// this.logService.trace('Renderer->SharedProcess#connect: connection established');
+
+			const client = new MessagePortClient(port, `window:${environmentService.window.id}`);
+			const proxy = ProxyChannel.toService<IPtyService>(client.getChannel(TerminalIpcChannels.PtyHostWindow));
+
+			logService.info('latency: ', proxy.getLatency(0));
+			proxy.onProcessData(e => {
+				logService.info('message port process data: ' + e.event);
+			});
+		})();
+
+
 		// Attach process listeners
 		this._localPtyService.onProcessData(e => this._ptys.get(e.id)?.handleData(e.event));
 		this._localPtyService.onDidChangeProperty(e => this._ptys.get(e.id)?.handleDidChangeProperty(e.property));

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,9 @@ import { IChannelClient } from 'vs/base/parts/ipc/common/ipc';`
`9`	`9`
`10`	`10`	`export interface IPtyHostConnection extends IDisposable {`
`11`	`11`	`readonly client: IChannelClient;`
	`12`	`+ // TODO: Type`
	`13`	`+ readonly port?: any;`
	`14`	`+ connect?(): any;`
`12`	`15`	`readonly onDidProcessExit: Event<{ code: number; signal: string }>;`
`13`	`16`	`}`
`14`	`17`