Replace internal usages of 'master' term in 'server/src/main' directory #2519

tlfeng · 2022-03-19T08:44:22Z

Description

Replace the non-inclusive terminology "master" with "cluster manager" in code comments, internal variable/method/class names, in server/src/main directory.
Backwards compatibility is not impacted.
The PR is split from Replace non-inclusive terminology 'master' in code comments and internal variable/method/class names #2150

Replacement rules:

master -> cluster_manager or clusterManager (variable name) or cluster-manager (code comment)
Master -> ClusterManager

Issues Resolved

A part of #1548

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.

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

opensearch-ci-bot · 2022-03-19T08:53:40Z

❌ Gradle Check failure 11dcbd4
Log 3548

Reports 3548

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

opensearch-ci-bot · 2022-03-19T09:28:21Z

❌ Gradle Check failure 89ad4b9
Log 3550

Reports 3550

tlfeng · 2022-03-19T17:07:51Z

In log 3550:

REPRODUCE WITH: ./gradlew ':server:internalClusterTest' --tests "org.opensearch.blocks.SimpleBlocksIT.testAddBlockWhileDeletingIndices" -Dtests.seed=99275B89D9E202D1 -Dtests.security.manager=true -Dtests.jvm.argline="-XX:TieredStopAtLevel=1 -XX:ReservedCodeCacheSize=64m" -Dtests.locale=es-VE -Dtests.timezone=America/El_Salvador -Druntime.java=17

org.opensearch.blocks.SimpleBlocksIT > testAddBlockWhileDeletingIndices FAILED
    com.carrotsearch.randomizedtesting.UncaughtExceptionError: Captured an uncaught exception in thread: Thread[id=977, name=Thread-14, state=RUNNABLE, group=TGRP-SimpleBlocksIT]
        at __randomizedtesting.SeedInfo.seed([99275B89D9E202D1:C851EB9F814D483B]:0)

        Caused by:
        java.lang.AssertionError: 
        Expected: an instance of org.opensearch.index.IndexNotFoundException
             but: <ProcessClusterEventTimeoutException[failed to process cluster event (delete-index [[rlccusjhzk/T9k1DjV3TmavEjk5cD1tiA]]) within 30s]> is a org.opensearch.cluster.metadata.ProcessClusterEventTimeoutException
            at __randomizedtesting.SeedInfo.seed([99275B89D9E202D1]:0)
            at org.hamcrest.MatcherAssert.assertThat(MatcherAssert.java:18)
            at org.junit.Assert.assertThat(Assert.java:964)
            at org.junit.Assert.assertThat(Assert.java:930)
            at org.opensearch.blocks.SimpleBlocksIT.lambda$testAddBlockWhileDeletingIndices$14(SimpleBlocksIT.java:483)
            at org.opensearch.blocks.SimpleBlocksIT.lambda$testAddBlockWhileDeletingIndices$15(SimpleBlocksIT.java:498)

It's reported in issue #2472
start gradle check

opensearch-ci-bot · 2022-03-19T17:43:23Z

❌ Gradle Check failure 89ad4b9
Log 3556

Reports 3556

tlfeng · 2022-03-19T17:50:42Z

In log 3556:

> Task :server:internalClusterTest

REPRODUCE WITH: ./gradlew ':server:internalClusterTest' --tests "org.opensearch.search.SearchCancellationIT.testCancellationDuringQueryPhaseUsingRequestParameter" -Dtests.seed=FB910982D2688C51 -Dtests.security.manager=true -Dtests.jvm.argline="-XX:TieredStopAtLevel=1 -XX:ReservedCodeCacheSize=64m" -Dtests.locale=it -Dtests.timezone=America/Los_Angeles -Druntime.java=17

org.opensearch.search.SearchCancellationIT > testCancellationDuringQueryPhaseUsingRequestParameter FAILED
    java.lang.AssertionError: At least one shard should have failed. Actual: 0
        at __randomizedtesting.SeedInfo.seed([FB910982D2688C51:7903394CD1A4D942]:0)
        at org.junit.Assert.fail(Assert.java:89)
        at org.junit.Assert.failEquals(Assert.java:187)
        at org.junit.Assert.assertNotEquals(Assert.java:201)
        at org.opensearch.search.SearchCancellationIT.ensureSearchWasCancelled(SearchCancellationIT.java:167)
        at org.opensearch.search.SearchCancellationIT.testCancellationDuringQueryPhaseUsingRequestParameter(SearchCancellationIT.java:247)

I couldn't reproduce it locally.

opensearch-ci-bot · 2022-03-19T19:00:15Z

❌ Gradle Check failure eec54ae
Log 3559

Reports 3559

tlfeng · 2022-03-19T19:03:12Z

In log 3559:

REPRODUCE WITH: ./gradlew ':server:internalClusterTest' --tests "org.opensearch.gateway.RecoveryFromGatewayIT.testReuseInFileBasedPeerRecovery" -Dtests.seed=E5B8689123BC8C1E -Dtests.security.manager=true -Dtests.jvm.argline="-XX:TieredStopAtLevel=1 -XX:ReservedCodeCacheSize=64m" -Dtests.locale=es-GT -Dtests.timezone=Pacific/Norfolk -Druntime.java=17

org.opensearch.gateway.RecoveryFromGatewayIT > testReuseInFileBasedPeerRecovery FAILED
    java.lang.AssertionError: shard [test][0] on node [node_t1] has pending operations:
     --> RetentionLeaseBackgroundSyncAction.Request{retentionLeases=RetentionLeases{primaryTerm=1, version=1498, leases={peer_recovery/VhzdIrX0Taayi_pp9rophg=RetentionLease{id='peer_recovery/VhzdIrX0Taayi_pp9rophg', retainingSequenceNumber=1559, timestamp=1647714373479, source='peer recovery'}, peer_recovery/CqBbYXt5QiSw8OQuzCsgqw=RetentionLease{id='peer_recovery/CqBbYXt5QiSw8OQuzCsgqw', retainingSequenceNumber=1559, timestamp=1647714373479, source='peer recovery'}}}, shardId=[test][0], timeout=1m, index='test', waitForActiveShards=0}
    	at org.opensearch.index.shard.IndexShardOperationPermits.acquire(IndexShardOperationPermits.java:248)
    	at org.opensearch.index.shard.IndexShard.acquirePrimaryOperationPermit(IndexShard.java:3146)
    	at org.opensearch.action.support.replication.TransportReplicationAction.acquirePrimaryOperationPermit(TransportReplicationAction.java:1116)
    	at org.opensearch.action.support.replication.TransportReplicationAction$AsyncPrimaryAction.doRun(TransportReplicationAction.java:433)
    	at org.opensearch.common.util.concurrent.AbstractRunnable.run(AbstractRunnable.java:50)
    	at org.opensearch.action.support.replication.TransportReplicationAction.handlePrimaryRequest(TransportReplicationAction.java:377)

It's reported in issue #1746.
start gradle check

opensearch-ci-bot · 2022-03-19T19:31:59Z

❌ Gradle Check failure eec54ae
Log 3561

Reports 3561

tlfeng · 2022-03-19T19:35:16Z

In log 3561:

REPRODUCE WITH: ./gradlew ':qa:remote-clusters:integTest' --tests "org.opensearch.cluster.remote.test.RemoteClustersIT.testHAProxyModeConnectionWorks" -Dtests.seed=6C712ACD74C2F3F0 -Dtests.security.manager=true -Dtests.jvm.argline="-XX:TieredStopAtLevel=1 -XX:ReservedCodeCacheSize=64m" -Dtests.locale=lv -Dtests.timezone=America/Guyana -Druntime.java=17

org.opensearch.cluster.remote.test.RemoteClustersIT > testHAProxyModeConnectionWorks FAILED
    java.lang.AssertionError
        at __randomizedtesting.SeedInfo.seed([6C712ACD74C2F3F0:6B07FF064F4485AD]:0)
        at org.junit.Assert.fail(Assert.java:87)
        at org.junit.Assert.assertTrue(Assert.java:42)
        at org.junit.Assert.assertTrue(Assert.java:53)
        at org.opensearch.cluster.remote.test.RemoteClustersIT.testHAProxyModeConnectionWorks(RemoteClustersIT.java:125)

It's reported in issue #1703.
start gradle check

opensearch-ci-bot · 2022-03-19T20:05:05Z

❌ Gradle Check failure eec54ae
Log 3563

Reports 3563

tlfeng · 2022-03-19T21:25:11Z

In Log 3563:

> Task :qa:rolling-upgrade:v1.3.0#oneThirdUpgradedTest

REPRODUCE WITH: ./gradlew ':qa:rolling-upgrade:v1.3.0#oneThirdUpgradedTest' --tests "org.opensearch.upgrades.IndexingIT.testAutoIdWithOpTypeCreate" -Dtests.seed=512653CB7D65CBC7 -Dtests.security.manager=true -Dtests.jvm.argline="-XX:TieredStopAtLevel=1 -XX:ReservedCodeCacheSize=64m" -Dtests.locale=ja-JP-u-ca-japanese-x-lvariant-JP -Dtests.timezone=Antarctica/Rothera -Druntime.java=17

org.opensearch.upgrades.IndexingIT > testAutoIdWithOpTypeCreate FAILED
    java.lang.AssertionError: there are still running tasks:
    {time_in_queue=389ms, time_in_queue_millis=389, source=shard-started StartedShardEntry{shardId [[recover_and_create_leases_in_promotion][4]], allocationId [gt3B9PnTSYePRTVS4QZdFA], primary term [1], message [after peer recovery]}, executing=true, priority=URGENT, insert_order=301}
    {time_in_queue=388ms, time_in_queue_millis=388, source=shard-started StartedShardEntry{shardId [[recover_and_create_leases_in_promotion][0]], allocationId [yN6_RNTSQViP8oogDc5dQw], primary term [2], message [after peer recovery]}, executing=false, priority=URGENT, insert_order=302}
        at __randomizedtesting.SeedInfo.seed([512653CB7D65CBC7:11BDA0F374A0169E]:0)
        at org.junit.Assert.fail(Assert.java:89)
        at org.opensearch.test.rest.OpenSearchRestTestCase.lambda$waitForClusterStateUpdatesToFinish$7(OpenSearchRestTestCase.java:783)
        at org.opensearch.test.OpenSearchTestCase.assertBusy(OpenSearchTestCase.java:1060)
        at org.opensearch.test.rest.OpenSearchRestTestCase.waitForClusterStateUpdatesToFinish(OpenSearchRestTestCase.java:774)
        at org.opensearch.test.rest.OpenSearchRestTestCase.cleanUpCluster(OpenSearchRestTestCase.java:358)
...

I couldn't reproduce locally. Created issue 2522 #2522

tlfeng · 2022-03-19T21:29:52Z

start gradle check

opensearch-ci-bot · 2022-03-19T22:21:41Z

✅ Gradle Check success eec54ae
Log 3566

Reports 3566

nknize

Since this PR is "Replace internal usage of master..." do you also want to (shift+F6) refactor ClusterHealthResponse.java#L279 from hasDiscoveredMaster() to hasDiscoveredManager() (or some method name consistent w/ everything else)? Or are you worried that will unknowingly break a plugin that might use it (since the method is public)?

tlfeng · 2022-03-22T04:12:51Z

Since this PR is "Replace internal usage of master..." do you also want to (shift+F6) refactor ClusterHealthResponse.java#L279 from hasDiscoveredMaster() to hasDiscoveredManager() (or some method name consistent w/ everything else)? Or are you worried that will unknowingly break a plugin that might use it (since the method is public)?

Hi @nknize, thanks a lot for reviewing my PR! Yeah, that's my concern, and I wouldn't rename the public methods that published to Maven as Java API in version 2.x, in case the change breaks too many plugins or clients.
There was a discussion in PR #2453 (comment).
Changing such Java APIs will be tracked in issue #1684.
I will rename most of the APIs in at least version 3.0 to give plugins and clients more time, and for some common used APIs, I can follow the normal deprecation path to add "@Deprecation" annotation and create alternative method.

xuezhou25 · 2022-03-23T00:24:46Z

server/src/main/java/org/opensearch/action/admin/cluster/state/ClusterStateResponse.java

    }

-    private static String getMasterNodeId(ClusterState clusterState) {
+    private static String getClusterManagerNodeId(ClusterState clusterState) {
        if (clusterState == null) {
            return null;
        }


Should the getMasterNodeId below in line 130 need to be changed to getClusterManagerNodeId?

Hi @xuezhou25 , thanks a lot for your time in reviewing my PR! 👍👍.
the method getMasterNodeId() in line 130 is published to Maven as Java API. Please see my comment above: #2519 (comment).
Although the normal way to rename the Java API is to deprecate old method and create new alternative method, there are too many public methods contain name "master", and it will introduce too many extra codes to deprecate them all. So I plan to rename them all in a future major version, and give the other plugins and clients enough notice before renaming.

xuezhou25 · 2022-03-23T00:28:16Z

server/src/main/java/org/opensearch/action/support/master/TransportMasterNodeAction.java

@@ -201,10 +201,10 @@ protected void doStart(ClusterState clusterState) {
                        logger.debug("no known master node, scheduling a retry");


line 70
line 185
line 201
line 219
line 282
master->cluster-manager

Good catch! Thank you, you are so carefully. Those usages are all missed... 😅
I will change them.

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

opensearch-ci-bot · 2022-04-26T16:57:53Z

❌ Gradle Check failure d5660fd
Log 4804

Reports 4804

opensearch-ci-bot · 2022-04-26T17:07:52Z

❌ Gradle Check failure e6c10f2
Log 4808

Reports 4808

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

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

opensearch-ci-bot · 2022-04-26T23:00:02Z

❌ Gradle Check failure 0c110ca
Log 4818

Reports 4818

opensearch-ci-bot · 2022-04-26T23:03:11Z

❌ Gradle Check failure 4d50c6f
Log 4819

Reports 4819

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

opensearch-ci-bot · 2022-04-27T00:29:01Z

✅ Gradle Check success cc57d7e
Log 4820

Reports 4820

opensearch-trigger-bot · 2022-04-27T13:08:23Z

The backport to 2.x failed:

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

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.x 2.x
# Navigate to the new working tree
cd .worktrees/backport-2.x
# Create a new branch
git switch --create backport/backport-2519-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 79eb3b04922f4d4688372b93550ded9feffd7338
# Push it to GitHub
git push --set-upstream origin backport/backport-2519-to-2.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.x

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

…ry (opensearch-project#2519) Signed-off-by: Tianli Feng <[email protected]>

…ry (#2519) (#3165) Signed-off-by: Tianli Feng <[email protected]>

Replace internal usages of 'master' terminology in server/src/main di…

11dcbd4

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

tlfeng requested a review from a team as a code owner March 19, 2022 08:44

This was referenced Mar 19, 2022

Replace "master" terminology in code comments, and internal variable, method and class names #1548

Closed

Replace internal usages of 'master' terminology in server directory #2518

Closed

Tianli Feng added 2 commits March 19, 2022 01:53

Restore rename DISCOVERED_MASTER in ClusterHealthResponse

e94fc0a

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

Rename two methods in unit tests

89ad4b9

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

tlfeng added enhancement Enhancement or improvement to existing feature or request v2.0.0 Version 2.0.0 labels Mar 19, 2022

tlfeng changed the title ~~Replace internal usages of 'master' terminology in server/src/main directory~~ Replace internal usages of 'master' term in server/src/main directory Mar 19, 2022

tlfeng changed the title ~~Replace internal usages of 'master' term in server/src/main directory~~ Replace internal usages of 'master' term in 'server/src/main' directory Mar 19, 2022

tlfeng mentioned this pull request Mar 19, 2022

Replace non-inclusive terminology 'master' in code comments and internal variable/method/class names #2150

Closed

5 tasks

Merge branch 'main' into replace-master-int-server-main

eec54ae

tlfeng mentioned this pull request Mar 19, 2022

[CI] flaky test faiure - o.o.upgrades.IndexingIT.testAutoIdWithOpTypeCreate - in v1.3.0#oneThirdUpgradedTest #2522

Closed

nknize reviewed Mar 22, 2022

View reviewed changes

xuezhou25 reviewed Mar 23, 2022

View reviewed changes

Tianli Feng added 4 commits April 21, 2022 22:21

Replace master word in more classes

6636663

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

Replace master word in more classes

8f27cf7

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

Replace master word in DiscoveryNodes classes

32534b8

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

Replace master word in more classes

d5660fd

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

tlfeng requested a review from reta as a code owner April 26, 2022 16:26

Correct mistakes

e6c10f2

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

tlfeng added v2.1.0 Issues and PRs related to version 2.1.0 backport 2.x Backport to 2.x branch and removed WIP Work in progress labels Apr 26, 2022

Tianli Feng added 3 commits April 26, 2022 14:25

Merge remote-tracking branch 'upstream/main' into replace-master-int-…

be0acc3

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

Adjust format by spotlessApply task

0c110ca

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

Change MASTER__NODE_BOOTSTRAPPED_MSG in test

4d50c6f

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

Fix SnapshotDisruptionIT by renaming to cluster-manager

cc57d7e

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

dblock approved these changes Apr 27, 2022

View reviewed changes

dblock merged commit 79eb3b0 into opensearch-project:main Apr 27, 2022

tlfeng deleted the replace-master-int-server-main branch April 27, 2022 16:11

tlfeng mentioned this pull request May 3, 2022

[2.x] Replace internal usages of 'master' term in 'server/src/main' directory (#2519) #3165

Merged

5 tasks

tlfeng pushed a commit to tlfeng/OpenSearch that referenced this pull request May 3, 2022

Replace internal usages of 'master' term in 'server/src/main' directo…

eb041f0

…ry (opensearch-project#2519) Signed-off-by: Tianli Feng <[email protected]>

tlfeng mentioned this pull request May 3, 2022

[2.0] Replace 'master' terminology with 'cluster manager' in log messages in 'server/src/main' directory - Part 2 #3174

Merged

5 tasks

dblock pushed a commit that referenced this pull request May 4, 2022

Replace internal usages of 'master' term in 'server/src/main' directo…

acbcf76

…ry (#2519) (#3165) Signed-off-by: Tianli Feng <[email protected]>

tlfeng mentioned this pull request Jun 24, 2022

[BUG] Classes that implement interface 'o.o.cluster.LocalNodeMasterListener' should not have to implement abstract method 'onClusterManager()' and 'offClusterManager()' #3688

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Replace internal usages of 'master' term in 'server/src/main' directory #2519

Replace internal usages of 'master' term in 'server/src/main' directory #2519

tlfeng commented Mar 19, 2022 •

edited

Loading

opensearch-ci-bot commented Mar 19, 2022

opensearch-ci-bot commented Mar 19, 2022

tlfeng commented Mar 19, 2022

opensearch-ci-bot commented Mar 19, 2022

tlfeng commented Mar 19, 2022 •

edited

Loading

opensearch-ci-bot commented Mar 19, 2022

tlfeng commented Mar 19, 2022

opensearch-ci-bot commented Mar 19, 2022

tlfeng commented Mar 19, 2022

opensearch-ci-bot commented Mar 19, 2022

tlfeng commented Mar 19, 2022 •

edited

Loading

tlfeng commented Mar 19, 2022

opensearch-ci-bot commented Mar 19, 2022

nknize left a comment

tlfeng commented Mar 22, 2022

xuezhou25 Mar 23, 2022

tlfeng Mar 23, 2022

xuezhou25 Mar 23, 2022 •

edited

Loading

tlfeng Mar 23, 2022 •

edited

Loading

opensearch-ci-bot commented Apr 26, 2022

opensearch-ci-bot commented Apr 26, 2022

opensearch-ci-bot commented Apr 26, 2022

opensearch-ci-bot commented Apr 26, 2022

opensearch-ci-bot commented Apr 27, 2022

opensearch-trigger-bot bot commented Apr 27, 2022

		@@ -201,10 +201,10 @@ protected void doStart(ClusterState clusterState) {
		logger.debug("no known master node, scheduling a retry");

Replace internal usages of 'master' term in 'server/src/main' directory #2519

Replace internal usages of 'master' term in 'server/src/main' directory #2519

Conversation

tlfeng commented Mar 19, 2022 • edited Loading

Description

Issues Resolved

Check List

opensearch-ci-bot commented Mar 19, 2022

opensearch-ci-bot commented Mar 19, 2022

tlfeng commented Mar 19, 2022

opensearch-ci-bot commented Mar 19, 2022

tlfeng commented Mar 19, 2022 • edited Loading

opensearch-ci-bot commented Mar 19, 2022

tlfeng commented Mar 19, 2022

opensearch-ci-bot commented Mar 19, 2022

tlfeng commented Mar 19, 2022

opensearch-ci-bot commented Mar 19, 2022

tlfeng commented Mar 19, 2022 • edited Loading

tlfeng commented Mar 19, 2022

opensearch-ci-bot commented Mar 19, 2022

nknize left a comment

Choose a reason for hiding this comment

tlfeng commented Mar 22, 2022

xuezhou25 Mar 23, 2022

Choose a reason for hiding this comment

tlfeng Mar 23, 2022

Choose a reason for hiding this comment

xuezhou25 Mar 23, 2022 • edited Loading

Choose a reason for hiding this comment

tlfeng Mar 23, 2022 • edited Loading

Choose a reason for hiding this comment

opensearch-ci-bot commented Apr 26, 2022

opensearch-ci-bot commented Apr 26, 2022

opensearch-ci-bot commented Apr 26, 2022

opensearch-ci-bot commented Apr 26, 2022

opensearch-ci-bot commented Apr 27, 2022

opensearch-trigger-bot bot commented Apr 27, 2022

tlfeng commented Mar 19, 2022 •

edited

Loading

tlfeng commented Mar 19, 2022 •

edited

Loading

tlfeng commented Mar 19, 2022 •

edited

Loading

xuezhou25 Mar 23, 2022 •

edited

Loading

tlfeng Mar 23, 2022 •

edited

Loading