fix: Use the universe domain if it is provided by the user #1563
+172
−7
Conversation
This file contains 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
product-auto-label
bot
added
size: m
…ejs-bigtable into universe-domain-2
danieljbruce
commented
Jan 10, 2025
| servicePath: customEndpointBaseUrl || defaultAdminBaseUrl, | ||
| servicePath: | ||
| customEndpointBaseUrl || | ||
| `bigtableadmin.${getDomain(options.BigtableTableAdminClient)}`, |
There was a problem hiding this comment.
If no universe domain and custom endpoint is provided then this will still be bigtableadmin.googleapis.com.
danieljbruce
commented
Jan 10, 2025
| servicePath: customEndpointBaseUrl || defaultBaseUrl, | ||
| servicePath: | ||
| customEndpointBaseUrl || | ||
| `bigtable.${getDomain(options.BigtableClient)}`, |
There was a problem hiding this comment.
If no universe domain and custom endpoint is provided then this will still be bigtable.googleapis.com.
daniel-sanche
approved these changes
Jan 10, 2025
| * @returns {string} The universe domain. | ||
| */ | ||
| function getDomain(opts?: gax.ClientOptions) { | ||
| // This code for universe domain was taken from the Gapic Layer. |
There was a problem hiding this comment.
can you add a permalink to where this came from?
| servicePath: customEndpointBaseUrl || defaultBaseUrl, | ||
| servicePath: | ||
| customEndpointBaseUrl || | ||
| `bigtable.${getDomain(options.BigtableClient)}`, |
There was a problem hiding this comment.
What would you think about adding pathPrefix as an argument to getDomain (and maybe renaming the method if needed), instead of manually building the string here? I think that would be a bit easier to read, and seems more natural to me since the returned string isn't useful on its own
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.
Summary:
The user should be able to set the universe domain so that outgoing calls work with a different Google Cloud Universe. Right now, if the user specifies a universe domain then it will not get used and the request will just be sent to the default Bigtable endpoint.
Changes:
src/index.ts:The change here is that when a custom url is not provided, but a universe domain is provided then the servicePath will use the universe domain provided. This is done for each Gapic client and ensures requests will be made to the universe domain instead of the default Bigtable service.system-test/service-path.ts: Two tests are added to ensure the service path is always set correctly. For instance, when a custom endpoint is provided then the service path will still always be that custom endpoint. When a custom endpoint is NOT provided, but a universe domain is provided then the service path is set to use the universe domain instead of the default endpoint.Alternatives:
universeDomainoption that would apply to all clients. While this would make things easier for users, it is an API change so it is not reversible. For now we should not change the API since users already have a way to specify the universe domains for the Gapic clients. We can always add this option later.