SOLR-18038: Remove deprecated LocalSolrQueryRequest and use SolrQueryRequestBase (#4131)

Migrate from LocalSolrQueryRequest to SolrQueryRequestBase by making SolrQueryRequestBase no longer abstract and including all functionality previously unique to LocalSolrQueryRequest

Author: epugh

changelog/unreleased/SOLR-18038-v2.yml

@@ -0,0 +1,8 @@
+# See https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc
+title: Remove deprecated LocalSolrQueryRequest in favour of SolrQueryRequestBase.
+type: removed # added, changed, fixed, deprecated, removed, dependency_update, security, other
+authors:
+  - name: Eric Pugh
+links:
+  - name: SOLR-18038
+    url: https://issues.apache.org/jira/browse/SOLR-18038

solr/core/src/java/org/apache/solr/api/Api.java

@@ -25,8 +25,8 @@
 import org.apache.solr.response.SolrQueryResponse;
 
 /**
- * Every version 2 API must extend the this class. It's mostly like a request handler but it has
- * extra methods to provide the json schema of the end point
+ * Every version 2 API must extend this class. It's mostly like a request handler, but it has extra
+ * methods to provide the json schema of the end point
  */
 public abstract class Api implements SpecProvider {
   protected SpecProvider spec;

solr/core/src/java/org/apache/solr/cloud/RecoveryStrategy.java

@@ -55,8 +55,8 @@
 import org.apache.solr.core.DirectoryFactory.DirContext;
 import org.apache.solr.core.SolrCore;
 import org.apache.solr.handler.ReplicationHandler;
-import org.apache.solr.request.LocalSolrQueryRequest;
 import org.apache.solr.request.SolrQueryRequest;
+import org.apache.solr.request.SolrQueryRequestBase;
 import org.apache.solr.request.SolrRequestHandler;
 import org.apache.solr.search.SolrIndexSearcher;
 import org.apache.solr.update.CommitUpdateCommand;
@@ -689,7 +689,7 @@ public final void doSyncOrReplicateRecovery(SolrCore core) throws Exception {
             syncSuccess = peerSyncWithLeader.sync(recentVersions).isSuccess();
           }
           if (syncSuccess) {
-            SolrQueryRequest req = new LocalSolrQueryRequest(core, new ModifiableSolrParams());
+            SolrQueryRequest req = new SolrQueryRequestBase(core, new ModifiableSolrParams());
             // force open a new searcher
             core.getUpdateHandler().commit(new CommitUpdateCommand(req, false));
             req.close();
@@ -850,7 +850,7 @@ private final Future<RecoveryInfo> replay(SolrCore core)
     }
     if (replicaType == Replica.Type.TLOG) {
       // roll over all updates during buffering to new tlog, make RTG available
-      SolrQueryRequest req = new LocalSolrQueryRequest(core, new ModifiableSolrParams());
+      SolrQueryRequest req = new SolrQueryRequestBase(core, new ModifiableSolrParams());
       core.getUpdateHandler()
           .getUpdateLog()
           .copyOverBufferingUpdates(new CommitUpdateCommand(req, false));

solr/core/src/java/org/apache/solr/cloud/ReplicateFromLeader.java

@@ -28,8 +28,8 @@
 import org.apache.solr.handler.IndexFetcher;
 import org.apache.solr.handler.ReplicationHandler;
 import org.apache.solr.handler.admin.api.ReplicationAPIBase;
-import org.apache.solr.request.LocalSolrQueryRequest;
 import org.apache.solr.request.SolrQueryRequest;
+import org.apache.solr.request.SolrQueryRequestBase;
 import org.apache.solr.update.CommitUpdateCommand;
 import org.apache.solr.update.SolrIndexWriter;
 import org.apache.solr.update.UpdateLog;
@@ -101,7 +101,7 @@ public void startReplication(boolean switchTransactionLog) {
                 if (commitVersion == null) return;
                 if (Long.parseLong(commitVersion) == lastVersion) return;
                 UpdateLog updateLog = solrCore.getUpdateHandler().getUpdateLog();
-                SolrQueryRequest req = new LocalSolrQueryRequest(core, new ModifiableSolrParams());
+                SolrQueryRequest req = new SolrQueryRequestBase(core, new ModifiableSolrParams());
                 CommitUpdateCommand cuc = new CommitUpdateCommand(req, false);
                 cuc.setVersion(Long.parseLong(commitVersion));
                 updateLog.commitAndSwitchToNewTlog(cuc);

solr/core/src/java/org/apache/solr/core/CoreContainer.java

@@ -137,8 +137,8 @@
 import org.apache.solr.metrics.SolrMetricsContext;
 import org.apache.solr.metrics.otel.OtelUnit;
 import org.apache.solr.pkg.SolrPackageLoader;
-import org.apache.solr.request.LocalSolrQueryRequest;
 import org.apache.solr.request.SolrQueryRequest;
+import org.apache.solr.request.SolrQueryRequestBase;
 import org.apache.solr.request.SolrRequestHandler;
 import org.apache.solr.request.SolrRequestInfo;
 import org.apache.solr.search.CacheConfig;
@@ -1977,7 +1977,7 @@ public void reload(String name, UUID coreId) {
 
         // force commit on old core if the new one is readOnly and prevent any new updates
         if (newCore.readOnly) {
-          SolrQueryRequest req = new LocalSolrQueryRequest(core, new ModifiableSolrParams());
+          SolrQueryRequest req = new SolrQueryRequestBase(core, new ModifiableSolrParams());
           core.getUpdateHandler().commit(CommitUpdateCommand.closeOnCommit(req, false));
         }
 

solr/core/src/java/org/apache/solr/handler/IndexFetcher.java

@@ -117,8 +117,8 @@
 import org.apache.solr.core.IndexDeletionPolicyWrapper;
 import org.apache.solr.core.SolrCore;
 import org.apache.solr.handler.admin.api.ReplicationAPIBase;
-import org.apache.solr.request.LocalSolrQueryRequest;
 import org.apache.solr.request.SolrQueryRequest;
+import org.apache.solr.request.SolrQueryRequestBase;
 import org.apache.solr.search.SolrIndexSearcher;
 import org.apache.solr.security.AllowListUrlChecker;
 import org.apache.solr.update.CommitUpdateCommand;
@@ -540,7 +540,7 @@ IndexFetchResult fetchLatestIndex(boolean forceReplication, boolean forceCoreRel
           if (skipCommitOnLeaderVersionZero || solrCore.readOnly) {
             openNewSearcherAndUpdateCommitPoint();
           } else {
-            SolrQueryRequest req = new LocalSolrQueryRequest(solrCore, new ModifiableSolrParams());
+            SolrQueryRequest req = new SolrQueryRequestBase(solrCore, new ModifiableSolrParams());
             solrCore.getUpdateHandler().commit(new CommitUpdateCommand(req, false));
           }
         }

solr/core/src/java/org/apache/solr/handler/admin/SplitOp.java

@@ -48,8 +48,8 @@
 import org.apache.solr.common.params.CoreAdminParams;
 import org.apache.solr.common.params.SolrParams;
 import org.apache.solr.core.SolrCore;
-import org.apache.solr.request.LocalSolrQueryRequest;
 import org.apache.solr.request.SolrQueryRequest;
+import org.apache.solr.request.SolrQueryRequestBase;
 import org.apache.solr.search.SolrIndexSearcher;
 import org.apache.solr.update.SolrIndexSplitter;
 import org.apache.solr.update.SplitIndexCommand;
@@ -201,7 +201,7 @@ public void execute(CoreAdminHandler.CallInfo it) throws Exception {
         paths = Arrays.asList(pathsArr);
       }
 
-      req = new LocalSolrQueryRequest(parentCore, params);
+      req = new SolrQueryRequestBase(parentCore, params);
 
       SplitIndexCommand cmd =
           new SplitIndexCommand(

solr/core/src/java/org/apache/solr/handler/admin/api/MergeIndexes.java

@@ -39,8 +39,8 @@
 import org.apache.solr.core.SolrCore;
 import org.apache.solr.handler.admin.CoreAdminHandler;
 import org.apache.solr.jersey.PermissionName;
-import org.apache.solr.request.LocalSolrQueryRequest;
 import org.apache.solr.request.SolrQueryRequest;
+import org.apache.solr.request.SolrQueryRequestBase;
 import org.apache.solr.response.SolrQueryResponse;
 import org.apache.solr.search.SolrIndexSearcher;
 import org.apache.solr.security.PermissionNameProvider;
@@ -169,7 +169,7 @@ public SolrJerseyResponse mergeIndexes(String coreName, MergeIndexesRequestBody
 
               UpdateRequestProcessorChain processorChain =
                   core.getUpdateProcessingChain(requestBody.updateChain);
-              wrappedReq = new LocalSolrQueryRequest(core, req.getParams());
+              wrappedReq = new SolrQueryRequestBase(core, req.getParams());
               UpdateRequestProcessor processor = processorChain.createProcessor(wrappedReq, rsp);
               processor.processMergeIndexes(new MergeIndexesCommand(readers, req));
             } catch (Exception e) {

solr/core/src/java/org/apache/solr/handler/admin/api/UpgradeCoreIndex.java

@@ -50,8 +50,8 @@
 import org.apache.solr.handler.RequestHandlerBase;
 import org.apache.solr.handler.admin.CoreAdminHandler;
 import org.apache.solr.index.LatestVersionMergePolicy;
-import org.apache.solr.request.LocalSolrQueryRequest;
 import org.apache.solr.request.SolrQueryRequest;
+import org.apache.solr.request.SolrQueryRequestBase;
 import org.apache.solr.request.SolrRequestHandler;
 import org.apache.solr.response.SolrQueryResponse;
 import org.apache.solr.schema.IndexSchema;
@@ -95,7 +95,7 @@ public class UpgradeCoreIndex extends CoreAdminAPIBase {
   public enum CoreIndexUpgradeStatus {
     UPGRADE_SUCCESSFUL,
     ERROR,
-    NO_UPGRADE_NEEDED;
+    NO_UPGRADE_NEEDED
   }
 
   private static final int RETRY_COUNT_FOR_SEGMENT_DELETION = 5;
@@ -377,7 +377,7 @@ private boolean isIndexUpgraded(SolrCore core) throws IOException {
   }
 
   private void doCommit(SolrCore core) throws IOException {
-    try (LocalSolrQueryRequest req = new LocalSolrQueryRequest(core, new ModifiableSolrParams())) {
+    try (SolrQueryRequestBase req = new SolrQueryRequestBase(core, new ModifiableSolrParams())) {
       CommitUpdateCommand cmd = new CommitUpdateCommand(req, false); // optimize=false
       core.getUpdateHandler().commit(cmd);
     } catch (IOException ioEx) {
@@ -404,8 +404,8 @@ private void processSegment(
     // Exclude copy field targets to avoid duplicating values on reindex
     Set<String> nonStoredDVFields = docFetcher.getNonStoredDVsWithoutCopyTargets();
 
-    try (LocalSolrQueryRequest solrRequest =
-        new LocalSolrQueryRequest(core, new ModifiableSolrParams())) {
+    try (SolrQueryRequestBase solrRequest =
+        new SolrQueryRequestBase(core, new ModifiableSolrParams())) {
       SolrQueryResponse rsp = new SolrQueryResponse();
       UpdateRequestProcessor processor = processorChain.createProcessor(solrRequest, rsp);
       try {

solr/core/src/java/org/apache/solr/handler/component/RealTimeGetComponent.java

@@ -74,8 +74,8 @@
 import org.apache.solr.common.util.NamedList;
 import org.apache.solr.common.util.StrUtils;
 import org.apache.solr.core.SolrCore;
-import org.apache.solr.request.LocalSolrQueryRequest;
 import org.apache.solr.request.SolrQueryRequest;
+import org.apache.solr.request.SolrQueryRequestBase;
 import org.apache.solr.response.ResultContext;
 import org.apache.solr.response.SolrQueryResponse;
 import org.apache.solr.response.transform.DocTransformer;
@@ -859,7 +859,7 @@ private static SolrReturnFields makeReturnFields(
     if (resolution == Resolution.ROOT_WITH_CHILDREN
         && core.getLatestSchema().isUsableForChildDocs()) {
       SolrParams params = new ModifiableSolrParams().set("limit", "-1");
-      try (LocalSolrQueryRequest req = new LocalSolrQueryRequest(core, params)) {
+      try (SolrQueryRequestBase req = new SolrQueryRequestBase(core, params)) {
         docTransformer = core.getTransformerFactory("child").create(null, params, req);
       }
     } else {