feat(copilot): add Copilot request executor and model registry [3/5] #382
Conversation
- Add auth directory management helper (GetAuthDir) - Add random hex string generator for request IDs - Add helper for generating unique machine identifiers
|
Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits. |
Summary of ChangesHello @jeffnash, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly expands the system's capabilities by integrating GitHub Copilot support. It introduces a robust framework for authenticating with Copilot, executing requests, and dynamically managing available models. The changes ensure seamless interaction with Copilot's various API endpoints, including proper header handling for different request types and account configurations. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces significant new functionality for GitHub Copilot integration. It adds the core authentication flow using device codes, a request executor that handles Copilot-specific headers, and a dynamic model registry. The changes are well-structured, with new packages for Copilot authentication and shared types. I've identified a critical compilation error due to a duplicated struct definition, a potential race condition in a new management handler, and a couple of places where error handling could be improved. Overall, this is a solid implementation of a complex feature.
internal/config/config.go
Outdated
| // CopilotKey represents the configuration for GitHub Copilot API access. | ||
| // Authentication is handled via device code OAuth flow, not API keys. | ||
| type CopilotKey struct { | ||
| // AccountType is the Copilot subscription type (individual, business, enterprise). | ||
| // Defaults to "individual" if not specified. | ||
| AccountType string `yaml:"account-type" json:"account-type"` | ||
|
|
||
| // ProxyURL overrides the global proxy setting for Copilot requests if provided. | ||
| ProxyURL string `yaml:"proxy-url,omitempty" json:"proxy-url,omitempty"` | ||
|
|
||
| // AgentInitiatorPersist, when true, forces subsequent Copilot requests sharing the | ||
| // same prompt_cache_key to send X-Initiator=agent after the first call. Default false. | ||
| AgentInitiatorPersist bool `yaml:"agent-initiator-persist" json:"agent-initiator-persist"` | ||
| } | ||
|
|
||
| // CopilotKey represents the configuration for GitHub Copilot API access. | ||
| // Authentication is handled via device code OAuth flow, not API keys. | ||
| type CopilotKey struct { | ||
| // AccountType is the Copilot subscription type (individual, business, enterprise). | ||
| // Defaults to "individual" if not specified. | ||
| AccountType string `yaml:"account-type" json:"account-type"` | ||
|
|
||
| // ProxyURL overrides the global proxy setting for Copilot requests if provided. | ||
| ProxyURL string `yaml:"proxy-url,omitempty" json:"proxy-url,omitempty"` | ||
|
|
||
| // AgentInitiatorPersist, when true, forces subsequent Copilot requests sharing the | ||
| // same prompt_cache_key to send X-Initiator=agent after the first call. Default false. | ||
| AgentInitiatorPersist bool `yaml:"agent-initiator-persist" json:"agent-initiator-persist"` | ||
| } |
There was a problem hiding this comment.
The CopilotKey struct is defined multiple times. This will cause a compilation error due to redeclaration. Please remove the duplicate definitions.
| func (h *Handler) PutCopilotKeys(c *gin.Context) { | ||
| data, err := c.GetRawData() | ||
| if err != nil { | ||
| c.JSON(400, gin.H{"error": "failed to read body"}) | ||
| return | ||
| } | ||
| var arr []config.CopilotKey | ||
| if err = json.Unmarshal(data, &arr); err != nil { | ||
| var obj struct { | ||
| Items []config.CopilotKey `json:"items"` | ||
| } | ||
| if err2 := json.Unmarshal(data, &obj); err2 != nil || len(obj.Items) == 0 { | ||
| c.JSON(400, gin.H{"error": "invalid body"}) | ||
| return | ||
| } | ||
| arr = obj.Items | ||
| } | ||
| // Normalize entries | ||
| filtered := make([]config.CopilotKey, 0, len(arr)) | ||
| for i := range arr { | ||
| entry := arr[i] | ||
| entry.AccountType = strings.TrimSpace(entry.AccountType) | ||
| entry.ProxyURL = strings.TrimSpace(entry.ProxyURL) | ||
| filtered = append(filtered, entry) | ||
| } | ||
| h.cfg.CopilotKey = filtered | ||
| h.cfg.SanitizeCopilotKeys() | ||
| h.persist(c) | ||
| } |
There was a problem hiding this comment.
The PutCopilotKeys function modifies h.cfg.CopilotKey, which is a shared configuration object. Other handler functions like PatchCopilotKey and DeleteCopilotKey use a mutex to protect concurrent access. To prevent potential race conditions, this function should also use a mutex lock.
func (h *Handler) PutCopilotKeys(c *gin.Context) {
data, err := c.GetRawData()
if err != nil {
c.JSON(400, gin.H{"error": "failed to read body"})
return
}
var arr []config.CopilotKey
if err = json.Unmarshal(data, &arr); err != nil {
var obj struct {
Items []config.CopilotKey `json:"items"`
}
if err2 := json.Unmarshal(data, &obj); err2 != nil || len(obj.Items) == 0 {
c.JSON(400, gin.H{"error": "invalid body"})
return
}
arr = obj.Items
}
// Normalize entries
filtered := make([]config.CopilotKey, 0, len(arr))
for i := range arr {
entry := arr[i]
entry.AccountType = strings.TrimSpace(entry.AccountType)
entry.ProxyURL = strings.TrimSpace(entry.ProxyURL)
filtered = append(filtered, entry)
}
h.mu.Lock()
defer h.mu.Unlock()
h.cfg.CopilotKey = filtered
h.cfg.SanitizeCopilotKeys()
h.persist(c)
}
config.example.yaml
Outdated
| # GitHub Copilot account configuration | ||
| # Note: Copilot uses OAuth device code authentication, NOT API keys or tokens. | ||
| # Do NOT paste your GitHub access token or Copilot bearer token here. | ||
| # Tokens are stored only in auth-dir JSON files, never in config.yaml. | ||
| # | ||
| # To authenticate: | ||
| # - CLI: run with -copilot-login flag | ||
| # - Web: use the /copilot-auth-url management endpoint | ||
| # | ||
| # After OAuth login, tokens are managed automatically and stored in auth-dir. | ||
| # The entries below only configure account type and optional proxy settings. | ||
| #copilot-api-key: | ||
| # - account-type: "individual" # Options: individual, business, enterprise | ||
| # proxy-url: "socks5://proxy.example.com:1080" # optional: proxy for Copilot requests | ||
|
|
||
| # # When set to true, this flag forces subsequent requests in a session (sharing the same prompt_cache_key) | ||
| # # to send the header "X-Initiator: agent" instead of "vscode". This mirrors VS Code's behavior for | ||
| # # long-running agent interactions and helps prevent hitting standard rate limits. | ||
| # agent-initiator-persist: true | ||
|
|
||
| # GitHub Copilot account configuration | ||
| # Note: Copilot uses OAuth device code authentication, NOT API keys or tokens. | ||
| # Do NOT paste your GitHub access token or Copilot bearer token here. | ||
| # Tokens are stored only in auth-dir JSON files, never in config.yaml. | ||
| # | ||
| # To authenticate: | ||
| # - CLI: run with -copilot-login flag | ||
| # - Web: use the /copilot-auth-url management endpoint | ||
| # | ||
| # After OAuth login, tokens are managed automatically and stored in auth-dir. | ||
| # The entries below only configure account type and optional proxy settings. | ||
| #copilot-api-key: | ||
| # - account-type: "individual" # Options: individual, business, enterprise | ||
| # proxy-url: "socks5://proxy.example.com:1080" # optional: proxy for Copilot requests | ||
|
|
||
| # # When set to true, this flag forces subsequent requests in a session (sharing the same prompt_cache_key) | ||
| # # to send the header "X-Initiator: agent" instead of "vscode". This mirrors VS Code's behavior for | ||
| # # long-running agent interactions and helps prevent hitting standard rate limits. | ||
| # agent-initiator-persist: true | ||
|
|
There was a problem hiding this comment.
This configuration block for copilot-api-key is duplicated. It seems to be a copy-paste error. Please remove the redundant blocks to avoid confusion for users configuring the service.
| "client_id": GitHubClientID, | ||
| "scope": GitHubAppScopes, | ||
| } | ||
| bodyBytes, _ := json.Marshal(reqBody) |
There was a problem hiding this comment.
The error from json.Marshal is being ignored. While it's unlikely to fail when marshalling a map[string]string, it's best practice to handle potential errors to prevent unexpected behavior.
bodyBytes, err := json.Marshal(reqBody)
if err != nil {
return nil, fmt.Errorf("%w: failed to marshal request body: %v", ErrDeviceCodeFailed, err)
}| "device_code": deviceCode, | ||
| "grant_type": "urn:ietf:params:oauth:grant-type:device_code", | ||
| } | ||
| bodyBytes, _ := json.Marshal(reqBody) |
There was a problem hiding this comment.
The error from json.Marshal is being ignored. While it's unlikely to fail when marshalling a map[string]string, it's best practice to handle potential errors to prevent unexpected behavior.
bodyBytes, err := json.Marshal(reqBody)
if err != nil {
return "", fmt.Errorf("failed to marshal access token request: %w", err)
}
|
@luispater just saw your rule on no 3p resellers, I could disable all non-copilot models (i.e. keep raptor-mini + oswe) and commit the gemini PR + dynamic model fetching and other models in the registry to the new repo. also curious about how this works since iFlow has qwen, kimi, glm, and others |
- Add Copilot section with agent-initiator-persist flag - Add scanner buffer size configuration - Add account type configuration option - Add copilot types with account type validation - Document configuration options in example config - Add tests for util and copilot types
- Add device-code OAuth flow with GitHub token exchange - Implement Copilot token acquisition and refresh logic - Add account type handling (individual/business/enterprise) - Add token persistence and storage management - Add CLI login command (cliproxy-api copilot login) - Register Copilot refresh handler in SDK - Validate account_type with warning for invalid values
jeffnash
force-pushed
the
feat/copilot-executor
branch
from
8e9ba84 to
21a24d3
Compare
- Implement Copilot executor with header injection - Add VS Code version headers and integration IDs - Add agent header logic (X-Initiator detection) - Add vision request header for image inputs - Add static model registry with raptor-mini and oswe-vscode-prime - Add management API endpoints for auth files Note: Full model list and dynamic fetching added in gemini branch
jeffnash
force-pushed
the
feat/copilot-executor
branch
from
21a24d3 to
11a07b6
Compare
2 participants
Summary
Implements the Copilot request executor with header injection and dynamic model registry.
Changes
Stack
This is PR 3/5 in the Copilot feature stack:
Depends on: #381 - merge that first