Files
gemini-cli/packages/core/src/utils/memoryDiscovery.test.ts

1258 lines
40 KiB
TypeScript

/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { vi, describe, it, expect, beforeEach, afterEach } from 'vitest';
import * as fsPromises from 'node:fs/promises';
import * as os from 'node:os';
import * as path from 'node:path';
import {
loadServerHierarchicalMemory,
getGlobalMemoryPaths,
getExtensionMemoryPaths,
getEnvironmentMemoryPaths,
loadJitSubdirectoryMemory,
refreshServerHierarchicalMemory,
} from './memoryDiscovery.js';
import {
setGeminiMdFilename,
DEFAULT_CONTEXT_FILENAME,
} from '../tools/memoryTool.js';
import { flattenMemory, type HierarchicalMemory } from '../config/memory.js';
import { FileDiscoveryService } from '../services/fileDiscoveryService.js';
import { GEMINI_DIR, normalizePath, homedir as pathsHomedir } from './paths.js';
function flattenResult(result: {
memoryContent: HierarchicalMemory;
fileCount: number;
filePaths: string[];
}) {
return {
...result,
memoryContent: flattenMemory(result.memoryContent),
filePaths: result.filePaths.map((p) => normalizePath(p)),
};
}
import { Config, type GeminiCLIExtension } from '../config/config.js';
import { Storage } from '../config/storage.js';
import { SimpleExtensionLoader } from './extensionLoader.js';
import { CoreEvent, coreEvents } from './events.js';
vi.mock('os', async (importOriginal) => {
const actualOs = await importOriginal<typeof os>();
return {
...actualOs,
homedir: vi.fn(),
};
});
vi.mock('../utils/paths.js', async (importOriginal) => {
const actual = await importOriginal<typeof import('../utils/paths.js')>();
return {
...actual,
normalizePath: (p: string) => {
const resolved = path.resolve(p);
return process.platform === 'win32' ? resolved.toLowerCase() : resolved;
},
homedir: vi.fn(),
};
});
describe('memoryDiscovery', () => {
const DEFAULT_FOLDER_TRUST = true;
let testRootDir: string;
let cwd: string;
let projectRoot: string;
let homedir: string;
async function createEmptyDir(fullPath: string) {
await fsPromises.mkdir(fullPath, { recursive: true });
return normalizePath(fullPath);
}
async function createTestFile(fullPath: string, fileContents: string) {
await fsPromises.mkdir(path.dirname(fullPath), { recursive: true });
await fsPromises.writeFile(fullPath, fileContents);
return normalizePath(path.resolve(testRootDir, fullPath));
}
beforeEach(async () => {
testRootDir = normalizePath(
await fsPromises.mkdtemp(
path.join(os.tmpdir(), 'folder-structure-test-'),
),
);
vi.resetAllMocks();
// Set environment variables to indicate test environment
vi.stubEnv('NODE_ENV', 'test');
vi.stubEnv('VITEST', 'true');
projectRoot = await createEmptyDir(path.join(testRootDir, 'project'));
cwd = await createEmptyDir(path.join(projectRoot, 'src'));
homedir = await createEmptyDir(path.join(testRootDir, 'userhome'));
vi.mocked(os.homedir).mockReturnValue(homedir);
vi.mocked(pathsHomedir).mockReturnValue(homedir);
});
const normMarker = (p: string) =>
process.platform === 'win32' ? p.toLowerCase() : p;
afterEach(async () => {
vi.unstubAllEnvs();
// Some tests set this to a different value.
setGeminiMdFilename(DEFAULT_CONTEXT_FILENAME);
// Clean up the temporary directory to prevent resource leaks.
// Use maxRetries option for robust cleanup without race conditions
await fsPromises.rm(testRootDir, {
recursive: true,
force: true,
maxRetries: 3,
retryDelay: 10,
});
});
describe('when untrusted', () => {
it('does not load context files from untrusted workspaces', async () => {
await createTestFile(
path.join(projectRoot, DEFAULT_CONTEXT_FILENAME),
'Project root memory',
);
await createTestFile(
path.join(cwd, DEFAULT_CONTEXT_FILENAME),
'Src directory memory',
);
const result = flattenResult(
await loadServerHierarchicalMemory(
cwd,
[],
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
false, // untrusted
),
);
expect(result).toEqual({
memoryContent: '',
fileCount: 0,
filePaths: [],
});
});
it('loads context from outside the untrusted workspace', async () => {
await createTestFile(
path.join(projectRoot, DEFAULT_CONTEXT_FILENAME),
'Project root memory', // Untrusted
);
await createTestFile(
path.join(cwd, DEFAULT_CONTEXT_FILENAME),
'Src directory memory', // Untrusted
);
const filepathInput = path.join(
homedir,
GEMINI_DIR,
DEFAULT_CONTEXT_FILENAME,
);
const filepath = await createTestFile(
filepathInput,
'default context content',
); // In user home dir (outside untrusted space).
const { fileCount, memoryContent, filePaths } = flattenResult(
await loadServerHierarchicalMemory(
cwd,
[],
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
false, // untrusted
),
);
expect(fileCount).toEqual(1);
expect(memoryContent).toContain(path.relative(cwd, filepath).toString());
expect(filePaths).toEqual([filepath]);
});
});
it('should return empty memory and count if no context files are found', async () => {
const result = flattenResult(
await loadServerHierarchicalMemory(
cwd,
[],
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
DEFAULT_FOLDER_TRUST,
),
);
expect(result).toEqual({
memoryContent: '',
fileCount: 0,
filePaths: [],
});
});
it('should load only the global context file if present and others are not (default filename)', async () => {
const defaultContextFile = await createTestFile(
path.join(homedir, GEMINI_DIR, DEFAULT_CONTEXT_FILENAME),
'default context content',
);
const result = flattenResult(
await loadServerHierarchicalMemory(
cwd,
[],
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
DEFAULT_FOLDER_TRUST,
),
);
expect({
...result,
memoryContent: flattenMemory(result.memoryContent),
}).toEqual({
memoryContent: `--- Global ---
--- Context from: ${path.relative(cwd, defaultContextFile)} ---
default context content
--- End of Context from: ${path.relative(cwd, defaultContextFile)} ---`,
fileCount: 1,
filePaths: [defaultContextFile],
});
});
it('should load only the global custom context file if present and filename is changed', async () => {
const customFilename = 'CUSTOM_AGENTS.md';
setGeminiMdFilename(customFilename);
const customContextFile = await createTestFile(
path.join(homedir, GEMINI_DIR, customFilename),
'custom context content',
);
const result = flattenResult(
await loadServerHierarchicalMemory(
cwd,
[],
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
DEFAULT_FOLDER_TRUST,
),
);
expect(result).toEqual({
memoryContent: `--- Global ---
--- Context from: ${normMarker(path.relative(cwd, customContextFile))} ---
custom context content
--- End of Context from: ${normMarker(path.relative(cwd, customContextFile))} ---`,
fileCount: 1,
filePaths: [customContextFile],
});
});
it('should load context files by upward traversal with custom filename', async () => {
const customFilename = 'PROJECT_CONTEXT.md';
setGeminiMdFilename(customFilename);
const projectContextFile = await createTestFile(
path.join(projectRoot, customFilename),
'project context content',
);
const cwdContextFile = await createTestFile(
path.join(cwd, customFilename),
'cwd context content',
);
const result = flattenResult(
await loadServerHierarchicalMemory(
cwd,
[],
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
DEFAULT_FOLDER_TRUST,
),
);
expect(result).toEqual({
memoryContent: `--- Project ---
--- Context from: ${normMarker(path.relative(cwd, projectContextFile))} ---
project context content
--- End of Context from: ${normMarker(path.relative(cwd, projectContextFile))} ---
--- Context from: ${normMarker(path.relative(cwd, cwdContextFile))} ---
cwd context content
--- End of Context from: ${normMarker(path.relative(cwd, cwdContextFile))} ---`,
fileCount: 2,
filePaths: [projectContextFile, cwdContextFile],
});
});
it('should load context files by downward traversal with custom filename', async () => {
const customFilename = 'LOCAL_CONTEXT.md';
setGeminiMdFilename(customFilename);
const subdirCustomFile = await createTestFile(
path.join(cwd, 'subdir', customFilename),
'Subdir custom memory',
);
const cwdCustomFile = await createTestFile(
path.join(cwd, customFilename),
'CWD custom memory',
);
const result = flattenResult(
await loadServerHierarchicalMemory(
cwd,
[],
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
DEFAULT_FOLDER_TRUST,
),
);
expect(result).toEqual({
memoryContent: `--- Project ---
--- Context from: ${normMarker(customFilename)} ---
CWD custom memory
--- End of Context from: ${normMarker(customFilename)} ---
--- Context from: ${normMarker(path.join('subdir', customFilename))} ---
Subdir custom memory
--- End of Context from: ${normMarker(path.join('subdir', customFilename))} ---`,
fileCount: 2,
filePaths: [cwdCustomFile, subdirCustomFile],
});
});
it('should load ORIGINAL_GEMINI_MD_FILENAME files by upward traversal from CWD to project root', async () => {
const projectRootGeminiFile = await createTestFile(
path.join(projectRoot, DEFAULT_CONTEXT_FILENAME),
'Project root memory',
);
const srcGeminiFile = await createTestFile(
path.join(cwd, DEFAULT_CONTEXT_FILENAME),
'Src directory memory',
);
const result = flattenResult(
await loadServerHierarchicalMemory(
cwd,
[],
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
DEFAULT_FOLDER_TRUST,
),
);
expect(result).toEqual({
memoryContent: `--- Project ---
--- Context from: ${normMarker(path.relative(cwd, projectRootGeminiFile))} ---
Project root memory
--- End of Context from: ${normMarker(path.relative(cwd, projectRootGeminiFile))} ---
--- Context from: ${normMarker(path.relative(cwd, srcGeminiFile))} ---
Src directory memory
--- End of Context from: ${normMarker(path.relative(cwd, srcGeminiFile))} ---`,
fileCount: 2,
filePaths: [projectRootGeminiFile, srcGeminiFile],
});
});
it('should load ORIGINAL_GEMINI_MD_FILENAME files by downward traversal from CWD', async () => {
const subDirGeminiFile = await createTestFile(
path.join(cwd, 'subdir', DEFAULT_CONTEXT_FILENAME),
'Subdir memory',
);
const cwdGeminiFile = await createTestFile(
path.join(cwd, DEFAULT_CONTEXT_FILENAME),
'CWD memory',
);
const result = flattenResult(
await loadServerHierarchicalMemory(
cwd,
[],
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
DEFAULT_FOLDER_TRUST,
),
);
expect(result).toEqual({
memoryContent: `--- Project ---
--- Context from: ${normMarker(DEFAULT_CONTEXT_FILENAME)} ---
CWD memory
--- End of Context from: ${normMarker(DEFAULT_CONTEXT_FILENAME)} ---
--- Context from: ${normMarker(path.join('subdir', DEFAULT_CONTEXT_FILENAME))} ---
Subdir memory
--- End of Context from: ${normMarker(path.join('subdir', DEFAULT_CONTEXT_FILENAME))} ---`,
fileCount: 2,
filePaths: [cwdGeminiFile, subDirGeminiFile],
});
});
it('should load and correctly order global, upward, and downward ORIGINAL_GEMINI_MD_FILENAME files', async () => {
const defaultContextFile = await createTestFile(
path.join(homedir, GEMINI_DIR, DEFAULT_CONTEXT_FILENAME),
'default context content',
);
const rootGeminiFile = await createTestFile(
path.join(testRootDir, DEFAULT_CONTEXT_FILENAME),
'Project parent memory',
);
const projectRootGeminiFile = await createTestFile(
path.join(projectRoot, DEFAULT_CONTEXT_FILENAME),
'Project root memory',
);
const cwdGeminiFile = await createTestFile(
path.join(cwd, DEFAULT_CONTEXT_FILENAME),
'CWD memory',
);
const subDirGeminiFile = await createTestFile(
path.join(cwd, 'sub', DEFAULT_CONTEXT_FILENAME),
'Subdir memory',
);
const result = flattenResult(
await loadServerHierarchicalMemory(
cwd,
[],
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
DEFAULT_FOLDER_TRUST,
),
);
expect(result).toEqual({
memoryContent: `--- Global ---
--- Context from: ${normMarker(path.relative(cwd, defaultContextFile))} ---
default context content
--- End of Context from: ${normMarker(path.relative(cwd, defaultContextFile))} ---
--- Project ---
--- Context from: ${normMarker(path.relative(cwd, rootGeminiFile))} ---
Project parent memory
--- End of Context from: ${normMarker(path.relative(cwd, rootGeminiFile))} ---
--- Context from: ${normMarker(path.relative(cwd, projectRootGeminiFile))} ---
Project root memory
--- End of Context from: ${normMarker(path.relative(cwd, projectRootGeminiFile))} ---
--- Context from: ${normMarker(path.relative(cwd, cwdGeminiFile))} ---
CWD memory
--- End of Context from: ${normMarker(path.relative(cwd, cwdGeminiFile))} ---
--- Context from: ${normMarker(path.relative(cwd, subDirGeminiFile))} ---
Subdir memory
--- End of Context from: ${normMarker(path.relative(cwd, subDirGeminiFile))} ---`,
fileCount: 5,
filePaths: [
defaultContextFile,
rootGeminiFile,
projectRootGeminiFile,
cwdGeminiFile,
subDirGeminiFile,
],
});
});
it('should ignore specified directories during downward scan', async () => {
await createEmptyDir(path.join(projectRoot, '.git'));
await createTestFile(path.join(projectRoot, '.gitignore'), 'node_modules');
await createTestFile(
path.join(cwd, 'node_modules', DEFAULT_CONTEXT_FILENAME),
'Ignored memory',
);
const regularSubDirGeminiFile = await createTestFile(
path.join(cwd, 'my_code', DEFAULT_CONTEXT_FILENAME),
'My code memory',
);
const result = flattenResult(
await loadServerHierarchicalMemory(
cwd,
[],
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
DEFAULT_FOLDER_TRUST,
'tree',
{
respectGitIgnore: true,
respectGeminiIgnore: true,
customIgnoreFilePaths: [],
},
200, // maxDirs parameter
),
);
expect(result).toEqual({
memoryContent: `--- Project ---
--- Context from: ${normMarker(path.relative(cwd, regularSubDirGeminiFile))} ---
My code memory
--- End of Context from: ${normMarker(path.relative(cwd, regularSubDirGeminiFile))} ---`,
fileCount: 1,
filePaths: [regularSubDirGeminiFile],
});
});
it('should respect the maxDirs parameter during downward scan', async () => {
// Create directories in parallel for better performance
const dirPromises = Array.from({ length: 2 }, (_, i) =>
createEmptyDir(path.join(cwd, `deep_dir_${i}`)),
);
await Promise.all(dirPromises);
// Pass the custom limit directly to the function
await loadServerHierarchicalMemory(
cwd,
[],
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
DEFAULT_FOLDER_TRUST,
'tree', // importFormat
{
respectGitIgnore: true,
respectGeminiIgnore: true,
customIgnoreFilePaths: [],
},
1, // maxDirs
);
// Note: bfsFileSearch debug logging is no longer controlled via debugMode parameter
// The test verifies maxDirs is respected by checking the result, not debug logs
const result = flattenResult(
await loadServerHierarchicalMemory(
cwd,
[],
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
DEFAULT_FOLDER_TRUST,
),
);
expect(result).toEqual({
memoryContent: '',
fileCount: 0,
filePaths: [],
});
});
it('should load extension context file paths', async () => {
const extensionFilePath = await createTestFile(
path.join(testRootDir, 'extensions/ext1/GEMINI.md'),
'Extension memory content',
);
const result = flattenResult(
await loadServerHierarchicalMemory(
cwd,
[],
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([
{
contextFiles: [extensionFilePath],
isActive: true,
} as GeminiCLIExtension,
]),
DEFAULT_FOLDER_TRUST,
),
);
expect(result).toEqual({
memoryContent: `--- Extension ---
--- Context from: ${normMarker(path.relative(cwd, extensionFilePath))} ---
Extension memory content
--- End of Context from: ${normMarker(path.relative(cwd, extensionFilePath))} ---`,
fileCount: 1,
filePaths: [extensionFilePath],
});
});
it('should load memory from included directories', async () => {
const includedDir = await createEmptyDir(
path.join(testRootDir, 'included'),
);
const includedFile = await createTestFile(
path.join(includedDir, DEFAULT_CONTEXT_FILENAME),
'included directory memory',
);
const result = flattenResult(
await loadServerHierarchicalMemory(
cwd,
[includedDir],
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
DEFAULT_FOLDER_TRUST,
),
);
expect(result).toEqual({
memoryContent: `--- Project ---
--- Context from: ${normMarker(path.relative(cwd, includedFile))} ---
included directory memory
--- End of Context from: ${normMarker(path.relative(cwd, includedFile))} ---`,
fileCount: 1,
filePaths: [includedFile],
});
});
it('should handle multiple directories and files in parallel correctly', async () => {
// Create multiple test directories with GEMINI.md files
const numDirs = 5;
const createdFiles: string[] = [];
for (let i = 0; i < numDirs; i++) {
const dirPath = await createEmptyDir(
path.join(testRootDir, `project-${i}`),
);
const filePath = await createTestFile(
path.join(dirPath, DEFAULT_CONTEXT_FILENAME),
`Content from project ${i}`,
);
createdFiles.push(filePath);
}
// Load memory from all directories
const result = flattenResult(
await loadServerHierarchicalMemory(
cwd,
createdFiles.map((f) => path.dirname(f)),
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
DEFAULT_FOLDER_TRUST,
),
);
// Should have loaded all files
expect(result.fileCount).toBe(numDirs);
expect(result.filePaths.length).toBe(numDirs);
expect(result.filePaths.sort()).toEqual(createdFiles.sort());
// Content should include all project contents
const flattenedMemory = flattenMemory(result.memoryContent);
for (let i = 0; i < numDirs; i++) {
expect(flattenedMemory).toContain(`Content from project ${i}`);
}
});
it('should preserve order and prevent duplicates when processing multiple directories', async () => {
// Create overlapping directory structure
const parentDir = await createEmptyDir(path.join(testRootDir, 'parent'));
const childDir = await createEmptyDir(path.join(parentDir, 'child'));
const parentFile = await createTestFile(
path.join(parentDir, DEFAULT_CONTEXT_FILENAME),
'Parent content',
);
const childFile = await createTestFile(
path.join(childDir, DEFAULT_CONTEXT_FILENAME),
'Child content',
);
// Include both parent and child directories
const result = flattenResult(
await loadServerHierarchicalMemory(
parentDir,
[childDir, parentDir], // Deliberately include duplicates
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
DEFAULT_FOLDER_TRUST,
),
);
// Should have both files without duplicates
const flattenedMemory = flattenMemory(result.memoryContent);
expect(result.fileCount).toBe(2);
expect(flattenedMemory).toContain('Parent content');
expect(flattenedMemory).toContain('Child content');
expect(result.filePaths.sort()).toEqual([parentFile, childFile].sort());
// Check that files are not duplicated
const parentOccurrences = (flattenedMemory.match(/Parent content/g) || [])
.length;
const childOccurrences = (flattenedMemory.match(/Child content/g) || [])
.length;
expect(parentOccurrences).toBe(1);
expect(childOccurrences).toBe(1);
});
describe('getGlobalMemoryPaths', () => {
it('should find global memory file if it exists', async () => {
const globalMemoryFile = await createTestFile(
path.join(homedir, GEMINI_DIR, DEFAULT_CONTEXT_FILENAME),
'Global memory content',
);
const result = await getGlobalMemoryPaths();
expect(result).toHaveLength(1);
expect(result[0]).toBe(globalMemoryFile);
});
it('should return empty array if global memory file does not exist', async () => {
const result = await getGlobalMemoryPaths();
expect(result).toHaveLength(0);
});
});
describe('getExtensionMemoryPaths', () => {
it('should return active extension context files', async () => {
const extFile = await createTestFile(
path.join(testRootDir, 'ext', 'GEMINI.md'),
'Extension content',
);
const loader = new SimpleExtensionLoader([
{
isActive: true,
contextFiles: [extFile],
} as GeminiCLIExtension,
]);
const result = getExtensionMemoryPaths(loader);
expect(result).toHaveLength(1);
expect(result[0]).toBe(extFile);
});
it('should ignore inactive extensions', async () => {
const extFile = await createTestFile(
path.join(testRootDir, 'ext', 'GEMINI.md'),
'Extension content',
);
const loader = new SimpleExtensionLoader([
{
isActive: false,
contextFiles: [extFile],
} as GeminiCLIExtension,
]);
const result = getExtensionMemoryPaths(loader);
expect(result).toHaveLength(0);
});
});
describe('getEnvironmentMemoryPaths', () => {
it('should NOT traverse upward beyond trusted root (even with .git)', async () => {
// Setup: /temp/parent/repo/.git
const parentDir = await createEmptyDir(path.join(testRootDir, 'parent'));
const repoDir = await createEmptyDir(path.join(parentDir, 'repo'));
await createEmptyDir(path.join(repoDir, '.git'));
const srcDir = await createEmptyDir(path.join(repoDir, 'src'));
await createTestFile(
path.join(parentDir, DEFAULT_CONTEXT_FILENAME),
'Parent content',
);
await createTestFile(
path.join(repoDir, DEFAULT_CONTEXT_FILENAME),
'Repo content',
);
const srcFile = await createTestFile(
path.join(srcDir, DEFAULT_CONTEXT_FILENAME),
'Src content',
);
// Trust srcDir. Should ONLY load srcFile.
// Repo and Parent are NOT trusted.
const result = await getEnvironmentMemoryPaths([srcDir]);
expect(result).toHaveLength(1);
expect(result[0]).toBe(srcFile);
});
it('should NOT traverse upward beyond trusted root (no .git)', async () => {
// Setup: /homedir/docs/notes (no .git anywhere)
const docsDir = await createEmptyDir(path.join(homedir, 'docs'));
const notesDir = await createEmptyDir(path.join(docsDir, 'notes'));
await createTestFile(
path.join(homedir, DEFAULT_CONTEXT_FILENAME),
'Home content',
);
const docsFile = await createTestFile(
path.join(docsDir, DEFAULT_CONTEXT_FILENAME),
'Docs content',
);
// Trust notesDir. Should load NOTHING because notesDir has no file,
// and we do not traverse up to docsDir.
const resultNotes = await getEnvironmentMemoryPaths([notesDir]);
expect(resultNotes).toHaveLength(0);
// Trust docsDir. Should load docsFile, but NOT homeFile.
const resultDocs = await getEnvironmentMemoryPaths([docsDir]);
expect(resultDocs).toHaveLength(1);
expect(resultDocs[0]).toBe(docsFile);
});
it('should deduplicate paths when same root is trusted multiple times', async () => {
const repoDir = await createEmptyDir(path.join(testRootDir, 'repo'));
await createEmptyDir(path.join(repoDir, '.git'));
const repoFile = await createTestFile(
path.join(repoDir, DEFAULT_CONTEXT_FILENAME),
'Repo content',
);
// Trust repoDir twice.
const result = await getEnvironmentMemoryPaths([repoDir, repoDir]);
expect(result).toHaveLength(1);
expect(result[0]).toBe(repoFile);
});
it('should keep multiple memory files from the same directory adjacent and in order', async () => {
// Configure multiple memory filenames
setGeminiMdFilename(['PRIMARY.md', 'SECONDARY.md']);
const dir = await createEmptyDir(
path.join(testRootDir, 'multi_file_dir'),
);
await createEmptyDir(path.join(dir, '.git'));
const primaryFile = await createTestFile(
path.join(dir, 'PRIMARY.md'),
'Primary content',
);
const secondaryFile = await createTestFile(
path.join(dir, 'SECONDARY.md'),
'Secondary content',
);
const result = await getEnvironmentMemoryPaths([dir]);
expect(result).toHaveLength(2);
// Verify order: PRIMARY should come before SECONDARY because they are
// sorted by path and PRIMARY.md comes before SECONDARY.md alphabetically
// if in same dir.
expect(result[0]).toBe(primaryFile);
expect(result[1]).toBe(secondaryFile);
});
});
describe('case-insensitive filesystem deduplication', () => {
it('should deduplicate files that point to the same inode (same physical file)', async () => {
const geminiFile = await createTestFile(
path.join(projectRoot, 'gemini.md'),
'Project root memory',
);
// create hard link to simulate case-insensitive filesystem behavior
const geminiFileLink = path.join(projectRoot, 'GEMINI.md');
try {
await fsPromises.link(geminiFile, geminiFileLink);
} catch (error) {
const errorMessage =
error instanceof Error ? error.message : String(error);
if (
errorMessage.includes('cross-device') ||
errorMessage.includes('EXDEV') ||
errorMessage.includes('EEXIST')
) {
return;
}
throw error;
}
const stats1 = await fsPromises.lstat(geminiFile);
const stats2 = await fsPromises.lstat(geminiFileLink);
expect(stats1.ino).toBe(stats2.ino);
expect(stats1.dev).toBe(stats2.dev);
setGeminiMdFilename(['GEMINI.md', 'gemini.md']);
const result = flattenResult(
await loadServerHierarchicalMemory(
cwd,
[],
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
DEFAULT_FOLDER_TRUST,
),
);
expect(result.fileCount).toBe(1);
expect(result.filePaths).toHaveLength(1);
expect(result.memoryContent).toContain('Project root memory');
const contentMatches = result.memoryContent.match(/Project root memory/g);
expect(contentMatches).toHaveLength(1);
try {
await fsPromises.unlink(geminiFileLink);
} catch {
// ignore cleanup errors
}
});
it('should handle case where files have different inodes (different files)', async () => {
const geminiFileLower = await createTestFile(
path.join(projectRoot, 'gemini.md'),
'Lowercase file content',
);
const geminiFileUpper = await createTestFile(
path.join(projectRoot, 'GEMINI.md'),
'Uppercase file content',
);
const stats1 = await fsPromises.lstat(geminiFileLower);
const stats2 = await fsPromises.lstat(geminiFileUpper);
if (stats1.ino !== stats2.ino || stats1.dev !== stats2.dev) {
setGeminiMdFilename(['GEMINI.md', 'gemini.md']);
const result = flattenResult(
await loadServerHierarchicalMemory(
cwd,
[],
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
DEFAULT_FOLDER_TRUST,
),
);
expect(result.fileCount).toBe(2);
expect(result.filePaths).toHaveLength(2);
expect(result.memoryContent).toContain('Lowercase file content');
expect(result.memoryContent).toContain('Uppercase file content');
}
});
it("should handle files that cannot be stat'd (missing files)", async () => {
await createTestFile(
path.join(projectRoot, 'gemini.md'),
'Valid file content',
);
setGeminiMdFilename(['gemini.md', 'missing.md']);
const result = flattenResult(
await loadServerHierarchicalMemory(
cwd,
[],
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
DEFAULT_FOLDER_TRUST,
),
);
expect(result.fileCount).toBe(1);
expect(result.memoryContent).toContain('Valid file content');
});
it('should deduplicate multiple paths pointing to same file (3+ duplicates)', async () => {
const geminiFile = await createTestFile(
path.join(projectRoot, 'gemini.md'),
'Project root memory',
);
const link1 = path.join(projectRoot, 'GEMINI.md');
const link2 = path.join(projectRoot, 'Gemini.md');
try {
await fsPromises.link(geminiFile, link1);
await fsPromises.link(geminiFile, link2);
} catch (error) {
const errorMessage =
error instanceof Error ? error.message : String(error);
if (
errorMessage.includes('cross-device') ||
errorMessage.includes('EXDEV') ||
errorMessage.includes('EEXIST')
) {
return;
}
throw error;
}
const stats1 = await fsPromises.lstat(geminiFile);
const stats2 = await fsPromises.lstat(link1);
const stats3 = await fsPromises.lstat(link2);
expect(stats1.ino).toBe(stats2.ino);
expect(stats1.ino).toBe(stats3.ino);
setGeminiMdFilename(['gemini.md', 'GEMINI.md', 'Gemini.md']);
const result = flattenResult(
await loadServerHierarchicalMemory(
cwd,
[],
new FileDiscoveryService(projectRoot),
new SimpleExtensionLoader([]),
DEFAULT_FOLDER_TRUST,
),
);
expect(result.fileCount).toBe(1);
expect(result.filePaths).toHaveLength(1);
expect(result.memoryContent).toContain('Project root memory');
const contentMatches = result.memoryContent.match(/Project root memory/g);
expect(contentMatches).toHaveLength(1);
try {
await fsPromises.unlink(link1);
await fsPromises.unlink(link2);
} catch {
// ignore cleanup errors
}
});
});
describe('loadJitSubdirectoryMemory', () => {
it('should load JIT memory when target is inside a trusted root', async () => {
const rootDir = await createEmptyDir(path.join(testRootDir, 'jit_root'));
const subDir = await createEmptyDir(path.join(rootDir, 'subdir'));
const targetFile = path.join(subDir, 'target.txt');
const subDirMemory = await createTestFile(
path.join(subDir, DEFAULT_CONTEXT_FILENAME),
'Subdir JIT content',
);
const result = await loadJitSubdirectoryMemory(
targetFile,
[rootDir],
new Set(),
);
expect(result.files).toHaveLength(1);
expect(result.files[0].path).toBe(subDirMemory);
expect(result.files[0].content).toBe('Subdir JIT content');
});
it('should skip JIT memory when target is outside trusted roots', async () => {
const trustedRoot = await createEmptyDir(
path.join(testRootDir, 'trusted'),
);
const untrustedDir = await createEmptyDir(
path.join(testRootDir, 'untrusted'),
);
const targetFile = path.join(untrustedDir, 'target.txt');
await createTestFile(
path.join(untrustedDir, DEFAULT_CONTEXT_FILENAME),
'Untrusted content',
);
const result = await loadJitSubdirectoryMemory(
targetFile,
[trustedRoot],
new Set(),
);
expect(result.files).toHaveLength(0);
});
it('should skip already loaded paths', async () => {
const rootDir = await createEmptyDir(path.join(testRootDir, 'jit_root'));
const subDir = await createEmptyDir(path.join(rootDir, 'subdir'));
const targetFile = path.join(subDir, 'target.txt');
const rootMemory = await createTestFile(
path.join(rootDir, DEFAULT_CONTEXT_FILENAME),
'Root content',
);
const subDirMemory = await createTestFile(
path.join(subDir, DEFAULT_CONTEXT_FILENAME),
'Subdir content',
);
// Simulate root memory already loaded (e.g., by loadEnvironmentMemory)
const alreadyLoaded = new Set([rootMemory]);
const result = await loadJitSubdirectoryMemory(
targetFile,
[rootDir],
alreadyLoaded,
);
expect(result.files).toHaveLength(1);
expect(result.files[0].path).toBe(subDirMemory);
expect(result.files[0].content).toBe('Subdir content');
});
it('should deduplicate files in JIT memory loading (same inode)', async () => {
const rootDir = await createEmptyDir(path.join(testRootDir, 'jit_root'));
const subDir = await createEmptyDir(path.join(rootDir, 'subdir'));
const targetFile = path.join(subDir, 'target.txt');
const geminiFile = await createTestFile(
path.join(subDir, 'gemini.md'),
'JIT memory content',
);
const geminiFileLink = path.join(subDir, 'GEMINI.md');
try {
await fsPromises.link(geminiFile, geminiFileLink);
} catch (error) {
const errorMessage =
error instanceof Error ? error.message : String(error);
if (
errorMessage.includes('cross-device') ||
errorMessage.includes('EXDEV') ||
errorMessage.includes('EEXIST')
) {
return;
}
throw error;
}
const stats1 = await fsPromises.lstat(geminiFile);
const stats2 = await fsPromises.lstat(geminiFileLink);
expect(stats1.ino).toBe(stats2.ino);
setGeminiMdFilename(['gemini.md', 'GEMINI.md']);
const result = await loadJitSubdirectoryMemory(
targetFile,
[rootDir],
new Set(),
);
expect(result.files).toHaveLength(1);
expect(result.files[0].content).toBe('JIT memory content');
const contentMatches =
result.files[0].content.match(/JIT memory content/g);
expect(contentMatches).toHaveLength(1);
try {
await fsPromises.unlink(geminiFileLink);
} catch {
// ignore cleanup errors
}
});
it('should use the deepest trusted root when multiple nested roots exist', async () => {
const outerRoot = await createEmptyDir(path.join(testRootDir, 'outer'));
const innerRoot = await createEmptyDir(path.join(outerRoot, 'inner'));
const targetFile = path.join(innerRoot, 'target.txt');
const outerMemory = await createTestFile(
path.join(outerRoot, DEFAULT_CONTEXT_FILENAME),
'Outer content',
);
const innerMemory = await createTestFile(
path.join(innerRoot, DEFAULT_CONTEXT_FILENAME),
'Inner content',
);
const result = await loadJitSubdirectoryMemory(
targetFile,
[outerRoot, innerRoot],
new Set(),
);
expect(result.files).toHaveLength(1);
expect(result.files[0].path).toBe(innerMemory);
expect(result.files[0].content).toBe('Inner content');
// Ensure outer memory is NOT loaded
expect(result.files.find((f) => f.path === outerMemory)).toBeUndefined();
});
});
it('refreshServerHierarchicalMemory should refresh memory and update config', async () => {
const extensionLoader = new SimpleExtensionLoader([]);
const config = new Config({
sessionId: '1',
targetDir: cwd,
cwd,
debugMode: false,
model: 'fake-model',
extensionLoader,
});
const result = flattenResult(
await loadServerHierarchicalMemory(
config.getWorkingDir(),
config.shouldLoadMemoryFromIncludeDirectories()
? config.getWorkspaceContext().getDirectories()
: [],
config.getFileService(),
config.getExtensionLoader(),
config.isTrustedFolder(),
config.getImportFormat(),
),
);
expect(result.fileCount).equals(0);
// Now add an extension with a memory file
const extensionsDir = new Storage(homedir).getExtensionsDir();
const extensionPath = path.join(extensionsDir, 'new-extension');
const contextFilePath = path.join(extensionPath, 'CustomContext.md');
await fsPromises.mkdir(extensionPath, { recursive: true });
await fsPromises.writeFile(contextFilePath, 'Really cool custom context!');
await extensionLoader.loadExtension({
name: 'new-extension',
isActive: true,
contextFiles: [contextFilePath],
version: '1.0.0',
id: '1234',
path: extensionPath,
});
const mockEventListener = vi.fn();
coreEvents.on(CoreEvent.MemoryChanged, mockEventListener);
const refreshResult = await refreshServerHierarchicalMemory(config);
expect(refreshResult.fileCount).equals(1);
expect(config.getGeminiMdFileCount()).equals(refreshResult.fileCount);
const flattenedMemory = flattenMemory(refreshResult.memoryContent);
expect(flattenedMemory).toContain('Really cool custom context!');
expect(config.getUserMemory()).toStrictEqual(refreshResult.memoryContent);
expect(refreshResult.filePaths[0]).toContain(
normMarker(path.join(extensionPath, 'CustomContext.md')),
);
expect(config.getGeminiMdFilePaths()).equals(refreshResult.filePaths);
expect(mockEventListener).toHaveBeenCalledExactlyOnceWith({
fileCount: refreshResult.fileCount,
});
});
it('should include MCP instructions in user memory', async () => {
const mockConfig = {
getWorkingDir: vi.fn().mockReturnValue(cwd),
shouldLoadMemoryFromIncludeDirectories: vi.fn().mockReturnValue(false),
getFileService: vi
.fn()
.mockReturnValue(new FileDiscoveryService(projectRoot)),
getExtensionLoader: vi
.fn()
.mockReturnValue(new SimpleExtensionLoader([])),
isTrustedFolder: vi.fn().mockReturnValue(true),
getImportFormat: vi.fn().mockReturnValue('tree'),
getFileFilteringOptions: vi.fn().mockReturnValue(undefined),
getDiscoveryMaxDirs: vi.fn().mockReturnValue(200),
setUserMemory: vi.fn(),
setGeminiMdFileCount: vi.fn(),
setGeminiMdFilePaths: vi.fn(),
getMcpClientManager: vi.fn().mockReturnValue({
getMcpInstructions: vi
.fn()
.mockReturnValue(
"\n\n# Instructions for MCP Server 'extension-server'\nAlways be polite.",
),
}),
} as unknown as Config;
await refreshServerHierarchicalMemory(mockConfig);
expect(mockConfig.setUserMemory).toHaveBeenCalledWith(
expect.objectContaining({
project: expect.stringContaining(
"# Instructions for MCP Server 'extension-server'",
),
}),
);
expect(mockConfig.setUserMemory).toHaveBeenCalledWith(
expect.objectContaining({
project: expect.stringContaining('Always be polite.'),
}),
);
});
});