Recover on pty host reconnect

Tyriar · Tyriar · commit f9e6b352d1cf · 2021-03-08T05:26:22.000-08:00
Fixes #117990
diff --git a/src/vs/platform/terminal/common/terminal.ts b/src/vs/platform/terminal/common/terminal.ts
@@ -71,6 +71,7 @@ export interface IPtyService {
 	readonly onPtyHostExit?: Event<number>;
 	readonly onPtyHostStart?: Event<void>;
 	readonly onPtyHostUnresponsive?: Event<void>;
+	readonly onPtyHostResponsive?: Event<void>;
 
 	readonly onProcessData: Event<{ id: number, event: IProcessDataEvent | string }>;
 	readonly onProcessExit: Event<{ id: number, event: number | undefined }>;
diff --git a/src/vs/platform/terminal/electron-browser/localPtyService.ts b/src/vs/platform/terminal/electron-browser/localPtyService.ts
@@ -43,6 +43,8 @@ export class LocalPtyService extends Disposable implements IPtyService {
 	readonly onPtyHostStart = this._onPtyHostStart.event;
 	private readonly _onPtyHostUnresponsive = this._register(new Emitter<void>());
 	readonly onPtyHostUnresponsive = this._onPtyHostUnresponsive.event;
+	private readonly _onPtyHostResponsive = this._register(new Emitter<void>());
+	readonly onPtyHostResponsive = this._onPtyHostResponsive.event;
 
 	private readonly _onProcessData = this._register(new Emitter<{ id: number, event: IProcessDataEvent | string }>());
 	readonly onProcessData = this._onProcessData.event;
@@ -186,6 +188,7 @@ export class LocalPtyService extends Disposable implements IPtyService {
 	private _handleHeartbeat() {
 		this._clearHeartbeatTimeouts();
 		this._heartbeatFirstTimeout = setTimeout(() => this._handleHeartbeatFirstTimeout(), HeartbeatConstants.BeatInterval * HeartbeatConstants.FirstWaitMultiplier);
+		this._onPtyHostResponsive.fire();
 	}
 
 	private _handleHeartbeatFirstTimeout() {
diff --git a/src/vs/workbench/contrib/terminal/browser/terminal.ts b/src/vs/workbench/contrib/terminal/browser/terminal.ts
@@ -36,6 +36,16 @@ export interface ITerminalInstanceService {
 	 * terminals using this pty host connection and mark them as disconnected.
 	 */
 	onPtyHostUnresponsive: Event<void>;
+	/**
+	 * Fired when the ptyHost process becomes responsive after being non-responsive. Allowing
+	 * previously disconnected terminals to reconnect.
+	 */
+	onPtyHostResponsive: Event<void>;
+	/**
+	 * Fired when the ptyHost has been restarted, this is used as a signal for listening terminals
+	 * that its pty has been lost and will remain disconnected.
+	 */
+	onPtyHostRestart: Event<void>;
 
 	// These events are optional as the requests they make are only needed on the browser side
 	onRequestDefaultShellAndArgs?: Event<IDefaultShellAndArgsRequest>;
@@ -287,6 +297,11 @@ export interface ITerminalInstance {
 	 */
 	readonly shouldPersist: boolean;
 
+	/**
+	 * Whether the process communication channel has been disconnected.
+	 */
+	readonly isDisconnected: boolean;
+
 	/**
 	 * An event that fires when the terminal instance's title changes.
 	 */
diff --git a/src/vs/workbench/contrib/terminal/browser/terminalInstance.ts b/src/vs/workbench/contrib/terminal/browser/terminalInstance.ts
@@ -156,6 +156,7 @@ export class TerminalInstance extends Disposable implements ITerminalInstance {
 	public get shellType(): TerminalShellType { return this._shellType; }
 	public get commandTracker(): CommandTrackerAddon | undefined { return this._commandTrackerAddon; }
 	public get navigationMode(): INavigationMode | undefined { return this._navigationModeAddon; }
+	public get isDisconnected(): boolean { return this._processManager.isDisconnected; }
 
 	private readonly _onExit = new Emitter<number | undefined>();
 	public get onExit(): Event<number | undefined> { return this._onExit.event; }
@@ -957,8 +958,11 @@ export class TerminalInstance extends Disposable implements ITerminalInstance {
 		this._processManager.onEnvironmentVariableInfoChanged(e => this._onEnvironmentVariableInfoChanged(e));
 		this._processManager.onPtyDisconnect(() => {
 			this._safeSetOption('disableStdin', true);
-			// Use api source so it cannot be overridden
-			this.setTitle(nls.localize('ptyDisconnected', "{0} (disconnected)", this._title), TitleEventSource.Api);
+			this._onTitleChanged.fire(this);
+		});
+		this._processManager.onPtyReconnect(() => {
+			this._safeSetOption('disableStdin', false);
+			this._onTitleChanged.fire(this);
 		});
 
 		if (this._shellLaunchConfig.name) {
diff --git a/src/vs/workbench/contrib/terminal/browser/terminalInstanceService.ts b/src/vs/workbench/contrib/terminal/browser/terminalInstanceService.ts
@@ -10,7 +10,7 @@ import type { SearchAddon as XTermSearchAddon } from 'xterm-addon-search';
 import type { Unicode11Addon as XTermUnicode11Addon } from 'xterm-addon-unicode11';
 import type { WebglAddon as XTermWebglAddon } from 'xterm-addon-webgl';
 import { IProcessEnvironment } from 'vs/base/common/platform';
-import { Emitter } from 'vs/base/common/event';
+import { Emitter, Event } from 'vs/base/common/event';
 import { registerSingleton } from 'vs/platform/instantiation/common/extensions';
 import { Disposable } from 'vs/base/common/lifecycle';
 import { ITerminalsLayoutInfoById, ITerminalsLayoutInfo, ITerminalChildProcess } from 'vs/platform/terminal/common/terminal';
@@ -24,10 +24,10 @@ let WebglAddon: typeof XTermWebglAddon;
 export class TerminalInstanceService extends Disposable implements ITerminalInstanceService {
 	public _serviceBrand: undefined;
 
-	private readonly _onPtyHostExit = this._register(new Emitter<void>());
-	readonly onPtyHostExit = this._onPtyHostExit.event;
-	private readonly _onPtyHostUnresponsive = this._register(new Emitter<void>());
-	readonly onPtyHostUnresponsive = this._onPtyHostUnresponsive.event;
+	readonly onPtyHostExit = Event.None;
+	readonly onPtyHostUnresponsive = Event.None;
+	readonly onPtyHostResponsive = Event.None;
+	readonly onPtyHostRestart = Event.None;
 	private readonly _onRequestDefaultShellAndArgs = this._register(new Emitter<IDefaultShellAndArgsRequest>());
 	readonly onRequestDefaultShellAndArgs = this._onRequestDefaultShellAndArgs.event;
 
diff --git a/src/vs/workbench/contrib/terminal/browser/terminalProcessManager.ts b/src/vs/workbench/contrib/terminal/browser/terminalProcessManager.ts
@@ -21,7 +21,7 @@ import { IProductService } from 'vs/platform/product/common/productService';
 import { IRemoteTerminalService, ITerminalInstanceService } from 'vs/workbench/contrib/terminal/browser/terminal';
 import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
 import { IRemoteAgentService } from 'vs/workbench/services/remote/common/remoteAgentService';
-import { Disposable } from 'vs/base/common/lifecycle';
+import { Disposable, IDisposable, toDisposable } from 'vs/base/common/lifecycle';
 import { withNullAsUndefined } from 'vs/base/common/types';
 import { EnvironmentVariableInfoChangesActive, EnvironmentVariableInfoStale } from 'vs/workbench/contrib/terminal/browser/environmentVariableInfo';
 import { IPathService } from 'vs/workbench/services/path/common/pathService';
@@ -57,6 +57,7 @@ export class TerminalProcessManager extends Disposable implements ITerminalProce
 	public remoteAuthority: string | undefined;
 	public os: platform.OperatingSystem | undefined;
 	public userHome: string | undefined;
+	public isDisconnected: boolean = false;
 
 	private _process: ITerminalChildProcess | null = null;
 	private _processType: ProcessType = ProcessType.Process;
@@ -68,9 +69,13 @@ export class TerminalProcessManager extends Disposable implements ITerminalProce
 	private _environmentVariableInfo: IEnvironmentVariableInfo | undefined;
 	private _ackDataBufferer: AckDataBufferer;
 	private _hasWrittenData: boolean = false;
+	private _ptyResponsiveListener: IDisposable | undefined;
 
 	private readonly _onPtyDisconnect = this._register(new Emitter<void>());
 	public get onPtyDisconnect(): Event<void> { return this._onPtyDisconnect.event; }
+	private readonly _onPtyReconnect = this._register(new Emitter<void>());
+	public get onPtyReconnect(): Event<void> { return this._onPtyReconnect.event; }
+
 	private readonly _onProcessReady = this._register(new Emitter<void>());
 	public get onProcessReady(): Event<void> { return this._onProcessReady.event; }
 	private readonly _onBeforeProcessData = this._register(new Emitter<IBeforeProcessDataEvent>());
@@ -328,7 +333,20 @@ export class TerminalProcessManager extends Disposable implements ITerminalProce
 		const useConpty = this._configHelper.config.windowsEnableConpty && !isScreenReaderModeEnabled;
 		const shouldPersist = this._configHelper.config.enablePersistentSessions && !shellLaunchConfig.isFeatureTerminal;
 
-		this._terminalInstanceService.onPtyHostUnresponsive(() => this._onPtyDisconnect.fire());
+		this._register(this._terminalInstanceService.onPtyHostUnresponsive(() => {
+			this.isDisconnected = true;
+			this._onPtyDisconnect.fire();
+		}));
+		this._ptyResponsiveListener = this._terminalInstanceService.onPtyHostResponsive(() => {
+			this.isDisconnected = false;
+			this._onPtyReconnect.fire();
+		});
+		this._register(toDisposable(() => this._ptyResponsiveListener?.dispose()));
+		this._register(this._terminalInstanceService.onPtyHostRestart(() => {
+			// When the pty host restarts, reconnect is no longer possible
+			this._ptyResponsiveListener?.dispose();
+			this._ptyResponsiveListener = undefined;
+		}));
 		return await this._terminalInstanceService.createTerminalProcess(shellLaunchConfig, initialCwd, cols, rows, env, useConpty, shouldPersist);
 	}
 
diff --git a/src/vs/workbench/contrib/terminal/browser/terminalService.ts b/src/vs/workbench/contrib/terminal/browser/terminalService.ts
@@ -340,7 +340,9 @@ export class TerminalService implements ITerminalService {
 	}
 
 	public getTabLabels(): string[] {
-		return this._terminalTabs.filter(tab => tab.terminalInstances.length > 0).map((tab, index) => `${index + 1}: ${tab.title ? tab.title : ''}`);
+		return this._terminalTabs.filter(tab => tab.terminalInstances.length > 0).map((tab, index) => {
+			return `${index + 1}: ${tab.title ? tab.title : ''}`;
+		});
 	}
 
 	public getFindState(): FindReplaceState {
diff --git a/src/vs/workbench/contrib/terminal/browser/terminalTab.ts b/src/vs/workbench/contrib/terminal/browser/terminalTab.ts
@@ -12,6 +12,7 @@ import { IInstantiationService } from 'vs/platform/instantiation/common/instanti
 import { ITerminalInstance, Direction, ITerminalTab, ITerminalService } from 'vs/workbench/contrib/terminal/browser/terminal';
 import { ViewContainerLocation, IViewDescriptorService } from 'vs/workbench/common/views';
 import { IShellLaunchConfig, ITerminalTabLayoutInfoById } from 'vs/platform/terminal/common/terminal';
+import { localize } from 'vs/nls';
 
 const SPLIT_PANE_MIN_SIZE = 120;
 
@@ -402,15 +403,20 @@ export class TerminalTab extends Disposable implements ITerminalTab {
 	}
 
 	public get title(): string {
-		let title = this.terminalInstances[0].title;
+		let title = this._titleWithConnectionStatus(this.terminalInstances[0]);
 		for (let i = 1; i < this.terminalInstances.length; i++) {
-			if (this.terminalInstances[i].title) {
-				title += `, ${this.terminalInstances[i].title}`;
+			const instance = this.terminalInstances[i];
+			if (instance.title) {
+				title += `, ${this._titleWithConnectionStatus(instance)}`;
 			}
 		}
 		return title;
 	}
 
+	private _titleWithConnectionStatus(instance: ITerminalInstance): string {
+		return instance.isDisconnected ? localize('ptyDisconnected', "{0} (disconnected)", instance.title) : instance.title;
+	}
+
 	public setVisible(visible: boolean): void {
 		this._isVisible = visible;
 		if (this._tabElement) {
diff --git a/src/vs/workbench/contrib/terminal/browser/terminalView.ts b/src/vs/workbench/contrib/terminal/browser/terminalView.ts
@@ -397,9 +397,15 @@ class SwitchTerminalActionViewItem extends SelectActionViewItem {
 }
 
 function getTerminalSelectOpenItems(terminalService: ITerminalService, contributions: ITerminalContributionService): ISelectOptionItem[] {
-	const items = terminalService.connectionState === TerminalConnectionState.Connected ?
-		terminalService.getTabLabels().map(label => <ISelectOptionItem>{ text: label }) :
-		[{ text: nls.localize('terminalConnectingLabel', "Starting...") }];
+	let items: ISelectOptionItem[];
+
+	if (terminalService.connectionState === TerminalConnectionState.Connected) {
+		items = terminalService.getTabLabels().map(label => {
+			return { text: label };
+		});
+	} else {
+		items = [{ text: nls.localize('terminalConnectingLabel', "Starting...") }];
+	}
 
 	items.push({ text: switchTerminalActionViewItemSeparator, isDisabled: true });
 
diff --git a/src/vs/workbench/contrib/terminal/common/terminal.ts b/src/vs/workbench/contrib/terminal/common/terminal.ts
@@ -248,10 +248,13 @@ export interface ITerminalProcessManager extends IDisposable {
 	readonly environmentVariableInfo: IEnvironmentVariableInfo | undefined;
 	readonly persistentTerminalId: number | undefined;
 	readonly shouldPersist: boolean;
+	readonly isDisconnected: boolean;
 	/** Whether the process has had data written to it yet. */
 	readonly hasWrittenData: boolean;
 
 	readonly onPtyDisconnect: Event<void>;
+	readonly onPtyReconnect: Event<void>;
+
 	readonly onProcessReady: Event<void>;
 	readonly onBeforeProcessData: Event<IBeforeProcessDataEvent>;
 	readonly onProcessData: Event<IProcessDataEvent>;
diff --git a/src/vs/workbench/contrib/terminal/electron-browser/terminalInstanceService.ts b/src/vs/workbench/contrib/terminal/electron-browser/terminalInstanceService.ts
@@ -28,7 +28,7 @@ import { Emitter } from 'vs/base/common/event';
 import { Disposable } from 'vs/base/common/lifecycle';
 import { IGetTerminalLayoutInfoArgs, ISetTerminalLayoutInfoArgs } from 'vs/platform/terminal/common/terminalProcess';
 import { ILabelService } from 'vs/platform/label/common/label';
-import { INotificationService, IPromptChoice, Severity } from 'vs/platform/notification/common/notification';
+import { INotificationHandle, INotificationService, IPromptChoice, Severity } from 'vs/platform/notification/common/notification';
 import { localize } from 'vs/nls';
 
 let Terminal: typeof XTermTerminal;
@@ -40,11 +40,16 @@ export class TerminalInstanceService extends Disposable implements ITerminalInst
 	public _serviceBrand: undefined;
 
 	private readonly _ptys: Map<number, LocalPty> = new Map();
+	private _isPtyHostUnresponsive: boolean = false;
 
 	private readonly _onPtyHostExit = this._register(new Emitter<void>());
 	readonly onPtyHostExit = this._onPtyHostExit.event;
 	private readonly _onPtyHostUnresponsive = this._register(new Emitter<void>());
 	readonly onPtyHostUnresponsive = this._onPtyHostUnresponsive.event;
+	private readonly _onPtyHostResponsive = this._register(new Emitter<void>());
+	readonly onPtyHostResponsive = this._onPtyHostResponsive.event;
+	private readonly _onPtyHostRestart = this._register(new Emitter<void>());
+	readonly onPtyHostRestart = this._onPtyHostRestart.event;
 
 	constructor(
 		@IInstantiationService private readonly _instantiationService: IInstantiationService,
@@ -61,41 +66,59 @@ export class TerminalInstanceService extends Disposable implements ITerminalInst
 		super();
 
 		// Attach process listeners
-		this._localPtyService.onProcessData(e => this._ptys.get(e.id)?.handleData(e.event));
-		this._localPtyService.onProcessExit(e => {
+		this._register(this._localPtyService.onProcessData(e => this._ptys.get(e.id)?.handleData(e.event)));
+		this._register(this._localPtyService.onProcessExit(e => {
 			const pty = this._ptys.get(e.id);
 			if (pty) {
 				pty.handleExit(e.event);
 				this._ptys.delete(e.id);
 			}
-		});
-		this._localPtyService.onProcessReady(e => this._ptys.get(e.id)?.handleReady(e.event));
-		this._localPtyService.onProcessTitleChanged(e => this._ptys.get(e.id)?.handleTitleChanged(e.event));
-		this._localPtyService.onProcessOverrideDimensions(e => this._ptys.get(e.id)?.handleOverrideDimensions(e.event));
-		this._localPtyService.onProcessResolvedShellLaunchConfig(e => this._ptys.get(e.id)?.handleResolvedShellLaunchConfig(e.event));
-		this._localPtyService.onProcessReplay(e => this._ptys.get(e.id)?.handleReplay(e.event));
+		}));
+		this._register(this._localPtyService.onProcessReady(e => this._ptys.get(e.id)?.handleReady(e.event)));
+		this._register(this._localPtyService.onProcessTitleChanged(e => this._ptys.get(e.id)?.handleTitleChanged(e.event)));
+		this._register(this._localPtyService.onProcessOverrideDimensions(e => this._ptys.get(e.id)?.handleOverrideDimensions(e.event)));
+		this._register(this._localPtyService.onProcessResolvedShellLaunchConfig(e => this._ptys.get(e.id)?.handleResolvedShellLaunchConfig(e.event)));
+		this._register(this._localPtyService.onProcessReplay(e => this._ptys.get(e.id)?.handleReplay(e.event)));
 
 		// Attach pty host listeners
 		if (this._localPtyService.onPtyHostExit) {
-			this._localPtyService.onPtyHostExit(e => {
+			this._register(this._localPtyService.onPtyHostExit(() => {
 				this._onPtyHostExit.fire();
 				notificationService.error(`The terminal's pty host process exited, the connection to all terminal processes was lost`);
-			});
+			}));
 		}
+		let unresponsiveNotification: INotificationHandle | undefined;
 		if (this._localPtyService.onPtyHostStart) {
-			this._localPtyService.onPtyHostStart(() => {
+			this._register(this._localPtyService.onPtyHostStart(() => {
 				this._logService.info(`ptyHost restarted`);
-			});
+				this._onPtyHostRestart.fire();
+				unresponsiveNotification?.close();
+				unresponsiveNotification = undefined;
+				this._isPtyHostUnresponsive = false;
+			}));
 		}
 		if (this._localPtyService.onPtyHostUnresponsive) {
-			this._localPtyService.onPtyHostUnresponsive(() => {
+			this._register(this._localPtyService.onPtyHostUnresponsive(() => {
 				const choices: IPromptChoice[] = [{
 					label: localize('restartPtyHost', "Restart pty host"),
 					run: () => this._localPtyService.restartPtyHost!()
 				}];
-				notificationService.prompt(Severity.Error, localize('nonResponsivePtyHost', "The connection to the terminal's pty host process is unresponsive, the terminals may stop working."), choices);
+				unresponsiveNotification = notificationService.prompt(Severity.Error, localize('nonResponsivePtyHost', "The connection to the terminal's pty host process is unresponsive, the terminals may stop working."), choices);
+				this._isPtyHostUnresponsive = true;
 				this._onPtyHostUnresponsive.fire();
-			});
+			}));
+		}
+		if (this._localPtyService.onPtyHostResponsive) {
+			this._register(this._localPtyService.onPtyHostResponsive(() => {
+				if (!this._isPtyHostUnresponsive) {
+					return;
+				}
+				this._logService.info('The pty host became responsive again');
+				unresponsiveNotification?.close();
+				unresponsiveNotification = undefined;
+				this._isPtyHostUnresponsive = false;
+				this._onPtyHostResponsive.fire();
+			}));
 		}
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -340,7 +340,9 @@ export class TerminalService implements ITerminalService {`
`340`	`340`	`}`
`341`	`341`
`342`	`342`	`public getTabLabels(): string[] {`
`343`		- return this._terminalTabs.filter(tab => tab.terminalInstances.length > 0).map((tab, index) => `${index + 1}: ${tab.title ? tab.title : ''}`);
	`343`	`+ return this._terminalTabs.filter(tab => tab.terminalInstances.length > 0).map((tab, index) => {`
	`344`	+ return `${index + 1}: ${tab.title ? tab.title : ''}`;
	`345`	`+ });`
`344`	`346`	`}`
`345`	`347`
`346`	`348`	`public getFindState(): FindReplaceState {`