SOLR-7003: Remove unused boolean waitFlush from SolrClients

changelog/unreleased/SOLR-7003.yml

@@ -0,0 +1,8 @@
+# See https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc
+title: Remove unused waitFlush boolean from SolrClients
+type: removed # added, changed, fixed, deprecated, removed, dependency_update, security, other
+authors:
+  - name: Eric Pugh
+links:
+  - name: SOLR-7003
+    url: https://issues.apache.org/jira/browse/SOLR-7003

solr/core/src/java/org/apache/solr/cloud/api/collections/CollectionHandlingUtils.java

@@ -247,7 +247,7 @@ private static UpdateResponse softCommit(
       HttpJettySolrClient solrClient, String baseUrl, String coreName)
       throws SolrServerException, IOException {
     UpdateRequest ureq = new UpdateRequest();
-    ureq.setAction(AbstractUpdateRequest.ACTION.COMMIT, false, true, true);
+    ureq.setAction(AbstractUpdateRequest.ACTION.COMMIT, true, true);
     return ureq.processWithBaseUrl(solrClient, baseUrl, coreName);
   }
 

solr/core/src/java/org/apache/solr/handler/designer/SchemaDesignerAPI.java

@@ -1026,7 +1026,7 @@ protected Map<Object, Throwable> indexSampleDocs(
     // load sample docs from blob store
     CloudSolrClient cloudSolrClient = cloudClient();
     cloudSolrClient.deleteByQuery(collectionName, "*:*", 1);
-    cloudSolrClient.optimize(collectionName, true, true, 1);
+    cloudSolrClient.optimize(collectionName, true, 1);
 
     final int commitWithin = 100;
     final int numDocs = docs.size();
@@ -1060,7 +1060,7 @@ protected Map<Object, Throwable> indexSampleDocs(
       }
     }
 
-    cloudSolrClient.commit(collectionName, true, true, true);
+    cloudSolrClient.commit(collectionName, true, true);
 
     if (!errorsDuringIndexing.isEmpty()) {
       return errorsDuringIndexing;
@@ -1084,7 +1084,7 @@ protected long waitToSeeSampleDocs(String collectionName, long numAdded)
       // wait up to 5 seconds for this to occur
       final long deadline = System.nanoTime() + TimeUnit.SECONDS.toNanos(5);
       do {
-        cloudSolrClient.commit(collectionName, true, true, true);
+        cloudSolrClient.commit(collectionName, true, true);
         queryResponse = cloudSolrClient.query(collectionName, query);
         numFound = queryResponse.getResults().getNumFound();
         if (numFound >= numAdded) {

solr/core/src/java/org/apache/solr/update/SolrCmdDistributor.java

@@ -295,7 +295,7 @@ void addCommit(UpdateRequest ureq, CommitUpdateCommand cmd) {
     if (cmd == null) return;
     ureq.setAction(
         cmd.optimize ? AbstractUpdateRequest.ACTION.OPTIMIZE : AbstractUpdateRequest.ACTION.COMMIT,
-        false,
+        true, // waitFlush - ignored
         cmd.waitSearcher,
         cmd.maxOptimizeSegments,
         cmd.softCommit,

solr/core/src/test/org/apache/solr/cloud/RecoveryAfterSoftCommitTest.java

@@ -91,7 +91,7 @@ public void test() throws Exception {
 
     // soft-commit so searchers are open on un-committed but flushed segment files
     AbstractUpdateRequest request =
-        new UpdateRequest().setAction(AbstractUpdateRequest.ACTION.COMMIT, true, true, true);
+        new UpdateRequest().setAction(AbstractUpdateRequest.ACTION.COMMIT, true, true);
     cloudClient.request(request);
 
     Replica notLeader = ensureAllReplicasAreActive(DEFAULT_COLLECTION, "shard1", 1, 2, 30).get(0);

solr/core/src/test/org/apache/solr/cloud/TestStressInPlaceUpdates.java

@@ -183,7 +183,7 @@ public void run() {
 
                       if (rand.nextInt(100) < softCommitPercent) {
                         log.info("softCommit start");
-                        clients.get(chosenClientIndex).commit(true, true, true);
+                        clients.get(chosenClientIndex).commit(true, true);
                         log.info("softCommit end");
                       } else {
                         log.info("hardCommit start");

solr/core/src/test/org/apache/solr/core/snapshots/TestSolrCoreSnapshots.java

@@ -246,7 +246,7 @@ public void testIndexOptimization() throws Exception {
       }
 
       // Optimize the index.
-      leaderClient.optimize(true, true, 1);
+      leaderClient.optimize(true, 1);
 
       // After invoking optimize command, verify that the index directory contains multiple commits
       // (including the one we snapshotted earlier).
@@ -278,7 +278,7 @@ public void testIndexOptimization() throws Exception {
       }
 
       // Optimize the index.
-      leaderClient.optimize(true, true, 1);
+      leaderClient.optimize(true, 1);
 
       // Verify that the index directory contains only 1 index commit (which is not the same as the
       // snapshotted commit).

solr/core/src/test/org/apache/solr/handler/TestReplicationHandlerDiskOverFlow.java

@@ -242,7 +242,7 @@ private long indexDocs(SolrClient client, int totalDocs, int start) throws Excep
     for (int i = 0; i < totalDocs; i++)
       ReplicationTestHelper.index(
           client, "id", i + start, "name", TestUtil.randomSimpleString(random(), 1000, 5000));
-    client.commit(true, true);
+    client.commit(true, false);  // hard commit (softCommit=false) needed for replication
     QueryResponse response =
         client.query(
             new SolrQuery()

solr/core/src/test/org/apache/solr/search/TestSolrJ.java

@@ -179,7 +179,7 @@ public void doCommitPerf() throws Exception {
         SolrInputDocument doc = new SolrInputDocument();
         doc.addField("id", Integer.toString(i % 13));
         client.add(doc);
-        client.commit(true, true, true);
+        client.commit(true, true);
       }
 
       System.out.println("TIME: " + timer.getTime());

solr/solrj-streaming/src/java/org/apache/solr/client/solrj/io/stream/CommitStream.java

@@ -306,9 +306,7 @@ private String findZkHost(
   private void sendCommit() throws IOException {
 
     try {
-      clientCache
-          .getCloudSolrClient(zkHost)
-          .commit(collection, waitFlush, waitSearcher, softCommit);
+      clientCache.getCloudSolrClient(zkHost).commit(collection, waitSearcher, softCommit);
     } catch (SolrServerException | IOException e) {
       log.warn(
           String.format(

solr/solrj/src/java/org/apache/solr/client/solrj/SolrClient.java

@@ -407,7 +407,7 @@ public UpdateResponse addBeans(final Iterator<?> beanIterator)
   /**
    * Performs an explicit commit, causing pending documents to be committed for indexing
    *
-   * <p>waitFlush=true and waitSearcher=true to be inline with the defaults for plain HTTP access
+   * <p>waitSearcher=true to be inline with the defaults for plain HTTP access
    *
    * <p>Be very careful when triggering commits from the client side. Commits are heavy operations
    * and WILL impact Solr performance when executed too often or too close together. Instead,
@@ -421,13 +421,15 @@ public UpdateResponse addBeans(final Iterator<?> beanIterator)
    * @throws SolrServerException if there is an error on the server
    */
   public UpdateResponse commit(String collection) throws SolrServerException, IOException {
-    return commit(collection, true, true);
+    return new UpdateRequest()
+        .setAction(UpdateRequest.ACTION.COMMIT, true, true)
+        .process(this, collection);
   }
 
   /**
    * Performs an explicit commit, causing pending documents to be committed for indexing
    *
-   * <p>waitFlush=true and waitSearcher=true to be inline with the defaults for plain HTTP access
+   * <p>waitSearcher=true to be inline with the defaults for plain HTTP access
    *
    * <p>Be very careful when triggering commits from the client side. Commits are heavy operations
    * and WILL impact Solr performance when executed too often or too close together. Instead,
@@ -440,7 +442,9 @@ public UpdateResponse commit(String collection) throws SolrServerException, IOEx
    * @throws SolrServerException if there is an error on the server
    */
   public UpdateResponse commit() throws SolrServerException, IOException {
-    return commit(null, true, true);
+    return new UpdateRequest()
+        .setAction(UpdateRequest.ACTION.COMMIT, true, true)
+        .process(this, null);
   }
 
   /**
@@ -452,18 +456,17 @@ public UpdateResponse commit() throws SolrServerException, IOException {
    * 'autoCommit' settings.
    *
    * @param collection the Solr collection to send the commit to
-   * @param waitFlush block until index changes are flushed to disk
    * @param waitSearcher block until a new searcher is opened and registered as the main query
    *     searcher, making the changes visible
    * @return an {@link org.apache.solr.client.solrj.response.UpdateResponse} containing the response
    *     from the server
    * @throws IOException If there is a low-level I/O error.
    * @throws SolrServerException if there is an error on the server
    */
-  public UpdateResponse commit(String collection, boolean waitFlush, boolean waitSearcher)
+  public UpdateResponse commit(String collection, boolean waitSearcher)
       throws SolrServerException, IOException {
     return new UpdateRequest()
-        .setAction(UpdateRequest.ACTION.COMMIT, waitFlush, waitSearcher)
+        .setAction(UpdateRequest.ACTION.COMMIT, true, waitSearcher)
         .process(this, collection);
   }
 
@@ -475,17 +478,15 @@ public UpdateResponse commit(String collection, boolean waitFlush, boolean waitS
    * consider using 'commitWithin' when adding documents or rely on your core's/collection's
    * 'autoCommit' settings.
    *
-   * @param waitFlush block until index changes are flushed to disk
    * @param waitSearcher block until a new searcher is opened and registered as the main query
    *     searcher, making the changes visible
    * @return an {@link org.apache.solr.client.solrj.response.UpdateResponse} containing the response
    *     from the server
    * @throws IOException If there is a low-level I/O error.
    * @throws SolrServerException if there is an error on the server
    */
-  public UpdateResponse commit(boolean waitFlush, boolean waitSearcher)
-      throws SolrServerException, IOException {
-    return commit(null, waitFlush, waitSearcher);
+  public UpdateResponse commit(boolean waitSearcher) throws SolrServerException, IOException {
+    return commit(null, waitSearcher);
   }
 
   /**
@@ -497,7 +498,6 @@ public UpdateResponse commit(boolean waitFlush, boolean waitSearcher)
    * 'autoCommit' settings.
    *
    * @param collection the Solr collection to send the commit to
-   * @param waitFlush block until index changes are flushed to disk
    * @param waitSearcher block until a new searcher is opened and registered as the main query
    *     searcher, making the changes visible
    * @param softCommit makes index changes visible while neither fsync-ing index files nor writing a
@@ -507,11 +507,10 @@ public UpdateResponse commit(boolean waitFlush, boolean waitSearcher)
    * @throws IOException If there is a low-level I/O error.
    * @throws SolrServerException if there is an error on the server
    */
-  public UpdateResponse commit(
-      String collection, boolean waitFlush, boolean waitSearcher, boolean softCommit)
+  public UpdateResponse commit(String collection, boolean waitSearcher, boolean softCommit)
       throws SolrServerException, IOException {
     return new UpdateRequest()
-        .setAction(UpdateRequest.ACTION.COMMIT, waitFlush, waitSearcher, softCommit)
+        .setAction(UpdateRequest.ACTION.COMMIT, true, waitSearcher, softCommit)
         .process(this, collection);
   }
 
@@ -523,7 +522,6 @@ public UpdateResponse commit(
    * consider using 'commitWithin' when adding documents or rely on your core's/collection's
    * 'autoCommit' settings.
    *
-   * @param waitFlush block until index changes are flushed to disk
    * @param waitSearcher block until a new searcher is opened and registered as the main query
    *     searcher, making the changes visible
    * @param softCommit makes index changes visible while neither fsync-ing index files nor writing a
@@ -533,9 +531,11 @@ public UpdateResponse commit(
    * @throws IOException If there is a low-level I/O error.
    * @throws SolrServerException if there is an error on the server
    */
-  public UpdateResponse commit(boolean waitFlush, boolean waitSearcher, boolean softCommit)
+  public UpdateResponse commit(boolean waitSearcher, boolean softCommit)
       throws SolrServerException, IOException {
-    return commit(null, waitFlush, waitSearcher, softCommit);
+    return new UpdateRequest()
+        .setAction(UpdateRequest.ACTION.COMMIT, true, waitSearcher, softCommit)
+        .process(this, null);
   }
 
   /**
@@ -552,13 +552,15 @@ public UpdateResponse commit(boolean waitFlush, boolean waitSearcher, boolean so
    * @throws SolrServerException if there is an error on the server
    */
   public UpdateResponse optimize(String collection) throws SolrServerException, IOException {
-    return optimize(collection, true, true, 1);
+    return new UpdateRequest()
+        .setAction(UpdateRequest.ACTION.OPTIMIZE, true, true, 1)
+        .process(this, collection);
   }
 
   /**
    * Performs an explicit optimize, causing a merge of all segments to one.
    *
-   * <p>waitFlush=true and waitSearcher=true to be inline with the defaults for plain HTTP access
+   * <p>waitSearcher=true to be inline with the defaults for plain HTTP access
    *
    * <p>Note: In most cases it is not required to do explicit optimize
    *
@@ -568,7 +570,9 @@ public UpdateResponse optimize(String collection) throws SolrServerException, IO
    * @throws SolrServerException if there is an error on the server
    */
   public UpdateResponse optimize() throws SolrServerException, IOException {
-    return optimize(null, true, true, 1);
+    return new UpdateRequest()
+        .setAction(UpdateRequest.ACTION.OPTIMIZE, true, true, 1)
+        .process(this, null);
   }
 
   /**
@@ -577,35 +581,34 @@ public UpdateResponse optimize() throws SolrServerException, IOException {
    * <p>Note: In most cases it is not required to do explicit optimize
    *
    * @param collection the Solr collection to send the optimize command to
-   * @param waitFlush block until index changes are flushed to disk
    * @param waitSearcher block until a new searcher is opened and registered as the main query
    *     searcher, making the changes visible
    * @return an {@link org.apache.solr.client.solrj.response.UpdateResponse} containing the response
    *     from the server
    * @throws IOException If there is a low-level I/O error.
    * @throws SolrServerException if there is an error on the server
    */
-  public UpdateResponse optimize(String collection, boolean waitFlush, boolean waitSearcher)
+  public UpdateResponse optimize(String collection, boolean waitSearcher)
       throws SolrServerException, IOException {
-    return optimize(collection, waitFlush, waitSearcher, 1);
+    return new UpdateRequest()
+        .setAction(UpdateRequest.ACTION.OPTIMIZE, true, waitSearcher, 1)
+        .process(this, collection);
   }
 
   /**
    * Performs an explicit optimize, causing a merge of all segments to one.
    *
    * <p>Note: In most cases it is not required to do explicit optimize
    *
-   * @param waitFlush block until index changes are flushed to disk
    * @param waitSearcher block until a new searcher is opened and registered as the main query
    *     searcher, making the changes visible
    * @return an {@link org.apache.solr.client.solrj.response.UpdateResponse} containing the response
    *     from the server
    * @throws IOException If there is a low-level I/O error.
    * @throws SolrServerException if there is an error on the server
    */
-  public UpdateResponse optimize(boolean waitFlush, boolean waitSearcher)
-      throws SolrServerException, IOException {
-    return optimize(null, waitFlush, waitSearcher);
+  public UpdateResponse optimize(boolean waitSearcher) throws SolrServerException, IOException {
+    return optimize(null, waitSearcher);
   }
 
   /**
@@ -614,7 +617,6 @@ public UpdateResponse optimize(boolean waitFlush, boolean waitSearcher)
    * <p>Note: In most cases it is not required to do explicit optimize
    *
    * @param collection the Solr collection to send the optimize command to
-   * @param waitFlush block until index changes are flushed to disk
    * @param waitSearcher block until a new searcher is opened and registered as the main query
    *     searcher, making the changes visible
    * @param maxSegments optimizes down to at most this number of segments
@@ -623,11 +625,10 @@ public UpdateResponse optimize(boolean waitFlush, boolean waitSearcher)
    * @throws IOException If there is a low-level I/O error.
    * @throws SolrServerException if there is an error on the server
    */
-  public UpdateResponse optimize(
-      String collection, boolean waitFlush, boolean waitSearcher, int maxSegments)
+  public UpdateResponse optimize(String collection, boolean waitSearcher, int maxSegments)
       throws SolrServerException, IOException {
     return new UpdateRequest()
-        .setAction(UpdateRequest.ACTION.OPTIMIZE, waitFlush, waitSearcher, maxSegments)
+        .setAction(UpdateRequest.ACTION.OPTIMIZE, true, waitSearcher, maxSegments)
         .process(this, collection);
   }
 
@@ -636,7 +637,6 @@ public UpdateResponse optimize(
    *
    * <p>Note: In most cases it is not required to do explicit optimize
    *
-   * @param waitFlush block until index changes are flushed to disk
    * @param waitSearcher block until a new searcher is opened and registered as the main query
    *     searcher, making the changes visible
    * @param maxSegments optimizes down to at most this number of segments
@@ -645,9 +645,11 @@ public UpdateResponse optimize(
    * @throws IOException If there is a low-level I/O error.
    * @throws SolrServerException if there is an error on the server
    */
-  public UpdateResponse optimize(boolean waitFlush, boolean waitSearcher, int maxSegments)
+  public UpdateResponse optimize(boolean waitSearcher, int maxSegments)
       throws SolrServerException, IOException {
-    return optimize(null, waitFlush, waitSearcher, maxSegments);
+    return new UpdateRequest()
+        .setAction(UpdateRequest.ACTION.OPTIMIZE, true, waitSearcher, maxSegments)
+        .process(this, null);
   }
 
   /**

solr/solrj/src/test/org/apache/solr/client/solrj/SolrExampleTests.java

@@ -326,7 +326,7 @@ public void testExampleConfig() throws Exception {
     // System.out.println( "COMMIT:"+upres.getResponse() );
     assertEquals(0, upres.getStatus());
 
-    upres = client.optimize(true, true);
+    upres = client.optimize(true);
     // System.out.println( "OPTIMIZE:"+upres.getResponse() );
     assertEquals(0, upres.getStatus());
 
@@ -371,7 +371,7 @@ public void testExampleConfig() throws Exception {
     // System.out.println( "COMMIT:"+upres.getResponse() );
     assertEquals(0, upres.getStatus());
 
-    upres = client.optimize(true, true);
+    upres = client.optimize(true);
     // System.out.println( "OPTIMIZE:"+upres.getResponse() );
     assertEquals(0, upres.getStatus());
 

solr/test-framework/src/java/org/apache/solr/cloud/StoppableCommitThread.java

@@ -46,7 +46,7 @@ public void run() {
     log.debug("StoppableCommitThread started");
     while (!stop) {
       try {
-        cloudClient.commit(false, false, softCommits);
+        cloudClient.commit(false, softCommits);
         numCommits.incrementAndGet();
       } catch (Exception e) {
         numFails.incrementAndGet();