Apache Solr open-source search software
SOLR-17538: CloudHttp2SolrClient needs a custom ClusterStateProvider option (#2832)
Sanjay Dutt783d7805ea7e
diff --git a/solr/core/src/java/org/apache/solr/cloud/ZkController.java b/solr/core/src/java/org/apache/solr/cloud/ZkController.javaindex 25c5cb1fa9e..59480caa8e9 100644--- a/solr/core/src/java/org/apache/solr/cloud/ZkController.java+++ b/solr/core/src/java/org/apache/solr/cloud/ZkController.java@@ -60,6 +60,7 @@ import org.apache.solr.client.solrj.impl.Http2SolrClient;import org.apache.solr.client.solrj.impl.HttpSolrClient.Builder;import org.apache.solr.client.solrj.impl.SolrClientCloudManager;import org.apache.solr.client.solrj.impl.SolrZkClientTimeout;+import org.apache.solr.client.solrj.impl.ZkClientClusterStateProvider;import org.apache.solr.client.solrj.request.CoreAdminRequest.WaitForState;import org.apache.solr.cloud.overseer.ClusterStateMutator;import org.apache.solr.cloud.overseer.OverseerAction;@@ -870,7 +871,7 @@ public class ZkController implements Closeable {.withConnectionTimeout(15000, TimeUnit.MILLISECONDS).build();cloudSolrClient =- new CloudHttp2SolrClient.Builder(List.of(getZkServerAddress()), Optional.empty())+ new CloudHttp2SolrClient.Builder(new ZkClientClusterStateProvider(zkStateReader)).withHttpClient(http2SolrClient).build();cloudManager = new SolrClientCloudManager(cloudSolrClient, cc.getObjectCache());diff --git a/solr/core/src/test/org/apache/solr/cloud/OverseerTest.java b/solr/core/src/test/org/apache/solr/cloud/OverseerTest.javaindex ae10c722b20..8e7e45333f4 100644--- a/solr/core/src/test/org/apache/solr/cloud/OverseerTest.java+++ b/solr/core/src/test/org/apache/solr/cloud/OverseerTest.java@@ -41,7 +41,6 @@ import java.util.HashMap;import java.util.List;import java.util.Locale;import java.util.Map;-import java.util.Optional;import java.util.Set;import java.util.concurrent.ExecutorService;import java.util.concurrent.TimeUnit;@@ -55,6 +54,7 @@ import org.apache.solr.client.solrj.cloud.SolrCloudManager;import org.apache.solr.client.solrj.impl.CloudHttp2SolrClient;import org.apache.solr.client.solrj.impl.Http2SolrClient;import org.apache.solr.client.solrj.impl.SolrClientCloudManager;+import org.apache.solr.client.solrj.impl.ZkClientClusterStateProvider;import org.apache.solr.cloud.overseer.NodeMutator;import org.apache.solr.cloud.overseer.OverseerAction;import org.apache.solr.cloud.overseer.ZkWriteCommand;@@ -1942,18 +1942,18 @@ public class OverseerTest extends SolrTestCaseJ4 {when(zkController.getLeaderProps(anyString(), anyString(), anyInt())).thenCallRealMethod();when(zkController.getLeaderProps(anyString(), anyString(), anyInt(), anyBoolean())).thenCallRealMethod();- doReturn(getCloudDataProvider(zkAddress)).when(zkController).getSolrCloudManager();+ doReturn(getCloudDataProvider(reader)).when(zkController).getSolrCloudManager();return zkController;}- private SolrCloudManager getCloudDataProvider(String zkAddress) {+ private SolrCloudManager getCloudDataProvider(ZkStateReader zkStateReader) {var httpSolrClient =new Http2SolrClient.Builder().withIdleTimeout(30000, TimeUnit.MILLISECONDS).withConnectionTimeout(15000, TimeUnit.MILLISECONDS).build();var cloudSolrClient =- new CloudHttp2SolrClient.Builder(Collections.singletonList(zkAddress), Optional.empty())+ new CloudHttp2SolrClient.Builder(new ZkClientClusterStateProvider(zkStateReader)).withHttpClient(httpSolrClient).build();solrClients.add(cloudSolrClient);diff --git a/solr/solrj/src/java/org/apache/solr/client/solrj/impl/CloudHttp2SolrClient.java b/solr/solrj/src/java/org/apache/solr/client/solrj/impl/CloudHttp2SolrClient.javaindex f45945ae045..92da218d15c 100644--- a/solr/solrj/src/java/org/apache/solr/client/solrj/impl/CloudHttp2SolrClient.java+++ b/solr/solrj/src/java/org/apache/solr/client/solrj/impl/CloudHttp2SolrClient.java@@ -56,10 +56,7 @@ public class CloudHttp2SolrClient extends CloudSolrClient {super(builder.shardLeadersOnly, builder.parallelUpdates, builder.directUpdatesToLeadersOnly);this.clientIsInternal = builder.httpClient == null;this.myClient = createOrGetHttpClientFromBuilder(builder);- this.stateProvider =- builder.zkHosts.isEmpty()- ? createHttp2ClusterStateProvider(builder.solrUrls, myClient)- : createZkClusterStateProvider(builder);+ this.stateProvider = createClusterStateProvider(builder);this.retryExpiryTimeNano = builder.retryExpiryTimeNano;this.defaultCollection = builder.defaultCollection;if (builder.requestWriter != null) {@@ -89,6 +86,16 @@ public class CloudHttp2SolrClient extends CloudSolrClient {}}+ private ClusterStateProvider createClusterStateProvider(Builder builder) {+ if (builder.stateProvider != null) {+ return builder.stateProvider;+ } else if (builder.zkHosts.isEmpty()) {+ return createHttp2ClusterStateProvider(builder.solrUrls, this.myClient);+ } else {+ return createZkClusterStateProvider(builder);+ }+ }+private ClusterStateProvider createZkClusterStateProvider(Builder builder) {try {ClusterStateProvider stateProvider =@@ -233,6 +240,11 @@ public class CloudHttp2SolrClient extends CloudSolrClient {if (zkChroot.isPresent()) this.zkChroot = zkChroot.get();}+ /** for an expert use-case */+ public Builder(ClusterStateProvider stateProvider) {+ this.stateProvider = stateProvider;+ }+/** Whether to use the default ZK ACLs when building a ZK Client. */public Builder canUseZkACLs(boolean canUseZkACLs) {this.canUseZkACLs = canUseZkACLs;@@ -451,12 +463,19 @@ public class CloudHttp2SolrClient extends CloudSolrClient {/** Create a {@link CloudHttp2SolrClient} based on the provided configuration. */public CloudHttp2SolrClient build() {- if (!zkHosts.isEmpty() && !solrUrls.isEmpty()) {+ int providedOptions = 0;+ if (!zkHosts.isEmpty()) providedOptions++;+ if (!solrUrls.isEmpty()) providedOptions++;+ if (stateProvider != null) providedOptions++;++ if (providedOptions > 1) {throw new IllegalArgumentException(- "Both zkHost(s) & solrUrl(s) have been specified. Only specify one.");- } else if (zkHosts.isEmpty() && solrUrls.isEmpty()) {- throw new IllegalArgumentException("Both zkHosts and solrUrl cannot be null.");+ "Only one of zkHost(s), solrUrl(s), or stateProvider should be specified.");+ } else if (providedOptions == 0) {+ throw new IllegalArgumentException(+ "One of zkHosts, solrUrls, or stateProvider must be specified.");}+return new CloudHttp2SolrClient(this);}}diff --git a/solr/solrj/src/java/org/apache/solr/client/solrj/impl/CloudSolrClient.java b/solr/solrj/src/java/org/apache/solr/client/solrj/impl/CloudSolrClient.javaindex 666f5662627..38cd77ddc4e 100644--- a/solr/solrj/src/java/org/apache/solr/client/solrj/impl/CloudSolrClient.java+++ b/solr/solrj/src/java/org/apache/solr/client/solrj/impl/CloudSolrClient.java@@ -177,6 +177,11 @@ public abstract class CloudSolrClient extends SolrClient {public Builder(List<String> zkHosts, Optional<String> zkChroot) {super(zkHosts, zkChroot);}++ /** for an expert use-case */+ public Builder(ClusterStateProvider stateProvider) {+ super(stateProvider);+ }}static class StateCache extends ConcurrentHashMap<String, ExpiringCachedDocCollection> {diff --git a/solr/solrj/src/test/org/apache/solr/client/solrj/impl/CloudHttp2SolrClientBuilderTest.java b/solr/solrj/src/test/org/apache/solr/client/solrj/impl/CloudHttp2SolrClientBuilderTest.javaindex 19c32d9c138..01f57970e99 100644--- a/solr/solrj/src/test/org/apache/solr/client/solrj/impl/CloudHttp2SolrClientBuilderTest.java+++ b/solr/solrj/src/test/org/apache/solr/client/solrj/impl/CloudHttp2SolrClientBuilderTest.java@@ -17,6 +17,7 @@package org.apache.solr.client.solrj.impl;+import static org.mockito.Mockito.mock;import static org.mockito.Mockito.never;import static org.mockito.Mockito.times;import static org.mockito.Mockito.verify;@@ -30,7 +31,6 @@ import java.util.Optional;import org.apache.solr.cloud.SolrCloudTestCase;import org.junit.BeforeClass;import org.junit.Test;-import org.mockito.Mockito;public class CloudHttp2SolrClientBuilderTest extends SolrCloudTestCase {private static final String ANY_CHROOT = "/ANY_CHROOT";@@ -128,23 +128,23 @@ public class CloudHttp2SolrClientBuilderTest extends SolrCloudTestCase {() ->new CloudHttp2SolrClient.Builder(Collections.singletonList(ANY_ZK_HOST), Optional.of(ANY_CHROOT))- .withHttpClient(Mockito.mock(Http2SolrClient.class))- .withInternalClientBuilder(Mockito.mock(Http2SolrClient.Builder.class))+ .withHttpClient(mock(Http2SolrClient.class))+ .withInternalClientBuilder(mock(Http2SolrClient.Builder.class)).build());expectThrows(IllegalStateException.class,() ->new CloudHttp2SolrClient.Builder(Collections.singletonList(ANY_ZK_HOST), Optional.of(ANY_CHROOT))- .withInternalClientBuilder(Mockito.mock(Http2SolrClient.Builder.class))- .withHttpClient(Mockito.mock(Http2SolrClient.class))+ .withInternalClientBuilder(mock(Http2SolrClient.Builder.class))+ .withHttpClient(mock(Http2SolrClient.class)).build());}@Testpublic void testProvideInternalBuilder() throws IOException {- Http2SolrClient http2Client = Mockito.mock(Http2SolrClient.class);- Http2SolrClient.Builder http2ClientBuilder = Mockito.mock(Http2SolrClient.Builder.class);+ Http2SolrClient http2Client = mock(Http2SolrClient.class);+ Http2SolrClient.Builder http2ClientBuilder = mock(Http2SolrClient.Builder.class);when(http2ClientBuilder.build()).thenReturn(http2Client);CloudHttp2SolrClient.Builder clientBuilder =new CloudHttp2SolrClient.Builder(@@ -162,7 +162,7 @@ public class CloudHttp2SolrClientBuilderTest extends SolrCloudTestCase {@Testpublic void testProvideExternalClient() throws IOException {- Http2SolrClient http2Client = Mockito.mock(Http2SolrClient.class);+ Http2SolrClient http2Client = mock(Http2SolrClient.class);CloudHttp2SolrClient.Builder clientBuilder =new CloudHttp2SolrClient.Builder(Collections.singletonList(ANY_ZK_HOST), Optional.of(ANY_CHROOT))@@ -228,4 +228,12 @@ public class CloudHttp2SolrClientBuilderTest extends SolrCloudTestCase {((Http2ClusterStateProvider) client.getClusterStateProvider()).getHttpClient());}}++ public void testCustomStateProvider() throws IOException {+ ZkClientClusterStateProvider stateProvider = mock(ZkClientClusterStateProvider.class);+ try (CloudSolrClient cloudSolrClient = new CloudSolrClient.Builder(stateProvider).build()) {+ assertEquals(stateProvider, cloudSolrClient.getClusterStateProvider());+ }+ verify(stateProvider, times(1)).close();+ }}