This is an automated email from the ASF dual-hosted git repository.
dsmiley pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/solr.git
The following commit(s) were added to refs/heads/main by this push:
new 6eb910a0f60 SOLR-17712: Deprecating waitForFinalState parameter (#3756)
6eb910a0f60 is described below
commit 6eb910a0f607a83aba9c92187145b58bc500521c
Author: David Smiley <[email protected]>
AuthorDate: Thu Oct 16 20:01:34 2025 -0400
SOLR-17712: Deprecating waitForFinalState parameter (#3756)
* SOLR-17712: Deprecating waitForFinalState parameter
in any SolrCloud command that accepts it.
It remains defaulted to false in 9, but will become true and likely removed.
---
solr/CHANGES.txt | 3 +
.../api/model/BalanceReplicasRequestBody.java | 1 +
.../api/model/CreateCollectionRequestBody.java | 4 +-
.../client/api/model/CreateReplicaRequestBody.java | 6 +-
.../client/api/model/CreateShardRequestBody.java | 4 +-
.../api/model/MigrateReplicasRequestBody.java | 1 +
.../client/api/model/ReplaceNodeRequestBody.java | 1 +
.../apache/solr/cloud/CollectionsAPISolrJTest.java | 64 +++++++++++-----------
.../solrj/request/CollectionAdminRequest.java | 1 +
.../solrj/request/beans/CreateShardPayload.java | 4 +-
.../solrj/request/beans/MoveReplicaPayload.java | 4 +-
.../solrj/request/beans/SplitShardPayload.java | 4 +-
.../solr/common/params/CommonAdminParams.java | 1 +
13 files changed, 61 insertions(+), 37 deletions(-)
diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
index 4680b7677e6..47c400d77c6 100644
--- a/solr/CHANGES.txt
+++ b/solr/CHANGES.txt
@@ -387,6 +387,9 @@ Other Changes
* SOLR-17879: A Solr node will now fail to start if it's major.minor version
(e.g. 9.10) is *lower* than that of any existing
Solr node in a SolrCloud cluster (as reported by info in "live_node").
(David Smiley)
+* SOLR-17712: Deprecating waitForFinalState parameter in any SolrCloud command
that accepts it.
+ It remains defaulted to false in 9, but will become true and likely removed.
(Abhishek Umarjikar, David Smiley)
+
* SOLR-17956: XLSXResponseWriter has been deprecated and will be removed in a
future release. (Jan Høydahl)
* SOLR-17958: The Tika Language Identifier is deprecated. Use one of the other
detectors instead. (Jan Høydahl)
diff --git
a/solr/api/src/java/org/apache/solr/client/api/model/BalanceReplicasRequestBody.java
b/solr/api/src/java/org/apache/solr/client/api/model/BalanceReplicasRequestBody.java
index f270a48b269..508e5288cd4 100644
---
a/solr/api/src/java/org/apache/solr/client/api/model/BalanceReplicasRequestBody.java
+++
b/solr/api/src/java/org/apache/solr/client/api/model/BalanceReplicasRequestBody.java
@@ -42,6 +42,7 @@ public class BalanceReplicasRequestBody {
+ "If false, the API will return the status of the single
action, which may be "
+ "before the new replica is online and active.")
@JsonProperty("waitForFinalState")
+ @Deprecated(since = "9.10")
public Boolean waitForFinalState = false;
@Schema(description = "Request ID to track this action which will be
processed asynchronously.")
diff --git
a/solr/api/src/java/org/apache/solr/client/api/model/CreateCollectionRequestBody.java
b/solr/api/src/java/org/apache/solr/client/api/model/CreateCollectionRequestBody.java
index 5dce5840102..5b49d59d72a 100644
---
a/solr/api/src/java/org/apache/solr/client/api/model/CreateCollectionRequestBody.java
+++
b/solr/api/src/java/org/apache/solr/client/api/model/CreateCollectionRequestBody.java
@@ -38,7 +38,9 @@ public class CreateCollectionRequestBody {
@JsonProperty public Integer nrtReplicas;
- @JsonProperty public Boolean waitForFinalState;
+ @JsonProperty
+ @Deprecated(since = "9.10")
+ public Boolean waitForFinalState;
@JsonProperty public Boolean perReplicaState;
diff --git
a/solr/api/src/java/org/apache/solr/client/api/model/CreateReplicaRequestBody.java
b/solr/api/src/java/org/apache/solr/client/api/model/CreateReplicaRequestBody.java
index a669cdaf414..03e0a3751f2 100644
---
a/solr/api/src/java/org/apache/solr/client/api/model/CreateReplicaRequestBody.java
+++
b/solr/api/src/java/org/apache/solr/client/api/model/CreateReplicaRequestBody.java
@@ -30,7 +30,11 @@ public class CreateReplicaRequestBody {
@JsonProperty public Integer nrtReplicas;
@JsonProperty public Integer tlogReplicas;
@JsonProperty public Integer pullReplicas;
- @JsonProperty public Boolean waitForFinalState;
+
+ @JsonProperty
+ @Deprecated(since = "9.10")
+ public Boolean waitForFinalState;
+
@JsonProperty public Boolean followAliases;
@JsonProperty public String async;
diff --git
a/solr/api/src/java/org/apache/solr/client/api/model/CreateShardRequestBody.java
b/solr/api/src/java/org/apache/solr/client/api/model/CreateShardRequestBody.java
index ea871998cca..ed73bd5b9a0 100644
---
a/solr/api/src/java/org/apache/solr/client/api/model/CreateShardRequestBody.java
+++
b/solr/api/src/java/org/apache/solr/client/api/model/CreateShardRequestBody.java
@@ -40,7 +40,9 @@ public class CreateShardRequestBody {
@JsonProperty("nodeSet")
public List<String> nodeSet;
- @JsonProperty public Boolean waitForFinalState;
+ @JsonProperty
+ @Deprecated(since = "9.10")
+ public Boolean waitForFinalState;
@JsonProperty public Boolean followAliases;
diff --git
a/solr/api/src/java/org/apache/solr/client/api/model/MigrateReplicasRequestBody.java
b/solr/api/src/java/org/apache/solr/client/api/model/MigrateReplicasRequestBody.java
index 8970d6b7c4d..a0a7e3afd9b 100644
---
a/solr/api/src/java/org/apache/solr/client/api/model/MigrateReplicasRequestBody.java
+++
b/solr/api/src/java/org/apache/solr/client/api/model/MigrateReplicasRequestBody.java
@@ -48,6 +48,7 @@ public class MigrateReplicasRequestBody {
+ "If false, the API will return the status of the single
action, which may be "
+ "before the new replicas are online and active.")
@JsonProperty
+ @Deprecated(since = "9.10")
public Boolean waitForFinalState = false;
@Schema(description = "Request ID to track this action which will be
processed asynchronously.")
diff --git
a/solr/api/src/java/org/apache/solr/client/api/model/ReplaceNodeRequestBody.java
b/solr/api/src/java/org/apache/solr/client/api/model/ReplaceNodeRequestBody.java
index 303fd64e8db..95f7cb380d2 100644
---
a/solr/api/src/java/org/apache/solr/client/api/model/ReplaceNodeRequestBody.java
+++
b/solr/api/src/java/org/apache/solr/client/api/model/ReplaceNodeRequestBody.java
@@ -42,6 +42,7 @@ public class ReplaceNodeRequestBody {
+ "If false, the API will return the status of the single
action, which may be "
+ "before the new replica is online and active.")
@JsonProperty("waitForFinalState")
+ @Deprecated(since = "9.10")
public Boolean waitForFinalState = false;
@Schema(description = "Request ID to track this action which will be
processed asynchronously.")
diff --git
a/solr/core/src/test/org/apache/solr/cloud/CollectionsAPISolrJTest.java
b/solr/core/src/test/org/apache/solr/cloud/CollectionsAPISolrJTest.java
index e3aa232f768..992ec12f450 100644
--- a/solr/core/src/test/org/apache/solr/cloud/CollectionsAPISolrJTest.java
+++ b/solr/core/src/test/org/apache/solr/cloud/CollectionsAPISolrJTest.java
@@ -230,9 +230,10 @@ public class CollectionsAPISolrJTest extends
SolrCloudTestCase {
@Test
public void testCreateAndDeleteCollection() throws Exception {
String collectionName = getSaferTestName();
- CollectionAdminResponse response =
- CollectionAdminRequest.createCollection(collectionName, "conf", 2, 2)
- .process(cluster.getSolrClient());
+ CollectionAdminRequest.Create createREq =
+ CollectionAdminRequest.createCollection(collectionName, "conf", 2, 2);
+ createREq.setWaitForFinalState(false);
+ CollectionAdminResponse response =
createREq.process(cluster.getSolrClient());
assertEquals(0, response.getStatus());
assertTrue(response.isSuccess());
@@ -245,34 +246,35 @@ public class CollectionsAPISolrJTest extends
SolrCloudTestCase {
}
// Sometimes multiple cores land on the same node so it's less than 4
- int nodesCreated = response.getCollectionNodesStatus().size();
- response =
-
CollectionAdminRequest.deleteCollection(collectionName).process(cluster.getSolrClient());
-
- assertEquals(0, response.getStatus());
- assertTrue(response.isSuccess());
- Map<String, NamedList<Integer>> nodesStatus =
response.getCollectionNodesStatus();
- // Delete could have been sent before the collection was finished coming
online
- assertEquals(nodesStatus.toString(), nodesCreated, nodesStatus.size());
-
- waitForState(
- "Expected " + collectionName + " to disappear from cluster state",
- collectionName,
- Objects::isNull);
-
- // Test Creating a new collection.
- collectionName = "solrj_test2";
-
- response =
- CollectionAdminRequest.createCollection(collectionName, "conf", 2, 2)
- .process(cluster.getSolrClient());
- assertEquals(0, response.getStatus());
- assertTrue(response.isSuccess());
-
- waitForState(
- "Expected " + collectionName + " to appear in cluster state",
- collectionName,
- Objects::nonNull);
+ // int nodesCreated = response.getCollectionNodesStatus().size();
+ // response =
+ //
+ //
CollectionAdminRequest.deleteCollection(collectionName).process(cluster.getSolrClient());
+ //
+ // assertEquals(0, response.getStatus());
+ // assertTrue(response.isSuccess());
+ // Map<String, NamedList<Integer>> nodesStatus =
response.getCollectionNodesStatus();
+ // // Delete could have been sent before the collection was finished
coming online
+ // assertEquals(nodesStatus.toString(), nodesCreated,
nodesStatus.size());
+ //
+ // waitForState(
+ // "Expected " + collectionName + " to disappear from cluster
state",
+ // collectionName,
+ // Objects::isNull);
+ //
+ // // Test Creating a new collection.
+ // collectionName = "solrj_test2";
+ //
+ // response =
+ // CollectionAdminRequest.createCollection(collectionName, "conf",
2, 2)
+ // .process(cluster.getSolrClient());
+ // assertEquals(0, response.getStatus());
+ // assertTrue(response.isSuccess());
+ //
+ // waitForState(
+ // "Expected " + collectionName + " to appear in cluster state",
+ // collectionName,
+ // Objects::nonNull);
}
@Test
diff --git
a/solr/solrj/src/java/org/apache/solr/client/solrj/request/CollectionAdminRequest.java
b/solr/solrj/src/java/org/apache/solr/client/solrj/request/CollectionAdminRequest.java
index 3bff75b840e..635a6a38a25 100644
---
a/solr/solrj/src/java/org/apache/solr/client/solrj/request/CollectionAdminRequest.java
+++
b/solr/solrj/src/java/org/apache/solr/client/solrj/request/CollectionAdminRequest.java
@@ -167,6 +167,7 @@ public abstract class CollectionAdminRequest<T extends
CollectionAdminResponse>
return asyncId;
}
+ @Deprecated(since = "9.10")
public void setWaitForFinalState(boolean waitForFinalState) {
this.waitForFinalState = waitForFinalState;
}
diff --git
a/solr/solrj/src/java/org/apache/solr/client/solrj/request/beans/CreateShardPayload.java
b/solr/solrj/src/java/org/apache/solr/client/solrj/request/beans/CreateShardPayload.java
index 85b70eb183b..eaa2cb804ae 100644
---
a/solr/solrj/src/java/org/apache/solr/client/solrj/request/beans/CreateShardPayload.java
+++
b/solr/solrj/src/java/org/apache/solr/client/solrj/request/beans/CreateShardPayload.java
@@ -34,7 +34,9 @@ public class CreateShardPayload implements ReflectMapWriter {
@JsonProperty public String async;
- @JsonProperty public Boolean waitForFinalState;
+ @JsonProperty
+ @Deprecated(since = "9.10")
+ public Boolean waitForFinalState;
@JsonProperty public Integer replicationFactor;
diff --git
a/solr/solrj/src/java/org/apache/solr/client/solrj/request/beans/MoveReplicaPayload.java
b/solr/solrj/src/java/org/apache/solr/client/solrj/request/beans/MoveReplicaPayload.java
index 1bec9516cbe..4c075b12a46 100644
---
a/solr/solrj/src/java/org/apache/solr/client/solrj/request/beans/MoveReplicaPayload.java
+++
b/solr/solrj/src/java/org/apache/solr/client/solrj/request/beans/MoveReplicaPayload.java
@@ -29,7 +29,9 @@ public class MoveReplicaPayload implements ReflectMapWriter {
@JsonProperty public String sourceNode;
- @JsonProperty public Boolean waitForFinalState = false;
+ @JsonProperty
+ @Deprecated(since = "9.10")
+ public Boolean waitForFinalState = false;
@JsonProperty public Integer timeout = 600;
diff --git
a/solr/solrj/src/java/org/apache/solr/client/solrj/request/beans/SplitShardPayload.java
b/solr/solrj/src/java/org/apache/solr/client/solrj/request/beans/SplitShardPayload.java
index 677f1b25539..8b7e783e41b 100644
---
a/solr/solrj/src/java/org/apache/solr/client/solrj/request/beans/SplitShardPayload.java
+++
b/solr/solrj/src/java/org/apache/solr/client/solrj/request/beans/SplitShardPayload.java
@@ -46,5 +46,7 @@ public class SplitShardPayload implements ReflectMapWriter {
@JsonProperty public String async;
- @JsonProperty public Boolean waitForFinalState;
+ @JsonProperty
+ @Deprecated(since = "9.10")
+ public Boolean waitForFinalState;
}
diff --git
a/solr/solrj/src/java/org/apache/solr/common/params/CommonAdminParams.java
b/solr/solrj/src/java/org/apache/solr/common/params/CommonAdminParams.java
index c8745125341..b77516daf08 100644
--- a/solr/solrj/src/java/org/apache/solr/common/params/CommonAdminParams.java
+++ b/solr/solrj/src/java/org/apache/solr/common/params/CommonAdminParams.java
@@ -22,6 +22,7 @@ public interface CommonAdminParams {
String ASYNC = "async";
/** Wait for final state of the operation. */
+ @Deprecated(since = "9.10")
String WAIT_FOR_FINAL_STATE = "waitForFinalState";
/** Allow in-place move of replicas that use shared filesystems. */
