Skip to content

Fix NullPointerException in LongComparator caused by null search_after values #132434

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Fix NullPointerException in LongComparator caused by null search_after values #132434

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fc09858
Fix NullPointerException in LongComparator caused by null search_afte…
Kguswo Aug 5, 2025
462a529
Fix NullPointerException in LongComparator caused by null search_afte…
Kguswo Aug 5, 2025
8b3ed29
Merge branch 'main' into fix/npe-in-search-after
Kguswo Aug 11, 2025
d0139e5
Merge branch 'main' into fix/npe-in-search-after
Kguswo Aug 15, 2025
43071a2
Merge branch 'main' into fix/npe-in-search-after
Kguswo Aug 17, 2025
2a099ca
Make error message more specific for search_after null values
Kguswo Aug 18, 2025
dedceaa
Merge branch 'main' into fix/npe-in-search-after
Kguswo Aug 18, 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
8 changes: 5 additions & 3 deletions server/src/main/java/org/elasticsearch/search/searchafter/SearchAfterBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ public SearchAfterBuilder setSortValues(Object[] values) {
throw new IllegalArgumentException("Values must contains at least one value.");
}
for (int i = 0; i < values.length; i++) {
if (values[i] == null) continue;
if (values[i] == null) {
throw new IllegalArgumentException("Values cannot contain null at position " + i + ".");
}
if (values[i] instanceof String) continue;
if (values[i] instanceof Text) continue;
if (values[i] instanceof Long) continue;
Expand Down Expand Up @@ -117,7 +119,7 @@ public static FieldDoc buildFieldDoc(SortAndFormats sort, Object[] values, @Null
if (values[i] != null) {
fieldValues[i] = convertValueFromSortField(values[i], sortField, format);
} else {
fieldValues[i] = null;
throw new IllegalArgumentException("Values cannot contain null at position " + i + ".");
Copy link
Member

Choose a reason for hiding this comment

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

do you know what scenario this covers for in practice?

Copy link
Author

Choose a reason for hiding this comment

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

In the constructor SearchAfterBuilder(StreamInput in), readGenericValue() can return null (case -1), and these null values are directly assigned to the sortValues array, bypassing the validation in setSortValues().

Copy link
Member

@javanna javanna Aug 18, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Right, I see, but these you can only get from a serialized SearchAfterBuilder, so perhaps null values can only come in from previous versions (before your change is made)? At the same time version based logic complicates things so maybe it is ok to leave it as-is.

Copy link
Author

Choose a reason for hiding this comment

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

I agree with your point about backward compatibility. Keeping the validation as it is seems like the simplest and safest approach. Appreciate the feedback!

}
}
/*
Expand Down Expand Up @@ -250,7 +252,7 @@ public static SearchAfterBuilder fromXContent(XContentParser parser) throws IOEx
} else if (token == XContentParser.Token.VALUE_BOOLEAN) {
values.add(parser.booleanValue());
} else if (token == XContentParser.Token.VALUE_NULL) {
values.add(null);
throw new ParsingException(parser.getTokenLocation(), "Values cannot contain null.");
Copy link
Member

Choose a reason for hiding this comment

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

Should we be more specific in the error message that it's the search_after values?

Copy link
Author

Choose a reason for hiding this comment

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

You're right, that would be much clearer. I think we could update this to:

  • Values cannot contain null. → [search_after] values cannot contain null.

Copy link
Member

Choose a reason for hiding this comment

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

++

} else {
throw new ParsingException(
parser.getTokenLocation(),
Expand Down
53 changes: 48 additions & 5 deletions server/src/test/java/org/elasticsearch/search/searchafter/SearchAfterBuilderTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import org.apache.lucene.search.SortedNumericSortField;
import org.apache.lucene.search.SortedSetSortField;
import org.apache.lucene.util.BytesRef;
import org.elasticsearch.common.ParsingException;
import org.elasticsearch.common.bytes.BytesReference;
import org.elasticsearch.common.geo.GeoPoint;
import org.elasticsearch.common.io.stream.NamedWriteableRegistry;
Expand Down Expand Up @@ -59,7 +60,7 @@ public static SearchAfterBuilder randomSearchAfterBuilder() throws IOException {
SearchAfterBuilder searchAfterBuilder = new SearchAfterBuilder();
Object[] values = new Object[numSearchFrom];
for (int i = 0; i < numSearchFrom; i++) {
int branch = randomInt(10);
int branch = randomInt(9);
switch (branch) {
case 0 -> values[i] = randomInt();
case 1 -> values[i] = randomFloat();
Expand All @@ -70,8 +71,7 @@ public static SearchAfterBuilder randomSearchAfterBuilder() throws IOException {
case 6 -> values[i] = randomByte();
case 7 -> values[i] = randomShort();
case 8 -> values[i] = new Text(randomAlphaOfLengthBetween(5, 20));
case 9 -> values[i] = null;
case 10 -> values[i] = randomBigInteger();
case 9 -> values[i] = randomBigInteger();
}
}
searchAfterBuilder.setSortValues(values);
Expand All @@ -91,7 +91,7 @@ public static SearchAfterBuilder randomJsonSearchFromBuilder(BiFunction<XContent
jsonBuilder.startObject();
jsonBuilder.startArray("search_after");
for (int i = 0; i < numSearchAfter; i++) {
int branch = randomInt(9);
int branch = randomInt(8);
switch (branch) {
case 0 -> jsonBuilder.value(randomInt());
case 1 -> jsonBuilder.value(randomFloat());
Expand All @@ -102,7 +102,6 @@ public static SearchAfterBuilder randomJsonSearchFromBuilder(BiFunction<XContent
case 6 -> jsonBuilder.value(randomByte());
case 7 -> jsonBuilder.value(randomShort());
case 8 -> jsonBuilder.value(new Text(randomAlphaOfLengthBetween(5, 20)));
case 9 -> jsonBuilder.nullValue();
}
}
jsonBuilder.endArray();
Expand Down Expand Up @@ -280,4 +279,48 @@ public void testBuildFieldDocWithCollapse() {
);
assertEquals(fieldDoc.toString(), new FieldDoc(Integer.MAX_VALUE, 0, new Object[] { new BytesRef("foo") }).toString());
}

/**
* Test that null values are properly rejected in setSortValues
*/
public void testSetSortValuesRejectsNull() {
SearchAfterBuilder builder = new SearchAfterBuilder();

IllegalArgumentException e1 = expectThrows(IllegalArgumentException.class, () -> { builder.setSortValues(new Object[] { null }); });
assertThat(e1.getMessage(), equalTo("Values cannot contain null at position 0."));

IllegalArgumentException e2 = expectThrows(IllegalArgumentException.class, () -> {
builder.setSortValues(new Object[] { 123L, null, "test" });
});
assertThat(e2.getMessage(), equalTo("Values cannot contain null at position 1."));
}

/**
* Test that null values are properly rejected in JSON parsing
*/
public void testFromXContentRejectsNull() throws Exception {
String jsonWithNull = "{\"search_after\": [123, null, \"test\"]}";
try (XContentParser parser = createParser(JsonXContent.jsonXContent, jsonWithNull)) {
parser.nextToken();
parser.nextToken();
parser.nextToken();
ParsingException e = expectThrows(ParsingException.class, () -> { SearchAfterBuilder.fromXContent(parser); });
assertThat(e.getMessage(), equalTo("Values cannot contain null."));
}
}

/**
* Test that buildFieldDoc rejects null values
*/
public void testBuildFieldDocRejectsNull() {
SortField longSortField = new SortField("timestamp", SortField.Type.LONG, true);
Sort sort = new Sort(longSortField);
DocValueFormat[] formats = { DocValueFormat.RAW };
SortAndFormats sortAndFormats = new SortAndFormats(sort, formats);

IllegalArgumentException e = expectThrows(IllegalArgumentException.class, () -> {
SearchAfterBuilder.buildFieldDoc(sortAndFormats, new Object[] { null }, null);
});
assertThat(e.getMessage(), equalTo("Values cannot contain null at position 0."));
}
}