refactor: Add TransportChannelProvider's endpoint to EndpointContext (#…

…2294) * refactor: Add transportchannelprovider's endpoint to EndpointContext * chore: Add Endpoint tests for ClientContext * chore: Resolve PR comments
googleapis · Dec 11, 2023 · c0e03cd · c0e03cd
1 parent 4029fbd
commit c0e03cd
Show file tree

Hide file tree

Showing 7 changed files with 179 additions and 21 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
@@ -430,6 +430,7 @@ private ManagedChannel createSingleChannel() throws IOException {
   }
 
   /** The endpoint to be used for the channel. */
+  @Override
   public String getEndpoint() {
     return endpoint;
   }

diff --git a/...pjson/src/main/java/com/google/api/gax/httpjson/InstantiatingHttpJsonChannelProvider.java b/...pjson/src/main/java/com/google/api/gax/httpjson/InstantiatingHttpJsonChannelProvider.java
@@ -207,6 +207,7 @@ private HttpJsonTransportChannel createChannel() throws IOException, GeneralSecu
   }
 
   /** The endpoint to be used for the channel. */
+  @Override
   public String getEndpoint() {
     return endpoint;
   }

diff --git a/gax-java/gax/clirr-ignored-differences.xml b/gax-java/gax/clirr-ignored-differences.xml
@@ -19,4 +19,10 @@
     <method>*setWaitTimeout*</method>
     <to>com.google.api.gax.rpc.ServerStreamingCallSettings$Builder</to>
   </difference>
+  <!-- Add a default Endpoint Getter -->
+  <difference>
+    <differenceType>7012</differenceType>
+    <className>com/google/api/gax/rpc/TransportChannelProvider</className>
+    <method>* getEndpoint()</method>
+  </difference>
 </differences>
diff --git a/gax-java/gax/src/main/java/com/google/api/gax/rpc/ClientContext.java b/gax-java/gax/src/main/java/com/google/api/gax/rpc/ClientContext.java
@@ -203,6 +203,8 @@ public static ClientContext create(StubSettings settings) throws IOException {
     EndpointContext endpointContext =
         EndpointContext.newBuilder()
             .setClientSettingsEndpoint(settings.getEndpoint())
+            .setTransportChannelProviderEndpoint(
+                settings.getTransportChannelProvider().getEndpoint())
             .setMtlsEndpoint(settings.getMtlsEndpoint())
             .setSwitchToMtlsEndpointAllowed(settings.getSwitchToMtlsEndpointAllowed())
             .build();

diff --git a/gax-java/gax/src/main/java/com/google/api/gax/rpc/EndpointContext.java b/gax-java/gax/src/main/java/com/google/api/gax/rpc/EndpointContext.java
@@ -46,6 +46,13 @@ public abstract class EndpointContext {
   @Nullable
   public abstract String clientSettingsEndpoint();
 
+  /**
+   * TransportChannelProviderEndpoint is the endpoint value set via the TransportChannelProvider
+   * class.
+   */
+  @Nullable
+  public abstract String transportChannelProviderEndpoint();
+
   @Nullable
   public abstract String mtlsEndpoint();
 
@@ -65,9 +72,13 @@ public static Builder newBuilder() {
   @VisibleForTesting
   void determineEndpoint() throws IOException {
     MtlsProvider mtlsProvider = mtlsProvider() == null ? new MtlsProvider() : mtlsProvider();
+    String customEndpoint =
+        transportChannelProviderEndpoint() == null
+            ? clientSettingsEndpoint()
+            : transportChannelProviderEndpoint();
     resolvedEndpoint =
         mtlsEndpointResolver(
-            clientSettingsEndpoint(), mtlsEndpoint(), switchToMtlsEndpointAllowed(), mtlsProvider);
+            customEndpoint, mtlsEndpoint(), switchToMtlsEndpointAllowed(), mtlsProvider);
   }
 
   // This takes in parameters because determineEndpoint()'s logic will be updated
@@ -111,6 +122,12 @@ public abstract static class Builder {
      */
     public abstract Builder setClientSettingsEndpoint(String clientSettingsEndpoint);
 
+    /**
+     * TransportChannelProviderEndpoint is the endpoint value set via the TransportChannelProvider
+     * class.
+     */
+    public abstract Builder setTransportChannelProviderEndpoint(String transportChannelEndpoint);
+
     public abstract Builder setMtlsEndpoint(String mtlsEndpoint);
 
     public abstract Builder setSwitchToMtlsEndpointAllowed(boolean switchToMtlsEndpointAllowed);

diff --git a/gax-java/gax/src/main/java/com/google/api/gax/rpc/TransportChannelProvider.java b/gax-java/gax/src/main/java/com/google/api/gax/rpc/TransportChannelProvider.java
@@ -142,4 +142,13 @@ public interface TransportChannelProvider {
    * <p>This string can be used for identifying transports for switching logic.
    */
   String getTransportName();
+
+  /**
+   * User set custom endpoint for the Transport Channel Provider
+   *
+   * <p>This is the unresolved endpoint used by GAPICs
+   */
+  default String getEndpoint() {
+    return null;
+  }
 }