upgrade httpcore5/httpclient5 to support ExtendedSocketOption in Http…

…AsyncClient Signed-off-by: kkewwei <[email protected]> Signed-off-by: kkewwei <[email protected]>
opensearch-project · Dec 3, 2024 · 71872d7 · 71872d7
1 parent b75f27a
commit 71872d7
Show file tree

Hide file tree

Showing 18 changed files with 53 additions and 11 deletions.
diff --git a/CHANGELOG-3.0.md b/CHANGELOG-3.0.md
@@ -15,6 +15,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Views, simplify data access and manipulation by providing a virtual layer over one or more indices ([#11957](https://github.com/opensearch-project/OpenSearch/pull/11957))
 
 ### Dependencies
+- Bump Apache HttpCore5/HttpClient5 dependencies from 5.2.5/5.3.1 to 5.3.1/5.4.1 to support ExtendedSocketOption in HttpAsyncClient ([#16757](https://github.com/opensearch-project/OpenSearch/pull/16757))
 
 ### Changed
 - Changed locale provider from COMPAT to CLDR  ([#14345](https://github.com/opensearch-project/OpenSearch/pull/14345))

diff --git a/client/rest/licenses/httpclient5-5.3.1.jar.sha1 b/client/rest/licenses/httpclient5-5.3.1.jar.sha1
diff --git a/client/rest/licenses/httpclient5-5.4.1.jar.sha1 b/client/rest/licenses/httpclient5-5.4.1.jar.sha1
@@ -0,0 +1 @@
+ce913081e592ee8eeee35c4e577d7dce13cba7a4
diff --git a/client/rest/licenses/httpcore5-5.2.5.jar.sha1 b/client/rest/licenses/httpcore5-5.2.5.jar.sha1
diff --git a/client/rest/licenses/httpcore5-5.3.1.jar.sha1 b/client/rest/licenses/httpcore5-5.3.1.jar.sha1
@@ -0,0 +1 @@
+eaf64237945d7d0f301d48420e8bdb7f565a7b0e
diff --git a/client/rest/licenses/httpcore5-h2-5.2.5.jar.sha1 b/client/rest/licenses/httpcore5-h2-5.2.5.jar.sha1
diff --git a/client/rest/licenses/httpcore5-h2-5.3.1.jar.sha1 b/client/rest/licenses/httpcore5-h2-5.3.1.jar.sha1
@@ -0,0 +1 @@
+760c34db3ba41b0ffa07e956bc308d3a12356915
diff --git a/client/rest/licenses/httpcore5-reactive-5.2.5.jar.sha1 b/client/rest/licenses/httpcore5-reactive-5.2.5.jar.sha1
diff --git a/client/rest/licenses/httpcore5-reactive-5.3.1.jar.sha1 b/client/rest/licenses/httpcore5-reactive-5.3.1.jar.sha1
@@ -0,0 +1 @@
+c4c0c3c7bbcb0db54aa7ddd39e34a835428c99c0
diff --git a/client/rest/src/test/java/org/opensearch/client/RestClientBuilderTests.java b/client/rest/src/test/java/org/opensearch/client/RestClientBuilderTests.java
@@ -37,6 +37,7 @@
 import org.apache.hc.core5.http.Header;
 import org.apache.hc.core5.http.HttpHost;
 import org.apache.hc.core5.http.message.BasicHeader;
+import org.apache.hc.core5.reactor.IOReactorConfig;
 import org.apache.hc.core5.util.Timeout;
 
 import java.io.IOException;
@@ -143,6 +144,12 @@ public void testBuild() throws IOException {
             builder.setHttpClientConfigCallback(new RestClientBuilder.HttpClientConfigCallback() {
                 @Override
                 public HttpAsyncClientBuilder customizeHttpClient(HttpAsyncClientBuilder httpClientBuilder) {
+                    IOReactorConfig.Builder iOReactorConfig = IOReactorConfig.custom();
+                    iOReactorConfig.setTcpKeepCount(randomIntBetween(4, 10));
+                    iOReactorConfig.setTcpKeepInterval(randomIntBetween(5, 10));
+                    iOReactorConfig.setTcpKeepIdle(randomIntBetween(100, 200));
+                    iOReactorConfig.setIoThreadCount(2);
+                    httpClientBuilder.setIOReactorConfig(iOReactorConfig.build());
                     return httpClientBuilder;
                 }
             });

diff --git a/client/rest/src/test/java/org/opensearch/client/RestClientSingleHostIntegTests.java b/client/rest/src/test/java/org/opensearch/client/RestClientSingleHostIntegTests.java
@@ -377,8 +377,14 @@ public void testRequestResetAndAbort() throws Exception {
      * Exercises the test http server ability to send back whatever headers it received.
      */
     public void testHeaders() throws Exception {
+        // HttpClient 5.4.x has by default enabled HTTP/1.1 TLS Upgrade in
+        // https://github.com/apache/httpcomponents-client/pull/542, response of
+        // HEAD/HEAD/OPTIONS will be added two new headers:
+        // <Connection->Upgrade, Upgrade->TLS/1.2>, we have to handle these
+        // three methods specially.
+        Set<String> protocolUpgradeMethods = new HashSet<>(Arrays.asList("GET", "HEAD", "OPTIONS"));
         for (String method : getHttpMethods()) {
-            final Set<String> standardHeaders = new HashSet<>(Arrays.asList("Connection", "Host", "User-agent", "Date"));
+            final Set<String> standardHeaders = new HashSet<>(Arrays.asList("Connection", "Host", "User-agent", "Date", "Upgrade"));
             if (method.equals("HEAD") == false) {
                 standardHeaders.add("Content-length");
             }
@@ -401,8 +407,14 @@ public void testHeaders() throws Exception {
             assertEquals(statusCode, esResponse.getStatusLine().getStatusCode());
             assertEquals(pathPrefix + "/" + statusCode, esResponse.getRequestLine().getUri());
             assertHeaders(defaultHeaders, requestHeaders, esResponse.getHeaders(), standardHeaders);
+            // HttpClient 5.4.x will return the response with headers containing two key named Connection.
+            boolean firstConnection = true;
             for (final Header responseHeader : esResponse.getHeaders()) {
                 String name = responseHeader.getName();
+                if (protocolUpgradeMethods.contains(method) && name.equals("Connection") && firstConnection) {
+                    firstConnection = false;
+                    continue;
+                }
                 if (name.startsWith("Header") == false) {
                     assertTrue("unknown header was returned " + name, standardHeaders.remove(name));
                 }

diff --git a/client/rest/src/test/java/org/opensearch/client/documentation/RestClientDocumentation.java b/client/rest/src/test/java/org/opensearch/client/documentation/RestClientDocumentation.java
@@ -376,6 +376,24 @@ public HttpAsyncClientBuilder customizeHttpClient(
                 });
             //end::rest-client-config-threads
         }
+        {
+            //tag::rest-client-config-tcpKeepIdle/tcpKeepInterval/tcpKeepCount
+            RestClientBuilder builder = RestClient.builder(
+                    new HttpHost("localhost", 9200))
+                    .setHttpClientConfigCallback(new HttpClientConfigCallback() {
+                        @Override
+                        public HttpAsyncClientBuilder customizeHttpClient(
+                                HttpAsyncClientBuilder httpClientBuilder) {
+                            return httpClientBuilder.setIOReactorConfig(
+                                    IOReactorConfig.custom()
+                                            .setTcpKeepIdle(200)
+                                            .setTcpKeepInterval(10)
+                                            .setTcpKeepCount(10)
+                                            .build());
+                        }
+                    });
+            //end::rest-client-config-tcpKeepIdle/tcpKeepInterval/tcpKeepCount
+        }
         {
             //tag::rest-client-config-basic-auth
             final BasicCredentialsProvider credentialsProvider = new BasicCredentialsProvider();

diff --git a/client/sniffer/licenses/httpclient5-5.3.1.jar.sha1 b/client/sniffer/licenses/httpclient5-5.3.1.jar.sha1
diff --git a/client/sniffer/licenses/httpclient5-5.4.1.jar.sha1 b/client/sniffer/licenses/httpclient5-5.4.1.jar.sha1
@@ -0,0 +1 @@
+ce913081e592ee8eeee35c4e577d7dce13cba7a4
diff --git a/client/sniffer/licenses/httpcore5-5.2.5.jar.sha1 b/client/sniffer/licenses/httpcore5-5.2.5.jar.sha1
diff --git a/client/sniffer/licenses/httpcore5-5.3.1.jar.sha1 b/client/sniffer/licenses/httpcore5-5.3.1.jar.sha1
@@ -0,0 +1 @@
+eaf64237945d7d0f301d48420e8bdb7f565a7b0e
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -40,8 +40,8 @@ reactor_netty     = "1.1.23"
 reactor           = "3.5.20"
 
 # client dependencies
-httpclient5       = "5.3.1"
-httpcore5         = "5.2.5"
+httpclient5       = "5.4.1"
+httpcore5         = "5.3.1"
 httpclient        = "4.5.14"
 httpcore          = "4.4.16"
 httpasyncclient   = "4.1.5"

diff --git a/test/framework/src/main/java/org/opensearch/bootstrap/BootstrapForTesting.java b/test/framework/src/main/java/org/opensearch/bootstrap/BootstrapForTesting.java
@@ -301,11 +301,15 @@ static Set<URL> parseClassPathWithSymlinks() throws Exception {
     private static Set<String> getTrustedHosts() {
         //
         try {
-            return Collections.list(NetworkInterface.getNetworkInterfaces())
+            List<String> hosts = Collections.list(NetworkInterface.getNetworkInterfaces())
                 .stream()
                 .flatMap(iface -> Collections.list(iface.getInetAddresses()).stream())
                 .map(address -> NetworkAddress.format(address))
-                .collect(Collectors.toSet());
+                .collect(Collectors.toList());
+            // 0:0:0:0:0:0:0:1 is simplified to ::1, in it test, the incoming address can be 0:0:0:0:0:0:0:1,
+            // so we should add it to trusted hosts.
+            hosts.add("0:0:0:0:0:0:0:1");
+            return Collections.unmodifiableSet(new HashSet<>(hosts));
         } catch (final SocketException e) {
             return Collections.emptySet();
         }