416 lines
14 KiB
TypeScript
416 lines
14 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2025 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
import fs from 'fs';
|
|
import path from 'path';
|
|
import os from 'os';
|
|
import crypto from 'crypto';
|
|
import { Config } from '../config/config.js';
|
|
import {
|
|
BaseDeclarativeTool,
|
|
BaseToolInvocation,
|
|
ToolInvocation,
|
|
ToolResult,
|
|
ToolCallConfirmationDetails,
|
|
ToolExecuteConfirmationDetails,
|
|
ToolConfirmationOutcome,
|
|
Kind,
|
|
} from './tools.js';
|
|
import { SchemaValidator } from '../utils/schemaValidator.js';
|
|
import { getErrorMessage } from '../utils/errors.js';
|
|
import { summarizeToolOutput } from '../utils/summarizer.js';
|
|
import {
|
|
ShellExecutionService,
|
|
ShellOutputEvent,
|
|
} from '../services/shellExecutionService.js';
|
|
import { formatMemoryUsage } from '../utils/formatters.js';
|
|
import {
|
|
getCommandRoots,
|
|
isCommandAllowed,
|
|
stripShellWrapper,
|
|
} from '../utils/shell-utils.js';
|
|
|
|
export const OUTPUT_UPDATE_INTERVAL_MS = 1000;
|
|
|
|
export interface ShellToolParams {
|
|
command: string;
|
|
description?: string;
|
|
directory?: string;
|
|
}
|
|
|
|
class ShellToolInvocation extends BaseToolInvocation<
|
|
ShellToolParams,
|
|
ToolResult
|
|
> {
|
|
constructor(
|
|
private readonly config: Config,
|
|
params: ShellToolParams,
|
|
private readonly allowlist: Set<string>,
|
|
) {
|
|
super(params);
|
|
}
|
|
|
|
getDescription(): string {
|
|
let description = `${this.params.command}`;
|
|
// append optional [in directory]
|
|
// note description is needed even if validation fails due to absolute path
|
|
if (this.params.directory) {
|
|
description += ` [in ${this.params.directory}]`;
|
|
}
|
|
// append optional (description), replacing any line breaks with spaces
|
|
if (this.params.description) {
|
|
description += ` (${this.params.description.replace(/\n/g, ' ')})`;
|
|
}
|
|
return description;
|
|
}
|
|
|
|
override async shouldConfirmExecute(
|
|
_abortSignal: AbortSignal,
|
|
): Promise<ToolCallConfirmationDetails | false> {
|
|
const command = stripShellWrapper(this.params.command);
|
|
const rootCommands = [...new Set(getCommandRoots(command))];
|
|
const commandsToConfirm = rootCommands.filter(
|
|
(command) => !this.allowlist.has(command),
|
|
);
|
|
|
|
if (commandsToConfirm.length === 0) {
|
|
return false; // already approved and whitelisted
|
|
}
|
|
|
|
const confirmationDetails: ToolExecuteConfirmationDetails = {
|
|
type: 'exec',
|
|
title: 'Confirm Shell Command',
|
|
command: this.params.command,
|
|
rootCommand: commandsToConfirm.join(', '),
|
|
onConfirm: async (outcome: ToolConfirmationOutcome) => {
|
|
if (outcome === ToolConfirmationOutcome.ProceedAlways) {
|
|
commandsToConfirm.forEach((command) => this.allowlist.add(command));
|
|
}
|
|
},
|
|
};
|
|
return confirmationDetails;
|
|
}
|
|
|
|
async execute(
|
|
signal: AbortSignal,
|
|
updateOutput?: (output: string) => void,
|
|
): Promise<ToolResult> {
|
|
const strippedCommand = stripShellWrapper(this.params.command);
|
|
|
|
if (signal.aborted) {
|
|
return {
|
|
llmContent: 'Command was cancelled by user before it could start.',
|
|
returnDisplay: 'Command cancelled by user.',
|
|
};
|
|
}
|
|
|
|
const isWindows = os.platform() === 'win32';
|
|
const tempFileName = `shell_pgrep_${crypto
|
|
.randomBytes(6)
|
|
.toString('hex')}.tmp`;
|
|
const tempFilePath = path.join(os.tmpdir(), tempFileName);
|
|
|
|
try {
|
|
// pgrep is not available on Windows, so we can't get background PIDs
|
|
const commandToExecute = isWindows
|
|
? strippedCommand
|
|
: (() => {
|
|
// wrap command to append subprocess pids (via pgrep) to temporary file
|
|
let command = strippedCommand.trim();
|
|
if (!command.endsWith('&')) command += ';';
|
|
return `{ ${command} }; __code=$?; pgrep -g 0 >${tempFilePath} 2>&1; exit $__code;`;
|
|
})();
|
|
|
|
const cwd = path.resolve(
|
|
this.config.getTargetDir(),
|
|
this.params.directory || '',
|
|
);
|
|
|
|
let cumulativeStdout = '';
|
|
let cumulativeStderr = '';
|
|
|
|
let lastUpdateTime = Date.now();
|
|
let isBinaryStream = false;
|
|
|
|
const { result: resultPromise } = ShellExecutionService.execute(
|
|
commandToExecute,
|
|
cwd,
|
|
(event: ShellOutputEvent) => {
|
|
if (!updateOutput) {
|
|
return;
|
|
}
|
|
|
|
let currentDisplayOutput = '';
|
|
let shouldUpdate = false;
|
|
|
|
switch (event.type) {
|
|
case 'data':
|
|
if (isBinaryStream) break; // Don't process text if we are in binary mode
|
|
if (event.stream === 'stdout') {
|
|
cumulativeStdout += event.chunk;
|
|
} else {
|
|
cumulativeStderr += event.chunk;
|
|
}
|
|
currentDisplayOutput =
|
|
cumulativeStdout +
|
|
(cumulativeStderr ? `\n${cumulativeStderr}` : '');
|
|
if (Date.now() - lastUpdateTime > OUTPUT_UPDATE_INTERVAL_MS) {
|
|
shouldUpdate = true;
|
|
}
|
|
break;
|
|
case 'binary_detected':
|
|
isBinaryStream = true;
|
|
currentDisplayOutput =
|
|
'[Binary output detected. Halting stream...]';
|
|
shouldUpdate = true;
|
|
break;
|
|
case 'binary_progress':
|
|
isBinaryStream = true;
|
|
currentDisplayOutput = `[Receiving binary output... ${formatMemoryUsage(
|
|
event.bytesReceived,
|
|
)} received]`;
|
|
if (Date.now() - lastUpdateTime > OUTPUT_UPDATE_INTERVAL_MS) {
|
|
shouldUpdate = true;
|
|
}
|
|
break;
|
|
default: {
|
|
throw new Error('An unhandled ShellOutputEvent was found.');
|
|
}
|
|
}
|
|
|
|
if (shouldUpdate) {
|
|
updateOutput(currentDisplayOutput);
|
|
lastUpdateTime = Date.now();
|
|
}
|
|
},
|
|
signal,
|
|
);
|
|
|
|
const result = await resultPromise;
|
|
|
|
const backgroundPIDs: number[] = [];
|
|
if (os.platform() !== 'win32') {
|
|
if (fs.existsSync(tempFilePath)) {
|
|
const pgrepLines = fs
|
|
.readFileSync(tempFilePath, 'utf8')
|
|
.split('\n')
|
|
.filter(Boolean);
|
|
for (const line of pgrepLines) {
|
|
if (!/^\d+$/.test(line)) {
|
|
console.error(`pgrep: ${line}`);
|
|
}
|
|
const pid = Number(line);
|
|
if (pid !== result.pid) {
|
|
backgroundPIDs.push(pid);
|
|
}
|
|
}
|
|
} else {
|
|
if (!signal.aborted) {
|
|
console.error('missing pgrep output');
|
|
}
|
|
}
|
|
}
|
|
|
|
let llmContent = '';
|
|
if (result.aborted) {
|
|
llmContent = 'Command was cancelled by user before it could complete.';
|
|
if (result.output.trim()) {
|
|
llmContent += ` Below is the output (on stdout and stderr) before it was cancelled:\n${result.output}`;
|
|
} else {
|
|
llmContent += ' There was no output before it was cancelled.';
|
|
}
|
|
} else {
|
|
// Create a formatted error string for display, replacing the wrapper command
|
|
// with the user-facing command.
|
|
const finalError = result.error
|
|
? result.error.message.replace(commandToExecute, this.params.command)
|
|
: '(none)';
|
|
|
|
llmContent = [
|
|
`Command: ${this.params.command}`,
|
|
`Directory: ${this.params.directory || '(root)'}`,
|
|
`Stdout: ${result.stdout || '(empty)'}`,
|
|
`Stderr: ${result.stderr || '(empty)'}`,
|
|
`Error: ${finalError}`, // Use the cleaned error string.
|
|
`Exit Code: ${result.exitCode ?? '(none)'}`,
|
|
`Signal: ${result.signal ?? '(none)'}`,
|
|
`Background PIDs: ${
|
|
backgroundPIDs.length ? backgroundPIDs.join(', ') : '(none)'
|
|
}`,
|
|
`Process Group PGID: ${result.pid ?? '(none)'}`,
|
|
].join('\n');
|
|
}
|
|
|
|
let returnDisplayMessage = '';
|
|
if (this.config.getDebugMode()) {
|
|
returnDisplayMessage = llmContent;
|
|
} else {
|
|
if (result.output.trim()) {
|
|
returnDisplayMessage = result.output;
|
|
} else {
|
|
if (result.aborted) {
|
|
returnDisplayMessage = 'Command cancelled by user.';
|
|
} else if (result.signal) {
|
|
returnDisplayMessage = `Command terminated by signal: ${result.signal}`;
|
|
} else if (result.error) {
|
|
returnDisplayMessage = `Command failed: ${getErrorMessage(
|
|
result.error,
|
|
)}`;
|
|
} else if (result.exitCode !== null && result.exitCode !== 0) {
|
|
returnDisplayMessage = `Command exited with code: ${result.exitCode}`;
|
|
}
|
|
// If output is empty and command succeeded (code 0, no error/signal/abort),
|
|
// returnDisplayMessage will remain empty, which is fine.
|
|
}
|
|
}
|
|
|
|
const summarizeConfig = this.config.getSummarizeToolOutputConfig();
|
|
if (summarizeConfig && summarizeConfig[ShellTool.Name]) {
|
|
const summary = await summarizeToolOutput(
|
|
llmContent,
|
|
this.config.getGeminiClient(),
|
|
signal,
|
|
summarizeConfig[ShellTool.Name].tokenBudget,
|
|
);
|
|
return {
|
|
llmContent: summary,
|
|
returnDisplay: returnDisplayMessage,
|
|
};
|
|
}
|
|
|
|
return {
|
|
llmContent,
|
|
returnDisplay: returnDisplayMessage,
|
|
};
|
|
} finally {
|
|
if (fs.existsSync(tempFilePath)) {
|
|
fs.unlinkSync(tempFilePath);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
function getShellToolDescription(): string {
|
|
const returnedInfo = `
|
|
|
|
The following information is returned:
|
|
|
|
Command: Executed command.
|
|
Directory: Directory (relative to project root) where command was executed, or \`(root)\`.
|
|
Stdout: Output on stdout stream. Can be \`(empty)\` or partial on error and for any unwaited background processes.
|
|
Stderr: Output on stderr stream. Can be \`(empty)\` or partial on error and for any unwaited background processes.
|
|
Error: Error or \`(none)\` if no error was reported for the subprocess.
|
|
Exit Code: Exit code or \`(none)\` if terminated by signal.
|
|
Signal: Signal number or \`(none)\` if no signal was received.
|
|
Background PIDs: List of background processes started or \`(none)\`.
|
|
Process Group PGID: Process group started or \`(none)\``;
|
|
|
|
if (os.platform() === 'win32') {
|
|
return `This tool executes a given shell command as \`cmd.exe /c <command>\`. Command can start background processes using \`start /b\`.${returnedInfo}`;
|
|
} else {
|
|
return `This tool executes a given shell command as \`bash -c <command>\`. Command can start background processes using \`&\`. Command is executed as a subprocess that leads its own process group. Command process group can be terminated as \`kill -- -PGID\` or signaled as \`kill -s SIGNAL -- -PGID\`.${returnedInfo}`;
|
|
}
|
|
}
|
|
|
|
function getCommandDescription(): string {
|
|
if (os.platform() === 'win32') {
|
|
return 'Exact command to execute as `cmd.exe /c <command>`';
|
|
} else {
|
|
return 'Exact bash command to execute as `bash -c <command>`';
|
|
}
|
|
}
|
|
|
|
export class ShellTool extends BaseDeclarativeTool<
|
|
ShellToolParams,
|
|
ToolResult
|
|
> {
|
|
static Name: string = 'run_shell_command';
|
|
private allowlist: Set<string> = new Set();
|
|
|
|
constructor(private readonly config: Config) {
|
|
super(
|
|
ShellTool.Name,
|
|
'Shell',
|
|
getShellToolDescription(),
|
|
Kind.Execute,
|
|
{
|
|
type: 'object',
|
|
properties: {
|
|
command: {
|
|
type: 'string',
|
|
description: getCommandDescription(),
|
|
},
|
|
description: {
|
|
type: 'string',
|
|
description:
|
|
'Brief description of the command for the user. Be specific and concise. Ideally a single sentence. Can be up to 3 sentences for clarity. No line breaks.',
|
|
},
|
|
directory: {
|
|
type: 'string',
|
|
description:
|
|
'(OPTIONAL) Directory to run the command in, if not the project root directory. Must be relative to the project root directory and must already exist.',
|
|
},
|
|
},
|
|
required: ['command'],
|
|
},
|
|
false, // output is not markdown
|
|
true, // output can be updated
|
|
);
|
|
}
|
|
|
|
protected override validateToolParams(
|
|
params: ShellToolParams,
|
|
): string | null {
|
|
const commandCheck = isCommandAllowed(params.command, this.config);
|
|
if (!commandCheck.allowed) {
|
|
if (!commandCheck.reason) {
|
|
console.error(
|
|
'Unexpected: isCommandAllowed returned false without a reason',
|
|
);
|
|
return `Command is not allowed: ${params.command}`;
|
|
}
|
|
return commandCheck.reason;
|
|
}
|
|
const errors = SchemaValidator.validate(
|
|
this.schema.parametersJsonSchema,
|
|
params,
|
|
);
|
|
if (errors) {
|
|
return errors;
|
|
}
|
|
if (!params.command.trim()) {
|
|
return 'Command cannot be empty.';
|
|
}
|
|
if (getCommandRoots(params.command).length === 0) {
|
|
return 'Could not identify command root to obtain permission from user.';
|
|
}
|
|
if (params.directory) {
|
|
if (path.isAbsolute(params.directory)) {
|
|
return 'Directory cannot be absolute. Please refer to workspace directories by their name.';
|
|
}
|
|
const workspaceDirs = this.config.getWorkspaceContext().getDirectories();
|
|
const matchingDirs = workspaceDirs.filter(
|
|
(dir) => path.basename(dir) === params.directory,
|
|
);
|
|
|
|
if (matchingDirs.length === 0) {
|
|
return `Directory '${params.directory}' is not a registered workspace directory.`;
|
|
}
|
|
|
|
if (matchingDirs.length > 1) {
|
|
return `Directory name '${params.directory}' is ambiguous as it matches multiple workspace directories.`;
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
protected createInvocation(
|
|
params: ShellToolParams,
|
|
): ToolInvocation<ShellToolParams, ToolResult> {
|
|
return new ShellToolInvocation(this.config, params, this.allowlist);
|
|
}
|
|
}
|