KAFKA-17897: Deprecate Admin.listConsumerGroups

[AndrewJSchofield]

The final part of KIP-1043 is to deprecate Admin.listConsumerGroups() in
favour of Admin.listGroups() which works for all group types.

Reviewers: PoAn Yang [email protected], Chia-Ping Tsai
[email protected]

[chia7712]

@AndrewJSchofield thanks for this patch. a couple of comments are left. PTAL

[chia7712]

I guess there will be a follow-up to use this field?

[AndrewJSchofield]

Yes, I'll add a few more tests. And update the KIP of course.

[chia7712]

Use {@link Admin#listGroups()} instead.

[AndrewJSchofield]

I don't think so. If you want Admin.listGroups() to return just consumer groups, you need to apply a filter to group type and protocol type.

[chia7712]

This new API is not in KIP-1043, therefore its code style is probably open for discussion 😃

Given that this API appears to be a helper function for creating a specific query, perhaps we could refactor it as a static method.

    public static ListGroupsOptions forConsumerGroups() {
        return new ListGroupsOptions()
                .withTypes(Set.of(GroupType.CLASSIC, GroupType.CONSUMER))
                .withProtocolTypes(Set.of("", ConsumerProtocol.PROTOCOL_TYPE));
    }

and then the code new ListGroupsOptions().forConsumerGroups() can be replaced by ListGroupsOptions.forConsumerGroups()

[AndrewJSchofield]

Yes, I agree. I was trying to see what the best way to express this would be and I like the static method suggestion.

[FrankYang0529]

The ConfigCommand still uses listConsumerGroups. Do we want to update it to listGroups?

kafka/core/src/main/scala/kafka/admin/ConfigCommand.scala

Lines 352 to 353 in 67fa365

	case GroupType =>
	adminClient.listConsumerGroups().all.get.asScala.map(_.groupId).toSeq

[AndrewJSchofield]

@chia7712 I actually discovered a problem with the code running against older brokers. Admin.listGroups(ListGroupsOptions.forConsumerGroups()) actually implies a higher version of ListGroups RPC than Admin.listConsumerGroups(). Since we support back to AK 2.1, the code needs to use an early version of ListGroups. I'll put in another PR.