Fixes #48513 - buffers terminal onData events

Author: eamodio

src/vs/workbench/api/browser/mainThreadTerminalService.ts

@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { DisposableStore, Disposable } from 'vs/base/common/lifecycle';
-import { IShellLaunchConfig, ITerminalProcessExtHostProxy, ISpawnExtHostProcessRequest, ITerminalDimensions, EXT_HOST_CREATION_DELAY, IAvailableShellsRequest, IDefaultShellAndArgsRequest, IStartExtensionTerminalRequest } from 'vs/workbench/contrib/terminal/common/terminal';
+import { IShellLaunchConfig, ITerminalProcessExtHostProxy, ISpawnExtHostProcessRequest, ITerminalDimensions, EXT_HOST_CREATION_DELAY, IAvailableShellsRequest, IDefaultShellAndArgsRequest, IStartExtensionTerminalRequest, getTerminalDataBufferer } from 'vs/workbench/contrib/terminal/common/terminal';
 import { ExtHostContext, ExtHostTerminalServiceShape, MainThreadTerminalServiceShape, MainContext, IExtHostContext, IShellLaunchConfigDto, TerminalLaunchConfig, ITerminalDimensionsDto } from 'vs/workbench/api/common/extHost.protocol';
 import { extHostNamedCustomer } from 'vs/workbench/api/common/extHostCustomers';
 import { URI } from 'vs/base/common/uri';
@@ -337,6 +337,19 @@ class TerminalDataEventTracker extends Disposable {
 	}
 
 	private _registerInstance(instance: ITerminalInstance): void {
-		this._register(instance.onData(e => this._callback(instance.id, e)));
+		const bufferer = getTerminalDataBufferer(instance.id, this._callback);
+		const disposables = [bufferer, instance.onData(bufferer.onData)];
+
+		for (const d of disposables) {
+			this._register(d);
+		}
+
+		this._register(this._terminalService.onInstanceDisposed(i => {
+			if (i.id === instance.id) {
+				for (const d of disposables) {
+					d.dispose();
+				}
+			}
+		}));
 	}
 }

src/vs/workbench/api/common/extHostTerminalService.ts

@@ -4,12 +4,13 @@
  *--------------------------------------------------------------------------------------------*/
 
 import * as vscode from 'vscode';
+import { IDisposable } from 'vs/base/common/lifecycle';
 import { Event, Emitter } from 'vs/base/common/event';
 import { ExtHostTerminalServiceShape, MainContext, MainThreadTerminalServiceShape, IShellLaunchConfigDto, IShellDefinitionDto, IShellAndArgsDto, ITerminalDimensionsDto } from 'vs/workbench/api/common/extHost.protocol';
 import { ExtHostConfigProvider } from 'vs/workbench/api/common/extHostConfiguration';
 import { createDecorator } from 'vs/platform/instantiation/common/instantiation';
 import { URI, UriComponents } from 'vs/base/common/uri';
-import { EXT_HOST_CREATION_DELAY, ITerminalChildProcess, ITerminalDimensions } from 'vs/workbench/contrib/terminal/common/terminal';
+import { EXT_HOST_CREATION_DELAY, ITerminalChildProcess, ITerminalDimensions, getTerminalDataBufferer } from 'vs/workbench/contrib/terminal/common/terminal';
 import { timeout } from 'vs/base/common/async';
 import { IExtHostRpcService } from 'vs/workbench/api/common/extHostRpcService';
 
@@ -464,8 +465,12 @@ export abstract class BaseExtHostTerminalService implements IExtHostTerminalServ
 	protected _setupExtHostProcessListeners(id: number, p: ITerminalChildProcess): void {
 		p.onProcessReady((e: { pid: number, cwd: string }) => this._proxy.$sendProcessReady(id, e.pid, e.cwd));
 		p.onProcessTitleChanged(title => this._proxy.$sendProcessTitle(id, title));
-		p.onProcessData(data => this._proxy.$sendProcessData(id, data));
-		p.onProcessExit(exitCode => this._onProcessExit(id, exitCode));
+
+		const bufferer = getTerminalDataBufferer(id, this._proxy.$sendProcessData);
+		const disposables = [bufferer, p.onProcessData(bufferer.onData)];
+
+		p.onProcessExit(exitCode => this._onProcessExit(id, exitCode, disposables));
+
 		if (p.onProcessOverrideDimensions) {
 			p.onProcessOverrideDimensions(e => this._proxy.$sendOverrideDimensions(id, e));
 		}
@@ -503,7 +508,11 @@ export abstract class BaseExtHostTerminalService implements IExtHostTerminalServ
 		return id;
 	}
 
-	private _onProcessExit(id: number, exitCode: number): void {
+	private _onProcessExit(id: number, exitCode: number, disposables: IDisposable[]): void {
+		for (const d of disposables) {
+			d.dispose();
+		}
+
 		// Remove process reference
 		delete this._terminalProcesses[id];
 

src/vs/workbench/contrib/terminal/common/terminal.ts

@@ -475,3 +475,43 @@ export const enum TERMINAL_COMMAND_ID {
 	NAVIGATION_MODE_FOCUS_NEXT = 'workbench.action.terminal.navigationModeFocusNext',
 	NAVIGATION_MODE_FOCUS_PREVIOUS = 'workbench.action.terminal.navigationModeFocusPrevious'
 }
+
+interface TerminalDataBuffer {
+	timeoutId: any;
+	data: string[];
+}
+
+export interface TerminalDataBufferer extends IDisposable {
+	onData: (e: string) => void;
+}
+
+const terminalBufferMap = new Map<number, TerminalDataBuffer>();
+
+export function getTerminalDataBufferer(id: number, callback: (id: number, data: string) => void): TerminalDataBufferer {
+	return {
+		dispose: () => {
+			const buffer = terminalBufferMap.get(id);
+			if (buffer) {
+				clearTimeout(buffer.timeoutId);
+				terminalBufferMap.delete(id);
+			}
+		},
+		onData: (e: string) => {
+			let buffer = terminalBufferMap.get(id);
+			if (buffer) {
+				buffer.data.push(e);
+
+				return;
+			}
+
+			buffer = {
+				data: [e],
+				timeoutId: setTimeout(() => {
+					terminalBufferMap.delete(id);
+					callback(id, buffer!.data.join(''));
+				}, 5)
+			};
+			terminalBufferMap.set(id, buffer);
+		}
+	};
+}