Migrate client transports to Apache HttpClient / Core 5.x

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

CHANGELOG.md

@@ -31,6 +31,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 - Plugin ZIP publication groupId value is configurable ([#4156](https://github.com/opensearch-project/OpenSearch/pull/4156))
 - Add index specific setting for remote repository ([#4253](https://github.com/opensearch-project/OpenSearch/pull/4253))
 - [Segment Replication] Update replicas to commit SegmentInfos instead of relying on SIS files from primary shards. ([#4402](https://github.com/opensearch-project/OpenSearch/pull/4402))
+- Migrate client transports to Apache HttpClient / Core 5.x ([#4458](https://github.com/opensearch-project/OpenSearch/pull/4458))
 
 ### Deprecated
 

buildSrc/src/main/resources/forbidden/http-signatures.txt

@@ -15,31 +15,14 @@
 # language governing permissions and limitations under the License.
 
 @defaultMessage Explicitly specify the ContentType of HTTP entities when creating
-org.apache.http.entity.StringEntity#<init>(java.lang.String)
-org.apache.http.entity.StringEntity#<init>(java.lang.String,java.lang.String)
-org.apache.http.entity.StringEntity#<init>(java.lang.String,java.nio.charset.Charset)
-org.apache.http.entity.ByteArrayEntity#<init>(byte[])
-org.apache.http.entity.ByteArrayEntity#<init>(byte[],int,int)
-org.apache.http.entity.FileEntity#<init>(java.io.File)
-org.apache.http.entity.InputStreamEntity#<init>(java.io.InputStream)
-org.apache.http.entity.InputStreamEntity#<init>(java.io.InputStream,long)
-org.apache.http.nio.entity.NByteArrayEntity#<init>(byte[])
-org.apache.http.nio.entity.NByteArrayEntity#<init>(byte[],int,int)
-org.apache.http.nio.entity.NFileEntity#<init>(java.io.File)
-org.apache.http.nio.entity.NStringEntity#<init>(java.lang.String)
-org.apache.http.nio.entity.NStringEntity#<init>(java.lang.String,java.lang.String)
+org.apache.hc.core5.http.io.entity.StringEntity#<init>(java.lang.String)
+org.apache.hc.core5.http.io.entity.StringEntity#<init>(java.lang.String,java.nio.charset.Charset)
 
 @defaultMessage Use non-deprecated constructors
-org.apache.http.nio.entity.NFileEntity#<init>(java.io.File,java.lang.String)
-org.apache.http.nio.entity.NFileEntity#<init>(java.io.File,java.lang.String,boolean)
-org.apache.http.entity.FileEntity#<init>(java.io.File,java.lang.String)
-org.apache.http.entity.StringEntity#<init>(java.lang.String,java.lang.String,java.lang.String)
+org.apache.hc.core5.http.io.entity.FileEntity#<init>(java.io.File,org.apache.hc.core5.http.ContentType)
 
 @defaultMessage BasicEntity is easy to mess up and forget to set content type
-org.apache.http.entity.BasicHttpEntity#<init>()
-
-@defaultMessage EntityTemplate is easy to mess up and forget to set content type
-org.apache.http.entity.EntityTemplate#<init>(org.apache.http.entity.ContentProducer)
+org.apache.hc.core5.http.io.entity.BasicHttpEntity#<init>(java.io.InputStream,org.apache.hc.core5.http.ContentType)
 
 @defaultMessage SerializableEntity uses java serialization and makes it easy to forget to set content type
-org.apache.http.entity.SerializableEntity#<init>(java.io.Serializable)
+org.apache.hc.core5.http.io.entity.SerializableEntity#<init>(java.io.Serializable,org.apache.hc.core5.http.ContentType)

buildSrc/version.properties

@@ -25,6 +25,8 @@ netty             = 4.1.79.Final
 joda              = 2.10.13
 
 # client dependencies
+httpclient5       = 5.1.3
+httpcore5         = 5.1.4
 httpclient        = 4.5.13
 httpcore          = 4.4.15
 httpasyncclient   = 4.1.5

client/benchmark/src/main/java/org/opensearch/client/benchmark/rest/RestClientBenchmark.java

@@ -31,10 +31,10 @@
 
 package org.opensearch.client.benchmark.rest;
 
-import org.apache.http.HttpHeaders;
-import org.apache.http.HttpHost;
-import org.apache.http.HttpStatus;
-import org.apache.http.message.BasicHeader;
+import org.apache.hc.core5.http.HttpHeaders;
+import org.apache.hc.core5.http.HttpHost;
+import org.apache.hc.core5.http.HttpStatus;
+import org.apache.hc.core5.http.message.BasicHeader;
 import org.opensearch.OpenSearchException;
 import org.opensearch.client.Request;
 import org.opensearch.client.Response;

client/rest-high-level/build.gradle

@@ -104,3 +104,9 @@ testClusters.all {
   extraConfigFile nodeTrustStore.name, nodeTrustStore
   extraConfigFile pkiTrustCert.name, pkiTrustCert
 }
+
+thirdPartyAudit.ignoreMissingClasses(
+  'org.conscrypt.Conscrypt',
+  'org.slf4j.Logger',
+  'org.slf4j.LoggerFactory'
+)

client/rest-high-level/src/main/java/org/opensearch/client/ClusterRequestConverters.java

@@ -32,10 +32,10 @@
 
 package org.opensearch.client;
 
-import org.apache.http.client.methods.HttpDelete;
-import org.apache.http.client.methods.HttpGet;
-import org.apache.http.client.methods.HttpHead;
-import org.apache.http.client.methods.HttpPut;
+import org.apache.hc.client5.http.classic.methods.HttpDelete;
+import org.apache.hc.client5.http.classic.methods.HttpGet;
+import org.apache.hc.client5.http.classic.methods.HttpHead;
+import org.apache.hc.client5.http.classic.methods.HttpPut;
 import org.opensearch.action.admin.cluster.health.ClusterHealthRequest;
 import org.opensearch.action.admin.cluster.settings.ClusterGetSettingsRequest;
 import org.opensearch.action.admin.cluster.settings.ClusterUpdateSettingsRequest;

client/rest-high-level/src/main/java/org/opensearch/client/IndicesRequestConverters.java

@@ -32,11 +32,11 @@
 
 package org.opensearch.client;
 
-import org.apache.http.client.methods.HttpDelete;
-import org.apache.http.client.methods.HttpGet;
-import org.apache.http.client.methods.HttpHead;
-import org.apache.http.client.methods.HttpPost;
-import org.apache.http.client.methods.HttpPut;
+import org.apache.hc.client5.http.classic.methods.HttpDelete;
+import org.apache.hc.client5.http.classic.methods.HttpGet;
+import org.apache.hc.client5.http.classic.methods.HttpHead;
+import org.apache.hc.client5.http.classic.methods.HttpPost;
+import org.apache.hc.client5.http.classic.methods.HttpPut;
 import org.opensearch.action.admin.indices.alias.IndicesAliasesRequest;
 import org.opensearch.action.admin.indices.alias.get.GetAliasesRequest;
 import org.opensearch.action.admin.indices.cache.clear.ClearIndicesCacheRequest;

client/rest-high-level/src/main/java/org/opensearch/client/IngestRequestConverters.java

@@ -32,10 +32,10 @@
 
 package org.opensearch.client;
 
-import org.apache.http.client.methods.HttpDelete;
-import org.apache.http.client.methods.HttpGet;
-import org.apache.http.client.methods.HttpPost;
-import org.apache.http.client.methods.HttpPut;
+import org.apache.hc.client5.http.classic.methods.HttpDelete;
+import org.apache.hc.client5.http.classic.methods.HttpGet;
+import org.apache.hc.client5.http.classic.methods.HttpPost;
+import org.apache.hc.client5.http.classic.methods.HttpPut;
 import org.opensearch.action.ingest.DeletePipelineRequest;
 import org.opensearch.action.ingest.GetPipelineRequest;
 import org.opensearch.action.ingest.PutPipelineRequest;

client/rest-high-level/src/main/java/org/opensearch/client/RequestConverters.java

@@ -32,14 +32,14 @@
 
 package org.opensearch.client;
 
-import org.apache.http.HttpEntity;
-import org.apache.http.client.methods.HttpDelete;
-import org.apache.http.client.methods.HttpGet;
-import org.apache.http.client.methods.HttpHead;
-import org.apache.http.client.methods.HttpPost;
-import org.apache.http.client.methods.HttpPut;
-import org.apache.http.entity.ContentType;
-import org.apache.http.nio.entity.NByteArrayEntity;
+import org.apache.hc.client5.http.classic.methods.HttpDelete;
+import org.apache.hc.client5.http.classic.methods.HttpGet;
+import org.apache.hc.client5.http.classic.methods.HttpHead;
+import org.apache.hc.client5.http.classic.methods.HttpPost;
+import org.apache.hc.client5.http.classic.methods.HttpPut;
+import org.apache.hc.core5.http.ContentType;
+import org.apache.hc.core5.http.HttpEntity;
+import org.apache.hc.core5.http.io.entity.ByteArrayEntity;
 import org.apache.lucene.util.BytesRef;
 import org.opensearch.action.DocWriteRequest;
 import org.opensearch.action.admin.cluster.health.ClusterHealthRequest;
@@ -269,7 +269,7 @@ static Request bulk(BulkRequest bulkRequest) throws IOException {
             }
         }
         request.addParameters(parameters.asMap());
-        request.setEntity(new NByteArrayEntity(content.toByteArray(), 0, content.size(), requestContentType));
+        request.setEntity(new ByteArrayEntity(content.toByteArray(), 0, content.size(), requestContentType));
         return request;
     }
 
@@ -358,7 +358,7 @@ static Request index(IndexRequest indexRequest) {
         BytesRef source = indexRequest.source().toBytesRef();
         ContentType contentType = createContentType(indexRequest.getContentType());
         request.addParameters(parameters.asMap());
-        request.setEntity(new NByteArrayEntity(source.bytes, source.offset, source.length, contentType));
+        request.setEntity(new ByteArrayEntity(source.bytes, source.offset, source.length, contentType));
         return request;
     }
 
@@ -510,7 +510,7 @@ static Request multiSearch(MultiSearchRequest multiSearchRequest) throws IOExcep
         XContent xContent = REQUEST_BODY_CONTENT_TYPE.xContent();
         byte[] source = MultiSearchRequest.writeMultiLineFormat(multiSearchRequest, xContent);
         request.addParameters(params.asMap());
-        request.setEntity(new NByteArrayEntity(source, createContentType(xContent.type())));
+        request.setEntity(new ByteArrayEntity(source, createContentType(xContent.type())));
         return request;
     }
 
@@ -545,7 +545,7 @@ static Request multiSearchTemplate(MultiSearchTemplateRequest multiSearchTemplat
 
         XContent xContent = REQUEST_BODY_CONTENT_TYPE.xContent();
         byte[] source = MultiSearchTemplateRequest.writeMultiLineFormat(multiSearchTemplateRequest, xContent);
-        request.setEntity(new NByteArrayEntity(source, createContentType(xContent.type())));
+        request.setEntity(new ByteArrayEntity(source, createContentType(xContent.type())));
         return request;
     }
 
@@ -813,7 +813,7 @@ static HttpEntity createEntity(ToXContent toXContent, XContentType xContentType)
     static HttpEntity createEntity(ToXContent toXContent, XContentType xContentType, ToXContent.Params toXContentParams)
         throws IOException {
         BytesRef source = XContentHelper.toXContent(toXContent, xContentType, toXContentParams, false).toBytesRef();
-        return new NByteArrayEntity(source.bytes, source.offset, source.length, createContentType(xContentType));
+        return new ByteArrayEntity(source.bytes, source.offset, source.length, createContentType(xContentType));
     }
 
     static String endpoint(String index, String id) {

client/rest-high-level/src/main/java/org/opensearch/client/RestHighLevelClient.java

@@ -32,7 +32,7 @@
 
 package org.opensearch.client;
 
-import org.apache.http.HttpEntity;
+import org.apache.hc.core5.http.HttpEntity;
 import org.opensearch.OpenSearchException;
 import org.opensearch.OpenSearchStatusException;
 import org.opensearch.action.ActionListener;
@@ -2185,9 +2185,9 @@ protected final <Resp> Resp parseEntity(final HttpEntity entity, final CheckedFu
         if (entity.getContentType() == null) {
             throw new IllegalStateException("OpenSearch didn't return the [Content-Type] header, unable to parse response body");
         }
-        XContentType xContentType = XContentType.fromMediaType(entity.getContentType().getValue());
+        XContentType xContentType = XContentType.fromMediaType(entity.getContentType());
         if (xContentType == null) {
-            throw new IllegalStateException("Unsupported Content-Type: " + entity.getContentType().getValue());
+            throw new IllegalStateException("Unsupported Content-Type: " + entity.getContentType());
         }
         try (XContentParser parser = xContentType.xContent().createParser(registry, DEPRECATION_HANDLER, entity.getContent())) {
             return entityParser.apply(parser);

client/rest-high-level/src/main/java/org/opensearch/client/SnapshotRequestConverters.java

@@ -32,10 +32,10 @@
 
 package org.opensearch.client;
 
-import org.apache.http.client.methods.HttpDelete;
-import org.apache.http.client.methods.HttpGet;
-import org.apache.http.client.methods.HttpPost;
-import org.apache.http.client.methods.HttpPut;
+import org.apache.hc.client5.http.classic.methods.HttpDelete;
+import org.apache.hc.client5.http.classic.methods.HttpGet;
+import org.apache.hc.client5.http.classic.methods.HttpPost;
+import org.apache.hc.client5.http.classic.methods.HttpPut;
 import org.opensearch.action.admin.cluster.repositories.cleanup.CleanupRepositoryRequest;
 import org.opensearch.action.admin.cluster.repositories.delete.DeleteRepositoryRequest;
 import org.opensearch.action.admin.cluster.repositories.get.GetRepositoriesRequest;

client/rest-high-level/src/main/java/org/opensearch/client/TasksRequestConverters.java

@@ -32,8 +32,8 @@
 
 package org.opensearch.client;
 
-import org.apache.http.client.methods.HttpGet;
-import org.apache.http.client.methods.HttpPost;
+import org.apache.hc.client5.http.classic.methods.HttpGet;
+import org.apache.hc.client5.http.classic.methods.HttpPost;
 import org.opensearch.action.admin.cluster.node.tasks.list.ListTasksRequest;
 import org.opensearch.client.RequestConverters.EndpointBuilder;
 import org.opensearch.client.tasks.CancelTasksRequest;

client/rest-high-level/src/main/resources/forbidden/rest-high-level-signatures.txt

@@ -15,10 +15,9 @@
 # language governing permissions and limitations under the License.
 
 @defaultMessage Use Request#createContentType(XContentType) to be sure to pass the right MIME type
-org.apache.http.entity.ContentType#create(java.lang.String)
-org.apache.http.entity.ContentType#create(java.lang.String,java.lang.String)
-org.apache.http.entity.ContentType#create(java.lang.String,java.nio.charset.Charset)
-org.apache.http.entity.ContentType#create(java.lang.String,org.apache.http.NameValuePair[])
+org.apache.hc.core5.http.ContentType#create(java.lang.String)
+org.apache.hc.core5.http.ContentType#create(java.lang.String,java.lang.String)
+org.apache.hc.core5.http.ContentType#create(java.lang.String,java.nio.charset.Charset)
 
 @defaultMessage ES's logging infrastructure uses log4j2 which we don't want to force on high level rest client users
 org.opensearch.common.logging.DeprecationLogger
@@ -30,7 +29,3 @@ org.opensearch.common.logging.PrefixLogger
 
 @defaultMessage We can't rely on log4j2 being on the classpath so don't log deprecations!
 org.opensearch.common.xcontent.LoggingDeprecationHandler
-
-@defaultMessage Use Nonblocking org.apache.http.nio.entity.NByteArrayEntity
-org.apache.http.entity.ByteArrayEntity
-org.apache.http.entity.StringEntity

client/rest-high-level/src/test/java/org/opensearch/client/ClusterClientIT.java

@@ -32,7 +32,8 @@
 
 package org.opensearch.client;
 
-import org.apache.http.util.EntityUtils;
+import org.apache.hc.core5.http.ParseException;
+import org.apache.hc.core5.http.io.entity.EntityUtils;
 import org.opensearch.OpenSearchException;
 import org.opensearch.OpenSearchStatusException;
 import org.opensearch.action.admin.cluster.health.ClusterHealthRequest;
@@ -220,7 +221,7 @@ public void testClusterHealthGreen() throws IOException {
         assertThat(response.getStatus(), equalTo(ClusterHealthStatus.GREEN));
     }
 
-    public void testClusterHealthYellowClusterLevel() throws IOException {
+    public void testClusterHealthYellowClusterLevel() throws IOException, ParseException {
         createIndex("index", Settings.EMPTY);
         createIndex("index2", Settings.EMPTY);
         ClusterHealthRequest request = new ClusterHealthRequest();
@@ -231,7 +232,7 @@ public void testClusterHealthYellowClusterLevel() throws IOException {
         assertThat(response.getIndices().size(), equalTo(0));
     }
 
-    public void testClusterHealthYellowIndicesLevel() throws IOException {
+    public void testClusterHealthYellowIndicesLevel() throws IOException, ParseException {
         String firstIndex = "index";
         String secondIndex = "index2";
         // including another index that we do not assert on, to ensure that we are not

client/rest-high-level/src/test/java/org/opensearch/client/ClusterRequestConvertersTests.java

@@ -32,8 +32,6 @@
 
 package org.opensearch.client;
 
-import org.apache.http.client.methods.HttpGet;
-import org.apache.http.client.methods.HttpPut;
 import org.opensearch.action.admin.cluster.health.ClusterHealthRequest;
 import org.opensearch.action.admin.cluster.settings.ClusterGetSettingsRequest;
 import org.opensearch.action.admin.cluster.settings.ClusterUpdateSettingsRequest;
@@ -44,6 +42,8 @@
 import org.opensearch.common.Priority;
 import org.opensearch.common.util.CollectionUtils;
 import org.opensearch.test.OpenSearchTestCase;
+import org.apache.hc.client5.http.classic.methods.HttpGet;
+import org.apache.hc.client5.http.classic.methods.HttpPut;
 import org.hamcrest.CoreMatchers;
 import org.junit.Assert;
 

client/rest-high-level/src/test/java/org/opensearch/client/CustomRestHighLevelClientTests.java

@@ -32,15 +32,14 @@
 
 package org.opensearch.client;
 
-import org.apache.http.Header;
-import org.apache.http.HttpHost;
-import org.apache.http.ProtocolVersion;
-import org.apache.http.RequestLine;
-import org.apache.http.client.methods.HttpGet;
-import org.apache.http.entity.ContentType;
-import org.apache.http.message.BasicRequestLine;
-import org.apache.http.message.BasicStatusLine;
-import org.apache.http.nio.entity.NByteArrayEntity;
+import org.apache.hc.client5.http.classic.methods.HttpGet;
+import org.apache.hc.core5.http.ContentType;
+import org.apache.hc.core5.http.Header;
+import org.apache.hc.core5.http.HttpHost;
+import org.apache.hc.core5.http.ProtocolVersion;
+import org.apache.hc.core5.http.io.entity.ByteArrayEntity;
+import org.apache.hc.core5.http.message.RequestLine;
+import org.apache.hc.core5.http.message.StatusLine;
 import org.apache.lucene.util.BytesRef;
 import org.opensearch.Build;
 import org.opensearch.Version;
@@ -172,13 +171,13 @@ private Response mockPerformRequest(Request request) throws IOException {
         when(mockResponse.getHost()).thenReturn(new HttpHost("localhost", 9200));
 
         ProtocolVersion protocol = new ProtocolVersion("HTTP", 1, 1);
-        when(mockResponse.getStatusLine()).thenReturn(new BasicStatusLine(protocol, 200, "OK"));
+        when(mockResponse.getStatusLine()).thenReturn(new StatusLine(protocol, 200, "OK"));
 
         MainResponse response = new MainResponse(httpHeader.getValue(), Version.CURRENT, ClusterName.DEFAULT, "_na", Build.CURRENT);
         BytesRef bytesRef = XContentHelper.toXContent(response, XContentType.JSON, false).toBytesRef();
-        when(mockResponse.getEntity()).thenReturn(new NByteArrayEntity(bytesRef.bytes, ContentType.APPLICATION_JSON));
+        when(mockResponse.getEntity()).thenReturn(new ByteArrayEntity(bytesRef.bytes, ContentType.APPLICATION_JSON));
 
-        RequestLine requestLine = new BasicRequestLine(HttpGet.METHOD_NAME, ENDPOINT, protocol);
+        RequestLine requestLine = new RequestLine(HttpGet.METHOD_NAME, ENDPOINT, protocol);
         when(mockResponse.getRequestLine()).thenReturn(requestLine);
 
         return mockResponse;

client/rest-high-level/src/test/java/org/opensearch/client/HighLevelRestClientCompressionIT.java

@@ -31,9 +31,9 @@
 
 package org.opensearch.client;
 
-import org.apache.http.HttpHeaders;
-import org.apache.http.client.methods.HttpPost;
-import org.apache.http.client.methods.HttpPut;
+import org.apache.hc.client5.http.classic.methods.HttpPost;
+import org.apache.hc.client5.http.classic.methods.HttpPut;
+import org.apache.hc.core5.http.HttpHeaders;
 import org.opensearch.action.search.SearchRequest;
 import org.opensearch.action.search.SearchResponse;
 

client/rest-high-level/src/test/java/org/opensearch/client/IndicesClientIT.java

@@ -32,9 +32,9 @@
 
 package org.opensearch.client;
 
-import org.apache.http.client.methods.HttpGet;
-import org.apache.http.client.methods.HttpPost;
-import org.apache.http.client.methods.HttpPut;
+import org.apache.hc.client5.http.classic.methods.HttpGet;
+import org.apache.hc.client5.http.classic.methods.HttpPost;
+import org.apache.hc.client5.http.classic.methods.HttpPut;
 import org.opensearch.OpenSearchException;
 import org.opensearch.OpenSearchStatusException;
 import org.opensearch.action.admin.indices.alias.Alias;

client/rest-high-level/src/test/java/org/opensearch/client/IndicesRequestConvertersTests.java

@@ -32,11 +32,11 @@
 
 package org.opensearch.client;
 
-import org.apache.http.client.methods.HttpDelete;
-import org.apache.http.client.methods.HttpGet;
-import org.apache.http.client.methods.HttpHead;
-import org.apache.http.client.methods.HttpPost;
-import org.apache.http.client.methods.HttpPut;
+import org.apache.hc.client5.http.classic.methods.HttpDelete;
+import org.apache.hc.client5.http.classic.methods.HttpGet;
+import org.apache.hc.client5.http.classic.methods.HttpHead;
+import org.apache.hc.client5.http.classic.methods.HttpPost;
+import org.apache.hc.client5.http.classic.methods.HttpPut;
 import org.apache.lucene.tests.util.LuceneTestCase;
 import org.opensearch.action.ActionRequestValidationException;
 import org.opensearch.action.admin.indices.alias.Alias;