jeffkbkim commented on code in PR #14067:
URL: https://github.com/apache/kafka/pull/14067#discussion_r1275398688
##########
group-coordinator/src/main/java/org/apache/kafka/coordinator/group/GroupMetadataManager.java:
##########
@@ -408,6 +409,17 @@ public MetadataImage image() {
return metadataImage;
}
+ /**
+ * @return The group corresponding to the groupId or throw
GroupIdNotFoundException.
Review Comment:
nit: group id
##########
group-coordinator/src/main/java/org/apache/kafka/coordinator/group/OffsetMetadataManager.java:
##########
@@ -0,0 +1,384 @@
+/*
+ * 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.coordinator.group;
+
+import org.apache.kafka.common.TopicPartition;
+import org.apache.kafka.common.errors.ApiException;
+import org.apache.kafka.common.errors.GroupIdNotFoundException;
+import org.apache.kafka.common.errors.StaleMemberEpochException;
+import org.apache.kafka.common.message.OffsetCommitRequestData;
+import org.apache.kafka.common.message.OffsetCommitResponseData;
+import
org.apache.kafka.common.message.OffsetCommitResponseData.OffsetCommitResponseTopic;
+import
org.apache.kafka.common.message.OffsetCommitResponseData.OffsetCommitResponsePartition;
+import org.apache.kafka.common.protocol.Errors;
+import org.apache.kafka.common.requests.OffsetCommitRequest;
+import org.apache.kafka.common.requests.RequestContext;
+import org.apache.kafka.common.utils.LogContext;
+import org.apache.kafka.common.utils.Time;
+import org.apache.kafka.coordinator.group.generated.OffsetCommitKey;
+import org.apache.kafka.coordinator.group.generated.OffsetCommitValue;
+import org.apache.kafka.coordinator.group.generic.GenericGroup;
+import org.apache.kafka.coordinator.group.generic.GenericGroupState;
+import org.apache.kafka.coordinator.group.runtime.CoordinatorResult;
+import org.apache.kafka.image.MetadataDelta;
+import org.apache.kafka.image.MetadataImage;
+import org.apache.kafka.timeline.SnapshotRegistry;
+import org.apache.kafka.timeline.TimelineHashMap;
+import org.slf4j.Logger;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import java.util.OptionalLong;
+
+/**
+ * The OffsetMetadataManager manages the offsets of all the groups. It
basically maintains
+ * a mapping from group id to topic-partition to offset. This class has two
kinds of methods:
+ * 1) The request handlers which handle the requests and generate a response
and records to
+ * mutate the hard state. Those records will be written by the runtime and
applied to the
+ * hard state via the replay methods.
+ * 2) The replay methods which apply records to the hard state. Those are used
in the request
+ * handling as well as during the initial loading of the records from the
partitions.
+ */
+public class OffsetMetadataManager {
+ public static class Builder {
+ private LogContext logContext = null;
+ private SnapshotRegistry snapshotRegistry = null;
+ private Time time = null;
+ private GroupMetadataManager groupMetadataManager = null;
+ private int offsetMetadataMaxSize = 4096;
+ private MetadataImage metadataImage = null;
+
+ Builder withLogContext(LogContext logContext) {
+ this.logContext = logContext;
+ return this;
+ }
+
+ Builder withSnapshotRegistry(SnapshotRegistry snapshotRegistry) {
+ this.snapshotRegistry = snapshotRegistry;
+ return this;
+ }
+
+ Builder withTime(Time time) {
+ this.time = time;
+ return this;
+ }
+
+ Builder withGroupMetadataManager(GroupMetadataManager
groupMetadataManager) {
+ this.groupMetadataManager = groupMetadataManager;
+ return this;
+ }
+
+ Builder withOffsetMetadataMaxSize(int offsetMetadataMaxSize) {
+ this.offsetMetadataMaxSize = offsetMetadataMaxSize;
+ return this;
+ }
+
+ Builder withMetadataImage(MetadataImage metadataImage) {
+ this.metadataImage = metadataImage;
+ return this;
+ }
+
+ public OffsetMetadataManager build() {
+ if (logContext == null) logContext = new LogContext();
+ if (snapshotRegistry == null) snapshotRegistry = new
SnapshotRegistry(logContext);
+ if (metadataImage == null) metadataImage = MetadataImage.EMPTY;
+ if (time == null) time = Time.SYSTEM;
+
+ if (groupMetadataManager == null) {
+ throw new IllegalArgumentException("GroupMetadataManager
cannot be null");
+ }
+
+ return new OffsetMetadataManager(
+ snapshotRegistry,
+ logContext,
+ time,
+ metadataImage,
+ groupMetadataManager,
+ offsetMetadataMaxSize
+ );
+ }
+ }
+
+ /**
+ * The logger.
+ */
+ private final Logger log;
+
+ /**
+ * The snapshot registry.
+ */
+ private final SnapshotRegistry snapshotRegistry;
+
+ /**
+ * The system time.
+ */
+ private final Time time;
+
+ /**
+ * The metadata image.
+ */
+ private MetadataImage metadataImage;
+
+ /**
+ * The group metadata manager.
+ */
+ private final GroupMetadataManager groupMetadataManager;
+
+ /**
+ * The maximum allowed metadata for any offset commit.
+ */
+ private final int offsetMetadataMaxSize;
+
+ /**
+ * The offsets keyed by topic-partition and group id.
+ */
+ private final TimelineHashMap<String, TimelineHashMap<TopicPartition,
OffsetAndMetadata>> offsetsByGroup;
+
+ OffsetMetadataManager(
+ SnapshotRegistry snapshotRegistry,
+ LogContext logContext,
+ Time time,
+ MetadataImage metadataImage,
+ GroupMetadataManager groupMetadataManager,
+ int offsetMetadataMaxSize
+ ) {
+ this.snapshotRegistry = snapshotRegistry;
+ this.log = logContext.logger(OffsetMetadataManager.class);
+ this.time = time;
+ this.metadataImage = metadataImage;
+ this.groupMetadataManager = groupMetadataManager;
+ this.offsetMetadataMaxSize = offsetMetadataMaxSize;
+ this.offsetsByGroup = new TimelineHashMap<>(snapshotRegistry, 0);
+ }
+
+ /**
+ * Validates an OffsetCommit request.
+ *
+ * @param context The request context.
+ * @param request The actual request.
+ */
+ private Group validateOffsetCommit(
+ RequestContext context,
+ OffsetCommitRequestData request
+ ) throws ApiException {
+ Group group;
+ try {
+ group = groupMetadataManager.group(request.groupId());
+ } catch (GroupIdNotFoundException ex) {
+ if (request.generationIdOrMemberEpoch() < 0) {
+ // If the group does not exist and generation id is -1, the
request comes from
+ // either the admin client or a consumer which does not use
the group management
+ // facility. In this case, a so-called simple group is created
and the request
+ // is accepted.
+ group =
groupMetadataManager.getOrMaybeCreateGenericGroup(request.groupId(), true);
+ } else {
+ if (context.header.apiVersion() >= 9) {
+ // Starting from version 9 of the OffsetCommit API, we
return GROUP_ID_NOT_FOUND
+ // if the group does not exist. This error works for both
the old and the new
+ // protocol for clients using this version of the API.
+ throw ex;
+ } else {
+ // For older version, we return ILLEGAL_GENERATION to
preserve the backward
+ // compatibility.
+ throw Errors.ILLEGAL_GENERATION.exception();
+ }
+ }
+ }
+
+ try {
+ group.validateOffsetCommit(
+ request.memberId(),
+ request.groupInstanceId(),
+ request.generationIdOrMemberEpoch()
+ );
+ } catch (StaleMemberEpochException ex) {
+ // The STALE_MEMBER_EPOCH error is only returned for new consumer
group (KIP-848). When
+ // it is, the member should be using the OffsetCommit API version
>= 9. As we don't
+ // support upgrading from the old to the new protocol yet, we
return UNSUPPORTED_VERSION
+ // error if an older version is used. We will revise this when the
upgrade path is implemented.
+ if (context.header.apiVersion() >= 9) {
+ throw ex;
+ } else {
+ throw Errors.UNSUPPORTED_VERSION.exception();
+ }
+ }
+
+ return group;
+ }
+
+ /**
+ * Computes the expiration timestamp based on the retention time provided
in the OffsetCommit
+ * request.
+ *
+ * The "default" expiration timestamp is defined as now + retention. The
retention may be overridden
+ * in versions from v2 to v4. Otherwise, the retention defined on the
broker is used. If an explicit
+ * commit timestamp is provided (v1 only), the expiration timestamp is
computed based on that.
+ *
+ * @param retentionTimeMs The retention time in milliseconds.
+ * @param currentTimeMs The current time in milliseconds.
+ *
+ * @return An optional containing the expiration timestamp if defined; an
empty optional otherwise.
+ */
+ private static OptionalLong expireTimestampMs(
+ long retentionTimeMs,
+ long currentTimeMs
+ ) {
+ return retentionTimeMs == OffsetCommitRequest.DEFAULT_RETENTION_TIME ?
+ OptionalLong.empty() : OptionalLong.of(currentTimeMs +
retentionTimeMs);
+ }
+
+ /**
+ * Handles an OffsetCommit request.
+ *
+ * @param context The request context.
+ * @param request The OffsetCommit request.
+ *
+ * @return A Result containing the OffsetCommitResponseData response and
+ * a list of records to update the state machine.
+ */
+ public CoordinatorResult<OffsetCommitResponseData, Record> commitOffset(
+ RequestContext context,
+ OffsetCommitRequestData request
+ ) throws ApiException {
+ Group group = validateOffsetCommit(context, request);
+
+ // In the old consumer group protocol, the offset commits maintain the
session if
+ // the group is in Stable or PreparingRebalance state.
+ if (group.type() == Group.GroupType.GENERIC) {
+ GenericGroup genericGroup = (GenericGroup) group;
+ if (genericGroup.isInState(GenericGroupState.STABLE) ||
genericGroup.isInState(GenericGroupState.PREPARING_REBALANCE)) {
+ groupMetadataManager.rescheduleGenericGroupMemberHeartbeat(
+ genericGroup,
+ genericGroup.member(request.memberId())
+ );
+ }
+ }
+
+ final OffsetCommitResponseData response = new
OffsetCommitResponseData();
+ final List<Record> records = new ArrayList<>();
+ final long currentTimeMs = time.milliseconds();
+ final OptionalLong expireTimestampMs =
expireTimestampMs(request.retentionTimeMs(), currentTimeMs);
+
+ request.topics().forEach(topic -> {
+ final OffsetCommitResponseData.OffsetCommitResponseTopic
topicResponse =
Review Comment:
nit: OffsetCommitResponseTopic
--
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]
