Support for resource based session API changes (#8027)

* Initial support for new resource based chat sessions

* Update tests

* Bump proposal version

---------

Co-authored-by: Josh Spicer <23246594+joshspicer@users.noreply.github.com>

Author: mjbvz

package.json

@@ -14,7 +14,7 @@
 		"activeComment",
 		"chatParticipantAdditions",
 		"chatParticipantPrivate",
-		"chatSessionsProvider@2",
+		"chatSessionsProvider@3",
 		"codiconDecoration",
 		"codeActionRanges",
 		"commentingRangeHint",
@@ -4364,4 +4364,4 @@
 		"string_decoder": "^1.3.0"
 	},
 	"license": "MIT"
-}
+}

src/@types/vscode.proposed.chatParticipantAdditions.d.ts

@@ -652,6 +652,7 @@ declare module 'vscode' {
 	}
 
 	export interface ChatRequestModeInstructions {
+		readonly name: string;
 		readonly content: string;
 		readonly toolReferences?: readonly ChatLanguageModelToolReference[];
 		readonly metadata?: Record<string, boolean | string | number>;

src/@types/vscode.proposed.chatSessionsProvider.d.ts

@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-// version: 2
+// version: 3
 
 declare module 'vscode' {
 	/**
@@ -35,6 +35,14 @@ declare module 'vscode' {
 		 */
 		readonly onDidChangeChatSessionItems: Event<void>;
 
+		/**
+		 * Provides a list of chat sessions.
+		 */
+		// TODO: Do we need a flag to try auth if needed?
+		provideChatSessionItems(token: CancellationToken): ProviderResult<ChatSessionItem[]>;
+
+		// #region Unstable parts of API
+
 		/**
 		 * Event that the provider can fire to signal that the current (original) chat session should be replaced with a new (modified) chat session.
 		 * The UI can use this information to gracefully migrate the user to the new session.
@@ -61,27 +69,16 @@ declare module 'vscode' {
 			metadata?: any;
 		}, token: CancellationToken): ProviderResult<ChatSessionItem>;
 
-		/**
-		 * Provides a list of chat sessions.
-		 */
-		// TODO: Do we need a flag to try auth if needed?
-		provideChatSessionItems(token: CancellationToken): ProviderResult<ChatSessionItem[]>;
+		// #endregion
 	}
 
 	export interface ChatSessionItem {
-		/**
-		 * Unique identifier for the chat session.
-		 *
-		 * @deprecated Will be replaced by `resource`
-		 */
-		id: string;
-
 		/**
 		 * The resource associated with the chat session.
 		 *
 		 * This is uniquely identifies the chat session and is used to open the chat session.
 		 */
-		resource: Uri | undefined;
+		resource: Uri;
 
 		/**
 		 * Human readable name of the session shown in the UI
@@ -149,9 +146,12 @@ declare module 'vscode' {
 		readonly history: ReadonlyArray<ChatRequestTurn | ChatResponseTurn2>;
 
 		/**
-		 * Options configured for this session.
+		 * Options configured for this session as key-value pairs.
+		 * Keys correspond to option group IDs (e.g., 'models', 'subagents')
+		 * and values are the selected option item IDs.
+		 * TODO: Strongly type the keys
 		 */
-		readonly options?: { model?: LanguageModelChatInformation };
+		readonly options?: Record<string, string>;
 
 		/**
 		 * Callback invoked by the editor for a currently running response. This allows the session to push items for the
@@ -172,22 +172,28 @@ declare module 'vscode' {
 		readonly requestHandler: ChatRequestHandler | undefined;
 	}
 
+	/**
+	 * Provides the content for a chat session rendered using the native chat UI.
+	 */
 	export interface ChatSessionContentProvider {
 		/**
-		 * Resolves a chat session into a full `ChatSession` object.
+		 * Provides the chat session content for a given uri.
 		 *
-		 * @param sessionId The id of the chat session to open.
+		 * The returned {@linkcode ChatSession} is used to populate the history of the chat UI.
+		 *
+		 * @param resource The URI of the chat session to resolve.
 		 * @param token A cancellation token that can be used to cancel the operation.
+		 *
+		 * @return The {@link ChatSession chat session} associated with the given URI.
 		 */
-		provideChatSessionContent(sessionId: string, token: CancellationToken): Thenable<ChatSession> | ChatSession;
+		provideChatSessionContent(resource: Uri, token: CancellationToken): Thenable<ChatSession> | ChatSession;
 
 		/**
-		 *
-		 * @param sessionId Identifier of the chat session being updated.
+		 * @param resource Identifier of the chat session being updated.
 		 * @param updates Collection of option identifiers and their new values. Only the options that changed are included.
 		 * @param token A cancellation token that can be used to cancel the notification if the session is disposed.
 		 */
-		provideHandleOptionsChange?(sessionId: string, updates: ReadonlyArray<ChatSessionOptionUpdate>, token: CancellationToken): void;
+		provideHandleOptionsChange?(resource: Uri, updates: ReadonlyArray<ChatSessionOptionUpdate>, token: CancellationToken): void;
 
 		/**
 		 * Called as soon as you register (call me once)
@@ -224,12 +230,12 @@ declare module 'vscode' {
 		/**
 		 * Registers a new {@link ChatSessionContentProvider chat session content provider}.
 		 *
-		 * @param chatSessionType A unique identifier for the chat session type. This is used to differentiate between different chat session providers.
+		 * @param scheme The uri-scheme to register for. This must be unique.
 		 * @param provider The provider to register.
 		 *
 		 * @returns A disposable that unregisters the provider when disposed.
 		 */
-		export function registerChatSessionContentProvider(chatSessionType: string, provider: ChatSessionContentProvider, chatParticipant: ChatParticipant, capabilities?: ChatSessionCapabilities): Disposable;
+		export function registerChatSessionContentProvider(scheme: string, provider: ChatSessionContentProvider, chatParticipant: ChatParticipant, capabilities?: ChatSessionCapabilities): Disposable;
 	}
 
 	export interface ChatContext {
@@ -252,31 +258,51 @@ declare module 'vscode' {
 		supportsInterruptions?: boolean;
 	}
 
-	export interface ChatSessionProviderOptions {
+	/**
+	 * Represents a single selectable item within a provider option group.
+	 */
+	export interface ChatSessionProviderOptionItem {
+		/**
+		 * Unique identifier for the option item.
+		 */
+		readonly id: string;
+
 		/**
-		 * Set of available models.
+		 * Human-readable name displayed in the UI.
 		 */
-		models?: LanguageModelChatInformation[];
+		readonly name: string;
 	}
 
 	/**
-	 * @deprecated
+	 * Represents a group of related provider options (e.g., models, sub-agents).
 	 */
-	export interface ChatSessionShowOptions {
+	export interface ChatSessionProviderOptionGroup {
 		/**
-		 * The editor view column to show the chat session in.
-		 *
-		 * If not provided, the chat session will be shown in the chat panel instead.
+		 * Unique identifier for the option group (e.g., "models", "subagents").
 		 */
-		readonly viewColumn?: ViewColumn;
+		readonly id: string;
+
+		/**
+		 * Human-readable name for the option group.
+		 */
+		readonly name: string;
+
+		/**
+		 * Optional description providing context about this option group.
+		 */
+		readonly description?: string;
+
+		/**
+		 * The selectable items within this option group.
+		 */
+		readonly items: ChatSessionProviderOptionItem[];
 	}
 
-	export namespace window {
+	export interface ChatSessionProviderOptions {
 		/**
-		 * Shows a chat session in the panel or editor.
-		 *
-		 * @deprecated
+		 * Provider-defined option groups (0-2 groups supported).
+		 * Examples: models picker, sub-agents picker, etc.
 		 */
-		export function showChatSession(chatSessionType: string, sessionId: string, options: ChatSessionShowOptions): Thenable<void>;
+		optionGroups?: ChatSessionProviderOptionGroup[];
 	}
 }

src/extension.ts

@@ -447,12 +447,12 @@ async function deferredActivate(context: vscode.ExtensionContext, showPRControll
 
 		const provider = new class implements vscode.ChatSessionContentProvider, vscode.ChatSessionItemProvider {
 			label = vscode.l10n.t('GitHub Copilot Coding Agent');
-			provideChatSessionItems = async (token) => {
+			async provideChatSessionItems(token: vscode.CancellationToken) {
 				return await copilotRemoteAgentManager.provideChatSessions(token);
-			};
-			provideChatSessionContent = async (id, token) => {
-				return await copilotRemoteAgentManager.provideChatSessionContent(id, token);
-			};
+			}
+			async provideChatSessionContent(resource: vscode.Uri, token: vscode.CancellationToken) {
+				return await copilotRemoteAgentManager.provideChatSessionContent(resource, token);
+			}
 			onDidChangeChatSessionItems = copilotRemoteAgentManager.onDidChangeChatSessions;
 			onDidCommitChatSessionItem = copilotRemoteAgentManager.onDidCommitChatSession;
 		}();

src/github/copilotRemoteAgent.ts

@@ -4,6 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 import * as pathLib from 'path';
+import { URI } from '@vscode/prompt-tsx/dist/base/util/vs/common/uri';
 import * as marked from 'marked';
 import vscode, { ChatPromptReference, ChatSessionItem } from 'vscode';
 import { copilotPRStatusToSessionStatus, IAPISessionLogs, ICopilotRemoteAgentCommandArgs, ICopilotRemoteAgentCommandResponse, OctokitCommon, RemoteAgentResult, RepoInfo } from './common';
@@ -56,12 +57,14 @@ export namespace SessionIdForPr {
 
 	const prefix = 'pull-session-by-index';
 
-	export function getId(prNumber: number, sessionIndex: number): string {
-		return `${prefix}-${prNumber}-${sessionIndex}`;
+	export function getResource(prNumber: number, sessionIndex: number): vscode.Uri {
+		return vscode.Uri.from({
+			scheme: COPILOT_SWE_AGENT, path: `/${prefix}-${prNumber}-${sessionIndex}`,
+		});
 	}
 
-	export function parse(id: string): { prNumber: number; sessionIndex: number } | undefined {
-		const match = id.match(new RegExp(`^${prefix}-(\\d+)-(\\d+)$`));
+	export function parse(resource: vscode.Uri): { prNumber: number; sessionIndex: number } | undefined {
+		const match = resource.path.match(new RegExp(`^/${prefix}-(\\d+)-(\\d+)$`));
 		if (match) {
 			return {
 				prNumber: parseInt(match[1], 10),
@@ -141,7 +144,7 @@ export class CopilotRemoteAgentManager extends Disposable {
 						const card = new vscode.ChatResponsePullRequestPart(uri, pullRequest.title, plaintextBody, pullRequest.author.specialDisplayName ?? pullRequest.author.login, `#${pullRequest.number}`);
 						stream.push(card);
 						stream.markdown(vscode.l10n.t('GitHub Copilot coding agent has begun working on your request. Follow its progress in the associated chat and pull request.'));
-						vscode.window.showChatSession(COPILOT_SWE_AGENT, String(number), { viewColumn: vscode.ViewColumn.Active });
+						vscode.commands.executeCommand('vscode.open', vscode.Uri.from({ scheme: COPILOT_SWE_AGENT, path: '/' + number }), { viewColumn: vscode.ViewColumn.Active });
 						break;
 					default:
 						stream.warning(`Unknown confirmation step: ${data.step}\n\n`);
@@ -167,7 +170,10 @@ export class CopilotRemoteAgentManager extends Disposable {
 				return {};
 			}
 			// Tell UI to the new chat session
-			const modified: vscode.ChatSessionItem = { id: String(number), label: `Pull Request ${number}` } as unknown as vscode.ChatSessionItem;
+			const modified: vscode.ChatSessionItem = {
+				resource: vscode.Uri.from({ scheme: COPILOT_SWE_AGENT, path: '/' + number }),
+				label: `Pull Request ${number}`,
+			};
 			this._onDidCommitChatSession.fire({ original: context.chatSessionContext.chatSessionItem, modified });
 		} else if (context.chatSessionContext) {
 			/* Follow up to an existing coding agent session */
@@ -185,9 +191,9 @@ export class CopilotRemoteAgentManager extends Disposable {
 
 				stream.progress(vscode.l10n.t('Preparing'));
 
-				const pullRequest = await this.findPullRequestById(parseInt(context.chatSessionContext.chatSessionItem.id, 10), true);
+				const pullRequest = await this.findPullRequestById(parseInt(context.chatSessionContext.chatSessionItem.resource.path.slice(1), 10), true);
 				if (!pullRequest) {
-					stream.warning(vscode.l10n.t('Could not find the associated pull request {0} for this chat session.', context.chatSessionContext.chatSessionItem.id));
+					stream.warning(vscode.l10n.t('Could not find the associated pull request {0} for this chat session.', context.chatSessionContext.chatSessionItem.resource.toString));
 					return {};
 				}
 
@@ -705,7 +711,7 @@ export class CopilotRemoteAgentManager extends Disposable {
 		} else {
 			await this.provideChatSessions(new vscode.CancellationTokenSource().token);
 			if (pr) {
-				vscode.window.showChatSession(COPILOT_SWE_AGENT, `${pr.number}`, {});
+				vscode.commands.executeCommand('vscode.open', vscode.Uri.from({ scheme: COPILOT_SWE_AGENT, path: '/' + pr.number }));
 			}
 		}
 
@@ -1060,7 +1066,7 @@ export class CopilotRemoteAgentManager extends Disposable {
 				}
 				const description = new vscode.MarkdownString(`[${repoInfo}#${pullRequest.number}](${uri.toString()} "${prLinkTitle}")`); //  pullRequest.base.ref === defaultBranch ? `PR #${pullRequest.number}`: `PR #${pullRequest.number} → ${pullRequest.base.ref}`;
 				const chatSession: ChatSessionWithPR = {
-					id: `${pullRequest.number}`,
+					resource: vscode.Uri.from({ scheme: COPILOT_SWE_AGENT, path: '/' + pullRequest.number }),
 					label: pullRequest.title || `Session ${pullRequest.number}`,
 					iconPath: this.getIconForSession(status),
 					pullRequest: pullRequest,
@@ -1074,7 +1080,7 @@ export class CopilotRemoteAgentManager extends Disposable {
 						insertions: pullRequest.item.additions,
 						deletions: pullRequest.item.deletions
 					} : undefined
-				} as unknown as ChatSessionWithPR;
+				};
 				return chatSession;
 			}));
 		} catch (error) {
@@ -1083,7 +1089,7 @@ export class CopilotRemoteAgentManager extends Disposable {
 		return [];
 	}
 
-	public async provideChatSessionContent(id: string, token: vscode.CancellationToken): Promise<vscode.ChatSession> {
+	public async provideChatSessionContent(resource: URI, token: vscode.CancellationToken): Promise<vscode.ChatSession> {
 		try {
 			const capi = await this.copilotApi;
 			if (!capi || token.isCancellationRequested) {
@@ -1095,16 +1101,16 @@ export class CopilotRemoteAgentManager extends Disposable {
 			let pullRequestNumber: number | undefined;
 			let sessionIndex: number | undefined;
 
-			const indexedSessionId = SessionIdForPr.parse(id);
+			const indexedSessionId = SessionIdForPr.parse(resource);
 			if (indexedSessionId) {
 				pullRequestNumber = indexedSessionId.prNumber;
 				sessionIndex = indexedSessionId.sessionIndex;
 			}
 
 			if (typeof pullRequestNumber === 'undefined') {
-				pullRequestNumber = parseInt(id);
+				pullRequestNumber = parseInt(resource.path.slice(1));
 				if (isNaN(pullRequestNumber)) {
-					Logger.error(`Invalid pull request number: ${id}`, CopilotRemoteAgentManager.ID);
+					Logger.error(`Invalid pull request number: ${resource}`, CopilotRemoteAgentManager.ID);
 					return this.createEmptySession();
 				}
 			}

src/github/pullRequestOverview.ts

@@ -509,7 +509,7 @@ export class PullRequestOverviewPanel extends IssueOverviewPanel<PullRequestMode
 
 	private async openSessionLog(message: IRequestMessage<{ link: SessionLinkInfo }>): Promise<void> {
 		try {
-			return vscode.window.showChatSession(COPILOT_SWE_AGENT, SessionIdForPr.getId(this._item.number, message.args.link.sessionIndex), {});
+			return vscode.commands.executeCommand('vscode.open', COPILOT_SWE_AGENT, SessionIdForPr.getResource(this._item.number, message.args.link.sessionIndex));
 		} catch (e) {
 			Logger.error(`Open session log view failed: ${formatError(e)}`, PullRequestOverviewPanel.ID);
 		}

src/test/github/copilotRemoteAgent.test.ts

@@ -6,7 +6,7 @@
 import { default as assert } from 'assert';
 import { SinonSandbox, createSandbox } from 'sinon';
 import * as vscode from 'vscode';
-import { CopilotRemoteAgentManager } from '../../github/copilotRemoteAgent';
+import { CopilotRemoteAgentManager, SessionIdForPr } from '../../github/copilotRemoteAgent';
 import { MockCommandRegistry } from '../mocks/mockCommandRegistry';
 import { MockTelemetry } from '../mocks/mockTelemetry';
 import { CredentialStore } from '../../github/credentials';
@@ -21,6 +21,7 @@ import { ReposManagerState } from '../../github/folderRepositoryManager';
 import { GitApiImpl } from '../../api/api1';
 import { MockPrsTreeModel } from '../mocks/mockPRsTreeModel';
 import { PrsTreeModel } from '../../view/prsTreeModel';
+import { COPILOT_SWE_AGENT } from '../../common/copilot';
 
 const telemetry = new MockTelemetry();
 const protocol = new Protocol('https://github.com/github/test.git');
@@ -271,7 +272,7 @@ describe('CopilotRemoteAgentManager', function () {
 		it('should return empty session when copilot API is not available', async function () {
 			const token = new vscode.CancellationTokenSource().token;
 
-			const result = await manager.provideChatSessionContent('123', token);
+			const result = await manager.provideChatSessionContent(SessionIdForPr.getResource(123, 0), token);
 
 			assert.strictEqual(Array.isArray(result.history), true);
 			assert.strictEqual(result.history.length, 0);
@@ -282,7 +283,7 @@ describe('CopilotRemoteAgentManager', function () {
 			const tokenSource = new vscode.CancellationTokenSource();
 			tokenSource.cancel();
 
-			const result = await manager.provideChatSessionContent('123', tokenSource.token);
+			const result = await manager.provideChatSessionContent(SessionIdForPr.getResource(123, 0), tokenSource.token);
 
 			assert.strictEqual(Array.isArray(result.history), true);
 			assert.strictEqual(result.history.length, 0);
@@ -291,7 +292,7 @@ describe('CopilotRemoteAgentManager', function () {
 		it('should return empty session for invalid PR number', async function () {
 			const token = new vscode.CancellationTokenSource().token;
 
-			const result = await manager.provideChatSessionContent('invalid', token);
+			const result = await manager.provideChatSessionContent(vscode.Uri.from({ scheme: COPILOT_SWE_AGENT, path: '/invalid' }), token);
 
 			assert.strictEqual(Array.isArray(result.history), true);
 			assert.strictEqual(result.history.length, 0);