SOLR-17600 (Part 1/4): Migrate V2 API Payloads from MapSerializable by isaric · Pull Request #4463 · apache/solr

isaric · 2026-05-25T13:20:54Z

This is Part 1 of 4 to deprecate and remove the MapSerializable interface as part of SOLR-17600.

This PR migrates all V2 API payload and handler classes to use MapWriter / Utils.convertToMap.

Note: The work has been split into 4 PRs to make reviewing easier. The subsequent PRs are stacked on top of this one.

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Refactors multiple Solr handlers/tests to standardize conversion of Solr/MapWriter-style objects into map-like structures (favoring Utils.convertToMap(...) / SimpleOrderedMap) and updates one internal API adapter to a MapWriter#writeMap(...) implementation.

Changes:

Replaced a number of toMap(new HashMap<>()) call sites with Utils.convertToMap(...) or new SimpleOrderedMap<>(...).
Updated config/response building code paths to use MapWriter / SimpleOrderedMap rather than MapSerializable.
Adjusted BaseHandlerApiSupport parameter adapter to implement writeMap(...) and skip null-valued entries.

Reviewed changes

Copilot reviewed 23 out of 23 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
solr/core/src/test/org/apache/solr/handler/designer/TestSchemaDesignerAPI.java	Updates test param map construction to use `SimpleOrderedMap`.
solr/core/src/java/org/apache/solr/handler/export/ExportWriterStream.java	Uses `SimpleOrderedMap` when materializing `MapWriter` values.
solr/core/src/java/org/apache/solr/handler/designer/ManagedSchemaDiff.java	Uses `Utils.convertToMap` for diff map materialization.
solr/core/src/java/org/apache/solr/handler/admin/api/SplitShardAPI.java	Uses `Utils.convertToMap` for v2 payload → v1 params.
solr/core/src/java/org/apache/solr/handler/admin/api/SplitCoreAPI.java	Uses `Utils.convertToMap` for v2 payload → v1 params.
solr/core/src/java/org/apache/solr/handler/admin/api/RequestSyncShardAPI.java	Uses `Utils.convertToMap` for v2 payload → v1 params.
solr/core/src/java/org/apache/solr/handler/admin/api/RequestCoreRecoveryAPI.java	Uses `Utils.convertToMap` for v2 payload → v1 params.
solr/core/src/java/org/apache/solr/handler/admin/api/RequestBufferUpdatesAPI.java	Uses `Utils.convertToMap` for v2 payload → v1 params.
solr/core/src/java/org/apache/solr/handler/admin/api/RequestApplyCoreUpdatesAPI.java	Uses `Utils.convertToMap` for v2 payload → v1 params.
solr/core/src/java/org/apache/solr/handler/admin/api/RejoinLeaderElectionAPI.java	Uses `Utils.convertToMap` for v2 payload → v1 params.
solr/core/src/java/org/apache/solr/handler/admin/api/RebalanceLeadersAPI.java	Uses `Utils.convertToMap` for v2 payload → v1 params.
solr/core/src/java/org/apache/solr/handler/admin/api/PrepareCoreRecoveryAPI.java	Uses `Utils.convertToMap` for v2 payload → v1 params.
solr/core/src/java/org/apache/solr/handler/admin/api/OverseerOperationAPI.java	Builds v1 params using `SimpleOrderedMap` instead of `toMap(HashMap)`.
solr/core/src/java/org/apache/solr/handler/admin/api/MoveReplicaAPI.java	Uses `Utils.convertToMap` for v2 payload → v1 params.
solr/core/src/java/org/apache/solr/handler/admin/api/ModifyCollectionAPI.java	Uses `Utils.convertToMap` for v2 payload → v1 params.
solr/core/src/java/org/apache/solr/handler/admin/api/MigrateDocsAPI.java	Uses `Utils.convertToMap` for v2 payload → v1 params.
solr/core/src/java/org/apache/solr/handler/admin/api/InstallShardData.java	Uses `Utils.convertToMap` before creating `ZkNodeProps`.
solr/core/src/java/org/apache/solr/handler/admin/api/CreateCore.java	Uses `Utils.convertToMap` to derive request body from v1 params.
solr/core/src/java/org/apache/solr/handler/admin/ZookeeperInfoHandler.java	Uses `Utils.convertToMap` for `DocCollection` serialization.
solr/core/src/java/org/apache/solr/handler/admin/IndexSizeEstimator.java	Uses `SimpleOrderedMap` when converting `MapWriter` results.
solr/core/src/java/org/apache/solr/handler/admin/BaseHandlerApiSupport.java	Switches adapter from `toMap(...)` to `writeMap(...)` and filters nulls.
solr/core/src/java/org/apache/solr/handler/SolrConfigHandler.java	Migrates plugin/config map building to `MapWriter`/`SimpleOrderedMap` and adds helper for component lookup.
solr/core/src/java/org/apache/solr/handler/ClusterAPI.java	Builds role command maps using `SimpleOrderedMap`.

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


    SolrParams solrParams = idFieldMapUpdated.toSolrParams();
-    Map<String, Object> mapParams = solrParams.toMap(new HashMap<>());
+    Map<String, Object> mapParams = new SimpleOrderedMap<>(solrParams);


dsmiley · 2026-05-27T18:24:47Z

  public void joinOverseerLeaderElection(PayloadObj<OverseerOperationPayload> payload)
      throws Exception {
-    final Map<String, Object> v1Params = payload.get().toMap(new HashMap<>());
+    final Map<String, Object> v1Params = new SimpleOrderedMap<>(payload.get());


Lets standardize on use of Utils.convertToMap in these places (classes with suffix API... on the request dispatch code-path)

dsmiley · 2026-05-27T18:45:48Z

+        Map<String, Object> map = new SimpleOrderedMap<>(queue);
        entry.setValue(map);
      } else if (value instanceof MapWriterSummaryStatistics stats) {
-        Map<String, Object> map = new LinkedHashMap<>();
-        stats.toMap(map);
+        Map<String, Object> map = new SimpleOrderedMap<>(stats);


SOM is good here; this is a response-structure

dsmiley · 2026-05-27T18:52:20Z

            m.put(ZNODEVER, params.getZnodeVersion());
            if (p != null) {
-              m.put(RequestParams.NAME, Map.of(parts.get(2), p.toMap(new LinkedHashMap<>())));
+              m.put(RequestParams.NAME, Map.of(parts.get(2), new SimpleOrderedMap<>(p)));


SOM makes sense as it's a response structure here

dsmiley · 2026-05-27T19:01:41Z

-                    o instanceof MapSerializable
-                        ? ((MapSerializable) o).toMap(new LinkedHashMap<>())
+                    o instanceof MapWriter
+                        ? new SimpleOrderedMap<>((MapWriter) o)


SOM is okay for response

      String componentName = componentType == null ? null : req.getParams().get("componentName");
      boolean showParams = req.getParams().getBool("expandParams", false);
-      Map<String, Object> map = this.req.getCore().getSolrConfig().toMap(new LinkedHashMap<>());
+      Map<String, Object> map = new SimpleOrderedMap<>(this.req.getCore().getSolrConfig());


        pluginInfo = (Map) plugin;
      } else if (plugin instanceof PluginInfo) {
-        pluginInfo = ((PluginInfo) plugin).toMap(new LinkedHashMap<>());
+        pluginInfo = new SimpleOrderedMap<>((PluginInfo) plugin);


+      return pluginInfo.containsKey("class")
+          ? pluginInfo
+          : (Map<String, Object>) pluginInfo.getOrDefault(componentName, new HashMap<>());


dsmiley

Thanks for resuming this effort!

dsmiley · 2026-05-27T18:24:47Z

  public void joinOverseerLeaderElection(PayloadObj<OverseerOperationPayload> payload)
      throws Exception {
-    final Map<String, Object> v1Params = payload.get().toMap(new HashMap<>());
+    final Map<String, Object> v1Params = new SimpleOrderedMap<>(payload.get());


Lets standardize on use of Utils.convertToMap in these places (classes with suffix API... on the request dispatch code-path)

dsmiley · 2026-05-27T18:38:54Z

+              if (o == null) {
+                ew.put(param, null);
+                continue;
+              }


can we skip putting 'null'? Curious, what test or issue brought this change about?

dsmiley · 2026-05-27T18:45:48Z

+        Map<String, Object> map = new SimpleOrderedMap<>(queue);
        entry.setValue(map);
      } else if (value instanceof MapWriterSummaryStatistics stats) {
-        Map<String, Object> map = new LinkedHashMap<>();
-        stats.toMap(map);
+        Map<String, Object> map = new SimpleOrderedMap<>(stats);


SOM is good here; this is a response-structure

dsmiley · 2026-05-27T18:52:20Z

            m.put(ZNODEVER, params.getZnodeVersion());
            if (p != null) {
-              m.put(RequestParams.NAME, Map.of(parts.get(2), p.toMap(new LinkedHashMap<>())));
+              m.put(RequestParams.NAME, Map.of(parts.get(2), new SimpleOrderedMap<>(p)));


SOM makes sense as it's a response structure here

dsmiley · 2026-05-27T19:01:41Z

-                    o instanceof MapSerializable
-                        ? ((MapSerializable) o).toMap(new LinkedHashMap<>())
+                    o instanceof MapWriter
+                        ? new SimpleOrderedMap<>((MapWriter) o)


SOM is okay for response

Copilot AI review requested due to automatic review settings May 25, 2026 13:20

github-actions Bot added the tests label May 25, 2026

This was referenced May 25, 2026

SOLR-17600 (Part 2/4): Migrate Core Configuration classes from MapSerializable #4464

Open

SOLR-17600 (Part 3/4): Migrate SolrJ and Utilities from MapSerializable #4465

Open

SOLR-17600 (Part 4/4): Delete MapSerializable interface #4466

Open

Copilot AI reviewed May 25, 2026

View reviewed changes

isaric force-pushed the SOLR-17600-1-v2-api branch from de2593f to baae128 Compare May 25, 2026 13:36

SOLR-17600 (Part 1/4): Migrate V2 API Payloads from MapSerializable

74d671e

isaric force-pushed the SOLR-17600-1-v2-api branch from baae128 to 74d671e Compare May 26, 2026 05:55

dsmiley reviewed May 27, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SOLR-17600 (Part 1/4): Migrate V2 API Payloads from MapSerializable#4463

SOLR-17600 (Part 1/4): Migrate V2 API Payloads from MapSerializable#4463
isaric wants to merge 1 commit into
apache:mainfrom
isaric:SOLR-17600-1-v2-api

isaric commented May 25, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

dsmiley May 27, 2026

Uh oh!

dsmiley May 27, 2026

Uh oh!

dsmiley May 27, 2026

Uh oh!

dsmiley May 27, 2026

Uh oh!

dsmiley left a comment

Uh oh!

dsmiley May 27, 2026

Uh oh!

dsmiley May 27, 2026

Uh oh!

dsmiley May 27, 2026

Uh oh!

dsmiley May 27, 2026

Uh oh!

dsmiley May 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

isaric commented May 25, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

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!

dsmiley left a comment

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants