refactor: Add EndpointContext by lqiu96 · Pull Request #2275 · googleapis/sdk-platform-java

lqiu96 · 2023-11-29T22:15:40Z

Thank you for opening a Pull Request! For general contributing guidelines, please refer to contributing guide

Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
Ensure the tests and linter pass
Code coverage does not decrease (if any source code was changed)
Appropriate docs were updated (if necessary)

Description

EndpointContext is a new class created to resolve the correct endpoint. Client library users are able customize the endpoint in various ways and this class is the source of truth to resolve all the customizations.

Currently supports:

ClientSettings/ StubSettings endpoint value
mTLS endpoint value
switchToMtls flag

The logic to resolve the endpoint was moved from the ClientContext into the EndpointContext. In this PR, no additional logic was added.

blakeli0 · 2023-11-30T18:17:44Z

Can we integrate EndpointContext into the existing code and make sure all functionalities are not affected? It may not be a good practice to have a chore PR introduces new classes without any reference to it. Because it does not provide additional functionality, and it's not easy for reviewers to understand the purpose of the new class. It would be better if we can make this PR a proper refactor.

lqiu96 · 2023-12-01T17:54:39Z

Can we integrate EndpointContext into the existing code and make sure all functionalities are not affected? It may not be a good practice to have a chore PR introduces new classes without any reference to it. Because it does not provide additional functionality, and it's not easy for reviewers to understand the purpose of the new class. It would be better if we can make this PR a proper refactor.

Added usage of the EndpointContext in the ClientContext to determine the endpoint.

blakeli0 · 2023-12-05T22:06:27Z

+  public abstract String clientSettingsEndpoint();
+
+  @Nullable
+  public abstract String transportChannelEndpoint();


Will we ever need to pass in transportChannelEndpoint?
I see that there is no getters for the endpoint set to transport channel, maybe we want to expose one? So that we can set all the info to EndpointContext?
It's also OK to leave transportChannelEndpoint out of EndpointContext for now, if that's the case, then it's better to remove this field at this moment.

Will we ever need to pass in transportChannelEndpoint?

I believe so to keep with the existing behavior where transportChannelEndpoint overrides the clientSettingsEndpoint if set. Right now, the ClientContext doesn't set it inside the EndpointContext but the code to use it exists here:

sdk-platform-java/gax-java/gax/src/main/java/com/google/api/gax/rpc/ClientContext.java

Lines 233 to 235 in da6607b

if (transportChannelProvider.needsEndpoint()) {

transportChannelProvider = transportChannelProvider.withEndpoint(endpoint);

}

The reason I haven't added it in yet is because I most likely will need to expose an additional getEndpoint() method to the TransportChannelProvider: https://github.com/googleapis/sdk-platform-java/blob/da6607b17130ab045640618d505fda915ddb8e49/gax-java/gax/src/main/java/com/google/api/gax/rpc/TransportChannelProvider.java (Note: grpc and httpjson's transportchannel already have a getEndpoint() method). I was planning on doing this on the next PR as this one only introduces the EndpointContext.

I see your point about including it then, so I'll drop the transportChannelEndpoint values from this PR and add it in the next PR.

blakeli0 · 2023-12-05T22:16:20Z

+    return endpoint;
+  }
+
+  public String resolveEndpoint() throws IOException {


Can we try to resolve the endpoint in the build() method and just expose a getter for the resolved endpoint?

I'm using Autovalue's Builder which I believe generates the build() implementation for us. I could create my own Builder class if that's preferable.

Edit: Actually, I think I see a section that I can configure. I'll try that.

Yeah, it's a common practice to validate or normalize a field value in the build() method, see internal docs here. We have examples in our repo as well.

blakeli0 · 2023-12-05T22:20:52Z

+@AutoValue
+public abstract class EndpointContext {
+  @Nullable
+  public abstract String clientSettingsEndpoint();


I don't think this can be null as it is coming from StubSettings.endpoint?

I believe for most non-modified GAPICs, this is the case. It should be set via the {Service}StubSettings like: https://github.com/googleapis/google-cloud-java/blob/6227504db7c511b379cad2d67960d63f36eed39b/java-grafeas/src/main/java/io/grafeas/v1/stub/GrafeasStubSettings.java#L635 with a non-null value (as the generator will fail if it can't find it).

I'm accounting for the Grafeas edge case: https://github.com/googleapis/google-cloud-java/blob/6227504db7c511b379cad2d67960d63f36eed39b/java-grafeas/src/main/java/io/grafeas/v1/stub/GrafeasStubSettings.java#L403-L405 which has post-processed changes.

I see, this is good for now then. Let's keep this in mind and come back for it later if we have time. I'm not sure why we removed the default endpoint for grafeas, and how does grafeas create channels without a default endpoint. But ideally this should not be nullable, otherwise gRPC channel creation could fail.

lqiu96 · 2023-12-06T18:11:45Z

Removed the methods and seeing CLIRR check failures:

I've removed the public functions and seeing the CLIRR failure:
Error:  7002: com.google.api.gax.rpc.EndpointContext: Method 'public java.lang.String resolveEndpoint()' has been removed
Error:  7002: com.google.api.gax.rpc.EndpointContext: Method 'public java.lang.String transportChannelEndpoint()' has been removed
Error:  7002: com.google.api.gax.rpc.EndpointContext$Builder: Method 'public com.google.api.gax.rpc.EndpointContext$Builder setTransportChannelEndpoint(java.lang.String)' has been removed

This was due to the old gax version being cached in gh actions. Cleared the cache and re-ran.

sonarqubecloud · 2023-12-07T22:09:28Z

[gapic-generator-java-root] SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

0.0% Coverage
0.0% Duplication

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

sonarqubecloud · 2023-12-07T22:13:21Z

[java_showcase_integration_tests] SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

74.4% Coverage
0.0% Duplication

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

blakeli0

LGTM. Before merging, can you please add more info to the description to explain the purpose of EndpointContext?
I would reword the title as well, I think this is more like a refactor instead of feat. Because we added a new class to encapsulate existing features but didn't introduce any new features.

lqiu96 · 2023-12-08T02:07:24Z

LGTM. Before merging, can you please add more info to the description to explain the purpose of EndpointContext? I would reword the title as well, I think this is more like a refactor instead of feat. Because we added a new class to encapsulate existing features but didn't introduce any new features.

Added.

product-auto-label Bot added the size: l Pull request size is large. label Nov 29, 2023

lqiu96 added the owlbot:run Add this label to trigger the Owlbot post processor. label Nov 29, 2023

gcf-owl-bot Bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Nov 29, 2023

blakeli0 reviewed Nov 30, 2023

View reviewed changes

Comment thread gax-java/gax/src/main/java/com/google/api/gax/rpc/EndpointContext.java Outdated

lqiu96 changed the title ~~chore: Add EndpointContext~~ feat: Add EndpointContext Nov 30, 2023

lqiu96 added the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 1, 2023

gcf-owl-bot Bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Dec 1, 2023

lqiu96 marked this pull request as ready for review December 1, 2023 02:07

lqiu96 requested a review from a team December 1, 2023 02:07

lqiu96 requested a review from blakeli0 December 1, 2023 17:54

blakeli0 reviewed Dec 5, 2023

View reviewed changes

lqiu96 added 12 commits December 6, 2023 12:59

chore: Add EndpointContext

769a209

chore: Update constants scope to private

b12beeb

chore: Rename tests

7bc8951

chore: Fix lint issues

c67a679

chore: Clean up EndpointContext

2e1962f

chore: Add uses for the EndpointContext in ClientContext

2ebd48b

chore: Replace ClientContext getEndpoint() logic

6f9928d

chore: Remove stubsettings code

201d786

chore: Clean up EndpointContext test case

de2e309

chore: Fix lint issues

d7f48f7

chore: Add variables for test params

ce5255a

feat: Remove TransportChannelProvider logic

a6eeda8

lqiu96 force-pushed the add-endpoint-context branch from 1f56ada to a6eeda8 Compare December 6, 2023 18:00

lqiu96 commented Dec 7, 2023

View reviewed changes

Comment thread gax-java/gax/src/main/java/com/google/api/gax/rpc/EndpointContext.java Outdated

lqiu96 commented Dec 7, 2023

View reviewed changes

Comment thread gax-java/gax/src/main/java/com/google/api/gax/rpc/EndpointContext.java

lqiu96 commented Dec 7, 2023

View reviewed changes

Comment thread gax-java/gax/src/main/java/com/google/api/gax/rpc/EndpointContext.java

feat: Add javadocs for clientSettingsEndpoint

588fd53

lqiu96 requested a review from blakeli0 December 7, 2023 22:37

blakeli0 approved these changes Dec 7, 2023

View reviewed changes

lqiu96 changed the title ~~feat: Add EndpointContext~~ refactor: Add EndpointContext Dec 8, 2023

lqiu96 merged commit 2cb0f9e into main Dec 8, 2023

lqiu96 deleted the add-endpoint-context branch December 8, 2023 02:07

blakeli0 mentioned this pull request Feb 28, 2024

SonarCloud stopped working #2520

Closed

lqiu96 mentioned this pull request Jun 13, 2024

feat: Introduce java.time to Gax-Java #1872

Merged

	if (transportChannelProvider.needsEndpoint()) {
	transportChannelProvider = transportChannelProvider.withEndpoint(endpoint);
	}

Conversation

lqiu96 commented Nov 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

blakeli0 commented Nov 30, 2023

Uh oh!

Uh oh!

lqiu96 commented Dec 1, 2023

Uh oh!

blakeli0 Dec 5, 2023

Choose a reason for hiding this comment

Uh oh!

lqiu96 Dec 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

blakeli0 Dec 5, 2023

Choose a reason for hiding this comment

Uh oh!

lqiu96 Dec 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

blakeli0 Dec 6, 2023

Choose a reason for hiding this comment

Uh oh!

blakeli0 Dec 5, 2023

Choose a reason for hiding this comment

Uh oh!

lqiu96 Dec 5, 2023

Choose a reason for hiding this comment

Uh oh!

blakeli0 Dec 6, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lqiu96 commented Dec 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud Bot commented Dec 7, 2023

Uh oh!

sonarqubecloud Bot commented Dec 7, 2023

Uh oh!

blakeli0 left a comment

Choose a reason for hiding this comment

Uh oh!

lqiu96 commented Dec 8, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

lqiu96 commented Nov 29, 2023 •

edited

Loading

lqiu96 Dec 5, 2023 •

edited

Loading

lqiu96 Dec 5, 2023 •

edited

Loading

lqiu96 commented Dec 6, 2023 •

edited

Loading