Skip to content

fix issue 18446 NPE by making sure scoreSupplier.get() returns non-null scorer #19650

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
cwperks merged 2 commits into from
Nov 5, 2025
Merged

fix issue 18446 NPE by making sure scoreSupplier.get() returns non-null scorer #19650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
541af32
fix issue 18446 NPE by making sure scoreSupplier.get() returns non-nu…
haruki1243 Oct 16, 2025
9e69b55
add tests and changelog
Oct 16, 2025
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
- Fixed assertion unsafe use of ClusterService.state() in ResourceUsageCollectorService ([#19775])(https://github.com/opensearch-project/OpenSearch/pull/19775))
- Fix Unified highlighter for nested fields when using matchPhrasePrefixQuery ([#19442](https://github.com/opensearch-project/OpenSearch/pull/19442))
- Add S3Repository.LEGACY_MD5_CHECKSUM_CALCULATION to list of repository-s3 settings ([#19788](https://github.com/opensearch-project/OpenSearch/pull/19788))
- Fix NPE of ScriptScoreQuery ([#19650](https://github.com/opensearch-project/OpenSearch/pull/19650))

### Dependencies
- Update to Gradle 9.2 ([#19575](https://github.com/opensearch-project/OpenSearch/pull/19575)) ([#19856](https://github.com/opensearch-project/OpenSearch/pull/19856))
Expand Down
21 changes: 21 additions & 0 deletions server/src/internalClusterTest/java/org/opensearch/search/query/ScriptScoreQueryIT.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
import java.util.function.Function;

import static org.opensearch.index.query.QueryBuilders.boolQuery;
import static org.opensearch.index.query.QueryBuilders.idsQuery;
import static org.opensearch.index.query.QueryBuilders.matchQuery;
import static org.opensearch.index.query.QueryBuilders.scriptScoreQuery;
import static org.opensearch.search.SearchService.CLUSTER_CONCURRENT_SEGMENT_SEARCH_SETTING;
Expand Down Expand Up @@ -217,4 +218,24 @@ public void testDisallowExpensiveQueries() throws Exception {
assertAcked(client().admin().cluster().updateSettings(updateSettingsRequest).actionGet());
}
}

// test case added for issue https://github.com/opensearch-project/OpenSearch/issues/18446
public void testScriptScoreNotExistingQuery() throws Exception {
assertAcked(prepareCreate("test-index").setMapping("field2", "type=double"));
client().prepareIndex("test-index").setId("1").setSource("field2", 1).get();
refresh();
indexRandomForConcurrentSearch("test-index");

Map<String, Object> params = new HashMap<>();
params.put("param1", 0.1);
Script script = new Script(ScriptType.INLINE, CustomScriptPlugin.NAME, "doc['field2'].value * param1", params);
QueryBuilder idsQuery = idsQuery().addIds("2");
QueryBuilder scriptScoreQuery = scriptScoreQuery(idsQuery, script);
// Issue 18446 arises because of null Scorer returned from ScorerSupplier.
// However, Lucene prefers bulkScorer() instead of scorer() which doesn't trigger NPE as stated in issue 18446.
// As a result, we have to set profile to true to force the usage of scorer() instead of bulkScorer(),
// to make sure we test the intended code path
SearchResponse resp = client().prepareSearch("test-index").setQuery(scriptScoreQuery).setProfile(true).get();
assertNoFailures(resp);
}
}
71 changes: 22 additions & 49 deletions server/src/main/java/org/opensearch/common/lucene/search/function/ScriptScoreQuery.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,72 +124,45 @@ public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float bo
Weight subQueryWeight = subQuery.createWeight(searcher, subQueryScoreMode, 1.0f);
Copy link
Contributor

@jainankitk jainankitk Nov 5, 2025

Choose a reason for hiding this comment

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

Why are we not using the boost? Is it because the boost is irrelevant for the subQuery?


return new Weight(this) {

@Override
public ScorerSupplier scorerSupplier(LeafReaderContext context) throws IOException {
final Weight weight = this;
ScorerSupplier subQueryScorerSupplier = subQueryWeight.scorerSupplier(context);
if (subQueryScorerSupplier == null) {
return null;
}
Comment on lines +130 to +133
Copy link
Contributor

@jainankitk jainankitk Nov 5, 2025

Choose a reason for hiding this comment

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

Ensuring the subQueryScorerSupplier is non-null here helps make the ScorerSupplier implementation cleaner and easier.

Weight weight = this;
Copy link
Contributor

@jainankitk jainankitk Nov 5, 2025

Choose a reason for hiding this comment

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

nit: I will probably decare subQueryScorerSupplier and weight as final.

return new ScorerSupplier() {
private Scorer scorer;
private BulkScorer bulkScorer;

@Override
public BulkScorer bulkScorer() throws IOException {
if (minScore == null) {
final BulkScorer subQueryBulkScorer = subQueryWeight.bulkScorer(context);
if (subQueryBulkScorer == null) {
bulkScorer = null;
} else {
bulkScorer = new ScriptScoreBulkScorer(
subQueryBulkScorer,
subQueryScoreMode,
makeScoreScript(context),
boost
);
}
final BulkScorer subQueryBulkScorer = subQueryScorerSupplier.bulkScorer();
return new ScriptScoreBulkScorer(subQueryBulkScorer, subQueryScoreMode, makeScoreScript(context), boost);
} else {
final Scorer scorer = get(Long.MAX_VALUE);
if (scorer != null) {
bulkScorer = new Weight.DefaultBulkScorer(scorer);
}
return super.bulkScorer();
}

return bulkScorer;
}

@Override
public Scorer get(long leadCost) throws IOException {
final Scorer subQueryScorer = subQueryWeight.scorer(context);

if (subQueryScorer == null) {
scorer = null;
} else {
Scorer scriptScorer = new ScriptScorer(
weight,
makeScoreScript(context),
subQueryScorer,
subQueryScoreMode,
boost,
null
);
if (minScore != null) {
scriptScorer = new MinScoreScorer(weight, scriptScorer, minScore);
}
scorer = scriptScorer;
Scorer subQueryScorer = subQueryScorerSupplier.get(leadCost);
Scorer scriptScorer = new ScriptScorer(
weight,
makeScoreScript(context),
subQueryScorer,
subQueryScoreMode,
boost,
null
);
if (minScore != null) {
scriptScorer = new MinScoreScorer(weight, scriptScorer, minScore);
}

return scorer;
return scriptScorer;
}

@Override
public long cost() {
if (scorer != null) {
return scorer.iterator().cost();
} else if (bulkScorer != null) {
return bulkScorer.cost();
} else {
// We have no prior knowledge of how many docs might match for any given query term,
// so we assume that all docs could be a match.
return Integer.MAX_VALUE;
}
return subQueryScorerSupplier.cost();
}
};
}
Expand Down
60 changes: 60 additions & 0 deletions server/src/test/java/org/opensearch/search/query/ScriptScoreQueryTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,10 @@
import org.apache.lucene.search.IndexSearcher;
import org.apache.lucene.search.MatchAllDocsQuery;
import org.apache.lucene.search.Query;
import org.apache.lucene.search.QueryVisitor;
import org.apache.lucene.search.ScoreMode;
import org.apache.lucene.search.Scorer;
import org.apache.lucene.search.ScorerSupplier;
import org.apache.lucene.search.TwoPhaseIterator;
import org.apache.lucene.search.Weight;
import org.apache.lucene.store.Directory;
Expand Down Expand Up @@ -216,6 +218,64 @@ public void testTwoPhaseIteratorDelegation() throws IOException {
assertTrue("Expected to find at least one matching document", foundMatchingDoc);
}

public void testNullScorerSupplier() throws IOException {
Script script = new Script("script using explain");
ScoreScript.LeafFactory factory = newFactory(script, true, explanation -> {
assertNotNull(explanation);
explanation.set("this explains the score");
return 1.0;
});

ScriptScoreQuery query = new ScriptScoreQuery(new NullScorerSupplierQuery(), script, factory, null, "index", 0, Version.CURRENT);
Weight weight = query.createWeight(searcher, ScoreMode.COMPLETE, 1.0f);
ScorerSupplier scorerSupplier = weight.scorerSupplier(null);
assertNull(scorerSupplier);
}

private static class NullScorerSupplierQuery extends Query {

@Override
public String toString(String field) {
return getClass().getSimpleName();
}

@Override
public void visit(QueryVisitor visitor) {
visitor.visitLeaf(this);
}

@Override
public boolean equals(Object obj) {
return this == obj;
}

@Override
public int hashCode() {
return 0;
}

@Override
public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException {
return new Weight(this) {

@Override
public Explanation explain(LeafReaderContext context, int doc) throws IOException {
throw new UnsupportedOperationException();
}

@Override
public ScorerSupplier scorerSupplier(LeafReaderContext context) throws IOException {
return null;
}

@Override
public boolean isCacheable(LeafReaderContext ctx) {
return true;
}
};
}
}

private ScoreScript.LeafFactory newFactory(
Script script,
boolean needsScore,
Expand Down
Loading