Skip to content
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

Add percentiles aggregation #109

Merged
merged 5 commits into from
Dec 28, 2023
Merged

Add percentiles aggregation #109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c0ef9a0
Add Percentiles aggregation
Dec 27, 2023
20b2bc6
api dump
Dec 27, 2023
35fd9e6
Remove generic
Dec 27, 2023
74f7c21
@Suppress("MagicNumber") for default percents in PercentilesAgg
Dec 27, 2023
6d58437
Change PercentilesAgg parameters
Dec 28, 2023
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
36 changes: 36 additions & 0 deletions elasticmagic/api/elasticmagic.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1831,6 +1831,42 @@ public final class dev/evo/elasticmagic/aggs/OptionalDoubleValueAggResult$Compan
public final fun invoke (Ldev/evo/elasticmagic/serde/Deserializer$ObjectCtx;)Ldev/evo/elasticmagic/aggs/OptionalDoubleValueAggResult;
}

public final class dev/evo/elasticmagic/aggs/PercentileAggResult : dev/evo/elasticmagic/aggs/AggregationResult {
public static final field Companion Ldev/evo/elasticmagic/aggs/PercentileAggResult$Companion;
public fun <init> (Ljava/util/Map;)V
public final fun component1 ()Ljava/util/Map;
public final fun copy (Ljava/util/Map;)Ldev/evo/elasticmagic/aggs/PercentileAggResult;
public static synthetic fun copy$default (Ldev/evo/elasticmagic/aggs/PercentileAggResult;Ljava/util/Map;ILjava/lang/Object;)Ldev/evo/elasticmagic/aggs/PercentileAggResult;
public fun equals (Ljava/lang/Object;)Z
public final fun getValues ()Ljava/util/Map;
public fun hashCode ()I
public fun toString ()Ljava/lang/String;
}

public final class dev/evo/elasticmagic/aggs/PercentileAggResult$Companion {
public final fun invoke (Ldev/evo/elasticmagic/serde/Deserializer$ObjectCtx;)Ldev/evo/elasticmagic/aggs/PercentileAggResult;
}

public final class dev/evo/elasticmagic/aggs/PercentilesAgg : dev/evo/elasticmagic/aggs/MetricAggregation {
public fun <init> (Ldev/evo/elasticmagic/query/FieldOperations;Ljava/util/List;)V
public synthetic fun <init> (Ldev/evo/elasticmagic/query/FieldOperations;Ljava/util/List;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
public fun clone ()Ldev/evo/elasticmagic/aggs/PercentilesAgg;
public synthetic fun clone ()Ldev/evo/elasticmagic/query/Expression;
public final fun component1 ()Ldev/evo/elasticmagic/query/FieldOperations;
public final fun component2 ()Ljava/util/List;
public final fun copy (Ldev/evo/elasticmagic/query/FieldOperations;Ljava/util/List;)Ldev/evo/elasticmagic/aggs/PercentilesAgg;
public static synthetic fun copy$default (Ldev/evo/elasticmagic/aggs/PercentilesAgg;Ldev/evo/elasticmagic/query/FieldOperations;Ljava/util/List;ILjava/lang/Object;)Ldev/evo/elasticmagic/aggs/PercentilesAgg;
public fun equals (Ljava/lang/Object;)Z
public final fun getField ()Ldev/evo/elasticmagic/query/FieldOperations;
public fun getName ()Ljava/lang/String;
public final fun getPercents ()Ljava/util/List;
public fun hashCode ()I
public synthetic fun processResult (Ldev/evo/elasticmagic/serde/Deserializer$ObjectCtx;)Ldev/evo/elasticmagic/aggs/AggregationResult;
public fun processResult (Ldev/evo/elasticmagic/serde/Deserializer$ObjectCtx;)Ldev/evo/elasticmagic/aggs/PercentileAggResult;
public fun toString ()Ljava/lang/String;
public fun visit (Ldev/evo/elasticmagic/serde/Serializer$ObjectCtx;Ldev/evo/elasticmagic/compile/BaseSearchQueryCompiler;)V
}

public final class dev/evo/elasticmagic/aggs/RangeAgg : dev/evo/elasticmagic/aggs/BaseRangeAgg {
public static final field Companion Ldev/evo/elasticmagic/aggs/RangeAgg$Companion;
public fun <init> (Ldev/evo/elasticmagic/aggs/AggValue;Ljava/util/List;Ljava/lang/String;Ljava/lang/Number;Ljava/util/Map;Ljava/util/Map;)V
Expand Down
47 changes: 43 additions & 4 deletions elasticmagic/src/commonMain/kotlin/dev/evo/elasticmagic/aggs/Metric.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ import dev.evo.elasticmagic.query.ObjExpression
import dev.evo.elasticmagic.query.Script
import dev.evo.elasticmagic.serde.Deserializer
import dev.evo.elasticmagic.serde.Serializer
import dev.evo.elasticmagic.serde.toMap
import dev.evo.elasticmagic.types.FieldType

@Suppress("UnnecessaryAbstractClass")
abstract class MetricAggregation<R: AggregationResult> : Aggregation<R>
abstract class MetricAggregation<R : AggregationResult> : Aggregation<R>

abstract class SingleValueMetricAggResult<T> : AggregationResult {
abstract val value: T
Expand Down Expand Up @@ -59,7 +60,7 @@ data class LongValueAggResult(
}
}

abstract class NumericValueAgg<T, R: AggregationResult>(
abstract class NumericValueAgg<T, R : AggregationResult>(
private val resultProcessor: (Deserializer.ObjectCtx) -> R
) : MetricAggregation<R>() {
abstract val value: AggValue<T>
Expand Down Expand Up @@ -117,6 +118,44 @@ data class MaxAgg<T>(
override fun clone() = copy()
}


data class PercentileAggResult(val values: Map<Double, Double>) : AggregationResult {
companion object {
operator fun invoke(obj: Deserializer.ObjectCtx): PercentileAggResult {
val values = obj.obj("values")
return PercentileAggResult(
values.toMap().filter { it.value is Double }.map { it.key.toDouble() to it.value as Double }.toMap()
)
}
}
}

data class PercentilesAgg(
val field: FieldOperations<*>,
val percents: List<Double>? = null,
) : MetricAggregation<PercentileAggResult>() {
override fun processResult(obj: Deserializer.ObjectCtx): PercentileAggResult {
return PercentileAggResult(obj)
}

override val name: String
get() = "percentiles"

override fun visit(ctx: Serializer.ObjectCtx, compiler: BaseSearchQueryCompiler) {
ctx.field("field", field.getQualifiedFieldName())
if (percents != null) {
ctx.array("percents") {
percents.forEach {
value(it)
}
}
}
}

override fun clone() = copy()

}

typealias MaxAggResult = OptionalDoubleValueAggResult

data class AvgAgg<T>(
Expand Down Expand Up @@ -188,7 +227,7 @@ data class WeightedAvgAgg<T>(

typealias WeightedAvgAggResult = OptionalDoubleValueAggResult

data class SumAgg<T: Number>(
data class SumAgg<T : Number>(
override val value: AggValue<T>,
override val missing: T? = null,
val format: String? = null,
Expand Down Expand Up @@ -363,7 +402,7 @@ data class ExtendedStatsAggResult(
sumOfSquares = obj.doubleOrNull("sum_of_squares"),
variance = obj.doubleOrNull("variance"),
stdDeviation = obj.doubleOrNull("std_deviation"),
stdDeviationBounds = ExtendedStatsAggResult.StdDeviationBounds(
stdDeviationBounds = StdDeviationBounds(
upper = stdDevBoundsRaw.doubleOrNull("upper"),
lower = stdDevBoundsRaw.doubleOrNull("lower"),
)
Expand Down
115 changes: 99 additions & 16 deletions elasticmagic/src/commonTest/kotlin/dev/evo/elasticmagic/aggs/MetricTests.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
package dev.evo.elasticmagic.aggs

import dev.evo.elasticmagic.types.FloatType
import dev.evo.elasticmagic.query.FieldOperations
import dev.evo.elasticmagic.query.Script
import dev.evo.elasticmagic.serde.platform
import dev.evo.elasticmagic.serde.Platform
import dev.evo.elasticmagic.serde.DeserializationException

import dev.evo.elasticmagic.serde.Platform
import dev.evo.elasticmagic.serde.platform
import dev.evo.elasticmagic.types.FloatType
import io.kotest.assertions.throwables.shouldThrow
import io.kotest.data.forAll
import io.kotest.data.headers
Expand All @@ -15,7 +14,6 @@ import io.kotest.data.table
import io.kotest.matchers.maps.shouldContainExactly
import io.kotest.matchers.nulls.shouldBeNull
import io.kotest.matchers.shouldBe

import kotlin.test.Test

class MetricTests : TestAggregation() {
Expand Down Expand Up @@ -59,6 +57,85 @@ class MetricTests : TestAggregation() {
}
}

@Test
fun percentile() {
val ratingAgg = PercentilesAgg(
MovieDoc.rating
)
ratingAgg.compile() shouldContainExactly mapOf(
"percentiles" to mapOf(
"field" to "rating"
)
)

val numRatingsAgg = PercentilesAgg(
MovieDoc.numRatings,
percents = listOf(25.0, 50.0, 75.0, 95.0, 99.0),
)

numRatingsAgg.compile() shouldContainExactly mapOf(
"percentiles" to mapOf(
"field" to "num_ratings",
"percents" to listOf(25.0, 50.0, 75.0, 95.0, 99.0),
)
)



shouldThrow<DeserializationException> {
process(
ratingAgg,
mapOf("values" to null)
)
}

process(
ratingAgg,
mapOf(
"values" to mapOf(
"1.0" to 0.9,
"5.0" to 1.1,
"25.0" to 2.2,
"50.0" to 3.3,
"75.0" to 4.4,
"95.0" to 5.5,
"99.0" to 6.6,
),
)
).let { res ->
res.values shouldBe mapOf(
1.0 to 0.9,
5.0 to 1.1,
25.0 to 2.2,
50.0 to 3.3,
75.0 to 4.4,
95.0 to 5.5,
99.0 to 6.6,
)
}

process(
numRatingsAgg,
mapOf(
"values" to mapOf(
"25.0" to 1.0,
"50.0" to 2.0,
"75.0" to 3.0,
"95.0" to 4.0,
"99.0" to 5.0,
),
)
).let { res ->
res.values shouldBe mapOf(
25.0 to 1.0,
50.0 to 2.0,
75.0 to 3.0,
95.0 to 4.0,
99.0 to 5.0,
)
}
}

@Test
fun sum() {
val agg = SumAgg(MovieDoc.rating, 0.0F)
Expand Down Expand Up @@ -207,27 +284,33 @@ class MetricTests : TestAggregation() {
)
)
agg.processResult(
deserializer.wrapObj(mapOf(
"value" to null
))
deserializer.wrapObj(
mapOf(
"value" to null
)
)
).let { res ->
res.value.shouldBeNull()
res.valueAsString.shouldBeNull()
}
agg.processResult(
deserializer.wrapObj(mapOf(
"value" to 2.2,
"value_as_string" to "2.2",
))
deserializer.wrapObj(
mapOf(
"value" to 2.2,
"value_as_string" to "2.2",
)
)
).let { res ->
res.value shouldBe 2.2
res.valueAsString shouldBe "2.2"
}
agg.processResult(
deserializer.wrapObj(mapOf(
"value" to 2,
"value_as_string" to "2",
))
deserializer.wrapObj(
mapOf(
"value" to 2,
"value_as_string" to "2",
)
)
).let { res ->
res.value shouldBe 2.0
res.valueAsString shouldBe "2"
Expand Down