This is an automated email from the ASF dual-hosted git repository.
jgus pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git
The following commit(s) were added to refs/heads/trunk by this push:
new f98e176 KAFKA-8678; Fix leave group protocol bug in throttling and
error response (#7101)
f98e176 is described below
commit f98e176746d663fadedbcd3c18312a7f476a20c8
Author: Boyang Chen <[email protected]>
AuthorDate: Mon Jul 22 16:13:02 2019 -0700
KAFKA-8678; Fix leave group protocol bug in throttling and error response
(#7101)
This is a bug fix PR to resolve errors introduced in
https://github.com/apache/kafka/pull/6188. The PR fixes 2 things:
1. throttle time should be set on version >= 1 instead of version >= 2
2. `getErrorResponse` should set throwable exception within
LeaveGroupResponseData
The patch also adds more unit tests to guarantee correctness for leave
group protocol.
Reviewers: Guozhang Wang <[email protected]>, Jason Gustafson
<[email protected]>
---
.../kafka/common/requests/LeaveGroupRequest.java | 11 ++-
.../kafka/common/requests/LeaveGroupResponse.java | 12 +++
.../common/requests/LeaveGroupRequestTest.java | 60 +++++++++++++++
.../common/requests/LeaveGroupResponseTest.java | 85 ++++++++++++++++++++++
4 files changed, 164 insertions(+), 4 deletions(-)
diff --git
a/clients/src/main/java/org/apache/kafka/common/requests/LeaveGroupRequest.java
b/clients/src/main/java/org/apache/kafka/common/requests/LeaveGroupRequest.java
index 20fdf4f..e6e239c 100644
---
a/clients/src/main/java/org/apache/kafka/common/requests/LeaveGroupRequest.java
+++
b/clients/src/main/java/org/apache/kafka/common/requests/LeaveGroupRequest.java
@@ -19,6 +19,7 @@ package org.apache.kafka.common.requests;
import org.apache.kafka.common.message.LeaveGroupRequestData;
import org.apache.kafka.common.message.LeaveGroupResponseData;
import org.apache.kafka.common.protocol.ApiKeys;
+import org.apache.kafka.common.protocol.Errors;
import org.apache.kafka.common.protocol.types.Struct;
import java.nio.ByteBuffer;
@@ -65,11 +66,13 @@ public class LeaveGroupRequest extends AbstractRequest {
@Override
public AbstractResponse getErrorResponse(int throttleTimeMs, Throwable e) {
- LeaveGroupResponseData response = new LeaveGroupResponseData();
- if (version() >= 2) {
- response.setThrottleTimeMs(throttleTimeMs);
+ LeaveGroupResponseData responseData = new LeaveGroupResponseData()
+
.setErrorCode(Errors.forException(e).code());
+
+ if (version() >= 1) {
+ responseData.setThrottleTimeMs(throttleTimeMs);
}
- return new LeaveGroupResponse(response);
+ return new LeaveGroupResponse(responseData);
}
public static LeaveGroupRequest parse(ByteBuffer buffer, short version) {
diff --git
a/clients/src/main/java/org/apache/kafka/common/requests/LeaveGroupResponse.java
b/clients/src/main/java/org/apache/kafka/common/requests/LeaveGroupResponse.java
index 3f67bb0..6390c0f 100644
---
a/clients/src/main/java/org/apache/kafka/common/requests/LeaveGroupResponse.java
+++
b/clients/src/main/java/org/apache/kafka/common/requests/LeaveGroupResponse.java
@@ -24,6 +24,7 @@ import org.apache.kafka.common.protocol.types.Struct;
import java.nio.ByteBuffer;
import java.util.Collections;
import java.util.Map;
+import java.util.Objects;
public class LeaveGroupResponse extends AbstractResponse {
@@ -72,4 +73,15 @@ public class LeaveGroupResponse extends AbstractResponse {
public boolean shouldClientThrottle(short version) {
return version >= 2;
}
+
+ @Override
+ public boolean equals(Object other) {
+ return other instanceof LeaveGroupResponse &&
+ ((LeaveGroupResponse) other).data.equals(this.data);
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hashCode(data);
+ }
}
diff --git
a/clients/src/test/java/org/apache/kafka/common/requests/LeaveGroupRequestTest.java
b/clients/src/test/java/org/apache/kafka/common/requests/LeaveGroupRequestTest.java
new file mode 100644
index 0000000..9fa9d3b
--- /dev/null
+++
b/clients/src/test/java/org/apache/kafka/common/requests/LeaveGroupRequestTest.java
@@ -0,0 +1,60 @@
+/*
+ * 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.common.requests;
+
+import org.apache.kafka.common.message.LeaveGroupRequestData;
+import org.apache.kafka.common.message.LeaveGroupResponseData;
+import org.apache.kafka.common.protocol.ApiKeys;
+import org.apache.kafka.common.protocol.Errors;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+
+public class LeaveGroupRequestTest {
+
+ @Test
+ public void testLeaveConstructor() {
+ final String groupId = "group_id";
+ final String memberId = "member_id";
+ final int throttleTimeMs = 10;
+
+ final LeaveGroupRequestData expectedData = new LeaveGroupRequestData()
+ .setGroupId(groupId)
+ .setMemberId(memberId);
+
+ final LeaveGroupRequest.Builder builder =
+ new LeaveGroupRequest.Builder(new LeaveGroupRequestData()
+ .setGroupId(groupId)
+ .setMemberId(memberId));
+
+ for (short version = 0; version <=
ApiKeys.LEAVE_GROUP.latestVersion(); version++) {
+ LeaveGroupRequest request = builder.build(version);
+ assertEquals(expectedData, request.data());
+
+ int expectedThrottleTime = version >= 1 ? throttleTimeMs
+ :
AbstractResponse.DEFAULT_THROTTLE_TIME;
+ LeaveGroupResponse expectedResponse = new LeaveGroupResponse(
+ new LeaveGroupResponseData()
+ .setErrorCode(Errors.NOT_CONTROLLER.code())
+ .setThrottleTimeMs(expectedThrottleTime)
+ );
+
+ assertEquals(expectedResponse,
request.getErrorResponse(throttleTimeMs,
+
Errors.NOT_CONTROLLER.exception()));
+ }
+ }
+}
diff --git
a/clients/src/test/java/org/apache/kafka/common/requests/LeaveGroupResponseTest.java
b/clients/src/test/java/org/apache/kafka/common/requests/LeaveGroupResponseTest.java
new file mode 100644
index 0000000..a1368b5
--- /dev/null
+++
b/clients/src/test/java/org/apache/kafka/common/requests/LeaveGroupResponseTest.java
@@ -0,0 +1,85 @@
+/*
+ * 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.common.requests;
+
+import org.apache.kafka.common.message.LeaveGroupResponseData;
+import org.apache.kafka.common.protocol.ApiKeys;
+import org.apache.kafka.common.protocol.Errors;
+import org.junit.Test;
+
+import java.util.Collections;
+import java.util.Map;
+
+import static
org.apache.kafka.common.requests.AbstractResponse.DEFAULT_THROTTLE_TIME;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+public class LeaveGroupResponseTest {
+ private final int throttleTimeMs = 10;
+
+ @Test
+ public void testConstructor() {
+ Map<Errors, Integer> expectedErrorCounts =
Collections.singletonMap(Errors.NOT_COORDINATOR, 1);
+
+ LeaveGroupResponseData responseData = new LeaveGroupResponseData()
+
.setErrorCode(Errors.NOT_COORDINATOR.code())
+
.setThrottleTimeMs(throttleTimeMs);
+ for (short version = 0; version <=
ApiKeys.LEAVE_GROUP.latestVersion(); version++) {
+ LeaveGroupResponse leaveGroupResponse = new
LeaveGroupResponse(responseData.toStruct(version), version);
+
+ assertEquals(expectedErrorCounts,
leaveGroupResponse.errorCounts());
+
+ if (version >= 1) {
+ assertEquals(throttleTimeMs,
leaveGroupResponse.throttleTimeMs());
+ } else {
+ assertEquals(DEFAULT_THROTTLE_TIME,
leaveGroupResponse.throttleTimeMs());
+ }
+
+ assertEquals(Errors.NOT_COORDINATOR, leaveGroupResponse.error());
+ }
+ }
+
+ @Test
+ public void testShouldThrottle() {
+ // A dummy setup is ok.
+ LeaveGroupResponse response = new LeaveGroupResponse(new
LeaveGroupResponseData());
+ for (short version = 0; version <=
ApiKeys.LEAVE_GROUP.latestVersion(); version++) {
+ if (version >= 2) {
+ assertTrue(response.shouldClientThrottle(version));
+ } else {
+ assertFalse(response.shouldClientThrottle(version));
+ }
+ }
+ }
+
+ @Test
+ public void testEquality() {
+ LeaveGroupResponseData responseData = new LeaveGroupResponseData()
+ .setErrorCode(Errors.NONE.code())
+ .setThrottleTimeMs(throttleTimeMs);
+ for (short version = 0; version <=
ApiKeys.LEAVE_GROUP.latestVersion(); version++) {
+ LeaveGroupResponse primaryResponse = new
LeaveGroupResponse(responseData.toStruct(version), version);
+
+ LeaveGroupResponse secondaryResponse = new
LeaveGroupResponse(responseData.toStruct(version), version);
+
+ assertEquals(primaryResponse, primaryResponse);
+ assertEquals(primaryResponse, secondaryResponse);
+ assertEquals(primaryResponse.hashCode(),
secondaryResponse.hashCode());
+ }
+ }
+}
