(dsl): Support `Filter` aggregation #349

vanjaftn · 2023-10-31T16:21:05Z

Part of #118

arnoldlacko · 2023-11-07T07:49:04Z

modules/library/src/main/scala/zio/elasticsearch/result/AggregationResult.scala

+    subAggregations.get(aggName) match {
+      case Some(aggRes) =>
+        Try(aggRes.asInstanceOf[A]) match {
+          case Failure(_)   => Left(DecodingException(s"Aggregation with name $aggName was not of type you provided."))


This check will probably not work here because of type erasure: at runtime the type A is not known here, so asInstanceOf will allow anything and a cast error will most likely happen later in user code. An example to demonstrate the case: https://scastie.scala-lang.org/kyL2fVL2S8eQByJb4aS1Yg

dbulaja98

You will have to update this PR with the newly added aggregations.

dbulaja98 · 2023-11-13T23:16:47Z

docs/overview/aggregations/elastic_aggregation_filter.md

+```
+
+You can create a `Filter` aggregation using the `filterAggregation` method in the following manner:
+```scala


Add the import for term query.

dbulaja98 · 2023-11-13T23:18:07Z

modules/library/src/main/scala/zio/elasticsearch/aggregation/Aggregations.scala

@@ -143,6 +144,31 @@ private[elasticsearch] final case class Cardinality(name: String, field: String,
  }
 }

+sealed trait FilterAggregation extends SingleElasticAggregation with WithSubAgg[FilterAggregation] with WithAgg


Reorder traits (WithSubAgg and WithAgg).

dbulaja98 · 2023-11-13T23:30:13Z

modules/library/src/main/scala/zio/elasticsearch/executor/HttpExecutor.scala

+            value => {
              ZIO.succeed(new AggregateResult(value.aggs.map { case (key, response) =>
                (key, toResult(response))
              }))
+            }


Omit { and }.

dbulaja98 · 2023-11-13T23:31:26Z

modules/library/src/main/scala/zio/elasticsearch/executor/response/AggregationResponse.scala

+private[elasticsearch] final case class StatsAggregationResponse(
+  count: Int,
+  min: Double,
+  max: Double,
+  avg: Double,
+  sum: Double
+) extends AggregationResponse
+
+private[elasticsearch] object StatsAggregationResponse {
+  implicit val decoder: JsonDecoder[StatsAggregationResponse] = DeriveJsonDecoder.gen[StatsAggregationResponse]
+}


Please keep it ordered.

dbulaja98 · 2023-11-13T23:33:04Z

modules/library/src/main/scala/zio/elasticsearch/executor/response/AggregationResponse.scala

@@ -31,6 +31,16 @@ object AggregationResponse {
        AvgAggregationResult(value)
      case CardinalityAggregationResponse(value) =>
        CardinalityAggregationResult(value)
+      case FilterAggregationResponse(docCount, subAggregations) => {


Omit { and }.

dbulaja98 · 2023-11-13T23:53:11Z

modules/library/src/test/scala/zio/elasticsearch/ElasticAggregationSpec.scala

+                subAggregations = Chunk.empty,
+                query = query


Keep params ordered.

In other examples too.

dbulaja98 · 2023-11-13T23:57:22Z

modules/integration/src/test/scala/zio/elasticsearch/HttpExecutorSpec.scala

@@ -104,6 +104,67 @@ object HttpExecutorSpec extends IntegrationSpec {
            Executor.execute(ElasticRequest.createIndex(firstSearchIndex)),
            Executor.execute(ElasticRequest.deleteIndex(firstSearchIndex)).orDie
          ),
+          test("aggregate using filter aggregation") {


Suggested change

test("aggregate using filter aggregation") {

test("aggregate using filter aggregation with max aggregation as a sub aggregation") {

dbulaja98 · 2023-11-13T23:58:39Z

modules/integration/src/test/scala/zio/elasticsearch/HttpExecutorSpec.scala

@@ -104,6 +104,67 @@ object HttpExecutorSpec extends IntegrationSpec {
            Executor.execute(ElasticRequest.createIndex(firstSearchIndex)),
            Executor.execute(ElasticRequest.deleteIndex(firstSearchIndex)).orDie
          ),
+          test("aggregate using filter aggregation") {
+            val expectedResponse = (


Suggested change

val expectedResponse = (

val expectedResult = (

dbulaja98 · 2023-11-14T00:00:23Z

docs/overview/aggregations/elastic_aggregation_filter.md

+```
+
+If you want to add aggregation (on the same level), you can use `withAgg` method:
+```scala


dbulaja98 · 2023-11-14T00:00:49Z

docs/overview/aggregations/elastic_aggregation_filter.md

+```
+
+If you want to add another sub-aggregation, you can use `withSubAgg` method:
+```scala


Here add also for maxAggregation too.

dbulaja98 · 2023-11-15T15:12:26Z

modules/integration/src/test/scala/zio/elasticsearch/HttpExecutorSpec.scala

+                           .refreshTrue
+                       )
+                  query = term(field = TestDocument.stringField, value = secondDocumentUpdated.stringField.toLowerCase)
+


Omit empty line.

dbulaja98 · 2023-11-15T15:12:36Z

modules/integration/src/test/scala/zio/elasticsearch/HttpExecutorSpec.scala

+                    filterAggregation(name = "aggregation", query = query).withSubAgg(
+                      maxAggregation("subAggregation", TestDocument.intField)
+                    )
+


Omit empty line.

dbulaja98 · 2023-11-15T15:16:16Z

modules/library/src/main/scala/zio/elasticsearch/executor/response/AggregationResponse.scala

@@ -120,6 +224,7 @@ private[elasticsearch] final case class SumAggregationResponse(value: Double) ex

 private[elasticsearch] object SumAggregationResponse {
  implicit val decoder: JsonDecoder[SumAggregationResponse] = DeriveJsonDecoder.gen[SumAggregationResponse]
+


Omit empty line.

modules/library/src/main/scala/zio/elasticsearch/executor/response/AggregationResponse.scala

dbulaja98 · 2023-11-15T15:30:28Z

modules/library/src/test/scala/zio/elasticsearch/ElasticAggregationSpec.scala

+            filterAggregation("aggregation", query).withSubAgg(minAggregation("subAggregation", TestDocument.intField))
+          val aggregationWithMultipleSubAggregations = filterAggregation("aggregation", query)
+            .withSubAgg(maxAggregation("maxSubAggregation", TestDocument.intField))
+            .withSubAgg(minAggregation("minSubAggregation", TestDocument.intField))


Put other numeric field (not intField) for minAggregation.

dbulaja98 · 2023-11-15T15:30:41Z

modules/library/src/test/scala/zio/elasticsearch/ElasticAggregationSpec.scala

+            filterAggregation("aggregation", query).withSubAgg(minAggregation("subAggregation", TestDocument.intField))
+          val aggregationWithMultipleSubAggregations = filterAggregation("aggregation", query)
+            .withSubAgg(maxAggregation("maxSubAggregation", TestDocument.intField))
+            .withSubAgg(minAggregation("minSubAggregation", TestDocument.intField))


vanjaftn force-pushed the task-support-filter-aggregation branch 2 times, most recently from 7ebeec7 to cb25165 Compare November 1, 2023 14:31

arnoldlacko reviewed Nov 7, 2023

View reviewed changes

vanjaftn force-pushed the task-support-filter-aggregation branch from 5726f35 to 0627b78 Compare November 7, 2023 12:41

vanjaftn changed the title ~~[DRAFT]: (dsl): Support filter aggregation~~ (dsl): Support filter aggregation Nov 7, 2023

dbulaja98 marked this pull request as ready for review November 7, 2023 13:11

dbulaja98 changed the title ~~(dsl): Support filter aggregation~~ (dsl): Support Filter aggregation Nov 12, 2023

dbulaja98 requested changes Nov 14, 2023

View reviewed changes

vanjaftn force-pushed the task-support-filter-aggregation branch from a6efadf to 30edae8 Compare November 14, 2023 10:29

dbulaja98 requested changes Nov 15, 2023

View reviewed changes

vanjaftn force-pushed the task-support-filter-aggregation branch 2 times, most recently from c058f2c to 5914223 Compare November 17, 2023 09:27

vanjaftn added 10 commits November 17, 2023 10:30

Implement filter aggregation

0c59f9c

Reformat files

f49fab6

Implement changes to Filter ggregation

46dd94a

Implement changes in Filter aggregation

625321c

Implement Filter aggregation

0448df2

Implement changes in Filter aggregation

1c24137

Fix code remarks

74458d8

Resolve conflicts

6fee03b

Fix code remarks

73d623a

Fix code remarks

422b24b

vanjaftn force-pushed the task-support-filter-aggregation branch from 4a374b4 to 422b24b Compare November 17, 2023 09:30

vanjaftn added 2 commits November 17, 2023 10:35

Remove unnecessary code

32b1f8d

Implement changes in Filter aggregation

4a0e28a

dbulaja98 approved these changes Nov 17, 2023

View reviewed changes

dbulaja98 merged commit 8c55381 into lambdaworks:main Nov 17, 2023
13 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

(dsl): Support `Filter` aggregation #349

(dsl): Support `Filter` aggregation #349

vanjaftn commented Oct 31, 2023 •

edited by dbulaja98

arnoldlacko Nov 7, 2023

dbulaja98 left a comment

dbulaja98 Nov 13, 2023

dbulaja98 Nov 13, 2023

dbulaja98 Nov 13, 2023

dbulaja98 Nov 13, 2023

dbulaja98 Nov 13, 2023

dbulaja98 Nov 13, 2023

dbulaja98 Nov 13, 2023

dbulaja98 Nov 13, 2023

dbulaja98 Nov 13, 2023

dbulaja98 Nov 14, 2023

dbulaja98 Nov 14, 2023

dbulaja98 Nov 15, 2023

dbulaja98 Nov 15, 2023

dbulaja98 Nov 15, 2023

dbulaja98 Nov 15, 2023

dbulaja98 Nov 15, 2023

	test("aggregate using filter aggregation") {
	test("aggregate using filter aggregation with max aggregation as a sub aggregation") {

		@@ -120,6 +224,7 @@ private[elasticsearch] final case class SumAggregationResponse(value: Double) ex

		private[elasticsearch] object SumAggregationResponse {
		implicit val decoder: JsonDecoder[SumAggregationResponse] = DeriveJsonDecoder.gen[SumAggregationResponse]

(dsl): Support Filter aggregation #349

(dsl): Support Filter aggregation #349

Conversation

vanjaftn commented Oct 31, 2023 • edited by dbulaja98

Choose a reason for hiding this comment

dbulaja98 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

(dsl): Support `Filter` aggregation #349

(dsl): Support `Filter` aggregation #349

vanjaftn commented Oct 31, 2023 •

edited by dbulaja98