SOLR-18038: Remove deprecated LocalSolrQueryRequest and use SolrQueryRequestBase by epugh · Pull Request #4101 · apache/solr

epugh · 2026-02-04T10:40:34Z

https://issues.apache.org/jira/browse/SOLR-18038

Description

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

Solution

Beyond the direct conversion, I've also looked for places we used a NamedList and replaced them with ModifiableSolrParams.

There is this "six parameter" pattern that remains, primarily in tests, but it's done via ModifiableSolrParams method.

Some anonymous subclasses of SolrQueryRequestBase are now explicit. CSVRequest was trivial and could be removed now that SolrQueryRequestBase isn't abstract.

_BIG QUESTION: SHould we rename SolrQueryRequestBase to just SolrQueryRequest and eliminate the interface SolrQueryRequest?

Tests

I've re-run the tests.

… used This lets us replace LocalSolrQueryRequest

epugh · 2026-02-04T10:41:22Z

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

    } else {
      stream = new ContentStreamBase.ByteArrayStream(streamBytes, source, "text/csv");
    }
-    return (new SampleCSVLoader(new CSVRequest(params), maxDocsToLoad)).loadDocs(stream);


Here we deleted a trivial class!

epugh · 2026-02-04T10:42:09Z

solr/core/src/java/org/apache/solr/request/SolrQueryRequestBase.java

 * longer in use.
 */
-public abstract class SolrQueryRequestBase implements SolrQueryRequest, Closeable {
+public class SolrQueryRequestBase implements SolrQueryRequest, Closeable {


Do we eliminate SolrQueryRequest interface?

epugh · 2026-02-04T10:44:09Z

solr/core/src/java/org/apache/solr/request/SolrQueryRequestBase.java

  protected Map<Object, Object> context;
  protected Iterable<ContentStream> streams;
  protected Map<String, Object> json;
+  protected String userPrincipalName = null;


I investigated why we had to preserve this here when only one class uses it and:

DocExpirationUpdateProcessorFactory is the ONLY built-in component that:

Creates background/scheduled requests (not triggered by HTTP)

Needs authentication (because it makes distributed deletes)

Must identify itself as a node-initiated operation

Other internal requests either:

Don't need authentication (single-node operations)

Are triggered by user requests (already have principal from HTTP)

Use different mechanisms (like HTTP client with PKI headers for inter-node communication)

This is why setUserPrincipalName() exists but is rarely used - it's a special-purpose API for a rare use case!

I wondered about another home for this, or how do we handle secure internode elsewhere...? Any ideas?

epugh · 2026-02-04T10:45:57Z

solr/core/src/java/org/apache/solr/request/SolrQueryRequestBase.java


+  /**
+   * Utility method to build SolrParams from individual query components. This is a convenience
+   * method for legacy code that needs to construct params from separate query, qtype, start, limit,


how strongly do we want to eliminate this pattern? Actually, on more investigation, it's only used by five classes, though 27 times!

epugh · 2026-02-04T10:46:42Z

solr/core/src/java/org/apache/solr/request/SolrQueryRequestBase.java

  @Override
  public IndexSchema getSchema() {
-    // a request for a core admin will no have a core
+    // a request for a core admin will not have a core


I am not sure what this comment is telling us..

epugh · 2026-02-04T10:47:12Z

solr/core/src/java/org/apache/solr/request/SolrQueryRequestBase.java

+   *
+   * @see PKIAuthenticationPlugin#NODE_IS_USER
+   * @see #getUserPrincipal
+   * @lucene.internal


these tags are copied over from oroginal implementation. Not sure what they mean or why we have them at this point. If there was a better more "supported" way to do this, I'd love to hear about it!

epugh · 2026-02-04T11:10:09Z

solr/core/src/test/org/apache/solr/ConvertedLegacyTest.java


    assertU("<optimize/>");

-    // test query


These tests are covered by other unit tests that do the same thing. So removed to pare this massive file back.

Copilot

Pull request overview

This PR removes the deprecated LocalSolrQueryRequest by making SolrQueryRequestBase instantiable and migrating production code + tests to use it, including some cleanup of legacy parameter-building patterns.

Changes:

Make SolrQueryRequestBase concrete and move functionality previously unique to LocalSolrQueryRequest into it; delete LocalSolrQueryRequest.
Update many modules/tests to construct requests using SolrQueryRequestBase, frequently switching from NamedList to ModifiableSolrParams.
Minor test refactors/cleanups (imports, signatures, small comment tweaks).

Reviewed changes

Copilot reviewed 80 out of 80 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
solr/test-framework/src/java/org/apache/solr/util/TestHarness.java	Adds a helper to build `SolrParams` for legacy “six-parameter” request construction; updates factory to use `SolrQueryRequestBase`.
solr/test-framework/src/java/org/apache/solr/update/processor/UpdateProcessorTestBase.java	Migrates request creation from `LocalSolrQueryRequest` to `SolrQueryRequestBase`.
solr/test-framework/src/java/org/apache/solr/SolrTestCaseJ4.java	Uses `SolrQueryRequestBase` in helpers that previously returned `LocalSolrQueryRequest`.
solr/solrj/src/test/org/apache/solr/client/solrj/routing/ReplicaListTransformerTest.java	Updates test request instantiation; minor method signature cleanup.
solr/solrj/src/test/org/apache/solr/client/solrj/request/TestCoreAdmin.java	Removes unnecessary checked exceptions/imports in tests.
solr/modules/scripting/src/test/org/apache/solr/scripting/xslt/XSLTUpdateRequestHandlerTest.java	Migrates request creation to `SolrQueryRequestBase`.
solr/modules/scripting/src/java/org/apache/solr/scripting/update/ScriptUpdateProcessorFactory.java	Uses `SolrQueryRequestBase` for local init validation request.
solr/modules/ltr/src/test/org/apache/solr/ltr/TestLTRReRankingPipeline.java	Migrates test request creation to `SolrQueryRequestBase`.
solr/modules/ltr/src/java/org/apache/solr/ltr/feature/SolrFeature.java	Switches request param construction from `NamedList` to `ModifiableSolrParams` and `SolrQueryRequestBase`.
solr/modules/extraction/src/test/org/apache/solr/handler/extraction/ExtractingRequestHandlerTestAbstract.java	Adjusts casts/types to `SolrQueryRequestBase` for request handling in tests.
solr/modules/cross-dc/src/test/org/apache/solr/crossdc/handler/MirroringConfigSetsHandlerTest.java	Uses `SolrQueryRequestBase` for test request creation.
solr/modules/cross-dc/src/test/org/apache/solr/crossdc/handler/MirroringCollectionsHandlerTest.java	Uses `SolrQueryRequestBase` for test request creation.
solr/modules/cross-dc/src/java/org/apache/solr/crossdc/handler/MirroringConfigSetsHandler.java	Wraps requests using `SolrQueryRequestBase` instead of `LocalSolrQueryRequest`.
solr/modules/clustering/src/test/org/apache/solr/handler/clustering/ClusteringComponentTest.java	Migrates requests in tests to `SolrQueryRequestBase`.
solr/modules/clustering/src/java/org/apache/solr/handler/clustering/ClusteringComponent.java	Replaces legacy arg-map request construction with `ModifiableSolrParams` + `SolrQueryRequestBase`.
solr/core/src/test/org/apache/solr/update/processor/UUIDUpdateProcessorFallbackTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/update/processor/TolerantUpdateProcessorTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/update/processor/TemplateUpdateProcessorTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/update/processor/SkipExistingDocumentsProcessorFactoryTest.java	Moves request params from `NamedList` to `ModifiableSolrParams` and uses `SolrQueryRequestBase`.
solr/core/src/test/org/apache/solr/update/processor/SignatureUpdateProcessorFactoryTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/update/processor/IgnoreCommitOptimizeUpdateProcessorFactoryTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/update/processor/DistributedUpdateProcessorTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/update/processor/DefaultValueUpdateProcessorTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/update/processor/AtomicUpdateProcessorFactoryTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/update/SolrIndexSplitterTest.java	Updates test request types/creation to `SolrQueryRequestBase`.
solr/core/src/test/org/apache/solr/update/DirectUpdateHandlerTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/update/AddBlockUpdateTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/spelling/SpellCheckCollatorTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/security/TestPKIAuthenticationPlugin.java	Updates test request type; introduces a poorly named variable that shadows the class.
solr/core/src/test/org/apache/solr/search/SpatialFilterTest.java	Updates commented-out legacy snippet to `SolrQueryRequestBase`.
solr/core/src/test/org/apache/solr/search/SignificantTermsQParserPluginTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/schema/IndexSchemaTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/schema/IndexSchemaRuntimeFieldTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/schema/CopyFieldTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/schema/ChangedSchemaMergeTest.java	Uses `SolrQueryRequestBase` in tests; replaces `NamedList` request params.
solr/core/src/test/org/apache/solr/response/TestPushWriter.java	Uses `SolrQueryRequestBase` in writer tests.
solr/core/src/test/org/apache/solr/response/TestJavaBinResponseWriter.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/response/SmileWriterTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/request/TestSolrRequestInfo.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/handler/component/StatsComponentTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/handler/component/SpellCheckComponentTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/handler/component/MoreLikeThisComponentTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/handler/admin/api/V2NodeAPIMappingTest.java	Reworks param capture to use `ModifiableSolrParams` + `SolrQueryRequestBase`.
solr/core/src/test/org/apache/solr/handler/admin/V2ApiMappingTest.java	Updates request instantiation for mapping tests to `SolrQueryRequestBase`.
solr/core/src/test/org/apache/solr/handler/admin/TestCollectionAPIs.java	Updates request instantiation but drops `getHttpMethod()` behavior needed by `BaseHandlerApiSupport`.
solr/core/src/test/org/apache/solr/handler/admin/TestApiFramework.java	Uses `SolrQueryRequestBase` for API-framework tests.
solr/core/src/test/org/apache/solr/handler/admin/ShowFileRequestHandlerTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/handler/admin/SecurityConfHandlerTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/handler/V2UpdateAPIMappingTest.java	Uses `SolrQueryRequestBase` for update API mapping tests.
solr/core/src/test/org/apache/solr/handler/V2ClusterAPIMappingTest.java	Uses `SolrQueryRequestBase` for cluster API mapping tests.
solr/core/src/test/org/apache/solr/handler/TestCSVLoader.java	Uses `SolrQueryRequestBase` in tests; minor formatting.
solr/core/src/test/org/apache/solr/handler/RequestHandlerBaseTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/handler/MoreLikeThisHandlerTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/handler/FieldAnalysisRequestHandlerTest.java	Uses `SolrQueryRequestBase` in tests.
solr/core/src/test/org/apache/solr/core/TestLazyCores.java	Returns `SolrQueryRequestBase` from helper methods in tests.
solr/core/src/test/org/apache/solr/TestCrossCoreJoin.java	Replaces 6-arg request ctor usage with explicit `ModifiableSolrParams` + `SolrQueryRequestBase`.
solr/core/src/test/org/apache/solr/ConvertedLegacyTest.java	Migrates legacy request construction to `TestHarness.makeParams(...)` + `SolrQueryRequestBase`.
solr/core/src/test/org/apache/solr/BasicFunctionalityTest.java	Updates request creation to `SolrQueryRequestBase`; minor comment tweak.
solr/core/src/java/org/apache/solr/update/processor/DocExpirationUpdateProcessorFactory.java	Uses `SolrQueryRequestBase` for internal periodic work; minor comment fixes.
solr/core/src/java/org/apache/solr/update/UpdateLog.java	Uses `SolrQueryRequestBase` for internal update-log operations.
solr/core/src/java/org/apache/solr/update/PeerSync.java	Uses `SolrQueryRequestBase` for internal requests during peer sync.
solr/core/src/java/org/apache/solr/update/DirectUpdateHandler2.java	Uses `SolrQueryRequestBase` for internal request context.
solr/core/src/java/org/apache/solr/update/CommitTracker.java	Uses `SolrQueryRequestBase` for internal commit execution.
solr/core/src/java/org/apache/solr/search/join/ScoreJoinQParserPlugin.java	Uses `SolrQueryRequestBase` for cross-core parsing request.
solr/core/src/java/org/apache/solr/search/JoinQParserPlugin.java	Uses `SolrQueryRequestBase` for cross-core parsing request.
solr/core/src/java/org/apache/solr/schema/IndexSchema.java	Uses `SolrQueryRequestBase` for schema XML writing request context.
solr/core/src/java/org/apache/solr/request/SolrQueryRequestBase.java	Made concrete; adds principal-name plumbing; removes deprecated `LocalSolrQueryRequest` dependency.
solr/core/src/java/org/apache/solr/request/SolrQueryRequest.java	Small signature/style cleanup in interface (remove redundant `public`).
solr/core/src/java/org/apache/solr/request/LocalSolrQueryRequest.java	Deleted (deprecated class removal).
solr/core/src/java/org/apache/solr/handler/designer/DefaultSampleDocumentsLoader.java	Removes trivial `CSVRequest` subclass; uses `SolrQueryRequestBase` directly.
solr/core/src/java/org/apache/solr/handler/component/RealTimeGetComponent.java	Uses `SolrQueryRequestBase` for transformer factory request.
solr/core/src/java/org/apache/solr/handler/admin/api/UpgradeCoreIndex.java	Uses `SolrQueryRequestBase` for internal commit/reindex operations.
solr/core/src/java/org/apache/solr/handler/admin/api/MergeIndexes.java	Wraps request with `SolrQueryRequestBase` when invoking update chain.
solr/core/src/java/org/apache/solr/handler/admin/SplitOp.java	Uses `SolrQueryRequestBase` for split requests.
solr/core/src/java/org/apache/solr/handler/IndexFetcher.java	Uses `SolrQueryRequestBase` for internal commit requests.
solr/core/src/java/org/apache/solr/core/CoreContainer.java	Uses `SolrQueryRequestBase` for internal commit during reload/read-only transitions.
solr/core/src/java/org/apache/solr/cloud/ReplicateFromLeader.java	Uses `SolrQueryRequestBase` for internal commit-and-switch operations.
solr/core/src/java/org/apache/solr/cloud/RecoveryStrategy.java	Uses `SolrQueryRequestBase` for internal commits during recovery.
solr/core/src/java/org/apache/solr/api/Api.java	Minor doc grammar cleanup.

Comments suppressed due to low confidence (1)

solr/core/src/test/org/apache/solr/security/TestPKIAuthenticationPlugin.java:97

The variable name SolrQueryRequestBase shadows the SolrQueryRequestBase type and violates usual lowerCamelCase conventions. This is easy to misread and can confuse IDE navigation; rename it to something like localReq / testReq / solrRequest.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

solr/core/src/test/org/apache/solr/BasicFunctionalityTest.java

Copilot · 2026-02-04T15:15:08Z

solr/core/src/java/org/apache/solr/request/SolrQueryRequestBase.java

 import org.apache.solr.schema.IndexSchema;
 import org.apache.solr.search.SolrIndexSearcher;
+import org.apache.solr.security.PKIAuthenticationPlugin;
 import org.apache.solr.util.RTimerTree;


PKIAuthenticationPlugin is imported but only referenced in Javadoc. If the build enforces no-unused-imports (common with Checkstyle/Spotless), this will fail. Either remove the import and fully-qualify it in the @see, or reference the class in code.

solr/core/src/java/org/apache/solr/request/SolrQueryRequestBase.java

Copilot · 2026-02-04T15:15:09Z

solr/core/src/test/org/apache/solr/handler/admin/TestCollectionAPIs.java

@@ -163,16 +163,32 @@ public List<CommandOperation> getCommands(boolean validateInput) {
          public Map<String, String> getPathTemplateValues() {
            return parts;
          }
-
-          @Override
-          public String getHttpMethod() {
-            return method.toString();
-          }
        };
    api.call(req, rsp);


This test request no longer overrides getHttpMethod() and also doesn't populate req.getContext().put("httpMethod", ...). Since SolrQueryRequest#getHttpMethod()'s default implementation reads and casts the httpMethod context entry, BaseHandlerApiSupport will hit an NPE when it calls req.getHttpMethod(). Set req.getContext().put("httpMethod", method) (where method is the SolrRequest.METHOD enum) or add back a getHttpMethod() override.

Copilot · 2026-02-04T15:15:09Z

solr/core/src/test/org/apache/solr/handler/admin/TestCollectionAPIs.java

+  private SolrQueryRequestBase createTestRequest(
+      SolrParams params,
+      Map<String, String> pathTemplateValues,
+      String httpMethod,
+      String requestBody,
+      Api api) {
+    return new SolrQueryRequestBase(null, params) {
+      @Override
+      public List<CommandOperation> getCommands(boolean validateInput) {
+        if (requestBody == null) return Collections.emptyList();
+        return ApiBag.getCommandOperations(
+            new ContentStreamBase.StringStream(requestBody), api.getCommandSchema(), true);
+      }
+
+      @Override
+      public Map<String, String> getPathTemplateValues() {
+        return pathTemplateValues;
+      }
+    };
+  }


createTestRequest(...) is unused, and it has an unused parameter (httpMethod). Either remove this helper entirely or refactor makeCall(...) to use it (and ensure it sets the request context/overrides needed for getHttpMethod() as well).

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

epugh added 4 commits February 4, 2026 05:21

Convert abstract SolrQueryResposneBase into regular class that can be…

dcd5737

… used This lets us replace LocalSolrQueryRequest

Mass conversion of LSQR to SQRB

87246ba

Remove LocalSolrQueryRequest

41c25c6

Trival class can be removed now that SolrQueryRequestBase isn't abstract

f638d50

github-actions bot added test-framework client:solrj module:extraction module:ltr tests cat:search cat:cloud cat:index cat:schema module:clustering cat:security module:scripting labels Feb 4, 2026

epugh requested a review from dsmiley February 4, 2026 10:40

epugh added 2 commits February 4, 2026 06:03

Need fewer anonymous inner classes than we thought!

9010feb

lint

7ffe95f

epugh commented Feb 4, 2026

View reviewed changes

epugh added 3 commits February 4, 2026 06:40

typos

a924781

Small code style fixes.

a39810e

Reviewing code again, make LocalPrincipal a record.

7060092

epugh changed the title ~~SOLR-18038: Remove deprecated LocalSolrQueryRequest and just us SolrQueryRequestBase~~ SOLR-18038: Remove deprecated LocalSolrQueryRequest and use SolrQueryRequestBase Feb 4, 2026

epugh added 2 commits February 4, 2026 07:16

Eliminate makeParams where possible, and relocate method to TestHarness

55ca435

lint

4e63c05

github-actions bot added the cat:api label Feb 4, 2026

epugh added 2 commits February 4, 2026 09:27

Merge remote-tracking branch 'upstream/main' into SOLR-18038-v2

df7c02d

sync with latest code

05b3448

epugh requested review from Copilot and risdenk February 4, 2026 15:04

Copilot started reviewing on behalf of epugh February 4, 2026 15:04 View session

add changelog

969501f

Copilot AI reviewed Feb 4, 2026

View reviewed changes

epugh and others added 4 commits February 4, 2026 10:23

More updates needed

b79135f

Update solr/core/src/test/org/apache/solr/BasicFunctionalityTest.java

7c68219

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

remove unused code

89260a5

Merge branch 'SOLR-18038-v2' of github.com:epugh/solr into SOLR-18038-v2

a521afd

Conversation

epugh commented Feb 4, 2026

Description

Solution

Tests

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant