Merge pull request #259806 from microsoft/tyriar/258480

Move output monitoring for background terminals into separate class

Author: Tyriar

src/vs/workbench/contrib/terminalContrib/chatAgentTools/browser/outputMonitor.ts

@@ -0,0 +1,70 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import { CancellationToken } from '../../../../../base/common/cancellation.js';
+import { Emitter, Event } from '../../../../../base/common/event.js';
+import { Disposable } from '../../../../../base/common/lifecycle.js';
+import { ILanguageModelsService } from '../../../chat/common/languageModels.js';
+import { IChatService } from '../../../chat/common/chatService.js';
+import { racePollingOrPrompt, promptForMorePolling, pollForOutputAndIdle } from './bufferOutputPolling.js';
+
+export interface IOutputMonitor extends Disposable {
+	readonly isIdle: boolean;
+
+	readonly onDidFinishCommand: Event<void>;
+	readonly onDidIdle: Event<void>;
+	readonly onDidTimeout: Event<void>;
+
+	startMonitoring(
+		chatService: IChatService,
+		command: string,
+		invocationContext: any,
+		token: CancellationToken
+	): Promise<{ terminalExecutionIdleBeforeTimeout: boolean; output: string; pollDurationMs?: number; modelOutputEvalResponse?: string }>;
+}
+
+export class OutputMonitor extends Disposable implements IOutputMonitor {
+	private _isIdle = false;
+
+	private readonly _onDidFinishCommand = this._register(new Emitter<void>());
+	readonly onDidFinishCommand = this._onDidFinishCommand.event;
+	private readonly _onDidIdle = this._register(new Emitter<void>());
+	readonly onDidIdle = this._onDidIdle.event;
+	private readonly _onDidTimeout = this._register(new Emitter<void>());
+	readonly onDidTimeout = this._onDidTimeout.event;
+
+	get isIdle(): boolean {
+		return this._isIdle;
+	}
+
+	constructor(
+		private readonly _execution: { getOutput: () => string; isActive?: () => Promise<boolean> },
+		@ILanguageModelsService private readonly _languageModelsService: ILanguageModelsService
+	) {
+		super();
+	}
+
+	async startMonitoring(
+		chatService: IChatService,
+		command: string,
+		invocationContext: any,
+		token: CancellationToken
+	): Promise<{ terminalExecutionIdleBeforeTimeout: boolean; output: string; pollDurationMs?: number; modelOutputEvalResponse?: string }> {
+		let result = await pollForOutputAndIdle(this._execution, false, token, this._languageModelsService);
+
+		if (!result.terminalExecutionIdleBeforeTimeout) {
+			result = await racePollingOrPrompt(
+				() => pollForOutputAndIdle(this._execution, true, token, this._languageModelsService),
+				() => promptForMorePolling(command, token, invocationContext, chatService),
+				result,
+				token,
+				this._languageModelsService,
+				this._execution
+			);
+		}
+
+		return result;
+	}
+}

src/vs/workbench/contrib/terminalContrib/chatAgentTools/browser/tools/runInTerminalTool.ts

@@ -22,13 +22,12 @@ import { ITerminalLogService } from '../../../../../../platform/terminal/common/
 import { IWorkspaceContextService } from '../../../../../../platform/workspace/common/workspace.js';
 import { IRemoteAgentService } from '../../../../../services/remote/common/remoteAgentService.js';
 import { IChatService, type IChatTerminalToolInvocationData } from '../../../../chat/common/chatService.js';
-import { ILanguageModelsService } from '../../../../chat/common/languageModels.js';
 import { CountTokensCallback, ILanguageModelToolsService, IPreparedToolInvocation, IToolData, IToolImpl, IToolInvocation, IToolInvocationPreparationContext, IToolResult, ToolDataSource, ToolProgress, type IToolConfirmationAction, type IToolConfirmationMessages } from '../../../../chat/common/languageModelToolsService.js';
 import { ITerminalService, type ITerminalInstance } from '../../../../terminal/browser/terminal.js';
 import type { XtermTerminal } from '../../../../terminal/browser/xterm/xtermTerminal.js';
 import { ITerminalProfileResolverService } from '../../../../terminal/common/terminal.js';
 import { getRecommendedToolsOverRunInTerminal } from '../alternativeRecommendation.js';
-import { getOutput, pollForOutputAndIdle, promptForMorePolling, racePollingOrPrompt } from '../bufferOutputPolling.js';
+import { getOutput } from '../bufferOutputPolling.js';
 import { CommandLineAutoApprover, type ICommandApprovalResultWithReason } from '../commandLineAutoApprover.js';
 import { BasicExecuteStrategy } from '../executeStrategy/basicExecuteStrategy.js';
 import type { ITerminalExecuteStrategy } from '../executeStrategy/executeStrategy.js';
@@ -38,6 +37,7 @@ import { isPowerShell } from '../runInTerminalHelpers.js';
 import { extractInlineSubCommands, splitCommandLineIntoSubCommands } from '../subCommands.js';
 import { ShellIntegrationQuality, ToolTerminalCreator, type IToolTerminal } from '../toolTerminalCreator.js';
 import { Codicon } from '../../../../../../base/common/codicons.js';
+import { OutputMonitor } from '../outputMonitor.js';
 import type { TerminalNewAutoApproveButtonData } from '../../../../chat/browser/chatContentParts/toolInvocationParts/chatTerminalToolSubPart.js';
 
 const TERMINAL_SESSION_STORAGE_KEY = 'chat.terminalSessions';
@@ -159,7 +159,6 @@ export class RunInTerminalTool extends Disposable implements IToolImpl {
 		@IRemoteAgentService private readonly _remoteAgentService: IRemoteAgentService,
 		@IChatService private readonly _chatService: IChatService,
 		@IWorkspaceContextService private readonly _workspaceContextService: IWorkspaceContextService,
-		@ILanguageModelsService private readonly _languageModelsService: ILanguageModelsService
 	) {
 		super();
 
@@ -414,31 +413,21 @@ export class RunInTerminalTool extends Disposable implements IToolImpl {
 
 		if (args.isBackground) {
 			let outputAndIdle: { terminalExecutionIdleBeforeTimeout: boolean; output: string; pollDurationMs?: number; modelOutputEvalResponse?: string } | undefined = undefined;
+			let outputMonitor: OutputMonitor | undefined = undefined;
 			try {
 				this._logService.debug(`RunInTerminalTool: Starting background execution \`${command}\``);
 
 				const execution = new BackgroundTerminalExecution(toolTerminal.instance, xterm, command);
 				RunInTerminalTool._backgroundExecutions.set(termId, execution);
 
-				outputAndIdle = await pollForOutputAndIdle(execution, false, token, this._languageModelsService);
+				outputMonitor = this._instantiationService.createInstance(OutputMonitor, execution);
+				store.add(outputMonitor);
+
+				outputAndIdle = await outputMonitor.startMonitoring(this._chatService, command, invocation.context!, token);
 				if (token.isCancellationRequested) {
 					throw new CancellationError();
 				}
 
-				if (!outputAndIdle.terminalExecutionIdleBeforeTimeout) {
-					outputAndIdle = await racePollingOrPrompt(
-						() => pollForOutputAndIdle(execution, true, token, this._languageModelsService),
-						() => promptForMorePolling(command, token, invocation.context!, this._chatService),
-						outputAndIdle,
-						token,
-						this._languageModelsService,
-						execution
-					);
-					if (token.isCancellationRequested) {
-						throw new CancellationError();
-					}
-				}
-
 				let resultText = (
 					didUserEditCommand
 						? `Note: The user manually edited the command to \`${command}\`, and that command is now running in terminal with ID=${termId}`