fix(proxy): route /api/graphql to correct upstream for GHE Cloud data residency#6861
Merged
Conversation
Copilot
AI
changed the title
[WIP] Fix DIFC proxy returning 404 on GraphQL requests
fix(proxy): route /api/graphql to correct upstream for GHE Cloud data residency
Jun 1, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the proxy’s GraphQL upstream URL construction to support GHEC data residency API hosts (e.g. copilot-api.<tenant>.ghe.com) that don’t use an /api/v3 API base but still expect GraphQL at /api/graphql.
Changes:
- Add a new GraphQL URL rewrite branch in
forwardToGitHub()to handle/api/graphqlon non-/api/v3API bases. - Update/extend unit tests to reflect the new
/api/graphqlpreservation behavior (including query string handling).
Show a summary per file
| File | Description |
|---|---|
| internal/proxy/proxy.go | Adjusts GraphQL upstream URL rewrite logic to support GHEC data residency routing. |
| internal/proxy/forward_to_github_test.go | Adds test cases for the new /api/graphql behavior. |
| internal/proxy/proxy_test.go | Updates GraphQL rewrite expectations for non-/api/v3 API bases. |
| internal/proxy/handler_test.go | Updates handler forwarding expectations for /api/graphql and query strings. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 4/4 changed files
- Comments generated: 4
Comment on lines
361
to
+365
| pathOnly, query, hasQuery := strings.Cut(path, "?") | ||
| if IsGraphQLPath(pathOnly) { | ||
| graphqlURL := s.githubAPIURL + "/graphql" | ||
| var graphqlURL string | ||
| if strings.HasSuffix(s.githubAPIURL, "/api/v3") { | ||
| // GHES: strip /api/v3, GraphQL lives at /api/graphql |
Comment on lines
+917
to
+921
| {name: "plain graphql endpoint", path: "/graphql", wantPath: "/graphql"}, | ||
| {name: "ghes api graphql endpoint", path: "/api/graphql", wantPath: "/graphql"}, | ||
| // /api/graphql is treated as GHE Cloud data residency — path is preserved, not normalised to /graphql. | ||
| {name: "ghes api graphql endpoint", path: "/api/graphql", wantPath: "/api/graphql"}, | ||
| {name: "gh host prefixed graphql endpoint", path: "/api/v3/graphql", wantPath: "/graphql"}, | ||
| {name: "graphql endpoint with query string", path: "/api/graphql?foo=bar", wantPath: "/graphql", wantQuery: "foo=bar"}, | ||
| {name: "graphql endpoint with query string", path: "/api/graphql?foo=bar", wantPath: "/api/graphql", wantQuery: "foo=bar"}, |
Comment on lines
238
to
242
| // /api/graphql is treated as GHE Cloud data residency — path is preserved, not normalised to /graphql. | ||
| {name: "ghes api graphql path", path: "/api/graphql", wantPath: "/api/graphql"}, | ||
| {name: "ghes api graphql path with query", path: "/api/graphql?foo=bar", wantPath: "/api/graphql?foo=bar"}, | ||
| {name: "gh host prefixed graphql path", path: "/api/v3/graphql", wantPath: "/graphql"}, | ||
| {name: "gh host prefixed graphql path with query", path: "/api/v3/graphql?foo=bar", wantPath: "/graphql?foo=bar"}, |
Comment on lines
+188
to
+192
| { | ||
| // GHE Cloud data residency (e.g. copilot-api.sj.ghe.com) has no /api/v3 | ||
| // suffix but the gh CLI sends GraphQL requests to /api/graphql. | ||
| // forwardToGitHub must forward to base/api/graphql, not base/graphql. | ||
| name: "GHE Cloud data residency api/graphql path routes to base/api/graphql", |
Collaborator
|
@copilot address review feedback |
Contributor
Author
Closed
This was referenced Jun 7, 2026
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
forwardToGitHub()only handled two GraphQL upstream URL cases (github.com →/graphql, GHES →/api/graphql), causing a 404 for GHE Cloud data residency instances (e.g.copilot-api.sj.ghe.com) which have no/api/v3suffix ingithubAPIURLbut expect/api/graphqlon upstream.Changes
internal/proxy/proxy.go— refine GraphQL routing so/api/graphqlis preserved only for GHE Cloud data residency upstreams (copilot-api.*.ghe.com), while dotcom continues to normalize to/graphql:.../api/v3) →/api/graphqlcopilot-api.*.ghe.com) + inbound/api/graphql→/api/graphql/graphql/api/graphql/) before matchinginternal/proxy/forward_to_github_test.go— updateTestForwardToGitHub_GraphQLPathRoutingto:copilot-api.*.ghe.comhost routing for data residency behavior/api/graphqland/api/graphql/normalize to/graphqlinternal/proxy/proxy_test.go,internal/proxy/handler_test.go— restore dotcom expectations so inbound/api/graphqlis normalized to/graphql(with query string preserved).