fix: Verify Universe Domain's DirectPath Compatibility after Endpoint…

… Resolution
googleapis · Jan 23, 2024 · 371a69a · 371a69a
1 parent 909bdf9
commit 371a69a
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 2 deletions.
diff --git a/...java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java b/...java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java
@@ -295,6 +295,7 @@ private void logDirectPathMisconfig() {
               Level.WARNING,
               "DirectPath is misconfigured. DirectPath is only available in a GCE environment.");
         }
+        // Case 4: Universe Domain is non-GDU
         if (!canUseDirectPathWithUniverseDomain()) {
           LOG.log(
               Level.WARNING, "DirectPath will only work in the the googleapis.com Universe Domain");
@@ -334,8 +335,16 @@ static boolean isOnComputeEngine() {
     return false;
   }
 
-  private boolean canUseDirectPathWithUniverseDomain() {
-    return endpoint.contains("googleapis.com");
+  // Universe Domain configuration is currently only supported in the GDU
+  @VisibleForTesting
+  boolean canUseDirectPathWithUniverseDomain() {
+    // ClientContext will set an endpoint if it isn't provided to the TransportChannelProvider
+    // If the endpoint is null, then the endpoint hasn't been fully resolved yet (client not
+    // initialized). Before a call goes through with DirectPath, this validation must succeed.
+    if (endpoint == null) {
+      return true;
+    }
+    return endpoint.contains(Credentials.GOOGLE_DEFAULT_UNIVERSE);
   }
 
   @VisibleForTesting

diff --git a/.../gax-grpc/src/test/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProviderTest.java b/.../gax-grpc/src/test/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProviderTest.java
@@ -292,6 +292,38 @@ public void testDirectPathDisallowNullCredentials() throws IOException {
     assertThat(provider.isCredentialDirectPathCompatible()).isFalse();
   }
 
+  @Test
+  public void testDirectPathWithNullEndpoint() {
+    InstantiatingGrpcChannelProvider provider =
+        InstantiatingGrpcChannelProvider.newBuilder()
+            .setAttemptDirectPath(true)
+            .setAttemptDirectPathXds()
+            .build();
+    assertThat(provider.canUseDirectPathWithUniverseDomain()).isTrue();
+  }
+
+  @Test
+  public void testDirectPathWithGDUEndpoint() {
+    InstantiatingGrpcChannelProvider provider =
+        InstantiatingGrpcChannelProvider.newBuilder()
+            .setAttemptDirectPath(true)
+            .setAttemptDirectPathXds()
+            .setEndpoint("test.googleapis.com:443")
+            .build();
+    assertThat(provider.canUseDirectPathWithUniverseDomain()).isTrue();
+  }
+
+  @Test
+  public void testDirectPathWithNonGDUEndpoint() {
+    InstantiatingGrpcChannelProvider provider =
+        InstantiatingGrpcChannelProvider.newBuilder()
+            .setAttemptDirectPath(true)
+            .setAttemptDirectPathXds()
+            .setEndpoint("test.random.com:443")
+            .build();
+    assertThat(provider.canUseDirectPathWithUniverseDomain()).isFalse();
+  }
+
   @Test
   public void testDirectPathXdsEnabled() throws IOException {
     InstantiatingGrpcChannelProvider provider =