Merge remote-tracking branch 'upstream/main' into decommission/transp…

…ort-fix
opensearch-project · Jan 26, 2023 · 6fc708d · 6fc708d
2 parents 99ae759 + f9eb9bf
commit 6fc708d
Show file tree

Hide file tree

Showing 161 changed files with 418 additions and 251 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -47,6 +47,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Migrate client transports to Apache HttpClient / Core 5.x ([#4459](https:/opensearch-project/OpenSearch/pull/4459))
 - Changed http code on create index API with bad input raising NotXContentException from 500 to 400 ([#4773](https:/opensearch-project/OpenSearch/pull/4773))
 - Change http code for DecommissioningFailedException from 500 to 400 ([#5283](https:/opensearch-project/OpenSearch/pull/5283))
+- Require MediaType in Strings.toString API ([#6009](https:/opensearch-project/OpenSearch/pull/6009))
 
 ### Deprecated
 
@@ -98,4 +99,4 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ### Security
 
 [Unreleased 3.0]: https:/opensearch-project/OpenSearch/compare/2.x...HEAD
-[Unreleased 2.x]: https:/opensearch-project/OpenSearch/compare/2.5...2.x
+[Unreleased 2.x]: https:/opensearch-project/OpenSearch/compare/2.5...2.x
diff --git a/build.gradle b/build.gradle
@@ -315,6 +315,10 @@ allprojects {
  // see https://discuss.gradle.org/t/add-custom-javadoc-option-that-does-not-take-an-argument/5959
  javadoc.options.encoding = 'UTF8'
  javadoc.options.addStringOption('Xdoclint:all,-missing', '-quiet')
+ boolean failOnJavadocWarning = project.ext.has('failOnJavadocWarning') ? project.ext.get('failOnJavadocWarning') : true
+ if (failOnJavadocWarning) {
+ javadoc.options.addStringOption('Xwerror', '-quiet')
+ }
  javadoc.options.tags = ["opensearch.internal", "opensearch.api", "opensearch.experimental"]
  javadoc.options.addStringOption("-release", targetCompatibility.majorVersion)
  }

diff --git a/client/rest-high-level/src/main/java/org/opensearch/client/slm/SnapshotLifecyclePolicy.java b/client/rest-high-level/src/main/java/org/opensearch/client/slm/SnapshotLifecyclePolicy.java
@@ -39,6 +39,7 @@
 import org.opensearch.common.xcontent.ToXContentObject;
 import org.opensearch.common.xcontent.XContentBuilder;
 import org.opensearch.common.xcontent.XContentParser;
+import org.opensearch.common.xcontent.XContentType;
 
 import java.io.IOException;
 import java.util.Map;
@@ -168,6 +169,6 @@ public boolean equals(Object obj) {
 
  @Override
  public String toString() {
- return Strings.toString(this);
+ return Strings.toString(XContentType.JSON, this);
  }
 }
diff --git a/...t-high-level/src/main/java/org/opensearch/client/slm/SnapshotLifecyclePolicyMetadata.java b/...t-high-level/src/main/java/org/opensearch/client/slm/SnapshotLifecyclePolicyMetadata.java
@@ -39,6 +39,7 @@
 import org.opensearch.common.xcontent.ToXContentObject;
 import org.opensearch.common.xcontent.XContentBuilder;
 import org.opensearch.common.xcontent.XContentParser;
+import org.opensearch.common.xcontent.XContentType;
 import org.opensearch.snapshots.SnapshotId;
 
 import java.io.IOException;
@@ -288,7 +289,7 @@ public boolean equals(Object obj) {
 
  @Override
  public String toString() {
- return Strings.toString(this);
+ return Strings.toString(XContentType.JSON, this);
  }
  }
 }
diff --git a/client/rest-high-level/src/main/java/org/opensearch/client/slm/SnapshotLifecycleStats.java b/client/rest-high-level/src/main/java/org/opensearch/client/slm/SnapshotLifecycleStats.java
@@ -40,6 +40,7 @@
 import org.opensearch.common.xcontent.ToXContentObject;
 import org.opensearch.common.xcontent.XContentBuilder;
 import org.opensearch.common.xcontent.XContentParser;
+import org.opensearch.common.xcontent.XContentType;
 
 import java.io.IOException;
 import java.util.Collections;
@@ -187,7 +188,7 @@ public boolean equals(Object obj) {
 
  @Override
  public String toString() {
- return Strings.toString(this);
+ return Strings.toString(XContentType.JSON, this);
  }
 
  public static class SnapshotPolicyStats implements ToXContentFragment {

diff --git a/...st-high-level/src/main/java/org/opensearch/client/slm/SnapshotRetentionConfiguration.java b/...st-high-level/src/main/java/org/opensearch/client/slm/SnapshotRetentionConfiguration.java
@@ -40,6 +40,7 @@
 import org.opensearch.common.xcontent.ToXContentObject;
 import org.opensearch.common.xcontent.XContentBuilder;
 import org.opensearch.common.xcontent.XContentParser;
+import org.opensearch.common.xcontent.XContentType;
 
 import java.io.IOException;
 import java.util.Objects;
@@ -150,6 +151,6 @@ public boolean equals(Object obj) {
 
  @Override
  public String toString() {
- return Strings.toString(this);
+ return Strings.toString(XContentType.JSON, this);
  }
 }
diff --git a/...ution/archives/integ-test-zip/src/test/java/org/opensearch/test/rest/NodeRestUsageIT.java b/...ution/archives/integ-test-zip/src/test/java/org/opensearch/test/rest/NodeRestUsageIT.java
@@ -36,6 +36,7 @@
 import org.opensearch.client.Response;
 import org.opensearch.client.ResponseException;
 import org.opensearch.common.Strings;
+import org.opensearch.common.xcontent.XContentType;
 import org.opensearch.search.aggregations.AggregationBuilders;
 import org.opensearch.search.builder.SearchSourceBuilder;
 
@@ -171,8 +172,8 @@ public void testAggregationUsage() throws IOException {
  .aggregation(AggregationBuilders.terms("str_terms").field("str.keyword"))
  .aggregation(AggregationBuilders.terms("num_terms").field("num"))
  .aggregation(AggregationBuilders.avg("num_avg").field("num"));
- searchRequest.setJsonEntity(Strings.toString(searchSource));
- searchRequest.setJsonEntity(Strings.toString(searchSource));
+ searchRequest.setJsonEntity(Strings.toString(XContentType.JSON, searchSource));
+ searchRequest.setJsonEntity(Strings.toString(XContentType.JSON, searchSource));
  client().performRequest(searchRequest);
 
  searchRequest = new Request("GET", "/test/_search");
@@ -181,8 +182,8 @@ public void testAggregationUsage() throws IOException {
  .aggregation(AggregationBuilders.avg("num1").field("num"))
  .aggregation(AggregationBuilders.avg("num2").field("num"))
  .aggregation(AggregationBuilders.terms("foo").field("foo.keyword"));
- String r = Strings.toString(searchSource);
- searchRequest.setJsonEntity(Strings.toString(searchSource));
+ String r = Strings.toString(XContentType.JSON, searchSource);
+ searchRequest.setJsonEntity(Strings.toString(XContentType.JSON, searchSource));
  client().performRequest(searchRequest);
 
  Response response = client().performRequest(new Request("GET", "_nodes/usage"));

diff --git a/libs/x-content/src/main/java/org/opensearch/common/xcontent/MediaType.java b/libs/x-content/src/main/java/org/opensearch/common/xcontent/MediaType.java
@@ -62,4 +62,6 @@ public interface MediaType {
  default String typeWithSubtype() {
  return type() + "/" + subtype();
  }
+
+ XContent xContent();
 }
diff --git a/libs/x-content/src/main/java/org/opensearch/common/xcontent/XContentType.java b/libs/x-content/src/main/java/org/opensearch/common/xcontent/XContentType.java
@@ -190,8 +190,6 @@ public String mediaType() {
  return mediaTypeWithoutParameters();
  }
 
- public abstract XContent xContent();
-
  public abstract String mediaTypeWithoutParameters();
 
  @Override

diff --git a/libs/x-content/src/test/java/org/opensearch/common/xcontent/SimpleStruct.java b/libs/x-content/src/test/java/org/opensearch/common/xcontent/SimpleStruct.java
@@ -101,6 +101,6 @@ public int hashCode() {
 
  @Override
  public String toString() {
- return Strings.toString(this);
+ return Strings.toString(XContentType.JSON, this);
  }
 }
diff --git a/...ng-mustache/src/main/java/org/opensearch/script/mustache/MultiSearchTemplateResponse.java b/...ng-mustache/src/main/java/org/opensearch/script/mustache/MultiSearchTemplateResponse.java
@@ -45,6 +45,7 @@
 import org.opensearch.common.xcontent.ToXContentObject;
 import org.opensearch.common.xcontent.XContentBuilder;
 import org.opensearch.common.xcontent.XContentParser;
+import org.opensearch.common.xcontent.XContentType;
 
 import java.io.IOException;
 import java.util.Arrays;
@@ -199,6 +200,6 @@ public static MultiSearchTemplateResponse fromXContext(XContentParser parser) {
 
  @Override
  public String toString() {
- return Strings.toString(this);
+ return Strings.toString(XContentType.JSON, this);
  }
 }
diff --git a/modules/lang-painless/build.gradle b/modules/lang-painless/build.gradle
@@ -40,6 +40,11 @@ opensearchplugin {
  classname 'org.opensearch.painless.PainlessModulePlugin'
 }
 
+ext {
+ // Do not fail on `javadoc` warning (ANTLR generated code)
+ failOnJavadocWarning = false
+}
+
 testClusters.all {
  module ':modules:mapper-extras'
  systemProperty 'opensearch.scripting.update.ctx_in_params', 'false'

diff --git a/...per-extras/src/test/java/org/opensearch/index/mapper/SearchAsYouTypeFieldMapperTests.java b/...per-extras/src/test/java/org/opensearch/index/mapper/SearchAsYouTypeFieldMapperTests.java
@@ -53,6 +53,7 @@
 import org.opensearch.common.Strings;
 import org.opensearch.common.lucene.search.MultiPhrasePrefixQuery;
 import org.opensearch.common.xcontent.XContentBuilder;
+import org.opensearch.common.xcontent.XContentType;
 import org.opensearch.index.IndexSettings;
 import org.opensearch.index.analysis.AnalyzerScope;
 import org.opensearch.index.analysis.IndexAnalyzers;
@@ -609,15 +610,15 @@ public void testAnalyzerSerialization() throws IOException {
  b.field("type", "search_as_you_type");
  b.field("analyzer", "simple");
  }));
- String serialized = Strings.toString(ms.documentMapper());
+ String serialized = Strings.toString(XContentType.JSON, ms.documentMapper());
  assertEquals(
  serialized,
  "{\"_doc\":{\"properties\":{\"field\":"
  + "{\"type\":\"search_as_you_type\",\"doc_values\":false,\"max_shingle_size\":3,\"analyzer\":\"simple\"}}}}"
  );
 
  merge(ms, mapping(b -> {}));
- assertEquals(serialized, Strings.toString(ms.documentMapper()));
+ assertEquals(serialized, Strings.toString(XContentType.JSON, ms.documentMapper()));
  }
 
  private void documentParsingTestCase(Collection<String> values) throws IOException {

diff --git a/modules/rank-eval/src/main/java/org/opensearch/index/rankeval/RankEvalResponse.java b/modules/rank-eval/src/main/java/org/opensearch/index/rankeval/RankEvalResponse.java
@@ -44,6 +44,7 @@
 import org.opensearch.common.xcontent.XContentBuilder;
 import org.opensearch.common.xcontent.XContentParser;
 import org.opensearch.common.xcontent.XContentParserUtils;
+import org.opensearch.common.xcontent.XContentType;
 
 import java.io.IOException;
 import java.util.Collections;
@@ -105,7 +106,7 @@ public Map<String, Exception> getFailures() {
 
  @Override
  public String toString() {
- return Strings.toString(this);
+ return Strings.toString(XContentType.JSON, this);
  }
 
  @Override

diff --git a/modules/rank-eval/src/main/java/org/opensearch/index/rankeval/RankEvalSpec.java b/modules/rank-eval/src/main/java/org/opensearch/index/rankeval/RankEvalSpec.java
@@ -43,6 +43,7 @@
 import org.opensearch.common.xcontent.XContentBuilder;
 import org.opensearch.common.xcontent.XContentParser;
 import org.opensearch.common.xcontent.XContentParserUtils;
+import org.opensearch.common.xcontent.XContentType;
 import org.opensearch.script.Script;
 
 import java.io.IOException;
@@ -249,7 +250,7 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
 
  @Override
  public String toString() {
- return Strings.toString(this);
+ return Strings.toString(XContentType.JSON, this);
  }
 
  @Override

diff --git a/modules/rank-eval/src/main/java/org/opensearch/index/rankeval/RatedDocument.java b/modules/rank-eval/src/main/java/org/opensearch/index/rankeval/RatedDocument.java
@@ -41,6 +41,7 @@
 import org.opensearch.common.xcontent.ToXContentObject;
 import org.opensearch.common.xcontent.XContentBuilder;
 import org.opensearch.common.xcontent.XContentParser;
+import org.opensearch.common.xcontent.XContentType;
 
 import java.io.IOException;
 import java.util.Objects;
@@ -128,7 +129,7 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
 
  @Override
  public String toString() {
- return Strings.toString(this);
+ return Strings.toString(XContentType.JSON, this);
  }
 
  @Override

diff --git a/modules/rank-eval/src/main/java/org/opensearch/index/rankeval/RatedRequest.java b/modules/rank-eval/src/main/java/org/opensearch/index/rankeval/RatedRequest.java
@@ -42,6 +42,7 @@
 import org.opensearch.common.xcontent.ToXContentObject;
 import org.opensearch.common.xcontent.XContentBuilder;
 import org.opensearch.common.xcontent.XContentParser;
+import org.opensearch.common.xcontent.XContentType;
 import org.opensearch.index.rankeval.RatedDocument.DocumentKey;
 import org.opensearch.search.builder.SearchSourceBuilder;
 
@@ -340,7 +341,7 @@ public XContentBuilder toXContent(XContentBuilder builder, Params params) throws
 
  @Override
  public String toString() {
- return Strings.toString(this);
+ return Strings.toString(XContentType.JSON, this);
  }
 
  @Override

diff --git a/.../rank-eval/src/test/java/org/opensearch/index/rankeval/DiscountedCumulativeGainTests.java b/.../rank-eval/src/test/java/org/opensearch/index/rankeval/DiscountedCumulativeGainTests.java
@@ -323,10 +323,13 @@ public void testMetricDetails() {
  + ",\"unrated_docs\":"
  + unratedDocs
  + "}}",
- Strings.toString(detail)
+ Strings.toString(XContentType.JSON, detail)
  );
  } else {
- assertEquals("{\"dcg\":{\"dcg\":" + dcg + ",\"unrated_docs\":" + unratedDocs + "}}", Strings.toString(detail));
+ assertEquals(
+ "{\"dcg\":{\"dcg\":" + dcg + ",\"unrated_docs\":" + unratedDocs + "}}",
+ Strings.toString(XContentType.JSON, detail)
+ );
  }
  }
 

diff --git a/qa/full-cluster-restart/src/test/java/org/opensearch/upgrades/FullClusterRestartIT.java b/qa/full-cluster-restart/src/test/java/org/opensearch/upgrades/FullClusterRestartIT.java
@@ -44,6 +44,7 @@
 import org.opensearch.common.Strings;
 import org.opensearch.common.settings.Settings;
 import org.opensearch.common.xcontent.XContentBuilder;
+import org.opensearch.common.xcontent.XContentType;
 import org.opensearch.common.xcontent.json.JsonXContent;
 import org.opensearch.common.xcontent.support.XContentMapValues;
 import org.opensearch.index.IndexSettings;
@@ -1364,7 +1365,7 @@ public void testResize() throws Exception {
  if (randomBoolean()) {
  settings.put(IndexSettings.INDEX_SOFT_DELETES_SETTING.getKey(), true);
  }
- shrinkRequest.setJsonEntity("{\"settings\":" + Strings.toString(settings.build()) + "}");
+ shrinkRequest.setJsonEntity("{\"settings\":" + Strings.toString(XContentType.JSON, settings.build()) + "}");
  client().performRequest(shrinkRequest);
  ensureGreenLongWait(target);
  assertNumHits(target, numDocs + moreDocs, 1);
@@ -1376,7 +1377,7 @@ public void testResize() throws Exception {
  settings.put(IndexSettings.INDEX_SOFT_DELETES_SETTING.getKey(), true);
  }
  Request splitRequest = new Request("PUT", "/" + index + "/_split/" + target);
- splitRequest.setJsonEntity("{\"settings\":" + Strings.toString(settings.build()) + "}");
+ splitRequest.setJsonEntity("{\"settings\":" + Strings.toString(XContentType.JSON, settings.build()) + "}");
  client().performRequest(splitRequest);
  ensureGreenLongWait(target);
  assertNumHits(target, numDocs + moreDocs, 6);

diff --git a/qa/multi-cluster-search/src/test/java/org/opensearch/search/CCSDuelIT.java b/qa/multi-cluster-search/src/test/java/org/opensearch/search/CCSDuelIT.java
@@ -726,7 +726,7 @@ public void testCompletionSuggester() throws Exception {
  sourceBuilder.suggest(suggestBuilder);
  duelSearch(searchRequest, response -> {
  assertMultiClusterSearchResponse(response);
- assertEquals(Strings.toString(response, true, true), 3, response.getSuggest().size());
+ assertEquals(Strings.toString(XContentType.JSON, response, true, true), 3, response.getSuggest().size());
  assertThat(response.getSuggest().getSuggestion("python").getEntries().size(), greaterThan(0));
  assertThat(response.getSuggest().getSuggestion("java").getEntries().size(), greaterThan(0));
  assertThat(response.getSuggest().getSuggestion("ruby").getEntries().size(), greaterThan(0));

diff --git a/qa/rolling-upgrade/src/test/java/org/opensearch/upgrades/RecoveryIT.java b/qa/rolling-upgrade/src/test/java/org/opensearch/upgrades/RecoveryIT.java
@@ -31,7 +31,6 @@
 
 package org.opensearch.upgrades;
 
-import org.opensearch.LegacyESVersion;
 import org.opensearch.Version;
 import org.opensearch.action.support.PlainActionFuture;
 import org.opensearch.client.Request;
@@ -44,13 +43,13 @@
 import org.opensearch.common.Strings;
 import org.opensearch.common.settings.Settings;
 import org.opensearch.common.util.concurrent.AbstractRunnable;
+import org.opensearch.common.xcontent.XContentType;
 import org.opensearch.common.xcontent.support.XContentMapValues;
 import org.opensearch.index.IndexSettings;
 import org.opensearch.index.mapper.MapperService;
 import org.opensearch.rest.RestStatus;
 import org.opensearch.test.rest.yaml.ObjectPath;
 import org.apache.hc.core5.http.io.entity.EntityUtils;
-import org.hamcrest.Matcher;
 import org.hamcrest.Matchers;
 
 import java.io.IOException;
@@ -734,7 +733,7 @@ public void testSoftDeletesDisabledWarning() throws Exception {
  settings.put(IndexSettings.INDEX_SOFT_DELETES_SETTING.getKey(), softDeletesEnabled);
  }
  Request request = new Request("PUT", "/" + indexName);
- request.setJsonEntity("{\"settings\": " + Strings.toString(settings.build()) + "}");
+ request.setJsonEntity("{\"settings\": " + Strings.toString(XContentType.JSON, settings.build()) + "}");
  if (softDeletesEnabled == false) {
  expectSoftDeletesWarning(request, indexName);
  }

diff --git a/qa/smoke-test-http/src/test/java/org/opensearch/http/SearchRestCancellationIT.java b/qa/smoke-test-http/src/test/java/org/opensearch/http/SearchRestCancellationIT.java
@@ -98,7 +98,7 @@ public void testAutomaticCancellationDuringQueryPhase() throws Exception {
  Request searchRequest = new Request("GET", "/test/_search");
  SearchSourceBuilder searchSource = new SearchSourceBuilder().query(scriptQuery(
  new Script(ScriptType.INLINE, "mockscript", ScriptedBlockPlugin.SCRIPT_NAME, Collections.emptyMap())));
- searchRequest.setJsonEntity(Strings.toString(searchSource));
+ searchRequest.setJsonEntity(Strings.toString(XContentType.JSON, searchSource));
  verifyCancellationDuringQueryPhase(SearchAction.NAME, searchRequest);
  }
 
@@ -147,7 +147,7 @@ public void testAutomaticCancellationDuringFetchPhase() throws Exception {
  Request searchRequest = new Request("GET", "/test/_search");
  SearchSourceBuilder searchSource = new SearchSourceBuilder().scriptField("test_field",
  new Script(ScriptType.INLINE, "mockscript", ScriptedBlockPlugin.SCRIPT_NAME, Collections.emptyMap()));
- searchRequest.setJsonEntity(Strings.toString(searchSource));
+ searchRequest.setJsonEntity(Strings.toString(XContentType.JSON, searchSource));
  verifyCancellationDuringFetchPhase(SearchAction.NAME, searchRequest);
  }
 

diff --git a/server/src/internalClusterTest/java/org/opensearch/action/bulk/BulkWithUpdatesIT.java b/server/src/internalClusterTest/java/org/opensearch/action/bulk/BulkWithUpdatesIT.java
@@ -741,13 +741,17 @@ public void testNoopUpdate() {
 
  final BulkItemResponse noopUpdate = bulkResponse.getItems()[0];
  assertThat(noopUpdate.getResponse().getResult(), equalTo(DocWriteResponse.Result.NOOP));
- assertThat(Strings.toString(noopUpdate), noopUpdate.getResponse().getShardInfo().getSuccessful(), equalTo(2));
+ assertThat(Strings.toString(XContentType.JSON, noopUpdate), noopUpdate.getResponse().getShardInfo().getSuccessful(), equalTo(2));
 
  final BulkItemResponse notFoundUpdate = bulkResponse.getItems()[1];
  assertNotNull(notFoundUpdate.getFailure());
 
  final BulkItemResponse notFoundDelete = bulkResponse.getItems()[2];
  assertThat(notFoundDelete.getResponse().getResult(), equalTo(DocWriteResponse.Result.NOT_FOUND));
- assertThat(Strings.toString(notFoundDelete), notFoundDelete.getResponse().getShardInfo().getSuccessful(), equalTo(2));
+ assertThat(
+ Strings.toString(XContentType.JSON, notFoundDelete),
+ notFoundDelete.getResponse().getShardInfo().getSuccessful(),
+ equalTo(2)
+ );
  }
 }