/** * @license * Copyright 2025 Google LLC * SPDX-License-Identifier: Apache-2.0 */ import { describe, it, expect, beforeEach, afterEach } from 'vitest'; import * as fsPromises from 'fs/promises'; import * as path from 'path'; import * as os from 'os'; import { bfsFileSearch } from './bfsFileSearch.js'; import { FileDiscoveryService } from '../services/fileDiscoveryService.js'; describe('bfsFileSearch', () => { let testRootDir: string; async function createEmptyDir(...pathSegments: string[]) { const fullPath = path.join(testRootDir, ...pathSegments); await fsPromises.mkdir(fullPath, { recursive: true }); return fullPath; } async function createTestFile(content: string, ...pathSegments: string[]) { const fullPath = path.join(testRootDir, ...pathSegments); await fsPromises.mkdir(path.dirname(fullPath), { recursive: true }); await fsPromises.writeFile(fullPath, content); return fullPath; } beforeEach(async () => { testRootDir = await fsPromises.mkdtemp( path.join(os.tmpdir(), 'bfs-file-search-test-'), ); }); afterEach(async () => { await fsPromises.rm(testRootDir, { recursive: true, force: true }); }); it('should find a file in the root directory', async () => { const targetFilePath = await createTestFile('content', 'target.txt'); const result = await bfsFileSearch(testRootDir, { fileName: 'target.txt' }); expect(result).toEqual([targetFilePath]); }); it('should find a file in a nested directory', async () => { const targetFilePath = await createTestFile( 'content', 'a', 'b', 'target.txt', ); const result = await bfsFileSearch(testRootDir, { fileName: 'target.txt' }); expect(result).toEqual([targetFilePath]); }); it('should find multiple files with the same name', async () => { const targetFilePath1 = await createTestFile('content1', 'a', 'target.txt'); const targetFilePath2 = await createTestFile('content2', 'b', 'target.txt'); const result = await bfsFileSearch(testRootDir, { fileName: 'target.txt' }); result.sort(); expect(result).toEqual([targetFilePath1, targetFilePath2].sort()); }); it('should return an empty array if no file is found', async () => { await createTestFile('content', 'other.txt'); const result = await bfsFileSearch(testRootDir, { fileName: 'target.txt' }); expect(result).toEqual([]); }); it('should ignore directories specified in ignoreDirs', async () => { await createTestFile('content', 'ignored', 'target.txt'); const targetFilePath = await createTestFile( 'content', 'not-ignored', 'target.txt', ); const result = await bfsFileSearch(testRootDir, { fileName: 'target.txt', ignoreDirs: ['ignored'], }); expect(result).toEqual([targetFilePath]); }); it('should respect the maxDirs limit and not find the file', async () => { await createTestFile('content', 'a', 'b', 'c', 'target.txt'); const result = await bfsFileSearch(testRootDir, { fileName: 'target.txt', maxDirs: 3, }); expect(result).toEqual([]); }); it('should respect the maxDirs limit and find the file', async () => { const targetFilePath = await createTestFile( 'content', 'a', 'b', 'c', 'target.txt', ); const result = await bfsFileSearch(testRootDir, { fileName: 'target.txt', maxDirs: 4, }); expect(result).toEqual([targetFilePath]); }); describe('with FileDiscoveryService', () => { let projectRoot: string; beforeEach(async () => { projectRoot = await createEmptyDir('project'); }); it('should ignore gitignored files', async () => { await createEmptyDir('project', '.git'); await createTestFile('node_modules/', 'project', '.gitignore'); await createTestFile('content', 'project', 'node_modules', 'target.txt'); const targetFilePath = await createTestFile( 'content', 'project', 'not-ignored', 'target.txt', ); const fileService = new FileDiscoveryService(projectRoot); const result = await bfsFileSearch(projectRoot, { fileName: 'target.txt', fileService, fileFilteringOptions: { respectGitIgnore: true, respectGeminiIgnore: true, }, }); expect(result).toEqual([targetFilePath]); }); it('should ignore geminiignored files', async () => { await createTestFile('node_modules/', 'project', '.geminiignore'); await createTestFile('content', 'project', 'node_modules', 'target.txt'); const targetFilePath = await createTestFile( 'content', 'project', 'not-ignored', 'target.txt', ); const fileService = new FileDiscoveryService(projectRoot); const result = await bfsFileSearch(projectRoot, { fileName: 'target.txt', fileService, fileFilteringOptions: { respectGitIgnore: false, respectGeminiIgnore: true, }, }); expect(result).toEqual([targetFilePath]); }); it('should not ignore files if respect flags are false', async () => { await createEmptyDir('project', '.git'); await createTestFile('node_modules/', 'project', '.gitignore'); const target1 = await createTestFile( 'content', 'project', 'node_modules', 'target.txt', ); const target2 = await createTestFile( 'content', 'project', 'not-ignored', 'target.txt', ); const fileService = new FileDiscoveryService(projectRoot); const result = await bfsFileSearch(projectRoot, { fileName: 'target.txt', fileService, fileFilteringOptions: { respectGitIgnore: false, respectGeminiIgnore: false, }, }); expect(result.sort()).toEqual([target1, target2].sort()); }); }); it('should perform parallel directory scanning efficiently (performance test)', async () => { // Create a more complex directory structure for performance testing console.log('\nšŸš€ Testing Parallel BFS Performance...'); // Create 50 directories with multiple levels for faster test execution for (let i = 0; i < 50; i++) { await createEmptyDir(`dir${i}`); await createEmptyDir(`dir${i}`, 'subdir1'); await createEmptyDir(`dir${i}`, 'subdir2'); await createEmptyDir(`dir${i}`, 'subdir1', 'deep'); if (i < 10) { // Add target files in some directories await createTestFile('content', `dir${i}`, 'GEMINI.md'); await createTestFile('content', `dir${i}`, 'subdir1', 'GEMINI.md'); } } // Run multiple iterations to ensure consistency const iterations = 3; const durations: number[] = []; let foundFiles = 0; let firstResultSorted: string[] | undefined; for (let i = 0; i < iterations; i++) { const searchStartTime = performance.now(); const result = await bfsFileSearch(testRootDir, { fileName: 'GEMINI.md', maxDirs: 200, debug: false, }); const duration = performance.now() - searchStartTime; durations.push(duration); // Verify consistency: all iterations should find the exact same files if (firstResultSorted === undefined) { foundFiles = result.length; firstResultSorted = result.sort(); } else { expect(result.sort()).toEqual(firstResultSorted); } console.log(`šŸ“Š Iteration ${i + 1}: ${duration.toFixed(2)}ms`); } const avgDuration = durations.reduce((a, b) => a + b, 0) / durations.length; const maxDuration = Math.max(...durations); const minDuration = Math.min(...durations); console.log(`šŸ“Š Average Duration: ${avgDuration.toFixed(2)}ms`); console.log( `šŸ“Š Min/Max Duration: ${minDuration.toFixed(2)}ms / ${maxDuration.toFixed(2)}ms`, ); console.log(`šŸ“ Found ${foundFiles} GEMINI.md files`); console.log( `šŸŽļø Processing ~${Math.round(200 / (avgDuration / 1000))} dirs/second`, ); // Verify we found the expected files expect(foundFiles).toBe(20); // 10 dirs * 2 files each // Performance expectation: check consistency rather than absolute time const variance = maxDuration - minDuration; const consistencyRatio = variance / avgDuration; // Ensure reasonable performance (generous limit for CI environments) expect(avgDuration).toBeLessThan(2000); // Very generous limit // Ensure consistency across runs (variance should not be too high) // More tolerant in CI environments where performance can be variable const maxConsistencyRatio = process.env.CI ? 3.0 : 1.5; expect(consistencyRatio).toBeLessThan(maxConsistencyRatio); // Max variance should be reasonable console.log( `āœ… Performance test passed: avg=${avgDuration.toFixed(2)}ms, consistency=${(consistencyRatio * 100).toFixed(1)}% (threshold: ${(maxConsistencyRatio * 100).toFixed(0)}%)`, ); }); });