mirror of
https://github.com/QwenLM/qwen-code.git
synced 2025-12-21 09:17:53 +00:00
Initial commit of Gemini Code CLI
This commit introduces the initial codebase for the Gemini Code CLI, a command-line interface designed to facilitate interaction with the Gemini API for software engineering tasks.
The code was migrated from a previous git repository as a single squashed commit.
Core Features & Components:
* **Gemini Integration:** Leverages the `@google/genai` SDK to interact with the Gemini models, supporting chat history, streaming responses, and function calling (tools).
* **Terminal UI:** Built with Ink (React for CLIs) providing an interactive chat interface within the terminal, including input prompts, message display, loading indicators, and tool interaction elements.
* **Tooling Framework:** Implements a robust tool system allowing Gemini to interact with the local environment. Includes tools for:
* File system listing (`ls`)
* File reading (`read-file`)
* Content searching (`grep`)
* File globbing (`glob`)
* File editing (`edit`)
* File writing (`write-file`)
* Executing bash commands (`terminal`)
* **State Management:** Handles the streaming state of Gemini responses and manages the conversation history.
* **Configuration:** Parses command-line arguments (`yargs`) and loads environment variables (`dotenv`) for setup.
* **Project Structure:** Organized into `core`, `ui`, `tools`, `config`, and `utils` directories using TypeScript. Includes basic build (`tsc`) and start scripts.
This initial version establishes the foundation for a powerful CLI tool enabling developers to use Gemini for coding assistance directly in their terminal environment.
---
Created by yours truly: __Gemini Code__
This commit is contained in:
Taylor Mullen
73
packages/cli/src/tools/BaseTool.ts
Normal file
73
packages/cli/src/tools/BaseTool.ts
Normal file
@@ -0,0 +1,73 @@
|
||||
import type { FunctionDeclaration, Schema } from '@google/genai';
|
||||
import { ToolResult } from './ToolResult.js';
|
||||
import { Tool } from './Tool.js';
|
||||
import { ToolCallConfirmationDetails } from '../ui/types.js';
|
||||
|
||||
/**
|
||||
* Base implementation for tools with common functionality
|
||||
*/
|
||||
export abstract class BaseTool<TParams = unknown, TResult extends ToolResult = ToolResult> implements Tool<TParams, TResult> {
|
||||
/**
|
||||
* Creates a new instance of BaseTool
|
||||
* @param name Internal name of the tool (used for API calls)
|
||||
* @param displayName User-friendly display name of the tool
|
||||
* @param description Description of what the tool does
|
||||
* @param parameterSchema JSON Schema defining the parameters
|
||||
*/
|
||||
constructor(
|
||||
public readonly name: string,
|
||||
public readonly displayName: string,
|
||||
public readonly description: string,
|
||||
public readonly parameterSchema: Record<string, unknown>
|
||||
) {}
|
||||
|
||||
/**
|
||||
* Function declaration schema computed from name, description, and parameterSchema
|
||||
*/
|
||||
get schema(): FunctionDeclaration {
|
||||
return {
|
||||
name: this.name,
|
||||
description: this.description,
|
||||
parameters: this.parameterSchema as Schema
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates the parameters for the tool
|
||||
* This is a placeholder implementation and should be overridden
|
||||
* @param params Parameters to validate
|
||||
* @returns An error message string if invalid, null otherwise
|
||||
*/
|
||||
invalidParams(params: TParams): string | null {
|
||||
// Implementation would typically use a JSON Schema validator
|
||||
// This is a placeholder that should be implemented by derived classes
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a pre-execution description of the tool operation
|
||||
* Default implementation that should be overridden by derived classes
|
||||
* @param params Parameters for the tool execution
|
||||
* @returns A markdown string describing what the tool will do
|
||||
*/
|
||||
getDescription(params: TParams): string {
|
||||
return JSON.stringify(params);
|
||||
}
|
||||
|
||||
/**
|
||||
* Determines if the tool should prompt for confirmation before execution
|
||||
* @param params Parameters for the tool execution
|
||||
* @returns Whether or not execute should be confirmed by the user.
|
||||
*/
|
||||
shouldConfirmExecute(params: TParams): Promise<ToolCallConfirmationDetails | false> {
|
||||
return Promise.resolve(false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Abstract method to execute the tool with the given parameters
|
||||
* Must be implemented by derived classes
|
||||
* @param params Parameters for the tool execution
|
||||
* @returns Result of the tool execution
|
||||
*/
|
||||
abstract execute(params: TParams): Promise<TResult>;
|
||||
}
|
||||
57
packages/cli/src/tools/Tool.ts
Normal file
57
packages/cli/src/tools/Tool.ts
Normal file
@@ -0,0 +1,57 @@
|
||||
import { FunctionDeclaration } from "@google/genai";
|
||||
import { ToolResult } from "./ToolResult.js";
|
||||
import { ToolCallConfirmationDetails } from "../ui/types.js";
|
||||
|
||||
/**
|
||||
* Interface representing the base Tool functionality
|
||||
*/
|
||||
export interface Tool<TParams = unknown, TResult extends ToolResult = ToolResult> {
|
||||
/**
|
||||
* The internal name of the tool (used for API calls)
|
||||
*/
|
||||
name: string;
|
||||
|
||||
/**
|
||||
* The user-friendly display name of the tool
|
||||
*/
|
||||
displayName: string;
|
||||
|
||||
/**
|
||||
* Description of what the tool does
|
||||
*/
|
||||
description: string;
|
||||
|
||||
/**
|
||||
* Function declaration schema from @google/genai
|
||||
*/
|
||||
schema: FunctionDeclaration;
|
||||
|
||||
/**
|
||||
* Validates the parameters for the tool
|
||||
* @param params Parameters to validate
|
||||
* @returns An error message string if invalid, null otherwise
|
||||
*/
|
||||
invalidParams(params: TParams): string | null;
|
||||
|
||||
/**
|
||||
* Gets a pre-execution description of the tool operation
|
||||
* @param params Parameters for the tool execution
|
||||
* @returns A markdown string describing what the tool will do
|
||||
* Optional for backward compatibility
|
||||
*/
|
||||
getDescription(params: TParams): string;
|
||||
|
||||
/**
|
||||
* Determines if the tool should prompt for confirmation before execution
|
||||
* @param params Parameters for the tool execution
|
||||
* @returns Whether execute should be confirmed.
|
||||
*/
|
||||
shouldConfirmExecute(params: TParams): Promise<ToolCallConfirmationDetails | false>;
|
||||
|
||||
/**
|
||||
* Executes the tool with the given parameters
|
||||
* @param params Parameters for the tool execution
|
||||
* @returns Result of the tool execution
|
||||
*/
|
||||
execute(params: TParams): Promise<TResult>;
|
||||
}
|
||||
22
packages/cli/src/tools/ToolResult.ts
Normal file
22
packages/cli/src/tools/ToolResult.ts
Normal file
@@ -0,0 +1,22 @@
|
||||
/**
|
||||
* Standard tool result interface that all tools should implement
|
||||
*/
|
||||
export interface ToolResult {
|
||||
/**
|
||||
* Content meant to be included in LLM history.
|
||||
* This should represent the factual outcome of the tool execution.
|
||||
*/
|
||||
llmContent: string;
|
||||
|
||||
/**
|
||||
* Markdown string for user display.
|
||||
* This provides a user-friendly summary or visualization of the result.
|
||||
*/
|
||||
returnDisplay: ToolResultDisplay;
|
||||
}
|
||||
|
||||
export type ToolResultDisplay = string | FileDiff;
|
||||
|
||||
export interface FileDiff {
|
||||
fileDiff: string
|
||||
}
|
||||
369
packages/cli/src/tools/edit.tool.ts
Normal file
369
packages/cli/src/tools/edit.tool.ts
Normal file
@@ -0,0 +1,369 @@
|
||||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
import * as Diff from 'diff';
|
||||
import { SchemaValidator } from '../utils/schemaValidator.js';
|
||||
import { ToolResult } from './ToolResult.js';
|
||||
import { BaseTool } from './BaseTool.js';
|
||||
import { ToolCallConfirmationDetails, ToolConfirmationOutcome, ToolEditConfirmationDetails } from '../ui/types.js';
|
||||
import { makeRelative, shortenPath } from '../utils/paths.js';
|
||||
import { ReadFileTool } from './read-file.tool.js';
|
||||
import { WriteFileTool } from './write-file.tool.js';
|
||||
|
||||
/**
|
||||
* Parameters for the Edit tool
|
||||
*/
|
||||
export interface EditToolParams {
|
||||
/**
|
||||
* The absolute path to the file to modify
|
||||
*/
|
||||
file_path: string;
|
||||
|
||||
/**
|
||||
* The text to replace
|
||||
*/
|
||||
old_string: string;
|
||||
|
||||
/**
|
||||
* The text to replace it with
|
||||
*/
|
||||
new_string: string;
|
||||
|
||||
/**
|
||||
* The expected number of replacements to perform (optional, defaults to 1)
|
||||
*/
|
||||
expected_replacements?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Result from the Edit tool
|
||||
*/
|
||||
export interface EditToolResult extends ToolResult {
|
||||
}
|
||||
|
||||
interface CalculatedEdit {
|
||||
currentContent: string | null;
|
||||
newContent: string;
|
||||
occurrences: number;
|
||||
error?: { display: string, raw: string };
|
||||
isNewFile: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of the Edit tool that modifies files.
|
||||
* This tool maintains state for the "Always Edit" confirmation preference.
|
||||
*/
|
||||
export class EditTool extends BaseTool<EditToolParams, EditToolResult> {
|
||||
private shouldAlwaysEdit = false;
|
||||
private readonly rootDirectory: string;
|
||||
|
||||
/**
|
||||
* Creates a new instance of the EditTool
|
||||
* @param rootDirectory Root directory to ground this tool in.
|
||||
*/
|
||||
constructor(rootDirectory: string) {
|
||||
super(
|
||||
'replace',
|
||||
'Edit',
|
||||
`Replaces a SINGLE, UNIQUE occurrence of text within a file. Requires providing significant context around the change to ensure uniqueness. For moving/renaming files, use the Bash tool with \`mv\`. For replacing entire file contents or creating new files use the ${WriteFileTool.Name} tool. Always use the ${ReadFileTool.Name} tool to examine the file before using this tool.`,
|
||||
{
|
||||
properties: {
|
||||
file_path: {
|
||||
description: 'The absolute path to the file to modify. Must start with /. When creating a new file, ensure the parent directory exists (use the `LS` tool to verify).',
|
||||
type: 'string'
|
||||
},
|
||||
old_string: {
|
||||
description: 'The exact text to replace. CRITICAL: Must uniquely identify the single instance to change. Include at least 3-5 lines of context BEFORE and AFTER the target text, matching whitespace and indentation precisely. If this string matches multiple locations or does not match exactly, the tool will fail. Use an empty string ("") when creating a new file.',
|
||||
type: 'string'
|
||||
},
|
||||
new_string: {
|
||||
description: 'The text to replace the `old_string` with. When creating a new file (using an empty `old_string`), this should contain the full desired content of the new file. Ensure the resulting code is correct and idiomatic.',
|
||||
type: 'string'
|
||||
}
|
||||
},
|
||||
required: ['file_path', 'old_string', 'new_string'],
|
||||
type: 'object'
|
||||
}
|
||||
);
|
||||
this.rootDirectory = path.resolve(rootDirectory);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a path is within the root directory.
|
||||
* @param pathToCheck The absolute path to check.
|
||||
* @returns True if the path is within the root directory, false otherwise.
|
||||
*/
|
||||
private isWithinRoot(pathToCheck: string): boolean {
|
||||
const normalizedPath = path.normalize(pathToCheck);
|
||||
const normalizedRoot = this.rootDirectory;
|
||||
|
||||
const rootWithSep = normalizedRoot.endsWith(path.sep)
|
||||
? normalizedRoot
|
||||
: normalizedRoot + path.sep;
|
||||
|
||||
return normalizedPath === normalizedRoot || normalizedPath.startsWith(rootWithSep);
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates the parameters for the Edit tool
|
||||
* @param params Parameters to validate
|
||||
* @returns True if parameters are valid, false otherwise
|
||||
*/
|
||||
validateParams(params: EditToolParams): boolean {
|
||||
if (this.schema.parameters && !SchemaValidator.validate(this.schema.parameters as Record<string, unknown>, params)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
// Ensure path is absolute
|
||||
if (!path.isAbsolute(params.file_path)) {
|
||||
console.error(`File path must be absolute: ${params.file_path}`);
|
||||
return false;
|
||||
}
|
||||
|
||||
// Ensure path is within the root directory
|
||||
if (!this.isWithinRoot(params.file_path)) {
|
||||
console.error(`File path must be within the root directory (${this.rootDirectory}): ${params.file_path}`);
|
||||
return false;
|
||||
}
|
||||
|
||||
|
||||
// Validate expected_replacements if provided
|
||||
if (params.expected_replacements !== undefined && params.expected_replacements < 0) {
|
||||
console.error('Expected replacements must be a non-negative number');
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculates the potential outcome of an edit operation.
|
||||
* @param params Parameters for the edit operation
|
||||
* @returns An object describing the potential edit outcome
|
||||
* @throws File system errors if reading the file fails unexpectedly (e.g., permissions)
|
||||
*/
|
||||
private calculateEdit(params: EditToolParams): CalculatedEdit {
|
||||
const expectedReplacements = params.expected_replacements === undefined ? 1 : params.expected_replacements;
|
||||
let currentContent: string | null = null;
|
||||
let fileExists = false;
|
||||
let isNewFile = false;
|
||||
let newContent = '';
|
||||
let occurrences = 0;
|
||||
let error: { display: string, raw: string } | undefined = undefined;
|
||||
|
||||
try {
|
||||
currentContent = fs.readFileSync(params.file_path, 'utf8');
|
||||
fileExists = true;
|
||||
} catch (err: any) {
|
||||
if (err.code !== 'ENOENT') {
|
||||
throw err;
|
||||
}
|
||||
fileExists = false;
|
||||
}
|
||||
|
||||
if (params.old_string === '' && !fileExists) {
|
||||
isNewFile = true;
|
||||
newContent = params.new_string;
|
||||
occurrences = 0;
|
||||
} else if (!fileExists) {
|
||||
error = {
|
||||
display: `File not found.`,
|
||||
raw: `File not found: ${params.file_path}`
|
||||
};
|
||||
} else if (currentContent !== null) {
|
||||
occurrences = this.countOccurrences(currentContent, params.old_string);
|
||||
|
||||
if (occurrences === 0) {
|
||||
error = {
|
||||
display: `No edits made`,
|
||||
raw: `Failed to edit, 0 occurrences found`
|
||||
}
|
||||
} else if (occurrences !== expectedReplacements) {
|
||||
error = {
|
||||
display: `Failed to edit, expected ${expectedReplacements} occurrences but found ${occurrences}`,
|
||||
raw: `Failed to edit, Expected ${expectedReplacements} occurrences but found ${occurrences} in file: ${params.file_path}`
|
||||
}
|
||||
} else {
|
||||
newContent = this.replaceAll(currentContent, params.old_string, params.new_string);
|
||||
}
|
||||
} else {
|
||||
error = {
|
||||
display: `Failed to read content`,
|
||||
raw: `Failed to read content of existing file: ${params.file_path}`
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
currentContent,
|
||||
newContent,
|
||||
occurrences,
|
||||
error,
|
||||
isNewFile
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Determines if confirmation is needed and prepares the confirmation details.
|
||||
* This method performs the calculation needed to generate the diff and respects the `shouldAlwaysEdit` state.
|
||||
* @param params Parameters for the potential edit operation
|
||||
* @returns Confirmation details object or false if no confirmation is needed/possible.
|
||||
*/
|
||||
async shouldConfirmExecute(params: EditToolParams): Promise<ToolCallConfirmationDetails | false> {
|
||||
if (this.shouldAlwaysEdit) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!this.validateParams(params)) {
|
||||
console.error("[EditTool] Attempted confirmation with invalid parameters.");
|
||||
return false;
|
||||
}
|
||||
|
||||
let calculatedEdit: CalculatedEdit;
|
||||
try {
|
||||
calculatedEdit = this.calculateEdit(params);
|
||||
} catch (error) {
|
||||
console.error(`Error calculating edit for confirmation: ${error instanceof Error ? error.message : String(error)}`);
|
||||
return false;
|
||||
}
|
||||
|
||||
if (calculatedEdit.error) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const fileName = path.basename(params.file_path);
|
||||
const fileDiff = Diff.createPatch(
|
||||
fileName,
|
||||
calculatedEdit.currentContent ?? '',
|
||||
calculatedEdit.newContent,
|
||||
'Current',
|
||||
'Proposed',
|
||||
{ context: 3, ignoreWhitespace: true, }
|
||||
);
|
||||
|
||||
const confirmationDetails: ToolEditConfirmationDetails = {
|
||||
title: `Confirm Edit: ${shortenPath(makeRelative(params.file_path, this.rootDirectory))}`,
|
||||
fileName,
|
||||
fileDiff,
|
||||
onConfirm: async (outcome: ToolConfirmationOutcome) => {
|
||||
if (outcome === ToolConfirmationOutcome.ProceedAlways) {
|
||||
this.shouldAlwaysEdit = true;
|
||||
}
|
||||
},
|
||||
};
|
||||
return confirmationDetails;
|
||||
}
|
||||
|
||||
getDescription(params: EditToolParams): string {
|
||||
const relativePath = makeRelative(params.file_path, this.rootDirectory);
|
||||
const oldStringSnippet = params.old_string.split('\n')[0].substring(0, 30) + (params.old_string.length > 30 ? '...' : '');
|
||||
const newStringSnippet = params.new_string.split('\n')[0].substring(0, 30) + (params.new_string.length > 30 ? '...' : '');
|
||||
return `${shortenPath(relativePath)}: ${oldStringSnippet} => ${newStringSnippet}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes the edit operation with the given parameters.
|
||||
* This method recalculates the edit operation before execution.
|
||||
* @param params Parameters for the edit operation
|
||||
* @returns Result of the edit operation
|
||||
*/
|
||||
async execute(params: EditToolParams): Promise<EditToolResult> {
|
||||
if (!this.validateParams(params)) {
|
||||
return {
|
||||
llmContent: 'Invalid parameters for file edit operation',
|
||||
returnDisplay: '**Error:** Invalid parameters for file edit operation'
|
||||
};
|
||||
}
|
||||
|
||||
let editData: CalculatedEdit;
|
||||
try {
|
||||
editData = this.calculateEdit(params);
|
||||
} catch (error) {
|
||||
return {
|
||||
llmContent: `Error preparing edit: ${error instanceof Error ? error.message : String(error)}`,
|
||||
returnDisplay: 'Failed to prepare edit'
|
||||
};
|
||||
}
|
||||
|
||||
if (editData.error) {
|
||||
return {
|
||||
llmContent: editData.error.raw,
|
||||
returnDisplay: editData.error.display
|
||||
};
|
||||
}
|
||||
|
||||
try {
|
||||
this.ensureParentDirectoriesExist(params.file_path);
|
||||
fs.writeFileSync(params.file_path, editData.newContent, 'utf8');
|
||||
|
||||
if (editData.isNewFile) {
|
||||
return {
|
||||
llmContent: `Created new file: ${params.file_path} with provided content.`,
|
||||
returnDisplay: `Created ${shortenPath(makeRelative(params.file_path, this.rootDirectory))}`
|
||||
};
|
||||
} else {
|
||||
const fileName = path.basename(params.file_path);
|
||||
const fileDiff = Diff.createPatch(
|
||||
fileName,
|
||||
editData.currentContent ?? '',
|
||||
editData.newContent,
|
||||
'Current',
|
||||
'Proposed',
|
||||
{ context: 3, ignoreWhitespace: true }
|
||||
);
|
||||
|
||||
return {
|
||||
llmContent: `Successfully modified file: ${params.file_path} (${editData.occurrences} replacements).`,
|
||||
returnDisplay: { fileDiff }
|
||||
};
|
||||
}
|
||||
} catch (error) {
|
||||
return {
|
||||
llmContent: `Error executing edit: ${error instanceof Error ? error.message : String(error)}`,
|
||||
returnDisplay: `Failed to edit file`
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Counts occurrences of a substring in a string
|
||||
* @param str String to search in
|
||||
* @param substr Substring to count
|
||||
* @returns Number of occurrences
|
||||
*/
|
||||
private countOccurrences(str: string, substr: string): number {
|
||||
if (substr === '') {
|
||||
return 0;
|
||||
}
|
||||
let count = 0;
|
||||
let pos = str.indexOf(substr);
|
||||
while (pos !== -1) {
|
||||
count++;
|
||||
pos = str.indexOf(substr, pos + substr.length);
|
||||
}
|
||||
return count;
|
||||
}
|
||||
|
||||
/**
|
||||
* Replaces all occurrences of a substring in a string
|
||||
* @param str String to modify
|
||||
* @param find Substring to find
|
||||
* @param replace Replacement string
|
||||
* @returns Modified string
|
||||
*/
|
||||
private replaceAll(str: string, find: string, replace: string): string {
|
||||
if (find === '') {
|
||||
return str;
|
||||
}
|
||||
return str.split(find).join(replace);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates parent directories if they don't exist
|
||||
* @param filePath Path to ensure parent directories exist
|
||||
*/
|
||||
private ensureParentDirectoriesExist(filePath: string): void {
|
||||
const dirName = path.dirname(filePath);
|
||||
if (!fs.existsSync(dirName)) {
|
||||
fs.mkdirSync(dirName, { recursive: true });
|
||||
}
|
||||
}
|
||||
}
|
||||
227
packages/cli/src/tools/glob.tool.ts
Normal file
227
packages/cli/src/tools/glob.tool.ts
Normal file
@@ -0,0 +1,227 @@
|
||||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
import fg from 'fast-glob';
|
||||
import { SchemaValidator } from '../utils/schemaValidator.js';
|
||||
import { BaseTool } from './BaseTool.js';
|
||||
import { ToolResult } from './ToolResult.js';
|
||||
import { shortenPath, makeRelative } from '../utils/paths.js';
|
||||
|
||||
/**
|
||||
* Parameters for the GlobTool
|
||||
*/
|
||||
export interface GlobToolParams {
|
||||
/**
|
||||
* The glob pattern to match files against
|
||||
*/
|
||||
pattern: string;
|
||||
|
||||
/**
|
||||
* The directory to search in (optional, defaults to current directory)
|
||||
*/
|
||||
path?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Result from the GlobTool
|
||||
*/
|
||||
export interface GlobToolResult extends ToolResult {
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of the GlobTool that finds files matching patterns,
|
||||
* sorted by modification time (newest first).
|
||||
*/
|
||||
export class GlobTool extends BaseTool<GlobToolParams, GlobToolResult> {
|
||||
/**
|
||||
* The root directory that this tool is grounded in.
|
||||
* All file operations will be restricted to this directory.
|
||||
*/
|
||||
private rootDirectory: string;
|
||||
|
||||
/**
|
||||
* Creates a new instance of the GlobTool
|
||||
* @param rootDirectory Root directory to ground this tool in. All operations will be restricted to this directory.
|
||||
*/
|
||||
constructor(rootDirectory: string) {
|
||||
super(
|
||||
'glob',
|
||||
'FindFiles',
|
||||
'Efficiently finds files matching specific glob patterns (e.g., `src/**/*.ts`, `**/*.md`), returning absolute paths sorted by modification time (newest first). Ideal for quickly locating files based on their name or path structure, especially in large codebases.',
|
||||
{
|
||||
properties: {
|
||||
pattern: {
|
||||
description: 'The glob pattern to match against (e.g., \'*.py\', \'src/**/*.js\', \'docs/*.md\').',
|
||||
type: 'string'
|
||||
},
|
||||
path: {
|
||||
description: 'Optional: The absolute path to the directory to search within. If omitted, searches the root directory.',
|
||||
type: 'string'
|
||||
}
|
||||
},
|
||||
required: ['pattern'],
|
||||
type: 'object'
|
||||
}
|
||||
);
|
||||
|
||||
// Set the root directory
|
||||
this.rootDirectory = path.resolve(rootDirectory);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a path is within the root directory.
|
||||
* This is a security measure to prevent the tool from accessing files outside of its designated root.
|
||||
* @param pathToCheck The path to check (expects an absolute path)
|
||||
* @returns True if the path is within the root directory, false otherwise
|
||||
*/
|
||||
private isWithinRoot(pathToCheck: string): boolean {
|
||||
const absolutePathToCheck = path.resolve(pathToCheck);
|
||||
const normalizedPath = path.normalize(absolutePathToCheck);
|
||||
const normalizedRoot = path.normalize(this.rootDirectory);
|
||||
|
||||
// Ensure the normalizedRoot ends with a path separator for proper prefix comparison
|
||||
const rootWithSep = normalizedRoot.endsWith(path.sep)
|
||||
? normalizedRoot
|
||||
: normalizedRoot + path.sep;
|
||||
|
||||
// Check if it's the root itself or starts with the root path followed by a separator.
|
||||
// This ensures that we don't accidentally allow access to parent directories.
|
||||
return normalizedPath === normalizedRoot || normalizedPath.startsWith(rootWithSep);
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates the parameters for the tool.
|
||||
* Ensures that the provided parameters adhere to the expected schema and that the search path is valid and within the tool's root directory.
|
||||
* @param params Parameters to validate
|
||||
* @returns An error message string if invalid, null otherwise
|
||||
*/
|
||||
invalidParams(params: GlobToolParams): string | null {
|
||||
if (this.schema.parameters && !SchemaValidator.validate(this.schema.parameters as Record<string, unknown>, params)) {
|
||||
return "Parameters failed schema validation. Ensure 'pattern' is a string and 'path' (if provided) is a string.";
|
||||
}
|
||||
|
||||
// Determine the absolute path to check
|
||||
const searchDirAbsolute = params.path ?? this.rootDirectory;
|
||||
|
||||
// Validate path is within root directory
|
||||
if (!this.isWithinRoot(searchDirAbsolute)) {
|
||||
return `Search path ("${searchDirAbsolute}") resolves outside the tool's root directory ("${this.rootDirectory}").`;
|
||||
}
|
||||
|
||||
// Validate path exists and is a directory using the absolute path.
|
||||
// These checks prevent the tool from attempting to search in non-existent or non-directory paths, which would lead to errors.
|
||||
try {
|
||||
if (!fs.existsSync(searchDirAbsolute)) {
|
||||
return `Search path does not exist: ${shortenPath(makeRelative(searchDirAbsolute, this.rootDirectory))} (absolute: ${searchDirAbsolute})`;
|
||||
}
|
||||
if (!fs.statSync(searchDirAbsolute).isDirectory()) {
|
||||
return `Search path is not a directory: ${shortenPath(makeRelative(searchDirAbsolute, this.rootDirectory))} (absolute: ${searchDirAbsolute})`;
|
||||
}
|
||||
} catch (e: any) {
|
||||
// Catch potential permission errors during sync checks
|
||||
return `Error accessing search path: ${e.message}`;
|
||||
}
|
||||
|
||||
// Validate glob pattern (basic non-empty check)
|
||||
if (!params.pattern || typeof params.pattern !== 'string' || params.pattern.trim() === '') {
|
||||
return "The 'pattern' parameter cannot be empty.";
|
||||
}
|
||||
// Could add more sophisticated glob pattern validation if needed
|
||||
|
||||
return null; // Parameters are valid
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a description of the glob operation.
|
||||
* @param params Parameters for the glob operation.
|
||||
* @returns A string describing the glob operation.
|
||||
*/
|
||||
getDescription(params: GlobToolParams): string {
|
||||
let description = `'${params.pattern}'`;
|
||||
|
||||
if (params.path) {
|
||||
const searchDir = params.path || this.rootDirectory;
|
||||
const relativePath = makeRelative(searchDir, this.rootDirectory);
|
||||
description += ` within ${shortenPath(relativePath)}`;
|
||||
}
|
||||
|
||||
return description;
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes the glob search with the given parameters
|
||||
* @param params Parameters for the glob search
|
||||
* @returns Result of the glob search
|
||||
*/
|
||||
async execute(params: GlobToolParams): Promise<GlobToolResult> {
|
||||
const validationError = this.invalidParams(params);
|
||||
if (validationError) {
|
||||
return {
|
||||
llmContent: `Error: Invalid parameters provided. Reason: ${validationError}`,
|
||||
returnDisplay: `**Error:** Failed to execute tool.`
|
||||
};
|
||||
}
|
||||
|
||||
try {
|
||||
// 1. Resolve the absolute search directory. Validation ensures it exists and is a directory.
|
||||
const searchDirAbsolute = params.path ?? this.rootDirectory;
|
||||
|
||||
// 2. Perform Glob Search using fast-glob
|
||||
// We use fast-glob because it's performant and supports glob patterns.
|
||||
const entries = await fg(params.pattern, {
|
||||
cwd: searchDirAbsolute, // Search within this absolute directory
|
||||
absolute: true, // Return absolute paths
|
||||
onlyFiles: true, // Match only files
|
||||
stats: true, // Include file stats object for sorting
|
||||
dot: true, // Include files starting with a dot
|
||||
ignore: ['**/node_modules/**', '**/.git/**'], // Common sensible default, adjust as needed
|
||||
followSymbolicLinks: false, // Avoid potential issues with symlinks unless specifically needed
|
||||
suppressErrors: true, // Suppress EACCES errors for individual files (we handle dir access in validation)
|
||||
});
|
||||
|
||||
// 3. Handle No Results
|
||||
if (!entries || entries.length === 0) {
|
||||
return {
|
||||
llmContent: `No files found matching pattern "${params.pattern}" within ${searchDirAbsolute}.`,
|
||||
returnDisplay: `No files found`
|
||||
};
|
||||
}
|
||||
|
||||
// 4. Sort Results by Modification Time (Newest First)
|
||||
// Sorting by modification time ensures that the most recently modified files are listed first.
|
||||
// This can be useful for quickly identifying the files that have been recently changed.
|
||||
// The stats object is guaranteed by the `stats: true` option in the fast-glob configuration.
|
||||
entries.sort((a, b) => {
|
||||
// Ensure stats exist before accessing mtime (though fg should provide them)
|
||||
const mtimeA = a.stats?.mtime?.getTime() ?? 0;
|
||||
const mtimeB = b.stats?.mtime?.getTime() ?? 0;
|
||||
return mtimeB - mtimeA; // Descending order
|
||||
});
|
||||
|
||||
// 5. Format Output
|
||||
const sortedAbsolutePaths = entries.map(entry => entry.path);
|
||||
|
||||
// Convert absolute paths to relative paths (to rootDir) for clearer display
|
||||
const sortedRelativePaths = sortedAbsolutePaths.map(absPath => makeRelative(absPath, this.rootDirectory));
|
||||
|
||||
// Construct the result message
|
||||
const fileListDescription = sortedRelativePaths.map(p => ` - ${shortenPath(p)}`).join('\n');
|
||||
const fileCount = sortedRelativePaths.length;
|
||||
const relativeSearchDir = makeRelative(searchDirAbsolute, this.rootDirectory);
|
||||
const displayPath = shortenPath(relativeSearchDir === '.' ? 'root directory' : relativeSearchDir);
|
||||
|
||||
return {
|
||||
llmContent: `Found ${fileCount} file(s) matching "${params.pattern}" within ${displayPath}, sorted by modification time (newest first):\n${fileListDescription}`,
|
||||
returnDisplay: `Found ${fileCount} matching file(s)`
|
||||
};
|
||||
|
||||
} catch (error) {
|
||||
// Catch unexpected errors during glob execution (less likely with suppressErrors=true, but possible)
|
||||
const errorMessage = error instanceof Error ? error.message : String(error);
|
||||
console.error(`GlobTool execute Error: ${errorMessage}`, error);
|
||||
return {
|
||||
llmContent: `Error during glob search operation: ${errorMessage}`,
|
||||
returnDisplay: `**Error:** An unexpected error occurred.`
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
493
packages/cli/src/tools/grep.tool.ts
Normal file
493
packages/cli/src/tools/grep.tool.ts
Normal file
@@ -0,0 +1,493 @@
|
||||
import fs from 'fs'; // Used for sync checks in validation
|
||||
import fsPromises from 'fs/promises'; // Used for async operations in fallback
|
||||
import path from 'path';
|
||||
import { EOL } from 'os'; // Used for parsing grep output lines
|
||||
import { spawn } from 'child_process'; // Used for git grep and system grep
|
||||
import fastGlob from 'fast-glob'; // Used for JS fallback file searching
|
||||
import { ToolResult } from './ToolResult.js';
|
||||
import { BaseTool } from './BaseTool.js';
|
||||
import { SchemaValidator } from '../utils/schemaValidator.js';
|
||||
import { makeRelative, shortenPath } from '../utils/paths.js';
|
||||
|
||||
// --- Interfaces (kept separate for clarity) ---
|
||||
|
||||
/**
|
||||
* Parameters for the GrepTool
|
||||
*/
|
||||
export interface GrepToolParams {
|
||||
/**
|
||||
* The regular expression pattern to search for in file contents
|
||||
*/
|
||||
pattern: string;
|
||||
|
||||
/**
|
||||
* The directory to search in (optional, defaults to current directory relative to root)
|
||||
*/
|
||||
path?: string;
|
||||
|
||||
/**
|
||||
* File pattern to include in the search (e.g. "*.js", "*.{ts,tsx}")
|
||||
*/
|
||||
include?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Result object for a single grep match
|
||||
*/
|
||||
interface GrepMatch {
|
||||
filePath: string;
|
||||
lineNumber: number;
|
||||
line: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Result from the GrepTool
|
||||
*/
|
||||
export interface GrepToolResult extends ToolResult {
|
||||
}
|
||||
|
||||
// --- GrepTool Class ---
|
||||
|
||||
/**
|
||||
* Implementation of the GrepTool that searches file contents using git grep, system grep, or JS fallback.
|
||||
*/
|
||||
export class GrepTool extends BaseTool<GrepToolParams, GrepToolResult> {
|
||||
private rootDirectory: string;
|
||||
|
||||
/**
|
||||
* Creates a new instance of the GrepTool
|
||||
* @param rootDirectory Root directory to ground this tool in. All operations will be restricted to this directory.
|
||||
*/
|
||||
constructor(rootDirectory: string) {
|
||||
super(
|
||||
'search_file_content',
|
||||
'SearchText',
|
||||
'Searches for a regular expression pattern within the content of files in a specified directory (or current working directory). Can filter files by a glob pattern. Returns the lines containing matches, along with their file paths and line numbers.',
|
||||
{
|
||||
properties: {
|
||||
pattern: {
|
||||
description: 'The regular expression (regex) pattern to search for within file contents (e.g., \'function\\s+myFunction\', \'import\\s+\\{.*\\}\\s+from\\s+.*\').',
|
||||
type: 'string'
|
||||
},
|
||||
path: {
|
||||
description: 'Optional: The absolute path to the directory to search within. If omitted, searches the current working directory.',
|
||||
type: 'string'
|
||||
},
|
||||
include: {
|
||||
description: 'Optional: A glob pattern to filter which files are searched (e.g., \'*.js\', \'*.{ts,tsx}\', \'src/**\'). If omitted, searches all files (respecting potential global ignores).',
|
||||
type: 'string'
|
||||
}
|
||||
},
|
||||
required: ['pattern'],
|
||||
type: 'object'
|
||||
}
|
||||
);
|
||||
// Ensure rootDirectory is absolute and normalized
|
||||
this.rootDirectory = path.resolve(rootDirectory);
|
||||
}
|
||||
|
||||
// --- Validation Methods ---
|
||||
|
||||
/**
|
||||
* Checks if a path is within the root directory and resolves it.
|
||||
* @param relativePath Path relative to the root directory (or undefined for root).
|
||||
* @returns The absolute path if valid and exists.
|
||||
* @throws {Error} If path is outside root, doesn't exist, or isn't a directory.
|
||||
*/
|
||||
private resolveAndValidatePath(relativePath?: string): string {
|
||||
const targetPath = path.resolve(this.rootDirectory, relativePath || '.');
|
||||
|
||||
// Security Check: Ensure the resolved path is still within the root directory.
|
||||
if (!targetPath.startsWith(this.rootDirectory) && targetPath !== this.rootDirectory) {
|
||||
throw new Error(`Path validation failed: Attempted path "${relativePath || '.'}" resolves outside the allowed root directory "${this.rootDirectory}".`);
|
||||
}
|
||||
|
||||
// Check existence and type after resolving
|
||||
try {
|
||||
const stats = fs.statSync(targetPath);
|
||||
if (!stats.isDirectory()) {
|
||||
throw new Error(`Path is not a directory: ${targetPath}`);
|
||||
}
|
||||
} catch (err: any) {
|
||||
if (err.code === 'ENOENT') {
|
||||
throw new Error(`Path does not exist: ${targetPath}`);
|
||||
}
|
||||
throw new Error(`Failed to access path stats for ${targetPath}: ${err.message}`);
|
||||
}
|
||||
|
||||
return targetPath;
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates the parameters for the tool
|
||||
* @param params Parameters to validate
|
||||
* @returns An error message string if invalid, null otherwise
|
||||
*/
|
||||
invalidParams(params: GrepToolParams): string | null {
|
||||
if (this.schema.parameters && !SchemaValidator.validate(this.schema.parameters as Record<string, unknown>, params)) {
|
||||
return "Parameters failed schema validation.";
|
||||
}
|
||||
|
||||
try {
|
||||
new RegExp(params.pattern);
|
||||
} catch (error) {
|
||||
return `Invalid regular expression pattern provided: ${params.pattern}. Error: ${error instanceof Error ? error.message : String(error)}`;
|
||||
}
|
||||
|
||||
try {
|
||||
this.resolveAndValidatePath(params.path);
|
||||
} catch (error) {
|
||||
return error instanceof Error ? error.message : String(error);
|
||||
}
|
||||
|
||||
return null; // Parameters are valid
|
||||
}
|
||||
|
||||
|
||||
// --- Core Execution ---
|
||||
|
||||
/**
|
||||
* Executes the grep search with the given parameters
|
||||
* @param params Parameters for the grep search
|
||||
* @returns Result of the grep search
|
||||
*/
|
||||
async execute(params: GrepToolParams): Promise<GrepToolResult> {
|
||||
const validationError = this.invalidParams(params);
|
||||
if (validationError) {
|
||||
console.error(`GrepTool Parameter Validation Failed: ${validationError}`);
|
||||
return {
|
||||
llmContent: `Error: Invalid parameters provided. Reason: ${validationError}`,
|
||||
returnDisplay: `**Error:** Failed to execute tool.`
|
||||
};
|
||||
}
|
||||
|
||||
let searchDirAbs: string;
|
||||
try {
|
||||
searchDirAbs = this.resolveAndValidatePath(params.path);
|
||||
const searchDirDisplay = params.path || '.';
|
||||
|
||||
const matches: GrepMatch[] = await this.performGrepSearch({
|
||||
pattern: params.pattern,
|
||||
path: searchDirAbs,
|
||||
include: params.include,
|
||||
});
|
||||
|
||||
if (matches.length === 0) {
|
||||
const noMatchMsg = `No matches found for pattern "${params.pattern}" in path "${searchDirDisplay}"${params.include ? ` (filter: "${params.include}")` : ''}.`;
|
||||
const noMatchUser = `No matches found`;
|
||||
return { llmContent: noMatchMsg, returnDisplay: noMatchUser };
|
||||
}
|
||||
|
||||
const matchesByFile = matches.reduce((acc, match) => {
|
||||
const relativeFilePath = path.relative(searchDirAbs, path.resolve(searchDirAbs, match.filePath)) || path.basename(match.filePath);
|
||||
if (!acc[relativeFilePath]) {
|
||||
acc[relativeFilePath] = [];
|
||||
}
|
||||
acc[relativeFilePath].push(match);
|
||||
acc[relativeFilePath].sort((a, b) => a.lineNumber - b.lineNumber);
|
||||
return acc;
|
||||
}, {} as Record<string, GrepMatch[]>);
|
||||
|
||||
let llmContent = `Found ${matches.length} match(es) for pattern "${params.pattern}" in path "${searchDirDisplay}"${params.include ? ` (filter: "${params.include}")` : ''}:\n---\n`;
|
||||
|
||||
for (const filePath in matchesByFile) {
|
||||
llmContent += `File: ${filePath}\n`;
|
||||
matchesByFile[filePath].forEach(match => {
|
||||
const trimmedLine = match.line.trim();
|
||||
llmContent += `L${match.lineNumber}: ${trimmedLine}\n`;
|
||||
});
|
||||
llmContent += '---\n';
|
||||
}
|
||||
|
||||
return { llmContent: llmContent.trim(), returnDisplay: `Found ${matches.length} matche(s)` };
|
||||
|
||||
} catch (error) {
|
||||
console.error(`Error during GrepTool execution: ${error}`);
|
||||
const errorMessage = error instanceof Error ? error.message : String(error);
|
||||
return {
|
||||
llmContent: `Error during grep search operation: ${errorMessage}`,
|
||||
returnDisplay: errorMessage
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// --- Inlined Grep Logic and Helpers ---
|
||||
|
||||
/**
|
||||
* Checks if a command is available in the system's PATH.
|
||||
* @param {string} command The command name (e.g., 'git', 'grep').
|
||||
* @returns {Promise<boolean>} True if the command is available, false otherwise.
|
||||
*/
|
||||
private isCommandAvailable(command: string): Promise<boolean> {
|
||||
return new Promise((resolve) => {
|
||||
const checkCommand = process.platform === 'win32' ? 'where' : 'command';
|
||||
const checkArgs = process.platform === 'win32' ? [command] : ['-v', command];
|
||||
try {
|
||||
const child = spawn(checkCommand, checkArgs, { stdio: 'ignore', shell: process.platform === 'win32' });
|
||||
child.on('close', (code) => resolve(code === 0));
|
||||
child.on('error', () => resolve(false));
|
||||
} catch (e) {
|
||||
resolve(false);
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a directory or its parent directories contain a .git folder.
|
||||
* @param {string} dirPath Absolute path to the directory to check.
|
||||
* @returns {Promise<boolean>} True if it's a Git repository, false otherwise.
|
||||
*/
|
||||
private async isGitRepository(dirPath: string): Promise<boolean> {
|
||||
let currentPath = path.resolve(dirPath);
|
||||
const root = path.parse(currentPath).root;
|
||||
|
||||
try {
|
||||
while (true) {
|
||||
const gitPath = path.join(currentPath, '.git');
|
||||
try {
|
||||
const stats = await fsPromises.stat(gitPath);
|
||||
if (stats.isDirectory() || stats.isFile()) {
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
} catch (err: any) {
|
||||
if (err.code !== 'ENOENT') {
|
||||
console.error(`Error checking for .git in ${currentPath}: ${err.message}`);
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
if (currentPath === root) {
|
||||
break;
|
||||
}
|
||||
currentPath = path.dirname(currentPath);
|
||||
}
|
||||
} catch (err: any) {
|
||||
console.error(`Error traversing directory structure upwards from ${dirPath}: ${err instanceof Error ? err.message : String(err)}`);
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses the standard output of grep-like commands (git grep, system grep).
|
||||
* Expects format: filePath:lineNumber:lineContent
|
||||
* Handles colons within file paths and line content correctly.
|
||||
* @param {string} output The raw stdout string.
|
||||
* @param {string} basePath The absolute directory the search was run from, for relative paths.
|
||||
* @returns {GrepMatch[]} Array of match objects.
|
||||
*/
|
||||
private parseGrepOutput(output: string, basePath: string): GrepMatch[] {
|
||||
const results: GrepMatch[] = [];
|
||||
if (!output) return results;
|
||||
|
||||
const lines = output.split(EOL); // Use OS-specific end-of-line
|
||||
|
||||
for (const line of lines) {
|
||||
if (!line.trim()) continue;
|
||||
|
||||
// Find the index of the first colon.
|
||||
const firstColonIndex = line.indexOf(':');
|
||||
if (firstColonIndex === -1) {
|
||||
// Malformed line: Does not contain any colon. Skip.
|
||||
continue;
|
||||
}
|
||||
|
||||
// Find the index of the second colon, searching *after* the first one.
|
||||
const secondColonIndex = line.indexOf(':', firstColonIndex + 1);
|
||||
if (secondColonIndex === -1) {
|
||||
// Malformed line: Contains only one colon (e.g., filename:content). Skip.
|
||||
// Grep output with -n should always have file:line:content.
|
||||
continue;
|
||||
}
|
||||
|
||||
// Extract parts based on the found colon indices
|
||||
const filePathRaw = line.substring(0, firstColonIndex);
|
||||
const lineNumberStr = line.substring(firstColonIndex + 1, secondColonIndex);
|
||||
// The rest of the line, starting after the second colon, is the content.
|
||||
const lineContent = line.substring(secondColonIndex + 1);
|
||||
|
||||
const lineNumber = parseInt(lineNumberStr, 10);
|
||||
|
||||
if (!isNaN(lineNumber)) {
|
||||
// Resolve the raw path relative to the base path where grep ran
|
||||
const absoluteFilePath = path.resolve(basePath, filePathRaw);
|
||||
// Make the final path relative to the basePath for consistency
|
||||
const relativeFilePath = path.relative(basePath, absoluteFilePath);
|
||||
|
||||
results.push({
|
||||
// Use relative path, or just the filename if it's in the base path itself
|
||||
filePath: relativeFilePath || path.basename(absoluteFilePath),
|
||||
lineNumber: lineNumber,
|
||||
line: lineContent, // Use the full extracted line content
|
||||
});
|
||||
}
|
||||
// Silently ignore lines where the line number isn't parsable
|
||||
}
|
||||
return results;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a description of the grep operation
|
||||
* @param params Parameters for the grep operation
|
||||
* @returns A string describing the grep
|
||||
*/
|
||||
getDescription(params: GrepToolParams): string {
|
||||
let description = `'${params.pattern}'`;
|
||||
|
||||
if (params.include) {
|
||||
description += ` in ${params.include}`;
|
||||
}
|
||||
|
||||
if (params.path) {
|
||||
const searchDir = params.path || this.rootDirectory;
|
||||
const relativePath = makeRelative(searchDir, this.rootDirectory);
|
||||
description += ` within ${shortenPath(relativePath || './')}`;
|
||||
}
|
||||
|
||||
return description;
|
||||
}
|
||||
|
||||
/**
|
||||
* Performs the actual search using the prioritized strategies.
|
||||
* @param options Search options including pattern, absolute path, and include glob.
|
||||
* @returns A promise resolving to an array of match objects.
|
||||
*/
|
||||
private async performGrepSearch(options: {
|
||||
pattern: string;
|
||||
path: string; // Expects absolute path
|
||||
include?: string;
|
||||
}): Promise<GrepMatch[]> {
|
||||
const { pattern, path: absolutePath, include } = options;
|
||||
let strategyUsed = 'none'; // Keep track for potential error reporting
|
||||
|
||||
try {
|
||||
// --- Strategy 1: git grep ---
|
||||
const isGit = await this.isGitRepository(absolutePath);
|
||||
const gitAvailable = isGit && await this.isCommandAvailable('git');
|
||||
|
||||
if (gitAvailable) {
|
||||
strategyUsed = 'git grep';
|
||||
const gitArgs = ['grep', '--untracked', '-n', '-E', '--ignore-case', pattern];
|
||||
if (include) {
|
||||
gitArgs.push('--', include);
|
||||
}
|
||||
|
||||
try {
|
||||
const output = await new Promise<string>((resolve, reject) => {
|
||||
const child = spawn('git', gitArgs, { cwd: absolutePath, windowsHide: true });
|
||||
const stdoutChunks: Buffer[] = [];
|
||||
const stderrChunks: Buffer[] = [];
|
||||
|
||||
child.stdout.on('data', (chunk) => { stdoutChunks.push(chunk); });
|
||||
child.stderr.on('data', (chunk) => { stderrChunks.push(chunk); });
|
||||
|
||||
child.on('error', (err) => reject(new Error(`Failed to start git grep: ${err.message}`)));
|
||||
|
||||
child.on('close', (code) => {
|
||||
const stdoutData = Buffer.concat(stdoutChunks).toString('utf8');
|
||||
const stderrData = Buffer.concat(stderrChunks).toString('utf8');
|
||||
if (code === 0) resolve(stdoutData);
|
||||
else if (code === 1) resolve(''); // No matches is not an error
|
||||
else reject(new Error(`git grep exited with code ${code}: ${stderrData}`));
|
||||
});
|
||||
});
|
||||
return this.parseGrepOutput(output, absolutePath);
|
||||
} catch (gitError: any) {
|
||||
console.error(`GrepTool: git grep strategy failed: ${gitError.message}. Falling back...`);
|
||||
}
|
||||
}
|
||||
|
||||
// --- Strategy 2: System grep ---
|
||||
const grepAvailable = await this.isCommandAvailable('grep');
|
||||
if (grepAvailable) {
|
||||
strategyUsed = 'system grep';
|
||||
const grepArgs = ['-r', '-n', '-H', '-E'];
|
||||
const commonExcludes = ['.git', 'node_modules', 'bower_components'];
|
||||
commonExcludes.forEach(dir => grepArgs.push(`--exclude-dir=${dir}`));
|
||||
if (include) {
|
||||
grepArgs.push(`--include=${include}`);
|
||||
}
|
||||
grepArgs.push(pattern);
|
||||
grepArgs.push('.');
|
||||
|
||||
try {
|
||||
const output = await new Promise<string>((resolve, reject) => {
|
||||
const child = spawn('grep', grepArgs, { cwd: absolutePath, windowsHide: true });
|
||||
const stdoutChunks: Buffer[] = [];
|
||||
const stderrChunks: Buffer[] = [];
|
||||
|
||||
child.stdout.on('data', (chunk) => { stdoutChunks.push(chunk); });
|
||||
child.stderr.on('data', (chunk) => {
|
||||
const stderrStr = chunk.toString();
|
||||
if (!stderrStr.includes('Permission denied') && !/grep:.*: Is a directory/i.test(stderrStr)) {
|
||||
stderrChunks.push(chunk);
|
||||
}
|
||||
});
|
||||
|
||||
child.on('error', (err) => reject(new Error(`Failed to start system grep: ${err.message}`)));
|
||||
|
||||
child.on('close', (code) => {
|
||||
const stdoutData = Buffer.concat(stdoutChunks).toString('utf8');
|
||||
const stderrData = Buffer.concat(stderrChunks).toString('utf8').trim();
|
||||
if (code === 0) resolve(stdoutData);
|
||||
else if (code === 1) resolve(''); // No matches
|
||||
else {
|
||||
if (stderrData) reject(new Error(`System grep exited with code ${code}: ${stderrData}`));
|
||||
else resolve('');
|
||||
}
|
||||
});
|
||||
});
|
||||
return this.parseGrepOutput(output, absolutePath);
|
||||
} catch (grepError: any) {
|
||||
console.error(`GrepTool: System grep strategy failed: ${grepError.message}. Falling back...`);
|
||||
}
|
||||
}
|
||||
|
||||
// --- Strategy 3: Pure JavaScript Fallback ---
|
||||
strategyUsed = 'javascript fallback';
|
||||
const globPattern = include ? include : '**/*';
|
||||
const ignorePatterns = ['.git', 'node_modules', 'bower_components', '.svn', '.hg'];
|
||||
|
||||
const filesStream = fastGlob.stream(globPattern, {
|
||||
cwd: absolutePath,
|
||||
dot: true,
|
||||
ignore: ignorePatterns,
|
||||
absolute: true,
|
||||
onlyFiles: true,
|
||||
suppressErrors: true,
|
||||
stats: false,
|
||||
});
|
||||
|
||||
const regex = new RegExp(pattern, 'i');
|
||||
const allMatches: GrepMatch[] = [];
|
||||
|
||||
for await (const filePath of filesStream) {
|
||||
const fileAbsolutePath = filePath as string;
|
||||
try {
|
||||
const content = await fsPromises.readFile(fileAbsolutePath, 'utf8');
|
||||
const lines = content.split(/\r?\n/);
|
||||
lines.forEach((line, index) => {
|
||||
if (regex.test(line)) {
|
||||
allMatches.push({
|
||||
filePath: path.relative(absolutePath, fileAbsolutePath) || path.basename(fileAbsolutePath),
|
||||
lineNumber: index + 1,
|
||||
line: line,
|
||||
});
|
||||
}
|
||||
});
|
||||
} catch (readError: any) {
|
||||
if (readError.code !== 'ENOENT') {
|
||||
console.error(`GrepTool: Could not read or process file ${fileAbsolutePath}: ${readError.message}`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return allMatches;
|
||||
|
||||
} catch (error: any) {
|
||||
console.error(`GrepTool: Error during performGrepSearch (Strategy: ${strategyUsed}): ${error.message}`);
|
||||
throw error; // Re-throw to be caught by the execute method's handler
|
||||
}
|
||||
}
|
||||
}
|
||||
306
packages/cli/src/tools/ls.tool.ts
Normal file
306
packages/cli/src/tools/ls.tool.ts
Normal file
@@ -0,0 +1,306 @@
|
||||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
import { BaseTool } from './BaseTool.js';
|
||||
import { SchemaValidator } from '../utils/schemaValidator.js';
|
||||
import { ToolResult } from './ToolResult.js';
|
||||
import { makeRelative, shortenPath } from '../utils/paths.js';
|
||||
|
||||
/**
|
||||
* Parameters for the LS tool
|
||||
*/
|
||||
export interface LSToolParams {
|
||||
/**
|
||||
* The absolute path to the directory to list
|
||||
*/
|
||||
path: string;
|
||||
|
||||
/**
|
||||
* List of glob patterns to ignore
|
||||
*/
|
||||
ignore?: string[];
|
||||
}
|
||||
|
||||
/**
|
||||
* File entry returned by LS tool
|
||||
*/
|
||||
export interface FileEntry {
|
||||
/**
|
||||
* Name of the file or directory
|
||||
*/
|
||||
name: string;
|
||||
|
||||
/**
|
||||
* Absolute path to the file or directory
|
||||
*/
|
||||
path: string;
|
||||
|
||||
/**
|
||||
* Whether this entry is a directory
|
||||
*/
|
||||
isDirectory: boolean;
|
||||
|
||||
/**
|
||||
* Size of the file in bytes (0 for directories)
|
||||
*/
|
||||
size: number;
|
||||
|
||||
/**
|
||||
* Last modified timestamp
|
||||
*/
|
||||
modifiedTime: Date;
|
||||
}
|
||||
|
||||
/**
|
||||
* Result from the LS tool
|
||||
*/
|
||||
export interface LSToolResult extends ToolResult {
|
||||
/**
|
||||
* List of file entries
|
||||
*/
|
||||
entries: FileEntry[];
|
||||
|
||||
/**
|
||||
* The directory that was listed
|
||||
*/
|
||||
listedPath: string;
|
||||
|
||||
/**
|
||||
* Total number of entries found
|
||||
*/
|
||||
totalEntries: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of the LS tool that lists directory contents
|
||||
*/
|
||||
export class LSTool extends BaseTool<LSToolParams, LSToolResult> {
|
||||
/**
|
||||
* The root directory that this tool is grounded in.
|
||||
* All path operations will be restricted to this directory.
|
||||
*/
|
||||
private rootDirectory: string;
|
||||
|
||||
/**
|
||||
* Creates a new instance of the LSTool
|
||||
* @param rootDirectory Root directory to ground this tool in. All operations will be restricted to this directory.
|
||||
*/
|
||||
constructor(rootDirectory: string) {
|
||||
super(
|
||||
'list_directory',
|
||||
'ReadFolder',
|
||||
'Lists the names of files and subdirectories directly within a specified directory path. Can optionally ignore entries matching provided glob patterns.',
|
||||
{
|
||||
properties: {
|
||||
path: {
|
||||
description: 'The absolute path to the directory to list (must be absolute, not relative)',
|
||||
type: 'string'
|
||||
},
|
||||
ignore: {
|
||||
description: 'List of glob patterns to ignore',
|
||||
items: {
|
||||
type: 'string'
|
||||
},
|
||||
type: 'array'
|
||||
}
|
||||
},
|
||||
required: ['path'],
|
||||
type: 'object'
|
||||
}
|
||||
);
|
||||
|
||||
// Set the root directory
|
||||
this.rootDirectory = path.resolve(rootDirectory);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a path is within the root directory
|
||||
* @param pathToCheck The path to check
|
||||
* @returns True if the path is within the root directory, false otherwise
|
||||
*/
|
||||
private isWithinRoot(pathToCheck: string): boolean {
|
||||
const normalizedPath = path.normalize(pathToCheck);
|
||||
const normalizedRoot = path.normalize(this.rootDirectory);
|
||||
|
||||
// Ensure the normalizedRoot ends with a path separator for proper path comparison
|
||||
const rootWithSep = normalizedRoot.endsWith(path.sep)
|
||||
? normalizedRoot
|
||||
: normalizedRoot + path.sep;
|
||||
|
||||
return normalizedPath === normalizedRoot || normalizedPath.startsWith(rootWithSep);
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates the parameters for the tool
|
||||
* @param params Parameters to validate
|
||||
* @returns An error message string if invalid, null otherwise
|
||||
*/
|
||||
invalidParams(params: LSToolParams): string | null {
|
||||
if (this.schema.parameters && !SchemaValidator.validate(this.schema.parameters as Record<string, unknown>, params)) {
|
||||
return "Parameters failed schema validation.";
|
||||
}
|
||||
|
||||
// Ensure path is absolute
|
||||
if (!path.isAbsolute(params.path)) {
|
||||
return `Path must be absolute: ${params.path}`;
|
||||
}
|
||||
|
||||
// Ensure path is within the root directory
|
||||
if (!this.isWithinRoot(params.path)) {
|
||||
return `Path must be within the root directory (${this.rootDirectory}): ${params.path}`;
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a filename matches any of the ignore patterns
|
||||
* @param filename Filename to check
|
||||
* @param patterns Array of glob patterns to check against
|
||||
* @returns True if the filename should be ignored
|
||||
*/
|
||||
private shouldIgnore(filename: string, patterns?: string[]): boolean {
|
||||
if (!patterns || patterns.length === 0) {
|
||||
return false;
|
||||
}
|
||||
|
||||
for (const pattern of patterns) {
|
||||
// Convert glob pattern to RegExp
|
||||
const regexPattern = pattern
|
||||
.replace(/[.+^${}()|[\]\\]/g, '\\$&')
|
||||
.replace(/\*/g, '.*')
|
||||
.replace(/\?/g, '.');
|
||||
|
||||
const regex = new RegExp(`^${regexPattern}$`);
|
||||
|
||||
if (regex.test(filename)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a description of the file reading operation
|
||||
* @param params Parameters for the file reading
|
||||
* @returns A string describing the file being read
|
||||
*/
|
||||
getDescription(params: LSToolParams): string {
|
||||
const relativePath = makeRelative(params.path, this.rootDirectory);
|
||||
return shortenPath(relativePath);
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes the LS operation with the given parameters
|
||||
* @param params Parameters for the LS operation
|
||||
* @returns Result of the LS operation
|
||||
*/
|
||||
async execute(params: LSToolParams): Promise<LSToolResult> {
|
||||
const validationError = this.invalidParams(params);
|
||||
if (validationError) {
|
||||
return {
|
||||
entries: [],
|
||||
listedPath: params.path,
|
||||
totalEntries: 0,
|
||||
llmContent: `Error: Invalid parameters provided. Reason: ${validationError}`,
|
||||
returnDisplay: "**Error:** Failed to execute tool."
|
||||
};
|
||||
}
|
||||
|
||||
try {
|
||||
// Check if path exists
|
||||
if (!fs.existsSync(params.path)) {
|
||||
return {
|
||||
entries: [],
|
||||
listedPath: params.path,
|
||||
totalEntries: 0,
|
||||
llmContent: `Directory does not exist: ${params.path}`,
|
||||
returnDisplay: `Directory does not exist`
|
||||
};
|
||||
}
|
||||
|
||||
// Check if path is a directory
|
||||
const stats = fs.statSync(params.path);
|
||||
if (!stats.isDirectory()) {
|
||||
return {
|
||||
entries: [],
|
||||
listedPath: params.path,
|
||||
totalEntries: 0,
|
||||
llmContent: `Path is not a directory: ${params.path}`,
|
||||
returnDisplay: `Path is not a directory`
|
||||
};
|
||||
}
|
||||
|
||||
// Read directory contents
|
||||
const files = fs.readdirSync(params.path);
|
||||
const entries: FileEntry[] = [];
|
||||
|
||||
if (files.length === 0) {
|
||||
return {
|
||||
entries: [],
|
||||
listedPath: params.path,
|
||||
totalEntries: 0,
|
||||
llmContent: `Directory is empty: ${params.path}`,
|
||||
returnDisplay: `Directory is empty.`
|
||||
};
|
||||
}
|
||||
|
||||
// Process each entry
|
||||
for (const file of files) {
|
||||
// Skip if the file matches ignore patterns
|
||||
if (this.shouldIgnore(file, params.ignore)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const fullPath = path.join(params.path, file);
|
||||
|
||||
try {
|
||||
const stats = fs.statSync(fullPath);
|
||||
const isDir = stats.isDirectory();
|
||||
|
||||
entries.push({
|
||||
name: file,
|
||||
path: fullPath,
|
||||
isDirectory: isDir,
|
||||
size: isDir ? 0 : stats.size,
|
||||
modifiedTime: stats.mtime
|
||||
});
|
||||
} catch (error) {
|
||||
// Skip entries that can't be accessed
|
||||
console.error(`Error accessing ${fullPath}: ${error}`);
|
||||
}
|
||||
}
|
||||
|
||||
// Sort entries (directories first, then alphabetically)
|
||||
entries.sort((a, b) => {
|
||||
if (a.isDirectory && !b.isDirectory) return -1;
|
||||
if (!a.isDirectory && b.isDirectory) return 1;
|
||||
return a.name.localeCompare(b.name);
|
||||
});
|
||||
|
||||
// Create formatted content for display
|
||||
const directoryContent = entries.map(entry => {
|
||||
const typeIndicator = entry.isDirectory ? 'd' : '-';
|
||||
const sizeInfo = entry.isDirectory ? '' : ` (${entry.size} bytes)`;
|
||||
return `${typeIndicator} ${entry.name}${sizeInfo}`;
|
||||
}).join('\n');
|
||||
|
||||
return {
|
||||
entries,
|
||||
listedPath: params.path,
|
||||
totalEntries: entries.length,
|
||||
llmContent: `Directory listing for ${params.path}:\n${directoryContent}`,
|
||||
returnDisplay: `Found ${entries.length} item(s).`
|
||||
};
|
||||
} catch (error) {
|
||||
const errorMessage = `Error listing directory: ${error instanceof Error ? error.message : String(error)}`;
|
||||
return {
|
||||
entries: [],
|
||||
listedPath: params.path,
|
||||
totalEntries: 0,
|
||||
llmContent: errorMessage,
|
||||
returnDisplay: `**Error:** ${errorMessage}`
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
296
packages/cli/src/tools/read-file.tool.ts
Normal file
296
packages/cli/src/tools/read-file.tool.ts
Normal file
@@ -0,0 +1,296 @@
|
||||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
import { ToolResult } from './ToolResult.js';
|
||||
import { BaseTool } from './BaseTool.js';
|
||||
import { SchemaValidator } from '../utils/schemaValidator.js';
|
||||
import { makeRelative, shortenPath } from '../utils/paths.js';
|
||||
|
||||
/**
|
||||
* Parameters for the ReadFile tool
|
||||
*/
|
||||
export interface ReadFileToolParams {
|
||||
/**
|
||||
* The absolute path to the file to read
|
||||
*/
|
||||
file_path: string;
|
||||
|
||||
/**
|
||||
* The line number to start reading from (optional)
|
||||
*/
|
||||
offset?: number;
|
||||
|
||||
/**
|
||||
* The number of lines to read (optional)
|
||||
*/
|
||||
limit?: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Standardized result from the ReadFile tool
|
||||
*/
|
||||
export interface ReadFileToolResult extends ToolResult {
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of the ReadFile tool that reads files from the filesystem
|
||||
*/
|
||||
export class ReadFileTool extends BaseTool<ReadFileToolParams, ReadFileToolResult> {
|
||||
public static readonly Name: string = 'read_file';
|
||||
|
||||
// Maximum number of lines to read by default
|
||||
private static readonly DEFAULT_MAX_LINES = 2000;
|
||||
|
||||
// Maximum length of a line before truncating
|
||||
private static readonly MAX_LINE_LENGTH = 2000;
|
||||
|
||||
/**
|
||||
* The root directory that this tool is grounded in.
|
||||
* All file operations will be restricted to this directory.
|
||||
*/
|
||||
private rootDirectory: string;
|
||||
|
||||
/**
|
||||
* Creates a new instance of the ReadFileTool
|
||||
* @param rootDirectory Root directory to ground this tool in. All operations will be restricted to this directory.
|
||||
*/
|
||||
constructor(rootDirectory: string) {
|
||||
super(
|
||||
ReadFileTool.Name,
|
||||
'ReadFile',
|
||||
'Reads and returns the content of a specified file from the local filesystem. Handles large files by allowing reading specific line ranges.',
|
||||
{
|
||||
properties: {
|
||||
file_path: {
|
||||
description: 'The absolute path to the file to read (e.g., \'/home/user/project/file.txt\'). Relative paths are not supported.',
|
||||
type: 'string'
|
||||
},
|
||||
offset: {
|
||||
description: 'Optional: The 0-based line number to start reading from. Requires \'limit\' to be set. Use for paginating through large files.',
|
||||
type: 'number'
|
||||
},
|
||||
limit: {
|
||||
description: 'Optional: Maximum number of lines to read. Use with \'offset\' to paginate through large files. If omitted, reads the entire file (if feasible).',
|
||||
type: 'number'
|
||||
}
|
||||
},
|
||||
required: ['file_path'],
|
||||
type: 'object'
|
||||
}
|
||||
);
|
||||
|
||||
// Set the root directory
|
||||
this.rootDirectory = path.resolve(rootDirectory);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a path is within the root directory
|
||||
* @param pathToCheck The path to check
|
||||
* @returns True if the path is within the root directory, false otherwise
|
||||
*/
|
||||
private isWithinRoot(pathToCheck: string): boolean {
|
||||
const normalizedPath = path.normalize(pathToCheck);
|
||||
const normalizedRoot = path.normalize(this.rootDirectory);
|
||||
|
||||
// Ensure the normalizedRoot ends with a path separator for proper path comparison
|
||||
const rootWithSep = normalizedRoot.endsWith(path.sep)
|
||||
? normalizedRoot
|
||||
: normalizedRoot + path.sep;
|
||||
|
||||
return normalizedPath === normalizedRoot || normalizedPath.startsWith(rootWithSep);
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates the parameters for the ReadFile tool
|
||||
* @param params Parameters to validate
|
||||
* @returns True if parameters are valid, false otherwise
|
||||
*/
|
||||
invalidParams(params: ReadFileToolParams): string | null {
|
||||
if (this.schema.parameters && !SchemaValidator.validate(this.schema.parameters as Record<string, unknown>, params)) {
|
||||
return "Parameters failed schema validation.";
|
||||
}
|
||||
|
||||
// Ensure path is absolute
|
||||
if (!path.isAbsolute(params.file_path)) {
|
||||
return `File path must be absolute: ${params.file_path}`;
|
||||
}
|
||||
|
||||
// Ensure path is within the root directory
|
||||
if (!this.isWithinRoot(params.file_path)) {
|
||||
return `File path must be within the root directory (${this.rootDirectory}): ${params.file_path}`;
|
||||
}
|
||||
|
||||
// Validate offset and limit if provided
|
||||
if (params.offset !== undefined && params.offset < 0) {
|
||||
return 'Offset must be a non-negative number';
|
||||
}
|
||||
|
||||
if (params.limit !== undefined && params.limit <= 0) {
|
||||
return 'Limit must be a positive number';
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Determines if a file is likely binary based on content sampling
|
||||
* @param filePath Path to the file
|
||||
* @returns True if the file appears to be binary
|
||||
*/
|
||||
private isBinaryFile(filePath: string): boolean {
|
||||
try {
|
||||
// Read the first 4KB of the file
|
||||
const fd = fs.openSync(filePath, 'r');
|
||||
const buffer = Buffer.alloc(4096);
|
||||
const bytesRead = fs.readSync(fd, buffer, 0, 4096, 0);
|
||||
fs.closeSync(fd);
|
||||
|
||||
// Check for null bytes or high concentration of non-printable characters
|
||||
let nonPrintableCount = 0;
|
||||
for (let i = 0; i < bytesRead; i++) {
|
||||
// Null byte is a strong indicator of binary data
|
||||
if (buffer[i] === 0) {
|
||||
return true;
|
||||
}
|
||||
|
||||
// Count non-printable characters
|
||||
if (buffer[i] < 9 || (buffer[i] > 13 && buffer[i] < 32)) {
|
||||
nonPrintableCount++;
|
||||
}
|
||||
}
|
||||
|
||||
// If more than 30% are non-printable, likely binary
|
||||
return (nonPrintableCount / bytesRead) > 0.3;
|
||||
} catch (error) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Detects the type of file based on extension and content
|
||||
* @param filePath Path to the file
|
||||
* @returns File type description
|
||||
*/
|
||||
private detectFileType(filePath: string): string {
|
||||
const ext = path.extname(filePath).toLowerCase();
|
||||
|
||||
// Common image formats
|
||||
if (['.jpg', '.jpeg', '.png', '.gif', '.bmp', '.webp', '.svg'].includes(ext)) {
|
||||
return 'image';
|
||||
}
|
||||
|
||||
// Other known binary formats
|
||||
if (['.pdf', '.zip', '.tar', '.gz', '.exe', '.dll', '.so'].includes(ext)) {
|
||||
return 'binary';
|
||||
}
|
||||
|
||||
// Check content for binary indicators
|
||||
if (this.isBinaryFile(filePath)) {
|
||||
return 'binary';
|
||||
}
|
||||
|
||||
return 'text';
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a description of the file reading operation
|
||||
* @param params Parameters for the file reading
|
||||
* @returns A string describing the file being read
|
||||
*/
|
||||
getDescription(params: ReadFileToolParams): string {
|
||||
const relativePath = makeRelative(params.file_path, this.rootDirectory);
|
||||
return shortenPath(relativePath);
|
||||
}
|
||||
|
||||
/**
|
||||
* Reads a file and returns its contents with line numbers
|
||||
* @param params Parameters for the file reading
|
||||
* @returns Result with file contents
|
||||
*/
|
||||
async execute(params: ReadFileToolParams): Promise<ReadFileToolResult> {
|
||||
const validationError = this.invalidParams(params);
|
||||
if (validationError) {
|
||||
return {
|
||||
llmContent: `Error: Invalid parameters provided. Reason: ${validationError}`,
|
||||
returnDisplay: "**Error:** Failed to execute tool."
|
||||
};
|
||||
}
|
||||
|
||||
try {
|
||||
// Check if file exists
|
||||
if (!fs.existsSync(params.file_path)) {
|
||||
return {
|
||||
llmContent: `File not found: ${params.file_path}`,
|
||||
returnDisplay: `File not found.`,
|
||||
};
|
||||
}
|
||||
|
||||
// Check if it's a directory
|
||||
const stats = fs.statSync(params.file_path);
|
||||
if (stats.isDirectory()) {
|
||||
return {
|
||||
llmContent: `Path is a directory, not a file: ${params.file_path}`,
|
||||
returnDisplay: `File is directory.`,
|
||||
};
|
||||
}
|
||||
|
||||
// Detect file type
|
||||
const fileType = this.detectFileType(params.file_path);
|
||||
|
||||
// Handle binary files differently
|
||||
if (fileType !== 'text') {
|
||||
return {
|
||||
llmContent: `Binary file: ${params.file_path} (${fileType})`,
|
||||
returnDisplay: ``,
|
||||
};
|
||||
}
|
||||
|
||||
// Read and process text file
|
||||
const content = fs.readFileSync(params.file_path, 'utf8');
|
||||
const lines = content.split('\n');
|
||||
|
||||
// Apply offset and limit
|
||||
const startLine = params.offset || 0;
|
||||
// Use the default max lines if no limit is provided
|
||||
const endLine = params.limit
|
||||
? startLine + params.limit
|
||||
: Math.min(startLine + ReadFileTool.DEFAULT_MAX_LINES, lines.length);
|
||||
const selectedLines = lines.slice(startLine, endLine);
|
||||
|
||||
// Format with line numbers and handle line truncation
|
||||
let truncated = false;
|
||||
const formattedLines = selectedLines.map((line) => {
|
||||
// Calculate actual line number (1-based)
|
||||
// Truncate long lines
|
||||
let processedLine = line;
|
||||
if (line.length > ReadFileTool.MAX_LINE_LENGTH) {
|
||||
processedLine = line.substring(0, ReadFileTool.MAX_LINE_LENGTH) + '... [truncated]';
|
||||
truncated = true;
|
||||
}
|
||||
|
||||
return processedLine;
|
||||
});
|
||||
|
||||
// Check if content was truncated due to line limit or max lines limit
|
||||
const contentTruncated = (endLine < lines.length) || truncated;
|
||||
|
||||
// Create llmContent with truncation info if needed
|
||||
let llmContent = '';
|
||||
if (contentTruncated) {
|
||||
llmContent += `[File truncated: showing lines ${startLine + 1}-${endLine} of ${lines.length} total lines. Use offset parameter to view more.]\n`;
|
||||
}
|
||||
llmContent += formattedLines.join('\n');
|
||||
|
||||
return {
|
||||
llmContent,
|
||||
returnDisplay: '',
|
||||
};
|
||||
} catch (error) {
|
||||
const errorMsg = `Error reading file: ${error instanceof Error ? error.message : String(error)}`;
|
||||
|
||||
return {
|
||||
llmContent: `Error reading file ${params.file_path}: ${errorMsg}`,
|
||||
returnDisplay: `Failed to read file: ${errorMsg}`,
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
960
packages/cli/src/tools/terminal.tool.ts
Normal file
960
packages/cli/src/tools/terminal.tool.ts
Normal file
@@ -0,0 +1,960 @@
|
||||
import { spawn, SpawnOptions, ChildProcessWithoutNullStreams, exec } from 'child_process'; // Added 'exec'
|
||||
import path from 'path';
|
||||
import os from 'os';
|
||||
import crypto from 'crypto';
|
||||
import { promises as fs } from 'fs'; // Added fs.promises
|
||||
import { BaseTool } from './BaseTool.js'; // Adjust path as needed
|
||||
import { ToolResult } from './ToolResult.js'; // Adjust path as needed
|
||||
import { SchemaValidator } from '../utils/schemaValidator.js'; // Adjust path as needed
|
||||
import { ToolCallConfirmationDetails, ToolConfirmationOutcome, ToolExecuteConfirmationDetails } from '../ui/types.js'; // Adjust path as needed
|
||||
import { GeminiClient } from '../core/GeminiClient.js';
|
||||
import { SchemaUnion, Type } from '@google/genai';
|
||||
import { BackgroundTerminalAnalyzer } from '../utils/BackgroundTerminalAnalyzer.js';
|
||||
|
||||
// --- Interfaces ---
|
||||
export interface TerminalToolParams {
|
||||
command: string;
|
||||
description?: string;
|
||||
timeout?: number;
|
||||
runInBackground?: boolean;
|
||||
}
|
||||
|
||||
export interface TerminalToolResult extends ToolResult {
|
||||
// Add specific fields if needed for structured output from polling/LLM
|
||||
// finalStdout?: string;
|
||||
// finalStderr?: string;
|
||||
// llmAnalysis?: string;
|
||||
}
|
||||
|
||||
// --- Constants ---
|
||||
const MAX_OUTPUT_LENGTH = 10000; // Default max output length
|
||||
const DEFAULT_TIMEOUT_MS = 30 * 60 * 1000; // 30 minutes (for foreground commands)
|
||||
const MAX_TIMEOUT_OVERRIDE_MS = 10 * 60 * 1000; // 10 minutes (max override for foreground)
|
||||
const BACKGROUND_LAUNCH_TIMEOUT_MS = 15 * 1000; // 15 seconds timeout for *launching* background tasks
|
||||
const BACKGROUND_POLL_INTERVAL_MS = 5000; // 5 seconds interval for checking background process status
|
||||
const BACKGROUND_POLL_TIMEOUT_MS = 30000; // 30 seconds total polling time for background process status
|
||||
|
||||
const BANNED_COMMAND_ROOTS = [
|
||||
// Session/flow control (excluding cd)
|
||||
'alias', 'bg', 'command', 'declare', 'dirs', 'disown', 'enable', 'eval', 'exec',
|
||||
'exit', 'export', 'fc', 'fg', 'getopts', 'hash', 'history', 'jobs', 'kill', 'let',
|
||||
'local', 'logout', 'popd', 'printf', 'pushd', /* 'pwd' is safe */ 'read', 'readonly', 'set',
|
||||
'shift', 'shopt', 'source', 'suspend', 'test', 'times', 'trap', 'type', 'typeset',
|
||||
'ulimit', 'umask', 'unalias', 'unset', 'wait',
|
||||
// Network commands
|
||||
'curl', 'wget', 'nc', 'telnet', 'ssh', 'scp', 'ftp', 'sftp',
|
||||
'http', 'https', 'ftp', 'rsync',
|
||||
// Browsers/GUI launchers
|
||||
'lynx', 'w3m', 'links', 'elinks', 'httpie', 'xh', 'http-prompt',
|
||||
'chrome', 'firefox', 'safari', 'edge', 'xdg-open', 'open'
|
||||
];
|
||||
|
||||
|
||||
// --- Helper Type for Command Queue ---
|
||||
interface QueuedCommand {
|
||||
params: TerminalToolParams;
|
||||
resolve: (result: TerminalToolResult) => void;
|
||||
reject: (error: Error) => void;
|
||||
confirmationDetails: ToolExecuteConfirmationDetails | false; // Kept for potential future use
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of the terminal tool that executes shell commands within a persistent session.
|
||||
*/
|
||||
export class TerminalTool extends BaseTool<TerminalToolParams, TerminalToolResult> {
|
||||
public static Name: string = 'execute_bash_command';
|
||||
|
||||
private readonly rootDirectory: string;
|
||||
private readonly outputLimit: number;
|
||||
private bashProcess: ChildProcessWithoutNullStreams | null = null;
|
||||
private currentCwd: string;
|
||||
private isExecuting: boolean = false;
|
||||
private commandQueue: QueuedCommand[] = [];
|
||||
private currentCommandCleanup: (() => void) | null = null;
|
||||
private shouldAlwaysExecuteCommands: Map<string, boolean> = new Map(); // Track confirmation per root command
|
||||
private shellReady: Promise<void>;
|
||||
private resolveShellReady: (() => void) | undefined; // Definite assignment assertion
|
||||
private rejectShellReady: ((reason?: any) => void) | undefined; // Definite assignment assertion
|
||||
private readonly backgroundTerminalAnalyzer: BackgroundTerminalAnalyzer;
|
||||
|
||||
|
||||
constructor(rootDirectory: string, outputLimit: number = MAX_OUTPUT_LENGTH) {
|
||||
const toolDisplayName = 'Terminal';
|
||||
// --- LLM-Facing Description ---
|
||||
// Updated description for background tasks to mention polling and LLM analysis
|
||||
const toolDescription = `Executes one or more bash commands sequentially in a secure and persistent interactive shell session. Can run commands in the foreground (waiting for completion) or background (returning after launch, with subsequent status polling).
|
||||
|
||||
Core Functionality:
|
||||
* Starts in project root: '${path.basename(rootDirectory)}'. Current Directory starts as: ${rootDirectory} (will update based on 'cd' commands).
|
||||
* Persistent State: Environment variables and the current working directory (\`pwd\`) persist between calls to this tool.
|
||||
* **Execution Modes:**
|
||||
* **Foreground (default):** Waits for the command to complete. Captures stdout, stderr, and exit code. Output is truncated if it exceeds ${outputLimit} characters.
|
||||
* **Background (\`runInBackground: true\`):** Appends \`&\` to the command and redirects its output to temporary files. Returns *after* the command is launched, providing the Process ID (PID) and launch status. Subsequently, the tool **polls** for the background process status for up to ${BACKGROUND_POLL_TIMEOUT_MS / 1000} seconds. Once the process finishes or polling times out, the tool reads the captured stdout/stderr from the temporary files, runs an internal LLM analysis on the output, cleans up the files, and returns the final status, captured output, and analysis.
|
||||
* Timeout: Optional timeout per 'execute' call (default: ${DEFAULT_TIMEOUT_MS / 60000} min, max override: ${MAX_TIMEOUT_OVERRIDE_MS / 60000} min for foreground). Background *launch* has a fixed shorter timeout (${BACKGROUND_LAUNCH_TIMEOUT_MS / 1000}s) for the launch attempt itself. Background *polling* has its own timeout (${BACKGROUND_POLL_TIMEOUT_MS / 1000}s). Timeout attempts SIGINT for foreground commands.
|
||||
|
||||
Usage Guidance & Restrictions:
|
||||
|
||||
1. **Directory/File Verification (IMPORTANT):**
|
||||
* BEFORE executing commands that create files or directories (e.g., \`mkdir foo/bar\`, \`touch new/file.txt\`, \`git clone ...\`), use the dedicated File System tool (e.g., 'list_directory') to verify the target parent directory exists and is the correct location.
|
||||
* Example: Before running \`mkdir foo/bar\`, first use the File System tool to check that \`foo\` exists in the current directory (\`${rootDirectory}\` initially, check current CWD if it changed).
|
||||
|
||||
2. **Use Specialized Tools (CRITICAL):**
|
||||
* Do NOT use this tool for filesystem searching (\`find\`, \`grep\`). Use the dedicated Search tool instead.
|
||||
* Do NOT use this tool for reading files (\`cat\`, \`head\`, \`tail\`, \`less\`, \`more\`). Use the dedicated File Reader tool instead.
|
||||
* Do NOT use this tool for listing files (\`ls\`). Use the dedicated File System tool ('list_directory') instead. Relying on this tool's output for directory structure is unreliable due to potential truncation and lack of structured data.
|
||||
|
||||
3. **Security & Banned Commands:**
|
||||
* Certain commands are banned for security (e.g., network: ${BANNED_COMMAND_ROOTS.filter(c => ['curl', 'wget', 'ssh'].includes(c)).join(', ')}; session: ${BANNED_COMMAND_ROOTS.filter(c => ['exit', 'export', 'kill'].includes(c)).join(', ')}; etc.). The full list is extensive.
|
||||
* If you attempt a banned command, this tool will return an error explaining the restriction. You MUST relay this error clearly to the user.
|
||||
|
||||
4. **Command Execution Notes:**
|
||||
* Chain multiple commands using shell operators like ';' or '&&'. Do NOT use newlines within the 'command' parameter string itself (newlines are fine inside quoted arguments).
|
||||
* The shell's current working directory is tracked internally. While \`cd\` is permitted if the user explicitly asks or it's necessary for a workflow, **strongly prefer** using absolute paths or paths relative to the *known* current working directory to avoid errors. Check the '(Executed in: ...)' part of the previous command's output for the CWD.
|
||||
* Good example (if CWD is /workspace/project): \`pytest tests/unit\` or \`ls /workspace/project/data\`
|
||||
* Less preferred: \`cd tests && pytest unit\` (only use if necessary or requested)
|
||||
|
||||
5. **Background Tasks (\`runInBackground: true\`):**
|
||||
* Use this for commands that are intended to run continuously (e.g., \`node server.js\`, \`npm start\`).
|
||||
* The tool initially returns success if the process *launches* successfully, along with its PID.
|
||||
* **Polling & Final Result:** The tool then monitors the process. The *final* result (delivered after polling completes or times out) will include:
|
||||
* The final status (completed or timed out).
|
||||
* The complete stdout and stderr captured in temporary files (truncated if necessary).
|
||||
* An LLM-generated analysis/summary of the output.
|
||||
* The initial exit code (usually 0) signifies successful *launching*; the final status indicates completion or timeout after polling.
|
||||
|
||||
Use this tool for running build steps (\`npm install\`, \`make\`), linters (\`eslint .\`), test runners (\`pytest\`, \`jest\`), code formatters (\`prettier --write .\`), package managers (\`pip install\`), version control operations (\`git status\`, \`git diff\`), starting background servers/services (\`node server.js --runInBackground true\`), or other safe, standard command-line operations within the project workspace.`;
|
||||
// --- Parameter Schema ---
|
||||
const toolParameterSchema = {
|
||||
type: 'object',
|
||||
properties: {
|
||||
command: {
|
||||
description: `The exact bash command or sequence of commands (using ';' or '&&') to execute. Must adhere to usage guidelines. Example: 'npm install && npm run build'`,
|
||||
type: 'string'
|
||||
},
|
||||
description: {
|
||||
description: `Optional: A brief, user-centric explanation of what the command does and why it's being run. Used for logging and confirmation prompts. Example: 'Install project dependencies'`,
|
||||
type: 'string'
|
||||
},
|
||||
timeout: {
|
||||
description: `Optional execution time limit in milliseconds for FOREGROUND commands. Max ${MAX_TIMEOUT_OVERRIDE_MS}ms (${MAX_TIMEOUT_OVERRIDE_MS / 60000} min). Defaults to ${DEFAULT_TIMEOUT_MS}ms (${DEFAULT_TIMEOUT_MS / 60000} min) if not specified or invalid. Ignored if 'runInBackground' is true.`,
|
||||
type: 'number'
|
||||
},
|
||||
runInBackground: {
|
||||
description: `If true, execute the command in the background using '&'. Defaults to false. Use for servers or long tasks.`,
|
||||
type: 'boolean',
|
||||
}
|
||||
},
|
||||
required: ['command']
|
||||
};
|
||||
|
||||
|
||||
super(
|
||||
TerminalTool.Name,
|
||||
toolDisplayName,
|
||||
toolDescription,
|
||||
toolParameterSchema
|
||||
);
|
||||
|
||||
this.rootDirectory = path.resolve(rootDirectory);
|
||||
this.currentCwd = this.rootDirectory;
|
||||
this.outputLimit = outputLimit;
|
||||
this.shellReady = new Promise((resolve, reject) => {
|
||||
this.resolveShellReady = resolve;
|
||||
this.rejectShellReady = reject;
|
||||
});
|
||||
this.backgroundTerminalAnalyzer = new BackgroundTerminalAnalyzer();
|
||||
|
||||
this.initializeShell();
|
||||
}
|
||||
|
||||
// --- Shell Initialization and Management (largely unchanged) ---
|
||||
private initializeShell() {
|
||||
if (this.bashProcess) {
|
||||
try {
|
||||
this.bashProcess.kill();
|
||||
} catch (e) { /* Ignore */ }
|
||||
}
|
||||
|
||||
const spawnOptions: SpawnOptions = {
|
||||
cwd: this.rootDirectory,
|
||||
shell: true,
|
||||
env: { ...process.env },
|
||||
stdio: ['pipe', 'pipe', 'pipe']
|
||||
};
|
||||
|
||||
try {
|
||||
const bashPath = os.platform() === 'win32' ? 'bash.exe' : 'bash';
|
||||
this.bashProcess = spawn(bashPath, ['-s'], spawnOptions) as ChildProcessWithoutNullStreams;
|
||||
this.currentCwd = this.rootDirectory; // Reset CWD on restart
|
||||
|
||||
this.bashProcess.on('error', (err) => {
|
||||
console.error('Persistent Bash Error:', err);
|
||||
this.rejectShellReady?.(err); // Use optional chaining as reject might be cleared
|
||||
this.bashProcess = null;
|
||||
this.isExecuting = false;
|
||||
this.clearQueue(new Error(`Persistent bash process failed to start: ${err.message}`));
|
||||
});
|
||||
|
||||
this.bashProcess.on('close', (code, signal) => {
|
||||
this.bashProcess = null;
|
||||
this.isExecuting = false;
|
||||
// Only reject if it hasn't been resolved/rejected already
|
||||
this.rejectShellReady?.(new Error(`Persistent bash process exited (code: ${code}, signal: ${signal})`));
|
||||
// Reset shell readiness promise for reinitialization attempts
|
||||
this.shellReady = new Promise((resolve, reject) => {
|
||||
this.resolveShellReady = resolve;
|
||||
this.rejectShellReady = reject;
|
||||
});
|
||||
this.clearQueue(new Error(`Persistent bash process exited unexpectedly (code: ${code}, signal: ${signal}). State is lost. Queued commands cancelled.`));
|
||||
// Attempt to reinitialize after a short delay
|
||||
setTimeout(() => this.initializeShell(), 1000);
|
||||
});
|
||||
|
||||
// Readiness check - ensure shell is responsive
|
||||
// Slightly longer timeout to allow shell init
|
||||
setTimeout(() => {
|
||||
if (this.bashProcess && !this.bashProcess.killed) {
|
||||
this.resolveShellReady?.(); // Use optional chaining
|
||||
} else if (!this.bashProcess) {
|
||||
// Error likely already handled by 'error' or 'close' event
|
||||
} else {
|
||||
// Process was killed during init?
|
||||
this.rejectShellReady?.(new Error("Shell killed during initialization"));
|
||||
}
|
||||
}, 1000); // Increase readiness check timeout slightly
|
||||
|
||||
} catch (error: any) {
|
||||
console.error("Failed to spawn persistent bash:", error);
|
||||
this.rejectShellReady?.(error); // Use optional chaining
|
||||
this.bashProcess = null;
|
||||
this.clearQueue(new Error(`Failed to spawn persistent bash: ${error.message}`));
|
||||
}
|
||||
}
|
||||
|
||||
// --- Parameter Validation (unchanged) ---
|
||||
invalidParams(params: TerminalToolParams): string | null {
|
||||
if (!SchemaValidator.validate(this.parameterSchema as Record<string, unknown>, params)) {
|
||||
return `Parameters failed schema validation.`;
|
||||
}
|
||||
|
||||
const commandOriginal = params.command.trim();
|
||||
if (!commandOriginal) {
|
||||
return "Command cannot be empty.";
|
||||
}
|
||||
const commandLower = commandOriginal.toLowerCase();
|
||||
const commandParts = commandOriginal.split(/[\s;&&|]+/);
|
||||
|
||||
for (const part of commandParts) {
|
||||
if (!part) continue;
|
||||
// Improved check: strip leading special chars before checking basename
|
||||
const cleanPart = part.replace(/^[^a-zA-Z0-9]+/, '').split(/[\/\\]/).pop() || part.replace(/^[^a-zA-Z0-9]+/, '');
|
||||
if (cleanPart && BANNED_COMMAND_ROOTS.includes(cleanPart.toLowerCase())) {
|
||||
return `Command contains a banned keyword: '${cleanPart}'. Banned list includes network tools, session control, etc.`;
|
||||
}
|
||||
}
|
||||
|
||||
if (params.timeout !== undefined && (typeof params.timeout !== 'number' || params.timeout <= 0)) {
|
||||
return 'Timeout must be a positive number of milliseconds.';
|
||||
}
|
||||
|
||||
// Relax the absolute path restriction slightly if needed, but generally good practice
|
||||
// const firstCommandPart = commandParts[0];
|
||||
// if (firstCommandPart && (firstCommandPart.startsWith('/') || firstCommandPart.startsWith('\\'))) {
|
||||
// return 'Executing commands via absolute paths (starting with \'/\' or \'\\\') is restricted. Use commands available in PATH or relative paths.';
|
||||
// }
|
||||
|
||||
return null; // Parameters are valid
|
||||
}
|
||||
|
||||
// --- Description and Confirmation (unchanged) ---
|
||||
getDescription(params: TerminalToolParams): string {
|
||||
return params.description || params.command;
|
||||
}
|
||||
|
||||
async shouldConfirmExecute(params: TerminalToolParams): Promise<ToolCallConfirmationDetails | false> {
|
||||
const rootCommand = params.command.trim().split(/[\s;&&|]+/)[0]?.split(/[\/\\]/).pop() || 'unknown';
|
||||
|
||||
if (this.shouldAlwaysExecuteCommands.get(rootCommand)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const description = this.getDescription(params);
|
||||
|
||||
const confirmationDetails: ToolExecuteConfirmationDetails = {
|
||||
title: 'Confirm Shell Command',
|
||||
command: params.command,
|
||||
rootCommand: rootCommand,
|
||||
description: `Execute in '${this.currentCwd}':\n${description}`,
|
||||
onConfirm: async (outcome: ToolConfirmationOutcome) => {
|
||||
if (outcome === ToolConfirmationOutcome.ProceedAlways) {
|
||||
this.shouldAlwaysExecuteCommands.set(rootCommand, true);
|
||||
}
|
||||
},
|
||||
};
|
||||
return confirmationDetails;
|
||||
}
|
||||
|
||||
// --- Command Execution and Queueing (unchanged structure) ---
|
||||
async execute(params: TerminalToolParams): Promise<TerminalToolResult> {
|
||||
const validationError = this.invalidParams(params);
|
||||
if (validationError) {
|
||||
return {
|
||||
llmContent: `Command rejected: ${params.command}\nReason: ${validationError}`,
|
||||
returnDisplay: `Error: ${validationError}`,
|
||||
};
|
||||
}
|
||||
|
||||
// Assume confirmation is handled before calling execute
|
||||
|
||||
return new Promise((resolve) => {
|
||||
const queuedItem: QueuedCommand = {
|
||||
params,
|
||||
resolve, // Resolve outer promise
|
||||
reject: (error) => resolve({ // Handle internal errors by resolving outer promise
|
||||
llmContent: `Internal tool error for command: ${params.command}\nError: ${error.message}`,
|
||||
returnDisplay: `Internal Tool Error: ${error.message}`
|
||||
}),
|
||||
confirmationDetails: false // Placeholder
|
||||
};
|
||||
this.commandQueue.push(queuedItem);
|
||||
// Ensure queue processing is triggered *after* adding the item
|
||||
setImmediate(() => this.triggerQueueProcessing());
|
||||
});
|
||||
}
|
||||
|
||||
private async triggerQueueProcessing(): Promise<void> {
|
||||
if (this.isExecuting || this.commandQueue.length === 0) {
|
||||
return;
|
||||
}
|
||||
|
||||
this.isExecuting = true;
|
||||
const { params, resolve, reject } = this.commandQueue.shift()!;
|
||||
|
||||
try {
|
||||
await this.shellReady; // Wait for the shell to be ready (or reinitialized)
|
||||
if (!this.bashProcess || this.bashProcess.killed) { // Check if killed
|
||||
throw new Error("Persistent bash process is not available or was killed.");
|
||||
}
|
||||
// **** Core execution logic call ****
|
||||
const result = await this.executeCommandInShell(params);
|
||||
resolve(result); // Resolve the specific command's promise
|
||||
} catch (error: any) {
|
||||
console.error(`Error executing command "${params.command}":`, error);
|
||||
reject(error); // Use the specific command's reject handler
|
||||
} finally {
|
||||
this.isExecuting = false;
|
||||
// Use setImmediate to avoid potential deep recursion
|
||||
setImmediate(() => this.triggerQueueProcessing());
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// --- **** MODIFIED: Core Command Execution Logic **** ---
|
||||
private executeCommandInShell(params: TerminalToolParams): Promise<TerminalToolResult> {
|
||||
// Define temp file paths here to be accessible throughout
|
||||
let tempStdoutPath: string | null = null;
|
||||
let tempStderrPath: string | null = null;
|
||||
let originalResolve: (value: TerminalToolResult | PromiseLike<TerminalToolResult>) => void; // To pass to polling
|
||||
let originalReject: (reason?: any) => void;
|
||||
|
||||
const promise = new Promise<TerminalToolResult>((resolve, reject) => {
|
||||
originalResolve = resolve; // Assign outer scope resolve
|
||||
originalReject = reject; // Assign outer scope reject
|
||||
|
||||
if (!this.bashProcess) {
|
||||
return reject(new Error("Bash process is not running. Cannot execute command."));
|
||||
}
|
||||
|
||||
const isBackgroundTask = params.runInBackground ?? false;
|
||||
const commandUUID = crypto.randomUUID();
|
||||
const startDelimiter = `::START_CMD_${commandUUID}::`;
|
||||
const endDelimiter = `::END_CMD_${commandUUID}::`;
|
||||
const exitCodeDelimiter = `::EXIT_CODE_${commandUUID}::`;
|
||||
const pidDelimiter = `::PID_${commandUUID}::`; // For background PID
|
||||
|
||||
// --- Initialize Temp Files for Background Task ---
|
||||
if (isBackgroundTask) {
|
||||
try {
|
||||
const tempDir = os.tmpdir();
|
||||
tempStdoutPath = path.join(tempDir, `term_out_${commandUUID}.log`);
|
||||
tempStderrPath = path.join(tempDir, `term_err_${commandUUID}.log`);
|
||||
} catch (err: any) {
|
||||
// If temp dir setup fails, reject immediately
|
||||
return reject(new Error(`Failed to determine temporary directory: ${err.message}`));
|
||||
}
|
||||
}
|
||||
// --- End Temp File Init ---
|
||||
|
||||
let stdoutBuffer = ''; // For launch output
|
||||
let stderrBuffer = ''; // For launch output
|
||||
let commandOutputStarted = false;
|
||||
let exitCode: number | null = null;
|
||||
let backgroundPid: number | null = null; // Store PID
|
||||
let receivedEndDelimiter = false;
|
||||
|
||||
// Timeout only applies to foreground execution or background *launch* phase
|
||||
const effectiveTimeout = isBackgroundTask
|
||||
? BACKGROUND_LAUNCH_TIMEOUT_MS
|
||||
: Math.min(
|
||||
params.timeout ?? DEFAULT_TIMEOUT_MS, // Use default timeout if not provided
|
||||
MAX_TIMEOUT_OVERRIDE_MS
|
||||
);
|
||||
|
||||
let onStdoutData: ((data: Buffer) => void) | null = null;
|
||||
let onStderrData: ((data: Buffer) => void) | null = null;
|
||||
let launchTimeoutId: NodeJS.Timeout | null = null; // Renamed for clarity
|
||||
|
||||
launchTimeoutId = setTimeout(() => {
|
||||
const timeoutMessage = isBackgroundTask
|
||||
? `Background command launch timed out after ${effectiveTimeout}ms.`
|
||||
: `Command timed out after ${effectiveTimeout}ms.`;
|
||||
|
||||
if (!isBackgroundTask && this.bashProcess && !this.bashProcess.killed) {
|
||||
try {
|
||||
this.bashProcess.stdin.write('\x03'); // Ctrl+C for foreground timeout
|
||||
} catch (e: any) { console.error("Error writing SIGINT on timeout:", e); }
|
||||
}
|
||||
// Store listeners before calling cleanup, as cleanup nullifies them
|
||||
const listenersToClean = { onStdoutData, onStderrData };
|
||||
cleanupListeners(listenersToClean); // Clean up listeners for this command
|
||||
|
||||
// Clean up temp files if background launch timed out
|
||||
if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
|
||||
this.cleanupTempFiles(tempStdoutPath, tempStderrPath).catch(err => {
|
||||
console.warn(`Error cleaning up temp files on timeout: ${err.message}`);
|
||||
});
|
||||
}
|
||||
|
||||
// Resolve the main promise with timeout info
|
||||
originalResolve({
|
||||
llmContent: `Command execution failed: ${timeoutMessage}\nCommand: ${params.command}\nExecuted in: ${this.currentCwd}\n${isBackgroundTask ? 'Mode: Background Launch' : `Mode: Foreground\nTimeout Limit: ${effectiveTimeout}ms`}\nPartial Stdout (Launch):\n${this.truncateOutput(stdoutBuffer)}\nPartial Stderr (Launch):\n${this.truncateOutput(stderrBuffer)}\nNote: ${isBackgroundTask ? 'Launch failed or took too long.' : 'Attempted interrupt (SIGINT). Shell state might be unpredictable if command ignored interrupt.'}`,
|
||||
returnDisplay: `Timeout: ${timeoutMessage}`
|
||||
});
|
||||
}, effectiveTimeout);
|
||||
|
||||
// --- Data processing logic (refined slightly) ---
|
||||
const processDataChunk = (chunk: string, isStderr: boolean): boolean => {
|
||||
let dataToProcess = chunk;
|
||||
|
||||
if (!commandOutputStarted) {
|
||||
const startIndex = dataToProcess.indexOf(startDelimiter);
|
||||
if (startIndex !== -1) {
|
||||
commandOutputStarted = true;
|
||||
dataToProcess = dataToProcess.substring(startIndex + startDelimiter.length);
|
||||
} else {
|
||||
return false; // Still waiting for start delimiter
|
||||
}
|
||||
}
|
||||
|
||||
// Process PID delimiter (mostly expected on stderr for background)
|
||||
const pidIndex = dataToProcess.indexOf(pidDelimiter);
|
||||
if (pidIndex !== -1) {
|
||||
// Extract PID value strictly between delimiter and newline/end
|
||||
const pidMatch = dataToProcess.substring(pidIndex + pidDelimiter.length).match(/^(\d+)/);
|
||||
if (pidMatch?.[1]) {
|
||||
backgroundPid = parseInt(pidMatch[1], 10);
|
||||
const pidEndIndex = pidIndex + pidDelimiter.length + pidMatch[1].length;
|
||||
const beforePid = dataToProcess.substring(0, pidIndex);
|
||||
if (isStderr) stderrBuffer += beforePid; else stdoutBuffer += beforePid;
|
||||
dataToProcess = dataToProcess.substring(pidEndIndex);
|
||||
} else {
|
||||
// Consume delimiter even if no number followed
|
||||
const beforePid = dataToProcess.substring(0, pidIndex);
|
||||
if (isStderr) stderrBuffer += beforePid; else stdoutBuffer += beforePid;
|
||||
dataToProcess = dataToProcess.substring(pidIndex + pidDelimiter.length);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// Process Exit Code delimiter
|
||||
const exitCodeIndex = dataToProcess.indexOf(exitCodeDelimiter);
|
||||
if (exitCodeIndex !== -1) {
|
||||
const exitCodeMatch = dataToProcess.substring(exitCodeIndex + exitCodeDelimiter.length).match(/^(\d+)/);
|
||||
if (exitCodeMatch?.[1]) {
|
||||
exitCode = parseInt(exitCodeMatch[1], 10);
|
||||
const beforeExitCode = dataToProcess.substring(0, exitCodeIndex);
|
||||
if (isStderr) stderrBuffer += beforeExitCode; else stdoutBuffer += beforeExitCode;
|
||||
dataToProcess = dataToProcess.substring(exitCodeIndex + exitCodeDelimiter.length + exitCodeMatch[1].length);
|
||||
} else {
|
||||
const beforeExitCode = dataToProcess.substring(0, exitCodeIndex);
|
||||
if (isStderr) stderrBuffer += beforeExitCode; else stdoutBuffer += beforeExitCode;
|
||||
dataToProcess = dataToProcess.substring(exitCodeIndex + exitCodeDelimiter.length);
|
||||
}
|
||||
}
|
||||
|
||||
// Process End delimiter
|
||||
const endDelimiterIndex = dataToProcess.indexOf(endDelimiter);
|
||||
if (endDelimiterIndex !== -1) {
|
||||
receivedEndDelimiter = true;
|
||||
const beforeEndDelimiter = dataToProcess.substring(0, endDelimiterIndex);
|
||||
if (isStderr) stderrBuffer += beforeEndDelimiter; else stdoutBuffer += beforeEndDelimiter;
|
||||
// Consume delimiter and potentially the exit code echoed after it
|
||||
const afterEndDelimiter = dataToProcess.substring(endDelimiterIndex + endDelimiter.length);
|
||||
const exitCodeEchoMatch = afterEndDelimiter.match(/^(\d+)/);
|
||||
dataToProcess = exitCodeEchoMatch ? afterEndDelimiter.substring(exitCodeEchoMatch[1].length) : afterEndDelimiter;
|
||||
}
|
||||
|
||||
// Append remaining data
|
||||
if (dataToProcess.length > 0) {
|
||||
if (isStderr) stderrBuffer += dataToProcess; else stdoutBuffer += dataToProcess;
|
||||
}
|
||||
|
||||
// Check completion criteria
|
||||
if (receivedEndDelimiter && exitCode !== null) {
|
||||
setImmediate(cleanupAndResolve); // Use setImmediate
|
||||
return true; // Signal completion of this command's stream processing
|
||||
}
|
||||
|
||||
return false; // More data or delimiters expected
|
||||
};
|
||||
|
||||
// Assign listeners
|
||||
onStdoutData = (data: Buffer) => processDataChunk(data.toString(), false);
|
||||
onStderrData = (data: Buffer) => processDataChunk(data.toString(), true);
|
||||
|
||||
// --- Cleanup Logic ---
|
||||
// Pass listeners to allow cleanup even if they are nullified later
|
||||
const cleanupListeners = (listeners?: { onStdoutData: any, onStderrData: any }) => {
|
||||
if (launchTimeoutId) clearTimeout(launchTimeoutId);
|
||||
launchTimeoutId = null;
|
||||
|
||||
// Use passed-in listeners if available, otherwise use current scope's
|
||||
const stdoutListener = listeners?.onStdoutData ?? onStdoutData;
|
||||
const stderrListener = listeners?.onStderrData ?? onStderrData;
|
||||
|
||||
if (this.bashProcess && !this.bashProcess.killed) {
|
||||
if (stdoutListener) this.bashProcess.stdout.removeListener('data', stdoutListener);
|
||||
if (stderrListener) this.bashProcess.stderr.removeListener('data', stderrListener);
|
||||
}
|
||||
// Only nullify the *current command's* cleanup reference if it matches
|
||||
if (this.currentCommandCleanup === cleanupListeners) {
|
||||
this.currentCommandCleanup = null;
|
||||
}
|
||||
// Nullify the listener references in the outer scope regardless
|
||||
onStdoutData = null;
|
||||
onStderrData = null;
|
||||
};
|
||||
// Store *this specific* cleanup function instance for the current command
|
||||
this.currentCommandCleanup = cleanupListeners;
|
||||
|
||||
// --- Final Resolution / Polling Logic ---
|
||||
const cleanupAndResolve = async () => {
|
||||
// Prevent double execution if cleanup was already called (e.g., by timeout)
|
||||
if (!this.currentCommandCleanup || this.currentCommandCleanup !== cleanupListeners) {
|
||||
// Ensure temp files are cleaned if this command was superseded but might have created them
|
||||
if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
|
||||
this.cleanupTempFiles(tempStdoutPath, tempStderrPath).catch(err => {
|
||||
console.warn(`Error cleaning up temp files for superseded command: ${err.message}`);
|
||||
});
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
// Capture initial output *before* cleanup nullifies buffers indirectly
|
||||
const launchStdout = this.truncateOutput(stdoutBuffer);
|
||||
const launchStderr = this.truncateOutput(stderrBuffer);
|
||||
|
||||
// Store listeners before calling cleanup
|
||||
const listenersToClean = { onStdoutData, onStderrData };
|
||||
cleanupListeners(listenersToClean); // Remove listeners and clear launch timeout NOW
|
||||
|
||||
// --- Error check for missing exit code ---
|
||||
if (exitCode === null) {
|
||||
console.error(`CRITICAL: Command "${params.command}" (background: ${isBackgroundTask}) finished delimiter processing but exitCode is null.`);
|
||||
const errorMode = isBackgroundTask ? 'Background Launch' : 'Foreground';
|
||||
if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
|
||||
await this.cleanupTempFiles(tempStdoutPath, tempStderrPath);
|
||||
}
|
||||
originalResolve({ // Use originalResolve as this is a failure *before* polling starts
|
||||
llmContent: `Command: ${params.command}\nExecuted in: ${this.currentCwd}\nMode: ${errorMode}\nExit Code: -2 (Internal Error: Exit code not captured)\nStdout (during setup):\n${launchStdout}\nStderr (during setup):\n${launchStderr}`,
|
||||
returnDisplay: `Internal Error: Failed to capture command exit code.\n${launchStdout}\nStderr: ${launchStderr}`.trim()
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
// --- CWD Update Logic (Only for Foreground Success or 'cd') ---
|
||||
let cwdUpdateError = '';
|
||||
if (!isBackgroundTask) { // Only run for foreground
|
||||
const mightChangeCwd = params.command.trim().startsWith('cd ');
|
||||
if (exitCode === 0 || mightChangeCwd) {
|
||||
try {
|
||||
const latestCwd = await this.getCurrentShellCwd();
|
||||
if (this.currentCwd !== latestCwd) {
|
||||
this.currentCwd = latestCwd;
|
||||
}
|
||||
} catch (e: any) {
|
||||
if (exitCode === 0) { // Only warn if the command itself succeeded
|
||||
cwdUpdateError = `\nWarning: Failed to verify/update current working directory after command: ${e.message}`;
|
||||
console.error("Failed to update CWD after successful command:", e);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
// --- End CWD Update ---
|
||||
|
||||
// --- Result Formatting & Polling Decision ---
|
||||
if (isBackgroundTask) {
|
||||
const launchSuccess = exitCode === 0;
|
||||
const pidString = backgroundPid !== null ? backgroundPid.toString() : 'Not Captured';
|
||||
|
||||
// Check if polling should start
|
||||
if (launchSuccess && backgroundPid !== null && tempStdoutPath && tempStderrPath) {
|
||||
// --- START POLLING ---
|
||||
// Don't await this, let it run in the background and resolve the original promise later
|
||||
this.inspectBackgroundProcess(
|
||||
backgroundPid,
|
||||
params.command,
|
||||
this.currentCwd, // CWD at time of launch
|
||||
launchStdout, // Initial output captured during launch
|
||||
launchStderr, // Initial output captured during launch
|
||||
tempStdoutPath, // Path for final stdout
|
||||
tempStderrPath, // Path for final stderr
|
||||
originalResolve // The resolve function of the main promise
|
||||
);
|
||||
// IMPORTANT: Do NOT resolve the promise here. pollBackgroundProcess will do it.
|
||||
// --- END POLLING ---
|
||||
} else {
|
||||
// Background launch failed OR PID was not captured OR temp files missing
|
||||
const reason = backgroundPid === null ? "PID not captured" : `Launch failed (Exit Code: ${exitCode})`;
|
||||
const displayMessage = `Failed to launch process in background (${reason})`;
|
||||
console.error(`Background launch failed for command: ${params.command}. Reason: ${reason}`); // ERROR LOG
|
||||
// Ensure cleanup of temp files if launch failed
|
||||
if (tempStdoutPath && tempStderrPath) {
|
||||
await this.cleanupTempFiles(tempStdoutPath, tempStderrPath);
|
||||
}
|
||||
originalResolve({ // Use originalResolve as polling won't start
|
||||
llmContent: `Background Command Launch Failed: ${params.command}\nExecuted in: ${this.currentCwd}\nReason: ${reason}\nPID: ${pidString}\nExit Code (Launch): ${exitCode}\nStdout (During Launch):\n${launchStdout}\nStderr (During Launch):\n${launchStderr}`,
|
||||
returnDisplay: displayMessage
|
||||
});
|
||||
}
|
||||
|
||||
} else {
|
||||
// --- Foreground task result (resolve immediately) ---
|
||||
let displayOutput = '';
|
||||
const stdoutTrimmed = launchStdout.trim();
|
||||
const stderrTrimmed = launchStderr.trim();
|
||||
|
||||
if (stderrTrimmed) {
|
||||
displayOutput = stderrTrimmed;
|
||||
} else if (stdoutTrimmed) {
|
||||
displayOutput = stdoutTrimmed;
|
||||
}
|
||||
|
||||
if (exitCode !== 0 && !displayOutput) {
|
||||
displayOutput = `Failed with exit code: ${exitCode}`;
|
||||
} else if (exitCode === 0 && !displayOutput) {
|
||||
displayOutput = `Success (no output)`;
|
||||
}
|
||||
|
||||
originalResolve({ // Use originalResolve for foreground result
|
||||
llmContent: `Command: ${params.command}\nExecuted in: ${this.currentCwd}\nExit Code: ${exitCode}\nStdout:\n${launchStdout}\nStderr:\n${launchStderr}${cwdUpdateError}`,
|
||||
returnDisplay: displayOutput.trim() || `Exit Code: ${exitCode}` // Ensure some display
|
||||
});
|
||||
// --- End Foreground Result ---
|
||||
}
|
||||
}; // End of cleanupAndResolve
|
||||
|
||||
|
||||
// --- Attach listeners ---
|
||||
if (!this.bashProcess || this.bashProcess.killed) {
|
||||
console.error("Bash process lost or killed before listeners could be attached.");
|
||||
// Ensure temp files are cleaned up if they exist
|
||||
if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
|
||||
this.cleanupTempFiles(tempStdoutPath, tempStderrPath).catch(err => {
|
||||
console.warn(`Error cleaning up temp files on attach failure: ${err.message}`);
|
||||
});
|
||||
}
|
||||
return originalReject(new Error("Bash process lost or killed before listeners could be attached."));
|
||||
}
|
||||
// Defensive remove shouldn't be strictly necessary with current cleanup logic, but harmless
|
||||
// if (onStdoutData) this.bashProcess.stdout.removeListener('data', onStdoutData);
|
||||
// if (onStderrData) this.bashProcess.stderr.removeListener('data', onStderrData);
|
||||
|
||||
// Attach the fresh listeners
|
||||
if (onStdoutData) this.bashProcess.stdout.on('data', onStdoutData);
|
||||
if (onStderrData) this.bashProcess.stderr.on('data', onStderrData);
|
||||
|
||||
// --- Construct and Write Command ---
|
||||
let commandToWrite: string;
|
||||
if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
|
||||
// Background: Redirect command's stdout/stderr to temp files.
|
||||
// Use subshell { ... } > file 2> file to redirect the command inside.
|
||||
// Capture PID of the subshell. Capture exit code of the subshell launch.
|
||||
// Ensure the subshell itself doesn't interfere with delimiter capture on stderr.
|
||||
commandToWrite = `echo "${startDelimiter}"; { { ${params.command} > "${tempStdoutPath}" 2> "${tempStderrPath}"; } & } 2>/dev/null; __LAST_PID=$!; echo "${pidDelimiter}$__LAST_PID" >&2; echo "${exitCodeDelimiter}$?" >&2; echo "${endDelimiter}$?" >&1\n`;
|
||||
} else if (!isBackgroundTask) {
|
||||
// Foreground: Original structure. Capture command exit code.
|
||||
commandToWrite = `echo "${startDelimiter}"; ${params.command}; __EXIT_CODE=$?; echo "${exitCodeDelimiter}$__EXIT_CODE" >&2; echo "${endDelimiter}$__EXIT_CODE" >&1\n`;
|
||||
} else {
|
||||
// Should not happen if background task setup failed, but handle defensively
|
||||
return originalReject(new Error("Internal setup error: Missing temporary file paths for background execution."));
|
||||
}
|
||||
|
||||
try {
|
||||
if (this.bashProcess?.stdin?.writable) {
|
||||
this.bashProcess.stdin.write(commandToWrite, (err) => {
|
||||
if (err) {
|
||||
console.error(`Error writing command "${params.command}" to bash stdin (callback):`, err);
|
||||
// Store listeners before calling cleanup
|
||||
const listenersToClean = { onStdoutData, onStderrData };
|
||||
cleanupListeners(listenersToClean); // Attempt cleanup
|
||||
if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
|
||||
this.cleanupTempFiles(tempStdoutPath, tempStderrPath).catch(e => console.warn(`Cleanup failed: ${e.message}`));
|
||||
}
|
||||
originalReject(new Error(`Shell stdin write error: ${err.message}. Command likely did not execute.`));
|
||||
}
|
||||
});
|
||||
} else {
|
||||
throw new Error("Shell stdin is not writable or process closed when attempting to write command.");
|
||||
}
|
||||
} catch (e: any) {
|
||||
console.error(`Error writing command "${params.command}" to bash stdin (sync):`, e);
|
||||
// Store listeners before calling cleanup
|
||||
const listenersToClean = { onStdoutData, onStderrData };
|
||||
cleanupListeners(listenersToClean); // Attempt cleanup
|
||||
if (isBackgroundTask && tempStdoutPath && tempStderrPath) {
|
||||
this.cleanupTempFiles(tempStdoutPath, tempStderrPath).catch(err => console.warn(`Cleanup failed: ${err.message}`));
|
||||
}
|
||||
originalReject(new Error(`Shell stdin write exception: ${e.message}. Command likely did not execute.`));
|
||||
}
|
||||
}); // End of main promise constructor
|
||||
|
||||
return promise; // Return the promise created at the top
|
||||
} // End of executeCommandInShell
|
||||
|
||||
|
||||
// --- **** NEW: Background Process Polling **** ---
|
||||
private async inspectBackgroundProcess(
|
||||
pid: number,
|
||||
command: string,
|
||||
cwd: string,
|
||||
initialStdout: string, // Stdout during launch phase
|
||||
initialStderr: string, // Stderr during launch phase
|
||||
tempStdoutPath: string, // Path to redirected stdout
|
||||
tempStderrPath: string, // Path to redirected stderr
|
||||
resolve: (value: TerminalToolResult | PromiseLike<TerminalToolResult>) => void // The original promise's resolve
|
||||
): Promise<void> { // This function manages its own lifecycle but resolves the outer promise
|
||||
let finalStdout = '';
|
||||
let finalStderr = '';
|
||||
let llmAnalysis = '';
|
||||
let fileReadError = '';
|
||||
|
||||
// --- Call LLM Analysis ---
|
||||
try {
|
||||
const { status, summary } = await this.backgroundTerminalAnalyzer.analyze(pid, tempStdoutPath, tempStderrPath, command);
|
||||
if (status === 'Unknown')
|
||||
llmAnalysis = `LLM analysis failed: ${summary}`;
|
||||
else
|
||||
llmAnalysis = summary;
|
||||
|
||||
} catch (llmError: any) {
|
||||
console.error(`LLM analysis failed for PID ${pid} command "${command}":`, llmError);
|
||||
llmAnalysis = `LLM analysis failed: ${llmError.message}`; // Include error in analysis placeholder
|
||||
}
|
||||
// --- End LLM Call ---
|
||||
|
||||
try {
|
||||
finalStdout = await fs.readFile(tempStdoutPath, 'utf-8');
|
||||
finalStderr = await fs.readFile(tempStderrPath, 'utf-8');
|
||||
} catch (err: any) {
|
||||
console.error(`Error reading temp output files for PID ${pid}:`, err);
|
||||
fileReadError = `\nWarning: Failed to read temporary output files (${err.message}). Final output may be incomplete.`;
|
||||
}
|
||||
|
||||
// --- Clean up temp files ---
|
||||
await this.cleanupTempFiles(tempStdoutPath, tempStderrPath);
|
||||
// --- End Cleanup ---
|
||||
|
||||
const truncatedFinalStdout = this.truncateOutput(finalStdout);
|
||||
const truncatedFinalStderr = this.truncateOutput(finalStderr);
|
||||
|
||||
// Resolve the original promise passed into pollBackgroundProcess
|
||||
resolve({
|
||||
llmContent: `Background Command: ${command}\nLaunched in: ${cwd}\nPID: ${pid}\n--- LLM Analysis ---\n${llmAnalysis}\n--- Final Stdout (from ${path.basename(tempStdoutPath)}) ---\n${truncatedFinalStdout}\n--- Final Stderr (from ${path.basename(tempStderrPath)}) ---\n${truncatedFinalStderr}\n--- Launch Stdout ---\n${initialStdout}\n--- Launch Stderr ---\n${initialStderr}${fileReadError}`,
|
||||
returnDisplay: `(PID: ${pid}): ${this.truncateOutput(llmAnalysis, 200)}`
|
||||
});
|
||||
} // End of pollBackgroundProcess
|
||||
|
||||
// --- **** NEW: Helper to cleanup temp files **** ---
|
||||
private async cleanupTempFiles(stdoutPath: string | null, stderrPath: string | null): Promise<void> {
|
||||
const unlinkQuietly = async (filePath: string | null) => {
|
||||
if (!filePath) return;
|
||||
try {
|
||||
await fs.unlink(filePath);
|
||||
} catch (err: any) {
|
||||
// Ignore errors like file not found (it might have been deleted already or failed to create)
|
||||
if (err.code !== 'ENOENT') {
|
||||
console.warn(`Failed to delete temporary file '${filePath}': ${err.message}`);
|
||||
} else {
|
||||
}
|
||||
}
|
||||
};
|
||||
// Run deletions concurrently and wait for both
|
||||
await Promise.all([
|
||||
unlinkQuietly(stdoutPath),
|
||||
unlinkQuietly(stderrPath)
|
||||
]);
|
||||
}
|
||||
|
||||
|
||||
// --- Get CWD (mostly unchanged, added robustness) ---
|
||||
private getCurrentShellCwd(): Promise<string> {
|
||||
return new Promise((resolve, reject) => {
|
||||
if (!this.bashProcess || !this.bashProcess.stdin?.writable || this.bashProcess.killed) {
|
||||
return reject(new Error("Shell not running, stdin not writable, or killed for PWD check"));
|
||||
}
|
||||
|
||||
const pwdUuid = crypto.randomUUID();
|
||||
const pwdDelimiter = `::PWD_${pwdUuid}::`;
|
||||
let pwdOutput = '';
|
||||
let onPwdData: ((data: Buffer) => void) | null = null;
|
||||
let onPwdError: ((data: Buffer) => void) | null = null; // To catch errors during pwd
|
||||
let pwdTimeoutId: NodeJS.Timeout | null = null;
|
||||
let finished = false; // Prevent double resolution/rejection
|
||||
|
||||
const cleanupPwdListeners = (err?: Error) => {
|
||||
if (finished) return; // Already handled
|
||||
finished = true;
|
||||
if (pwdTimeoutId) clearTimeout(pwdTimeoutId);
|
||||
pwdTimeoutId = null;
|
||||
|
||||
const stdoutListener = onPwdData; // Capture current reference
|
||||
const stderrListener = onPwdError; // Capture current reference
|
||||
onPwdData = null; // Nullify before removing
|
||||
onPwdError = null;
|
||||
|
||||
if (this.bashProcess && !this.bashProcess.killed) {
|
||||
if (stdoutListener) this.bashProcess.stdout.removeListener('data', stdoutListener);
|
||||
if (stderrListener) this.bashProcess.stderr.removeListener('data', stderrListener);
|
||||
}
|
||||
|
||||
if (err) {
|
||||
reject(err);
|
||||
} else {
|
||||
// Trim whitespace and trailing newlines robustly
|
||||
resolve(pwdOutput.trim());
|
||||
}
|
||||
}
|
||||
|
||||
onPwdData = (data: Buffer) => {
|
||||
if (!onPwdData) return; // Listener removed
|
||||
const dataStr = data.toString();
|
||||
const delimiterIndex = dataStr.indexOf(pwdDelimiter);
|
||||
if (delimiterIndex !== -1) {
|
||||
pwdOutput += dataStr.substring(0, delimiterIndex);
|
||||
cleanupPwdListeners(); // Resolve successfully
|
||||
} else {
|
||||
pwdOutput += dataStr;
|
||||
}
|
||||
};
|
||||
|
||||
onPwdError = (data: Buffer) => {
|
||||
if (!onPwdError) return; // Listener removed
|
||||
const dataStr = data.toString();
|
||||
// If delimiter appears on stderr, or any stderr occurs, treat as error
|
||||
console.error(`Error during PWD check: ${dataStr}`);
|
||||
cleanupPwdListeners(new Error(`Stderr received during pwd check: ${this.truncateOutput(dataStr, 100)}`));
|
||||
};
|
||||
|
||||
// Attach listeners
|
||||
this.bashProcess.stdout.on('data', onPwdData);
|
||||
this.bashProcess.stderr.on('data', onPwdError);
|
||||
|
||||
// Set timeout
|
||||
pwdTimeoutId = setTimeout(() => {
|
||||
cleanupPwdListeners(new Error("Timeout waiting for pwd response"));
|
||||
}, 5000); // 5 second timeout for pwd
|
||||
|
||||
// Write command
|
||||
try {
|
||||
// Use printf for robustness against special characters in PWD and ensure newline
|
||||
const pwdCommand = `printf "%s" "$PWD"; printf "${pwdDelimiter}";\n`;
|
||||
if (this.bashProcess?.stdin?.writable) {
|
||||
this.bashProcess.stdin.write(pwdCommand, (err) => {
|
||||
if (err) {
|
||||
// Error during write callback, likely means shell is unresponsive
|
||||
console.error("Error writing pwd command (callback):", err);
|
||||
cleanupPwdListeners(new Error(`Failed to write pwd command: ${err.message}`));
|
||||
}
|
||||
});
|
||||
} else {
|
||||
throw new Error("Shell stdin not writable for pwd command.");
|
||||
}
|
||||
} catch (e: any) {
|
||||
console.error("Exception writing pwd command:", e);
|
||||
cleanupPwdListeners(new Error(`Exception writing pwd command: ${e.message}`));
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// --- Truncate Output (unchanged) ---
|
||||
private truncateOutput(output: string, limit?: number): string {
|
||||
const effectiveLimit = limit ?? this.outputLimit;
|
||||
if (output.length > effectiveLimit) {
|
||||
return output.substring(0, effectiveLimit) + `\n... [Output truncated at ${effectiveLimit} characters]`;
|
||||
}
|
||||
return output;
|
||||
}
|
||||
|
||||
// --- Clear Queue (unchanged) ---
|
||||
private clearQueue(error: Error) {
|
||||
const queuedCount = this.commandQueue.length;
|
||||
const queue = this.commandQueue;
|
||||
this.commandQueue = [];
|
||||
queue.forEach(({ resolve, params }) => resolve({
|
||||
llmContent: `Command cancelled: ${params.command}\nReason: ${error.message}`,
|
||||
returnDisplay: `Command Cancelled: ${error.message}`
|
||||
}));
|
||||
}
|
||||
|
||||
// --- Destroy (Added cleanup for pending background tasks if possible) ---
|
||||
destroy() {
|
||||
// Reject any pending shell readiness promise
|
||||
this.rejectShellReady?.(new Error("BashTool destroyed during initialization or operation."));
|
||||
this.rejectShellReady = undefined; // Prevent further calls
|
||||
this.resolveShellReady = undefined;
|
||||
|
||||
this.clearQueue(new Error("BashTool is being destroyed."));
|
||||
|
||||
// Attempt to cleanup listeners for the *currently executing* command, if any
|
||||
try {
|
||||
this.currentCommandCleanup?.();
|
||||
} catch (e) {
|
||||
console.warn("Error during current command cleanup:", e)
|
||||
}
|
||||
|
||||
// Handle the bash process itself
|
||||
if (this.bashProcess) {
|
||||
const proc = this.bashProcess; // Reference before nullifying
|
||||
const pid = proc.pid;
|
||||
this.bashProcess = null; // Nullify reference immediately
|
||||
|
||||
proc.stdout?.removeAllListeners();
|
||||
proc.stderr?.removeAllListeners();
|
||||
proc.removeAllListeners('error');
|
||||
proc.removeAllListeners('close');
|
||||
|
||||
// Ensure stdin is closed
|
||||
proc.stdin?.end();
|
||||
|
||||
try {
|
||||
// Don't wait for these, just attempt
|
||||
proc.kill('SIGTERM'); // Attempt graceful first
|
||||
setTimeout(() => {
|
||||
if (!proc.killed) {
|
||||
proc.kill('SIGKILL'); // Force kill if needed
|
||||
}
|
||||
}, 500); // 500ms grace period
|
||||
|
||||
} catch (e: any) {
|
||||
// Catch errors if process already exited etc.
|
||||
console.warn(`Error trying to kill bash process PID: ${pid}: ${e.message}`);
|
||||
}
|
||||
} else {
|
||||
}
|
||||
|
||||
// Note: We cannot reliably clean up temp files for background tasks
|
||||
// that were polling when destroy() was called without more complex state tracking.
|
||||
// OS should eventually clean /tmp, or implement a startup cleanup routine if needed.
|
||||
}
|
||||
} // End of TerminalTool class
|
||||
58
packages/cli/src/tools/tool-registry.ts
Normal file
58
packages/cli/src/tools/tool-registry.ts
Normal file
@@ -0,0 +1,58 @@
|
||||
import { ToolListUnion, FunctionDeclaration } from '@google/genai';
|
||||
import { Tool } from './Tool.js';
|
||||
import { ToolResult } from './ToolResult.js';
|
||||
|
||||
class ToolRegistry {
|
||||
private tools: Map<string, Tool> = new Map();
|
||||
|
||||
/**
|
||||
* Registers a tool definition.
|
||||
* @param tool - The tool object containing schema and execution logic.
|
||||
*/
|
||||
registerTool(tool: Tool): void {
|
||||
if (this.tools.has(tool.name)) {
|
||||
// Decide on behavior: throw error, log warning, or allow overwrite
|
||||
console.warn(`Tool with name "${tool.name}" is already registered. Overwriting.`);
|
||||
}
|
||||
this.tools.set(tool.name, tool);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieves the list of tool schemas in the format required by Gemini.
|
||||
* @returns A ToolListUnion containing the function declarations.
|
||||
*/
|
||||
getToolSchemas(): ToolListUnion {
|
||||
const declarations: FunctionDeclaration[] = [];
|
||||
this.tools.forEach(tool => {
|
||||
declarations.push(tool.schema);
|
||||
});
|
||||
|
||||
// Return Gemini's expected format. Handle the case of no tools.
|
||||
if (declarations.length === 0) {
|
||||
// Depending on the SDK version, you might need `undefined`, `[]`, or `[{ functionDeclarations: [] }]`
|
||||
// Check the documentation for your @google/genai version.
|
||||
// Let's assume an empty array works or signifies no tools.
|
||||
return [];
|
||||
// Or if it requires the structure:
|
||||
// return [{ functionDeclarations: [] }];
|
||||
}
|
||||
return [{ functionDeclarations: declarations }];
|
||||
}
|
||||
|
||||
/**
|
||||
* Optional: Get a list of registered tool names.
|
||||
*/
|
||||
listAvailableTools(): string[] {
|
||||
return Array.from(this.tools.keys());
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the definition of a specific tool.
|
||||
*/
|
||||
getTool(name: string): Tool | undefined {
|
||||
return this.tools.get(name);
|
||||
}
|
||||
}
|
||||
|
||||
// Export a singleton instance of the registry
|
||||
export const toolRegistry = new ToolRegistry();
|
||||
201
packages/cli/src/tools/write-file.tool.ts
Normal file
201
packages/cli/src/tools/write-file.tool.ts
Normal file
@@ -0,0 +1,201 @@
|
||||
import fs from 'fs';
|
||||
import path from 'path';
|
||||
import { ToolResult } from './ToolResult.js';
|
||||
import { BaseTool } from './BaseTool.js';
|
||||
import { SchemaValidator } from '../utils/schemaValidator.js';
|
||||
import { makeRelative, shortenPath } from '../utils/paths.js';
|
||||
import { ToolCallConfirmationDetails, ToolConfirmationOutcome, ToolEditConfirmationDetails } from '../ui/types.js';
|
||||
import * as Diff from 'diff';
|
||||
|
||||
/**
|
||||
* Parameters for the WriteFile tool
|
||||
*/
|
||||
export interface WriteFileToolParams {
|
||||
/**
|
||||
* The absolute path to the file to write to
|
||||
*/
|
||||
file_path: string;
|
||||
|
||||
/**
|
||||
* The content to write to the file
|
||||
*/
|
||||
content: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* Standardized result from the WriteFile tool
|
||||
*/
|
||||
export interface WriteFileToolResult extends ToolResult {
|
||||
}
|
||||
|
||||
/**
|
||||
* Implementation of the WriteFile tool that writes files to the filesystem
|
||||
*/
|
||||
export class WriteFileTool extends BaseTool<WriteFileToolParams, WriteFileToolResult> {
|
||||
public static readonly Name: string = 'write_file';
|
||||
private shouldAlwaysWrite = false;
|
||||
|
||||
/**
|
||||
* The root directory that this tool is grounded in.
|
||||
* All file operations will be restricted to this directory.
|
||||
*/
|
||||
private rootDirectory: string;
|
||||
|
||||
/**
|
||||
* Creates a new instance of the WriteFileTool
|
||||
* @param rootDirectory Root directory to ground this tool in. All operations will be restricted to this directory.
|
||||
*/
|
||||
constructor(rootDirectory: string) {
|
||||
super(
|
||||
WriteFileTool.Name,
|
||||
'WriteFile',
|
||||
'Writes content to a specified file in the local filesystem.',
|
||||
{
|
||||
properties: {
|
||||
file_path: {
|
||||
description: 'The absolute path to the file to write to (e.g., \'/home/user/project/file.txt\'). Relative paths are not supported.',
|
||||
type: 'string'
|
||||
},
|
||||
content: {
|
||||
description: 'The content to write to the file.',
|
||||
type: 'string'
|
||||
}
|
||||
},
|
||||
required: ['file_path', 'content'],
|
||||
type: 'object'
|
||||
}
|
||||
);
|
||||
|
||||
// Set the root directory
|
||||
this.rootDirectory = path.resolve(rootDirectory);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a path is within the root directory
|
||||
* @param pathToCheck The path to check
|
||||
* @returns True if the path is within the root directory, false otherwise
|
||||
*/
|
||||
private isWithinRoot(pathToCheck: string): boolean {
|
||||
const normalizedPath = path.normalize(pathToCheck);
|
||||
const normalizedRoot = path.normalize(this.rootDirectory);
|
||||
|
||||
// Ensure the normalizedRoot ends with a path separator for proper path comparison
|
||||
const rootWithSep = normalizedRoot.endsWith(path.sep)
|
||||
? normalizedRoot
|
||||
: normalizedRoot + path.sep;
|
||||
|
||||
return normalizedPath === normalizedRoot || normalizedPath.startsWith(rootWithSep);
|
||||
}
|
||||
|
||||
/**
|
||||
* Validates the parameters for the WriteFile tool
|
||||
* @param params Parameters to validate
|
||||
* @returns True if parameters are valid, false otherwise
|
||||
*/
|
||||
invalidParams(params: WriteFileToolParams): string | null {
|
||||
if (this.schema.parameters && !SchemaValidator.validate(this.schema.parameters as Record<string, unknown>, params)) {
|
||||
return 'Parameters failed schema validation.';
|
||||
}
|
||||
|
||||
// Ensure path is absolute
|
||||
if (!path.isAbsolute(params.file_path)) {
|
||||
return `File path must be absolute: ${params.file_path}`;
|
||||
}
|
||||
|
||||
// Ensure path is within the root directory
|
||||
if (!this.isWithinRoot(params.file_path)) {
|
||||
return `File path must be within the root directory (${this.rootDirectory}): ${params.file_path}`;
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Determines if the tool should prompt for confirmation before execution
|
||||
* @param params Parameters for the tool execution
|
||||
* @returns Whether or not execute should be confirmed by the user.
|
||||
*/
|
||||
async shouldConfirmExecute(params: WriteFileToolParams): Promise<ToolCallConfirmationDetails | false> {
|
||||
if (this.shouldAlwaysWrite) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const relativePath = makeRelative(params.file_path, this.rootDirectory);
|
||||
const fileName = path.basename(params.file_path);
|
||||
|
||||
let currentContent = '';
|
||||
try {
|
||||
currentContent = fs.readFileSync(params.file_path, 'utf8');
|
||||
} catch (error) {
|
||||
// File may not exist, which is fine
|
||||
}
|
||||
|
||||
const fileDiff = Diff.createPatch(
|
||||
fileName,
|
||||
currentContent,
|
||||
params.content,
|
||||
'Current',
|
||||
'Proposed',
|
||||
{ context: 3, ignoreWhitespace: true}
|
||||
);
|
||||
|
||||
const confirmationDetails: ToolEditConfirmationDetails = {
|
||||
title: `Confirm Write: ${shortenPath(relativePath)}`,
|
||||
fileName,
|
||||
fileDiff,
|
||||
onConfirm: async (outcome: ToolConfirmationOutcome) => {
|
||||
if (outcome === ToolConfirmationOutcome.ProceedAlways) {
|
||||
this.shouldAlwaysWrite = true;
|
||||
}
|
||||
},
|
||||
};
|
||||
return confirmationDetails;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a description of the file writing operation
|
||||
* @param params Parameters for the file writing
|
||||
* @returns A string describing the file being written to
|
||||
*/
|
||||
getDescription(params: WriteFileToolParams): string {
|
||||
const relativePath = makeRelative(params.file_path, this.rootDirectory);
|
||||
return `Writing to ${shortenPath(relativePath)}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Executes the file writing operation
|
||||
* @param params Parameters for the file writing
|
||||
* @returns Result of the file writing operation
|
||||
*/
|
||||
async execute(params: WriteFileToolParams): Promise<WriteFileToolResult> {
|
||||
const validationError = this.invalidParams(params);
|
||||
if (validationError) {
|
||||
return {
|
||||
llmContent: `Error: Invalid parameters provided. Reason: ${validationError}`,
|
||||
returnDisplay: '**Error:** Failed to execute tool.'
|
||||
};
|
||||
}
|
||||
|
||||
try {
|
||||
// Ensure parent directories exist
|
||||
const dirName = path.dirname(params.file_path);
|
||||
if (!fs.existsSync(dirName)) {
|
||||
fs.mkdirSync(dirName, { recursive: true });
|
||||
}
|
||||
|
||||
// Write the file
|
||||
fs.writeFileSync(params.file_path, params.content, 'utf8');
|
||||
|
||||
return {
|
||||
llmContent: `Successfully wrote to file: ${params.file_path}`,
|
||||
returnDisplay: `Wrote to ${shortenPath(makeRelative(params.file_path, this.rootDirectory))}`
|
||||
};
|
||||
} catch (error) {
|
||||
const errorMsg = `Error writing to file: ${error instanceof Error ? error.message : String(error)}`;
|
||||
return {
|
||||
llmContent: `Error writing to file ${params.file_path}: ${errorMsg}`,
|
||||
returnDisplay: `Failed to write to file: ${errorMsg}`
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user