diff --git a/CHANGELOG.md b/CHANGELOG.md index 650e921604..c79e975a22 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -47,6 +47,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Do not double-wrap OpenSearchException on error ([#323](https://github.com/opensearch-project/opensearch-java/pull/323)) - Fix AwsSdk2TransportOptions.responseCompression ([#322](https://github.com/opensearch-project/opensearch-java/pull/322)) - Bulk UpdateOperation misses upsert options ([#353](https://github.com/opensearch-project/opensearch-java/pull/353)) +- Fix missing key property in the RangeBucket ([#370](https://github.com/opensearch-project/opensearch-java/pull/370)) ### Security diff --git a/java-client/src/main/java/org/opensearch/client/opensearch/_types/aggregations/RangeBucket.java b/java-client/src/main/java/org/opensearch/client/opensearch/_types/aggregations/RangeBucket.java index 58b5a74b76..b8dd31a18b 100644 --- a/java-client/src/main/java/org/opensearch/client/opensearch/_types/aggregations/RangeBucket.java +++ b/java-client/src/main/java/org/opensearch/client/opensearch/_types/aggregations/RangeBucket.java @@ -51,6 +51,9 @@ @JsonpDeserializable public class RangeBucket extends MultiBucketBase { + + @Nullable + private final String key; @Nullable private final Double from; @@ -68,6 +71,7 @@ public class RangeBucket extends MultiBucketBase { private RangeBucket(Builder builder) { super(builder); + this.key = builder.key; this.from = builder.from; this.to = builder.to; this.fromAsString = builder.fromAsString; @@ -79,6 +83,14 @@ public static RangeBucket of(Function> fn) { return fn.apply(new Builder()).build(); } + /** + * API name: {@code key} + */ + @Nullable + public final String key() { + return this.key; + } + /** * API name: {@code from} */ @@ -114,6 +126,11 @@ public final String toAsString() { protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { super.serializeInternal(generator, mapper); + if (this.key != null) { + generator.writeKey("key"); + generator.write(this.key); + + } if (this.from != null) { generator.writeKey("from"); generator.write(this.from); @@ -144,6 +161,9 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) { */ public static class Builder extends MultiBucketBase.AbstractBuilder implements ObjectBuilder { + + @Nullable + private String key; @Nullable private Double from; @@ -156,6 +176,14 @@ public static class Builder extends MultiBucketBase.AbstractBuilder imp @Nullable private String toAsString; + /** + * API name: {@code key} + */ + public final Builder key(String value) { + this.key = value; + return this; + } + /** * API name: {@code from} */ @@ -216,6 +244,7 @@ public RangeBucket build() { protected static void setupRangeBucketDeserializer(ObjectDeserializer op) { setupMultiBucketBaseDeserializer(op); + op.add(Builder::key, JsonpDeserializer.stringDeserializer(), "key"); op.add(Builder::from, JsonpDeserializer.doubleDeserializer(), "from"); op.add(Builder::to, JsonpDeserializer.doubleDeserializer(), "to"); op.add(Builder::fromAsString, JsonpDeserializer.stringDeserializer(), "from_as_string"); diff --git a/java-client/src/test/java/org/opensearch/client/opensearch/integTest/restclient/AggregationRequestIT.java b/java-client/src/test/java/org/opensearch/client/opensearch/integTest/restclient/AggregationRequestIT.java new file mode 100644 index 0000000000..151c32867d --- /dev/null +++ b/java-client/src/test/java/org/opensearch/client/opensearch/integTest/restclient/AggregationRequestIT.java @@ -0,0 +1,173 @@ +/* + * SPDX-License-Identifier: Apache-2.0 + * + * The OpenSearch Contributors require contributions made to + * this file be licensed under the Apache-2.0 license or a + * compatible open source license. + */ + +package org.opensearch.client.opensearch.integTest.restclient; + +import com.fasterxml.jackson.annotation.JsonFormat; +import org.apache.hc.core5.http.HttpHost; +import org.junit.Test; +import org.opensearch.client.json.jackson.JacksonJsonpMapper; +import org.opensearch.client.opensearch._types.Refresh; +import org.opensearch.client.opensearch._types.aggregations.Aggregation; +import org.opensearch.client.opensearch._types.aggregations.AggregationRange; +import org.opensearch.client.opensearch._types.aggregations.DateRangeAggregation; +import org.opensearch.client.opensearch._types.aggregations.DateRangeExpression; +import org.opensearch.client.opensearch._types.aggregations.FieldDateMath; +import org.opensearch.client.opensearch._types.aggregations.RangeAggregation; +import org.opensearch.client.opensearch.core.SearchResponse; +import org.opensearch.client.opensearch.integTest.AbstractRequestIT; +import org.opensearch.client.transport.OpenSearchTransport; +import org.opensearch.client.transport.rest_client.RestClientTransport; +import org.opensearch.common.settings.Settings; + +import java.io.IOException; +import java.time.LocalDateTime; +import java.time.ZoneOffset; +import java.util.Date; +import java.util.List; + +public class AggregationRequestIT extends AbstractRequestIT { + + @Override + public OpenSearchTransport buildTransport(Settings settings, HttpHost[] hosts) throws IOException { + return new RestClientTransport(buildClient(settings, hosts), new JacksonJsonpMapper()); + } + + @Test + public void testValueRangeAggregation() throws Exception { + var index = "test-value-range-aggregation"; + createDateRangeDocuments(index); + var searchResponse = sendAggregateRequest(index, "cost_ranges", getCostValueRangeAggregation()); + var costRangesAggregations = searchResponse.aggregations().get("cost_ranges"); + var buckets = costRangesAggregations._get() + ._toAggregate() + .range() + .buckets() + .array(); + + assertEquals(3, buckets.size()); + assertEquals(2, buckets.get(0).docCount()); + assertEquals(2, buckets.get(1).docCount()); + assertEquals(2, buckets.get(2).docCount()); + } + + @Test + public void testDateRangeAggregation() throws Exception { + var index = "test-date-range-aggregation"; + createDateRangeDocuments(index); + var searchResponse = sendAggregateRequest(index, "expiry_ranges", getExpiryDateRangeAggregation()); + var expiryRangesAggregations = searchResponse.aggregations().get("expiry_ranges"); + var buckets = expiryRangesAggregations._get() + ._toAggregate() + .dateRange() + .buckets() + .array(); + + assertEquals(3, buckets.size()); + assertEquals(2, buckets.get(0).docCount()); + assertEquals(2, buckets.get(1).docCount()); + assertEquals(2, buckets.get(2).docCount()); + } + + private Aggregation getExpiryDateRangeAggregation() { + DateRangeAggregation expiryDateRangeAggregation = new DateRangeAggregation.Builder() + .field("expDate") + .ranges(getDateAggregationRanges()) + .build(); + return new Aggregation.Builder().dateRange(expiryDateRangeAggregation).build(); + } + + private Aggregation getCostValueRangeAggregation() { + RangeAggregation costValueRangeAggregation = new RangeAggregation.Builder() + .field("cost") + .ranges(getValueAggregationRanges()) + .build(); + return new Aggregation.Builder().range(costValueRangeAggregation).build(); + } + + private SearchResponse sendAggregateRequest(String index, String key, Aggregation value) throws IOException { + return javaClient().search( + request -> request.index(index) + .size(0) + .aggregations(key, value), + Void.class); + } + + private List getDateAggregationRanges() { + return List.of( + new DateRangeExpression.Builder() + .from(builder -> builder.value((double) getDatePlusDays(1).getTime())) + .to(FieldDateMath.of(builder -> builder.value((double) getDatePlusDays(3).getTime() - 1000))) + .key("from-1-to-2-days") + .build(), + new DateRangeExpression.Builder() + .from(builder -> builder.value((double) getDatePlusDays(3).getTime())) + .to(FieldDateMath.of(builder -> builder.value((double) getDatePlusDays(5).getTime() - 1000))) + .key("from-3-to-4-days") + .build(), + new DateRangeExpression.Builder() + .from(builder -> builder.value((double) getDatePlusDays(5).getTime())) + .to(FieldDateMath.of(builder -> builder.value((double) getDatePlusDays(7).getTime() - 1000))) + .key("from-5-to-6-days") + .build() + ); + } + + private List getValueAggregationRanges() { + return List.of( + new AggregationRange.Builder().to("10").build(), + new AggregationRange.Builder().from("10").to("30").build(), + new AggregationRange.Builder().from("30").build() + ); + } + + private void createDateRangeDocuments(String index) throws IOException { + javaClient().create(_1 -> _1.index(index).id("1").document(createProduct("egg", 2, 1)).refresh(Refresh.True)); + javaClient().create(_1 -> _1.index(index).id("2").document(createProduct("meat", 15, 2)).refresh(Refresh.True)); + javaClient().create(_1 -> _1.index(index).id("3").document(createProduct("ham", 30, 3)).refresh(Refresh.True)); + javaClient().create(_1 -> _1.index(index).id("4").document(createProduct("cheese", 25, 4)).refresh(Refresh.True)); + javaClient().create(_1 -> _1.index(index).id("5").document(createProduct("pasta", 8, 5)).refresh(Refresh.True)); + javaClient().create(_1 -> _1.index(index).id("6").document(createProduct("oil", 50, 6)).refresh(Refresh.True)); + } + + private ProductDetails createProduct(String name, int cost, int plusDays) { + return new ProductDetails(name, cost, getDatePlusDays(plusDays)); + } + + private Date getDatePlusDays(int plusDays) { + return java.sql.Date.from(LocalDateTime.of(2023, 2, 20, 0, 0, 0).plusDays(plusDays).toInstant(ZoneOffset.UTC)); + } + + public static class ProductDetails { + private String name; + private int cost; + @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS") + private Date expDate; + + public ProductDetails() { + } + + public ProductDetails(String name, int cost, Date expDate) { + this.name = name; + this.cost = cost; + this.expDate = expDate; + } + + public String getName() { + return name; + } + + public int getCost() { + return cost; + } + + public Date getExpDate() { + return expDate; + } + } +}