[BWC and API enforcement] Define the initial set of annotations, their meaning and relations between them by reta · Pull Request #9223 · opensearch-project/OpenSearch

reta · 2023-08-10T13:54:58Z

Description

Define the initial set of annotations, their meaning and relations between them

Related Issues

Resolves #9222

Check List

New functionality includes testing.
- All tests pass
New functionality has been documented.
- New functionality has javadoc added
Commits are signed per the DCO using --signoff
Commit changes are listed out in CHANGELOG.md file (See: Changelog)

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-08-10T13:59:16Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/22326/
CommitID: efc2b59
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-08-10T14:51:49Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/22327/
CommitID: b7ee11d
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-08-10T15:00:00Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/22330/
CommitID: 20b9176
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?

opensearch-trigger-bot · 2023-08-10T15:32:38Z

Compatibility status:



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

BUILD SUCCESSFUL in 34m

github-actions · 2023-08-10T15:42:55Z

Gradle Check (Jenkins) Run Completed with:

RESULT: SUCCESS ✅
URL: https://build.ci.opensearch.org/job/gradle-check/22331/
CommitID: 3317c5f

github-actions · 2023-08-10T17:55:27Z

Gradle Check (Jenkins) Run Completed with:

RESULT: SUCCESS ✅
URL: https://build.ci.opensearch.org/job/gradle-check/22335/
CommitID: 71d10fe

opensearch-trigger-bot · 2023-08-10T18:18:58Z

Compatibility status:



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

BUILD SUCCESSFUL in 28m 11s

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

opensearch-trigger-bot · 2023-08-10T19:31:06Z

Compatibility status:



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

BUILD SUCCESSFUL in 42m 12s

github-actions · 2023-08-10T19:31:50Z

Gradle Check (Jenkins) Run Completed with:

RESULT: SUCCESS ✅
URL: https://build.ci.opensearch.org/job/gradle-check/22343/
CommitID: a54fda4

nknize

I like this a lot!!!! I'd like to go ahead and start using it on #9262

libs/common/src/main/java/org/opensearch/common/annotation/InternalApi.java

Signed-off-by: Peter Nied <petern@amazon.com>

github-actions · 2023-08-11T21:26:50Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/22539/
CommitID: 43b0e6c
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?

opensearch-trigger-bot · 2023-08-11T22:02:18Z

Compatibility status:



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

BUILD SUCCESSFUL in 26m 25s

github-actions · 2023-08-11T22:16:06Z

Gradle Check (Jenkins) Run Completed with:

RESULT: UNSTABLE ❕
TEST FAILURES:

      1 org.opensearch.remotestore.multipart.RemoteStoreMultipartIT.testRemoteTranslogCleanup
      1 org.opensearch.remotestore.RemoteStoreIT.testRemoteTranslogCleanup

URL: https://build.ci.opensearch.org/job/gradle-check/22546/
CommitID: 43b0e6c
Please review all flaky tests that succeeded after retry and create an issue if one does not already exist to track the flaky failure.

opensearch-trigger-bot · 2023-08-11T23:08:51Z

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

…r meaning and relations between them (opensearch-project#9223) * [BWC and API enforcement] Define the initial set of annotations, their meaning and relations between them Signed-off-by: Andriy Redko <andriy.redko@aiven.io> Signed-off-by: Peter Nied <petern@amazon.com> Co-authored-by: Peter Nied <petern@amazon.com> (cherry picked from commit 0b2c07a)

nknize · 2023-08-14T15:37:43Z

I just had a thought. Should we add ElementType.FIELD to PublicApi (at minimum)? In #9262 the compressors have the static final String NAME singleton that is used for the registry. This would be breaking if it gets changed in a PR. There are other places (e.g., Field names) that we have this same idea. So I"m thinking we can catch these breaking changes in the future by adding the annotation to the field?

reta · 2023-08-14T15:46:35Z

So I"m thinking we can catch these breaking changes in the future by adding the annotation to the field?

Make sense, adding those ElementType.PARAMETER, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.MODULE

…annotations, their meaning and relations between them (#9223) (#9296) * [BWC and API enforcement] Define the initial set of annotations, their meaning and relations between them (#9223) * [BWC and API enforcement] Define the initial set of annotations, their meaning and relations between them Signed-off-by: Andriy Redko <andriy.redko@aiven.io> Signed-off-by: Peter Nied <petern@amazon.com> Co-authored-by: Peter Nied <petern@amazon.com> (cherry picked from commit 0b2c07a) * [BWC and API enforcement] Extend the element types the initial set of annotations could be applied to Signed-off-by: Andriy Redko <andriy.redko@aiven.io> --------- Signed-off-by: Andriy Redko <andriy.redko@aiven.io>

…r meaning and relations between them (opensearch-project#9223) * [BWC and API enforcement] Define the initial set of annotations, their meaning and relations between them Signed-off-by: Andriy Redko <andriy.redko@aiven.io> Signed-off-by: Peter Nied <petern@amazon.com> Co-authored-by: Peter Nied <petern@amazon.com>

…r meaning and relations between them (opensearch-project#9223) * [BWC and API enforcement] Define the initial set of annotations, their meaning and relations between them Signed-off-by: Andriy Redko <andriy.redko@aiven.io> Signed-off-by: Peter Nied <petern@amazon.com> Co-authored-by: Peter Nied <petern@amazon.com> Signed-off-by: Kaushal Kumar <ravi.kaushal97@gmail.com>

…r meaning and relations between them (opensearch-project#9223) * [BWC and API enforcement] Define the initial set of annotations, their meaning and relations between them Signed-off-by: Andriy Redko <andriy.redko@aiven.io> Signed-off-by: Peter Nied <petern@amazon.com> Co-authored-by: Peter Nied <petern@amazon.com> Signed-off-by: Ivan Brusic <ivan.brusic@flocksafety.com>

…r meaning and relations between them (opensearch-project#9223) * [BWC and API enforcement] Define the initial set of annotations, their meaning and relations between them Signed-off-by: Andriy Redko <andriy.redko@aiven.io> Signed-off-by: Peter Nied <petern@amazon.com> Co-authored-by: Peter Nied <petern@amazon.com> Signed-off-by: Shivansh Arora <hishiv@amazon.com>

reta force-pushed the issue-9222 branch from efc2b59 to b7ee11d Compare August 10, 2023 14:15

reta force-pushed the issue-9222 branch 2 times, most recently from 20b9176 to 3317c5f Compare August 10, 2023 14:59

Address code review comments

a54fda4

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

peternied approved these changes Aug 10, 2023

View reviewed changes

reta mentioned this pull request Aug 11, 2023

Refactor Compressors from CompressorFactory to CompressorRegistry for extensibility #9262

Merged

nknize approved these changes Aug 11, 2023

View reviewed changes

andrross reviewed Aug 11, 2023

View reviewed changes

libs/common/src/main/java/org/opensearch/common/annotation/InternalApi.java Show resolved Hide resolved

Merge branch 'main' into issue-9222

43b0e6c

Signed-off-by: Peter Nied <petern@amazon.com>

andrross approved these changes Aug 11, 2023

View reviewed changes

peternied merged commit 0b2c07a into opensearch-project:main Aug 11, 2023

reta added the backport 2.x Backport to 2.x branch label Aug 11, 2023

opensearch-trigger-bot bot added the backport-failed label Aug 11, 2023

reta mentioned this pull request Aug 14, 2023

[Backport] [2.x] [BWC and API enforcement] Define the initial set of annotations, their meaning and relations between them (#9223) #9296

Merged

reta mentioned this pull request Aug 14, 2023

[BWC and API enforcement] Extend the element types the initial set of annotations could be applied to #9308

Merged

6 tasks

nknize mentioned this pull request Oct 19, 2023

[Refactor] XContent base classes from xcontent to core library #5902

Merged

Conversation

reta commented Aug 10, 2023

Description

Related Issues

Check List

Uh oh!

github-actions bot commented Aug 10, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

github-actions bot commented Aug 10, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

github-actions bot commented Aug 10, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

opensearch-trigger-bot bot commented Aug 10, 2023

Uh oh!

github-actions bot commented Aug 10, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

github-actions bot commented Aug 10, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

opensearch-trigger-bot bot commented Aug 10, 2023

Uh oh!

opensearch-trigger-bot bot commented Aug 10, 2023

Uh oh!

github-actions bot commented Aug 10, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

nknize left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Aug 11, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

opensearch-trigger-bot bot commented Aug 11, 2023

Uh oh!

github-actions bot commented Aug 11, 2023

Gradle Check (Jenkins) Run Completed with:

Uh oh!

opensearch-trigger-bot bot commented Aug 11, 2023

Uh oh!

nknize commented Aug 14, 2023

Uh oh!

reta commented Aug 14, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants