KAFKA-18760: Deprecate Optional<String> and return String from public Endpoint#listener #19191

FrankYang0529 · 2025-03-12T14:54:40Z

Deprecate org.apache.kafka.common.Endpoint#listenerName.
Add org.apache.kafka.common.Endpoint#listener to replace
org.apache.kafka.common.Endpoint#listenerName.
Replace org.apache.kafka.network.EndPoint with
org.apache.kafka.common.Endpoint.
Deprecate org.apache.kafka.clients.admin.RaftVoterEndpoint#name
Add org.apache.kafka.clients.admin.RaftVoterEndpoint#listener to
replace org.apache.kafka.clients.admin.RaftVoterEndpoint#name

Reviewers: Chia-Ping Tsai [email protected], TaiJuWu
[email protected], Jhen-Yung Hsu [email protected], TengYao
Chi [email protected], Ken Huang [email protected], Bagda
Parth , Kuan-Po Tseng [email protected]

… EndPoint#listenerName Signed-off-by: PoAn Yang <[email protected]>

Signed-off-by: PoAn Yang <[email protected]>

chia7712

@FrankYang0529 thanks for this patch

chia7712 · 2025-04-16T16:47:29Z

clients/src/main/java/org/apache/kafka/clients/admin/RaftVoterEndpoint.java

+    /**
+     * @deprecated Since 4.1. Use {@link #listener()} instead. This function will be removed in 5.0.
+     */
+    @Deprecated


@Deprecated(since = "4.1", forRemoval = true)

chia7712 · 2025-04-16T16:47:33Z

clients/src/main/java/org/apache/kafka/common/Endpoint.java

     */
+    @Deprecated


@Deprecated(since = "4.1", forRemoval = true)

chia7712 · 2025-04-16T16:49:47Z

clients/src/main/java/org/apache/kafka/common/Endpoint.java

 public class Endpoint {

    private final String listenerName;
    private final SecurityProtocol securityProtocol;
    private final String host;
    private final int port;

+    public static String parseListenerName(String connectionString) {


it seems only KafkaConfig uses this helper. Could you please move it to the KafkaConfig instead of leaving it in this public APIs?

chia7712 · 2025-04-16T16:50:40Z

clients/src/main/java/org/apache/kafka/common/Endpoint.java

+     * Returns the listener name of this endpoint.
+     */
+    public String listener() {
+        return listenerName;


How about renaming it to listenerName for consistency?

Signed-off-by: PoAn Yang <[email protected]>

TaiJuWu

LGTM, thanks for this patch.

chia7712 · 2025-04-17T14:35:38Z

@FrankYang0529 please fix the conflicts

chia7712 · 2025-04-20T14:14:59Z

@FrankYang0529 please fix the conflicts

chia7712 · 2025-04-21T12:20:05Z

@FrankYang0529 please rebase code to include the fix

brandboat

LGTM, thanks!

… Endpoint#listener (apache#19191) * Deprecate org.apache.kafka.common.Endpoint#listenerName. * Add org.apache.kafka.common.Endpoint#listener to replace org.apache.kafka.common.Endpoint#listenerName. * Replace org.apache.kafka.network.EndPoint with org.apache.kafka.common.Endpoint. * Deprecate org.apache.kafka.clients.admin.RaftVoterEndpoint#name * Add org.apache.kafka.clients.admin.RaftVoterEndpoint#listener to replace org.apache.kafka.clients.admin.RaftVoterEndpoint#name Reviewers: Chia-Ping Tsai <[email protected]>, TaiJuWu <[email protected]>, Jhen-Yung Hsu <[email protected]>, TengYao Chi <[email protected]>, Ken Huang <[email protected]>, Bagda Parth , Kuan-Po Tseng <[email protected]> --------- Signed-off-by: PoAn Yang <[email protected]>

omkreddy · 2025-06-04T12:29:19Z

@FrankYang0529 Can we add a basic integration test that uses lowercase listener names?
Since certain parts of the code depend on listener name normalization, having a test would help to catch any regressions.

FrankYang0529 · 2025-06-04T12:34:42Z

Yes, I will create an integration test for it. Thanks.

FrankYang0529 · 2025-06-09T14:43:02Z

Created a followup PR: #19932

chia7712 · 2025-06-11T10:09:45Z

Since certain parts of the code depend on listener name normalization, having a test would help to catch any regressions.

@omkreddy Do you mean the listener name SHOULD be normalization? There is a path using controller.listener.names which is NOT normalized. see https://github.com/apache/kafka/blob/3.9/core/src/main/scala/kafka/server/KafkaConfig.scala#L856

Do you think that is a bug?

FrankYang0529 · 2025-06-12T15:07:02Z

In my testing, only controller.listener.names cannot be lowercase. Other fields like listeners, advertised.listeners, and listener.security.protocol.map can accept lowercase controller listener name. If we don't want to change the behavior, I recommend to add validation to KafkaConfig, so users don't get unclear message like following.

requirement failed: The listeners config must only contain KRaft controller listeners from controller.listener.names when process.roles=controller

They should get clear message like:

requirement failed: controller.listener.names doesn't allow lowercase

In [KIP-1143](https://cwiki.apache.org/confluence/x/LwqWF), it deprecated Endpoint#listenerName and removed org.apache.kafka.network.EndPoint. Certain parts of the code depend on listener name normalization. We should add a test to make sure there is no regression. Followup: https: //github.com//pull/19191#issuecomment-2939855317 Reviewers: Chia-Ping Tsai <[email protected]>

github-actions bot added core Kafka Broker tools kraft clients labels Mar 12, 2025

FrankYang0529 force-pushed the KAFKA-18760 branch from 9a88650 to 576b3df Compare March 13, 2025 00:40

KAFKA-18760: Deprecate Optional<String> and return String from public…

5a57f0b

… EndPoint#listenerName Signed-off-by: PoAn Yang <[email protected]>

FrankYang0529 force-pushed the KAFKA-18760 branch from 576b3df to 5a57f0b Compare March 13, 2025 10:43

parthbagda211 approved these changes Mar 15, 2025

View reviewed changes

FrankYang0529 added 7 commits March 16, 2025 20:51

Merge branch 'trunk' into KAFKA-18760

a6497b7

Merge branch 'trunk' into KAFKA-18760

5761989

Add listener function to org.apache.kafka.common.Endpoint

22b1848

Signed-off-by: PoAn Yang <[email protected]>

Change listener to name in Endpoint

ae2abed

Signed-off-by: PoAn Yang <[email protected]>

Change name to listener in Endpoint

a54b7ca

Signed-off-by: PoAn Yang <[email protected]>

Merge branch 'trunk' into KAFKA-18760

7dde246

KAFKA-18760: Deprecate RaftVoterEndpoint#name

14c1139

Signed-off-by: PoAn Yang <[email protected]>

FrankYang0529 changed the title ~~KAFKA-18760: Deprecate Optional<String> and return String from public EndPoint#listenerName (wip)~~ KAFKA-18760: Deprecate Optional<String> and return String from public Endpoint#listener (wip) Apr 15, 2025

FrankYang0529 requested review from chia7712 and TaiJuWu April 15, 2025 07:54

Merge branch 'trunk' into KAFKA-18760

e2ca968

FrankYang0529 changed the title ~~KAFKA-18760: Deprecate Optional<String> and return String from public Endpoint#listener (wip)~~ KAFKA-18760: Deprecate Optional<String> and return String from public Endpoint#listener Apr 15, 2025

chia7712 reviewed Apr 16, 2025

View reviewed changes

FrankYang0529 added 2 commits April 17, 2025 15:46

Merge branch 'trunk' into KAFKA-18760

3eb16c8

address comment

48103d9

Signed-off-by: PoAn Yang <[email protected]>

TaiJuWu approved these changes Apr 17, 2025

View reviewed changes

FrankYang0529 added 2 commits April 17, 2025 22:47

Merge branch 'trunk' into KAFKA-18760

07eff76

Merge branch 'trunk' into KAFKA-18760

0306ca1

Merge branch 'trunk' into KAFKA-18760

bbf483b

Merge branch 'trunk' into KAFKA-18760

403d00c

FrankYang0529 requested a review from chia7712 April 21, 2025 15:52

FrankYang0529 added the ci-approved label Apr 23, 2025

frankvicky approved these changes Apr 25, 2025

View reviewed changes

Merge branch 'trunk' into KAFKA-18760

e518150

m1a2st approved these changes Apr 30, 2025

View reviewed changes

Yunyung approved these changes Apr 30, 2025

View reviewed changes

brandboat approved these changes Apr 30, 2025

View reviewed changes

frankvicky merged commit 81881de into apache:trunk Apr 30, 2025
26 checks passed

FrankYang0529 deleted the KAFKA-18760 branch May 1, 2025 07:24

FrankYang0529 mentioned this pull request Jun 9, 2025

MINOR: add lower case lister name integration test #19932

Merged

KAFKA-18760: Deprecate Optional<String> and return String from public Endpoint#listener #19191

KAFKA-18760: Deprecate Optional<String> and return String from public Endpoint#listener #19191

Uh oh!

Conversation

FrankYang0529 commented Mar 12, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chia7712 left a comment

Choose a reason for hiding this comment

Uh oh!

chia7712 Apr 16, 2025

Choose a reason for hiding this comment

Uh oh!

chia7712 Apr 16, 2025

Choose a reason for hiding this comment

Uh oh!

chia7712 Apr 16, 2025

Choose a reason for hiding this comment

Uh oh!

chia7712 Apr 16, 2025

Choose a reason for hiding this comment

Uh oh!

TaiJuWu left a comment

Choose a reason for hiding this comment

Uh oh!

chia7712 commented Apr 17, 2025

Uh oh!

chia7712 commented Apr 20, 2025

Uh oh!

chia7712 commented Apr 21, 2025

Uh oh!

brandboat left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

omkreddy commented Jun 4, 2025

Uh oh!

FrankYang0529 commented Jun 4, 2025

Uh oh!

FrankYang0529 commented Jun 9, 2025

Uh oh!

chia7712 commented Jun 11, 2025

Uh oh!

FrankYang0529 commented Jun 12, 2025

Uh oh!

Uh oh!

FrankYang0529 commented Mar 12, 2025 •

edited by github-actions bot

Loading