Skip to content

armgit / solr

Public Imported from GitHub
0

Apache Solr open-source search software

SOLR-17322: Make RankQuery.getTopDocsCollector use covariant generic types (#2506)

Steve Woods57287c8520e5
diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
index 1077e653d98..ea7a5b7b71c 100644
--- a/solr/CHANGES.txt
+++ b/solr/CHANGES.txt
@@ -240,6 +240,9 @@ Other Changes
* SOLR-15831: Refactor bin/solr and bin/solr.cmd commands integration with AuthTool, DeleteTool, and PackageTool to delegate arg parsing to Java code. Removed limitation of PackageTool only being executed on an active Solr node. (Eric Pugh)
+* SOLR-17322: Once again allow rank queries to use custom TopDocsCollectors that operate on types that extend
+ ScoreDocs (covariant generic types) broken in Solr 9.0. (Stephen Woods via Christine Poerschke)
+
================== 9.6.1 ==================
Bug Fixes
---------------------
diff --git a/solr/core/src/java/org/apache/solr/search/AbstractReRankQuery.java b/solr/core/src/java/org/apache/solr/search/AbstractReRankQuery.java
index f2eb6de2c3b..62c4bd98bbc 100644
--- a/solr/core/src/java/org/apache/solr/search/AbstractReRankQuery.java
+++ b/solr/core/src/java/org/apache/solr/search/AbstractReRankQuery.java
@@ -75,7 +75,7 @@ public abstract class AbstractReRankQuery extends RankQuery {
@Override
@SuppressWarnings({"unchecked"})
- public TopDocsCollector<ScoreDoc> getTopDocsCollector(
+ public TopDocsCollector<? extends ScoreDoc> getTopDocsCollector(
int len, QueryCommand cmd, IndexSearcher searcher) throws IOException {
if (this.boostedPriority == null) {
SolrRequestInfo info = SolrRequestInfo.getRequestInfo();
diff --git a/solr/core/src/java/org/apache/solr/search/ExportQParserPlugin.java b/solr/core/src/java/org/apache/solr/search/ExportQParserPlugin.java
index e43f229d8a5..8529533dfb3 100644
--- a/solr/core/src/java/org/apache/solr/search/ExportQParserPlugin.java
+++ b/solr/core/src/java/org/apache/solr/search/ExportQParserPlugin.java
@@ -104,7 +104,7 @@ public class ExportQParserPlugin extends QParserPlugin {
}
@Override
- public TopDocsCollector<ScoreDoc> getTopDocsCollector(
+ public TopDocsCollector<? extends ScoreDoc> getTopDocsCollector(
int len, QueryCommand cmd, IndexSearcher searcher) throws IOException {
int leafCount = searcher.getTopReaderContext().leaves().size();
FixedBitSet[] sets = new FixedBitSet[leafCount];
diff --git a/solr/core/src/java/org/apache/solr/search/RankQuery.java b/solr/core/src/java/org/apache/solr/search/RankQuery.java
index ec6ae26f5a3..3f281ebbd29 100644
--- a/solr/core/src/java/org/apache/solr/search/RankQuery.java
+++ b/solr/core/src/java/org/apache/solr/search/RankQuery.java
@@ -29,7 +29,7 @@ import org.apache.solr.handler.component.MergeStrategy;
*/
public abstract class RankQuery extends ExtendedQueryBase {
- public abstract TopDocsCollector<ScoreDoc> getTopDocsCollector(
+ public abstract TopDocsCollector<? extends ScoreDoc> getTopDocsCollector(
int len, QueryCommand cmd, IndexSearcher searcher) throws IOException;
public abstract MergeStrategy getMergeStrategy();
diff --git a/solr/core/src/test/org/apache/solr/search/RankQueryTest.java b/solr/core/src/test/org/apache/solr/search/RankQueryTest.java
index 8bcdea1d50c..f9c3a8fa043 100644
--- a/solr/core/src/test/org/apache/solr/search/RankQueryTest.java
+++ b/solr/core/src/test/org/apache/solr/search/RankQueryTest.java
@@ -16,8 +16,19 @@
*/
package org.apache.solr.search;
+import java.io.IOException;
+import org.apache.lucene.index.LeafReaderContext;
+import org.apache.lucene.search.IndexSearcher;
+import org.apache.lucene.search.LeafCollector;
+import org.apache.lucene.search.Query;
+import org.apache.lucene.search.QueryVisitor;
+import org.apache.lucene.search.ScoreDoc;
+import org.apache.lucene.search.ScoreMode;
+import org.apache.lucene.search.TopDocsCollector;
+import org.apache.lucene.util.PriorityQueue;
import org.apache.solr.SolrTestCaseJ4;
import org.apache.solr.common.params.ModifiableSolrParams;
+import org.apache.solr.handler.component.MergeStrategy;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
@@ -106,4 +117,64 @@ public class RankQueryTest extends SolrTestCaseJ4 {
"//result/doc[2]/str[@name='id'][.='6']",
"//result/doc[1]/str[@name='id'][.='5']");
}
+
+ // The following static classes are intended to ensure that support of covariant
+ // ScoreDocs is supported in rank queries. MyRankQuery will fail to compile
+ // if covariant ScoreDocs are not supported because it returns a TopDocsCollector
+ // for MyScoreDoc (a subtype of ScoreDoc).
+ static class MyScoreDoc extends ScoreDoc {
+ public int someOtherField;
+
+ public MyScoreDoc(int doc, float score, int shardIndex, int someOtherField) {
+ super(doc, score, shardIndex);
+ this.someOtherField = someOtherField;
+ }
+ }
+
+ static class MyTopDocsCollector extends TopDocsCollector<MyScoreDoc> {
+ public MyTopDocsCollector(PriorityQueue<MyScoreDoc> pq) {
+ super(pq);
+ }
+
+ @Override
+ public ScoreMode scoreMode() {
+ return ScoreMode.COMPLETE;
+ }
+
+ @Override
+ public LeafCollector getLeafCollector(LeafReaderContext context) throws IOException {
+ return null;
+ }
+ }
+
+ static class MyRankQuery extends RankQuery {
+ @Override
+ public TopDocsCollector<? extends ScoreDoc> getTopDocsCollector(
+ int len, QueryCommand cmd, IndexSearcher searcher) throws IOException {
+ return new MyTopDocsCollector(null);
+ }
+
+ @Override
+ public MergeStrategy getMergeStrategy() {
+ return null;
+ }
+
+ @Override
+ public RankQuery wrap(Query mainQuery) {
+ return this;
+ }
+
+ @Override
+ public void visit(QueryVisitor visitor) {}
+
+ @Override
+ public int hashCode() {
+ return 1;
+ }
+
+ @Override
+ public boolean equals(Object obj) {
+ return true;
+ }
+ }
}
diff --git a/solr/core/src/test/org/apache/solr/search/RankQueryTestPlugin.java b/solr/core/src/test/org/apache/solr/search/RankQueryTestPlugin.java
index b11728e0283..c82661200b3 100644
--- a/solr/core/src/test/org/apache/solr/search/RankQueryTestPlugin.java
+++ b/solr/core/src/test/org/apache/solr/search/RankQueryTestPlugin.java
@@ -140,7 +140,7 @@ public class RankQueryTestPlugin extends QParserPlugin {
}
@Override
- public TopDocsCollector<ScoreDoc> getTopDocsCollector(
+ public TopDocsCollector<? extends ScoreDoc> getTopDocsCollector(
int len, QueryCommand cmd, IndexSearcher searcher) {
if (collector == 0) return new TestCollector(null);
else return new TestCollector1(null);
diff --git a/solr/core/src/test/org/apache/solr/search/SolrIndexSearcherTest.java b/solr/core/src/test/org/apache/solr/search/SolrIndexSearcherTest.java
index be7f458587b..49fcc21e45e 100644
--- a/solr/core/src/test/org/apache/solr/search/SolrIndexSearcherTest.java
+++ b/solr/core/src/test/org/apache/solr/search/SolrIndexSearcherTest.java
@@ -327,7 +327,7 @@ public class SolrIndexSearcherTest extends SolrTestCaseJ4 {
}
@Override
- public TopDocsCollector<ScoreDoc> getTopDocsCollector(
+ public TopDocsCollector<? extends ScoreDoc> getTopDocsCollector(
int len, QueryCommand cmd, IndexSearcher searcher) throws IOException {
return new ReRankCollector(
len,