Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added missed API visibility annotations for public / experimental APIs #12864

Merged
merged 1 commit into from
Mar 22, 2024

Conversation

reta
Copy link
Collaborator

@reta reta commented Mar 22, 2024

Description

Added missed API visibility annotations for public / experimental APIs

Related Issues

Fixing warnings from OpenSearch API annotation processor:

Note: The element org.opensearch.http.HttpServerTransport is part of the public APIs but is not marked as @PublicApi, @ExperimentalApi or @DeprecatedApi (referenced by org.opensearch.plugins.SecureTransportSettingsProvider)                                                                              
Note: The element org.opensearch.transport.TcpTransport is part of the public APIs but is not marked as @PublicApi, @ExperimentalApi or @DeprecatedApi (referenced by org.opensearch.plugins.SecureTransportSettingsProvider)   
Note: The element org.opensearch.semver.SemverRange is part of the public APIs but is not marked as @PublicApi, @ExperimentalApi or @DeprecatedApi (referenced by org.opensearch.plugins.PluginInfo)                                   
Note: The element org.opensearch.rest.RestHandler.Route is part of the public APIs but is not marked as @PublicApi, @ExperimentalApi or @DeprecatedApi (referenced by org.opensearch.rest.action.admin.indices.RestViewAction.CreateViewHandler) 
Note: The element org.opensearch.rest.BaseRestHandler.RestChannelConsumer is part of the public APIs but is not marked as @PublicApi, @ExperimentalApi or @DeprecatedApi (referenced by org.opensearch.rest.action.admin.indices.RestViewAction.SearchViewHandler) 
Note: The element org.opensearch.common.cache.RemovalListener is part of the public APIs but is not marked as @PublicApi, @ExperimentalApi or @DeprecatedApi (referenced by org.opensearch.common.cache.store.config.CacheConfig) 
Note: The element org.opensearch.common.cache.serializer.Serializer is part of the public APIs but is not marked as @PublicApi, @ExperimentalApi or @DeprecatedApi (referenced by org.opensearch.common.cache.store.config.CacheConfig) 
Note: The element org.opensearch.common.cache.policy.CachedQueryResult.PolicyValues is part of the public APIs but is not marked as @PublicApi, @ExperimentalApi or @DeprecatedApi (referenced by org.opensearch.common.cache.store.config.CacheConfig) 
Note: The element org.opensearch.common.lucene.index.OpenSearchDirectoryReader.DelegatingCacheHelper is part of the public APIs but is not marked as @PublicApi, @ExperimentalApi or @DeprecatedApi (referenced by org.opensearch.common.lucene.index.OpenSearchDirectoryReader) 
Note: The element org.opensearch.index.store.RemoteSegmentStoreDirectoryFactory is part of the public APIs but is not marked as @PublicApi, @ExperimentalApi or @DeprecatedApi (referenced by org.opensearch.index.store.RemoteSegmentStoreDirectory)

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.

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>
Copy link
Member

@peternied peternied left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If these builds are now clean, what do you think about enforcing the annotation process' checks and failing the build?

Copy link
Contributor

Compatibility status:

Checks if related components are compatible with change e6be391

Incompatible components

Incompatible components: [https://github.com/opensearch-project/security.git]

Skipped components

Compatible components

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

@reta
Copy link
Collaborator Author

reta commented Mar 22, 2024

If these builds are now clean, what do you think about enforcing the annotation process' checks and failing the build?

Thanks @peternied , so there was one change that held me back [1] but I am not sure anymore we should wait for it, I will work on annotating org.opensearch.common.inject.* to have clean pass (and make it mandatory)

[1] #10921

Copy link
Contributor

❕ Gradle check result for e6be391: UNSTABLE

  • TEST FAILURES:
      2 org.opensearch.cluster.MinimumClusterManagerNodesIT.testThreeNodesNoClusterManagerBlock

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

Copy link

codecov bot commented Mar 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.48%. Comparing base (b15cb0c) to head (e6be391).
Report is 79 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main   #12864      +/-   ##
============================================
+ Coverage     71.42%   71.48%   +0.06%     
- Complexity    59978    60290     +312     
============================================
  Files          4985     5011      +26     
  Lines        282275   283675    +1400     
  Branches      40946    41117     +171     
============================================
+ Hits         201603   202782    +1179     
- Misses        63999    64051      +52     
- Partials      16673    16842     +169     

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

@reta reta merged commit ac0bb83 into opensearch-project:main Mar 22, 2024
82 of 108 checks passed
@reta reta added backport 2.x Backport to 2.x branch backport 2.13 labels Mar 22, 2024
@opensearch-trigger-bot
Copy link
Contributor

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-12864-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 ac0bb8344a2dcd0b1c251e450710801c78b6249f
# Push it to GitHub
git push --set-upstream origin backport/backport-12864-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-12864-to-2.x.

@opensearch-trigger-bot
Copy link
Contributor

The backport to 2.13 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.13 2.13
# Navigate to the new working tree
pushd ../.worktrees/OpenSearch/backport-2.13
# Create a new branch
git switch --create backport/backport-12864-to-2.13
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 ac0bb8344a2dcd0b1c251e450710801c78b6249f
# Push it to GitHub
git push --set-upstream origin backport/backport-12864-to-2.13
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/OpenSearch/backport-2.13

Then, create a pull request where the base branch is 2.13 and the compare/head branch is backport/backport-12864-to-2.13.

reta added a commit to reta/OpenSearch that referenced this pull request Mar 22, 2024
opensearch-project#12864)

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>
(cherry picked from commit ac0bb83)
reta added a commit to reta/OpenSearch that referenced this pull request Mar 23, 2024
opensearch-project#12864)

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>
(cherry picked from commit ac0bb83)
VachaShah pushed a commit that referenced this pull request Mar 23, 2024
#12864) (#12867)

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>
(cherry picked from commit ac0bb83)
shiv0408 pushed a commit to Gaurav614/OpenSearch that referenced this pull request Apr 25, 2024
opensearch-project#12864)

Signed-off-by: Andriy Redko <andriy.redko@aiven.io>
Signed-off-by: Shivansh Arora <hishiv@amazon.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants