Copilot CLI: Remove CopilotCLISessionOptions (#4853)

* Copilot CLI Remove CopilotCLISessionOptions

* Updates

Author: DonJayamanne

src/extension/chatSessions/copilotcli/node/copilotCli.ts

@@ -7,7 +7,6 @@ import type { SessionOptions, SweCustomAgent } from '@github/copilot/sdk';
 import { promises as fs } from 'fs';
 import * as path from 'path';
 import type * as vscode from 'vscode';
-import type { Uri } from 'vscode';
 import { IAuthenticationService } from '../../../../platform/authentication/common/authentication';
 import { ConfigKey, IConfigurationService } from '../../../../platform/configuration/common/configurationService';
 import { IEnvService } from '../../../../platform/env/common/envService';
@@ -23,9 +22,7 @@ import { basename } from '../../../../util/vs/base/common/resources';
 import { URI } from '../../../../util/vs/base/common/uri';
 import { IInstantiationService } from '../../../../util/vs/platform/instantiation/common/instantiation';
 import { IChatPromptFileService } from '../../common/chatPromptFileService';
-import { getWorkingDirectory, IWorkspaceInfo } from '../../common/workspaceInfo';
 import { getCopilotLogger } from './logger';
-import { remapCustomAgentTools, type McpServerMappings } from './mcpHandler';
 import { ensureNodePtyShim } from './nodePtyShim';
 import { ensureRipgrepShim } from './ripgrepShim';
 
@@ -39,75 +36,6 @@ const COPILOT_CLI_SESSION_AGENTS_MEMENTO_KEY = 'github.copilot.cli.sessionAgents
  */
 export const COPILOT_CLI_DEFAULT_AGENT_ID = '___vscode_default___';
 
-export class CopilotCLISessionOptions {
-	public readonly workspaceInfo: IWorkspaceInfo;
-	private readonly model?: string;
-	private readonly agent?: SweCustomAgent;
-	private readonly customAgents?: SweCustomAgent[];
-	private readonly mcpServers?: SessionOptions['mcpServers'];
-	private readonly copilotUrl?: string;
-	private readonly skillLocations?: Uri[];
-	private readonly systemMessage?: SessionOptions['systemMessage'];
-	constructor(options: { model?: string; workspaceInfo: IWorkspaceInfo; mcpServers?: SessionOptions['mcpServers']; agent?: SweCustomAgent; customAgents?: SweCustomAgent[]; copilotUrl?: string; skillLocations?: Uri[]; systemMessage?: SessionOptions['systemMessage'] }, private readonly logService: ILogService) {
-		this.workspaceInfo = options.workspaceInfo;
-		this.model = options.model;
-		this.mcpServers = options.mcpServers;
-		this.agent = options.agent;
-		this.customAgents = options.customAgents;
-		this.copilotUrl = options.copilotUrl;
-		this.skillLocations = options.skillLocations;
-		this.systemMessage = options.systemMessage;
-	}
-
-	public get agentName(): string | undefined {
-		return this.agent?.name;
-	}
-
-	public toSessionOptions(mcpServerMappings?: McpServerMappings): Readonly<SessionOptions> {
-		const allOptions: SessionOptions = {
-			clientName: 'vscode',
-		};
-
-		const workingDirectory = getWorkingDirectory(this.workspaceInfo);
-		if (workingDirectory) {
-			allOptions.workingDirectory = workingDirectory.fsPath;
-		}
-		if (this.model) {
-			allOptions.model = this.model as unknown as SessionOptions['model'];
-		}
-		if (this.mcpServers && Object.keys(this.mcpServers).length > 0) {
-			allOptions.mcpServers = this.mcpServers;
-			this.logService.info(`[CopilotCLISession] Passing ${Object.keys(this.mcpServers).length} MCP server(s) to SDK: [${Object.keys(this.mcpServers).join(', ')}]`);
-			for (const [id, cfg] of Object.entries(this.mcpServers)) {
-				this.logService.info(`[CopilotCLISession]   ${id}: type=${cfg.type}`);
-			}
-		} else {
-			this.logService.info('[CopilotCLISession] No MCP servers to pass to SDK');
-		}
-		if (this.skillLocations) {
-			allOptions.skillDirectories = this.skillLocations.map(uri => uri.fsPath);
-		}
-		if (mcpServerMappings?.size && this.customAgents && this.mcpServers) {
-			remapCustomAgentTools(this.customAgents, mcpServerMappings, this.mcpServers, this.agent);
-		}
-		if (this.agent) {
-			allOptions.selectedCustomAgent = this.agent;
-		}
-		if (this.customAgents) {
-			allOptions.customAgents = this.customAgents;
-		}
-		allOptions.enableStreaming = true;
-		if (this.copilotUrl) {
-			allOptions.copilotUrl = this.copilotUrl;
-		}
-		if (this.systemMessage) {
-			allOptions.systemMessage = this.systemMessage;
-		}
-		allOptions.sessionCapabilities = new Set(['plan-mode', 'memory', 'cli-documentation', 'ask-user', 'interactive-mode', 'system-notifications']);
-		return allOptions as Readonly<SessionOptions>;
-	}
-}
-
 export interface CopilotCLIModelInfo {
 	readonly id: string;
 	readonly name: string;

src/extension/chatSessions/copilotcli/node/copilotcliSession.ts

@@ -34,7 +34,7 @@ import { getWorkingDirectory, isIsolationEnabled, IWorkspaceInfo } from '../../c
 import { buildChatHistoryFromEvents, enrichToolInvocationWithSubagentMetadata, getAffectedUrisForEditTool, isCopilotCliEditToolCall, isCopilotCLIToolThatCouldRequirePermissions, processToolExecutionComplete, processToolExecutionStart, RequestIdDetails, ToolCall, updateTodoList } from '../common/copilotCLITools';
 import { IChatDelegationSummaryService } from '../common/delegationSummaryService';
 import { getCopilotCLISessionStateDir } from './cliHelpers';
-import { CopilotCLISessionOptions, getAgentFileNameFromFilePath, ICopilotCLISDK } from './copilotCli';
+import { getAgentFileNameFromFilePath, ICopilotCLISDK } from './copilotCli';
 import type { CopilotCliBridgeSpanProcessor } from './copilotCliBridgeSpanProcessor';
 import { ICopilotCLIImageSupport } from './copilotCLIImageSupport';
 import { PermissionRequest, requestPermission, requiresFileEditconfirmation } from './permissionHelpers';
@@ -125,7 +125,7 @@ export class CopilotCLISession extends DisposableStore implements ICopilotCLISes
 		return this._sdkSession;
 	}
 	public get workspace() {
-		return this._options.workspaceInfo;
+		return this._workspaceInfo;
 	}
 	private _lastUsedModel: string | undefined;
 	private _permissionLevel: string | undefined;
@@ -145,7 +145,8 @@ export class CopilotCLISession extends DisposableStore implements ICopilotCLISes
 		this._updateSdkTraceContext = updater;
 	}
 	constructor(
-		private readonly _options: CopilotCLISessionOptions,
+		private readonly _workspaceInfo: IWorkspaceInfo,
+		private readonly _agentName: string | undefined,
 		private readonly _sdkSession: Session,
 		@ILogService private readonly logService: ILogService,
 		@IWorkspaceService private readonly workspaceService: IWorkspaceService,
@@ -686,7 +687,7 @@ export class CopilotCLISession extends DisposableStore implements ICopilotCLISes
 					vscodeRequestId: request.id,
 					copilotRequestId: sdkRequestId,
 					toolIdEditMap: resolvedToolIdEditMap,
-					agentId: this._options.agentName,
+					agentId: this._agentName,
 				}]).catch(error => {
 					this.logService.error(`[CopilotCLISession] Failed to update chat session metadata store for request ${request.id}`, error);
 				});

src/extension/chatSessions/copilotcli/node/copilotcliSessionService.ts

@@ -44,11 +44,12 @@ import { buildChatHistoryFromEvents, stripReminders } from '../common/copilotCLI
 import { ICustomSessionTitleService } from '../common/customSessionTitleService';
 import { IChatDelegationSummaryService } from '../common/delegationSummaryService';
 import { getCopilotCLISessionDir, getCopilotCLISessionEventsFile, getCopilotCLIWorkspaceFile } from './cliHelpers';
-import { CopilotCLISessionOptions, ICopilotCLIAgents, ICopilotCLISDK } from './copilotCli';
+import { ICopilotCLIAgents, ICopilotCLISDK } from './copilotCli';
 import { CopilotCliBridgeSpanProcessor } from './copilotCliBridgeSpanProcessor';
 import { CopilotCLISession, ICopilotCLISession } from './copilotcliSession';
 import { ICopilotCLISkills } from './copilotCLISkills';
-import { ICopilotCLIMCPHandler, McpServerMappings } from './mcpHandler';
+import { ICopilotCLIMCPHandler, McpServerMappings, remapCustomAgentTools } from './mcpHandler';
+
 
 const COPILOT_CLI_WORKSPACE_JSON_FILE_KEY = 'github.copilot.cli.workspaceSessionFile';
 
@@ -525,9 +526,9 @@ export class CopilotCLISessionService extends Disposable implements ICopilotCLIS
 		const { mcpConfig: mcpServers, disposable: mcpGateway } = await this.mcpHandler.loadMcpConfig();
 		try {
 			const copilotUrl = this.configurationService.getConfig(ConfigKey.Shared.DebugOverrideProxyUrl) || undefined;
-			const options = await this.createSessionsOptions({ model, workspaceInfo, mcpServers, agent, copilotUrl, sessionId, debugTargetSessionIds });
+			const { agentName, sessionOptions } = await this.createSessionsOptions({ model, workspaceInfo, mcpServers, agent, copilotUrl, sessionId, debugTargetSessionIds, mcpServerMappings });
 			const sessionManager = await raceCancellationError(this.getSessionManager(), token);
-			const sdkSession = await sessionManager.createSession({ ...options.toSessionOptions(mcpServerMappings), sessionId });
+			const sdkSession = await sessionManager.createSession({ ...sessionOptions, sessionId });
 			this._newSessionIds.delete(sdkSession.sessionId);
 			// After the first session creation, the SDK's OTel TracerProvider is
 			// initialized. Install the bridge processor so SDK-native spans flow
@@ -548,7 +549,7 @@ export class CopilotCLISessionService extends Disposable implements ICopilotCLIS
 			}
 			this.logService.trace(`[CopilotCLISession] Created new CopilotCLI session ${sdkSession.sessionId}.`);
 
-			const session = await this.createCopilotSession(sdkSession, options, sessionManager);
+			const session = await this.createCopilotSession(sdkSession, workspaceInfo, agentName, sessionManager);
 			session.object.add(mcpGateway);
 			return session;
 		}
@@ -638,14 +639,59 @@ export class CopilotCLISessionService extends Disposable implements ICopilotCLIS
 		return false;
 	}
 
-	protected async createSessionsOptions(options: { model?: string; workspaceInfo: IWorkspaceInfo; mcpServers?: SessionOptions['mcpServers']; agent: SweCustomAgent | undefined; copilotUrl?: string; sessionId?: string; debugTargetSessionIds?: readonly string[] }, readonly?: boolean): Promise<CopilotCLISessionOptions> {
+	protected async createSessionsOptions(options: { model?: string; workspaceInfo: IWorkspaceInfo; mcpServers?: SessionOptions['mcpServers']; agent: SweCustomAgent | undefined; copilotUrl?: string; sessionId?: string; debugTargetSessionIds?: readonly string[]; mcpServerMappings?: McpServerMappings }, readonly?: boolean): Promise<{ readonly sessionOptions: Readonly<SessionOptions>; readonly agentName: string | undefined }> {
 		const [customAgents, skillLocations] = await Promise.all([
 			this.agents.getAgents(),
-			readonly ? Promise.resolve([]) : this.copilotCLISkills.getSkillsLocations(),
+			readonly ? Promise.resolve<Uri[]>([]) : this.copilotCLISkills.getSkillsLocations(),
 		]);
 		const variablesContext = this._promptVariablesService.buildTemplateVariablesContext(options.sessionId, options.debugTargetSessionIds);
 		const systemMessage = variablesContext ? { mode: 'append' as const, content: variablesContext } : undefined;
-		return new CopilotCLISessionOptions({ ...options, customAgents, skillLocations, systemMessage }, this.logService);
+
+		const allOptions: SessionOptions = {
+			clientName: 'vscode',
+		};
+
+		const workingDirectory = getWorkingDirectory(options.workspaceInfo);
+		if (workingDirectory) {
+			allOptions.workingDirectory = workingDirectory.fsPath;
+		}
+		if (options.model) {
+			allOptions.model = options.model as unknown as SessionOptions['model'];
+		}
+		if (options.mcpServers && Object.keys(options.mcpServers).length > 0) {
+			allOptions.mcpServers = options.mcpServers;
+			this.logService.info(`[CopilotCLISession] Passing ${Object.keys(options.mcpServers).length} MCP server(s) to SDK: [${Object.keys(options.mcpServers).join(', ')}]`);
+			for (const [id, cfg] of Object.entries(options.mcpServers)) {
+				this.logService.info(`[CopilotCLISession]   ${id}: type=${cfg.type}`);
+			}
+		} else {
+			this.logService.info('[CopilotCLISession] No MCP servers to pass to SDK');
+		}
+		if (skillLocations.length > 0) {
+			allOptions.skillDirectories = skillLocations.map(uri => uri.fsPath);
+		}
+		if (options.mcpServerMappings?.size && customAgents && options.mcpServers) {
+			remapCustomAgentTools(customAgents, options.mcpServerMappings, options.mcpServers, options.agent);
+		}
+		if (options.agent) {
+			allOptions.selectedCustomAgent = options.agent;
+		}
+		if (customAgents.length > 0) {
+			allOptions.customAgents = customAgents;
+		}
+		allOptions.enableStreaming = true;
+		if (options.copilotUrl) {
+			allOptions.copilotUrl = options.copilotUrl;
+		}
+		if (systemMessage) {
+			allOptions.systemMessage = systemMessage;
+		}
+		allOptions.sessionCapabilities = new Set(['plan-mode', 'memory', 'cli-documentation', 'ask-user', 'interactive-mode', 'system-notifications']);
+
+		return {
+			sessionOptions: allOptions as Readonly<SessionOptions>,
+			agentName: options.agent?.name,
+		};
 	}
 
 	public async getSession({ sessionId, model, workspaceInfo, readonly, agent, debugTargetSessionIds, mcpServerMappings }: { sessionId: string; model?: string; workspaceInfo: IWorkspaceInfo; readonly: boolean; agent?: SweCustomAgent; debugTargetSessionIds?: readonly string[]; mcpServerMappings?: McpServerMappings }, token: CancellationToken): Promise<RefCountedSession | undefined> {
@@ -677,15 +723,15 @@ export class CopilotCLISessionService extends Disposable implements ICopilotCLIS
 			]);
 			try {
 				const copilotUrl = this.configurationService.getConfig(ConfigKey.Shared.DebugOverrideProxyUrl) || undefined;
-				const options = await this.createSessionsOptions({ model, agent, workspaceInfo, mcpServers, copilotUrl, sessionId, debugTargetSessionIds }, readonly);
+				const { agentName, sessionOptions } = await this.createSessionsOptions({ model, agent, workspaceInfo, mcpServers, copilotUrl, sessionId, debugTargetSessionIds, mcpServerMappings }, readonly);
 
-				const sdkSession = await sessionManager.getSession({ ...options.toSessionOptions(mcpServerMappings), sessionId }, !readonly);
+				const sdkSession = await sessionManager.getSession({ ...sessionOptions, sessionId }, !readonly);
 				if (!sdkSession) {
 					this.logService.error(`[CopilotCLISession] CopilotCLI failed to get session ${sessionId}.`);
 					return undefined;
 				}
 
-				const session = await this.createCopilotSession(sdkSession, options, sessionManager, readonly);
+				const session = await this.createCopilotSession(sdkSession, workspaceInfo, agentName, sessionManager, readonly);
 				session.object.add(mcpGateway);
 				return session;
 			}
@@ -722,9 +768,9 @@ export class CopilotCLISessionService extends Disposable implements ICopilotCLIS
 			]);
 
 			const copilotUrl = this.configurationService.getConfig(ConfigKey.Shared.DebugOverrideProxyUrl) || undefined;
-			const options = await this.createSessionsOptions({ workspaceInfo, mcpServers: undefined, copilotUrl, agent: undefined, sessionId: newSessionId }, false);
+			const { agentName, sessionOptions } = await this.createSessionsOptions({ workspaceInfo, mcpServers: undefined, copilotUrl, agent: undefined, sessionId: newSessionId }, false);
 
-			const sdkSession = await sessionManager.getSession({ ...options.toSessionOptions(), sessionId: newSessionId }, false);
+			const sdkSession = await sessionManager.getSession({ ...sessionOptions, sessionId: newSessionId }, false);
 			if (!sdkSession) {
 				this.logService.error(`[CopilotCLISession] CopilotCLI failed to open forked session ${newSessionId}.`);
 				throw new Error(`Failed to fork session ${sessionId}`);
@@ -736,7 +782,7 @@ export class CopilotCLISessionService extends Disposable implements ICopilotCLIS
 			let events: ReturnType<typeof sdkSession.getEvents> = [];
 			// Only if we have a request to truncate should we open and trucate.
 			if (requestId) {
-				const session = this.createCopilotSession(sdkSession, options, sessionManager, false, true);
+				const session = this.createCopilotSession(sdkSession, workspaceInfo, agentName, sessionManager, false, true);
 				disposables.add(session);
 				const history = await session.object.getChatHistory();
 				const requestToTruncateTo = history.find(event => event instanceof ChatRequestTurn2 && event.id === requestId);
@@ -856,8 +902,8 @@ export class CopilotCLISessionService extends Disposable implements ICopilotCLIS
 		return firstUserMessage;
 	}
 
-	private createCopilotSession(sdkSession: Session, options: CopilotCLISessionOptions, sessionManager: internal.LocalSessionManager, readonly = false, nowait = false): RefCountedSession {
-		const session = this.instantiationService.createInstance(CopilotCLISession, options, sdkSession);
+	private createCopilotSession(sdkSession: Session, workspaceInfo: IWorkspaceInfo, agentName: string | undefined, sessionManager: internal.LocalSessionManager, readonly = false, nowait = false): RefCountedSession {
+		const session = this.instantiationService.createInstance(CopilotCLISession, workspaceInfo, agentName, sdkSession);
 		this._debugFileLogger.startSession(session.sessionId).catch(err => {
 			this.logService.error('[CopilotCLISession] Failed to start debug log session', err);
 		});

src/extension/chatSessions/copilotcli/node/test/copilotCliSessionService.spec.ts

@@ -139,7 +139,7 @@ describe('CopilotCLISessionService', () => {
 			invokeFunction(fn: (accessor: unknown, ...args: any[]) => any, ...args: any[]): any {
 				return fn(accessor, ...args);
 			},
-			createInstance: (ctor: unknown, options: any, sdkSession: any) => {
+			createInstance: (ctor: unknown, workspaceInfo: any, agentName: any, sdkSession: any) => {
 				if (ctor === CopilotCLISessionWorkspaceTracker) {
 					return new class extends mock<CopilotCLISessionWorkspaceTracker>() {
 						override async initialize(): Promise<void> { return; }
@@ -148,7 +148,7 @@ describe('CopilotCLISessionService', () => {
 						}
 					}();
 				}
-				return disposables.add(new CopilotCLISession(options, sdkSession, logService, workspaceService, sdk, new MockChatSessionMetadataStore(), instantiationService, delegationService, new NullRequestLogger(), new NullICopilotCLIImageSupport(), new FakeToolsService(), new FakeUserQuestionHandler(), accessor.get(IConfigurationService), new NoopOTelService(resolveOTelConfig({ env: {}, extensionVersion: '0.0.0', sessionId: 'test' })), new class extends mock<IChatPromptFileService>() { override get customAgentPromptFiles() { return []; } }));
+				return disposables.add(new CopilotCLISession(workspaceInfo, agentName, sdkSession, logService, workspaceService, sdk, new MockChatSessionMetadataStore(), instantiationService, delegationService, new NullRequestLogger(), new NullICopilotCLIImageSupport(), new FakeToolsService(), new FakeUserQuestionHandler(), accessor.get(IConfigurationService), new NoopOTelService(resolveOTelConfig({ env: {}, extensionVersion: '0.0.0', sessionId: 'test' })), new class extends mock<IChatPromptFileService>() { override get customAgentPromptFiles() { return []; } }));
 			}
 		} as unknown as IInstantiationService;
 		const configurationService = accessor.get(IConfigurationService);