Deprecate class 'MasterService' and create alternative class 'ClusterManagerService' #4022
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 7 commits
July 26, 2022 14:19
Signed-off-by: Tianli Feng <ftianli@amazon.com>
Signed-off-by: Tianli Feng <ftianli@amazon.com>
…stead of MasterService Signed-off-by: Tianli Feng <ftianli@amazon.com>
Signed-off-by: Tianli Feng <ftianli@amazon.com>
Signed-off-by: Tianli Feng <ftianli@amazon.com>
…e.getMasterService() Signed-off-by: Tianli Feng <ftianli@amazon.com>
…viceUtils Signed-off-by: Tianli Feng <ftianli@amazon.com>
Gradle Check (Jenkins) Run Completed with:
|
tlfeng
added
deprecate
v3.0.0
Gradle Check (Jenkins) Run Completed with:
|
Gradle Check (Jenkins) Run Completed with:
|
Codecov Report
@@ Coverage Diff @@
## main #4022 +/- ##
============================================
- Coverage 70.65% 70.64% -0.02%
- Complexity 56904 56950 +46
============================================
Files 4579 4583 +4
Lines 273780 273931 +151
Branches 40143 40158 +15
============================================
+ Hits 193445 193511 +66
- Misses 64119 64195 +76
- Partials 16216 16225 +9
Help us with your feedback. Take ten seconds to tell us how you rate us. |
| @@ -84,21 +84,21 @@ public void testFakeClusterManagerService() { | |||
| doAnswer(invocationOnMock -> runnableTasks.add((Runnable) invocationOnMock.getArguments()[0])).when(executorService).execute(any()); | |||
| when(mockThreadPool.generic()).thenReturn(executorService); | |||
|
|
|||
| FakeThreadPoolMasterService masterService = new FakeThreadPoolMasterService( | |||
| FakeThreadPoolMasterService clusterManagerService = new FakeThreadPoolMasterService( | |||
There was a problem hiding this comment.
Does the class FakeThreadPoolMasterService need to be renamed as well?
There was a problem hiding this comment.
@kotwanikunal Thanks for your review. I forgot to write a note for this. 😂
I'm not going to rename this class in this PR. I plan to use the way of dealing with other classes on the 3 classes: FakeThreadPoolMasterService BlockMasterServiceOnMaster BusyMasterServiceDisruption.
One PR to rename directly, and one PR to create a new class with the old name then make it a subclass of the class in new name.
There was a problem hiding this comment.
👍 . Hopefully you have a task to keep track of these 🙂
There was a problem hiding this comment.
😁 I listed the remaining items in this issue #3543 (comment), and I will check it before wrapping up the work.
kotwanikunal
approved these changes
Jul 28, 2022
andrross
approved these changes
Jul 28, 2022
…vice Signed-off-by: Tianli Feng <ftianli@amazon.com> # Conflicts: # server/src/main/java/org/opensearch/cluster/service/ClusterService.java # server/src/main/java/org/opensearch/common/util/concurrent/BaseFuture.java
Gradle Check (Jenkins) Run Completed with:
|
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Jul 30, 2022
…ManagerService' (#4022) To support inclusive language, the `master` terminology is going to be replaced by `cluster manager` in the code base. - Deprecate class `MasterService` and create alternative class `ClusterManagerService`. - Add a unit test to validate the method `ClusterService.getMasterService()` can still return an object in type `MasterService`. - Rename all the existing references of `MasterService` to `ClusterManagerService`, and rename the local variable names. - Deprecate public methods `ClusterServiceUtils.createMasterService(...)` and create alternative methods `createClusterManagerService(...)` Note: The class `ClusterManagerService` is a subclass of `MasterService`, the inheritance relationship is opposite from most of the other classes with `Master` in the name (that covered by issue #1684). The reason is: There is a public method that has return value in type `MasterService`, https://github.com/opensearch-project/OpenSearch/blob/388c80ad94529b1d9aad0a735c4740dce2932a32/server/src/main/java/org/opensearch/cluster/service/ClusterService.java#L221 And in the code for Performance Analyzer plugin, there is a local variable in type `MasterService`: https://github.com/opensearch-project/performance-analyzer/blob/5ee4809ac1cda6517ed871aeb12c6635203e7f1d/src/main/java/org/opensearch/performanceanalyzer/collectors/MasterServiceEventMetrics.java#L219 If making the old class `MasterService` a subclass of the new class `ClusterManagerService`, the above usage will be broken. Reversing the inheritance relationship, I'm able to keep the backwards compatibility of the method `getMasterService()` while deprecating the class `MasterService` and encourage using a new class `ClusterManagerService`. Signed-off-by: Tianli Feng <ftianli@amazon.com> (cherry picked from commit 740f75d)
5 tasks
tlfeng
pushed a commit
that referenced
this pull request
Jul 30, 2022
…ManagerService' (#4022) (#4050) To support inclusive language, the `master` terminology is going to be replaced by `cluster manager` in the code base. - Deprecate class `MasterService` and create alternative class `ClusterManagerService`. - Add a unit test to validate the method `ClusterService.getMasterService()` can still return an object in type `MasterService`. - Rename all the existing references of `MasterService` to `ClusterManagerService`, and rename the local variable names. - Deprecate public methods `ClusterServiceUtils.createMasterService(...)` and create alternative methods `createClusterManagerService(...)` Note: The class `ClusterManagerService` is a subclass of `MasterService`, the inheritance relationship is opposite from most of the other classes with `Master` in the name (that covered by issue #1684). The reason is: There is a public method that has return value in type `MasterService`, https://github.com/opensearch-project/OpenSearch/blob/388c80ad94529b1d9aad0a735c4740dce2932a32/server/src/main/java/org/opensearch/cluster/service/ClusterService.java#L221 And in the code for Performance Analyzer plugin, there is a local variable in type `MasterService`: https://github.com/opensearch-project/performance-analyzer/blob/5ee4809ac1cda6517ed871aeb12c6635203e7f1d/src/main/java/org/opensearch/performanceanalyzer/collectors/MasterServiceEventMetrics.java#L219 If making the old class `MasterService` a subclass of the new class `ClusterManagerService`, the above usage will be broken. Reversing the inheritance relationship, I'm able to keep the backwards compatibility of the method `getMasterService()` while deprecating the class `MasterService` and encourage using a new class `ClusterManagerService`. Signed-off-by: Tianli Feng <ftianli@amazon.com> (cherry picked from commit 740f75d)
tlfeng
pushed a commit
that referenced
this pull request
Aug 1, 2022
…n directory 'test/framework' (#4051) To support inclusive language, the master terminology is going to be replaced by cluster manager in the code base. After the class MasterService has been deprecated and class ClusterManagerService has been created in #4022 / commit 740f75d, the classes in `test/framework` directory with name 'MasterService' can be deprecated and renamed. - Rename the following classes in `test/framework` directory: FakeThreadPoolMasterService -> FakeThreadPoolClusterManagerService BlockMasterServiceOnMaster -> BlockClusterManagerServiceOnClusterManager BusyMasterServiceDisruption -> BusyClusterManagerServiceDisruption In the following commit, I will add back the above 3 classes with the old name and deprecate them, to keep the backwards compatibility. Signed-off-by: Tianli Feng <ftianli@amazon.com>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Aug 1, 2022
…n directory 'test/framework' (#4051) To support inclusive language, the master terminology is going to be replaced by cluster manager in the code base. After the class MasterService has been deprecated and class ClusterManagerService has been created in #4022 / commit 740f75d, the classes in `test/framework` directory with name 'MasterService' can be deprecated and renamed. - Rename the following classes in `test/framework` directory: FakeThreadPoolMasterService -> FakeThreadPoolClusterManagerService BlockMasterServiceOnMaster -> BlockClusterManagerServiceOnClusterManager BusyMasterServiceDisruption -> BusyClusterManagerServiceDisruption In the following commit, I will add back the above 3 classes with the old name and deprecate them, to keep the backwards compatibility. Signed-off-by: Tianli Feng <ftianli@amazon.com> (cherry picked from commit bea5d1a)
tlfeng
pushed a commit
that referenced
this pull request
Aug 1, 2022
…n directory 'test/framework' (#4051) (#4057) To support inclusive language, the master terminology is going to be replaced by cluster manager in the code base. After the class MasterService has been deprecated and class ClusterManagerService has been created in #4022 / commit 740f75d, the classes in `test/framework` directory with name 'MasterService' can be deprecated and renamed. - Rename the following classes in `test/framework` directory: FakeThreadPoolMasterService -> FakeThreadPoolClusterManagerService BlockMasterServiceOnMaster -> BlockClusterManagerServiceOnClusterManager BusyMasterServiceDisruption -> BusyClusterManagerServiceDisruption In the following commit, I will add back the above 3 classes with the old name and deprecate them, to keep the backwards compatibility. Signed-off-by: Tianli Feng <ftianli@amazon.com> (cherry picked from commit bea5d1a) Co-authored-by: Tianli Feng <ftianli@amazon.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
To support inclusive language, the
masterterminology is going to be replaced bycluster managerin the code base.MasterServiceand create alternative classClusterManagerService.ClusterService.getMasterService()can still return an object in typeMasterService.MasterServicetoClusterManagerService, and rename the local variable names.ClusterServiceUtils.createMasterService(...)and create alternative methodscreateClusterManagerService(...)Note:
The class
ClusterManagerServiceis a subclass ofMasterService, the inheritance relationship is opposite from most of the other classes withMasterin the name (that covered by issue #1684).The reason is:
There is a public method that has return value in type
MasterService,OpenSearch/server/src/main/java/org/opensearch/cluster/service/ClusterService.java
Line 221 in 388c80a
And in the code for Performance Analyzer plugin, there is a local variable in type
MasterService:https://github.com/opensearch-project/performance-analyzer/blob/5ee4809ac1cda6517ed871aeb12c6635203e7f1d/src/main/java/org/opensearch/performanceanalyzer/collectors/MasterServiceEventMetrics.java#L219
If making the old class
MasterServicea subclass of the new classClusterManagerService, the above usage will be broken.Reversing the inheritance relationship, I'm able to keep the backwards compatibility of the method
getMasterService()while deprecating the classMasterServiceand encourage using a new classClusterManagerService.Issues Resolved
A part of issue #3543 and #3544 (comment)
Check List
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.