quantum-cli-core
Version:
Quantum CLI Core - Multi-LLM Collaboration System
432 lines • 21.6 kB
JavaScript
/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { vi, describe, it, expect, beforeEach } from 'vitest';
import * as fsPromises from 'fs/promises';
import * as os from 'os';
import * as path from 'path';
import { loadServerHierarchicalMemory } from './memoryDiscovery.js';
import { GEMINI_CONFIG_DIR, setGeminiMdFilename, getCurrentGeminiMdFilename, DEFAULT_CONTEXT_FILENAME, } from '../tools/memoryTool.js';
import { FileDiscoveryService } from '../services/fileDiscoveryService.js';
const ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST = DEFAULT_CONTEXT_FILENAME;
// Mock the entire fs/promises module
vi.mock('fs/promises');
// Mock the parts of fsSync we might use (like constants or existsSync if needed)
vi.mock('fs', async (importOriginal) => {
const actual = await importOriginal();
return {
...actual, // Spread actual to get all exports, including Stats and Dirent if they are classes/constructors
constants: { ...actual.constants }, // Preserve constants
};
});
vi.mock('os');
describe('loadServerHierarchicalMemory', () => {
const mockFs = fsPromises;
const mockOs = os;
const CWD = '/test/project/src';
const PROJECT_ROOT = '/test/project';
const USER_HOME = '/test/userhome';
let GLOBAL_GEMINI_DIR;
let GLOBAL_GEMINI_FILE; // Defined in beforeEach
const fileService = new FileDiscoveryService(PROJECT_ROOT);
beforeEach(() => {
vi.resetAllMocks();
// Set environment variables to indicate test environment
process.env.NODE_ENV = 'test';
process.env.VITEST = 'true';
setGeminiMdFilename(DEFAULT_CONTEXT_FILENAME); // Use defined const
mockOs.homedir.mockReturnValue(USER_HOME);
// Define these here to use potentially reset/updated values from imports
GLOBAL_GEMINI_DIR = path.join(USER_HOME, GEMINI_CONFIG_DIR);
GLOBAL_GEMINI_FILE = path.join(GLOBAL_GEMINI_DIR, getCurrentGeminiMdFilename());
mockFs.stat.mockRejectedValue(new Error('File not found'));
mockFs.readdir.mockResolvedValue([]);
mockFs.readFile.mockRejectedValue(new Error('File not found'));
mockFs.access.mockRejectedValue(new Error('File not found'));
});
it('should return empty memory and count if no context files are found', async () => {
const { memoryContent, fileCount } = await loadServerHierarchicalMemory(CWD, false, fileService);
expect(memoryContent).toBe('');
expect(fileCount).toBe(0);
});
it('should load only the global context file if present and others are not (default filename)', async () => {
const globalDefaultFile = path.join(GLOBAL_GEMINI_DIR, DEFAULT_CONTEXT_FILENAME);
mockFs.access.mockImplementation(async (p) => {
if (p === globalDefaultFile) {
return undefined;
}
throw new Error('File not found');
});
mockFs.readFile.mockImplementation(async (p) => {
if (p === globalDefaultFile) {
return 'Global memory content';
}
throw new Error('File not found');
});
const { memoryContent, fileCount } = await loadServerHierarchicalMemory(CWD, false, fileService);
expect(memoryContent).toBe(`--- Context from: ${path.relative(CWD, globalDefaultFile)} ---\nGlobal memory content\n--- End of Context from: ${path.relative(CWD, globalDefaultFile)} ---`);
expect(fileCount).toBe(1);
expect(mockFs.readFile).toHaveBeenCalledWith(globalDefaultFile, 'utf-8');
});
it('should load only the global custom context file if present and filename is changed', async () => {
const customFilename = 'CUSTOM_AGENTS.md';
setGeminiMdFilename(customFilename);
const globalCustomFile = path.join(GLOBAL_GEMINI_DIR, customFilename);
mockFs.access.mockImplementation(async (p) => {
if (p === globalCustomFile) {
return undefined;
}
throw new Error('File not found');
});
mockFs.readFile.mockImplementation(async (p) => {
if (p === globalCustomFile) {
return 'Global custom memory';
}
throw new Error('File not found');
});
const { memoryContent, fileCount } = await loadServerHierarchicalMemory(CWD, false, fileService);
expect(memoryContent).toBe(`--- Context from: ${path.relative(CWD, globalCustomFile)} ---\nGlobal custom memory\n--- End of Context from: ${path.relative(CWD, globalCustomFile)} ---`);
expect(fileCount).toBe(1);
expect(mockFs.readFile).toHaveBeenCalledWith(globalCustomFile, 'utf-8');
});
it('should load context files by upward traversal with custom filename', async () => {
const customFilename = 'PROJECT_CONTEXT.md';
setGeminiMdFilename(customFilename);
const projectRootCustomFile = path.join(PROJECT_ROOT, customFilename);
const srcCustomFile = path.join(CWD, customFilename);
mockFs.stat.mockImplementation(async (p) => {
if (p === path.join(PROJECT_ROOT, '.git')) {
return { isDirectory: () => true };
}
throw new Error('File not found');
});
mockFs.access.mockImplementation(async (p) => {
if (p === projectRootCustomFile || p === srcCustomFile) {
return undefined;
}
throw new Error('File not found');
});
mockFs.readFile.mockImplementation(async (p) => {
if (p === projectRootCustomFile) {
return 'Project root custom memory';
}
if (p === srcCustomFile) {
return 'Src directory custom memory';
}
throw new Error('File not found');
});
const { memoryContent, fileCount } = await loadServerHierarchicalMemory(CWD, false, fileService);
const expectedContent = `--- Context from: ${path.relative(CWD, projectRootCustomFile)} ---\nProject root custom memory\n--- End of Context from: ${path.relative(CWD, projectRootCustomFile)} ---\n\n` +
`--- Context from: ${customFilename} ---\nSrc directory custom memory\n--- End of Context from: ${customFilename} ---`;
expect(memoryContent).toBe(expectedContent);
expect(fileCount).toBe(2);
expect(mockFs.readFile).toHaveBeenCalledWith(projectRootCustomFile, 'utf-8');
expect(mockFs.readFile).toHaveBeenCalledWith(srcCustomFile, 'utf-8');
});
it('should load context files by downward traversal with custom filename', async () => {
const customFilename = 'LOCAL_CONTEXT.md';
setGeminiMdFilename(customFilename);
const subDir = path.join(CWD, 'subdir');
const subDirCustomFile = path.join(subDir, customFilename);
const cwdCustomFile = path.join(CWD, customFilename);
mockFs.access.mockImplementation(async (p) => {
if (p === cwdCustomFile || p === subDirCustomFile)
return undefined;
throw new Error('File not found');
});
mockFs.readFile.mockImplementation(async (p) => {
if (p === cwdCustomFile)
return 'CWD custom memory';
if (p === subDirCustomFile)
return 'Subdir custom memory';
throw new Error('File not found');
});
mockFs.readdir.mockImplementation((async (p) => {
if (p === CWD) {
return [
{
name: customFilename,
isFile: () => true,
isDirectory: () => false,
},
{
name: 'subdir',
isFile: () => false,
isDirectory: () => true,
},
];
}
if (p === subDir) {
return [
{
name: customFilename,
isFile: () => true,
isDirectory: () => false,
},
];
}
return [];
}));
const { memoryContent, fileCount } = await loadServerHierarchicalMemory(CWD, false, fileService);
const expectedContent = `--- Context from: ${customFilename} ---\nCWD custom memory\n--- End of Context from: ${customFilename} ---\n\n` +
`--- Context from: ${path.join('subdir', customFilename)} ---\nSubdir custom memory\n--- End of Context from: ${path.join('subdir', customFilename)} ---`;
expect(memoryContent).toBe(expectedContent);
expect(fileCount).toBe(2);
});
it('should load ORIGINAL_GEMINI_MD_FILENAME files by upward traversal from CWD to project root', async () => {
const projectRootGeminiFile = path.join(PROJECT_ROOT, ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST);
const srcGeminiFile = path.join(CWD, ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST);
mockFs.stat.mockImplementation(async (p) => {
if (p === path.join(PROJECT_ROOT, '.git')) {
return { isDirectory: () => true };
}
throw new Error('File not found');
});
mockFs.access.mockImplementation(async (p) => {
if (p === projectRootGeminiFile || p === srcGeminiFile) {
return undefined;
}
throw new Error('File not found');
});
mockFs.readFile.mockImplementation(async (p) => {
if (p === projectRootGeminiFile) {
return 'Project root memory';
}
if (p === srcGeminiFile) {
return 'Src directory memory';
}
throw new Error('File not found');
});
const { memoryContent, fileCount } = await loadServerHierarchicalMemory(CWD, false, fileService);
const expectedContent = `--- Context from: ${path.relative(CWD, projectRootGeminiFile)} ---\nProject root memory\n--- End of Context from: ${path.relative(CWD, projectRootGeminiFile)} ---\n\n` +
`--- Context from: ${ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST} ---\nSrc directory memory\n--- End of Context from: ${ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST} ---`;
expect(memoryContent).toBe(expectedContent);
expect(fileCount).toBe(2);
expect(mockFs.readFile).toHaveBeenCalledWith(projectRootGeminiFile, 'utf-8');
expect(mockFs.readFile).toHaveBeenCalledWith(srcGeminiFile, 'utf-8');
});
it('should load ORIGINAL_GEMINI_MD_FILENAME files by downward traversal from CWD', async () => {
const subDir = path.join(CWD, 'subdir');
const subDirGeminiFile = path.join(subDir, ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST);
const cwdGeminiFile = path.join(CWD, ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST);
mockFs.access.mockImplementation(async (p) => {
if (p === cwdGeminiFile || p === subDirGeminiFile)
return undefined;
throw new Error('File not found');
});
mockFs.readFile.mockImplementation(async (p) => {
if (p === cwdGeminiFile)
return 'CWD memory';
if (p === subDirGeminiFile)
return 'Subdir memory';
throw new Error('File not found');
});
mockFs.readdir.mockImplementation((async (p) => {
if (p === CWD) {
return [
{
name: ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST,
isFile: () => true,
isDirectory: () => false,
},
{
name: 'subdir',
isFile: () => false,
isDirectory: () => true,
},
];
}
if (p === subDir) {
return [
{
name: ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST,
isFile: () => true,
isDirectory: () => false,
},
];
}
return [];
}));
const { memoryContent, fileCount } = await loadServerHierarchicalMemory(CWD, false, fileService);
const expectedContent = `--- Context from: ${ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST} ---\nCWD memory\n--- End of Context from: ${ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST} ---\n\n` +
`--- Context from: ${path.join('subdir', ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST)} ---\nSubdir memory\n--- End of Context from: ${path.join('subdir', ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST)} ---`;
expect(memoryContent).toBe(expectedContent);
expect(fileCount).toBe(2);
});
it('should load and correctly order global, upward, and downward ORIGINAL_GEMINI_MD_FILENAME files', async () => {
setGeminiMdFilename(ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST); // Explicitly set for this test
const globalFileToUse = path.join(GLOBAL_GEMINI_DIR, ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST);
const projectParentDir = path.dirname(PROJECT_ROOT);
const projectParentGeminiFile = path.join(projectParentDir, ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST);
const projectRootGeminiFile = path.join(PROJECT_ROOT, ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST);
const cwdGeminiFile = path.join(CWD, ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST);
const subDir = path.join(CWD, 'sub');
const subDirGeminiFile = path.join(subDir, ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST);
mockFs.stat.mockImplementation(async (p) => {
if (p === path.join(PROJECT_ROOT, '.git')) {
return { isDirectory: () => true };
}
else if (p === path.join(PROJECT_ROOT, '.gemini')) {
return { isDirectory: () => true };
}
throw new Error('File not found');
});
mockFs.access.mockImplementation(async (p) => {
if (p === globalFileToUse || // Use the dynamically set global file path
p === projectParentGeminiFile ||
p === projectRootGeminiFile ||
p === cwdGeminiFile ||
p === subDirGeminiFile) {
return undefined;
}
throw new Error('File not found');
});
mockFs.readFile.mockImplementation(async (p) => {
if (p === globalFileToUse)
return 'Global memory'; // Use the dynamically set global file path
if (p === projectParentGeminiFile)
return 'Project parent memory';
if (p === projectRootGeminiFile)
return 'Project root memory';
if (p === cwdGeminiFile)
return 'CWD memory';
if (p === subDirGeminiFile)
return 'Subdir memory';
throw new Error('File not found');
});
mockFs.readdir.mockImplementation((async (p) => {
if (p === CWD) {
return [
{
name: 'sub',
isFile: () => false,
isDirectory: () => true,
},
];
}
if (p === subDir) {
return [
{
name: ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST,
isFile: () => true,
isDirectory: () => false,
},
];
}
return [];
}));
const { memoryContent, fileCount } = await loadServerHierarchicalMemory(CWD, false, fileService);
const relPathGlobal = path.relative(CWD, GLOBAL_GEMINI_FILE);
const relPathProjectParent = path.relative(CWD, projectParentGeminiFile);
const relPathProjectRoot = path.relative(CWD, projectRootGeminiFile);
const relPathCwd = ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST;
const relPathSubDir = path.join('sub', ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST);
const expectedContent = [
`--- Context from: ${relPathGlobal} ---\nGlobal memory\n--- End of Context from: ${relPathGlobal} ---`,
`--- Context from: ${relPathProjectParent} ---\nProject parent memory\n--- End of Context from: ${relPathProjectParent} ---`,
`--- Context from: ${relPathProjectRoot} ---\nProject root memory\n--- End of Context from: ${relPathProjectRoot} ---`,
`--- Context from: ${relPathCwd} ---\nCWD memory\n--- End of Context from: ${relPathCwd} ---`,
`--- Context from: ${relPathSubDir} ---\nSubdir memory\n--- End of Context from: ${relPathSubDir} ---`,
].join('\n\n');
expect(memoryContent).toBe(expectedContent);
expect(fileCount).toBe(5);
});
it('should ignore specified directories during downward scan', async () => {
const ignoredDir = path.join(CWD, 'node_modules');
const ignoredDirGeminiFile = path.join(ignoredDir, ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST); // Corrected
const regularSubDir = path.join(CWD, 'my_code');
const regularSubDirGeminiFile = path.join(regularSubDir, ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST);
mockFs.access.mockImplementation(async (p) => {
if (p === regularSubDirGeminiFile)
return undefined;
if (p === ignoredDirGeminiFile)
throw new Error('Should not access ignored file');
throw new Error('File not found');
});
mockFs.readFile.mockImplementation(async (p) => {
if (p === regularSubDirGeminiFile)
return 'My code memory';
throw new Error('File not found');
});
mockFs.readdir.mockImplementation((async (p) => {
if (p === CWD) {
return [
{
name: 'node_modules',
isFile: () => false,
isDirectory: () => true,
},
{
name: 'my_code',
isFile: () => false,
isDirectory: () => true,
},
];
}
if (p === regularSubDir) {
return [
{
name: ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST,
isFile: () => true,
isDirectory: () => false,
},
];
}
if (p === ignoredDir) {
return [];
}
return [];
}));
const { memoryContent, fileCount } = await loadServerHierarchicalMemory(CWD, false, fileService);
const expectedContent = `--- Context from: ${path.join('my_code', ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST)} ---\nMy code memory\n--- End of Context from: ${path.join('my_code', ORIGINAL_GEMINI_MD_FILENAME_CONST_FOR_TEST)} ---`;
expect(memoryContent).toBe(expectedContent);
expect(fileCount).toBe(1);
expect(mockFs.readFile).not.toHaveBeenCalledWith(ignoredDirGeminiFile, 'utf-8');
});
it('should respect MAX_DIRECTORIES_TO_SCAN_FOR_MEMORY during downward scan', async () => {
const consoleDebugSpy = vi
.spyOn(console, 'debug')
.mockImplementation(() => { });
const dirNames = [];
for (let i = 0; i < 250; i++) {
dirNames.push({
name: `deep_dir_${i}`,
isFile: () => false,
isDirectory: () => true,
});
}
mockFs.readdir.mockImplementation((async (p) => {
if (p === CWD)
return dirNames;
if (p.toString().startsWith(path.join(CWD, 'deep_dir_')))
return [];
return [];
}));
mockFs.access.mockRejectedValue(new Error('not found'));
await loadServerHierarchicalMemory(CWD, true, fileService);
expect(consoleDebugSpy).toHaveBeenCalledWith(expect.stringContaining('[DEBUG] [BfsFileSearch]'), expect.stringContaining('Scanning [200/200]:'));
consoleDebugSpy.mockRestore();
});
it('should load extension context file paths', async () => {
const extensionFilePath = '/test/extensions/ext1/GEMINI.md';
mockFs.access.mockImplementation(async (p) => {
if (p === extensionFilePath) {
return undefined;
}
throw new Error('File not found');
});
mockFs.readFile.mockImplementation(async (p) => {
if (p === extensionFilePath) {
return 'Extension memory content';
}
throw new Error('File not found');
});
const { memoryContent, fileCount } = await loadServerHierarchicalMemory(CWD, false, fileService, [extensionFilePath]);
expect(memoryContent).toBe(`--- Context from: ${path.relative(CWD, extensionFilePath)} ---\nExtension memory content\n--- End of Context from: ${path.relative(CWD, extensionFilePath)} ---`);
expect(fileCount).toBe(1);
expect(mockFs.readFile).toHaveBeenCalledWith(extensionFilePath, 'utf-8');
});
});
//# sourceMappingURL=memoryDiscovery.test.js.map