SOLR-17625: NamedList.findRecursive -> _get (#3355)

Replaced NamedList.findRecursive usages with _get, which can do Map traversal, and
  thus makes it easier to transition intermediate NamedLists to Maps.

Author: wildtusker

solr/CHANGES.txt

@@ -342,6 +342,9 @@ Other Changes
 
 * SOLR-17651: Add System.exit() in forbidden APIs, and make sure CLI unit tests never call it. (Pierre Salagnac)
 
+* SOLR-17625: Replaced NamedList.findRecursive usages with _get, which can do Map traversal, and
+  thus makes it easier to transition intermediate NamedLists to Maps. (Gaurav Tuli)
+
 ==================  9.8.1 ==================
 Bug Fixes
 ---------------------

solr/core/src/java/org/apache/solr/cli/AssertTool.java

@@ -21,6 +21,7 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.attribute.FileOwnerAttributeView;
+import java.util.List;
 import java.util.concurrent.TimeUnit;
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.Option;
@@ -280,7 +281,7 @@ public int assertSolrNotRunning(String url, String credentials) throws Exception
         System.nanoTime() + TimeUnit.NANOSECONDS.convert(timeoutMs, TimeUnit.MILLISECONDS);
     try (SolrClient solrClient = CLIUtils.getSolrClient(url, credentials)) {
       NamedList<Object> response = solrClient.request(new HealthCheckRequest());
-      Integer statusCode = (Integer) response.findRecursive("responseHeader", "status");
+      Integer statusCode = (Integer) response._get(List.of("responseHeader", "status"), null);
       CLIUtils.checkCodeForAuthError(statusCode);
     } catch (IOException | SolrServerException e) {
       log.debug("Opening connection to {} failed, Solr does not seem to be running", url, e);

solr/core/src/java/org/apache/solr/cli/ConfigTool.java

@@ -18,6 +18,7 @@
 package org.apache.solr.cli;
 
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.MissingArgumentException;
@@ -124,7 +125,7 @@ public void runImpl(CommandLine cli) throws Exception {
     try (SolrClient solrClient =
         CLIUtils.getSolrClient(solrUrl, cli.getOptionValue(CommonCLIOptions.CREDENTIALS_OPTION))) {
       NamedList<Object> result = SolrCLI.postJsonToSolr(solrClient, updatePath, jsonBody);
-      Integer statusCode = (Integer) result.findRecursive("responseHeader", "status");
+      Integer statusCode = (Integer) result._get(List.of("responseHeader", "status"), null);
       if (statusCode == 0) {
         if (value != null) {
           echo("Successfully " + action + " " + property + " to " + value);

solr/core/src/java/org/apache/solr/cli/HealthcheckTool.java

@@ -173,9 +173,10 @@ protected void runCloudTool(CloudSolrClient cloudSolrClient, CommandLine cli) th
                   solrClient.request(
                       new GenericSolrRequest(
                           SolrRequest.METHOD.GET, CommonParams.SYSTEM_INFO_PATH));
-              uptime = SolrCLI.uptime((Long) systemInfo.findRecursive("jvm", "jmx", "upTimeMS"));
-              String usedMemory = (String) systemInfo.findRecursive("jvm", "memory", "used");
-              String totalMemory = (String) systemInfo.findRecursive("jvm", "memory", "total");
+              uptime =
+                  SolrCLI.uptime((Long) systemInfo._get(List.of("jvm", "jmx", "upTimeMS"), null));
+              String usedMemory = systemInfo._getStr(List.of("jvm", "memory", "used"), null);
+              String totalMemory = systemInfo._getStr(List.of("jvm", "memory", "total"), null);
               memory = usedMemory + " of " + totalMemory;
             }
 

solr/core/src/java/org/apache/solr/cli/StatusTool.java

@@ -314,12 +314,12 @@ public static Map<String, Object> reportStatus(NamedList<Object> info, SolrClien
 
     String solrHome = (String) info.get("solr_home");
     status.put("solr_home", solrHome != null ? solrHome : "?");
-    status.put("version", info.findRecursive("lucene", "solr-impl-version"));
-    status.put("startTime", info.findRecursive("jvm", "jmx", "startTime").toString());
-    status.put("uptime", SolrCLI.uptime((Long) info.findRecursive("jvm", "jmx", "upTimeMS")));
+    status.put("version", info._getStr(List.of("lucene", "solr-impl-version"), null));
+    status.put("startTime", info._getStr(List.of("jvm", "jmx", "startTime"), null));
+    status.put("uptime", SolrCLI.uptime((Long) info._get(List.of("jvm", "jmx", "upTimeMS"), null)));
 
-    String usedMemory = (String) info.findRecursive("jvm", "memory", "used");
-    String totalMemory = (String) info.findRecursive("jvm", "memory", "total");
+    String usedMemory = info._getStr(List.of("jvm", "memory", "used"), null);
+    String totalMemory = info._getStr(List.of("jvm", "memory", "total"), null);
     status.put("memory", usedMemory + " of " + totalMemory);
 
     // if this is a Solr in solrcloud mode, gather some basic cluster info
@@ -344,11 +344,11 @@ private static Map<String, String> getCloudStatus(SolrClient solrClient, String
     // TODO add booleans to request just what we want; not everything
     NamedList<Object> json = solrClient.request(new CollectionAdminRequest.ClusterStatus());
 
-    List<String> liveNodes = (List<String>) json.findRecursive("cluster", "live_nodes");
+    List<String> liveNodes = (List<String>) json._get(List.of("cluster", "live_nodes"), null);
     cloudStatus.put("liveNodes", String.valueOf(liveNodes.size()));
 
     // TODO get this as a metric from the metrics API instead, or something else.
-    var collections = (Map<String, Object>) json.findRecursive("cluster", "collections");
+    var collections = (Map<String, Object>) json._get(List.of("cluster", "collections"), null);
     cloudStatus.put("collections", String.valueOf(collections.size()));
 
     return cloudStatus;

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

@@ -862,14 +862,15 @@ public static void checkDiskSpace(
                 SolrRequest.METHOD.GET, "/admin/metrics", SolrRequest.SolrRequestType.ADMIN, params)
             .process(cloudManager.getSolrClient());
 
-    Number size = (Number) rsp.getResponse().findRecursive("metrics", indexSizeMetricName);
+    Number size = (Number) rsp.getResponse()._get(List.of("metrics", indexSizeMetricName), null);
     if (size == null) {
       log.warn("cannot verify information for parent shard leader");
       return;
     }
     double indexSize = size.doubleValue();
 
-    Number freeSize = (Number) rsp.getResponse().findRecursive("metrics", freeDiskSpaceMetricName);
+    Number freeSize =
+        (Number) rsp.getResponse()._get(List.of("metrics", freeDiskSpaceMetricName), null);
     if (freeSize == null) {
       log.warn("missing node disk space information for parent shard leader");
       return;

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

@@ -609,15 +609,18 @@ private void processComponents(
                           if (resp == null) {
                             return false;
                           }
-                          Object recursive = resp.findRecursive("responseHeader", "partialResults");
+                          Object recursive =
+                              resp._get(List.of("responseHeader", "partialResults"), null);
                           if (recursive != null) {
                             Object message =
                                 "[Shard:"
                                     + response.getShardAddress()
                                     + "]"
-                                    + resp.findRecursive(
-                                        "responseHeader",
-                                        RESPONSE_HEADER_PARTIAL_RESULTS_DETAILS_KEY);
+                                    + resp._get(
+                                        List.of(
+                                            "responseHeader",
+                                            RESPONSE_HEADER_PARTIAL_RESULTS_DETAILS_KEY),
+                                        null);
                             detailMesg.compareAndSet(null, message); // first one, ingore rest
                           }
                           return recursive != null;

solr/core/src/java/org/apache/solr/packagemanager/PackageManager.java

@@ -284,7 +284,7 @@ public Map<String, SolrPackageInstance> getPackagesDeployedAsClusterLevelPlugins
       NamedList<Object> response =
           solrClient.request(
               new GenericV2SolrRequest(SolrRequest.METHOD.GET, PackageUtils.CLUSTERPROPS_PATH));
-      Integer statusCode = (Integer) response.findRecursive("responseHeader", "status");
+      Integer statusCode = (Integer) response._get(List.of("responseHeader", "status"), null);
       if (statusCode == null || statusCode == ErrorCode.NOT_FOUND.code) {
         // Cluster props doesn't exist, that means there are no cluster level plugins installed.
         result = Collections.emptyMap();

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

@@ -287,8 +287,8 @@ public void testCloudInfoInCoreStatus() throws IOException, SolrServerException
 
     cluster.waitForActiveCollection(collectionName, 2, 4);
 
-    String nodeName = (String) response._get("success[0]/key", null);
-    String corename = (String) response._get(asList("success", nodeName, "core"), null);
+    String nodeName = response._getStr("success[0]/key", null);
+    String corename = response._getStr(asList("success", nodeName, "core"), null);
 
     try (SolrClient coreClient =
         getHttpSolrClient(cluster.getZkStateReader().getBaseUrlForNodeName(nodeName))) {
@@ -620,19 +620,23 @@ public void testColStatus() throws Exception {
     CollectionAdminResponse rsp = req.process(cluster.getSolrClient());
     assertEquals(0, rsp.getStatus());
     assertNotNull(rsp.getResponse().get(collectionName));
-    assertNotNull(rsp.getResponse().findRecursive(collectionName, "properties"));
+    assertNotNull(rsp.getResponse()._get(List.of(collectionName, "properties"), null));
     final var collPropMap =
-        (Map<String, Object>) rsp.getResponse().findRecursive(collectionName, "properties");
+        (Map<String, Object>) rsp.getResponse()._get(List.of(collectionName, "properties"), null);
     assertEquals("conf2", collPropMap.get("configName"));
     assertEquals(2L, collPropMap.get("nrtReplicas"));
     assertEquals("0", collPropMap.get("tlogReplicas"));
     assertEquals("0", collPropMap.get("pullReplicas"));
     assertEquals(
-        2, ((NamedList<Object>) rsp.getResponse().findRecursive(collectionName, "shards")).size());
-    assertNotNull(rsp.getResponse().findRecursive(collectionName, "shards", "shard1", "leader"));
+        2,
+        ((NamedList<Object>) rsp.getResponse()._get(List.of(collectionName, "shards"), null))
+            .size());
+    assertNotNull(
+        rsp.getResponse()._get(List.of(collectionName, "shards", "shard1", "leader"), null));
     // Ensure more advanced info is not returned
     assertNull(
-        rsp.getResponse().findRecursive(collectionName, "shards", "shard1", "leader", "segInfos"));
+        rsp.getResponse()
+            ._get(List.of(collectionName, "shards", "shard1", "leader", "segInfos"), null));
 
     // Returns segment metadata iff requested
     req = CollectionAdminRequest.collectionStatus(collectionName);
@@ -689,7 +693,7 @@ public void testColStatus() throws Exception {
     assertEquals(0, rsp.getStatus());
     @SuppressWarnings({"unchecked"})
     List<Object> nonCompliant =
-        (List<Object>) rsp.getResponse().findRecursive(collectionName, "schemaNonCompliant");
+        (List<Object>) rsp.getResponse()._get(List.of(collectionName, "schemaNonCompliant"), null);
     assertEquals(nonCompliant.toString(), 1, nonCompliant.size());
     assertTrue(nonCompliant.toString(), nonCompliant.contains("(NONE)"));
     @SuppressWarnings({"unchecked"})

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

@@ -319,7 +319,7 @@ public void testAddDocs() throws Exception {
               "Replicas shouldn't process the add document request: " + statsResponse,
               ((Map<String, Object>)
                       (statsResponse.getResponse())
-                          .findRecursive("plugins", "UPDATE", "updateHandler", "stats"))
+                          ._get(List.of("plugins", "UPDATE", "updateHandler", "stats"), null))
                   .get("UPDATE.updateHandler.adds"));
         }
       }