Apache Solr open-source search software
SOLR-17705: V2 API response type improvements (#3282)
David Smiley6d84e8f97611
diff --git a/solr/CHANGES.txt b/solr/CHANGES.txtindex 4686b33af11..a471e3c872e 100644--- a/solr/CHANGES.txt+++ b/solr/CHANGES.txt@@ -41,7 +41,9 @@ Improvements* SOLR-17701: Simplify bin/solr scripts by removing AUTH_PORT export in favour of more commonly used SOLR_PORT export. (Eric Pugh)-* SOLR-17705: SolrJ's SolrRequest now allows any type for its response; needn't be SolrResponse. (David Smiley)+* SOLR-17705: SolrJ's SolrRequest now allows any type for its response; needn't be SolrResponse.+ Simplified the V2 API to remove the needless SolrResponse. And moved JSON/Jackson binding into+ a new JacksonDataBindResponseParser (David Smiley)Optimizations---------------------@@ -203,7 +205,7 @@ New FeaturesImprovements----------------------* SOLR-15751: The v2 API now has parity with the v1 "COLSTATUS" and "segments" APIs, which can be used to fetch detailed information about+* SOLR-15751: The v2 API now has parity with the v1 "COLSTATUS" and "segments" APIs, which can be used to fetch detailed information aboutspecific collections or cores. Collection information can be fetched by a call to `GET /api/collections/collectionName`, and coreinformation with a call to `GET /api/cores/coreName/segments`. (Jason Gerlowski)@@ -265,7 +267,7 @@ Dependency UpgradesOther Changes----------------------* SOLR-17579: Remove unused code and other refactorings in ReplicationHandler and tests. Removed unused public+* SOLR-17579: Remove unused code and other refactorings in ReplicationHandler and tests. Removed unused publicLOCAL_ACTIVITY_DURING_REPLICATION variable. (Eric Pugh)* GITHUB#2869: SolrTestCase now supports @LogLevel annotations (as SolrTestCaseJ4 has). Added LogLevelTestRulediff --git a/solr/core/src/java/org/apache/solr/cli/CLIUtils.java b/solr/core/src/java/org/apache/solr/cli/CLIUtils.javaindex 0f9f8641ac5..7bde598f1d2 100644--- a/solr/core/src/java/org/apache/solr/cli/CLIUtils.java+++ b/solr/core/src/java/org/apache/solr/cli/CLIUtils.java@@ -320,7 +320,7 @@ public final class CLIUtils {Thread.sleep(clamPeriodForStatusPollMs);}final var coreStatusReq = new CoresApi.GetCoreStatus(coreName);- final var coreStatusRsp = coreStatusReq.process(solrClient).getParsed();+ final var coreStatusRsp = coreStatusReq.process(solrClient);final var coreStatusByName = coreStatusRsp.status;final var coreStatus = coreStatusByName.get(coreName);final var failureStatus = coreStatusRsp.initFailures;diff --git a/solr/core/src/java/org/apache/solr/filestore/DistribFileStore.java b/solr/core/src/java/org/apache/solr/filestore/DistribFileStore.javaindex 96b81992d4c..0e654491832 100644--- a/solr/core/src/java/org/apache/solr/filestore/DistribFileStore.java+++ b/solr/core/src/java/org/apache/solr/filestore/DistribFileStore.java@@ -239,7 +239,7 @@ public class DistribFileStore implements FileStore {coreContainer.getZkController().getZkStateReader().getBaseUrlV2ForNodeName(liveNode);final var metadataRequest = new FileStoreApi.GetMetadata(path);final var client = coreContainer.getSolrClientCache().getHttpSolrClient(baseUrl);- final var metadataResponse = metadataRequest.process(client).getParsed();+ final var metadataResponse = metadataRequest.process(client);boolean nodeHasBlob =metadataResponse.files != null && metadataResponse.files.containsKey(path);@@ -387,7 +387,7 @@ public class DistribFileStore implements FileStore {pullFileRequest.setGetFrom(nodeToFetchFrom);final var client = coreContainer.getSolrClientCache().getHttpSolrClient(baseUrl);// fire and forget- pullFileRequest.process(client).getParsed();+ pullFileRequest.process(client);} catch (Exception e) {log.info("Node: {} failed to respond for file fetch notification", node, e);// ignore the exceptiondiff --git a/solr/core/src/java/org/apache/solr/packagemanager/PackageUtils.java b/solr/core/src/java/org/apache/solr/packagemanager/PackageUtils.javaindex b0bb80cef42..4e3aaa5ab71 100644--- a/solr/core/src/java/org/apache/solr/packagemanager/PackageUtils.java+++ b/solr/core/src/java/org/apache/solr/packagemanager/PackageUtils.java@@ -35,6 +35,7 @@ import java.util.zip.ZipFile;import org.apache.commons.io.IOUtils;import org.apache.lucene.util.SuppressForbidden;import org.apache.solr.cli.CLIUtils;+import org.apache.solr.client.api.model.UploadToFileStoreResponse;import org.apache.solr.client.solrj.SolrClient;import org.apache.solr.client.solrj.SolrRequest;import org.apache.solr.client.solrj.SolrServerException;@@ -96,7 +97,7 @@ public class PackageUtils {uploadReq.setSig(List.of(sig));}- final var uploadRsp = uploadReq.process(client).getParsed();+ final UploadToFileStoreResponse uploadRsp = uploadReq.process(client);if (!name.equals(uploadRsp.file)) {throw new SolrException(ErrorCode.BAD_REQUEST,diff --git a/solr/core/src/java/org/apache/solr/packagemanager/RepositoryManager.java b/solr/core/src/java/org/apache/solr/packagemanager/RepositoryManager.javaindex fb8c03c7d0b..b56d6441709 100644--- a/solr/core/src/java/org/apache/solr/packagemanager/RepositoryManager.java+++ b/solr/core/src/java/org/apache/solr/packagemanager/RepositoryManager.java@@ -151,7 +151,7 @@ public class RepositoryManager {String path = ClusterFileStore.KEYS_DIR + "/" + destinationKeyFilename;PackageUtils.uploadKey(key, path, Path.of(solrHome));final var syncRequest = new FileStoreApi.SyncFile(path);- final var syncResponse = syncRequest.process(solrClient).getParsed();+ final var syncResponse = syncRequest.process(solrClient);final var status = syncResponse.responseHeader.status;if (status != 0) {throw new SolrException(diff --git a/solr/core/src/test/org/apache/solr/cloud/CollectionsAPISolrJTest.java b/solr/core/src/test/org/apache/solr/cloud/CollectionsAPISolrJTest.javaindex 0742bf85115..6ce8503323d 100644--- a/solr/core/src/test/org/apache/solr/cloud/CollectionsAPISolrJTest.java+++ b/solr/core/src/test/org/apache/solr/cloud/CollectionsAPISolrJTest.java@@ -797,9 +797,7 @@ public class CollectionsAPISolrJTest extends SolrCloudTestCase {indexSomeDocs(simpleCollName);final var simpleResponse =- new CollectionsApi.GetCollectionStatus(simpleCollName)- .process(cluster.getSolrClient())- .getParsed();+ new CollectionsApi.GetCollectionStatus(simpleCollName).process(cluster.getSolrClient());assertEquals(simpleCollName, simpleResponse.name);assertEquals(2, simpleResponse.shards.size());assertEquals(Integer.valueOf(2), simpleResponse.activeShards);@@ -814,7 +812,7 @@ public class CollectionsAPISolrJTest extends SolrCloudTestCase {// Ensure segment data present when request sets 'segments=true' flagfinal var segmentDataRequest = new CollectionsApi.GetCollectionStatus(simpleCollName);segmentDataRequest.setSegments(true);- final var segmentDataResponse = segmentDataRequest.process(cluster.getSolrClient()).getParsed();+ final var segmentDataResponse = segmentDataRequest.process(cluster.getSolrClient());var segmentData = segmentDataResponse.shards.get("shard1").leader.segInfos;assertNotNull(segmentData);assertTrue(segmentData.info.numSegments > 0); // Expect at least one segment@@ -827,8 +825,7 @@ public class CollectionsAPISolrJTest extends SolrCloudTestCase {// Ensure file-size data present when request sets sizeInfo flagfinal var segmentFileSizeRequest = new CollectionsApi.GetCollectionStatus(simpleCollName);segmentFileSizeRequest.setSizeInfo(true);- final var segmentFileSizeResponse =- segmentFileSizeRequest.process(cluster.getSolrClient()).getParsed();+ final var segmentFileSizeResponse = segmentFileSizeRequest.process(cluster.getSolrClient());segmentData = segmentFileSizeResponse.shards.get("shard1").leader.segInfos;assertNotNull(segmentData);final var largeFileList = segmentData.segments.get("_0").largestFilesByName;diff --git a/solr/core/src/test/org/apache/solr/filestore/TestDistribFileStore.java b/solr/core/src/test/org/apache/solr/filestore/TestDistribFileStore.javaindex 49a77b9a02e..bff833f8c54 100644--- a/solr/core/src/test/org/apache/solr/filestore/TestDistribFileStore.java+++ b/solr/core/src/test/org/apache/solr/filestore/TestDistribFileStore.java@@ -324,7 +324,7 @@ public class TestDistribFileStore extends SolrCloudTestCase {final var syncReq = new FileStoreApi.SyncFile(path);final var syncRsp = syncReq.process(client);if (log.isInfoEnabled()) {- log.info("sync resp for path {} was {}", path, syncRsp.getParsed().responseHeader.status);+ log.info("sync resp for path {} was {}", path, syncRsp.responseHeader.status);}}checkAllNodesForFile(diff --git a/solr/core/src/test/org/apache/solr/handler/TestReplicationHandler.java b/solr/core/src/test/org/apache/solr/handler/TestReplicationHandler.javaindex 1a1d0ac3265..ad8bdcc792f 100644--- a/solr/core/src/test/org/apache/solr/handler/TestReplicationHandler.java+++ b/solr/core/src/test/org/apache/solr/handler/TestReplicationHandler.java@@ -1669,7 +1669,7 @@ public class TestReplicationHandler extends SolrTestCaseJ4 {final var statusRequest = new CoresApi.GetCoreStatus("collection1");while (timeSlept < TIMEOUT) {try {- final var statusResponse = statusRequest.process(adminClient).getParsed();+ final var statusResponse = statusRequest.process(adminClient);assertNotNull(statusResponse.status);assertTrue(statusResponse.status.containsKey("collection1"));final var coreStatus = statusResponse.status.get("collection1");diff --git a/solr/core/src/test/org/apache/solr/handler/admin/ZookeeperReadAPITest.java b/solr/core/src/test/org/apache/solr/handler/admin/ZookeeperReadAPITest.javaindex 41eddba832e..31609dc8318 100644--- a/solr/core/src/test/org/apache/solr/handler/admin/ZookeeperReadAPITest.java+++ b/solr/core/src/test/org/apache/solr/handler/admin/ZookeeperReadAPITest.java@@ -76,8 +76,7 @@ public class ZookeeperReadAPITest extends SolrCloudTestCase {}final var configListRequest = new ZookeeperReadApi.ListNodes("/configs");- final var configListResponse = configListRequest.process(client).getParsed();-+ final var configListResponse = configListRequest.process(client);assertEquals(6, configListResponse.unknownProperties().get("/configs").get("_default").children);assertEquals(2, configListResponse.unknownProperties().get("/configs").get("conf").children);@@ -133,7 +132,7 @@ public class ZookeeperReadAPITest extends SolrCloudTestCase {public void testCanListChildNodes() throws Exception {try (HttpSolrClient client = new HttpSolrClient.Builder(baseUrl.toString()).build()) {final var listDefaultFilesReq = new ZookeeperReadApi.ListNodes("/configs/_default");- final var listDefaultFilesResponse = listDefaultFilesReq.process(client).getParsed();+ final var listDefaultFilesResponse = listDefaultFilesReq.process(client);// At the top level, the response contains a key with the value of the specified zkPathassertEquals(1, listDefaultFilesResponse.unknownProperties().size());diff --git a/solr/solrj/src/java/org/apache/solr/client/solrj/JacksonDataBindResponseParser.java b/solr/solrj/src/java/org/apache/solr/client/solrj/JacksonDataBindResponseParser.javanew file mode 100644index 00000000000..5ea1ed2e287--- /dev/null+++ b/solr/solrj/src/java/org/apache/solr/client/solrj/JacksonDataBindResponseParser.java@@ -0,0 +1,69 @@+/*+ * Licensed to the Apache Software Foundation (ASF) under one or more+ * contributor license agreements. See the NOTICE file distributed with+ * this work for additional information regarding copyright ownership.+ * The ASF licenses this file to You under the Apache License, Version 2.0+ * (the "License"); you may not use this file except in compliance with+ * the License. You may obtain a copy of the License at+ *+ * http://www.apache.org/licenses/LICENSE-2.0+ *+ * Unless required by applicable law or agreed to in writing, software+ * distributed under the License is distributed on an "AS IS" BASIS,+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+ * See the License for the specific language governing permissions and+ * limitations under the License.+ */++package org.apache.solr.client.solrj;++import java.io.IOException;+import java.io.InputStream;+import java.io.InputStreamReader;+import java.util.Collection;+import java.util.List;+import org.apache.solr.common.util.NamedList;+import org.apache.solr.common.util.SimpleOrderedMap;++/**+ * Parses JSON, deserializing to a domain type (class) via Jackson data-bind.+ *+ * @lucene.experimental+ */+public class JacksonDataBindResponseParser<T> extends ResponseParser {++ private final Class<T> typeParam;++ public JacksonDataBindResponseParser(Class<T> typeParam) {+ this.typeParam = typeParam;+ }++ @Override+ public String getWriterType() {+ return "json";+ }++ @Override+ public Collection<String> getContentTypes() {+ return List.of("application/json");+ }++ // TODO it'd be nice if the ResponseParser could receive the mime type so it can parse+ // accordingly, maybe json, cbor, smile++ @Override+ public NamedList<Object> processResponse(InputStream stream, String encoding) throws IOException {+ // TODO SOLR-17549 for error handling, implying a significant ResponseParser API change+ // TODO generalize to CBOR, Smile, ...+ var mapper = JacksonContentWriter.DEFAULT_MAPPER;++ final T parsedVal;+ if (encoding == null) {+ parsedVal = mapper.readValue(stream, typeParam);+ } else {+ parsedVal = mapper.readValue(new InputStreamReader(stream, encoding), typeParam);+ }++ return SimpleOrderedMap.of("response", parsedVal);+ }+}diff --git a/solr/solrj/src/java/org/apache/solr/client/solrj/JacksonParsingResponse.java b/solr/solrj/src/java/org/apache/solr/client/solrj/JacksonParsingResponse.javadeleted file mode 100644index 3e95da59657..00000000000--- a/solr/solrj/src/java/org/apache/solr/client/solrj/JacksonParsingResponse.java+++ /dev/null@@ -1,44 +0,0 @@-/*- * Licensed to the Apache Software Foundation (ASF) under one or more- * contributor license agreements. See the NOTICE file distributed with- * this work for additional information regarding copyright ownership.- * The ASF licenses this file to You under the Apache License, Version 2.0- * (the "License"); you may not use this file except in compliance with- * the License. You may obtain a copy of the License at- *- * http://www.apache.org/licenses/LICENSE-2.0- *- * Unless required by applicable law or agreed to in writing, software- * distributed under the License is distributed on an "AS IS" BASIS,- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.- * See the License for the specific language governing permissions and- * limitations under the License.- */--package org.apache.solr.client.solrj;--import java.io.InputStream;-import org.apache.solr.client.solrj.response.SimpleSolrResponse;-import org.apache.solr.common.util.NamedList;-import org.apache.solr.common.util.ObjectReleaseTracker;--public class JacksonParsingResponse<T> extends SimpleSolrResponse {-- private final Class<T> typeParam;-- public JacksonParsingResponse(Class<T> typeParam) {- this.typeParam = typeParam;- }-- public T getParsed() {- final NamedList<Object> resp = getResponse();- final var stream = (InputStream) resp.get("stream");- try {- final T parsedVal = JacksonContentWriter.DEFAULT_MAPPER.readValue(stream, typeParam);- assert ObjectReleaseTracker.release(stream);- return parsedVal;- } catch (Exception e) {- throw new RuntimeException(e);- }- }-}diff --git a/solr/solrj/src/resources/java-template/api.mustache b/solr/solrj/src/resources/java-template/api.mustacheindex 64cfef3999b..2239f9f9507 100644--- a/solr/solrj/src/resources/java-template/api.mustache+++ b/solr/solrj/src/resources/java-template/api.mustache@@ -28,13 +28,12 @@ import java.util.List;import java.util.Map;import java.util.Set;-+import org.apache.solr.client.solrj.JacksonDataBindResponseParser;import org.apache.solr.client.solrj.SolrClient;import org.apache.solr.client.solrj.SolrRequest;import org.apache.solr.client.solrj.response.SimpleSolrResponse;import org.apache.solr.common.params.SolrParams;import org.apache.solr.common.params.ModifiableSolrParams;-import org.apache.solr.client.solrj.JacksonParsingResponse;import org.apache.solr.client.solrj.JacksonContentWriter;import org.apache.solr.client.solrj.request.RequestWriter.ContentWriter;import org.apache.solr.client.solrj.impl.InputStreamResponseParser;@@ -77,7 +76,7 @@ import {{modelPackage}}.{{dataType}};// changes should be made to the underlying template and not this file directly./**- * Experimental SolrRequest's and SolrResponse's for {{classVarName}}, generated from an OAS.+ * Experimental {@link SolrRequest}s for {{classVarName}}, generated from an OAS.** <p>See individual request and response classes for more detailed and relevant information.*@@ -91,17 +90,13 @@ public class {{classname}} {{{#operation}}{{^vendorExtensions.x-omitFromCodegen}}{{#vendorExtensions.x-rawOutput}}- public static class {{operationIdCamelCase}}Response extends InputStreamResponse {}+ public static class {{operationIdCamelCase}} extends SolrRequest+ <InputStreamResponse> {{{/vendorExtensions.x-rawOutput}}{{^vendorExtensions.x-rawOutput}}- public static class {{operationIdCamelCase}}Response extends JacksonParsingResponse<{{modelPackage}}.{{returnType}}> {- public {{operationIdCamelCase}}Response() {- super({{modelPackage}}.{{returnType}}.class);- }- }+ public static class {{operationIdCamelCase}} extends SolrRequest<{{modelPackage}}+ .{{returnType}}> {{{/vendorExtensions.x-rawOutput}}-- public static class {{operationIdCamelCase}} extends SolrRequest<{{operationIdCamelCase}}Response> {{{#bodyParam}}private final {{{dataType}}} requestBody;{{/bodyParam}}@@ -259,17 +254,31 @@ public class {{classname}} {{{/queryParams}}return queryParams;}+ {{#vendorExtensions.x-rawOutput}}+ @Override+ protected InputStreamResponse createResponse(NamedList+ <Object> namedList) {+ return new InputStreamResponse();+ }@Override- protected {{operationIdCamelCase}}Response createResponse(NamedList- <Object> namedList) {- return new {{operationIdCamelCase}}Response();+ public InputStreamResponseParser getResponseParser() {+ return new InputStreamResponseParser("json");+ }+ {{/vendorExtensions.x-rawOutput}}+ {{^vendorExtensions.x-rawOutput}}+ @Override+ protected {{modelPackage}}.{{returnType}} createResponse(NamedList+ <Object> namedList) {+ return ({{modelPackage}}.{{returnType}}) namedList.get("response");}@Overridepublic ResponseParser getResponseParser() {- return new InputStreamResponseParser("json");+ return new JacksonDataBindResponseParser<>({{modelPackage}}.{{returnType}}.class);}+ {{/vendorExtensions.x-rawOutput}}+}{{/vendorExtensions.x-omitFromCodegen}}{{/operation}}diff --git a/solr/solrj/src/test/org/apache/solr/client/solrj/ApiMustacheTemplateTests.java b/solr/solrj/src/test/org/apache/solr/client/solrj/ApiMustacheTemplateTests.javadeleted file mode 100644index 1dd0c524053..00000000000--- a/solr/solrj/src/test/org/apache/solr/client/solrj/ApiMustacheTemplateTests.java+++ /dev/null@@ -1,81 +0,0 @@-/*- * Licensed to the Apache Software Foundation (ASF) under one or more- * contributor license agreements. See the NOTICE file distributed with- * this work for additional information regarding copyright ownership.- * The ASF licenses this file to You under the Apache License, Version 2.0- * (the "License"); you may not use this file except in compliance with- * the License. You may obtain a copy of the License at- *- * http://www.apache.org/licenses/LICENSE-2.0- *- * Unless required by applicable law or agreed to in writing, software- * distributed under the License is distributed on an "AS IS" BASIS,- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.- * See the License for the specific language governing permissions and- * limitations under the License.- */--package org.apache.solr.client.solrj;--import java.io.ByteArrayInputStream;-import java.io.InputStream;-import java.nio.charset.StandardCharsets;-import org.apache.solr.client.api.model.SolrJerseyResponse;-import org.apache.solr.client.solrj.request.CollectionsApi.ListCollectionsResponse;-import org.apache.solr.common.util.NamedList;-import org.junit.Assert;-import org.junit.Test;--/**- * A test ensuring that specific generated SolrRequest classes deserialize responses into the- * correct type.- *- * <p>See SOLR-17326 for more context. Consider removing once SOLR-17329 has been completed.- */-public class ApiMustacheTemplateTests {-- /**- * Tests the return type in generated response classes. This test ensures that responses are still- * returning API models in case of a naming conflict between response class and return type (API- * model).- */- @Test- public void testParsedReturnTypes() {- JacksonParsingResponse<?> response = getJacksonParsingResponse();-- Object data = null;- try {- // Parsing may fail if wrong class is used- data = response.getParsed();- } catch (Exception e) {- // Parsing should not fail for the given example.- Assert.fail("Response parsing failed with error " + e.getMessage());- }-- // In case of a naming conflict, even if parsing would succeed, the type would still be the same- // as response- Assert.assertNotSame(data.getClass(), response.getClass());- Assert.assertFalse(data instanceof JacksonParsingResponse<?>);-- // Currently, all response types extend SolrJerseyResponse. Adjust if this change in the future.- Assert.assertTrue(data instanceof SolrJerseyResponse);- }-- /**- * @return Returns a dummy response of {@link ListCollectionsResponse} with data.- */- private static JacksonParsingResponse<?> getJacksonParsingResponse() {- JacksonParsingResponse<?> response = new ListCollectionsResponse(); // API response-- // Provide a dummy response for ListCollectionsResponse- InputStream inputStream =- new ByteArrayInputStream(- "{\"responseHeader\":{\"status\":0,\"QTime\":0},\"collections\":[\"testCollection\"]}"- .getBytes(StandardCharsets.UTF_8));- NamedList<Object> responseData = new NamedList<>();- responseData.add("stream", inputStream);- response.setResponse(responseData);-- return response;- }-}diff --git a/solr/test-framework/src/java/org/apache/solr/embedded/JettySolrRunner.java b/solr/test-framework/src/java/org/apache/solr/embedded/JettySolrRunner.javaindex 49e2f3139fc..12baf8a0e37 100644--- a/solr/test-framework/src/java/org/apache/solr/embedded/JettySolrRunner.java+++ b/solr/test-framework/src/java/org/apache/solr/embedded/JettySolrRunner.java@@ -712,7 +712,7 @@ public class JettySolrRunner {final var coreStatusReq = new CoresApi.GetAllCoreStatus();coreStatusReq.setIndexInfo(true);try (final var client = newClient()) {- final var coreStatusRsp = coreStatusReq.process(client).getParsed();+ final var coreStatusRsp = coreStatusReq.process(client);Utils.writeJson(coreStatusRsp, pw, true);} catch (SolrServerException | IOException e) {// Worth logging but not re-throwing