Add keepAlive configuration in NettyNioAsyncHttpClient

Author: zoewangg

.changes/next-release/feature-NettyNIOAsyncHTTPClient-6f2b347.json

@@ -0,0 +1,6 @@
+{
+    "category": "Netty NIO Async HTTP Client", 
+    "contributor": "", 
+    "type": "feature", 
+    "description": "Add `tcpKeepAlive` configuration."
+}

http-clients/netty-nio-client/src/main/java/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.java

@@ -26,6 +26,7 @@
 import io.netty.channel.EventLoopGroup;
 import io.netty.handler.ssl.SslContext;
 import io.netty.handler.ssl.SslProvider;
+import java.net.SocketOptions;
 import java.net.URI;
 import java.time.Duration;
 import java.util.concurrent.CompletableFuture;
@@ -359,6 +360,14 @@ public interface Builder extends SdkAsyncHttpClient.Builder<NettyNioAsyncHttpCli
          */
         Builder protocol(Protocol protocol);
 
+        /**
+         * Configure whether to enable support for TCP KeepAlive {@link SocketOptions#SO_KEEPALIVE}
+         *
+         * <p>
+         * By default, this is disabled.
+         */
+        Builder tcpKeepAlive(Boolean keepConnectionAlive);
+
         /**
          * Configures additional {@link ChannelOption} which will be used to create Netty Http client. This allows custom
          * configuration for Netty.
@@ -599,6 +608,16 @@ public void setProtocol(Protocol protocol) {
             protocol(protocol);
         }
 
+        @Override
+        public Builder tcpKeepAlive(Boolean keepConnectionAlive) {
+            standardOptions.put(SdkHttpConfigurationOption.TCP_KEEPALIVE, keepConnectionAlive);
+            return this;
+        }
+
+        public void setTcpKeepAlive(Boolean keepConnectionAlive) {
+            tcpKeepAlive(keepConnectionAlive);
+        }
+
         @Override
         public Builder putChannelOption(ChannelOption channelOption, Object value) {
             this.sdkChannelOptions.putOption(channelOption, value);

http-clients/netty-nio-client/src/main/java/software/amazon/awssdk/http/nio/netty/internal/BootstrapProvider.java

@@ -54,6 +54,7 @@ public Bootstrap createBootstrap(String host, int port) {
                 .group(sdkEventLoopGroup.eventLoopGroup())
                 .channelFactory(sdkEventLoopGroup.channelFactory())
                 .option(ChannelOption.CONNECT_TIMEOUT_MILLIS, nettyConfiguration.connectTimeoutMillis())
+                .option(ChannelOption.SO_KEEPALIVE, nettyConfiguration.tcpKeepAlive())
                 .remoteAddress(InetSocketAddress.createUnresolved(host, port));
         sdkChannelOptions.channelOptions().forEach(bootstrap::option);
 

http-clients/netty-nio-client/src/main/java/software/amazon/awssdk/http/nio/netty/internal/NettyConfiguration.java

@@ -19,6 +19,7 @@
 import static software.amazon.awssdk.http.SdkHttpConfigurationOption.CONNECTION_TIMEOUT;
 import static software.amazon.awssdk.http.SdkHttpConfigurationOption.MAX_CONNECTIONS;
 import static software.amazon.awssdk.http.SdkHttpConfigurationOption.MAX_PENDING_CONNECTION_ACQUIRES;
+import static software.amazon.awssdk.http.SdkHttpConfigurationOption.TCP_KEEPALIVE;
 import static software.amazon.awssdk.http.SdkHttpConfigurationOption.TRUST_ALL_CERTIFICATES;
 import static software.amazon.awssdk.utils.NumericUtils.saturatedCast;
 
@@ -97,4 +98,8 @@ public TlsTrustManagersProvider tlsTrustManagersProvider() {
     public boolean trustAllCertificates() {
         return configuration.get(TRUST_ALL_CERTIFICATES);
     }
+
+    public boolean tcpKeepAlive() {
+        return configuration.get(TCP_KEEPALIVE);
+    }
 }

http-clients/netty-nio-client/src/test/java/software/amazon/awssdk/http/nio/netty/internal/BootstrapProviderTest.java

@@ -17,19 +17,17 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static software.amazon.awssdk.http.SdkHttpConfigurationOption.GLOBAL_HTTP_DEFAULTS;
+import static software.amazon.awssdk.http.SdkHttpConfigurationOption.TCP_KEEPALIVE;
 
+import io.netty.bootstrap.Bootstrap;
+import io.netty.channel.ChannelOption;
 import java.net.InetSocketAddress;
 import java.net.SocketAddress;
-
 import org.junit.Test;
 import org.junit.runner.RunWith;
-import org.mockito.Mock;
 import org.mockito.runners.MockitoJUnitRunner;
-
-import io.netty.bootstrap.Bootstrap;
-import io.netty.resolver.AddressResolver;
-import io.netty.resolver.AddressResolverGroup;
 import software.amazon.awssdk.http.nio.netty.SdkEventLoopGroup;
+import software.amazon.awssdk.utils.AttributeMap;
 
 @RunWith(MockitoJUnitRunner.class)
 public class BootstrapProviderTest {
@@ -53,4 +51,27 @@ public void createBootstrap_usesUnresolvedInetSocketAddress() {
 
         assertThat(inetSocketAddress.isUnresolved()).isTrue();
     }
+
+    @Test
+    public void createBootstrap_defaultConfiguration_tcpKeepAliveShouldBeFalse() {
+        Bootstrap bootstrap = bootstrapProvider.createBootstrap("some-awesome-service-1234.amazonaws.com", 443);
+
+        Boolean keepAlive = (Boolean) bootstrap.config().options().get(ChannelOption.SO_KEEPALIVE);
+        assertThat(keepAlive).isFalse();
+    }
+
+    @Test
+    public void createBootstrap_tcpKeepAliveTrue_shouldApply() {
+        NettyConfiguration nettyConfiguration =
+            new NettyConfiguration(AttributeMap.builder().put(TCP_KEEPALIVE, true)
+                                                         .build().merge(GLOBAL_HTTP_DEFAULTS));
+        BootstrapProvider provider =
+            new BootstrapProvider(SdkEventLoopGroup.builder().build(),
+                                  nettyConfiguration,
+                                  new SdkChannelOptions());
+
+        Bootstrap bootstrap = provider.createBootstrap("some-awesome-service-1234.amazonaws.com", 443);
+        Boolean keepAlive = (Boolean) bootstrap.config().options().get(ChannelOption.SO_KEEPALIVE);
+        assertThat(keepAlive).isTrue();
+    }
 }