You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by ma...@apache.org on 2023/07/03 17:55:35 UTC

[flink] 02/02: [FLINK-32436][runtime] Removes obsolete LeaderContender#getDescription()

This is an automated email from the ASF dual-hosted git repository.

mapohl pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git

commit 310d85950b80f7f775617983df2d82b9c6224201
Author: Matthias Pohl <ma...@aiven.io>
AuthorDate: Wed Jun 21 17:20:33 2023 +0200

    [FLINK-32436][runtime] Removes obsolete LeaderContender#getDescription()
    
    Signed-off-by: Matthias Pohl <ma...@aiven.io>
---
 .../DefaultLeaderElectionService.java              | 16 +++++++---------
 .../runtime/leaderelection/LeaderContender.java    |  9 ---------
 .../runtime/webmonitor/WebMonitorEndpoint.java     |  5 -----
 .../nonha/embedded/TestingLeaderContender.java     |  5 -----
 .../DefaultLeaderElectionServiceTest.java          |  1 -
 .../runtime/leaderelection/LeaderElectionTest.java |  5 -----
 .../runtime/leaderelection/TestingContender.java   |  5 -----
 .../TestingGenericLeaderContender.java             | 22 ++--------------------
 8 files changed, 9 insertions(+), 59 deletions(-)

diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/leaderelection/DefaultLeaderElectionService.java b/flink-runtime/src/main/java/org/apache/flink/runtime/leaderelection/DefaultLeaderElectionService.java
index ddde3a5c819..caf93263247 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/leaderelection/DefaultLeaderElectionService.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/leaderelection/DefaultLeaderElectionService.java
@@ -203,7 +203,7 @@ public class DefaultLeaderElectionService extends AbstractLeaderElectionService
 
             LOG.info(
                     "LeaderContender {} has been registered for {}.",
-                    contender.getDescription(),
+                    this.contenderID,
                     leaderElectionDriver);
 
             if (issuedLeaderSessionID != null) {
@@ -395,7 +395,7 @@ public class DefaultLeaderElectionService extends AbstractLeaderElectionService
 
         LOG.debug(
                 "Granting leadership to contender {} with session ID {}.",
-                leaderContender.getDescription(),
+                contenderID,
                 issuedLeaderSessionID);
 
         leaderContender.grantLeadership(issuedLeaderSessionID);
@@ -433,11 +433,11 @@ public class DefaultLeaderElectionService extends AbstractLeaderElectionService
         if (confirmedLeaderInformation.isEmpty()) {
             LOG.debug(
                     "Revoking leadership to contender {} while a previous leadership grant wasn't confirmed, yet.",
-                    leaderContender.getDescription());
+                    contenderID);
         } else {
             LOG.debug(
                     "Revoking leadership to contender {} for {}.",
-                    leaderContender.getDescription(),
+                    contenderID,
                     LeaderElectionUtils.convertToString(confirmedLeaderInformation));
         }
 
@@ -455,7 +455,7 @@ public class DefaultLeaderElectionService extends AbstractLeaderElectionService
         if (leaderContender != null) {
             LOG.trace(
                     "Leader node changed while {} is the leader with {}. New leader information {}.",
-                    leaderContender.getDescription(),
+                    contenderID,
                     LeaderElectionUtils.convertToString(confirmedLeaderInformation),
                     LeaderElectionUtils.convertToString(leaderInformation));
             if (!confirmedLeaderInformation.isEmpty()) {
@@ -463,13 +463,11 @@ public class DefaultLeaderElectionService extends AbstractLeaderElectionService
                 if (leaderInformation.isEmpty()) {
                     LOG.debug(
                             "Writing leader information by {} since the external storage is empty.",
-                            leaderContender.getDescription());
+                            contenderID);
                     leaderElectionDriver.publishLeaderInformation(contenderID, confirmedLeaderInfo);
                 } else if (!leaderInformation.equals(confirmedLeaderInfo)) {
                     // the data field does not correspond to the expected leader information
-                    LOG.debug(
-                            "Correcting leader information by {}.",
-                            leaderContender.getDescription());
+                    LOG.debug("Correcting leader information by {}.", contenderID);
                     leaderElectionDriver.publishLeaderInformation(contenderID, confirmedLeaderInfo);
                 }
             }
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/leaderelection/LeaderContender.java b/flink-runtime/src/main/java/org/apache/flink/runtime/leaderelection/LeaderContender.java
index fb386d8ae62..7babfd4f2be 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/leaderelection/LeaderContender.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/leaderelection/LeaderContender.java
@@ -48,13 +48,4 @@ public interface LeaderContender {
      * @param exception Caught exception
      */
     void handleError(Exception exception);
-
-    /**
-     * Returns the description of the {@link LeaderContender} for logging purposes.
-     *
-     * @return Description of this contender.
-     */
-    default String getDescription() {
-        return "LeaderContender: " + getClass().getSimpleName();
-    }
 }
diff --git a/flink-runtime/src/main/java/org/apache/flink/runtime/webmonitor/WebMonitorEndpoint.java b/flink-runtime/src/main/java/org/apache/flink/runtime/webmonitor/WebMonitorEndpoint.java
index 8019471db06..c653866b28b 100644
--- a/flink-runtime/src/main/java/org/apache/flink/runtime/webmonitor/WebMonitorEndpoint.java
+++ b/flink-runtime/src/main/java/org/apache/flink/runtime/webmonitor/WebMonitorEndpoint.java
@@ -1115,11 +1115,6 @@ public class WebMonitorEndpoint<T extends RestfulGateway> extends RestServerEndp
         log.info("{} lost leadership", getRestBaseUrl());
     }
 
-    @Override
-    public String getDescription() {
-        return getRestBaseUrl();
-    }
-
     @Override
     public void handleError(final Exception exception) {
         fatalErrorHandler.onFatalError(exception);
diff --git a/flink-runtime/src/test/java/org/apache/flink/runtime/highavailability/nonha/embedded/TestingLeaderContender.java b/flink-runtime/src/test/java/org/apache/flink/runtime/highavailability/nonha/embedded/TestingLeaderContender.java
index 8a2a0ec4ca9..def21123289 100644
--- a/flink-runtime/src/test/java/org/apache/flink/runtime/highavailability/nonha/embedded/TestingLeaderContender.java
+++ b/flink-runtime/src/test/java/org/apache/flink/runtime/highavailability/nonha/embedded/TestingLeaderContender.java
@@ -55,11 +55,6 @@ final class TestingLeaderContender implements LeaderContender {
         }
     }
 
-    @Override
-    public String getDescription() {
-        return "foobar";
-    }
-
     @Override
     public void handleError(Exception exception) {
         synchronized (lock) {
diff --git a/flink-runtime/src/test/java/org/apache/flink/runtime/leaderelection/DefaultLeaderElectionServiceTest.java b/flink-runtime/src/test/java/org/apache/flink/runtime/leaderelection/DefaultLeaderElectionServiceTest.java
index 0006924f16f..7f9ab94b9e3 100644
--- a/flink-runtime/src/test/java/org/apache/flink/runtime/leaderelection/DefaultLeaderElectionServiceTest.java
+++ b/flink-runtime/src/test/java/org/apache/flink/runtime/leaderelection/DefaultLeaderElectionServiceTest.java
@@ -62,7 +62,6 @@ class DefaultLeaderElectionServiceTest {
                             grantLeadership(leaderSessionID);
 
                             testingContender.waitForLeader();
-                            assertThat(testingContender.getDescription()).isEqualTo(TEST_URL);
                             assertThat(testingContender.getLeaderSessionID())
                                     .isEqualTo(
                                             leaderElectionService.getLeaderSessionID(contenderID))
diff --git a/flink-runtime/src/test/java/org/apache/flink/runtime/leaderelection/LeaderElectionTest.java b/flink-runtime/src/test/java/org/apache/flink/runtime/leaderelection/LeaderElectionTest.java
index b95f46837d5..9f519ccd820 100644
--- a/flink-runtime/src/test/java/org/apache/flink/runtime/leaderelection/LeaderElectionTest.java
+++ b/flink-runtime/src/test/java/org/apache/flink/runtime/leaderelection/LeaderElectionTest.java
@@ -126,11 +126,6 @@ public class LeaderElectionTest {
             leaderSessionIds.offer(NULL_LEADER_SESSION_ID);
         }
 
-        @Override
-        public String getDescription() {
-            return "foobar";
-        }
-
         @Override
         public void handleError(Exception exception) {
             this.exception = exception;
diff --git a/flink-runtime/src/test/java/org/apache/flink/runtime/leaderelection/TestingContender.java b/flink-runtime/src/test/java/org/apache/flink/runtime/leaderelection/TestingContender.java
index dc7f0ca77b8..d566289c711 100644
--- a/flink-runtime/src/test/java/org/apache/flink/runtime/leaderelection/TestingContender.java
+++ b/flink-runtime/src/test/java/org/apache/flink/runtime/leaderelection/TestingContender.java
@@ -63,11 +63,6 @@ public class TestingContender extends TestingLeaderBase implements LeaderContend
         leaderEventQueue.offer(LeaderInformation.empty());
     }
 
-    @Override
-    public String getDescription() {
-        return address;
-    }
-
     @Override
     public void handleError(Exception exception) {
         super.handleError(exception);
diff --git a/flink-runtime/src/test/java/org/apache/flink/runtime/leaderelection/TestingGenericLeaderContender.java b/flink-runtime/src/test/java/org/apache/flink/runtime/leaderelection/TestingGenericLeaderContender.java
index 35a7e82dcbd..a5b43cf8bb2 100644
--- a/flink-runtime/src/test/java/org/apache/flink/runtime/leaderelection/TestingGenericLeaderContender.java
+++ b/flink-runtime/src/test/java/org/apache/flink/runtime/leaderelection/TestingGenericLeaderContender.java
@@ -20,7 +20,6 @@ package org.apache.flink.runtime.leaderelection;
 
 import java.util.UUID;
 import java.util.function.Consumer;
-import java.util.function.Supplier;
 
 /**
  * {@code TestingGenericLeaderContender} is a more generic testing implementation of the {@link
@@ -33,17 +32,14 @@ public class TestingGenericLeaderContender implements LeaderContender {
     private final Consumer<UUID> grantLeadershipConsumer;
     private final Runnable revokeLeadershipRunnable;
     private final Consumer<Exception> handleErrorConsumer;
-    private final Supplier<String> getDescriptionSupplier;
 
     private TestingGenericLeaderContender(
             Consumer<UUID> grantLeadershipConsumer,
             Runnable revokeLeadershipRunnable,
-            Consumer<Exception> handleErrorConsumer,
-            Supplier<String> getDescriptionSupplier) {
+            Consumer<Exception> handleErrorConsumer) {
         this.grantLeadershipConsumer = grantLeadershipConsumer;
         this.revokeLeadershipRunnable = revokeLeadershipRunnable;
         this.handleErrorConsumer = handleErrorConsumer;
-        this.getDescriptionSupplier = getDescriptionSupplier;
     }
 
     @Override
@@ -67,11 +63,6 @@ public class TestingGenericLeaderContender implements LeaderContender {
         }
     }
 
-    @Override
-    public String getDescription() {
-        return getDescriptionSupplier.get();
-    }
-
     public static Builder newBuilder() {
         return new Builder();
     }
@@ -84,7 +75,6 @@ public class TestingGenericLeaderContender implements LeaderContender {
                 error -> {
                     throw new AssertionError(error);
                 };
-        private Supplier<String> getDescriptionSupplier = () -> "testing contender";
 
         private Builder() {}
 
@@ -103,17 +93,9 @@ public class TestingGenericLeaderContender implements LeaderContender {
             return this;
         }
 
-        public Builder setGetDescriptionSupplier(Supplier<String> getDescriptionSupplier) {
-            this.getDescriptionSupplier = getDescriptionSupplier;
-            return this;
-        }
-
         public TestingGenericLeaderContender build() {
             return new TestingGenericLeaderContender(
-                    grantLeadershipConsumer,
-                    revokeLeadershipRunnable,
-                    handleErrorConsumer,
-                    getDescriptionSupplier);
+                    grantLeadershipConsumer, revokeLeadershipRunnable, handleErrorConsumer);
         }
     }
 }