jcarr
/
gemini-cli
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Introduce ContentGeneratorConfig (#826)

This commit is contained in:
Tommaso Sciortino 2025-06-07 16:17:27 -07:00 committed by GitHub
parent e95a6086fc
commit 389907ce65
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
12 changed files with 156 additions and 141 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
packages/cli/src/config/config.integration.test.ts
View File

@ -8,7 +8,17 @@ import { describe, it, expect, beforeEach, vi, afterEach } from 'vitest';
import * as fs from 'fs';
import * as path from 'path';
import { tmpdir } from 'os';
import { Config, ConfigParameters } from '@gemini-cli/core';
import {
Config,
ConfigParameters,
ContentGeneratorConfig,
} from '@gemini-cli/core';
const TEST_CONTENT_GENERATOR_CONFIG: ContentGeneratorConfig = {
apiKey: 'test-key',
model: 'test-model',
userAgent: 'test-agent',
};
// Mock file discovery service and tool registry
vi.mock('@gemini-cli/core', async () => {
@ -43,12 +53,11 @@ describe('Configuration Integration Tests', () => {
describe('File Filtering Configuration', () => {
it('should load default file filtering settings', async () => {
const configParams: ConfigParameters = {
apiKey: 'test-key',
model: 'test-model',
contentGeneratorConfig: TEST_CONTENT_GENERATOR_CONFIG,
embeddingModel: 'test-embedding-model',
sandbox: false,
targetDir: tempDir,
debugMode: false,
userAgent: 'test-agent',
fileFilteringRespectGitIgnore: undefined, // Should default to true
fileFilteringAllowBuildArtifacts: undefined, // Should default to false
};
@ -61,12 +70,11 @@ describe('Configuration Integration Tests', () => {
it('should load custom file filtering settings from configuration', async () => {
const configParams: ConfigParameters = {
apiKey: 'test-key',
model: 'test-model',
contentGeneratorConfig: TEST_CONTENT_GENERATOR_CONFIG,
embeddingModel: 'test-embedding-model',
sandbox: false,
targetDir: tempDir,
debugMode: false,
userAgent: 'test-agent',
fileFilteringRespectGitIgnore: false,
fileFilteringAllowBuildArtifacts: true,
};
@ -79,12 +87,11 @@ describe('Configuration Integration Tests', () => {
it('should merge user and workspace file filtering settings', async () => {
const configParams: ConfigParameters = {
apiKey: 'test-key',
model: 'test-model',
contentGeneratorConfig: TEST_CONTENT_GENERATOR_CONFIG,
embeddingModel: 'test-embedding-model',
sandbox: false,
targetDir: tempDir,
debugMode: false,
userAgent: 'test-agent',
fileFilteringRespectGitIgnore: true,
fileFilteringAllowBuildArtifacts: true,
};
@ -99,12 +106,11 @@ describe('Configuration Integration Tests', () => {
describe('Configuration Integration', () => {
it('should handle partial configuration objects gracefully', async () => {
const configParams: ConfigParameters = {
apiKey: 'test-key',
model: 'test-model',
contentGeneratorConfig: TEST_CONTENT_GENERATOR_CONFIG,
embeddingModel: 'test-embedding-model',
sandbox: false,
targetDir: tempDir,
debugMode: false,
userAgent: 'test-agent',
fileFilteringRespectGitIgnore: false,
fileFilteringAllowBuildArtifacts: undefined, // Should default to false
};
@ -120,12 +126,11 @@ describe('Configuration Integration Tests', () => {
it('should handle empty configuration objects gracefully', async () => {
const configParams: ConfigParameters = {
apiKey: 'test-key',
model: 'test-model',
contentGeneratorConfig: TEST_CONTENT_GENERATOR_CONFIG,
embeddingModel: 'test-embedding-model',
sandbox: false,
targetDir: tempDir,
debugMode: false,
userAgent: 'test-agent',
fileFilteringRespectGitIgnore: undefined,
fileFilteringAllowBuildArtifacts: undefined,
};
@ -139,12 +144,11 @@ describe('Configuration Integration Tests', () => {
it('should handle missing configuration sections gracefully', async () => {
const configParams: ConfigParameters = {
apiKey: 'test-key',
model: 'test-model',
contentGeneratorConfig: TEST_CONTENT_GENERATOR_CONFIG,
embeddingModel: 'test-embedding-model',
sandbox: false,
targetDir: tempDir,
debugMode: false,
userAgent: 'test-agent',
// Missing fileFiltering configuration
};
@ -159,12 +163,11 @@ describe('Configuration Integration Tests', () => {
describe('Real-world Configuration Scenarios', () => {
it('should handle a security-focused configuration', async () => {
const configParams: ConfigParameters = {
apiKey: 'test-key',
model: 'test-model',
contentGeneratorConfig: TEST_CONTENT_GENERATOR_CONFIG,
embeddingModel: 'test-embedding-model',
sandbox: false,
targetDir: tempDir,
debugMode: false,
userAgent: 'test-agent',
fileFilteringRespectGitIgnore: true,
fileFilteringAllowBuildArtifacts: false,
};
@ -177,12 +180,11 @@ describe('Configuration Integration Tests', () => {
it('should handle a development-focused configuration', async () => {
const configParams: ConfigParameters = {
apiKey: 'test-key',
model: 'test-model',
contentGeneratorConfig: TEST_CONTENT_GENERATOR_CONFIG,
embeddingModel: 'test-embedding-model',
sandbox: false,
targetDir: tempDir,
debugMode: false,
userAgent: 'test-agent',
fileFilteringRespectGitIgnore: true,
fileFilteringAllowBuildArtifacts: true,
};
@ -194,12 +196,11 @@ describe('Configuration Integration Tests', () => {
it('should handle a CI/CD environment configuration', async () => {
const configParams: ConfigParameters = {
apiKey: 'test-key',
model: 'test-model',
contentGeneratorConfig: TEST_CONTENT_GENERATOR_CONFIG,
embeddingModel: 'test-embedding-model',
sandbox: false,
targetDir: tempDir,
debugMode: false,
userAgent: 'test-agent',
fileFilteringRespectGitIgnore: false, // CI might need to see all files
fileFilteringAllowBuildArtifacts: true,
};

124
packages/cli/src/config/config.ts
View File

@ -14,6 +14,7 @@ import {
setGeminiMdFilename as setServerGeminiMdFilename,
getCurrentGeminiMdFilename,
ApprovalMode,
ContentGeneratorConfig,
} from '@gemini-cli/core';
import { Settings } from './settings.js';
import { getEffectiveModel } from '../utils/modelCheck.js';
@ -121,6 +122,62 @@ export async function loadCliConfig(
): Promise<Config> {
loadEnvironment();
const argv = await parseArguments();
const debugMode = argv.debug || false;
// Set the context filename in the server's memoryTool module BEFORE loading memory
// TODO(b/343434939): This is a bit of a hack. The contextFileName should ideally be passed
// directly to the Config constructor in core, and have core handle setGeminiMdFilename.
// However, loadHierarchicalGeminiMemory is called *before* createServerConfig.
if (settings.contextFileName) {
setServerGeminiMdFilename(settings.contextFileName);
} else {
// Reset to default if not provided in settings.
setServerGeminiMdFilename(getCurrentGeminiMdFilename());
}
// Call the (now wrapper) loadHierarchicalGeminiMemory which calls the server's version
const { memoryContent, fileCount } = await loadHierarchicalGeminiMemory(
process.cwd(),
debugMode,
);
const contentGeneratorConfig = await createContentGeneratorConfig(argv);
return new Config({
contentGeneratorConfig,
embeddingModel: DEFAULT_GEMINI_EMBEDDING_MODEL,
sandbox: argv.sandbox ?? settings.sandbox ?? argv.yolo ?? false,
targetDir: process.cwd(),
debugMode,
question: argv.prompt || '',
fullContext: argv.all_files || false,
coreTools: settings.coreTools || undefined,
toolDiscoveryCommand: settings.toolDiscoveryCommand,
toolCallCommand: settings.toolCallCommand,
mcpServerCommand: settings.mcpServerCommand,
mcpServers: settings.mcpServers,
userMemory: memoryContent,
geminiMdFileCount: fileCount,
approvalMode: argv.yolo || false ? ApprovalMode.YOLO : ApprovalMode.DEFAULT,
showMemoryUsage:
argv.show_memory_usage || settings.showMemoryUsage || false,
geminiIgnorePatterns,
accessibility: settings.accessibility,
telemetry:
argv.telemetry !== undefined
? argv.telemetry
: (settings.telemetry ?? false),
// Git-aware file filtering settings
fileFilteringRespectGitIgnore: settings.fileFiltering?.respectGitIgnore,
fileFilteringAllowBuildArtifacts:
settings.fileFiltering?.allowBuildArtifacts,
});
}
async function createContentGeneratorConfig(
argv: CliArgs,
): Promise<ContentGeneratorConfig> {
const geminiApiKey = process.env.GEMINI_API_KEY;
const googleApiKey = process.env.GOOGLE_API_KEY;
const googleCloudProject = process.env.GOOGLE_CLOUD_PROJECT;
@ -144,65 +201,16 @@ export async function loadCliConfig(
process.exit(1);
}
const argv = await parseArguments();
const debugMode = argv.debug || false;
const config: ContentGeneratorConfig = {
model: argv.model || DEFAULT_GEMINI_MODEL,
apiKey: geminiApiKey || googleApiKey || '',
vertexai: hasGeminiApiKey ? false : undefined,
userAgent: `GeminiCLI/${getCliVersion()}/(${process.platform}; ${process.arch})`,
};
// Set the context filename in the server's memoryTool module BEFORE loading memory
// TODO(b/343434939): This is a bit of a hack. The contextFileName should ideally be passed
// directly to the Config constructor in core, and have core handle setGeminiMdFilename.
// However, loadHierarchicalGeminiMemory is called *before* createServerConfig.
if (settings.contextFileName) {
setServerGeminiMdFilename(settings.contextFileName);
} else {
// Reset to default if not provided in settings.
setServerGeminiMdFilename(getCurrentGeminiMdFilename());
if (config.apiKey) {
config.model = await getEffectiveModel(config.apiKey, config.model);
}
// Call the (now wrapper) loadHierarchicalGeminiMemory which calls the server's version
const { memoryContent, fileCount } = await loadHierarchicalGeminiMemory(
process.cwd(),
debugMode,
);
const userAgent = `GeminiCLI/${getCliVersion()}/(${process.platform}; ${process.arch})`;
const apiKeyForServer = geminiApiKey || googleApiKey || '';
const useVertexAI = hasGeminiApiKey ? false : undefined;
let modelToUse = argv.model || DEFAULT_GEMINI_MODEL;
if (apiKeyForServer) {
modelToUse = await getEffectiveModel(apiKeyForServer, modelToUse);
}
return new Config({
apiKey: apiKeyForServer,
model: modelToUse,
embeddingModel: DEFAULT_GEMINI_EMBEDDING_MODEL,
sandbox: argv.sandbox ?? settings.sandbox ?? argv.yolo ?? false,
targetDir: process.cwd(),
debugMode,
question: argv.prompt || '',
fullContext: argv.all_files || false,
coreTools: settings.coreTools || undefined,
toolDiscoveryCommand: settings.toolDiscoveryCommand,
toolCallCommand: settings.toolCallCommand,
mcpServerCommand: settings.mcpServerCommand,
mcpServers: settings.mcpServers,
userAgent,
userMemory: memoryContent,
geminiMdFileCount: fileCount,
approvalMode: argv.yolo || false ? ApprovalMode.YOLO : ApprovalMode.DEFAULT,
vertexai: useVertexAI,
showMemoryUsage:
argv.show_memory_usage || settings.showMemoryUsage || false,
geminiIgnorePatterns,
accessibility: settings.accessibility,
telemetry:
argv.telemetry !== undefined
? argv.telemetry
: (settings.telemetry ?? false),
// Git-aware file filtering settings
fileFilteringRespectGitIgnore: settings.fileFiltering?.respectGitIgnore,
fileFilteringAllowBuildArtifacts:
settings.fileFiltering?.allowBuildArtifacts,
});
return config;
}

8
packages/cli/src/ui/App.test.tsx
View File

@ -179,13 +179,15 @@ describe('App UI', () => {
beforeEach(() => {
const ServerConfigMocked = vi.mocked(ServerConfig, true);
mockConfig = new ServerConfigMocked({
apiKey: 'test-key',
model: 'test-model',
contentGeneratorConfig: {
apiKey: 'test-key',
model: 'test-model',
userAgent: 'test-agent',
},
embeddingModel: 'test-embedding-model',
sandbox: false,
targetDir: '/test/dir',
debugMode: false,
userAgent: 'test-agent',
userMemory: '',
geminiMdFileCount: 0,
showMemoryUsage: false,

11
packages/core/src/config/config.test.ts
View File

@ -50,15 +50,17 @@ describe('Server Config (config.ts)', () => {
const TELEMETRY = false;
const EMBEDDING_MODEL = 'gemini-embedding';
const baseParams: ConfigParameters = {
apiKey: API_KEY,
model: MODEL,
contentGeneratorConfig: {
apiKey: API_KEY,
model: MODEL,
userAgent: USER_AGENT,
},
embeddingModel: EMBEDDING_MODEL,
sandbox: SANDBOX,
targetDir: TARGET_DIR,
debugMode: DEBUG_MODE,
question: QUESTION,
fullContext: FULL_CONTEXT,
userAgent: USER_AGENT,
userMemory: USER_MEMORY,
telemetry: TELEMETRY,
};
@ -73,10 +75,7 @@ describe('Server Config (config.ts)', () => {
expect(config.getUserMemory()).toBe(USER_MEMORY);
// Verify other getters if needed
expect(config.getApiKey()).toBe(API_KEY);
expect(config.getModel()).toBe(MODEL);
expect(config.getTargetDir()).toBe(path.resolve(TARGET_DIR)); // Check resolved path
expect(config.getUserAgent()).toBe(USER_AGENT);
});
it('Config constructor should default userMemory to empty string if not provided', () => {

31
packages/core/src/config/config.ts
View File

@ -9,6 +9,7 @@ import * as fs from 'node:fs';
import * as path from 'node:path';
import process from 'node:process';
import * as os from 'node:os';
import { ContentGeneratorConfig } from '../core/contentGenerator.js';
import { ToolRegistry } from '../tools/tool-registry.js';
import { CodeParserTool } from '../tools/code_parser.js'; // Added CodeParserTool
import { LSTool } from '../tools/ls.js';
@ -17,7 +18,6 @@ import { GrepTool } from '../tools/grep.js';
import { GlobTool } from '../tools/glob.js';
import { EditTool } from '../tools/edit.js';
import { ShellTool } from '../tools/shell.js';
import { WebFetchTool } from '../tools/web-fetch.js';
import { ReadManyFilesTool } from '../tools/read-many-files.js';
import { MemoryTool, setGeminiMdFilename } from '../tools/memoryTool.js';
@ -55,8 +55,7 @@ export class MCPServerConfig {
}
export interface ConfigParameters {
apiKey: string;
model: string;
contentGeneratorConfig: ContentGeneratorConfig;
embeddingModel: string;
sandbox: boolean | string;
targetDir: string;
@ -68,11 +67,9 @@ export interface ConfigParameters {
toolCallCommand?: string;
mcpServerCommand?: string;
mcpServers?: Record<string, MCPServerConfig>;
userAgent: string;
userMemory?: string;
geminiMdFileCount?: number;
approvalMode?: ApprovalMode;
vertexai?: boolean;
showMemoryUsage?: boolean;
contextFileName?: string;
geminiIgnorePatterns?: string[];
@ -85,8 +82,7 @@ export interface ConfigParameters {
export class Config {
private toolRegistry: Promise<ToolRegistry>;
private readonly apiKey: string;
private readonly model: string;
private readonly contentGeneratorConfig: ContentGeneratorConfig;
private readonly embeddingModel: string;
private readonly sandbox: boolean | string;
private readonly targetDir: string;
@ -98,11 +94,9 @@ export class Config {
private readonly toolCallCommand: string | undefined;
private readonly mcpServerCommand: string | undefined;
private readonly mcpServers: Record<string, MCPServerConfig> | undefined;
private readonly userAgent: string;
private userMemory: string;
private geminiMdFileCount: number;
private approvalMode: ApprovalMode;
private readonly vertexai: boolean | undefined;
private readonly showMemoryUsage: boolean;
private readonly accessibility: AccessibilitySettings;
private readonly telemetry: boolean;
@ -115,8 +109,7 @@ export class Config {
private fileDiscoveryService: FileDiscoveryService | null = null;
constructor(params: ConfigParameters) {
this.apiKey = params.apiKey;
this.model = params.model;
this.contentGeneratorConfig = params.contentGeneratorConfig;
this.embeddingModel = params.embeddingModel;
this.sandbox = params.sandbox;
this.targetDir = path.resolve(params.targetDir);
@ -128,11 +121,9 @@ export class Config {
this.toolCallCommand = params.toolCallCommand;
this.mcpServerCommand = params.mcpServerCommand;
this.mcpServers = params.mcpServers;
this.userAgent = params.userAgent ?? 'GeminiCLI/unknown';
this.userMemory = params.userMemory ?? '';
this.geminiMdFileCount = params.geminiMdFileCount ?? 0;
this.approvalMode = params.approvalMode ?? ApprovalMode.DEFAULT;
this.vertexai = params.vertexai;
this.showMemoryUsage = params.showMemoryUsage ?? false;
this.accessibility = params.accessibility ?? {};
this.telemetry = params.telemetry ?? false;
@ -160,12 +151,12 @@ export class Config {
}
}
getApiKey(): string {
return this.apiKey;
getContentGeneratorConfig(): ContentGeneratorConfig {
return this.contentGeneratorConfig;
}
getModel(): string {
return this.model;
return this.contentGeneratorConfig.model;
}
getEmbeddingModel(): string {
@ -215,10 +206,6 @@ export class Config {
return this.mcpServers;
}
getUserAgent(): string {
return this.userAgent;
}
getUserMemory(): string {
return this.userMemory;
}
@ -243,10 +230,6 @@ export class Config {
this.approvalMode = mode;
}
getVertexAI(): boolean | undefined {
return this.vertexai;
}
getShowMemoryUsage(): boolean {
return this.showMemoryUsage;
}

5
packages/core/src/core/client.test.ts
View File

@ -77,6 +77,11 @@ describe('Gemini Client (client.ts)', () => {
const MockedConfig = vi.mocked(Config, true);
MockedConfig.mockImplementation(() => {
const mock = {
getContentGeneratorConfig: vi.fn().mockReturnValue({
model: 'test-model',
apiKey: 'test-key',
vertexai: false,
}),
getToolRegistry: vi.fn().mockResolvedValue(mockToolRegistry),
getModel: vi.fn().mockReturnValue('test-model'),
getEmbeddingModel: vi.fn().mockReturnValue('test-embedding-model'),

23
packages/core/src/core/client.ts
View File

@ -8,7 +8,6 @@ import {
EmbedContentResponse,
EmbedContentParameters,
GenerateContentConfig,
GoogleGenAI,
Part,
SchemaUnion,
PartListUnion,
@ -34,7 +33,10 @@ import {
logApiResponse,
logApiError,
} from '../telemetry/index.js';
import { ContentGenerator } from './contentGenerator.js';
import {
ContentGenerator,
createContentGenerator,
} from './contentGenerator.js';
export class GeminiClient {
private chat: Promise<GeminiChat>;
@ -48,20 +50,9 @@ export class GeminiClient {
private readonly MAX_TURNS = 100;
constructor(private config: Config) {
const userAgent = config.getUserAgent();
const apiKeyFromConfig = config.getApiKey();
const vertexaiFlag = config.getVertexAI();
const googleGenAI = new GoogleGenAI({
apiKey: apiKeyFromConfig === '' ? undefined : apiKeyFromConfig,
vertexai: vertexaiFlag,
httpOptions: {
headers: {
'User-Agent': userAgent,
},
},
});
this.contentGenerator = googleGenAI.models;
this.contentGenerator = createContentGenerator(
this.config.getContentGeneratorConfig(),
);
this.model = config.getModel();
this.embeddingModel = config.getEmbeddingModel();
this.chat = this.startChat();

23
packages/core/src/core/contentGenerator.ts
View File

@ -11,6 +11,7 @@ import {
CountTokensParameters,
EmbedContentResponse,
EmbedContentParameters,
GoogleGenAI,
} from '@google/genai';
/**
@ -29,3 +30,25 @@ export interface ContentGenerator {
embedContent(request: EmbedContentParameters): Promise<EmbedContentResponse>;
}
export type ContentGeneratorConfig = {
model: string;
apiKey?: string;
vertexai?: boolean;
userAgent: string;
};
export function createContentGenerator(
config: ContentGeneratorConfig,
): ContentGenerator {
const googleGenAI = new GoogleGenAI({
apiKey: config.apiKey === '' ? undefined : config.apiKey,
vertexai: config.vertexai,
httpOptions: {
headers: {
'User-Agent': config.userAgent,
},
},
});
return googleGenAI.models;
}

1
packages/core/src/index.ts
View File

@ -9,6 +9,7 @@ export * from './config/config.js';
// Export Core Logic
export * from './core/client.js';
export * from './core/contentGenerator.js';
export * from './core/geminiChat.js';
export * from './core/logger.js';
export * from './core/prompts.js';

2
packages/core/src/telemetry/loggers.ts
View File

@ -45,7 +45,7 @@ export function logCliConfiguration(config: Config): void {
typeof config.getSandbox() === 'string' ? true : config.getSandbox(),
core_tools_enabled: (config.getCoreTools() ?? []).join(','),
approval_mode: config.getApprovalMode(),
vertex_ai_enabled: config.getVertexAI() ?? false,
vertex_ai_enabled: !!config.getContentGeneratorConfig().vertexai,
log_user_prompts_enabled: config.getTelemetryLogUserPromptsEnabled(),
file_filtering_respect_git_ignore:
config.getFileFilteringRespectGitIgnore(),

2
packages/core/src/telemetry/sdk.ts
View File

@ -64,7 +64,7 @@ export function initializeTelemetry(config: Config): void {
return;
}
const geminiCliVersion = config.getUserAgent() || 'unknown';
const geminiCliVersion = config.getContentGeneratorConfig().userAgent;
const resource = new Resource({
[SemanticResourceAttributes.SERVICE_NAME]: SERVICE_NAME,
[SemanticResourceAttributes.SERVICE_VERSION]: geminiCliVersion,

10
packages/core/src/tools/tool-registry.test.ts
View File

@ -124,17 +124,19 @@ class MockTool extends BaseTool<{ param: string }, ToolResult> {
}
const baseConfigParams: ConfigParameters = {
apiKey: 'test-api-key',
model: 'test-model',
contentGeneratorConfig: {
model: 'test-model',
apiKey: 'test-api-key',
vertexai: false,
userAgent: 'TestAgent/1.0',
},
embeddingModel: 'test-embedding-model',
sandbox: false,
targetDir: '/test/dir',
debugMode: false,
userAgent: 'TestAgent/1.0',
userMemory: '',
geminiMdFileCount: 0,
approvalMode: ApprovalMode.DEFAULT,
vertexai: false,
};
describe('ToolRegistry', () => {