Skip to content

[log] Add debug logging to GitHub API URL derivation #6043

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lpcox merged 2 commits into from
May 20, 2026
Merged

[log] Add debug logging to GitHub API URL derivation #6043

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2db3f8d
Add debug logging to deriveAPIFromServerURL
github-actions[bot] May 19, 2026
d5a93a8
Redact URL values in GitHub API debug logs
Copilot May 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions internal/envutil/github.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"strings"

"github.com/github/gh-aw-mcpg/internal/logger"
"github.com/github/gh-aw-mcpg/internal/logger/sanitize"
)

var logGitHub = logger.New("envutil:github")
Expand Down Expand Up @@ -66,37 +67,50 @@ func DeriveGitHubAPIURL(defaultURL string) string {
if serverURL := strings.TrimSpace(os.Getenv("GITHUB_SERVER_URL")); serverURL != "" {
derived := deriveAPIFromServerURL(serverURL)
if derived != "" {
logGitHub.Printf("GitHub API URL derived from GITHUB_SERVER_URL=%s: %s", serverURL, derived)
logGitHub.Printf("GitHub API URL derived from GITHUB_SERVER_URL=%s: %s", sanitize.RedactURL(serverURL), sanitize.RedactURL(derived))
return derived
}
}
return strings.TrimRight(strings.TrimSpace(defaultURL), "/")
result := strings.TrimRight(strings.TrimSpace(defaultURL), "/")
logGitHub.Printf("GitHub API URL falling back to provided default: %s", sanitize.RedactURL(result))
return result
}

// deriveAPIFromServerURL converts a GITHUB_SERVER_URL to the corresponding API endpoint.
// GHEC tenants (*.ghe.com): https://tenant.ghe.com → https://copilot-api.tenant.ghe.com
// GitHub.com: https://github.com → https://api.github.com
// GHES (all others): https://github.example.com → https://github.example.com/api/v3
func deriveAPIFromServerURL(serverURL string) string {
logGitHub.Printf("Deriving API URL from server URL: %s", sanitize.RedactURL(serverURL))

parsed, err := url.Parse(strings.TrimRight(serverURL, "/"))
if err != nil || parsed.Host == "" {
logGitHub.Printf("Failed to parse server URL or empty host: serverURL=%s, err=%v", sanitize.RedactURL(serverURL), err)
return ""
}
if parsed.Scheme != "http" && parsed.Scheme != "https" {
logGitHub.Printf("Unsupported scheme in server URL: scheme=%s, serverURL=%s", parsed.Scheme, sanitize.RedactURL(serverURL))
return ""
}

hostname := strings.ToLower(parsed.Hostname())

switch {
case hostname == "github.com" || hostname == "www.github.com":
logGitHub.Printf("GitHub.com detected, using default API URL: %s", DefaultGitHubAPIBaseURL)
return DefaultGitHubAPIBaseURL
case strings.HasSuffix(hostname, ".ghe.com"):
var apiURL string
if port := parsed.Port(); port != "" {
return fmt.Sprintf("%s://copilot-api.%s:%s", parsed.Scheme, hostname, port)
apiURL = fmt.Sprintf("%s://copilot-api.%s:%s", parsed.Scheme, hostname, port)
} else {
apiURL = fmt.Sprintf("%s://copilot-api.%s", parsed.Scheme, hostname)
}
return fmt.Sprintf("%s://copilot-api.%s", parsed.Scheme, hostname)
logGitHub.Printf("GHEC tenant detected, using copilot-api subdomain: hostname=%s, apiURL=%s", hostname, apiURL)
return apiURL
default:
return fmt.Sprintf("%s://%s/api/v3", parsed.Scheme, parsed.Host)
apiURL := fmt.Sprintf("%s://%s/api/v3", parsed.Scheme, parsed.Host)
logGitHub.Printf("GHES instance detected, using /api/v3 path: host=%s, apiURL=%s", parsed.Host, apiURL)
return apiURL
}
}
Loading