Fix queries losing inherited data when toBuilder is called. (#1181)

* Fixes #1172

Calling `toBuilder` on classes which implement `QueryBase` will now preserve `boost` and `queryName`.

Signed-off-by: Chris Danisch <[email protected]>

* Updated changelog

Signed-off-by: Chris Danisch <[email protected]>

* Added toBuilder to QueryBase instead.

Signed-off-by: Chris Danisch <[email protected]>

---------

Signed-off-by: Chris Danisch <[email protected]>
(cherry picked from commit 020e0b0)
Signed-off-by: Thomas Farr <[email protected]>

CHANGELOG.md

@@ -14,6 +14,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Removed
 
 ### Fixed
+- Fix queries not preserving boost and name when converted to builders ([#1181](https://github.com/opensearch-project/opensearch-java/pull/1181))
 
 ### Security
 

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/BoolQuery.java

@@ -172,7 +172,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().filter(filter).minimumShouldMatch(minimumShouldMatch).must(must).mustNot(mustNot).should(should);
+        return toBuilder(new Builder()).filter(filter).minimumShouldMatch(minimumShouldMatch).must(must).mustNot(mustNot).should(should);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/BoostingQuery.java

@@ -111,7 +111,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().negativeBoost(negativeBoost).negative(negative).positive(positive);
+        return toBuilder(new Builder()).negativeBoost(negativeBoost).negative(negative).positive(positive);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/CombinedFieldsQuery.java

@@ -174,7 +174,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().fields(fields)
+        return toBuilder(new Builder()).fields(fields)
             .query(query)
             .autoGenerateSynonymsPhraseQuery(autoGenerateSynonymsPhraseQuery)
             .operator(operator)

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/CommonTermsQuery.java

@@ -183,7 +183,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().field(field)
+        return toBuilder(new Builder()).field(field)
             .analyzer(analyzer)
             .cutoffFrequency(cutoffFrequency)
             .highFreqOperator(highFreqOperator)

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/ConstantScoreQuery.java

@@ -85,7 +85,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().filter(filter);
+        return toBuilder(new Builder()).filter(filter);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/DisMaxQuery.java

@@ -112,7 +112,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().queries(queries).tieBreaker(tieBreaker);
+        return toBuilder(new Builder()).queries(queries).tieBreaker(tieBreaker);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/DistanceFeatureQuery.java

@@ -112,7 +112,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().origin(origin).pivot(pivot).field(field);
+        return toBuilder(new Builder()).origin(origin).pivot(pivot).field(field);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/ExistsQuery.java

@@ -85,7 +85,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().field(field);
+        return toBuilder(new Builder()).field(field);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/FunctionScoreQuery.java

@@ -178,7 +178,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().boostMode(boostMode)
+        return toBuilder(new Builder()).boostMode(boostMode)
             .functions(functions)
             .maxBoost(maxBoost)
             .minScore(minScore)

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/FuzzyQuery.java

@@ -186,7 +186,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().field(field)
+        return toBuilder(new Builder()).field(field)
             .value(value)
             .maxExpansions(maxExpansions)
             .prefixLength(prefixLength)

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/GeoBoundingBoxQuery.java

@@ -149,7 +149,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().field(field)
+        return toBuilder(new Builder()).field(field)
             .boundingBox(boundingBox)
             .type(type)
             .validationMethod(validationMethod)

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/GeoDistanceQuery.java

@@ -147,7 +147,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().field(field).location(location);
+        return toBuilder(new Builder()).field(field).location(location);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/GeoShapeQuery.java

@@ -113,7 +113,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().field(field).shape(shape);
+        return toBuilder(new Builder()).field(field).shape(shape);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/HasChildQuery.java

@@ -184,7 +184,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().ignoreUnmapped(ignoreUnmapped)
+        return toBuilder(new Builder()).ignoreUnmapped(ignoreUnmapped)
             .innerHits(innerHits)
             .maxChildren(maxChildren)
             .minChildren(minChildren)

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/HasParentQuery.java

@@ -152,7 +152,11 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().ignoreUnmapped(ignoreUnmapped).innerHits(innerHits).parentType(parentType).query(query).score(score);
+        return toBuilder(new Builder()).ignoreUnmapped(ignoreUnmapped)
+            .innerHits(innerHits)
+            .parentType(parentType)
+            .query(query)
+            .score(score);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/HybridQuery.java

@@ -56,7 +56,7 @@ public Query.Kind _queryKind() {
     }
 
     public HybridQuery.Builder toBuilder() {
-        return new HybridQuery.Builder().queries(queries);
+        return toBuilder(new Builder()).queries(queries);
     }
 
     public static class Builder extends QueryBase.AbstractBuilder<HybridQuery.Builder> implements ObjectBuilder<HybridQuery> {

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/IdsQuery.java

@@ -95,7 +95,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().values(values);
+        return toBuilder(new Builder()).values(values);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/IntervalsQuery.java

@@ -252,7 +252,7 @@ public void serialize(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder()._kind(_kind)._value(_value).field(field);
+        return toBuilder(new Builder())._kind(_kind)._value(_value).field(field);
     }
 
     public static class Builder extends QueryBase.AbstractBuilder<Builder> implements ObjectBuilder<IntervalsQuery> {

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/KnnQuery.java

@@ -108,7 +108,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().field(field).vector(vector).k(k).filter(filter);
+        return toBuilder(new Builder()).field(field).vector(vector).k(k).filter(filter);
     }
 
     /**

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/MatchBoolPrefixQuery.java

@@ -235,7 +235,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().field(field)
+        return toBuilder(new Builder()).field(field)
             .analyzer(analyzer)
             .fuzziness(fuzziness)
             .fuzzyRewrite(fuzzyRewrite)

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/MatchPhrasePrefixQuery.java

@@ -168,7 +168,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().field(field)
+        return toBuilder(new Builder()).field(field)
             .analyzer(analyzer)
             .maxExpansions(maxExpansions)
             .query(query)

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/MatchPhraseQuery.java

@@ -151,7 +151,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().field(field).analyzer(analyzer).query(query).slop(slop).zeroTermsQuery(zeroTermsQuery);
+        return toBuilder(new Builder()).field(field).analyzer(analyzer).query(query).slop(slop).zeroTermsQuery(zeroTermsQuery);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/MatchQuery.java

@@ -307,7 +307,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().field(field)
+        return toBuilder(new Builder()).field(field)
             .analyzer(analyzer)
             .autoGenerateSynonymsPhraseQuery(autoGenerateSynonymsPhraseQuery)
             .cutoffFrequency(cutoffFrequency)

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/MoreLikeThisQuery.java

@@ -415,7 +415,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().analyzer(analyzer)
+        return toBuilder(new Builder()).analyzer(analyzer)
             .boostTerms(boostTerms)
             .failOnUnsupportedField(failOnUnsupportedField)
             .fields(fields)

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/MultiMatchQuery.java

@@ -363,7 +363,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().analyzer(analyzer)
+        return toBuilder(new Builder()).analyzer(analyzer)
             .autoGenerateSynonymsPhraseQuery(autoGenerateSynonymsPhraseQuery)
             .cutoffFrequency(cutoffFrequency)
             .fields(fields)

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/NestedQuery.java

@@ -151,7 +151,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().ignoreUnmapped(ignoreUnmapped).innerHits(innerHits).path(path).query(query).scoreMode(scoreMode);
+        return toBuilder(new Builder()).ignoreUnmapped(ignoreUnmapped).innerHits(innerHits).path(path).query(query).scoreMode(scoreMode);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/NeuralQuery.java

@@ -152,7 +152,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().field(field).queryText(queryText).queryImage(queryImage).k(k).modelId(modelId).filter(filter);
+        return toBuilder(new Builder()).field(field).queryText(queryText).queryImage(queryImage).k(k).modelId(modelId).filter(filter);
     }
 
     /**

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/ParentIdQuery.java

@@ -124,7 +124,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().id(id).ignoreUnmapped(ignoreUnmapped).type(type);
+        return toBuilder(new Builder()).id(id).ignoreUnmapped(ignoreUnmapped).type(type);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/PercolateQuery.java

@@ -228,7 +228,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().document(document)
+        return toBuilder(new Builder()).document(document)
             .documents(documents)
             .field(field)
             .id(id)

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/PinnedQuery.java

@@ -197,7 +197,7 @@ public void serialize(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder()._kind(_kind)._value(_value).organic(organic);
+        return toBuilder(new Builder())._kind(_kind)._value(_value).organic(organic);
     }
 
     public static class Builder extends QueryBase.AbstractBuilder<Builder> {

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/PrefixQuery.java

@@ -135,7 +135,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().field(field).value(value).rewrite(rewrite).value(value).caseInsensitive(caseInsensitive);
+        return toBuilder(new Builder()).field(field).value(value).rewrite(rewrite).value(value).caseInsensitive(caseInsensitive);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/QueryBase.java

@@ -98,6 +98,10 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
 
     }
 
+    protected <BuilderT extends AbstractBuilder<BuilderT>> BuilderT toBuilder(BuilderT builder) {
+        return builder.queryName(queryName).boost(boost);
+    }
+
     protected abstract static class AbstractBuilder<BuilderT extends AbstractBuilder<BuilderT>> extends ObjectBuilderBase {
         @Nullable
         private Float boost;

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/QueryStringQuery.java

@@ -497,7 +497,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().allowLeadingWildcard(allowLeadingWildcard)
+        return toBuilder(new Builder()).allowLeadingWildcard(allowLeadingWildcard)
             .analyzer(analyzer)
             .analyzeWildcard(analyzeWildcard)
             .autoGenerateSynonymsPhraseQuery(autoGenerateSynonymsPhraseQuery)

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/RangeQuery.java

@@ -225,7 +225,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().field(field).gt(gt).gte(gte).lt(lt).lte(lte).from(from).to(to).format(format).timeZone(timeZone);
+        return toBuilder(new Builder()).field(field).gt(gt).gte(gte).lt(lt).lte(lte).from(from).to(to).format(format).timeZone(timeZone);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/RankFeatureQuery.java

@@ -155,7 +155,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().field(field).saturation(saturation).log(log).linear(linear).sigmoid(sigmoid);
+        return toBuilder(new Builder()).field(field).saturation(saturation).log(log).linear(linear).sigmoid(sigmoid);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/RegexpQuery.java

@@ -168,7 +168,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().field(field)
+        return toBuilder(new Builder()).field(field)
             .value(value)
             .caseInsensitive(caseInsensitive)
             .flags(flags)

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/ScriptQuery.java

@@ -86,7 +86,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().script(script);
+        return toBuilder(new Builder()).script(script);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/ScriptScoreQuery.java

@@ -117,7 +117,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().minScore(minScore).query(query).script(script);
+        return toBuilder(new Builder()).minScore(minScore).query(query).script(script);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/SimpleQueryStringQuery.java

@@ -294,7 +294,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().analyzer(analyzer)
+        return toBuilder(new Builder()).analyzer(analyzer)
             .analyzeWildcard(analyzeWildcard)
             .autoGenerateSynonymsPhraseQuery(autoGenerateSynonymsPhraseQuery)
             .defaultOperator(defaultOperator)

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/SpanContainingQuery.java

@@ -106,7 +106,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().big(big).little(little);
+        return toBuilder(new Builder()).big(big).little(little);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/SpanFieldMaskingQuery.java

@@ -106,7 +106,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().field(field).query(query);
+        return toBuilder(new Builder()).field(field).query(query);
     }
 
     // ---------------------------------------------------------------------------------------------

java-client/src/main/java/org/opensearch/client/opensearch/_types/query_dsl/SpanFirstQuery.java

@@ -106,7 +106,7 @@ protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
     }
 
     public Builder toBuilder() {
-        return new Builder().end(end).match(match);
+        return toBuilder(new Builder()).end(end).match(match);
     }
 
     // ---------------------------------------------------------------------------------------------