[BWC and API enforcement] Decorate the existing APIs with proper annotations (part 3) #11182

reta · 2023-11-13T21:45:53Z

Description

Decorate the existing APIs with proper annotations. This is merely the first part so we could work through the small changesets vs big bang pull request. The API validations are fully automated (as annotation processor #9304).

All classes that are annotated in this pull request leak through org.opensearch.client.Client which is by definition (currently) is public APIs exposed through plugins and RestClient / HighLevelRestClient.

Related Issues

Part of #9303

Check List

~~New functionality includes testing.~~
- ~~All tests pass~~
~~New functionality has been documented.~~
- ~~New functionality has javadoc added~~
Failing checks are inspected and point to the corresponding known issue(s) (See: Troubleshooting Failing Builds)
Commits are signed per the DCO using --signoff
~~Commit changes are listed out in CHANGELOG.md file (See: Changelog)~~
~~Public documentation issue/PR created~~

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

github-actions · 2023-11-13T21:58:56Z

❌ Gradle check result for 9b20bce: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2023-11-13T22:07:50Z

Compatibility status:

Checks if related components are compatible with change 199a68d

Incompatible components

Incompatible components: [https://github.com/opensearch-project/k-nn.git, https://github.com/opensearch-project/performance-analyzer.git]

Skipped components

Compatible components

Compatible components: [https://github.com/opensearch-project/asynchronous-search.git, https://github.com/opensearch-project/security-analytics.git, https://github.com/opensearch-project/observability.git, https://github.com/opensearch-project/reporting.git, https://github.com/opensearch-project/job-scheduler.git, https://github.com/opensearch-project/opensearch-oci-object-storage.git, https://github.com/opensearch-project/sql.git, https://github.com/opensearch-project/common-utils.git, https://github.com/opensearch-project/custom-codecs.git, https://github.com/opensearch-project/ml-commons.git, https://github.com/opensearch-project/security.git, https://github.com/opensearch-project/notifications.git, https://github.com/opensearch-project/anomaly-detection.git, https://github.com/opensearch-project/index-management.git, https://github.com/opensearch-project/neural-search.git, https://github.com/opensearch-project/alerting.git, https://github.com/opensearch-project/cross-cluster-replication.git, https://github.com/opensearch-project/performance-analyzer-rca.git, https://github.com/opensearch-project/geospatial.git]

server/src/main/java/org/opensearch/cluster/node/DiscoveryNode.java

github-actions · 2023-11-14T14:35:30Z

❕ Gradle check result for 7de9a36: UNSTABLE

TEST FAILURES:

      1 org.opensearch.search.SearchWeightedRoutingIT.testShardRoutingWithNetworkDisruption_FailOpenEnabled

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

codecov · 2023-11-14T14:36:14Z

Codecov Report

Attention: 4 lines in your changes are missing coverage. Please review.

Comparison is base (54ff353) 71.09% compared to head (07ccc2e) 71.26%.
Report is 1 commits behind head on main.

❗ Current head 07ccc2e differs from pull request most recent head 199a68d. Consider uploading reports for the commit 199a68d to get more accurate results

Files	Patch %	Lines
.../java/org/opensearch/common/settings/Settings.java	77.77%	1 Missing and 3 partials ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #11182      +/-   ##
============================================
+ Coverage     71.09%   71.26%   +0.17%     
- Complexity    58752    58865     +113     
============================================
  Files          4888     4888              
  Lines        277207   277222      +15     
  Branches      40282    40287       +5     
============================================
+ Hits         197077   197561     +484     
+ Misses        63654    63130     -524     
- Partials      16476    16531      +55

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

github-actions · 2023-11-14T16:07:14Z

❕ Gradle check result for 326a566: UNSTABLE

TEST FAILURES:

      1 org.opensearch.search.SearchWeightedRoutingIT.testShardRoutingWithNetworkDisruption_FailOpenEnabled
      1 org.opensearch.remotestore.RemoteStoreStatsIT.testStatsResponseFromAllNodes
      1 org.opensearch.action.admin.cluster.node.tasks.ResourceAwareTasksTests.testTaskResourceTrackingDuringTaskCancellation

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

github-actions · 2023-11-14T16:19:48Z

✅ Gradle check result for 318a704: SUCCESS

github-actions · 2023-11-14T17:07:40Z

✅ Gradle check result for a38dc2c: SUCCESS

server/src/main/java/org/opensearch/index/mapper/DocumentMapper.java

github-actions · 2023-11-14T17:59:33Z

✅ Gradle check result for 3be616c: SUCCESS

github-actions · 2023-11-14T19:06:14Z

❕ Gradle check result for 61bd2d3: UNSTABLE

TEST FAILURES:

      1 org.opensearch.http.SearchRestCancellationIT.testAutomaticCancellationDuringQueryPhase

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

server/src/test/java/org/opensearch/index/IndexServiceTestUtils.java

github-actions · 2023-11-14T20:24:20Z

❕ Gradle check result for 3a34bb6: UNSTABLE

TEST FAILURES:

      1 org.opensearch.search.SearchTimeoutIT.testSimpleTimeout {p0={"search.concurrent_segment_search.enabled":"false"}}

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

github-actions · 2023-11-14T21:29:34Z

❌ Gradle check result for 72f2f4f: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

reta · 2023-11-14T21:45:57Z

❌ Gradle check result for 72f2f4f: FAILURE

#7934

github-actions · 2023-11-14T22:12:26Z

❌ Gradle check result for 72f2f4f: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2023-11-15T02:58:44Z

❕ Gradle check result for 72f2f4f: UNSTABLE

TEST FAILURES:

      1 org.opensearch.cluster.allocation.ClusterRerouteIT.testDelayWithALargeAmountOfShards

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

reta · 2023-11-15T14:13:37Z

@andrross @dblock @nknize looks like the last large chunk, there are only 2 issues to fix (one of them should be addressed by #10921):

error: The element org.opensearch.action.search.SearchTransportService is part of the public APIs but is not maked as @PublicApi, @ExperimentalApi or @DeprecatedApi (referenced by org.opensearch.action.search.SearchPhaseContext) 
error: The element org.opensearch.common.inject.Module is part of the public APIs but is not maked as @PublicApi, @ExperimentalApi or @DeprecatedApi (referenced by org.opensearch.plugins.Plugin)

github-actions · 2023-11-15T14:44:02Z

❌ Gradle check result for 6eca3b7: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

github-actions · 2023-11-15T15:29:27Z

❌ Gradle check result for 7d1515d: FAILURE

Please examine the workflow log, locate, and copy-paste the failure(s) below, then iterate to green. Is the failure a flaky test unrelated to your change?

reta · 2023-11-15T16:36:58Z

❌ Gradle check result for 7d1515d: FAILURE

#7934
#9499

github-actions · 2023-11-15T17:26:30Z

❕ Gradle check result for b64aae8: UNSTABLE

TEST FAILURES:

      1 org.opensearch.remotestore.multipart.RemoteStoreMultipartIT.testOverriddenBufferInterval

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

andrross · 2023-11-15T22:03:05Z

@reta Unfortunately the other PR I just merged caused a conflict here :(

reta · 2023-11-15T22:10:44Z

@reta Unfortunately the other PR I just merged caused a conflict here :(

Thanks @andrross , will resolve the conflicts shortly!

github-actions · 2023-11-16T14:10:47Z

✅ Gradle check result for 6bc7fdb: SUCCESS

github-actions · 2023-11-16T15:07:06Z

❕ Gradle check result for 07ccc2e: UNSTABLE

TEST FAILURES:

      1 org.opensearch.remotestore.RemoteStoreStatsIT.testDownloadStatsCorrectnessSinglePrimarySingleReplica

Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

…tations (part 3) Signed-off-by: Andriy Redko <[email protected]>

github-actions · 2023-11-16T15:56:46Z

✅ Gradle check result for 199a68d: SUCCESS

opensearch-trigger-bot · 2023-11-16T16:00:32Z

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/OpenSearch/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch/backport-2.x
# Create a new branch
git switch --create backport/backport-11182-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 09bacee5fc85676e97bee6b4ad87dec35c6aa8cc
# Push it to GitHub
git push --set-upstream origin backport/backport-11182-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-11182-to-2.x.

…tations (part 3) (opensearch-project#11182) Signed-off-by: Andriy Redko <[email protected]> (cherry picked from commit 09bacee)

…tations (part 3) (#11182) (#11231) Signed-off-by: Andriy Redko <[email protected]> (cherry picked from commit 09bacee)

jmazanec15 · 2023-11-17T00:02:06Z

server/src/main/java/org/opensearch/index/mapper/ParametrizedFieldMapper.java

@@ -276,7 +282,7 @@ public Parameter<T> setValidator(Consumer<T> validator) {
        /**
         * Configure a custom serializer for this parameter
         */
-        public Parameter<T> setSerializer(Serializer<T> serializer, Function<T, String> conflictSerializer) {
+        protected Parameter<T> setSerializer(Serializer<T> serializer, Function<T, String> conflictSerializer) {


@reta I saw this failed for k-NN plugin field mapper: https://github.com/opensearch-project/k-NN/blob/main/src/main/java/org/opensearch/knn/index/mapper/KNNVectorFieldMapper.java#L138. Should Serializer be public? It seems like it is similar to setValidator.

Thanks @jmazanec15 , I will take a look shortly, the Serializer is defined as protected interface

@InternalApi protected interface Serializer<T> { void serialize(XContentBuilder builder, String name, T value) throws IOException; }

so it was really weird to have a public method that uses the protected interface

@jmazanec15 the change was reverted, should be all good, thank you for noticing!

…tations (part 3) (opensearch-project#11182) Signed-off-by: Andriy Redko <[email protected]>

…tations (part 3) (opensearch-project#11182) Signed-off-by: Andriy Redko <[email protected]> Signed-off-by: Shivansh Arora <[email protected]>

reta added the skip-changelog label Nov 13, 2023

reta force-pushed the bwc.3 branch from 9b20bce to 7de9a36 Compare November 14, 2023 13:45

reta commented Nov 14, 2023

View reviewed changes

server/src/main/java/org/opensearch/cluster/node/DiscoveryNode.java Show resolved Hide resolved

reta force-pushed the bwc.3 branch 2 times, most recently from 326a566 to 318a704 Compare November 14, 2023 15:33

reta force-pushed the bwc.3 branch from 318a704 to a38dc2c Compare November 14, 2023 16:22

reta force-pushed the bwc.3 branch from a38dc2c to 3be616c Compare November 14, 2023 17:15

reta commented Nov 14, 2023

View reviewed changes

server/src/main/java/org/opensearch/index/mapper/DocumentMapper.java Show resolved Hide resolved

reta force-pushed the bwc.3 branch from 3be616c to 61bd2d3 Compare November 14, 2023 18:13

reta force-pushed the bwc.3 branch from 61bd2d3 to 3a34bb6 Compare November 14, 2023 19:23

reta commented Nov 14, 2023

View reviewed changes

server/src/test/java/org/opensearch/index/IndexServiceTestUtils.java Show resolved Hide resolved

reta force-pushed the bwc.3 branch from 3a34bb6 to 72f2f4f Compare November 14, 2023 21:07

reta force-pushed the bwc.3 branch from 72f2f4f to 6eca3b7 Compare November 15, 2023 14:10

reta marked this pull request as ready for review November 15, 2023 14:10

reta requested review from abbashus and adnapibar as code owners November 15, 2023 14:10

reta requested a review from VachaShah as a code owner November 15, 2023 14:10

reta force-pushed the bwc.3 branch from 6eca3b7 to 7d1515d Compare November 15, 2023 14:45

reta force-pushed the bwc.3 branch from 7d1515d to b64aae8 Compare November 15, 2023 16:37

andrross approved these changes Nov 15, 2023

View reviewed changes

reta force-pushed the bwc.3 branch from b64aae8 to 6bc7fdb Compare November 16, 2023 13:20

reta force-pushed the bwc.3 branch from 6bc7fdb to 07ccc2e Compare November 16, 2023 14:21

[BWC and API enforcement] Decorate the existing APIs with proper anno…

199a68d

…tations (part 3) Signed-off-by: Andriy Redko <[email protected]>

reta force-pushed the bwc.3 branch from 07ccc2e to 199a68d Compare November 16, 2023 15:08

reta merged commit 09bacee into opensearch-project:main Nov 16, 2023
27 checks passed

reta added the backport 2.x Backport to 2.x branch label Nov 16, 2023

opensearch-trigger-bot bot added the backport-failed label Nov 16, 2023

reta mentioned this pull request Nov 16, 2023

[Backport] [2.x] [BWC and API enforcement] Decorate the existing APIs with proper annotations (part 3) (#11182) #11231

Merged

andrross pushed a commit that referenced this pull request Nov 16, 2023

[BWC and API enforcement] Decorate the existing APIs with proper anno…

78cfce4

…tations (part 3) (#11182) (#11231) Signed-off-by: Andriy Redko <[email protected]> (cherry picked from commit 09bacee)

reta mentioned this pull request Nov 16, 2023

[BWC and API enforcement] Reduce the visibility of some existing APIs #11242

Merged

8 tasks

jmazanec15 reviewed Nov 17, 2023

View reviewed changes

fahadshamiinsta pushed a commit to fahadshamiinsta/OpenSearch270 that referenced this pull request Dec 4, 2023

[BWC and API enforcement] Decorate the existing APIs with proper anno…

42e02c4

…tations (part 3) (opensearch-project#11182) Signed-off-by: Andriy Redko <[email protected]>

rayshrey pushed a commit to rayshrey/OpenSearch that referenced this pull request Mar 18, 2024

[BWC and API enforcement] Decorate the existing APIs with proper anno…

1c2211d

…tations (part 3) (opensearch-project#11182) Signed-off-by: Andriy Redko <[email protected]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BWC and API enforcement] Decorate the existing APIs with proper annotations (part 3) #11182

[BWC and API enforcement] Decorate the existing APIs with proper annotations (part 3) #11182

reta commented Nov 13, 2023

github-actions bot commented Nov 13, 2023

github-actions bot commented Nov 13, 2023 •

edited

Loading

github-actions bot commented Nov 14, 2023

codecov bot commented Nov 14, 2023 •

edited

Loading

github-actions bot commented Nov 14, 2023

github-actions bot commented Nov 14, 2023

github-actions bot commented Nov 14, 2023

github-actions bot commented Nov 14, 2023

github-actions bot commented Nov 14, 2023

github-actions bot commented Nov 14, 2023

github-actions bot commented Nov 14, 2023

reta commented Nov 14, 2023

github-actions bot commented Nov 14, 2023

github-actions bot commented Nov 15, 2023

reta commented Nov 15, 2023 •

edited

Loading

github-actions bot commented Nov 15, 2023

github-actions bot commented Nov 15, 2023

reta commented Nov 15, 2023

github-actions bot commented Nov 15, 2023

andrross commented Nov 15, 2023

reta commented Nov 15, 2023

github-actions bot commented Nov 16, 2023

github-actions bot commented Nov 16, 2023

github-actions bot commented Nov 16, 2023

opensearch-trigger-bot bot commented Nov 16, 2023

jmazanec15 Nov 17, 2023

reta Nov 17, 2023

reta Nov 20, 2023

[BWC and API enforcement] Decorate the existing APIs with proper annotations (part 3) #11182

[BWC and API enforcement] Decorate the existing APIs with proper annotations (part 3) #11182

Conversation

reta commented Nov 13, 2023

Description

Related Issues

Check List

github-actions bot commented Nov 13, 2023

github-actions bot commented Nov 13, 2023 • edited Loading

Compatibility status:

Incompatible components

Skipped components

Compatible components

github-actions bot commented Nov 14, 2023

codecov bot commented Nov 14, 2023 • edited Loading

Codecov Report

github-actions bot commented Nov 14, 2023

github-actions bot commented Nov 14, 2023

github-actions bot commented Nov 14, 2023

github-actions bot commented Nov 14, 2023

github-actions bot commented Nov 14, 2023

github-actions bot commented Nov 14, 2023

github-actions bot commented Nov 14, 2023

reta commented Nov 14, 2023

github-actions bot commented Nov 14, 2023

github-actions bot commented Nov 15, 2023

reta commented Nov 15, 2023 • edited Loading

github-actions bot commented Nov 15, 2023

github-actions bot commented Nov 15, 2023

reta commented Nov 15, 2023

github-actions bot commented Nov 15, 2023

andrross commented Nov 15, 2023

reta commented Nov 15, 2023

github-actions bot commented Nov 16, 2023

github-actions bot commented Nov 16, 2023

github-actions bot commented Nov 16, 2023

opensearch-trigger-bot bot commented Nov 16, 2023

jmazanec15 Nov 17, 2023

Choose a reason for hiding this comment

reta Nov 17, 2023

Choose a reason for hiding this comment

reta Nov 20, 2023

Choose a reason for hiding this comment

github-actions bot commented Nov 13, 2023 •

edited

Loading

codecov bot commented Nov 14, 2023 •

edited

Loading

reta commented Nov 15, 2023 •

edited

Loading