Implement WithFieldName interface in ValuesSourceAggregationBuilder &…

… FieldSortBuilder (opensearch-project#15916) Signed-off-by: David Zane <[email protected]> (cherry picked from commit 7c427d9)
dzane17 · Sep 18, 2024 · ff49481 · ff49481
1 parent 79867fb
commit ff49481
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - [Offline Nodes] Adds offline-tasks library containing various interfaces to be used for Offline Background Tasks. ([#13574](https://github.com/opensearch-project/OpenSearch/pull/13574))
 - Add path prefix support to hashed prefix snapshots ([#15664](https://github.com/opensearch-project/OpenSearch/pull/15664))
 - [Workload Management] QueryGroup resource cancellation framework changes ([#15651](https://github.com/opensearch-project/OpenSearch/pull/15651))
+- Implement WithFieldName interface in ValuesSourceAggregationBuilder & FieldSortBuilder ([#15916](https://github.com/opensearch-project/OpenSearch/pull/15916))
 
 ### Dependencies
 - Bump `org.apache.logging.log4j:log4j-core` from 2.23.1 to 2.24.0 ([#15858](https://github.com/opensearch-project/OpenSearch/pull/15858))

diff --git a/.../main/java/org/opensearch/search/aggregations/support/ValuesSourceAggregationBuilder.java b/.../main/java/org/opensearch/search/aggregations/support/ValuesSourceAggregationBuilder.java
@@ -43,6 +43,7 @@
 import org.opensearch.core.xcontent.XContentBuilder;
 import org.opensearch.core.xcontent.XContentParser;
 import org.opensearch.index.query.QueryShardContext;
+import org.opensearch.index.query.WithFieldName;
 import org.opensearch.script.Script;
 import org.opensearch.search.aggregations.AbstractAggregationBuilder;
 import org.opensearch.search.aggregations.AggregationInitializationException;
@@ -60,7 +61,9 @@
  *
  * @opensearch.internal
  */
-public abstract class ValuesSourceAggregationBuilder<AB extends ValuesSourceAggregationBuilder<AB>> extends AbstractAggregationBuilder<AB> {
+public abstract class ValuesSourceAggregationBuilder<AB extends ValuesSourceAggregationBuilder<AB>> extends AbstractAggregationBuilder<AB>
+    implements
+        WithFieldName {
 
     public static <T> void declareFields(
         AbstractObjectParser<? extends ValuesSourceAggregationBuilder<?>, T> objectParser,
@@ -303,6 +306,11 @@ public String field() {
         return field;
     }
 
+    @Override
+    public String fieldName() {
+        return field();
+    }
+
     /**
      * Sets the script to use for this aggregation.
      */

diff --git a/server/src/main/java/org/opensearch/search/sort/FieldSortBuilder.java b/server/src/main/java/org/opensearch/search/sort/FieldSortBuilder.java
@@ -66,6 +66,7 @@
 import org.opensearch.index.query.QueryRewriteContext;
 import org.opensearch.index.query.QueryShardContext;
 import org.opensearch.index.query.QueryShardException;
+import org.opensearch.index.query.WithFieldName;
 import org.opensearch.search.DocValueFormat;
 import org.opensearch.search.MultiValueMode;
 import org.opensearch.search.SearchSortValuesAndFormats;
@@ -87,7 +88,7 @@
  *
  * @opensearch.internal
  */
-public class FieldSortBuilder extends SortBuilder<FieldSortBuilder> {
+public class FieldSortBuilder extends SortBuilder<FieldSortBuilder> implements WithFieldName {
     private static final DeprecationLogger deprecationLogger = DeprecationLogger.getLogger(FieldSortBuilder.class);
 
     public static final String NAME = "field_sort";
@@ -189,6 +190,11 @@ public String getFieldName() {
         return this.fieldName;
     }
 
+    @Override
+    public String fieldName() {
+        return getFieldName();
+    }
+
     /**
      * Sets the value when a field is missing in a doc. Can also be set to {@code _last} or
      * {@code _first} to sort missing last or first respectively.

diff --git a/...st/java/org/opensearch/search/aggregations/bucket/range/RangeAggregationBuilderTests.java b/...st/java/org/opensearch/search/aggregations/bucket/range/RangeAggregationBuilderTests.java
@@ -128,6 +128,7 @@ public void testNumericKeys() throws IOException {
         );
         assertThat(builder.getName(), equalTo("test"));
         assertThat(builder.field(), equalTo("f"));
+        assertThat(builder.fieldName(), equalTo("f"));
         assertThat(builder.ranges, equalTo(List.of(new RangeAggregator.Range("1", null, 0d))));
     }
 }
diff --git a/server/src/test/java/org/opensearch/search/sort/FieldSortBuilderTests.java b/server/src/test/java/org/opensearch/search/sort/FieldSortBuilderTests.java
@@ -196,6 +196,7 @@ protected void sortFieldAssertions(FieldSortBuilder builder, SortField sortField
         assertEquals(builder.order() == SortOrder.ASC ? false : true, sortField.getReverse());
         if (expectedType == SortField.Type.CUSTOM) {
             assertEquals(builder.getFieldName(), sortField.getField());
+            assertEquals(builder.fieldName(), sortField.getField());
         }
         assertEquals(DocValueFormat.RAW, format);
     }