-
Notifications
You must be signed in to change notification settings - Fork 135
chore: abstract plain text settings into a SpannerOption #4264
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
base: main
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @sagnghos, 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 introduces a significant quality-of-life improvement for developers working with experimental Spanner hosts. By abstracting the complex setup for plaintext communication into a single 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
|
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.
Code Review
This pull request introduces a new usePlainText option in SpannerOptions.Builder to simplify connecting to experimental hosts over plaintext. The implementation correctly handles setting up the channel for plaintext, disabling credentials, and ensuring the host string is correctly formatted with an http:// prefix regardless of the order of method calls. The changes are well-tested. I've added one suggestion to refactor some duplicated logic to improve code maintainability.
google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java
Show resolved
Hide resolved
|
|
||
| @ExperimentalApi("https://github.com/googleapis/java-spanner/pull/3676") | ||
| public Builder setExperimentalHost(String host) { | ||
| if (this.usePlainText && !host.startsWith("http")) { |
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.
nit: You might want to do a slightly more elaborate check here, considering that this is intended to make things as easy as possible for users, and check that there is also no other protocol prefix present (e.g. add something like Preconditions.checkArgument(!host.startsWith("https:", "Only plain text commmunication is supported for experimental host. Please remove the 'https:' protocol prefix from the host string.")
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.
Thanks. I did add a check but in the message mentioned that Please remove the 'https:' protocol prefix from the host string when using plain text communication because we do support mTLS and tls as well using Java Client
google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java
Outdated
Show resolved
Hide resolved
7418bc5 to
24e196e
Compare
24e196e to
fbe6fb1
Compare
Introduce a SpannerOption usePlainText: a single, additive option that configures the channel for plaintext transport, disables credentials, and sets the protocol for plain-text communication when missing, making it easy and ergonomic to connect to experimental hosts over plain text communication.