Skip to content

Use inner query for equals/hashCode() in SourceConfirmedTextQuery #134451

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 3 commits into from
Sep 10, 2025
+49 −39
Merged

Use inner query for equals/hashCode() in SourceConfirmedTextQuery #134451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
09c91ad
Use inner query for equals/hashCode() implementation in SourceConfirm…
romseygeek Sep 10, 2025
c37b488
Update docs/changelog/134451.yaml
romseygeek Sep 10, 2025
5b267fe
Update 134451.yaml
romseygeek Sep 10, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/changelog/134451.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pr: 134451
summary: Use inner query for equals/hashCode() in `SourceConfirmedTextQuery`
area: "Search"
type: bug
issues:
- 134432
12 changes: 8 additions & 4 deletions ...-extras/src/main/java/org/elasticsearch/index/mapper/extras/SourceConfirmedTextQuery.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,14 +176,18 @@ public boolean equals(Object obj) {
return false;
}
SourceConfirmedTextQuery that = (SourceConfirmedTextQuery) obj;
return Objects.equals(in, that.in)
&& Objects.equals(valueFetcherProvider, that.valueFetcherProvider)
&& Objects.equals(indexAnalyzer, that.indexAnalyzer);
// We intentionally do not compare the value fetcher or analyzer, as they
// do not typically implement equals() themselves, and the inner
// Query is sufficient to establish identity.
return Objects.equals(in, that.in);
}

@Override
public int hashCode() {
return 31 * Objects.hash(in, valueFetcherProvider, indexAnalyzer) + classHash();
// We intentionally do not hash the value fetcher or analyzer, as they
// do not typically implement hashCode() themselves, and the inner
// Query is sufficient to establish identity.
return 31 * Objects.hash(in) + classHash();
}

@Override
Expand Down
70 changes: 35 additions & 35 deletions ...as/src/test/java/org/elasticsearch/index/mapper/extras/SourceConfirmedTextQueryTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,13 @@
public class SourceConfirmedTextQueryTests extends ESTestCase {

private static final AtomicInteger sourceFetchCount = new AtomicInteger();
private static final IOFunction<LeafReaderContext, CheckedIntFunction<List<Object>, IOException>> SOURCE_FETCHER_PROVIDER =
context -> docID -> {

private static IOFunction<LeafReaderContext, CheckedIntFunction<List<Object>, IOException>> sourceFetcherProvider() {
return context -> docID -> {
sourceFetchCount.incrementAndGet();
return Collections.<Object>singletonList(context.reader().storedFields().document(docID).get("body"));
return Collections.singletonList(context.reader().storedFields().document(docID).get("body"));
};
}

public void testTerm() throws Exception {
try (Directory dir = newDirectory(); IndexWriter w = new IndexWriter(dir, newIndexWriterConfig(Lucene.STANDARD_ANALYZER))) {
Expand All @@ -84,7 +86,7 @@ public void testTerm() throws Exception {
IndexSearcher searcher = newSearcher(reader);

TermQuery query = new TermQuery(new Term("body", "c"));
Query sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
Query sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);

assertEquals(searcher.count(query), searcher.count(sourceConfirmedPhraseQuery));
ScoreDoc[] phraseHits = searcher.search(query, 10).scoreDocs;
Expand All @@ -95,7 +97,7 @@ public void testTerm() throws Exception {

// Term query with missing term
query = new TermQuery(new Term("body", "e"));
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
assertEquals(searcher.count(query), searcher.count(sourceConfirmedPhraseQuery));
assertArrayEquals(new ScoreDoc[0], searcher.search(sourceConfirmedPhraseQuery, 10).scoreDocs);
}
Expand All @@ -112,7 +114,7 @@ public void testMissingPhrase() throws Exception {
try (IndexReader reader = DirectoryReader.open(w)) {
IndexSearcher searcher = newSearcher(reader);
PhraseQuery query = new PhraseQuery("missing_field", "b", "c");
Query sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
Query sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
Explanation explanation = searcher.explain(sourceConfirmedPhraseQuery, 0);
assertFalse(explanation.isMatch());

Expand Down Expand Up @@ -141,7 +143,7 @@ public void testPhrase() throws Exception {
IndexSearcher searcher = newSearcher(reader);

PhraseQuery query = new PhraseQuery("body", "b", "c");
Query sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
Query sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);

assertEquals(searcher.count(query), searcher.count(sourceConfirmedPhraseQuery));
ScoreDoc[] phraseHits = searcher.search(query, 10).scoreDocs;
Expand All @@ -152,7 +154,7 @@ public void testPhrase() throws Exception {

// Sloppy phrase query
query = new PhraseQuery(1, "body", "b", "d");
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
assertEquals(searcher.count(query), searcher.count(sourceConfirmedPhraseQuery));
phraseHits = searcher.search(query, 10).scoreDocs;
assertEquals(2, phraseHits.length);
Expand All @@ -162,13 +164,13 @@ public void testPhrase() throws Exception {

// Phrase query with no matches
query = new PhraseQuery("body", "d", "c");
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
assertEquals(searcher.count(query), searcher.count(sourceConfirmedPhraseQuery));
assertArrayEquals(new ScoreDoc[0], searcher.search(sourceConfirmedPhraseQuery, 10).scoreDocs);

// Phrase query with one missing term
query = new PhraseQuery("body", "b", "e");
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
assertEquals(searcher.count(query), searcher.count(sourceConfirmedPhraseQuery));
assertArrayEquals(new ScoreDoc[0], searcher.search(sourceConfirmedPhraseQuery, 10).scoreDocs);
}
Expand Down Expand Up @@ -197,7 +199,7 @@ public void testMultiPhrase() throws Exception {
.add(new Term[] { new Term("body", "c") }, 1)
.build();

Query sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
Query sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);

assertEquals(searcher.count(query), searcher.count(sourceConfirmedPhraseQuery));

Expand All @@ -212,7 +214,7 @@ public void testMultiPhrase() throws Exception {
.add(new Term[] { new Term("body", "d") }, 1)
.setSlop(1)
.build();
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
assertEquals(searcher.count(query), searcher.count(sourceConfirmedPhraseQuery));
phraseHits = searcher.search(query, 10).scoreDocs;
assertEquals(2, phraseHits.length);
Expand All @@ -224,15 +226,15 @@ public void testMultiPhrase() throws Exception {
query = new MultiPhraseQuery.Builder().add(new Term[] { new Term("body", "d"), new Term("body", "c") }, 0)
.add(new Term[] { new Term("body", "a") }, 1)
.build();
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
assertEquals(searcher.count(query), searcher.count(sourceConfirmedPhraseQuery));
assertArrayEquals(new ScoreDoc[0], searcher.search(sourceConfirmedPhraseQuery, 10).scoreDocs);

// Multi phrase query with one missing term
query = new MultiPhraseQuery.Builder().add(new Term[] { new Term("body", "d"), new Term("body", "c") }, 0)
.add(new Term[] { new Term("body", "e") }, 1)
.build();
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
assertEquals(searcher.count(query), searcher.count(sourceConfirmedPhraseQuery));
assertArrayEquals(new ScoreDoc[0], searcher.search(sourceConfirmedPhraseQuery, 10).scoreDocs);
}
Expand All @@ -258,7 +260,7 @@ public void testMultiPhrasePrefix() throws Exception {
IndexSearcher searcher = newSearcher(reader);

MultiPhrasePrefixQuery query = new MultiPhrasePrefixQuery("body");
Query sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
Query sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
ScoreDoc[] phrasePrefixHits = searcher.search(query, 10).scoreDocs;
ScoreDoc[] sourceConfirmedHits = searcher.search(sourceConfirmedPhraseQuery, 10).scoreDocs;
CheckHits.checkEqual(query, phrasePrefixHits, sourceConfirmedHits);
Expand All @@ -267,7 +269,7 @@ public void testMultiPhrasePrefix() throws Exception {

query = new MultiPhrasePrefixQuery("body");
query.add(new Term("body", "c"));
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
phrasePrefixHits = searcher.search(query, 10).scoreDocs;
sourceConfirmedHits = searcher.search(sourceConfirmedPhraseQuery, 10).scoreDocs;
CheckHits.checkEqual(query, phrasePrefixHits, sourceConfirmedHits);
Expand All @@ -277,7 +279,7 @@ public void testMultiPhrasePrefix() throws Exception {
query = new MultiPhrasePrefixQuery("body");
query.add(new Term("body", "b"));
query.add(new Term("body", "c"));
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
phrasePrefixHits = searcher.search(query, 10).scoreDocs;
sourceConfirmedHits = searcher.search(sourceConfirmedPhraseQuery, 10).scoreDocs;
CheckHits.checkEqual(query, phrasePrefixHits, sourceConfirmedHits);
Expand All @@ -289,7 +291,7 @@ public void testMultiPhrasePrefix() throws Exception {
query.add(new Term("body", "a"));
query.add(new Term("body", "c"));
query.setSlop(2);
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
phrasePrefixHits = searcher.search(query, 10).scoreDocs;
sourceConfirmedHits = searcher.search(sourceConfirmedPhraseQuery, 10).scoreDocs;
CheckHits.checkEqual(query, phrasePrefixHits, sourceConfirmedHits);
Expand All @@ -300,15 +302,15 @@ public void testMultiPhrasePrefix() throws Exception {
query = new MultiPhrasePrefixQuery("body");
query.add(new Term("body", "d"));
query.add(new Term("body", "b"));
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
assertEquals(searcher.count(query), searcher.count(sourceConfirmedPhraseQuery));
assertArrayEquals(new ScoreDoc[0], searcher.search(sourceConfirmedPhraseQuery, 10).scoreDocs);

// Multi phrase query with one missing term
query = new MultiPhrasePrefixQuery("body");
query.add(new Term("body", "d"));
query.add(new Term("body", "f"));
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
assertEquals(0, searcher.count(sourceConfirmedPhraseQuery));
assertArrayEquals(new ScoreDoc[0], searcher.search(sourceConfirmedPhraseQuery, 10).scoreDocs);
}
Expand Down Expand Up @@ -338,7 +340,7 @@ public void testSpanNear() throws Exception {
0,
false
);
Query sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
Query sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);

assertEquals(searcher.count(query), searcher.count(sourceConfirmedPhraseQuery));
ScoreDoc[] spanHits = searcher.search(query, 10).scoreDocs;
Expand All @@ -353,7 +355,7 @@ public void testSpanNear() throws Exception {
1,
false
);
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
assertEquals(searcher.count(query), searcher.count(sourceConfirmedPhraseQuery));
spanHits = searcher.search(query, 10).scoreDocs;
assertEquals(2, spanHits.length);
Expand All @@ -367,7 +369,7 @@ public void testSpanNear() throws Exception {
0,
false
);
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
assertEquals(searcher.count(query), searcher.count(sourceConfirmedPhraseQuery));
assertArrayEquals(new ScoreDoc[0], searcher.search(sourceConfirmedPhraseQuery, 10).scoreDocs);

Expand All @@ -377,7 +379,7 @@ public void testSpanNear() throws Exception {
0,
false
);
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
assertEquals(searcher.count(query), searcher.count(sourceConfirmedPhraseQuery));
assertArrayEquals(new ScoreDoc[0], searcher.search(sourceConfirmedPhraseQuery, 10).scoreDocs);
}
Expand All @@ -386,30 +388,28 @@ public void testSpanNear() throws Exception {

public void testToString() {
PhraseQuery query = new PhraseQuery("body", "b", "c");
Query sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
Query sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
assertEquals(query.toString(), sourceConfirmedPhraseQuery.toString());
}

public void testEqualsHashCode() {
PhraseQuery query1 = new PhraseQuery("body", "b", "c");
Query sourceConfirmedPhraseQuery1 = new SourceConfirmedTextQuery(query1, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
Query sourceConfirmedPhraseQuery1 = new SourceConfirmedTextQuery(query1, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);

assertEquals(sourceConfirmedPhraseQuery1, sourceConfirmedPhraseQuery1);
assertEquals(sourceConfirmedPhraseQuery1.hashCode(), sourceConfirmedPhraseQuery1.hashCode());

PhraseQuery query2 = new PhraseQuery("body", "b", "c");
Query sourceConfirmedPhraseQuery2 = new SourceConfirmedTextQuery(query2, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
Query sourceConfirmedPhraseQuery2 = new SourceConfirmedTextQuery(query2, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
assertEquals(sourceConfirmedPhraseQuery1, sourceConfirmedPhraseQuery2);

PhraseQuery query3 = new PhraseQuery("body", "b", "d");
Query sourceConfirmedPhraseQuery3 = new SourceConfirmedTextQuery(query3, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
Query sourceConfirmedPhraseQuery3 = new SourceConfirmedTextQuery(query3, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
assertNotEquals(sourceConfirmedPhraseQuery1, sourceConfirmedPhraseQuery3);

Query sourceConfirmedPhraseQuery4 = new SourceConfirmedTextQuery(query1, context -> null, Lucene.STANDARD_ANALYZER);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NB - these tests were specifically checking for different analyzers and value fetcher lambdas, which we no longer want to do. The Analyzer is always the same for queries against the same mapped field, so will always be identical if the inner Query is identical.
assertNotEquals(sourceConfirmedPhraseQuery1, sourceConfirmedPhraseQuery4);

Query sourceConfirmedPhraseQuery5 = new SourceConfirmedTextQuery(query1, SOURCE_FETCHER_PROVIDER, Lucene.KEYWORD_ANALYZER);
assertNotEquals(sourceConfirmedPhraseQuery1, sourceConfirmedPhraseQuery5);
PhraseQuery query4 = new PhraseQuery("body", "b", "c");
Query sourceConfirmedPhraseQuery6 = new SourceConfirmedTextQuery(query4, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
assertEquals(sourceConfirmedPhraseQuery1, sourceConfirmedPhraseQuery6);
}

public void testApproximation() {
Expand Down Expand Up @@ -461,7 +461,7 @@ public void testEmptyIndex() throws Exception {
try (IndexReader reader = DirectoryReader.open(w)) {
IndexSearcher searcher = newSearcher(reader);
PhraseQuery query = new PhraseQuery("body", "a", "b");
Query sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
Query sourceConfirmedPhraseQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);
assertEquals(0, searcher.count(sourceConfirmedPhraseQuery));
}
}
Expand Down Expand Up @@ -489,7 +489,7 @@ private static void checkMatches(Query query, String inputDoc, int[] expectedMat
doc.add(new KeywordField("sort", "2", Store.NO));
w.addDocument(doc);

Query sourceConfirmedQuery = new SourceConfirmedTextQuery(query, SOURCE_FETCHER_PROVIDER, Lucene.STANDARD_ANALYZER);
Query sourceConfirmedQuery = new SourceConfirmedTextQuery(query, sourceFetcherProvider(), Lucene.STANDARD_ANALYZER);

try (IndexReader ir = DirectoryReader.open(w)) {
{
Expand Down