/** * @license * Copyright 2025 Google LLC * SPDX-License-Identifier: Apache-2.0 */ import fs from 'fs'; import path from 'path'; import { glob, escape } from 'glob'; import { SchemaValidator } from '../utils/schemaValidator.js'; import { BaseDeclarativeTool, BaseToolInvocation, Kind, ToolInvocation, ToolResult, } from './tools.js'; import { shortenPath, makeRelative } from '../utils/paths.js'; import { Config } from '../config/config.js'; // Subset of 'Path' interface provided by 'glob' that we can implement for testing export interface GlobPath { fullpath(): string; mtimeMs?: number; } /** * Sorts file entries based on recency and then alphabetically. * Recent files (modified within recencyThresholdMs) are listed first, newest to oldest. * Older files are listed after recent ones, sorted alphabetically by path. */ export function sortFileEntries( entries: GlobPath[], nowTimestamp: number, recencyThresholdMs: number, ): GlobPath[] { const sortedEntries = [...entries]; sortedEntries.sort((a, b) => { const mtimeA = a.mtimeMs ?? 0; const mtimeB = b.mtimeMs ?? 0; const aIsRecent = nowTimestamp - mtimeA < recencyThresholdMs; const bIsRecent = nowTimestamp - mtimeB < recencyThresholdMs; if (aIsRecent && bIsRecent) { return mtimeB - mtimeA; } else if (aIsRecent) { return -1; } else if (bIsRecent) { return 1; } else { return a.fullpath().localeCompare(b.fullpath()); } }); return sortedEntries; } /** * 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; /** * Whether the search should be case-sensitive (optional, defaults to false) */ case_sensitive?: boolean; /** * Whether to respect .gitignore patterns (optional, defaults to true) */ respect_git_ignore?: boolean; } class GlobToolInvocation extends BaseToolInvocation< GlobToolParams, ToolResult > { constructor( private config: Config, params: GlobToolParams, ) { super(params); } getDescription(): string { let description = `'${this.params.pattern}'`; if (this.params.path) { const searchDir = path.resolve( this.config.getTargetDir(), this.params.path || '.', ); const relativePath = makeRelative(searchDir, this.config.getTargetDir()); description += ` within ${shortenPath(relativePath)}`; } return description; } async execute(signal: AbortSignal): Promise { try { const workspaceContext = this.config.getWorkspaceContext(); const workspaceDirectories = workspaceContext.getDirectories(); // If a specific path is provided, resolve it and check if it's within workspace let searchDirectories: readonly string[]; if (this.params.path) { const searchDirAbsolute = path.resolve( this.config.getTargetDir(), this.params.path, ); if (!workspaceContext.isPathWithinWorkspace(searchDirAbsolute)) { return { llmContent: `Error: Path "${this.params.path}" is not within any workspace directory`, returnDisplay: `Path is not within workspace`, }; } searchDirectories = [searchDirAbsolute]; } else { // Search across all workspace directories searchDirectories = workspaceDirectories; } // Get centralized file discovery service const respectGitIgnore = this.params.respect_git_ignore ?? this.config.getFileFilteringRespectGitIgnore(); const fileDiscovery = this.config.getFileService(); // Collect entries from all search directories let allEntries: GlobPath[] = []; for (const searchDir of searchDirectories) { let pattern = this.params.pattern; const fullPath = path.join(searchDir, pattern); if (fs.existsSync(fullPath)) { pattern = escape(pattern); } const entries = (await glob(pattern, { cwd: searchDir, withFileTypes: true, nodir: true, stat: true, nocase: !this.params.case_sensitive, dot: true, ignore: ['**/node_modules/**', '**/.git/**'], follow: false, signal, })) as GlobPath[]; allEntries = allEntries.concat(entries); } const entries = allEntries; // Apply git-aware filtering if enabled and in git repository let filteredEntries = entries; let gitIgnoredCount = 0; if (respectGitIgnore) { const relativePaths = entries.map((p) => path.relative(this.config.getTargetDir(), p.fullpath()), ); const filteredRelativePaths = fileDiscovery.filterFiles(relativePaths, { respectGitIgnore, }); const filteredAbsolutePaths = new Set( filteredRelativePaths.map((p) => path.resolve(this.config.getTargetDir(), p), ), ); filteredEntries = entries.filter((entry) => filteredAbsolutePaths.has(entry.fullpath()), ); gitIgnoredCount = entries.length - filteredEntries.length; } if (!filteredEntries || filteredEntries.length === 0) { let message = `No files found matching pattern "${this.params.pattern}"`; if (searchDirectories.length === 1) { message += ` within ${searchDirectories[0]}`; } else { message += ` within ${searchDirectories.length} workspace directories`; } if (gitIgnoredCount > 0) { message += ` (${gitIgnoredCount} files were git-ignored)`; } return { llmContent: message, returnDisplay: `No files found`, }; } // Set filtering such that we first show the most recent files const oneDayInMs = 24 * 60 * 60 * 1000; const nowTimestamp = new Date().getTime(); // Sort the filtered entries using the new helper function const sortedEntries = sortFileEntries( filteredEntries, nowTimestamp, oneDayInMs, ); const sortedAbsolutePaths = sortedEntries.map((entry) => entry.fullpath(), ); const fileListDescription = sortedAbsolutePaths.join('\n'); const fileCount = sortedAbsolutePaths.length; let resultMessage = `Found ${fileCount} file(s) matching "${this.params.pattern}"`; if (searchDirectories.length === 1) { resultMessage += ` within ${searchDirectories[0]}`; } else { resultMessage += ` across ${searchDirectories.length} workspace directories`; } if (gitIgnoredCount > 0) { resultMessage += ` (${gitIgnoredCount} additional files were git-ignored)`; } resultMessage += `, sorted by modification time (newest first):\n${fileListDescription}`; return { llmContent: resultMessage, returnDisplay: `Found ${fileCount} matching file(s)`, }; } catch (error) { const errorMessage = error instanceof Error ? error.message : String(error); console.error(`GlobLogic execute Error: ${errorMessage}`, error); return { llmContent: `Error during glob search operation: ${errorMessage}`, returnDisplay: `Error: An unexpected error occurred.`, }; } } } /** * Implementation of the Glob tool logic */ export class GlobTool extends BaseDeclarativeTool { static readonly Name = 'glob'; constructor(private config: Config) { super( GlobTool.Name, '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.', Kind.Search, { properties: { pattern: { description: "The glob pattern to match against (e.g., '**/*.py', 'docs/*.md').", type: 'string', }, path: { description: 'Optional: The absolute path to the directory to search within. If omitted, searches the root directory.', type: 'string', }, case_sensitive: { description: 'Optional: Whether the search should be case-sensitive. Defaults to false.', type: 'boolean', }, respect_git_ignore: { description: 'Optional: Whether to respect .gitignore patterns when finding files. Only available in git repositories. Defaults to true.', type: 'boolean', }, }, required: ['pattern'], type: 'object', }, ); } /** * Validates the parameters for the tool. */ override validateToolParams(params: GlobToolParams): string | null { const errors = SchemaValidator.validate( this.schema.parametersJsonSchema, params, ); if (errors) { return errors; } const searchDirAbsolute = path.resolve( this.config.getTargetDir(), params.path || '.', ); const workspaceContext = this.config.getWorkspaceContext(); if (!workspaceContext.isPathWithinWorkspace(searchDirAbsolute)) { const directories = workspaceContext.getDirectories(); return `Search path ("${searchDirAbsolute}") resolves outside the allowed workspace directories: ${directories.join(', ')}`; } const targetDir = searchDirAbsolute || this.config.getTargetDir(); try { if (!fs.existsSync(targetDir)) { return `Search path does not exist ${targetDir}`; } if (!fs.statSync(targetDir).isDirectory()) { return `Search path is not a directory: ${targetDir}`; } } catch (e: unknown) { return `Error accessing search path: ${e}`; } if ( !params.pattern || typeof params.pattern !== 'string' || params.pattern.trim() === '' ) { return "The 'pattern' parameter cannot be empty."; } return null; } protected createInvocation( params: GlobToolParams, ): ToolInvocation { return new GlobToolInvocation(this.config, params); } }