From 998753816019dc5baff2b417646ffcc63865b207 Mon Sep 17 00:00:00 2001 From: Min Zhu Date: Thu, 5 Sep 2024 16:55:53 -0400 Subject: [PATCH 1/8] feat: expose property in GrpcTransportChannel if it uses direct path. --- .../com/google/api/gax/grpc/GrpcTransportChannel.java | 8 ++++++++ .../api/gax/grpc/InstantiatingGrpcChannelProvider.java | 3 ++- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java b/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java index 9e63bb2a63..7682808ca5 100644 --- a/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java +++ b/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java @@ -60,6 +60,8 @@ public GrpcCallContext getEmptyCallContext() { /** The channel in use. */ abstract ManagedChannel getManagedChannel(); + public abstract boolean getUseDirectPath(); + public Channel getChannel() { return getManagedChannel(); } @@ -107,10 +109,16 @@ public static GrpcTransportChannel create(ManagedChannel channel) { return newBuilder().setManagedChannel(channel).build(); } + public static GrpcTransportChannel create(ManagedChannel channel, boolean canUseDirectPath) { + return newBuilder().setManagedChannel(channel).setUseDirectPath(canUseDirectPath).build(); + } + @AutoValue.Builder public abstract static class Builder { public abstract Builder setManagedChannel(ManagedChannel value); + abstract Builder setUseDirectPath(boolean value); + public abstract GrpcTransportChannel build(); } } diff --git a/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java b/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java index c49d5265f7..1eab2b12bc 100644 --- a/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java +++ b/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java @@ -260,7 +260,8 @@ public TransportChannel getTransportChannel() throws IOException { private TransportChannel createChannel() throws IOException { return GrpcTransportChannel.create( ChannelPool.create( - channelPoolSettings, InstantiatingGrpcChannelProvider.this::createSingleChannel)); + channelPoolSettings, InstantiatingGrpcChannelProvider.this::createSingleChannel), + this.canUseDirectPath()); } private boolean isDirectPathEnabled() { From 49395691b993a5df926539d7dc1754461422001e Mon Sep 17 00:00:00 2001 From: Min Zhu Date: Fri, 6 Sep 2024 10:15:32 -0400 Subject: [PATCH 2/8] avoid exposing public abstract method. --- .../java/com/google/api/gax/grpc/GrpcTransportChannel.java | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java b/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java index 7682808ca5..9c3bf21208 100644 --- a/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java +++ b/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java @@ -60,7 +60,11 @@ public GrpcCallContext getEmptyCallContext() { /** The channel in use. */ abstract ManagedChannel getManagedChannel(); - public abstract boolean getUseDirectPath(); + abstract boolean getUseDirectPath(); + + public boolean useDirectPath() { + return getUseDirectPath(); + } public Channel getChannel() { return getManagedChannel(); From 14ce302da42c855a77877b59877e1dd8142b0c93 Mon Sep 17 00:00:00 2001 From: Min Zhu Date: Fri, 6 Sep 2024 11:00:25 -0400 Subject: [PATCH 3/8] set default and test. --- .../api/gax/grpc/GrpcTransportChannel.java | 2 +- .../InstantiatingGrpcChannelProviderTest.java | 20 +++++++++++++++---- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java b/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java index 9c3bf21208..70bbfb1ab2 100644 --- a/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java +++ b/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java @@ -106,7 +106,7 @@ public void close() { } public static Builder newBuilder() { - return new AutoValue_GrpcTransportChannel.Builder(); + return new AutoValue_GrpcTransportChannel.Builder().setUseDirectPath(false); } public static GrpcTransportChannel create(ManagedChannel channel) { diff --git a/gax-java/gax-grpc/src/test/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProviderTest.java b/gax-java/gax-grpc/src/test/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProviderTest.java index 4de1b8ee11..cfb268f6b3 100644 --- a/gax-java/gax-grpc/src/test/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProviderTest.java +++ b/gax-java/gax-grpc/src/test/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProviderTest.java @@ -706,7 +706,7 @@ void testLogDirectPathMisconfigNotOnGCE() throws Exception { } @Test - public void canUseDirectPath_happyPath() { + public void canUseDirectPath_happyPath() throws IOException { System.setProperty("os.name", "Linux"); EnvironmentProvider envProvider = Mockito.mock(EnvironmentProvider.class); Mockito.when( @@ -718,14 +718,20 @@ public void canUseDirectPath_happyPath() { .setAttemptDirectPath(true) .setCredentials(computeEngineCredentials) .setEndpoint(DEFAULT_ENDPOINT) - .setEnvProvider(envProvider); + .setEnvProvider(envProvider) + .setHeaderProvider(Mockito.mock(HeaderProvider.class)); InstantiatingGrpcChannelProvider provider = new InstantiatingGrpcChannelProvider(builder, GCE_PRODUCTION_NAME_AFTER_2016); Truth.assertThat(provider.canUseDirectPath()).isTrue(); + + // verify this info is passed correctly to transport channel + TransportChannel transportChannel = provider.getTransportChannel(); + Truth.assertThat(((GrpcTransportChannel) transportChannel).useDirectPath()).isTrue(); + transportChannel.shutdownNow(); } @Test - public void canUseDirectPath_directPathEnvVarDisabled() { + public void canUseDirectPath_directPathEnvVarDisabled() throws IOException { System.setProperty("os.name", "Linux"); EnvironmentProvider envProvider = Mockito.mock(EnvironmentProvider.class); Mockito.when( @@ -737,10 +743,16 @@ public void canUseDirectPath_directPathEnvVarDisabled() { .setAttemptDirectPath(true) .setCredentials(computeEngineCredentials) .setEndpoint(DEFAULT_ENDPOINT) - .setEnvProvider(envProvider); + .setEnvProvider(envProvider) + .setHeaderProvider(Mockito.mock(HeaderProvider.class)); InstantiatingGrpcChannelProvider provider = new InstantiatingGrpcChannelProvider(builder, GCE_PRODUCTION_NAME_AFTER_2016); Truth.assertThat(provider.canUseDirectPath()).isFalse(); + + // verify this info is passed correctly to transport channel + TransportChannel transportChannel = provider.getTransportChannel(); + Truth.assertThat(((GrpcTransportChannel) transportChannel).useDirectPath()).isFalse(); + transportChannel.shutdownNow(); } @Test From 6f57cb912d45de61f6b3c3a1bef1d01e0d07bc95 Mon Sep 17 00:00:00 2001 From: Min Zhu Date: Thu, 12 Sep 2024 13:28:00 -0400 Subject: [PATCH 4/8] use is prefix instead for autovalue. --- .../google/api/gax/grpc/GrpcTransportChannel.java | 12 ++++-------- .../grpc/InstantiatingGrpcChannelProviderTest.java | 4 ++-- 2 files changed, 6 insertions(+), 10 deletions(-) diff --git a/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java b/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java index 70bbfb1ab2..f09e8a1b2e 100644 --- a/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java +++ b/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java @@ -60,11 +60,7 @@ public GrpcCallContext getEmptyCallContext() { /** The channel in use. */ abstract ManagedChannel getManagedChannel(); - abstract boolean getUseDirectPath(); - - public boolean useDirectPath() { - return getUseDirectPath(); - } + public abstract boolean isDirectPath(); public Channel getChannel() { return getManagedChannel(); @@ -106,7 +102,7 @@ public void close() { } public static Builder newBuilder() { - return new AutoValue_GrpcTransportChannel.Builder().setUseDirectPath(false); + return new AutoValue_GrpcTransportChannel.Builder().setDirectPath(false); } public static GrpcTransportChannel create(ManagedChannel channel) { @@ -114,14 +110,14 @@ public static GrpcTransportChannel create(ManagedChannel channel) { } public static GrpcTransportChannel create(ManagedChannel channel, boolean canUseDirectPath) { - return newBuilder().setManagedChannel(channel).setUseDirectPath(canUseDirectPath).build(); + return newBuilder().setManagedChannel(channel).setDirectPath(canUseDirectPath).build(); } @AutoValue.Builder public abstract static class Builder { public abstract Builder setManagedChannel(ManagedChannel value); - abstract Builder setUseDirectPath(boolean value); + abstract Builder setDirectPath(boolean value); public abstract GrpcTransportChannel build(); } diff --git a/gax-java/gax-grpc/src/test/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProviderTest.java b/gax-java/gax-grpc/src/test/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProviderTest.java index cfb268f6b3..a4bcb65a1a 100644 --- a/gax-java/gax-grpc/src/test/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProviderTest.java +++ b/gax-java/gax-grpc/src/test/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProviderTest.java @@ -726,7 +726,7 @@ public void canUseDirectPath_happyPath() throws IOException { // verify this info is passed correctly to transport channel TransportChannel transportChannel = provider.getTransportChannel(); - Truth.assertThat(((GrpcTransportChannel) transportChannel).useDirectPath()).isTrue(); + Truth.assertThat(((GrpcTransportChannel) transportChannel).isDirectPath()).isTrue(); transportChannel.shutdownNow(); } @@ -751,7 +751,7 @@ public void canUseDirectPath_directPathEnvVarDisabled() throws IOException { // verify this info is passed correctly to transport channel TransportChannel transportChannel = provider.getTransportChannel(); - Truth.assertThat(((GrpcTransportChannel) transportChannel).useDirectPath()).isFalse(); + Truth.assertThat(((GrpcTransportChannel) transportChannel).isDirectPath()).isFalse(); transportChannel.shutdownNow(); } From 2e16a3b59859b2900d9dcb5c463c24a4602854cf Mon Sep 17 00:00:00 2001 From: Min Zhu Date: Thu, 12 Sep 2024 13:38:49 -0400 Subject: [PATCH 5/8] remove unecessary create method, and use builder to construct TransportChannel. --- .../com/google/api/gax/grpc/GrpcTransportChannel.java | 4 ---- .../api/gax/grpc/InstantiatingGrpcChannelProvider.java | 10 ++++++---- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java b/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java index f09e8a1b2e..2fa0908f17 100644 --- a/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java +++ b/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/GrpcTransportChannel.java @@ -109,10 +109,6 @@ public static GrpcTransportChannel create(ManagedChannel channel) { return newBuilder().setManagedChannel(channel).build(); } - public static GrpcTransportChannel create(ManagedChannel channel, boolean canUseDirectPath) { - return newBuilder().setManagedChannel(channel).setDirectPath(canUseDirectPath).build(); - } - @AutoValue.Builder public abstract static class Builder { public abstract Builder setManagedChannel(ManagedChannel value); diff --git a/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java b/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java index 1eab2b12bc..5d601e8fa6 100644 --- a/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java +++ b/gax-java/gax-grpc/src/main/java/com/google/api/gax/grpc/InstantiatingGrpcChannelProvider.java @@ -258,10 +258,12 @@ public TransportChannel getTransportChannel() throws IOException { } private TransportChannel createChannel() throws IOException { - return GrpcTransportChannel.create( - ChannelPool.create( - channelPoolSettings, InstantiatingGrpcChannelProvider.this::createSingleChannel), - this.canUseDirectPath()); + return GrpcTransportChannel.newBuilder() + .setManagedChannel( + ChannelPool.create( + channelPoolSettings, InstantiatingGrpcChannelProvider.this::createSingleChannel)) + .setDirectPath(this.canUseDirectPath()) + .build(); } private boolean isDirectPathEnabled() { From 8e5a9affb8bfdf57d3f92c33f032c71364e601d1 Mon Sep 17 00:00:00 2001 From: Min Zhu Date: Thu, 12 Sep 2024 16:11:16 -0400 Subject: [PATCH 6/8] add clirr ignore rule. --- gax-java/gax-grpc/clirr-ignored-differences.xml | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 gax-java/gax-grpc/clirr-ignored-differences.xml diff --git a/gax-java/gax-grpc/clirr-ignored-differences.xml b/gax-java/gax-grpc/clirr-ignored-differences.xml new file mode 100644 index 0000000000..8b595b0a85 --- /dev/null +++ b/gax-java/gax-grpc/clirr-ignored-differences.xml @@ -0,0 +1,10 @@ + + + + + + 7013 + com/google/api/gax/grpc/GrpcTransportChannel + boolean isDirectPath() + + From 9611d30b5a2e5cfa14bf25103184067470144202 Mon Sep 17 00:00:00 2001 From: Min Zhu Date: Thu, 12 Sep 2024 16:23:35 -0400 Subject: [PATCH 7/8] remove unused clirr ignore rule from gax module. --- gax-java/gax/clirr-ignored-differences.xml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/gax-java/gax/clirr-ignored-differences.xml b/gax-java/gax/clirr-ignored-differences.xml index cbaed47eb5..af5c5f26a1 100644 --- a/gax-java/gax/clirr-ignored-differences.xml +++ b/gax-java/gax/clirr-ignored-differences.xml @@ -66,11 +66,6 @@ com/google/api/gax/*/* *org.threeten.bp.Duration *() - - 7002 - com/google/api/gax/grpc/InstantiatingGrpcChannelProvider$Builder - * * - 7012 From 6cfed7b2402f07c9cefb64e0cfc15de06d397f7d Mon Sep 17 00:00:00 2001 From: Min Zhu Date: Fri, 13 Sep 2024 10:50:20 -0400 Subject: [PATCH 8/8] add test for default value in newBuilder(). --- .../gax/grpc/GrpcTransportChannelTest.java | 48 +++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 gax-java/gax-grpc/src/test/java/com/google/api/gax/grpc/GrpcTransportChannelTest.java diff --git a/gax-java/gax-grpc/src/test/java/com/google/api/gax/grpc/GrpcTransportChannelTest.java b/gax-java/gax-grpc/src/test/java/com/google/api/gax/grpc/GrpcTransportChannelTest.java new file mode 100644 index 0000000000..337f054c42 --- /dev/null +++ b/gax-java/gax-grpc/src/test/java/com/google/api/gax/grpc/GrpcTransportChannelTest.java @@ -0,0 +1,48 @@ +/* + * Copyright 2024 Google LLC + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above + * copyright notice, this list of conditions and the following disclaimer + * in the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Google LLC nor the names of its + * contributors may be used to endorse or promote products derived from + * this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +package com.google.api.gax.grpc; + +import static org.junit.jupiter.api.Assertions.*; + +import io.grpc.ManagedChannel; +import org.junit.jupiter.api.Test; +import org.mockito.Mockito; + +class GrpcTransportChannelTest { + + @Test + void testBuilderDefaults() { + ManagedChannel channel = Mockito.mock(ManagedChannel.class); + GrpcTransportChannel grpcTransportChannel = + GrpcTransportChannel.newBuilder().setManagedChannel(channel).build(); + assertFalse(grpcTransportChannel.isDirectPath()); + } +} pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy