Skip to content

Rename TopDocsCollectorContext to TopDocsCollectorFactory #95435

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 21, 2023
Merged

Rename TopDocsCollectorContext to TopDocsCollectorFactory #95435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions server/src/main/java/org/elasticsearch/search/query/QueryPhase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
import static org.elasticsearch.search.profile.query.CollectorResult.REASON_SEARCH_MULTI;
import static org.elasticsearch.search.profile.query.CollectorResult.REASON_SEARCH_POST_FILTER;
import static org.elasticsearch.search.profile.query.CollectorResult.REASON_SEARCH_TERMINATE_AFTER_COUNT;
import static org.elasticsearch.search.query.TopDocsCollectorContext.createTopDocsCollectorContext;
import static org.elasticsearch.search.query.TopDocsCollectorFactory.createTopDocsCollectorFactory;

/**
* Query phase of a search request, used to run the query and get back from each shard information about the matching documents
Expand Down Expand Up @@ -132,7 +132,7 @@ static void executeInternal(SearchContext searchContext) throws QueryPhaseExecut
}

// create the top docs collector last when the other collectors are known
final TopDocsCollectorContext topDocsFactory = createTopDocsCollectorContext(
final TopDocsCollectorFactory topDocsFactory = createTopDocsCollectorFactory(
searchContext,
searchContext.parsedPostFilter() != null || searchContext.minimumScore() != null
);
Expand Down
42 changes: 25 additions & 17 deletions ...search/query/TopDocsCollectorContext.java → ...search/query/TopDocsCollectorFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,21 +65,29 @@

/**
* Creates and holds the main {@link Collector} that will be used to search and collect top hits.
* Once the returned collector has been used to collect hits, allows to enrich the collected top docs to be set to the search context.
*/
abstract class TopDocsCollectorContext {
abstract class TopDocsCollectorFactory {
final String profilerName;
final DocValueFormat[] sortValueFormats;

TopDocsCollectorContext(String profilerName, DocValueFormat[] sortValueFormats) {
TopDocsCollectorFactory(String profilerName, DocValueFormat[] sortValueFormats) {
this.profilerName = profilerName;
this.sortValueFormats = sortValueFormats;
}

/**
* Returns the collector used to collect top hits, created depending on the incoming request options
*/
abstract Collector collector();

/**
* Returns the collected top docs to be set to the {@link QuerySearchResult} within the search context.
* To be called after collection, to enrich the top docs and wrap them with our {@link TopDocsAndMaxScore}.
*/
abstract TopDocsAndMaxScore topDocsAndMaxScore() throws IOException;

static class EmptyTopDocsCollectorContext extends TopDocsCollectorContext {
static class EmptyTopDocsCollectorFactory extends TopDocsCollectorFactory {
private final Sort sort;
private final Collector collector;
private final Supplier<TotalHits> hitCountSupplier;
Expand All @@ -89,7 +97,7 @@ static class EmptyTopDocsCollectorContext extends TopDocsCollectorContext {
* @param sortAndFormats The sort clause if provided
* @param trackTotalHitsUpTo The threshold up to which total hit count needs to be tracked
*/
private EmptyTopDocsCollectorContext(@Nullable SortAndFormats sortAndFormats, int trackTotalHitsUpTo) {
private EmptyTopDocsCollectorFactory(@Nullable SortAndFormats sortAndFormats, int trackTotalHitsUpTo) {
super(REASON_SEARCH_COUNT, null);
this.sort = sortAndFormats == null ? null : sortAndFormats.sort;
if (trackTotalHitsUpTo == SearchContext.TRACK_TOTAL_HITS_DISABLED) {
Expand Down Expand Up @@ -130,7 +138,7 @@ TopDocsAndMaxScore topDocsAndMaxScore() {
}
}

static class CollapsingTopDocsCollectorContext extends TopDocsCollectorContext {
static class CollapsingTopDocsCollectorFactory extends TopDocsCollectorFactory {
private final SinglePassGroupingCollector<?> topDocsCollector;
private final Supplier<Float> maxScoreSupplier;

Expand All @@ -141,7 +149,7 @@ static class CollapsingTopDocsCollectorContext extends TopDocsCollectorContext {
* @param numHits The number of collapsed top hits to retrieve.
* @param trackMaxScore True if max score should be tracked
*/
private CollapsingTopDocsCollectorContext(
private CollapsingTopDocsCollectorFactory(
CollapseContext collapseContext,
@Nullable SortAndFormats sortAndFormats,
int numHits,
Expand Down Expand Up @@ -175,7 +183,7 @@ TopDocsAndMaxScore topDocsAndMaxScore() throws IOException {
}
}

static class SimpleTopDocsCollectorContext extends TopDocsCollectorContext {
static class SimpleTopDocsCollectorFactory extends TopDocsCollectorFactory {

private static TopDocsCollector<?> createCollector(
@Nullable SortAndFormats sortAndFormats,
Expand Down Expand Up @@ -207,7 +215,7 @@ private static TopDocsCollector<?> createCollector(
* @param trackTotalHitsUpTo Threshold up to which total hit count should be tracked
* @param hasFilterCollector True if the collector chain contains at least one collector that can filter documents out
*/
private SimpleTopDocsCollectorContext(
private SimpleTopDocsCollectorFactory(
IndexReader reader,
Query query,
@Nullable SortAndFormats sortAndFormats,
Expand Down Expand Up @@ -289,11 +297,11 @@ TopDocsAndMaxScore topDocsAndMaxScore() {
}
}

static class ScrollingTopDocsCollectorContext extends SimpleTopDocsCollectorContext {
static class ScrollingTopDocsCollectorFactory extends SimpleTopDocsCollectorFactory {
private final ScrollContext scrollContext;
private final int numberOfShards;

private ScrollingTopDocsCollectorContext(
private ScrollingTopDocsCollectorFactory(
IndexReader reader,
Query query,
ScrollContext scrollContext,
Expand Down Expand Up @@ -403,18 +411,18 @@ static int shortcutTotalHitCount(IndexReader reader, Query query) throws IOExcep
}

/**
* Creates a {@link TopDocsCollectorContext} from the provided <code>searchContext</code>.
* Creates a {@link TopDocsCollectorFactory} from the provided <code>searchContext</code>.
* @param hasFilterCollector True if the collector chain contains at least one collector that can filters document.
*/
static TopDocsCollectorContext createTopDocsCollectorContext(SearchContext searchContext, boolean hasFilterCollector)
static TopDocsCollectorFactory createTopDocsCollectorFactory(SearchContext searchContext, boolean hasFilterCollector)
throws IOException {
final IndexReader reader = searchContext.searcher().getIndexReader();
final Query query = searchContext.rewrittenQuery();
// top collectors don't like a size of 0
final int totalNumDocs = Math.max(1, reader.numDocs());
if (searchContext.size() == 0) {
// no matter what the value of from is
return new EmptyTopDocsCollectorContext(searchContext.sort(), searchContext.trackTotalHitsUpTo());
return new EmptyTopDocsCollectorFactory(searchContext.sort(), searchContext.trackTotalHitsUpTo());
} else if (searchContext.scrollContext() != null) {
// we can disable the tracking of total hits after the initial scroll query
// since the total hits is preserved in the scroll context.
Expand All @@ -423,7 +431,7 @@ static TopDocsCollectorContext createTopDocsCollectorContext(SearchContext searc
: SearchContext.TRACK_TOTAL_HITS_ACCURATE;
// no matter what the value of from is
int numDocs = Math.min(searchContext.size(), totalNumDocs);
return new ScrollingTopDocsCollectorContext(
return new ScrollingTopDocsCollectorFactory(
reader,
query,
searchContext.scrollContext(),
Expand All @@ -435,9 +443,9 @@ static TopDocsCollectorContext createTopDocsCollectorContext(SearchContext searc
hasFilterCollector
);
} else if (searchContext.collapse() != null) {
boolean trackScores = searchContext.sort() == null ? true : searchContext.trackScores();
boolean trackScores = searchContext.sort() == null || searchContext.trackScores();
int numDocs = Math.min(searchContext.from() + searchContext.size(), totalNumDocs);
return new CollapsingTopDocsCollectorContext(
return new CollapsingTopDocsCollectorFactory(
searchContext.collapse(),
searchContext.sort(),
numDocs,
Expand All @@ -453,7 +461,7 @@ static TopDocsCollectorContext createTopDocsCollectorContext(SearchContext searc
numDocs = Math.max(numDocs, rescoreContext.getWindowSize());
}
}
return new SimpleTopDocsCollectorContext(
return new SimpleTopDocsCollectorFactory(
reader,
query,
searchContext.sort(),
Expand Down
6 changes: 3 additions & 3 deletions server/src/test/java/org/elasticsearch/search/query/QueryPhaseTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
import java.util.List;
import java.util.function.IntUnaryOperator;

import static org.elasticsearch.search.query.TopDocsCollectorContext.hasInfMaxScore;
import static org.elasticsearch.search.query.TopDocsCollectorFactory.hasInfMaxScore;
import static org.hamcrest.Matchers.anyOf;
import static org.hamcrest.Matchers.arrayWithSize;
import static org.hamcrest.Matchers.equalTo;
Expand Down Expand Up @@ -679,15 +679,15 @@ public void testDisableTopScoreCollection() throws Exception {
context.parsedQuery(new ParsedQuery(q));
context.setSize(3);
context.trackTotalHitsUpTo(3);
TopDocsCollectorContext topDocsContext = TopDocsCollectorContext.createTopDocsCollectorContext(context, false);
TopDocsCollectorFactory topDocsContext = TopDocsCollectorFactory.createTopDocsCollectorFactory(context, false);
assertEquals(topDocsContext.collector().scoreMode(), org.apache.lucene.search.ScoreMode.COMPLETE);
QueryPhase.executeInternal(context);
assertEquals(5, context.queryResult().topDocs().topDocs.totalHits.value);
assertEquals(context.queryResult().topDocs().topDocs.totalHits.relation, TotalHits.Relation.EQUAL_TO);
assertThat(context.queryResult().topDocs().topDocs.scoreDocs.length, equalTo(3));

context.sort(new SortAndFormats(new Sort(new SortField("other", SortField.Type.INT)), new DocValueFormat[] { DocValueFormat.RAW }));
topDocsContext = TopDocsCollectorContext.createTopDocsCollectorContext(context, false);
topDocsContext = TopDocsCollectorFactory.createTopDocsCollectorFactory(context, false);
assertEquals(topDocsContext.collector().scoreMode(), org.apache.lucene.search.ScoreMode.TOP_DOCS);
QueryPhase.executeInternal(context);
assertEquals(5, context.queryResult().topDocs().topDocs.totalHits.value);
Expand Down
8 changes: 4 additions & 4 deletions ...h/query/TopDocsCollectorContextTests.java → ...h/query/TopDocsCollectorFactoryTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

import java.io.IOException;

public class TopDocsCollectorContextTests extends ESTestCase {
public class TopDocsCollectorFactoryTests extends ESTestCase {

public void testShortcutTotalHitCountTextField() throws IOException {
try (Directory dir = newDirectory(); RandomIndexWriter iw = new RandomIndexWriter(random(), dir)) {
Expand All @@ -39,7 +39,7 @@ public void testShortcutTotalHitCountTextField() throws IOException {
iw.commit();
try (IndexReader reader = iw.getReader()) {
final Query testQuery = new FieldExistsQuery("text");
int hitCount = TopDocsCollectorContext.shortcutTotalHitCount(reader, testQuery);
int hitCount = TopDocsCollectorFactory.shortcutTotalHitCount(reader, testQuery);
assertEquals(-1, hitCount);
}
}
Expand All @@ -59,7 +59,7 @@ public void testShortcutTotalHitCountStringField() throws IOException {
iw.commit();
try (IndexReader reader = iw.getReader()) {
final Query testQuery = new FieldExistsQuery("string");
int hitCount = TopDocsCollectorContext.shortcutTotalHitCount(reader, testQuery);
int hitCount = TopDocsCollectorFactory.shortcutTotalHitCount(reader, testQuery);
assertEquals(2, hitCount);
}
}
Expand All @@ -75,7 +75,7 @@ public void testShortcutTotalHitCountNumericField() throws IOException {
iw.commit();
try (IndexReader reader = iw.getReader()) {
final Query testQuery = new FieldExistsQuery("int");
int hitCount = TopDocsCollectorContext.shortcutTotalHitCount(reader, testQuery);
int hitCount = TopDocsCollectorFactory.shortcutTotalHitCount(reader, testQuery);
assertEquals(1, hitCount);
}
}
Expand Down