@codingame/monaco-vscode-chat-service-override 33.0.8 → 34.0.0

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

@@ -0,0 +1,297 @@
+import { CancellationToken } from "@codingame/monaco-vscode-api/vscode/vs/base/common/cancellation";
+import { Disposable } from "@codingame/monaco-vscode-api/vscode/vs/base/common/lifecycle";
+import { ResourceMap } from "@codingame/monaco-vscode-api/vscode/vs/base/common/map";
+import { OperatingSystem } from "@codingame/monaco-vscode-api/vscode/vs/base/common/platform";
+import { IConfigurationService } from "@codingame/monaco-vscode-api/vscode/vs/platform/configuration/common/configuration.service";
+import { IFileService } from "@codingame/monaco-vscode-api/vscode/vs/platform/files/common/files.service";
+import { IInstantiationService, type ServicesAccessor } from "@codingame/monaco-vscode-api/vscode/vs/platform/instantiation/common/instantiation";
+import { ILabelService } from "@codingame/monaco-vscode-api/vscode/vs/platform/label/common/label.service";
+import { IStorageService } from "@codingame/monaco-vscode-api/vscode/vs/platform/storage/common/storage.service";
+import { ITerminalProfile } from "@codingame/monaco-vscode-api/vscode/vs/platform/terminal/common/terminal";
+import { ITerminalLogService } from "@codingame/monaco-vscode-api/vscode/vs/platform/terminal/common/terminal.service";
+import { IWorkspaceContextService } from "@codingame/monaco-vscode-api/vscode/vs/platform/workspace/common/workspace.service";
+import { IHistoryService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/services/history/common/history.service";
+import { ILifecycleService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/services/lifecycle/common/lifecycle.service";
+import { IRemoteAgentService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/services/remote/common/remoteAgentService.service";
+import { IAgentSessionsService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/chat/browser/agentSessions/agentSessionsService.service";
+import { IChatWidgetService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/chat/browser/chat.service";
+import { IChatService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/chat/common/chatService/chatService.service";
+import { CountTokensCallback, IPreparedToolInvocation, IStreamedToolInvocation, IToolData, IToolImpl, IToolInvocation, IToolInvocationPreparationContext, IToolInvocationStreamContext, IToolResult, ToolProgress } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/chat/common/tools/languageModelToolsService";
+import { ILanguageModelToolsService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/chat/common/tools/languageModelToolsService.service";
+import { type ITerminalInstance } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/terminal/browser/terminal";
+import { ITerminalChatService, ITerminalService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/terminal/browser/terminal.service";
+import { ITerminalProfileResolverService } from "@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/terminal/common/terminal.service";
+import { ITerminalSandboxService } from "../../common/terminalSandboxService.js";
+import type { ITerminalExecuteStrategyResult } from "../executeStrategy/executeStrategy.js";
+import { type IToolTerminal } from "../toolTerminalCreator.js";
+export declare function createRunInTerminalToolData(accessor: ServicesAccessor): Promise<IToolData>;
+export interface IRunInTerminalInputParams {
+    command: string;
+    explanation: string;
+    goal: string;
+    mode?: "sync" | "async";
+    /**
+     * @deprecated Use `mode` instead.
+     */
+    isBackground?: boolean;
+    timeout?: number;
+    requestUnsandboxedExecution?: boolean;
+    requestUnsandboxedExecutionReason?: string;
+    requestAllowNetwork?: boolean;
+    requestAllowNetworkReason?: string;
+    allowToRunUnsandboxedCommands?: boolean;
+}
+export interface IAutomaticUnsandboxRetryOptions {
+    readonly allowUnsandboxedCommands: boolean;
+    readonly didSandboxWrapCommand: boolean;
+    readonly requestUnsandboxedExecution: boolean;
+    readonly isPersistentSession: boolean;
+    readonly isBackgroundExecution: boolean;
+    readonly didTimeout: boolean;
+    readonly exitCode: number | undefined;
+    readonly output: string;
+}
+export interface IAutomaticAllowNetworkRetryOptions {
+    readonly retryWithAllowNetworkRequests: boolean;
+    readonly didSandboxWrapCommand: boolean;
+    readonly requestUnsandboxedExecution: boolean;
+    readonly requestAllowNetwork: boolean;
+    readonly isPersistentSession: boolean;
+    readonly isBackgroundExecution: boolean;
+    readonly didTimeout: boolean;
+    readonly exitCode: number | undefined;
+    readonly output: string;
+}
+export declare function shouldAutomaticallyRetryUnsandboxed(options: IAutomaticUnsandboxRetryOptions): boolean;
+export declare function shouldAutomaticallyRetryAllowNetworkInSandboxed(options: IAutomaticAllowNetworkRetryOptions): boolean;
+/**
+ * Interface for accessing a running terminal execution.
+ * Used by tools that need to await or interact with background terminal commands.
+ */
+export interface IActiveTerminalExecution {
+    /**
+     * Promise that resolves when the terminal command completes.
+     */
+    readonly completionPromise: Promise<ITerminalExecuteStrategyResult>;
+    /**
+     * The terminal instance associated with this execution.
+     */
+    readonly instance: ITerminalInstance;
+    /**
+     * Gets the current output from the terminal.
+     */
+    getOutput(): string;
+    /**
+     * Switches this execution to background mode, if supported.
+     */
+    setBackground?(): void;
+}
+/**
+ * Builds the short, single-line command string used in the SYSTEM NOTIFICATION
+ * label for background terminal completion (#318601). Keeps only the first line
+ * of the command (stripping common escape artifacts) and appends a horizontal
+ * ellipsis (`…`) when content is dropped — either because the command spans
+ * multiple lines or the first line itself is longer than 80 characters.
+ *
+ * Multi-line commands (with blank lines) used to break the surrounding inline
+ * code span; callers must additionally wrap the result with
+ * {@link appendEscapedMarkdownInlineCode} when interpolating into markdown.
+ */
+export declare function buildCompletionNotificationCommand(command: string): string;
+export declare class RunInTerminalTool extends Disposable implements IToolImpl {
+    protected readonly _chatService: IChatService;
+    private readonly _configurationService;
+    private readonly _fileService;
+    private readonly _historyService;
+    private readonly _instantiationService;
+    private readonly _labelService;
+    private readonly _languageModelToolsService;
+    private readonly _remoteAgentService;
+    private readonly _storageService;
+    private readonly _terminalChatService;
+    private readonly _logService;
+    private readonly _terminalService;
+    private readonly _terminalSandboxService;
+    private readonly _workspaceContextService;
+    private readonly _chatWidgetService;
+    private readonly _agentSessionsService;
+    private readonly _terminalToolCreator;
+    private readonly _treeSitterCommandParser;
+    private readonly _telemetry;
+    private readonly _commandArtifactCollector;
+    protected readonly _profileFetcher: TerminalProfileFetcher;
+    private readonly _commandLineRewriters;
+    private readonly _commandLineAnalyzers;
+    private readonly _commandLinePresenters;
+    private readonly _outputAnalyzers;
+    private readonly _archivedSessionListener;
+    protected readonly _sessionTerminalAssociations: ResourceMap<IToolTerminal>;
+    protected readonly _sessionTerminalInstances: ResourceMap<Set<ITerminalInstance>>;
+    private readonly _terminalsBeingDisposedBySessionCleanup;
+    /**
+     * Tracks active background completion notifications per terminal instance ID.
+     * When a new notification is registered for a terminal that already has one,
+     * the previous notification (and its OutputMonitor) is disposed first to
+     * prevent listener accumulation on the terminal's onDidInputData emitter.
+     *
+     * Keyed by `ITerminalInstance.instanceId` (stable per terminal) rather than
+     * the per-invocation `termId` so that reusing the same foreground terminal
+     * after an `inputNeeded` race disposes the prior OutputMonitor.
+     */
+    private readonly _backgroundNotifications;
+    /**
+     * Set when VS Code is shutting down. Suppresses "terminal exited"
+     * notifications that would otherwise be generated when background
+     * terminals are disposed during shutdown and then persist as
+     * undeliverable steering messages after restart.
+     */
+    private _isShuttingDown;
+    protected readonly _osBackend: Promise<OperatingSystem>;
+    private static readonly _activeExecutions;
+    /**
+     * Per-instance disposables that unregister `_activeExecutions` entries from the
+     * `ITerminalChatService` execution-id map. Keyed by the same `termId` as `_activeExecutions`
+     * so registrations and active executions share a lifecycle.
+     */
+    private readonly _executionRegistrations;
+    private _setActiveExecution;
+    private _deleteActiveExecution;
+    /**
+     * Terminal IDs being programmatically disposed (by `kill_terminal` or
+     * automatic background-terminal cleanup). Used to suppress the redundant
+     * "terminal exited" steering message in `_registerCompletionNotification`'s
+     * `onDisposed` handler.
+     */
+    private static readonly _killedByTool;
+    static getBackgroundOutput(id: string): string;
+    /**
+     * Gets an active terminal execution by ID. Returns undefined if not found.
+     * Can be used to await the completion of a background terminal command.
+     */
+    static getExecution(id: string): IActiveTerminalExecution | undefined;
+    /**
+     * Removes an active terminal execution by ID and disposes it.
+     * @returns true if the execution was found and removed, false otherwise.
+     */
+    static removeExecution(id: string): boolean;
+    /**
+     * Marks a terminal ID as being killed by the `kill_terminal` tool so that
+     * the `onDisposed` handler in `_registerCompletionNotification` skips the
+     * redundant steering message.
+     */
+    static markKilledByTool(id: string): void;
+    private _resolveExecutionOptions;
+    private get _allowUnsandboxedCommands();
+    private get _autoApproveUnsandboxedCommands();
+    private get _retryWithAllowNetworkRequests();
+    private get _allowSandboxAutoApprove();
+    private _getAllowToRunUnsandboxedCommands;
+    private _shouldRejectUnsandboxedExecutionRequest;
+    private _shouldRejectAllowNetworkRequest;
+    private _getUnsandboxedExecutionDisabledMessage;
+    private _getAllowNetworkRequestDisabledMessage;
+    /**
+     * Controls whether this tool wires up sandbox-specific command-line
+     * behavior, including both the {@link CommandLineSandboxRewriter} and the
+     * {@link CommandLineSandboxAnalyzer}. This is separate from
+     * ITerminalSandboxService.isEnabled(), which reports the current terminal
+     * sandboxing enablement for the running window.
+     */
+    protected get _enableCommandLineSandboxRewriting(): boolean;
+    constructor(_chatService: IChatService, _configurationService: IConfigurationService, _fileService: IFileService, _historyService: IHistoryService, _instantiationService: IInstantiationService, _labelService: ILabelService, _languageModelToolsService: ILanguageModelToolsService, _remoteAgentService: IRemoteAgentService, _storageService: IStorageService, _terminalChatService: ITerminalChatService, _logService: ITerminalLogService, _terminalService: ITerminalService, _terminalSandboxService: ITerminalSandboxService, _workspaceContextService: IWorkspaceContextService, _chatWidgetService: IChatWidgetService, _agentSessionsService: IAgentSessionsService, lifecycleService: ILifecycleService);
+    handleToolStream(context: IToolInvocationStreamContext, _token: CancellationToken): Promise<IStreamedToolInvocation | undefined>;
+    prepareToolInvocation(context: IToolInvocationPreparationContext, token: CancellationToken): Promise<IPreparedToolInvocation | undefined>;
+    private _formatBlockedDomainsForTitle;
+    private _getBlockedDomainReason;
+    private _rewriteCommandLine;
+    private _getSandboxPrecheckInputs;
+    private _confirmAutomaticSandboxRetry;
+    private _getAutomaticSandboxRetryTitle;
+    /**
+     * Surface a confirmation dialog when the terminal is detected to be waiting
+     * for sensitive input (password, passphrase, OTP, …). Sensitive prompts must
+     * never be routed through the model — the user types the secret directly
+     * into the terminal. The "Focus terminal" action reveals and focuses the
+     * terminal; the "Cancel" action cancels the running command.
+     *
+     * Returns a disposable that hides any pending elicitation. The handler
+     * itself dedupes concurrent elicitations so repeated polling cycles don't
+     * spam the chat session.
+     */
+    private _registerSensitiveInputElicitation;
+    private _acceptAutomaticSandboxRetryToolInvocationUpdate;
+    private _runAutomaticSandboxRetry;
+    invoke(invocation: IToolInvocation, _countTokens: CountTokensCallback, _progress: ToolProgress, token: CancellationToken): Promise<IToolResult>;
+    /**
+     * Builds the steering text the model sees when the terminal tool suspects
+     * the command may be waiting for input. The heuristic that triggers this
+     * note can false-positive on long-running compute commands or shells sitting
+     * on a secondary prompt (e.g. heredoc continuation `> `), so the text
+     * explicitly:
+     *   1. Tells the model this note is NOT a signal to end the turn.
+     *   2. In auto-approve mode, leads with `send_to_terminal` for non-secret
+     *      prompts to minimize round-trips, with a `get_terminal_output` fallback.
+     *   3. In default mode, leads with `get_terminal_output` as the safe
+     *      recovery action and offers `vscode_askQuestions` only for real
+     *      non-secret prompts. Secret prompts (passwords, passphrases,
+     *      tokens) must never be routed through `vscode_askQuestions`
+     *      because answers to that tool are sent through the model — the
+     *      user is told to type those values directly into the terminal.
+     * `kill_terminal` is only advertised when the command may be hung
+     * (`'timeout'` or `'idleSilence'`) — suggesting it in the general case
+     * leads the model to terminate valid interactive sessions (e.g.
+     * `npm init`) instead of driving them.
+     */
+    private _buildInputNeededSteeringText;
+    private _getOutputAnalyzerMessage;
+    private static readonly _maxImageFileSize;
+    /**
+     * Scans terminal output for file paths that point to images and reads them.
+     * Returns data content parts for any found images that exist on disk.
+     */
+    private _extractImagesFromOutput;
+    private _handleTerminalVisibility;
+    /**
+     * Initializes a terminal for command execution. For foreground mode, reuses existing cached
+     * terminal from the session. For background mode, always creates a new terminal to allow
+     * parallel execution.
+     */
+    private _initTerminal;
+    private _registerInputListener;
+    private _restoreTerminalAssociations;
+    private _setupProcessIdAssociation;
+    private _associateProcessIdWithSession;
+    private _removeProcessIdAssociation;
+    private _cleanupSessionTerminals;
+    private _addSessionTerminalAssociation;
+    private _ensureArchivedSessionListener;
+    private _removeTerminalAssociations;
+    private _removeExecutionAssociations;
+    /**
+     * Registers a listener for command completion on a background terminal.
+     * When a command finishes, sends a steering message to the chat session
+     * so the agent is notified on its next turn.
+     *
+     * If an output monitor is provided, it is continued in background mode
+     * to detect prompts-for-input while the terminal runs in the background.
+     * The output monitor is cancelled and disposed when a command finishes.
+     */
+    private _registerCompletionNotification;
+    /**
+     * Find and dismiss any pending (not yet answered) question carousels that
+     * are associated with the given terminal. This is called when the user
+     * types directly into the terminal, bypassing the carousel UI.
+     */
+    private _dismissPendingCarouselsForTerminal;
+}
+export declare class TerminalProfileFetcher {
+    private readonly _configurationService;
+    private readonly _terminalProfileResolverService;
+    private readonly _remoteAgentService;
+    readonly osBackend: Promise<OperatingSystem>;
+    constructor(_configurationService: IConfigurationService, _terminalProfileResolverService: ITerminalProfileResolverService, _remoteAgentService: IRemoteAgentService);
+    getCopilotProfile(): Promise<ITerminalProfile>;
+    getCopilotShell(): Promise<string>;
+    private _getChatTerminalProfile;
+    private _isValidChatAgentTerminalProfile;
+}