Skip to content

Commit 5b2ab82

Browse files
rmehta19rmehta19
authored
fix: S2A- Check if a default endpoint has been set (#3784)
Certain handwritten client libraries set this field to the (TLS) endpoint via [`GrpcTransportOptions.setUpChannelProvider`](https://github.com/googleapis/sdk-platform-java/blob/2a41393c0e148e96fd3a0a8e1505e0827aa4fd3a/java-core/google-cloud-core-grpc/src/main/java/com/google/cloud/grpc/GrpcTransportOptions.java#L165). This isn't really a custom endpoint, so we should be able to use S2A when this is set. Example with Cloud Logging: https://github.com/googleapis/java-logging/blob/644ebd756d44ffc02b58aa30d9a07c8afe700981/google-cloud-logging/src/main/java/com/google/cloud/logging/spi/v2/GrpcLoggingRpc.java#L137
1 parent b528708 commit 5b2ab82

2 files changed

Lines changed: 15 additions & 2 deletions

File tree

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -327,8 +327,12 @@ boolean shouldUseS2A() {
327327
}
328328

329329
// If a custom endpoint is being used, skip S2A.
330-
if (!Strings.isNullOrEmpty(clientSettingsEndpoint())
331-
|| !Strings.isNullOrEmpty(transportChannelProviderEndpoint())) {
330+
if ((!Strings.isNullOrEmpty(clientSettingsEndpoint())
331+
&& !buildEndpointTemplate(serviceName(), resolvedUniverseDomain())
332+
.contains(clientSettingsEndpoint()))
333+
|| (!Strings.isNullOrEmpty(transportChannelProviderEndpoint())
334+
&& !buildEndpointTemplate(serviceName(), resolvedUniverseDomain())
335+
.contains(transportChannelProviderEndpoint()))) {
332336
return false;
333337
}
334338

‎gax-java/gax/src/test/java/com/google/api/gax/rpc/EndpointContextTest.java‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -380,6 +380,7 @@ void endpointContextBuild_shouldUseS2A_tlsEndpoint() throws IOException {
380380
defaultEndpointContextBuilder =
381381
defaultEndpointContextBuilder
382382
.setEnvProvider(envProvider)
383+
.setResolvedUniverseDomain(Credentials.GOOGLE_DEFAULT_UNIVERSE)
383384
.setClientSettingsEndpoint("")
384385
.setTransportChannelProviderEndpoint("")
385386
.setUsingGDCH(false);
@@ -478,6 +479,7 @@ void shouldUseS2A_envVarNotSet_returnsFalse() throws IOException {
478479
defaultEndpointContextBuilder =
479480
defaultEndpointContextBuilder
480481
.setEnvProvider(envProvider)
482+
.setResolvedUniverseDomain(Credentials.GOOGLE_DEFAULT_UNIVERSE)
481483
.setClientSettingsEndpoint("")
482484
.setTransportChannelProviderEndpoint("")
483485
.setUsingGDCH(false);
@@ -491,6 +493,7 @@ void shouldUseS2A_UsingGDCH_returnsFalse() throws IOException {
491493
defaultEndpointContextBuilder =
492494
defaultEndpointContextBuilder
493495
.setEnvProvider(envProvider)
496+
.setResolvedUniverseDomain(Credentials.GOOGLE_DEFAULT_UNIVERSE)
494497
.setClientSettingsEndpoint("")
495498
.setTransportChannelProviderEndpoint("")
496499
.setUsingGDCH(true);
@@ -504,6 +507,7 @@ void shouldUseS2A_customEndpointSetViaClientSettings_returnsFalse() throws IOExc
504507
defaultEndpointContextBuilder =
505508
defaultEndpointContextBuilder
506509
.setEnvProvider(envProvider)
510+
.setResolvedUniverseDomain(Credentials.GOOGLE_DEFAULT_UNIVERSE)
507511
.setClientSettingsEndpoint("test.endpoint.com:443")
508512
.setTransportChannelProviderEndpoint("")
509513
.setUsingGDCH(false);
@@ -517,6 +521,7 @@ void shouldUseS2A_customEndpointSetViaTransportChannelProvider_returnsFalse() th
517521
defaultEndpointContextBuilder =
518522
defaultEndpointContextBuilder
519523
.setEnvProvider(envProvider)
524+
.setResolvedUniverseDomain(Credentials.GOOGLE_DEFAULT_UNIVERSE)
520525
.setClientSettingsEndpoint("")
521526
.setTransportChannelProviderEndpoint("test.endpoint.com:443")
522527
.setUsingGDCH(false);
@@ -530,6 +535,7 @@ void shouldUseS2A_mtlsEndpointNull_returnsFalse() throws IOException {
530535
defaultEndpointContextBuilder =
531536
defaultEndpointContextBuilder
532537
.setEnvProvider(envProvider)
538+
.setResolvedUniverseDomain(Credentials.GOOGLE_DEFAULT_UNIVERSE)
533539
.setClientSettingsEndpoint("")
534540
.setTransportChannelProviderEndpoint("")
535541
.setUsingGDCH(false)
@@ -544,6 +550,7 @@ void shouldUseS2A_mtlsEndpointEmpty_returnsFalse() throws IOException {
544550
defaultEndpointContextBuilder =
545551
defaultEndpointContextBuilder
546552
.setEnvProvider(envProvider)
553+
.setResolvedUniverseDomain(Credentials.GOOGLE_DEFAULT_UNIVERSE)
547554
.setClientSettingsEndpoint("")
548555
.setTransportChannelProviderEndpoint("")
549556
.setMtlsEndpoint("")
@@ -558,6 +565,7 @@ void shouldUseS2A_mtlsEndpointNotGoogleDefaultUniverse_returnsFalse() throws IOE
558565
defaultEndpointContextBuilder =
559566
defaultEndpointContextBuilder
560567
.setEnvProvider(envProvider)
568+
.setResolvedUniverseDomain(Credentials.GOOGLE_DEFAULT_UNIVERSE)
561569
.setClientSettingsEndpoint("")
562570
.setTransportChannelProviderEndpoint("")
563571
.setMtlsEndpoint("test.mtls.abcd.com:443")
@@ -572,6 +580,7 @@ void shouldUseS2A_success() throws IOException {
572580
defaultEndpointContextBuilder =
573581
defaultEndpointContextBuilder
574582
.setEnvProvider(envProvider)
583+
.setResolvedUniverseDomain(Credentials.GOOGLE_DEFAULT_UNIVERSE)
575584
.setClientSettingsEndpoint("")
576585
.setTransportChannelProviderEndpoint("")
577586
.setUsingGDCH(false);

0 commit comments

Comments
 (0)