Support optional function score variant (opensearch-project#880)

* Support optional function score variant This commit supports function score functions with an optional function variant. The function is optional as it is perfectly valid to have a function with only a weight e.g. a function score query with multiple functions and a score mode of "first", where the last weight function acts as some default value. Closes opensearch-project#820 Signed-off-by: Russ Cam <[email protected]> * Address CI build issues Signed-off-by: Russ Cam <[email protected]> * remove changelog entry for 3.0 Signed-off-by: Russ Cam <[email protected]> --------- Signed-off-by: Russ Cam <[email protected]>
Xtansia · Feb 27, 2024 · 045c805 · 045c805
1 parent 0c88a6a
commit 045c805
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -43,6 +43,7 @@ This section is for maintaining a changelog for all breaking changes for the cli
 
 ### Fixed
 - Fix integer overflow for variables in indices stats response ([#877](https://github.com/opensearch-project/opensearch-java/pull/877))
+- Support weight function in function score query ([#880](https://github.com/opensearch-project/opensearch-java/pull/880))
 
 ### Security
 

diff --git a/...client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/FunctionScore.java b/...client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/FunctionScore.java
@@ -106,20 +106,28 @@ public final Object _get() {
     @Nullable
     private final Double weight;
 
-    public FunctionScore(FunctionScoreVariant value) {
-
-        this._kind = ApiTypeHelper.requireNonNull(value._functionScoreKind(), this, "<variant kind>");
-        this._value = ApiTypeHelper.requireNonNull(value, this, "<variant value>");
+    public FunctionScore(@Nullable FunctionScoreVariant value) {
+        if (value != null) {
+            this._kind = ApiTypeHelper.requireNonNull(value._functionScoreKind(), this, "<variant kind>");
+            this._value = ApiTypeHelper.requireNonNull(value, this, "<variant value>");
+        } else {
+            this._kind = null;
+            this._value = null;
+        }
 
         this.filter = null;
         this.weight = null;
 
     }
 
     private FunctionScore(Builder builder) {
-
-        this._kind = ApiTypeHelper.requireNonNull(builder._kind, builder, "<variant kind>");
-        this._value = ApiTypeHelper.requireNonNull(builder._value, builder, "<variant value>");
+        if (builder._value != null) {
+            this._kind = ApiTypeHelper.requireNonNull(builder._kind, builder, "<variant kind>");
+            this._value = ApiTypeHelper.requireNonNull(builder._value, builder, "<variant value>");
+        } else {
+            this._kind = null;
+            this._value = null;
+        }
 
         this.filter = builder.filter;
         this.weight = builder.weight;
@@ -266,9 +274,11 @@ public void serialize(JsonGenerator generator, JsonpMapper mapper) {
 
         }
 
-        generator.writeKey(_kind.jsonValue());
-        if (_value instanceof JsonpSerializable) {
-            ((JsonpSerializable) _value).serialize(generator, mapper);
+        if (_value != null) {
+            generator.writeKey(_kind.jsonValue());
+            if (_value instanceof JsonpSerializable) {
+                ((JsonpSerializable) _value).serialize(generator, mapper);
+            }
         }
 
         generator.writeEnd();
@@ -279,8 +289,10 @@ public Builder toBuilder() {
         return new Builder()._kind(_kind)._value(_value).filter(filter).weight(weight);
     }
 
-    public static class Builder extends ObjectBuilderBase {
+    public static class Builder extends ObjectBuilderBase implements ObjectBuilder<FunctionScore> {
+        @Nullable
         private Kind _kind;
+        @Nullable
         private Object _value;
 
         @Nullable
@@ -289,12 +301,12 @@ public static class Builder extends ObjectBuilderBase {
         @Nullable
         private Double weight;
 
-        protected final Builder _kind(Kind v) {
+        protected final Builder _kind(@Nullable Kind v) {
             this._kind = v;
             return this;
         }
 
-        protected final Builder _value(Object v) {
+        protected final Builder _value(@Nullable Object v) {
             this._value = v;
             return this;
         }
@@ -384,7 +396,7 @@ public ContainerBuilder scriptScore(Function<ScriptScoreFunction.Builder, Object
             return this.scriptScore(fn.apply(new ScriptScoreFunction.Builder()).build());
         }
 
-        protected FunctionScore build() {
+        public FunctionScore build() {
             _checkSingleUse();
             return new FunctionScore(this);
         }

diff --git a/...c/test/java/org/opensearch/client/opensearch/_types/query_dsl/FunctionScoreQueryTest.java b/...c/test/java/org/opensearch/client/opensearch/_types/query_dsl/FunctionScoreQueryTest.java
@@ -11,4 +11,35 @@ public void toBuilder() {
 
         assertEquals(toJson(copied), toJson(origin));
     }
+
+    @Test
+    public void canSupportWeightFunction() {
+        Query functionScoreQuery = FunctionScoreQuery.of(fs -> fs.functions(f -> f.weight(5d)))._toQuery();
+
+        String json = "{\"function_score\":{\"functions\":[{\"weight\":5.0}]}}";
+
+        assertEquals(json, toJson(functionScoreQuery));
+
+        Query roundtripQuery = checkJsonRoundtrip(functionScoreQuery, json);
+
+        assertNull(roundtripQuery.functionScore().functions().get(0)._kind());
+        assertEquals(5.0, roundtripQuery.functionScore().functions().get(0).weight(), 0.001);
+    }
+
+    @Test
+    public void canSupportFunctionVariant() {
+        Query functionScoreQuery = FunctionScoreQuery.of(
+            fs -> fs.functions(f -> f.weight(3d).linear(l -> l.field("field").placement(p -> p.decay(8.0))))
+        )._toQuery();
+
+        String json = "{\"function_score\":{\"functions\":[{\"weight\":3.0,\"linear\":{\"field\":{\"decay\":8.0}}}]}}";
+
+        assertEquals(json, toJson(functionScoreQuery));
+
+        Query roundtripQuery = checkJsonRoundtrip(functionScoreQuery, json);
+
+        assertEquals(FunctionScore.Kind.Linear, roundtripQuery.functionScore().functions().get(0)._kind());
+        assertEquals(3.0, roundtripQuery.functionScore().functions().get(0).weight(), 0.001);
+        assertEquals(8.0, roundtripQuery.functionScore().functions().get(0).linear().placement().decay(), 0.001);
+    }
 }