-
Notifications
You must be signed in to change notification settings - Fork 1.6k
feat(source/bigquery): add apiEndpoint for custom API host #3358
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.
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
Open
hannank-rounds
wants to merge
1
commit into
googleapis:main
Choose a base branch
from
hannank-rounds:feat/source-bigquery-api-endpoint
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| // Copyright 2026 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package bigquery | ||
|
|
||
| import ( | ||
| "strings" | ||
|
|
||
| "google.golang.org/api/option" | ||
| ) | ||
|
|
||
| // normalizeAPIEndpoint returns a value accepted by option.WithEndpoint for both | ||
| // the bigquery client and the bigquery/v2 REST service. Empty/whitespace yields | ||
| // "" (default Google endpoint). The scheme is preserved so http-only proxies and | ||
| // emulators (e.g. http://localhost:9050) keep working; a missing scheme defaults | ||
| // to https. A default port is appended when absent (:80 for http, else :443), and | ||
| // a trailing slash is removed. | ||
| func normalizeAPIEndpoint(raw string) string { | ||
| s := strings.TrimSpace(raw) | ||
| if s == "" { | ||
| return "" | ||
| } | ||
| scheme := "https://" | ||
| for _, p := range []string{"https://", "http://"} { | ||
| if len(s) >= len(p) && strings.EqualFold(s[:len(p)], p) { | ||
| scheme, s = p, s[len(p):] | ||
| break | ||
| } | ||
| } | ||
| host := strings.TrimSuffix(s, "/") | ||
| if !strings.Contains(host, ":") { | ||
| if scheme == "http://" { | ||
| host += ":80" | ||
| } else { | ||
| host += ":443" | ||
| } | ||
| } | ||
| return scheme + host | ||
| } | ||
|
|
||
| func appendAPIEndpointOption(opts []option.ClientOption, apiEndpoint string) []option.ClientOption { | ||
| if ep := normalizeAPIEndpoint(apiEndpoint); ep != "" { | ||
| return append(opts, option.WithEndpoint(ep)) | ||
| } | ||
| return opts | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| // Copyright 2026 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package bigquery | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "google.golang.org/api/option" | ||
| ) | ||
|
|
||
| func TestNormalizeAPIEndpoint(t *testing.T) { | ||
| tcs := []struct { | ||
| in string | ||
| want string | ||
| }{ | ||
| {"", ""}, | ||
| {" ", ""}, | ||
| {"https://proxy.example.com", "https://proxy.example.com:443"}, | ||
| {"https://proxy.example.com/", "https://proxy.example.com:443"}, | ||
| {"http://proxy.example.com", "http://proxy.example.com:80"}, | ||
| {"http://localhost:9050", "http://localhost:9050"}, | ||
| {"proxy.example.com", "https://proxy.example.com:443"}, | ||
| {"proxy.example.com:8443", "https://proxy.example.com:8443"}, | ||
| } | ||
| for _, tc := range tcs { | ||
| t.Run(tc.in, func(t *testing.T) { | ||
| if got := normalizeAPIEndpoint(tc.in); got != tc.want { | ||
| t.Fatalf("normalizeAPIEndpoint(%q) = %q, want %q", tc.in, got, tc.want) | ||
| } | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| func TestAppendAPIEndpointOption(t *testing.T) { | ||
| base := []option.ClientOption{option.WithUserAgent("test")} | ||
|
|
||
| if got := appendAPIEndpointOption(base, ""); len(got) != len(base) { | ||
| t.Fatalf("empty endpoint: got %d options, want %d", len(got), len(base)) | ||
| } | ||
| if got := appendAPIEndpointOption(base, "https://proxy.example.com"); len(got) != len(base)+1 { | ||
| t.Fatalf("set endpoint: got %d options, want %d", len(got), len(base)+1) | ||
| } | ||
| } |
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The current implementation of
normalizeAPIEndpointstrips the URL scheme (e.g.,http://orhttps://) and appends:443if no port is specified. This causes issues when a user explicitly configures an HTTP endpoint (such ashttp://localhost:8080orhttp://proxy.example.comfor local emulators or HTTP proxies).When the scheme is stripped, the Google API client library's HTTP transport automatically prepends
https://because the endpoint does not contain://. This forces the client to use HTTPS/TLS, which will fail against HTTP-only proxies or emulators.We should preserve the scheme if it is present, and only append the default port (
80for HTTP,443for HTTPS or when no scheme is specified) if no port is explicitly provided.