feat: add GitHub Copilot Provider that support agent mode #7010 #7072

NaccOll · 2025-08-14T02:53:21Z

Related GitHub Issue

Closes: #7010

Description

Implemented the Copilot component with authentication and model selection features.
Added tests for the Copilot component covering authentication states, error handling, and model management.
Updated localization files to include Copilot-related strings in multiple languages.
Enhanced the model validation functions to support Copilot models.
Modified the useSelectedModel hook to handle Copilot model selection.
Updated the index file to export the Copilot component.

VS Code LM API cannot achieve multiple use of the tool consuming only one advanced request. Therefore, I implemented a Copilot Provider, mimicking the Copilot authentication process found at https://github.com/BerriAI/litellm and https://github.com/sst/opencode.

In my own test, I chose claude-4 and had him write a web version of Angry Birds. This involved reading and writing eight files, requiring approximately 20 tool calls and consuming only one premium requeust.

Test Procedure

Select Copilot as your service provider.
Click Copilot Authentication.
Copy the device code.
Click Open Link.
Enter the device code and wait for authentication to complete.
Select a model and save.
Start the task.

Pre-Submission Checklist

Issue Linked: This PR is linked to an approved GitHub Issue (see "Related GitHub Issue" above).
Scope: My changes are focused on the linked issue (one major feature/fix per PR).
Self-Review: I have performed a thorough self-review of my code.
Testing: New and/or updated tests have been added to cover my changes (if applicable).
Documentation Impact: I have considered if my changes require documentation updates (see "Documentation Updates" section below).
Contribution Guidelines: I have read and agree to the Contributor Guidelines.

Screenshots / Videos

Documentation Updates

Additional Notes

Get in Touch

Important

Adds GitHub Copilot Provider with agent mode, including authentication, model selection, and validation, with tests and localization updates.

Behavior:
- Adds CopilotHandler in copilot.ts for GitHub Copilot Provider with authentication and model selection.
- Updates webviewMessageHandler.ts to handle Copilot authentication and model requests.
- Supports model validation and selection in validate.ts and useSelectedModel.ts.
Tests:
- Adds tests for Copilot authentication and model handling in copilot.test.ts and webviewMessageHandler.copilot.test.ts.
- Tests for provider settings in provider-settings.copilot.test.ts.
Localization:
- Updates localization files for Copilot-related strings in multiple languages.
Misc:
- Adds Copilot component in ApiOptions.tsx for UI integration.
- Updates provider-settings.ts to include Copilot schema.

^{This description was created by}^{for 5b02f1b. You can customize this summary. It will automatically update as commits are pushed.}

…7010 - Implemented the Copilot component with authentication and model selection features. - Added tests for the Copilot component covering authentication states, error handling, and model management. - Updated localization files to include Copilot-related strings in multiple languages. - Enhanced the model validation functions to support Copilot models. - Modified the useSelectedModel hook to handle Copilot model selection. - Updated the index file to export the Copilot component.

ellipsis-dev · 2025-08-14T02:56:24Z

src/api/providers/__tests__/copilot.test.ts

+
+			const handler = new CopilotHandler(mockOptions)
+
+			await expect(handler.completePrompt("Test prompt")).rejects.toThrow(" Copilotetion error: API Error")


Typographical issue: The error message string contains "Copilotetion error: API Error" which appears to be a typo. Perhaps it should be something like "Copilot completion error: API Error"?

Suggested change

await expect(handler.completePrompt("Test prompt")).rejects.toThrow(" Copilotetion error: API Error")

await expect(handler.completePrompt("Test prompt")).rejects.toThrow(" Copilot completion error: API Error")

ellipsis-dev · 2025-08-14T02:56:25Z

src/api/providers/copilot.ts

+				timeout: getApiRequestTimeout(),
+			})
+		} catch (error) {
+			throw new Error(`Failed to authenticate with  Copilot: ${error}`)


Typographical error: The error message 'Failed to authenticate with Copilot: ...' contains an extra space before 'Copilot'. Please remove the extra space.

Suggested change

throw new Error(`Failed to authenticate with Copilot: ${error}`)

throw new Error(`Failed to authenticate with Copilot: ${error}`)

ellipsis-dev · 2025-08-14T02:56:25Z

src/api/providers/copilot.ts

+			return response.choices[0]?.message.content || ""
+		} catch (error) {
+			if (error instanceof Error) {
+				throw new Error(` Copilotetion error: ${error.message}`)


Typographical error: The error message ' Copilotetion error: ...' has a leading extra space and a misspelling. Consider revising it to something like 'Copilot completion error: ...' to improve clarity.

Suggested change

throw new Error(` Copilotetion error: ${error.message}`)

throw new Error(`Copilot completion error: ${error.message}`)

roomote

Thank you for your contribution! I've reviewed the GitHub Copilot Provider implementation and found it to be well-structured overall. The OAuth device flow authentication is properly implemented, and the TypeScript typing is comprehensive. However, there are some issues that need attention before merging.

roomote · 2025-08-14T02:58:18Z

src/api/providers/copilot.ts

+				timeout: getApiRequestTimeout(),
+			})
+		} catch (error) {
+			throw new Error(`Failed to authenticate with  Copilot: ${error}`)


Typo: There's an extra space here - should be "Copilot" not " Copilot"

Suggested change

throw new Error(`Failed to authenticate with Copilot: ${error}`)

throw new Error(`Failed to authenticate with Copilot: ${error}`)

roomote · 2025-08-14T02:58:18Z

src/api/providers/copilot.ts

+			return response.choices[0]?.message.content || ""
+		} catch (error) {
+			if (error instanceof Error) {
+				throw new Error(` Copilotetion error: ${error.message}`)


Same typo here - should be "Copilot completion" not " Copilotetion"

Suggested change

throw new Error(` Copilotetion error: ${error.message}`)

throw new Error(`Copilot completion error: ${error.message}`)

roomote · 2025-08-14T02:58:18Z

src/api/providers/copilot.ts

+		}
+		return result
+	} catch (error) {
+		console.error("Failed to fetch Copilot:", error)


Incomplete error message - should be "Failed to fetch Copilot models:" or similar

Suggested change

console.error("Failed to fetch Copilot:", error)

console.error("Failed to fetch Copilot models:", error)

roomote · 2025-08-14T02:58:18Z

src/api/providers/copilot.ts

+	/**
+	 * Determine the X-Initiator header based on message roles
+	 */
+	private determineInitiator(messages: Anthropic.Messages.MessageParam[]): string {


Is this X-Initiator logic correct? The method seems complex and the logic for determining 'agent' vs 'user' might not cover all edge cases. Could you add more comments explaining the rationale, or consider simplifying this?

Yeah. This method is mainly used to determine whether the last request was sent by the user. However, there is currently no such flag, which can only determine whether the text in the message has the specified tag.

roomote · 2025-08-14T02:58:18Z

src/api/providers/fetchers/copilot.ts

+
+	private constructor() {
+		// Store tokens in user's home directory
+		this.tokenDir = join(homedir(), ".roo-code", "copilot")


Security concern: Tokens are stored in plaintext at ~/.roo-code/copilot/tokens.json. Have you considered using VSCode's secret storage API instead for better security?

Example:

await context.secrets.store('copilot_access_token', accessToken)

roomote · 2025-08-14T02:58:18Z

src/api/providers/copilot.ts

+			apiKey: "placeholder",
+			defaultHeaders: {
+				...DEFAULT_HEADERS,
+				"editor-version": "vscode/1.85.1",


These version strings are hard-coded. Could they be made configurable or pulled from the actual VSCode/extension version?

Suggested change

"editor-version": "vscode/1.85.1",

"editor-version": vscode.version,

"editor-plugin-version": `copilot/${extensionVersion}`,

roomote · 2025-08-14T02:58:18Z

src/api/providers/copilot.ts

+			await this.ensureAuthenticated()
+
+			// Use the authenticated client to fetch models
+			const response = await fetch(`${this.client.baseURL}models`, {


Missing rate limiting logic. GitHub APIs have rate limits - should we add retry logic with exponential backoff for resilience?

roomote · 2025-08-14T02:58:19Z

src/api/providers/__tests__/copilot.test.ts

+vi.mock("../transform/openai-format")
+vi.mock("../transform/model-params")
+
+describe("CopilotHandler", () => {


Test coverage could be improved - consider adding tests for:

Error recovery scenarios

Token refresh logic

Rate limiting behavior

Full authentication flow including timeout scenarios

NaccOll requested review from mrubens, cte and jr as code owners August 14, 2025 02:53

github-project-automation bot added this to Roo Code Roadmap and Roo Code Roadmap Aug 14, 2025

github-project-automation bot moved this to Triage in Roo Code Roadmap Aug 14, 2025

github-project-automation bot moved this to New in Roo Code Roadmap Aug 14, 2025

dosubot bot added size:XXL This PR changes 1000+ lines, ignoring generated files. enhancement New feature or request labels Aug 14, 2025

ellipsis-dev bot reviewed Aug 14, 2025

View reviewed changes

roomote bot reviewed Aug 14, 2025

View reviewed changes

fix: update default model ID and disbale reason

ae0ac5c

hannesrudolph added the Issue/PR - Triage New issue. Needs quick review to confirm validity and assign labels. label Aug 14, 2025

NaccOll marked this pull request as draft August 14, 2025 04:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: add GitHub Copilot Provider that support agent mode #7010 #7072

feat: add GitHub Copilot Provider that support agent mode #7010 #7072

NaccOll commented Aug 14, 2025 •

edited by ellipsis-dev bot

Loading

Uh oh!

ellipsis-dev bot Aug 14, 2025

Uh oh!

ellipsis-dev bot Aug 14, 2025

Uh oh!

ellipsis-dev bot Aug 14, 2025

Uh oh!

roomote bot left a comment

Uh oh!

roomote bot Aug 14, 2025

Uh oh!

roomote bot Aug 14, 2025

Uh oh!

roomote bot Aug 14, 2025

Uh oh!

roomote bot Aug 14, 2025

Uh oh!

NaccOll Aug 14, 2025

Uh oh!

roomote bot Aug 14, 2025

Uh oh!

roomote bot Aug 14, 2025

Uh oh!

roomote bot Aug 14, 2025

Uh oh!

roomote bot Aug 14, 2025

Uh oh!

Uh oh!


		const handler = new CopilotHandler(mockOptions)

		await expect(handler.completePrompt("Test prompt")).rejects.toThrow(" Copilotetion error: API Error")

	throw new Error(`Failed to authenticate with Copilot: ${error}`)
	throw new Error(`Failed to authenticate with Copilot: ${error}`)

	throw new Error(` Copilotetion error: ${error.message}`)
	throw new Error(`Copilot completion error: ${error.message}`)

	console.error("Failed to fetch Copilot:", error)
	console.error("Failed to fetch Copilot models:", error)

	"editor-version": "vscode/1.85.1",
	"editor-version": vscode.version,
	"editor-plugin-version": `copilot/${extensionVersion}`,

feat: add GitHub Copilot Provider that support agent mode #7010 #7072

Are you sure you want to change the base?

feat: add GitHub Copilot Provider that support agent mode #7010 #7072

Conversation

NaccOll commented Aug 14, 2025 • edited by ellipsis-dev bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related GitHub Issue

Description

Test Procedure

Pre-Submission Checklist

Screenshots / Videos

Documentation Updates

Additional Notes

Get in Touch

Uh oh!

ellipsis-dev bot Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

ellipsis-dev bot Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

ellipsis-dev bot Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

roomote bot left a comment

Choose a reason for hiding this comment

Uh oh!

roomote bot Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

roomote bot Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

roomote bot Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

roomote bot Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

NaccOll Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

roomote bot Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

roomote bot Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

roomote bot Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

roomote bot Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

NaccOll commented Aug 14, 2025 •

edited by ellipsis-dev bot

Loading