Merge pull request microsoft#210247 from microsoft/tyriar/145234_4

Debounce data events to shellIntegration API

Author: Tyriar

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

@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { Event } from 'vs/base/common/event';
-import { Disposable } from 'vs/base/common/lifecycle';
+import { Disposable, toDisposable, type IDisposable } from 'vs/base/common/lifecycle';
 import { URI } from 'vs/base/common/uri';
 import { TerminalCapability, type ITerminalCommand } from 'vs/platform/terminal/common/capabilities/capabilities';
 import { ExtHostContext, MainContext, type ExtHostTerminalShellIntegrationShape, type MainThreadTerminalShellIntegrationShape } from 'vs/workbench/api/common/extHost.protocol';
@@ -26,6 +26,13 @@ export class MainThreadTerminalShellIntegration extends Disposable implements Ma
 
 		this._proxy = extHostContext.getProxy(ExtHostContext.ExtHostTerminalShellIntegration);
 
+		const instanceDataListeners: Map<number, IDisposable> = new Map();
+		this._register(toDisposable(() => {
+			for (const listener of instanceDataListeners.values()) {
+				listener.dispose();
+			}
+		}));
+
 		// onDidChangeTerminalShellIntegration
 		const onDidAddCommandDetection = this._store.add(this._terminalService.createOnInstanceEvent(instance => {
 			return Event.map(
@@ -47,14 +54,22 @@ export class MainThreadTerminalShellIntegration extends Disposable implements Ma
 			}
 			// String paths are not exposed in the extension API
 			currentCommand = e.data;
-			this._proxy.$shellExecutionStart(e.instance.instanceId, e.data.command, convertToExtHostCommandLineConfidence(e.data), e.data.isTrusted, this._convertCwdToUri(e.data.cwd));
+			const instanceId = e.instance.instanceId;
+			this._proxy.$shellExecutionStart(instanceId, e.data.command, convertToExtHostCommandLineConfidence(e.data), e.data.isTrusted, this._convertCwdToUri(e.data.cwd));
+
+			// TerminalShellExecution.createDataStream
+			// Debounce events to reduce the message count - when this listener is disposed the events will be flushed
+			instanceDataListeners.get(instanceId)?.dispose();
+			instanceDataListeners.set(instanceId, Event.accumulate(e.instance.onData, 50, this._store)(events => this._proxy.$shellExecutionData(instanceId, events.join())));
 		}));
 
 		// onDidEndTerminalShellExecution
 		const commandDetectionEndEvent = this._store.add(this._terminalService.createOnInstanceCapabilityEvent(TerminalCapability.CommandDetection, e => e.onCommandFinished));
 		this._store.add(commandDetectionEndEvent.event(e => {
 			currentCommand = undefined;
-			this._proxy.$shellExecutionEnd(e.instance.instanceId, e.data.command, convertToExtHostCommandLineConfidence(e.data), e.data.isTrusted, e.data.exitCode);
+			const instanceId = e.instance.instanceId;
+			instanceDataListeners.get(instanceId)?.dispose();
+			this._proxy.$shellExecutionEnd(instanceId, e.data.command, convertToExtHostCommandLineConfidence(e.data), e.data.isTrusted, e.data.exitCode);
 		}));
 
 		// onDidChangeTerminalShellIntegration via cwd
@@ -65,12 +80,6 @@ export class MainThreadTerminalShellIntegration extends Disposable implements Ma
 
 		// Clean up after dispose
 		this._store.add(this._terminalService.onDidDisposeInstance(e => this._proxy.$closeTerminal(e.instanceId)));
-
-		// TerminalShellExecution.createDataStream
-		// TODO: Support this on remote; it should go via the server
-		if (!workbenchEnvironmentService.remoteAuthority) {
-			this._store.add(this._terminalService.onAnyInstanceData(e => this._proxy.$shellExecutionData(e.instance.instanceId, e.data)));
-		}
 	}
 
 	$executeCommand(terminalId: number, commandLine: string): void {

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

@@ -62,12 +62,12 @@ export class ExtHostTerminalShellIntegration extends Disposable implements IExtH
 		// 	console.log('*** onDidStartTerminalShellExecution', e);
 		// 	// new Promise<void>(r => {
 		// 	// 	(async () => {
-		// 	// 		for await (const d of e.createDataStream()) {
+		// 	// 		for await (const d of e.execution.read()) {
 		// 	// 			console.log('data2', d);
 		// 	// 		}
 		// 	// 	})();
 		// 	// });
-		// 	for await (const d of e.createDataStream()) {
+		// 	for await (const d of e.execution.read()) {
 		// 		console.log('data', d);
 		// 	}
 		// });

src/vscode-dts/vscode.proposed.terminalShellIntegration.d.ts

@@ -46,9 +46,9 @@ declare module 'vscode' {
 
 		/**
 		 * Creates a stream of raw data (including escape sequences) that is written to the
-		 * terminal. This will only include data that was written after `readData` was called for
-		 * the first time, ie. you must call `readData` immediately after the command is executed
-		 * via {@link TerminalShellIntegration.executeCommand} or
+		 * terminal. This will only include data that was written after `read` was called for
+		 * the first time, ie. you must call `read` immediately after the command is executed via
+		 * {@link TerminalShellIntegration.executeCommand} or
 		 * {@link window.onDidStartTerminalShellExecution} to not miss any data.
 		 *
 		 * @example