cadonna commented on code in PR #18125: URL: https://github.com/apache/kafka/pull/18125#discussion_r1880189623
########## clients/src/main/java/org/apache/kafka/clients/admin/internals/DescribeStreamsGroupsHandler.java: ########## @@ -0,0 +1,285 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.apache.kafka.clients.admin.internals; + +import org.apache.kafka.clients.admin.StreamsGroupDescription; +import org.apache.kafka.clients.admin.StreamsGroupMemberAssignment; +import org.apache.kafka.clients.admin.StreamsGroupMemberDescription; +import org.apache.kafka.clients.admin.StreamsGroupSubtopologyDescription; +import org.apache.kafka.common.GroupState; +import org.apache.kafka.common.Node; +import org.apache.kafka.common.acl.AclOperation; +import org.apache.kafka.common.message.StreamsGroupDescribeRequestData; +import org.apache.kafka.common.message.StreamsGroupDescribeResponseData; +import org.apache.kafka.common.protocol.Errors; +import org.apache.kafka.common.requests.AbstractResponse; +import org.apache.kafka.common.requests.FindCoordinatorRequest.CoordinatorType; +import org.apache.kafka.common.requests.StreamsGroupDescribeRequest; +import org.apache.kafka.common.requests.StreamsGroupDescribeResponse; +import org.apache.kafka.common.utils.LogContext; + +import org.slf4j.Logger; + +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.HashMap; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.Set; +import java.util.stream.Collectors; + +import static org.apache.kafka.clients.admin.internals.AdminUtils.validAclOperations; + +public class DescribeStreamsGroupsHandler extends AdminApiHandler.Batched<CoordinatorKey, StreamsGroupDescription> { + + private final boolean includeAuthorizedOperations; + private final Logger log; + private final AdminApiLookupStrategy<CoordinatorKey> lookupStrategy; + + public DescribeStreamsGroupsHandler( + boolean includeAuthorizedOperations, + LogContext logContext) { + this.includeAuthorizedOperations = includeAuthorizedOperations; + this.log = logContext.logger(DescribeStreamsGroupsHandler.class); + this.lookupStrategy = new CoordinatorStrategy(CoordinatorType.GROUP, logContext); + } + + private static Set<CoordinatorKey> buildKeySet(Collection<String> groupIds) { + return groupIds.stream() + .map(CoordinatorKey::byGroupId) + .collect(Collectors.toSet()); + } + + public static AdminApiFuture.SimpleAdminApiFuture<CoordinatorKey, StreamsGroupDescription> newFuture(Collection<String> groupIds) { + return AdminApiFuture.forKeys(buildKeySet(groupIds)); + } + + @Override + public String apiName() { + return "describeStreamsGroups"; + } + + @Override + public AdminApiLookupStrategy<CoordinatorKey> lookupStrategy() { + return lookupStrategy; + } + + @Override + public StreamsGroupDescribeRequest.Builder buildBatchedRequest(int coordinatorId, Set<CoordinatorKey> keys) { + List<String> groupIds = keys.stream().map(key -> { + if (key.type != CoordinatorType.GROUP) { + throw new IllegalArgumentException("Invalid group coordinator key " + key + + " when building `DescribeStreamsGroups` request"); + } + return key.idValue; + }).collect(Collectors.toList()); + StreamsGroupDescribeRequestData data = new StreamsGroupDescribeRequestData() + .setGroupIds(groupIds) + .setIncludeAuthorizedOperations(includeAuthorizedOperations); + return new StreamsGroupDescribeRequest.Builder(data, true); + } + + @Override + public ApiResult<CoordinatorKey, StreamsGroupDescription> handleResponse( + Node coordinator, + Set<CoordinatorKey> groupIds, + AbstractResponse abstractResponse) { + final StreamsGroupDescribeResponse response = (StreamsGroupDescribeResponse) abstractResponse; + final Map<CoordinatorKey, StreamsGroupDescription> completed = new HashMap<>(); + final Map<CoordinatorKey, Throwable> failed = new HashMap<>(); + final Set<CoordinatorKey> groupsToUnmap = new HashSet<>(); + + for (StreamsGroupDescribeResponseData.DescribedGroup describedGroup : response.data().groups()) { + CoordinatorKey groupIdKey = CoordinatorKey.byGroupId(describedGroup.groupId()); + Errors error = Errors.forCode(describedGroup.errorCode()); + if (error != Errors.NONE) { + handleError(groupIdKey, describedGroup, coordinator, error, describedGroup.errorMessage(), completed, failed, groupsToUnmap); + continue; + } + if (describedGroup.topology() == null) { + log.error("`DescribeStreamsGroups` response for group id {} is missing the topology information", groupIdKey.idValue); + failed.put(groupIdKey, new IllegalStateException("Topology information is missing")); + continue; + } + + final Set<AclOperation> authorizedOperations = validAclOperations(describedGroup.authorizedOperations()); + + Review Comment: nit: ```suggestion ``` ########## clients/src/main/java/org/apache/kafka/clients/admin/StreamsGroupDescription.java: ########## @@ -0,0 +1,180 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.kafka.clients.admin; + +import org.apache.kafka.common.GroupState; +import org.apache.kafka.common.Node; +import org.apache.kafka.common.acl.AclOperation; +import org.apache.kafka.common.annotation.InterfaceStability; + +import java.util.Collection; +import java.util.Objects; +import java.util.Set; +import java.util.stream.Collectors; + +/** + * A detailed description of a single streams group in the cluster. + */ [email protected] +public class StreamsGroupDescription { + + private final String groupId; + private final int groupEpoch; + private final int targetAssignmentEpoch; + private final int topologyEpoch; + private final Collection<StreamsGroupSubtopologyDescription> subtopologies; + private final Collection<StreamsGroupMemberDescription> members; + private final GroupState groupState; + private final Node coordinator; + private final Set<AclOperation> authorizedOperations; + + public StreamsGroupDescription( + final String groupId, + final int groupEpoch, + final int targetAssignmentEpoch, + final int topologyEpoch, + final Collection<StreamsGroupSubtopologyDescription> subtopologies, + final Collection<StreamsGroupMemberDescription> members, + final GroupState groupState, + final Node coordinator, + final Set<AclOperation> authorizedOperations + ) { + this.groupId = Objects.requireNonNull(groupId, "groupId must be non-null"); + this.groupEpoch = groupEpoch; + this.targetAssignmentEpoch = targetAssignmentEpoch; + this.topologyEpoch = topologyEpoch; + this.subtopologies = Objects.requireNonNull(subtopologies, "subtopologies must be non-null"); + this.members = Objects.requireNonNull(members, "members must be non-null"); + this.groupState = groupState; Review Comment: Why is the `groupState` not required to be non-null? ########## clients/src/test/java/org/apache/kafka/clients/admin/KafkaAdminClientTest.java: ########## @@ -4907,6 +4910,527 @@ public void testDeleteConsumerGroupOffsetsFindCoordinatorNonRetriableErrors() th } } + @Test + public void testDescribeStreamsGroups() throws Exception { + try (AdminClientUnitTestEnv env = new AdminClientUnitTestEnv(mockCluster(1, 0))) { + env.kafkaClient().setNodeApiVersions(NodeApiVersions.create()); + + // Retriable FindCoordinatorResponse errors should be retried + env.kafkaClient().prepareResponse(prepareFindCoordinatorResponse(Errors.COORDINATOR_NOT_AVAILABLE, Node.noNode())); + env.kafkaClient().prepareResponse(prepareFindCoordinatorResponse(Errors.COORDINATOR_LOAD_IN_PROGRESS, Node.noNode())); + env.kafkaClient().prepareResponse(prepareFindCoordinatorResponse(Errors.NONE, env.cluster().controller())); + + StreamsGroupDescribeResponseData data = new StreamsGroupDescribeResponseData(); + + // Retriable errors should be retried + data.groups().add(new StreamsGroupDescribeResponseData.DescribedGroup() + .setGroupId(GROUP_ID) + .setErrorCode(Errors.COORDINATOR_LOAD_IN_PROGRESS.code())); + env.kafkaClient().prepareResponse(new StreamsGroupDescribeResponse(data)); + + /* + * We need to return two responses here, one with NOT_COORDINATOR error when calling describe streams group + * api using coordinator that has moved. This will retry whole operation. So we need to again respond with a + * FindCoordinatorResponse. + * + * And the same reason for COORDINATOR_NOT_AVAILABLE error response + */ + data = new StreamsGroupDescribeResponseData(); + data.groups().add(new StreamsGroupDescribeResponseData.DescribedGroup() + .setGroupId(GROUP_ID) + .setErrorCode(Errors.NOT_COORDINATOR.code())); + env.kafkaClient().prepareResponse(new StreamsGroupDescribeResponse(data)); + env.kafkaClient().prepareResponse(prepareFindCoordinatorResponse(Errors.NONE, env.cluster().controller())); + + data = new StreamsGroupDescribeResponseData(); + data.groups().add(new StreamsGroupDescribeResponseData.DescribedGroup() + .setGroupId(GROUP_ID) + .setErrorCode(Errors.COORDINATOR_NOT_AVAILABLE.code())); + env.kafkaClient().prepareResponse(new StreamsGroupDescribeResponse(data)); + env.kafkaClient().prepareResponse(prepareFindCoordinatorResponse(Errors.NONE, env.cluster().controller())); + + data = makeFullStreamsGroupDescribeResponse(); + + env.kafkaClient().prepareResponse(new StreamsGroupDescribeResponse(data)); + + final DescribeStreamsGroupsResult result = env.adminClient().describeStreamsGroups(singletonList(GROUP_ID)); + final StreamsGroupDescription groupDescription = result.describedGroups().get(GROUP_ID).get(); + + StreamsGroupMemberAssignment.TaskIds expectedActiveTasks1 = + new StreamsGroupMemberAssignment.TaskIds("my_subtopology", asList(0, 1, 2)); Review Comment: Wouldn't it be better to use constants for those values that are verified so that you do not need to create them multiple times? At least, for the expected and actual subtopology ID. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
