Rename public classes with 'Master' to 'ClusterManager' #3619

tlfeng · 2022-06-17T03:42:51Z

Description

Replace master terminology by cluster manager in the public Java APIs to support inclusive language.
The PR deal with the public class name in the repository (except for those covered in issue #3542).

Replace Master to ClusterManager for all the classes, including all the references to the classes.

The above changes are done by the Rename refactoring feature of IntelliJ IDEA, so that both the definition and reference can be renamed.

The next PR will be like de21446, adding back the classes in old name for backwards compatibility.

List of classes that renamed in this PR:
sever directory:
interface LocalNodeMasterListener -> LocalNodeClusterManagerListener
final class MasterNodeChangePredicate -> ClusterManagerNodeChangePredicate
NotMasterException -> NotClusterManagerException
NoMasterBlockService -> NoClusterManagerBlockService
UnsafeBootstrapMasterCommand - UnsafeBootstrapClusterManagerCommand
MasterService -> ClusterManagerService
MasterNotDiscoveredException -> ClusterManagerNotDiscoveredException
RestMasterAction -> RestClusterManagerAction
test/framework directory:
FakeThreadPoolMasterService -> FakeThreadPoolClusterManagerService
BlockMasterServiceOnMaster -> BlockClusterManagerServiceOnMaster
BusyMasterServiceDisruption -> BusyClusterManagerServiceDisruption

Issues Resolved

The first step to resolve issue #3543

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

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: Tianli Feng <[email protected]>

opensearch-ci-bot · 2022-06-17T04:13:58Z

❌ Gradle Check failure f4d28f1
Log 6091

Reports 6091

tlfeng · 2022-06-17T04:37:47Z

Log 6091 shows the test failure in issue #3579

Signed-off-by: Tianli Feng <[email protected]> # Conflicts: # server/src/internalClusterTest/java/org/opensearch/action/admin/indices/exists/IndicesExistsIT.java

Signed-off-by: Tianli Feng <[email protected]>

…eption in text Signed-off-by: Tianli Feng <[email protected]>

… class Signed-off-by: Tianli Feng <[email protected]>

Signed-off-by: Tianli Feng <[email protected]>

opensearch-ci-bot · 2022-06-22T05:50:59Z

❌ Gradle Check failure a0b3f74
Log 6206

Reports 6206

Signed-off-by: Tianli Feng <[email protected]>

opensearch-ci-bot · 2022-06-22T06:38:08Z

✅ Gradle Check success 5f55097
Log 6207

Reports 6207

Poojita-Raj · 2022-06-22T22:46:20Z

server/src/main/java/org/opensearch/cluster/service/ClusterApplierService.java

@@ -277,7 +277,7 @@ public void removeTimeoutListener(TimeoutClusterStateListener listener) {
    /**
     * Add a listener for on/off local node cluster-manager events
     */
-    public void addLocalNodeMasterListener(LocalNodeMasterListener listener) {
+    public void addLocalNodeMasterListener(LocalNodeClusterManagerListener listener) {


I think addLocalNodeMasterListener method should either be renamed as part of this PR to addLocalNodeClusterManagerListener or should be documented/added in issue #3543 in the second part of the issue.

I will rename the method addLocalNodeMasterListener in issue #3544, which is being changed in PR #3647.
In issue #3543, only the methods within the above list of classes will be renamed, and of course, in a following PR as well.
There will be 3 PRs to address #3543:

Rename "Master" to "ClusterManager" in the classes names (this one)

Add the classes with the old "Master" name back to keep the compatibility

Rename and deprecate the public methods and variables in the above classes.

Poojita-Raj · 2022-06-22T22:56:24Z

server/src/main/java/org/opensearch/cluster/service/ClusterService.java

        clusterApplierService.addLocalNodeMasterListener(listener);
    }

-    public MasterService getMasterService() {
-        return masterService;
+    public ClusterManagerService getMasterService() {


getMasterService() should be renamed in this PR to getClusterManagerService() or this change should be documented in the parent issue #3543 under part 2

I will rename it when resolving issue #3544, which is being changed in PR #3647.

Poojita-Raj · 2022-06-22T22:58:43Z

test/framework/src/main/java/org/opensearch/test/ClusterServiceUtils.java

@@ -77,7 +77,7 @@ public static MasterService createMasterService(ThreadPool threadPool, ClusterSt
        return clusterManagerService;
    }

-    public static MasterService createMasterService(ThreadPool threadPool, DiscoveryNode localNode) {
+    public static ClusterManagerService createMasterService(ThreadPool threadPool, DiscoveryNode localNode) {


renaming of createMasterService to createClusterManagerService must be documented in parent issue #3543

Thanks! I will rename it when resolving issue #3544

tlfeng · 2022-06-22T23:26:46Z

Hi @Poojita-Raj, thank you so much for reviewing my PR!

Poojita-Raj

Thanks for linking me to the issues that will be covering these methods' renaming. LGTM!

tlfeng · 2022-06-23T20:29:40Z

@Poojita-Raj Thanks a again for your approval! 👍👍
Please hold on backporting this change to 2.x branch, since I need to revise the plan for the renamed classes to make sure the compatibility is kept.

Signed-off-by: Tianli Feng <[email protected]>

nknize

Looks like there's a merge conflict and a couple PR comments that still need to be addressed but otherwise LGTM.

Signed-off-by: Tianli Feng <[email protected]> # Conflicts: # server/src/internalClusterTest/java/org/opensearch/discovery/ClusterManagerDisruptionIT.java # server/src/main/java/org/opensearch/cluster/coordination/NoClusterManagerBlockService.java

github-actions · 2022-07-11T18:40:15Z

Gradle Check (Jenkins) Run Completed with:

RESULT: FAILURE ❌
URL: https://build.ci.opensearch.org/job/gradle-check/386/
CommitID: 7267e5282636c5e1dd731e3af7207163102b3103

github-actions · 2022-07-11T19:03:48Z

Gradle Check (Jenkins) Run Completed with:

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

Replace master terminology by cluster manager in the public Java APIs to support inclusive language. The PR deal with the public class name in the repository (except for those covered in issue #3542). * Replace Master to ClusterManager for all the classes, including all the references to the classes. The next PR will be like de21446, adding back the classes in old name for backwards compatibility. List of classes that renamed in this PR: sever directory: interface LocalNodeMasterListener -> LocalNodeClusterManagerListener final class MasterNodeChangePredicate -> ClusterManagerNodeChangePredicate NotMasterException -> NotClusterManagerException NoMasterBlockService -> NoClusterManagerBlockService UnsafeBootstrapMasterCommand - UnsafeBootstrapClusterManagerCommand MasterService -> UnsafeBootstrapClusterManagerCommand MasterNotDiscoveredException -> ClusterManagerNotDiscoveredException RestMasterAction -> RestClusterManagerAction test/framework directory: FakeThreadPoolMasterService -> FakeThreadPoolClusterManagerService BlockMasterServiceOnMaster -> BlockClusterManagerServiceOnMaster BusyMasterServiceDisruption -> BusyClusterManagerServiceDisruption Signed-off-by: Tianli Feng <[email protected]> (cherry picked from commit a7e113a)

#3870) * Rename public classes with 'Master' to 'ClusterManager' (#3619) Replace master terminology by cluster manager in the public Java APIs to support inclusive language. The PR deal with the public class name in the repository (except for those covered in issue #3542). * Replace `Master` to `ClusterManager` in most of the class names (except `MasterService` class), including all the references to the classes. The next PR will be #3871, adding back the classes in old name for backwards compatibility. List of classes that renamed in this PR: `sever` directory: interface LocalNodeMasterListener -> LocalNodeClusterManagerListener final class MasterNodeChangePredicate -> ClusterManagerNodeChangePredicate NotMasterException -> NotClusterManagerException NoMasterBlockService -> NoClusterManagerBlockService UnsafeBootstrapMasterCommand - UnsafeBootstrapClusterManagerCommand MasterNotDiscoveredException -> ClusterManagerNotDiscoveredException RestMasterAction -> RestClusterManagerAction List of classes that not renamed: `sever` directory: MasterService `test/framework` directory: FakeThreadPoolMasterService BlockMasterServiceOnMaster BusyMasterServiceDisruption Signed-off-by: Tianli Feng <[email protected]> (cherry picked from commit a7e113a)

- Add back the usage of old names for some classes for backwards compatibility. Those public classes were renamed from "master" to "cluster manager" In PR #3619 / commit a7e113a. - Add a unit test to validate the backwards compatibility of interface `LocalNodeMasterListener` remains. - Revert the renaming of class `MasterService`, `FakeThreadPoolMasterService`, `BlockMasterServiceOnMaster` and `BusyMasterServiceDisruption`, as well as instance variable names of class `MasterService`. Because I couldn't solve the compatibility problem of a public method `public ClusterManagerService getMasterService()` (#3871 (comment)) **List of classes that renamed in previous PR:** In this PR, the usages of the old names should all be restored. `sever` directory: interface LocalNodeMasterListener -> LocalNodeClusterManagerListener final class MasterNodeChangePredicate -> ClusterManagerNodeChangePredicate NotMasterException -> NotClusterManagerException NoMasterBlockService -> NoClusterManagerBlockService UnsafeBootstrapMasterCommand - UnsafeBootstrapClusterManagerCommand MasterNotDiscoveredException -> ClusterManagerNotDiscoveredException RestMasterAction -> RestClusterManagerAction **List of classes that not renamed:** `sever` directory: MasterService `test/framework` directory: FakeThreadPoolMasterService BlockMasterServiceOnMaster BusyMasterServiceDisruption Signed-off-by: Tianli Feng <[email protected]>

…ect#3871) - Add back the usage of old names for some classes for backwards compatibility. Those public classes were renamed from "master" to "cluster manager" In PR opensearch-project#3619 / commit opensearch-project@a7e113a. - Add a unit test to validate the backwards compatibility of interface `LocalNodeMasterListener` remains. - Revert the renaming of class `MasterService`, `FakeThreadPoolMasterService`, `BlockMasterServiceOnMaster` and `BusyMasterServiceDisruption`, as well as instance variable names of class `MasterService`. Because I couldn't solve the compatibility problem of a public method `public ClusterManagerService getMasterService()` (opensearch-project#3871 (comment)) **List of classes that renamed in previous PR:** In this PR, the usages of the old names should all be restored. `sever` directory: interface LocalNodeMasterListener -> LocalNodeClusterManagerListener final class MasterNodeChangePredicate -> ClusterManagerNodeChangePredicate NotMasterException -> NotClusterManagerException NoMasterBlockService -> NoClusterManagerBlockService UnsafeBootstrapMasterCommand - UnsafeBootstrapClusterManagerCommand MasterNotDiscoveredException -> ClusterManagerNotDiscoveredException RestMasterAction -> RestClusterManagerAction **List of classes that not renamed:** `sever` directory: MasterService `test/framework` directory: FakeThreadPoolMasterService BlockMasterServiceOnMaster BusyMasterServiceDisruption Signed-off-by: Tianli Feng <[email protected]>

…3914) * Deprecate public class names with master terminology (#3871) - Add back the usage of old names for some classes for backwards compatibility. Those public classes were renamed from "master" to "cluster manager" In PR #3619 / commit a7e113a. - Add a unit test to validate the backwards compatibility of interface `LocalNodeMasterListener` remains. - Revert the renaming of class `MasterService`, `FakeThreadPoolMasterService`, `BlockMasterServiceOnMaster` and `BusyMasterServiceDisruption`, as well as instance variable names of class `MasterService`. Because I couldn't solve the compatibility problem of a public method `public ClusterManagerService getMasterService()` (#3871 (comment)) **List of classes that renamed in previous PR:** In this PR, the usages of the old names should all be restored. `sever` directory: interface LocalNodeMasterListener -> LocalNodeClusterManagerListener final class MasterNodeChangePredicate -> ClusterManagerNodeChangePredicate NotMasterException -> NotClusterManagerException NoMasterBlockService -> NoClusterManagerBlockService UnsafeBootstrapMasterCommand - UnsafeBootstrapClusterManagerCommand MasterNotDiscoveredException -> ClusterManagerNotDiscoveredException RestMasterAction -> RestClusterManagerAction **List of classes that not renamed:** `sever` directory: MasterService `test/framework` directory: FakeThreadPoolMasterService BlockMasterServiceOnMaster BusyMasterServiceDisruption Signed-off-by: Tianli Feng <[email protected]>

Rename public classes with master to cluster manager

f4d28f1

Signed-off-by: Tianli Feng <[email protected]>

tlfeng added enhancement Enhancement or improvement to existing feature or request v2.1.0 Issues and PRs related to version 2.1.0 v3.0.0 Issues and PRs related to version 3.0.0 backport 2.x Backport to 2.x branch labels Jun 17, 2022

Tianli Feng added 5 commits June 21, 2022 22:23

Merge branch 'main' into rename-master-class

998c26d

Signed-off-by: Tianli Feng <[email protected]> # Conflicts: # server/src/internalClusterTest/java/org/opensearch/action/admin/indices/exists/IndicesExistsIT.java

Rename MasterService to ClusterManagerService in text

4872f5e

Signed-off-by: Tianli Feng <[email protected]>

Rename MasterNotDiscoveredException to ClusterManagerNotDiscoveredExc…

b92f7d4

…eption in text Signed-off-by: Tianli Feng <[email protected]>

Rename MasterNodeChangePredicate to ClusterManagerNodeChangePredicate…

dfd9a4f

… class Signed-off-by: Tianli Feng <[email protected]>

Adjust format by spotlessApply task

a0b3f74

Signed-off-by: Tianli Feng <[email protected]>

change a .setMasterNodeTimeout to .setClusterManagerNodeTimeout

5f55097

Signed-off-by: Tianli Feng <[email protected]>

tlfeng marked this pull request as ready for review June 22, 2022 06:41

tlfeng requested review from a team and reta as code owners June 22, 2022 06:41

tlfeng marked this pull request as draft June 22, 2022 06:42

tlfeng marked this pull request as ready for review June 22, 2022 16:22

Poojita-Raj reviewed Jun 22, 2022

View reviewed changes

Poojita-Raj approved these changes Jun 23, 2022

View reviewed changes

tlfeng added v2.2.0 and removed v2.1.0 Issues and PRs related to version 2.1.0 labels Jun 24, 2022

Merge branch 'main' into rename-master-class

6cd4b17

Signed-off-by: Tianli Feng <[email protected]>

nknize approved these changes Jun 29, 2022

View reviewed changes

tlfeng force-pushed the rename-master-class branch from 7267e52 to fdb869d Compare July 11, 2022 18:39

tlfeng merged commit a7e113a into opensearch-project:main Jul 12, 2022

opensearch-trigger-bot bot mentioned this pull request Jul 12, 2022

[Backport 2.x] Rename public classes with 'Master' to 'ClusterManager' #3870

Merged

tlfeng deleted the rename-master-class branch July 12, 2022 21:52

tlfeng mentioned this pull request Jul 12, 2022

Deprecate public class names with master terminology #3871

Merged

5 tasks

tlfeng mentioned this pull request Jul 15, 2022

[2.x] Deprecate public class names with master terminology (#3871) #3914

Merged

5 tasks

tlfeng mentioned this pull request Jul 19, 2022

Deprecate public or protected class that contains "master" terminology in 'server' and 'test/framework' directory #3543

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename public classes with 'Master' to 'ClusterManager' #3619

Rename public classes with 'Master' to 'ClusterManager' #3619

tlfeng commented Jun 17, 2022 •

edited

Loading

opensearch-ci-bot commented Jun 17, 2022

tlfeng commented Jun 17, 2022

opensearch-ci-bot commented Jun 22, 2022

opensearch-ci-bot commented Jun 22, 2022

Poojita-Raj Jun 22, 2022

tlfeng Jun 22, 2022 •

edited

Loading

Poojita-Raj Jun 22, 2022

tlfeng Jun 22, 2022

Poojita-Raj Jun 22, 2022

tlfeng Jun 22, 2022

tlfeng commented Jun 22, 2022

Poojita-Raj left a comment

tlfeng commented Jun 23, 2022

nknize left a comment

github-actions bot commented Jul 11, 2022

github-actions bot commented Jul 11, 2022

Rename public classes with 'Master' to 'ClusterManager' #3619

Rename public classes with 'Master' to 'ClusterManager' #3619

Conversation

tlfeng commented Jun 17, 2022 • edited Loading

Description

Issues Resolved

Check List

opensearch-ci-bot commented Jun 17, 2022

tlfeng commented Jun 17, 2022

opensearch-ci-bot commented Jun 22, 2022

opensearch-ci-bot commented Jun 22, 2022

Poojita-Raj Jun 22, 2022

Choose a reason for hiding this comment

tlfeng Jun 22, 2022 • edited Loading

Choose a reason for hiding this comment

Poojita-Raj Jun 22, 2022

Choose a reason for hiding this comment

tlfeng Jun 22, 2022

Choose a reason for hiding this comment

Poojita-Raj Jun 22, 2022

Choose a reason for hiding this comment

tlfeng Jun 22, 2022

Choose a reason for hiding this comment

tlfeng commented Jun 22, 2022

Poojita-Raj left a comment

Choose a reason for hiding this comment

tlfeng commented Jun 23, 2022

nknize left a comment

Choose a reason for hiding this comment

github-actions bot commented Jul 11, 2022

Gradle Check (Jenkins) Run Completed with:

github-actions bot commented Jul 11, 2022

Gradle Check (Jenkins) Run Completed with:

tlfeng commented Jun 17, 2022 •

edited

Loading

tlfeng Jun 22, 2022 •

edited

Loading