Let user select which github remote to target coding agent sessions against (#7645)

* Let user select which github remote to target coding agent sessions against

* update test

Author: joshspicer

package.json

@@ -1740,6 +1740,17 @@
 				"icon": "$(refresh)",
 				"category": "%command.pull.request.category%"
 			},
+			{
+				"command": "pr.preferredCodingAgentGitHubRemote",
+				"title": "%command.pr.preferredCodingAgentGitHubRemote.title%",
+				"icon": "$(gear)",
+				"category": "%command.pull.request.category%"
+			},
+			{
+				"command": "pr.resetCodingAgentPreferences",
+				"title": "%command.pr.resetCodingAgentPreferences.title%",
+				"category": "%command.pull.request.category%"
+			},
 			{
 				"command": "pr.closeChatSessionPullRequest",
 				"title": "%command.pr.closeChatSessionPullRequest.title%",
@@ -2653,6 +2664,11 @@
 					"command": "pr.refreshChatSessions",
 					"when": "view == workbench.view.chat.sessions.copilot-swe-agent",
 					"group": "navigation@1"
+				},
+				{
+					"command": "pr.preferredCodingAgentGitHubRemote",
+					"when": "view == workbench.view.chat.sessions.copilot-swe-agent",
+					"group": "navigation@1"
 				}
 			],
 			"view/item/context": [

package.nls.json

@@ -322,6 +322,8 @@
 	"command.notification.chatSummarizeNotification.title": "Summarize With Copilot",
 	"command.codingAgent.openSessionLog.title": "Open Coding Agent Session Log",
 	"command.pr.closeChatSessionPullRequest.title": "Close Pull Request",
+	"command.pr.preferredCodingAgentGitHubRemote.title": "Set Preferred GitHub Remote for Coding Agent Sessions",
+	"command.pr.resetCodingAgentPreferences.title": "Reset Coding Agent Workspace Preferences",
 	"command.pr.cancelCodingAgent.title": "Cancel Coding Agent",
 	"welcome.github.login.contents": {
 		"message": "You have not yet signed in with GitHub\n[Sign in](command:pr.signin)",

src/commands.ts

@@ -1903,4 +1903,16 @@ ${contents}
 			copilotRemoteAgentManager.refreshChatSessions();
 		})
 	);
+
+	context.subscriptions.push(
+		vscode.commands.registerCommand('pr.preferredCodingAgentGitHubRemote', async () => {
+			await copilotRemoteAgentManager.promptAndUpdatePreferredGitHubRemote();
+		})
+	);
+
+	context.subscriptions.push(
+		vscode.commands.registerCommand('pr.resetCodingAgentPreferences', async () => {
+			await copilotRemoteAgentManager.resetCodingAgentPreferences();
+		})
+	);
 }

src/github/copilotRemoteAgent.ts

@@ -44,6 +44,8 @@ const COPILOT = '@copilot';
 
 const body_suffix = vscode.l10n.t('Created from VS Code via the [GitHub Pull Request](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github) extension.');
 
+const PREFERRED_GITHUB_CODING_AGENT_REMOTE_WORKSPACE_KEY = 'PREFERRED_GITHUB_CODING_AGENT_REMOTE';
+
 export class CopilotRemoteAgentManager extends Disposable {
 	public static ID = 'CopilotRemoteAgentManager';
 
@@ -209,23 +211,72 @@ export class CopilotRemoteAgentManager extends Disposable {
 		);
 	}
 
+	public async resetCodingAgentPreferences() {
+		await this.context.workspaceState.update(PREFERRED_GITHUB_CODING_AGENT_REMOTE_WORKSPACE_KEY, undefined);
+	}
+
+	public async promptAndUpdatePreferredGitHubRemote(skipIfValueAlreadyCached = false): Promise<GitHubRemote | undefined> {
+		if (skipIfValueAlreadyCached) {
+			const cachedValue = await this.context.workspaceState.get(PREFERRED_GITHUB_CODING_AGENT_REMOTE_WORKSPACE_KEY);
+			if (cachedValue) {
+				return;
+			}
+		}
+
+		const fm = this.firstFolderManager();
+		if (!fm) {
+			return;
+		}
+
+		const ghRemotes = await fm.getAllGitHubRemotes();
+		Logger.trace(`There are ${ghRemotes.length} GitHub remotes available to select from`, CopilotRemoteAgentManager.ID);
+		if (!ghRemotes || ghRemotes.length === 0) {
+			return;
+		}
+
+		const result = await chooseItem<GitHubRemote>(
+			ghRemotes,
+			itemValue => `${itemValue.remoteName} (${itemValue.owner}/${itemValue.repositoryName})`,
+			{
+				title: vscode.l10n.t('Set the GitHub remote to target when creating a coding agent session'),
+			}
+		);
+
+		if (!result) {
+			Logger.warn('No coding agent GitHub remote selected. Clearing preferences.', CopilotRemoteAgentManager.ID);
+			return;
+		}
+
+		Logger.appendLine(`Updated '${result.remoteName}' as preferred coding agent remote`, CopilotRemoteAgentManager.ID);
+		await this.context.workspaceState.update(PREFERRED_GITHUB_CODING_AGENT_REMOTE_WORKSPACE_KEY, result.remoteName);
+		return result;
+	}
+
 	async repoInfo(fm?: FolderRepositoryManager): Promise<RepoInfo | undefined> {
 		fm = fm || this.firstFolderManager();
 		const repository = fm?.repository;
 		const ghRepository = fm?.gitHubRepositories.find(repo => repo.remote instanceof GitHubRemote) as GitHubRepository | undefined;
 		if (!fm || !repository || !ghRepository) {
 			return;
 		}
-
 		const baseRef = repository.state.HEAD?.name; // TODO: Consider edge cases
+		const preferredRemoteName = this.context.workspaceState.get(PREFERRED_GITHUB_CODING_AGENT_REMOTE_WORKSPACE_KEY);
 		const ghRemotes = await fm.getGitHubRemotes();
 		if (!ghRemotes || ghRemotes.length === 0) {
 			return;
 		}
 
 		const remote =
-			ghRemotes.find(remote => remote.remoteName === 'origin')
-			|| ghRemotes[0]; // Fallback to the first remote
+			preferredRemoteName
+				? ghRemotes.find(remote => remote.remoteName === preferredRemoteName) // Cached preferred value
+				: (ghRemotes.find(remote => remote.remoteName === 'origin') || ghRemotes[0]); // Fallback to the first remote
+
+		if (!remote) {
+			Logger.error(`no valid remotes for coding agent`, CopilotRemoteAgentManager.ID);
+			// Clear preference, something is wrong
+			this.context.workspaceState.update(PREFERRED_GITHUB_CODING_AGENT_REMOTE_WORKSPACE_KEY, undefined);
+			return;
+		}
 
 		// Extract repo data from target remote
 		const { owner, repositoryName: repo } = remote;
@@ -462,6 +513,10 @@ export class CopilotRemoteAgentManager extends Disposable {
 			return { error: vscode.l10n.t('Failed to initialize Copilot API'), state: 'error' };
 		}
 
+		if (!await this.promptAndUpdatePreferredGitHubRemote(true)) {
+			return { error: vscode.l10n.t('Cancelled setting preferred GitHub remote'), state: 'error' };
+		}
+
 		const repoInfo = await this.repoInfo();
 		if (!repoInfo) {
 			return { error: vscode.l10n.t('No repository information found. Please open a workspace with a GitHub repository.'), state: 'error' };

src/test/github/copilotRemoteAgent.test.ts

@@ -205,9 +205,6 @@ describe('CopilotRemoteAgentManager', function () {
 			const result = await manager.invokeRemoteAgent('test prompt', 'test context');
 
 			assert.strictEqual(result.state, 'error');
-			if (result.state === 'error') {
-				assert(result.error.includes('No repository information found'));
-			}
 		});
 	});