Skip to content

Commit

Permalink
Fix FiltersAggregation NPE when filters is empty (#41459)
Browse files Browse the repository at this point in the history 
If `keyedFilters` is null it assumes there are unkeyed filters...which
will NPE if the unkeyed filters was actually empty.

This refactors to simplify the filter assignment a bit, adds an empty
check and tidies up some formatting.
  • Loading branch information
@polyfractal
polyfractal committed May 20, 2019
1 parent dbbdcea commit 072a9bd
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 33 deletions.
12 changes: 12 additions & 0 deletions ...-api-spec/src/main/resources/rest-api-spec/test/search.aggregation/220_filters_bucket.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -251,8 +251,20 @@ setup:

---
"Bad params":
- skip:
version: " - 7.1.99"
reason: "empty bodies throws exception starting in 7.2"
- do:
catch: /\[filters\] cannot be empty/
search:
rest_total_hits_as_int: true
body:
aggs:
the_filter:
filters: {}

- do:
catch: /\[filters\] cannot be empty/
search:
rest_total_hits_as_int: true
body:
Expand Down
61 changes: 31 additions & 30 deletions ...n/java/org/elasticsearch/search/aggregations/bucket/filter/FiltersAggregationBuilder.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,15 @@
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.Map;
import java.util.Objects;

import static org.elasticsearch.index.query.AbstractQueryBuilder.parseInnerQueryBuilder;

public class FiltersAggregationBuilder extends AbstractAggregationBuilder<FiltersAggregationBuilder>
implements MultiBucketAggregationBuilder {
implements MultiBucketAggregationBuilder {
public static final String NAME = "filters";

private static final ParseField FILTERS_FIELD = new ParseField("filters");
Expand All @@ -74,7 +75,7 @@ private FiltersAggregationBuilder(String name, List<KeyedFilter> filters, boolea
this.filters = new ArrayList<>(filters);
if (keyed) {
// internally we want to have a fixed order of filters, regardless of the order of the filters in the request
Collections.sort(this.filters, (KeyedFilter kf1, KeyedFilter kf2) -> kf1.key().compareTo(kf2.key()));
this.filters.sort(Comparator.comparing(KeyedFilter::key));
this.keyed = true;
} else {
this.keyed = false;
Expand Down Expand Up @@ -220,9 +221,9 @@ protected AggregationBuilder doRewrite(QueryRewriteContext queryShardContext) th

@Override
protected AggregatorFactory<?> doBuild(SearchContext context, AggregatorFactory<?> parent, Builder subFactoriesBuilder)
throws IOException {
throws IOException {
return new FiltersAggregatorFactory(name, filters, keyed, otherBucket, otherBucketKey, context, parent,
subFactoriesBuilder, metaData);
subFactoriesBuilder, metaData);
}

@Override
Expand All @@ -248,15 +249,15 @@ protected XContentBuilder internalXContent(XContentBuilder builder, Params param
}

public static FiltersAggregationBuilder parse(String aggregationName, XContentParser parser)
throws IOException {
throws IOException {

List<FiltersAggregator.KeyedFilter> keyedFilters = null;
List<QueryBuilder> nonKeyedFilters = null;
List<FiltersAggregator.KeyedFilter> filters = new ArrayList<>();

XContentParser.Token token = null;
XContentParser.Token token;
String currentFieldName = null;
String otherBucketKey = null;
Boolean otherBucket = null;
boolean keyed = false;
while ((token = parser.nextToken()) != XContentParser.Token.END_OBJECT) {
if (token == XContentParser.Token.FIELD_NAME) {
currentFieldName = parser.currentName();
Expand All @@ -265,61 +266,61 @@ public static FiltersAggregationBuilder parse(String aggregationName, XContentPa
otherBucket = parser.booleanValue();
} else {
throw new ParsingException(parser.getTokenLocation(),
"Unknown key for a " + token + " in [" + aggregationName + "]: [" + currentFieldName + "].");
"Unknown key for a " + token + " in [" + aggregationName + "]: [" + currentFieldName + "].");
}
} else if (token == XContentParser.Token.VALUE_STRING) {
if (OTHER_BUCKET_KEY_FIELD.match(currentFieldName, parser.getDeprecationHandler())) {
otherBucketKey = parser.text();
} else {
throw new ParsingException(parser.getTokenLocation(),
"Unknown key for a " + token + " in [" + aggregationName + "]: [" + currentFieldName + "].");
"Unknown key for a " + token + " in [" + aggregationName + "]: [" + currentFieldName + "].");
}
} else if (token == XContentParser.Token.START_OBJECT) {
if (FILTERS_FIELD.match(currentFieldName, parser.getDeprecationHandler())) {
keyedFilters = new ArrayList<>();
String key = null;
while ((token = parser.nextToken()) != XContentParser.Token.END_OBJECT) {
if (token == XContentParser.Token.FIELD_NAME) {
key = parser.currentName();
} else {
QueryBuilder filter = parseInnerQueryBuilder(parser);
keyedFilters.add(new FiltersAggregator.KeyedFilter(key, filter));
filters.add(new FiltersAggregator.KeyedFilter(key, filter));
}
}
keyed = true;
} else {
throw new ParsingException(parser.getTokenLocation(),
"Unknown key for a " + token + " in [" + aggregationName + "]: [" + currentFieldName + "].");
"Unknown key for a " + token + " in [" + aggregationName + "]: [" + currentFieldName + "].");
}
} else if (token == XContentParser.Token.START_ARRAY) {
if (FILTERS_FIELD.match(currentFieldName, parser.getDeprecationHandler())) {
nonKeyedFilters = new ArrayList<>();
while ((token = parser.nextToken()) != XContentParser.Token.END_ARRAY) {
List<QueryBuilder> builders = new ArrayList<>();
while (parser.nextToken() != XContentParser.Token.END_ARRAY) {
QueryBuilder filter = parseInnerQueryBuilder(parser);
nonKeyedFilters.add(filter);
builders.add(filter);
}
for (int i = 0; i < builders.size(); i++) {
filters.add(new KeyedFilter(String.valueOf(i), builders.get(i)));
}
} else {
throw new ParsingException(parser.getTokenLocation(),
"Unknown key for a " + token + " in [" + aggregationName + "]: [" + currentFieldName + "].");
"Unknown key for a " + token + " in [" + aggregationName + "]: [" + currentFieldName + "].");
}
} else {
throw new ParsingException(parser.getTokenLocation(),
"Unknown key for a " + token + " in [" + aggregationName + "]: [" + currentFieldName + "].");
"Unknown key for a " + token + " in [" + aggregationName + "]: [" + currentFieldName + "].");
}
}

if (filters.isEmpty()) {
throw new IllegalArgumentException("[" + FILTERS_FIELD + "] cannot be empty.");
}

FiltersAggregationBuilder factory = new FiltersAggregationBuilder(aggregationName, filters, keyed);

if (otherBucket == null && otherBucketKey != null) {
// automatically enable the other bucket if a key is set, as per the doc
otherBucket = true;
}

FiltersAggregationBuilder factory;
if (keyedFilters != null) {
factory = new FiltersAggregationBuilder(aggregationName,
keyedFilters.toArray(new FiltersAggregator.KeyedFilter[keyedFilters.size()]));
} else {
factory = new FiltersAggregationBuilder(aggregationName,
nonKeyedFilters.toArray(new QueryBuilder[nonKeyedFilters.size()]));
}
if (otherBucket != null) {
factory.otherBucket(otherBucket);
}
Expand All @@ -338,9 +339,9 @@ protected int doHashCode() {
protected boolean doEquals(Object obj) {
FiltersAggregationBuilder other = (FiltersAggregationBuilder) obj;
return Objects.equals(filters, other.filters)
&& Objects.equals(keyed, other.keyed)
&& Objects.equals(otherBucket, other.otherBucket)
&& Objects.equals(otherBucketKey, other.otherBucketKey);
&& Objects.equals(keyed, other.keyed)
&& Objects.equals(otherBucket, other.otherBucket)
&& Objects.equals(otherBucketKey, other.otherBucketKey);
}

@Override
Expand Down
38 changes: 35 additions & 3 deletions server/src/test/java/org/elasticsearch/search/aggregations/bucket/FiltersTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,9 @@ public void testFiltersSortedByKey() {
public void testOtherBucket() throws IOException {
XContentBuilder builder = XContentFactory.contentBuilder(randomFrom(XContentType.values()));
builder.startObject();
builder.startArray("filters").endArray();
builder.startArray("filters")
.startObject().startObject("term").field("field", "foo").endObject().endObject()
.endArray();
builder.endObject();
try (XContentParser parser = createParser(shuffleXContent(builder))) {
parser.nextToken();
Expand All @@ -102,7 +104,9 @@ public void testOtherBucket() throws IOException {

builder = XContentFactory.contentBuilder(randomFrom(XContentType.values()));
builder.startObject();
builder.startArray("filters").endArray();
builder.startArray("filters")
.startObject().startObject("term").field("field", "foo").endObject().endObject()
.endArray();
builder.field("other_bucket_key", "some_key");
builder.endObject();
}
Expand All @@ -114,7 +118,9 @@ public void testOtherBucket() throws IOException {

builder = XContentFactory.contentBuilder(randomFrom(XContentType.values()));
builder.startObject();
builder.startArray("filters").endArray();
builder.startArray("filters")
.startObject().startObject("term").field("field", "foo").endObject().endObject()
.endArray();
builder.field("other_bucket", false);
builder.field("other_bucket_key", "some_key");
builder.endObject();
Expand Down Expand Up @@ -192,4 +198,30 @@ public void testRewritePreservesOtherBucket() throws IOException {
assertEquals(originalFilters.otherBucket(), rewrittenFilters.otherBucket());
assertEquals(originalFilters.otherBucketKey(), rewrittenFilters.otherBucketKey());
}

public void testEmptyFilters() throws IOException {
{
XContentBuilder builder = XContentFactory.contentBuilder(randomFrom(XContentType.values()));
builder.startObject();
builder.startArray("filters").endArray(); // unkeyed array
builder.endObject();
XContentParser parser = createParser(shuffleXContent(builder));
parser.nextToken();
IllegalArgumentException e = expectThrows(IllegalArgumentException.class,
() -> FiltersAggregationBuilder.parse("agg_name", parser));
assertThat(e.getMessage(), equalTo("[filters] cannot be empty."));
}

{
XContentBuilder builder = XContentFactory.contentBuilder(randomFrom(XContentType.values()));
builder.startObject();
builder.startObject("filters").endObject(); // keyed object
builder.endObject();
XContentParser parser = createParser(shuffleXContent(builder));
parser.nextToken();
IllegalArgumentException e = expectThrows(IllegalArgumentException.class,
() -> FiltersAggregationBuilder.parse("agg_name", parser));
assertThat(e.getMessage(), equalTo("[filters] cannot be empty."));
}
}
}

0 comments on commit 072a9bd

Please sign in to comment.