Added a ConfigurationFUnction interface and fixed tests with static configurations

Author: ivancea

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/ConfigurationFunction.java

@@ -0,0 +1,28 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+package org.elasticsearch.xpack.esql.expression.function;
+
+/**
+ * Marker interface indicating that a function needs a Configuration object as its last parameter.
+ * <p>
+ *     Extend {@link org.elasticsearch.xpack.esql.expression.function.scalar.EsqlConfigurationFunction} instead if possible.
+ *     It automatically takes care of:
+ * </p>
+ * <ul>
+ *     <li>The Configuration field</li>
+ *     <li>HashCode</li>
+ *     <li>Equals</li>
+ * </ul>
+ * <p>
+ *     If overridden directly, take a look at {@link org.elasticsearch.xpack.esql.expression.function.scalar.EsqlConfigurationFunction}
+ *     and add or update the required methods.
+ * </p>
+ */
+public interface ConfigurationFunction {
+
+}

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/EsqlFunctionRegistry.java

@@ -70,7 +70,6 @@
 import org.elasticsearch.xpack.esql.expression.function.grouping.TBucket;
 import org.elasticsearch.xpack.esql.expression.function.inference.TextEmbedding;
 import org.elasticsearch.xpack.esql.expression.function.scalar.Clamp;
-import org.elasticsearch.xpack.esql.expression.function.scalar.EsqlConfigurationFunction;
 import org.elasticsearch.xpack.esql.expression.function.scalar.conditional.Case;
 import org.elasticsearch.xpack.esql.expression.function.scalar.conditional.ClampMax;
 import org.elasticsearch.xpack.esql.expression.function.scalar.conditional.ClampMin;
@@ -773,7 +772,7 @@ public static FunctionDescription description(FunctionDefinition def) {
         if (TimestampAware.class.isAssignableFrom(def.clazz())) {
             countOfParamsToDescribe--; // skip the implicit @timestamp parameter (last or last before Configuration)
         }
-        if (EsqlConfigurationFunction.class.isAssignableFrom(def.clazz())) {
+        if (ConfigurationFunction.class.isAssignableFrom(def.clazz())) {
             // this isn't enforced by the contract, but the convention is: func(..., Expression timestamp, Configuration config)
             assert Configuration.class.isAssignableFrom(params[params.length - 1].getType())
                 : "The configuration parameter must be the last argument of an EsqlConfigurationFunction definition";

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/grouping/Bucket.java

@@ -25,6 +25,7 @@
 import org.elasticsearch.xpack.esql.core.tree.Source;
 import org.elasticsearch.xpack.esql.core.type.DataType;
 import org.elasticsearch.xpack.esql.expression.Foldables;
+import org.elasticsearch.xpack.esql.expression.function.ConfigurationFunction;
 import org.elasticsearch.xpack.esql.expression.function.Example;
 import org.elasticsearch.xpack.esql.expression.function.FunctionInfo;
 import org.elasticsearch.xpack.esql.expression.function.FunctionType;
@@ -62,7 +63,8 @@
 public class Bucket extends GroupingFunction.EvaluatableGroupingFunction
     implements
         PostOptimizationVerificationAware,
-        TwoOptionalArguments {
+        TwoOptionalArguments,
+        ConfigurationFunction {
     public static final NamedWriteableRegistry.Entry ENTRY = new NamedWriteableRegistry.Entry(Expression.class, "Bucket", Bucket::new);
 
     // TODO maybe we should just cover the whole of representable dates here - like ten years, 100 years, 1000 years, all the way up.
@@ -88,12 +90,6 @@ public class Bucket extends GroupingFunction.EvaluatableGroupingFunction
         Rounding.builder(TimeValue.timeValueMillis(10)),
         Rounding.builder(TimeValue.timeValueMillis(1)), };
 
-    /*
-     * As Bucket already extends GroupingFunction, it can't extend EsqlConfigurationFunction, so we had to replicate here:
-     * - The Configuration field
-     * - HashCode
-     * - Equals
-     */
     private final Configuration configuration;
     private final Expression field;
     private final Expression buckets;

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/grouping/TBucket.java

@@ -14,6 +14,7 @@
 import org.elasticsearch.xpack.esql.core.tree.Source;
 import org.elasticsearch.xpack.esql.core.type.DataType;
 import org.elasticsearch.xpack.esql.expression.SurrogateExpression;
+import org.elasticsearch.xpack.esql.expression.function.ConfigurationFunction;
 import org.elasticsearch.xpack.esql.expression.function.Example;
 import org.elasticsearch.xpack.esql.expression.function.FunctionInfo;
 import org.elasticsearch.xpack.esql.expression.function.FunctionType;
@@ -32,15 +33,13 @@
 /**
  * Splits dates into a given number of buckets. The span is derived from a time range provided.
  */
-public class TBucket extends GroupingFunction.EvaluatableGroupingFunction implements SurrogateExpression, TimestampAware {
+public class TBucket extends GroupingFunction.EvaluatableGroupingFunction
+    implements
+        SurrogateExpression,
+        TimestampAware,
+        ConfigurationFunction {
     public static final String NAME = "TBucket";
 
-    /*
-     * As Bucket already extends GroupingFunction, it can't extend EsqlConfigurationFunction, so we had to replicate here:
-     * - The Configuration field
-     * - HashCode
-     * - Equals
-     */
     private final Configuration configuration;
     private final Expression buckets;
     private final Expression timestamp;

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/EsqlConfigurationFunction.java

@@ -9,12 +9,19 @@
 
 import org.elasticsearch.xpack.esql.core.expression.Expression;
 import org.elasticsearch.xpack.esql.core.tree.Source;
+import org.elasticsearch.xpack.esql.expression.function.ConfigurationFunction;
 import org.elasticsearch.xpack.esql.session.Configuration;
 
 import java.util.List;
 import java.util.Objects;
 
-public abstract class EsqlConfigurationFunction extends EsqlScalarFunction {
+/**
+ * Implementation of {@link ConfigurationFunction}.
+ * <p>
+ *     Extend this class if possible instead of the base interface.
+ * </p>
+ */
+public abstract class EsqlConfigurationFunction extends EsqlScalarFunction implements ConfigurationFunction {
 
     private final Configuration configuration;
 

x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/grouping/BucketTests.java

@@ -114,7 +114,7 @@ private static void dateCases(List<TestCaseSupplier> suppliers, String name, Lon
                             + "rounding=Rounding[DAY_OF_MONTH in Z][fixed to midnight]]",
                         DataType.DATETIME,
                         resultsMatcher(args)
-                    );
+                    ).withStaticConfiguration();
                 }));
                 // same as above, but a low bucket count and datetime bounds that match it (at hour span)
                 suppliers.add(new TestCaseSupplier(name, List.of(DataType.DATETIME, DataType.INTEGER, fromType, toType), () -> {
@@ -128,7 +128,7 @@ private static void dateCases(List<TestCaseSupplier> suppliers, String name, Lon
                         "DateTruncDatetimeEvaluator[fieldVal=Attribute[channel=0], rounding=Rounding[3600000 in Z][fixed]]",
                         DataType.DATETIME,
                         equalTo(Rounding.builder(Rounding.DateTimeUnit.HOUR_OF_DAY).build().prepareForUnknown().round(date.getAsLong()))
-                    );
+                    ).withStaticConfiguration();
                 }));
             }
         }
@@ -161,7 +161,7 @@ private static void dateCasesWithSpan(
                 "DateTruncDatetimeEvaluator[fieldVal=Attribute[channel=0], rounding=Rounding" + spanStr + "]",
                 DataType.DATETIME,
                 resultsMatcher(args)
-            );
+            ).withStaticConfiguration();
         }));
     }
 
@@ -182,7 +182,7 @@ private static void dateNanosCasesWithSpan(
                 Matchers.startsWith("DateTruncDateNanosEvaluator[fieldVal=Attribute[channel=0], rounding=Rounding["),
                 DataType.DATE_NANOS,
                 resultsMatcher(args)
-            );
+            ).withStaticConfiguration();
         }));
     }
 
@@ -201,7 +201,7 @@ private static void dateNanosCases(List<TestCaseSupplier> suppliers, String name
                         Matchers.startsWith("DateTruncDateNanosEvaluator[fieldVal=Attribute[channel=0], rounding=Rounding["),
                         DataType.DATE_NANOS,
                         resultsMatcher(args)
-                    );
+                    ).withStaticConfiguration();
                 }));
                 // same as above, but a low bucket count and datetime bounds that match it (at hour span)
                 suppliers.add(new TestCaseSupplier(name, List.of(DataType.DATE_NANOS, DataType.INTEGER, fromType, toType), () -> {
@@ -215,7 +215,7 @@ private static void dateNanosCases(List<TestCaseSupplier> suppliers, String name
                         Matchers.startsWith("DateTruncDateNanosEvaluator[fieldVal=Attribute[channel=0], rounding=Rounding["),
                         DataType.DATE_NANOS,
                         equalTo(Rounding.builder(Rounding.DateTimeUnit.HOUR_OF_DAY).build().prepareForUnknown().round(date.getAsLong()))
-                    );
+                    ).withStaticConfiguration();
                 }));
             }
         }

x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/grouping/TBucketTests.java

@@ -95,7 +95,7 @@ private static void dateCasesWithSpan(
                 "DateTruncDatetimeEvaluator[fieldVal=Attribute[channel=0], rounding=Rounding" + spanStr + "]",
                 DataType.DATETIME,
                 resultsMatcher(args)
-            );
+            ).withStaticConfiguration();
         }));
     }
 
@@ -115,7 +115,7 @@ private static void dateNanosCasesWithSpan(
                 Matchers.startsWith("DateTruncDateNanosEvaluator[fieldVal=Attribute[channel=0], rounding=Rounding["),
                 DataType.DATE_NANOS,
                 resultsMatcher(args)
-            );
+            ).withStaticConfiguration();
         }));
     }
 

x-pack/plugin/esql/src/test/java/org/elasticsearch/xpack/esql/expression/function/scalar/date/DateTruncTests.java

@@ -76,7 +76,7 @@ private static List<TestCaseSupplier> ofDatePeriod(Period period, long value, St
                     Matchers.startsWith("DateTruncDatetimeEvaluator[fieldVal=Attribute[channel=0], rounding=Rounding["),
                     DataType.DATETIME,
                     equalTo(toMillis(expectedDate))
-                )
+                ).withStaticConfiguration()
             ),
             new TestCaseSupplier(
                 List.of(DataType.DATE_PERIOD, DataType.DATE_NANOS),
@@ -88,7 +88,7 @@ private static List<TestCaseSupplier> ofDatePeriod(Period period, long value, St
                     Matchers.startsWith("DateTruncDateNanosEvaluator[fieldVal=Attribute[channel=0], rounding=Rounding["),
                     DataType.DATE_NANOS,
                     equalTo(toNanos(expectedDate))
-                )
+                ).withStaticConfiguration()
             )
         );
     }
@@ -105,7 +105,7 @@ private static List<TestCaseSupplier> ofDuration(Duration duration, long value,
                     Matchers.startsWith("DateTruncDatetimeEvaluator[fieldVal=Attribute[channel=0], rounding=Rounding["),
                     DataType.DATETIME,
                     equalTo(toMillis(expectedDate))
-                )
+                ).withStaticConfiguration()
             ),
             new TestCaseSupplier(
                 List.of(DataType.TIME_DURATION, DataType.DATE_NANOS),
@@ -117,7 +117,7 @@ private static List<TestCaseSupplier> ofDuration(Duration duration, long value,
                     Matchers.startsWith("DateTruncDateNanosEvaluator[fieldVal=Attribute[channel=0], rounding=Rounding["),
                     DataType.DATE_NANOS,
                     equalTo(toNanos(expectedDate))
-                )
+                ).withStaticConfiguration()
             )
         );
     }