KAFKA-17747: Add compute topic and group hash #51
+249
−0
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,189 @@ | ||||||||
| /* | ||||||||
| * 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.Uuid; | ||||||||
| import org.apache.kafka.image.MetadataImage; | ||||||||
|
|
||||||||
| import com.google.common.hash.HashCode; | ||||||||
| import com.google.common.hash.HashFunction; | ||||||||
| import com.google.common.hash.Hasher; | ||||||||
| import com.google.common.hash.Hashing; | ||||||||
|
|
||||||||
| import org.junit.jupiter.api.Test; | ||||||||
| import org.junit.jupiter.params.ParameterizedTest; | ||||||||
| import org.junit.jupiter.params.provider.Arguments; | ||||||||
| import org.junit.jupiter.params.provider.MethodSource; | ||||||||
|
|
||||||||
| import java.nio.charset.StandardCharsets; | ||||||||
| import java.util.List; | ||||||||
| import java.util.Map; | ||||||||
| import java.util.stream.Stream; | ||||||||
|
|
||||||||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||||||||
| import static org.junit.jupiter.api.Assertions.assertNotEquals; | ||||||||
|
|
||||||||
| public class GroupTest { | ||||||||
| private static final Uuid FOO_TOPIC_ID = Uuid.randomUuid(); | ||||||||
| private static final String FOO_TOPIC_NAME = "foo"; | ||||||||
| private static final String BAR_TOPIC_NAME = "bar"; | ||||||||
| private static final int FOO_NUM_PARTITIONS = 2; | ||||||||
| private static final MetadataImage FOO_METADATA_IMAGE = new MetadataImageBuilder() | ||||||||
| .addTopic(FOO_TOPIC_ID, FOO_TOPIC_NAME, FOO_NUM_PARTITIONS) | ||||||||
| .addRacks() | ||||||||
| .build(); | ||||||||
|
|
||||||||
| @Test | ||||||||
| void testComputeTopicHash() { | ||||||||
| long result = Group.computeTopicHash(FOO_METADATA_IMAGE.topics().getTopic(FOO_TOPIC_ID), FOO_METADATA_IMAGE.cluster()); | ||||||||
|
|
||||||||
| HashFunction hf = Hashing.murmur3_128(); | ||||||||
| Hasher topicHasher = hf.newHasher() | ||||||||
| .putByte((byte) 0) // magic byte | ||||||||
| .putLong(FOO_TOPIC_ID.hashCode()) // topic Id | ||||||||
|
There was a problem hiding this comment. Using
Suggested change
|
||||||||
| .putString(FOO_TOPIC_NAME, StandardCharsets.UTF_8) // topic name | ||||||||
| .putInt(FOO_NUM_PARTITIONS) // number of partitions | ||||||||
| .putInt(0) // partition 0 | ||||||||
| .putString("rack0;rack1", StandardCharsets.UTF_8) // rack of partition 0 | ||||||||
| .putInt(1) // partition 1 | ||||||||
| .putString("rack1;rack2", StandardCharsets.UTF_8); // rack of partition 1 | ||||||||
|
Comment on lines
+54
to
+63
There was a problem hiding this comment. The logic for building the |
||||||||
| assertEquals(topicHasher.hash().asLong(), result); | ||||||||
| } | ||||||||
|
|
||||||||
| @Test | ||||||||
| void testComputeTopicHashWithDifferentMagicByte() { | ||||||||
| long result = Group.computeTopicHash(FOO_METADATA_IMAGE.topics().getTopic(FOO_TOPIC_ID), FOO_METADATA_IMAGE.cluster()); | ||||||||
|
|
||||||||
| HashFunction hf = Hashing.murmur3_128(); | ||||||||
| Hasher topicHasher = hf.newHasher() | ||||||||
| .putByte((byte) 1) // different magic byte | ||||||||
| .putLong(FOO_TOPIC_ID.hashCode()) // topic Id | ||||||||
| .putString(FOO_TOPIC_NAME, StandardCharsets.UTF_8) // topic name | ||||||||
| .putInt(FOO_NUM_PARTITIONS) // number of partitions | ||||||||
| .putInt(0) // partition 0 | ||||||||
| .putString("rack0;rack1", StandardCharsets.UTF_8) // rack of partition 0 | ||||||||
| .putInt(1) // partition 1 | ||||||||
| .putString("rack1;rack2", StandardCharsets.UTF_8); // rack of partition 1 | ||||||||
| assertNotEquals(topicHasher.hash().asLong(), result); | ||||||||
| } | ||||||||
|
|
||||||||
| @Test | ||||||||
| void testComputeTopicHashWithDifferentPartitionOrder() { | ||||||||
| long result = Group.computeTopicHash(FOO_METADATA_IMAGE.topics().getTopic(FOO_TOPIC_ID), FOO_METADATA_IMAGE.cluster()); | ||||||||
|
|
||||||||
| HashFunction hf = Hashing.murmur3_128(); | ||||||||
| Hasher topicHasher = hf.newHasher() | ||||||||
| .putByte((byte) 0) // magic byte | ||||||||
| .putLong(FOO_TOPIC_ID.hashCode()) // topic Id | ||||||||
| .putString(FOO_TOPIC_NAME, StandardCharsets.UTF_8) // topic name | ||||||||
| .putInt(FOO_NUM_PARTITIONS) // number of partitions | ||||||||
| // different partition order | ||||||||
| .putInt(1) // partition 1 | ||||||||
| .putString("rack1;rack2", StandardCharsets.UTF_8) // rack of partition 1 | ||||||||
| .putInt(0) // partition 0 | ||||||||
| .putString("rack0;rack1", StandardCharsets.UTF_8); // rack of partition 0 | ||||||||
| assertNotEquals(topicHasher.hash().asLong(), result); | ||||||||
| } | ||||||||
|
|
||||||||
| @Test | ||||||||
| void testComputeTopicHashWithDifferentRackOrder() { | ||||||||
| long result = Group.computeTopicHash(FOO_METADATA_IMAGE.topics().getTopic(FOO_TOPIC_ID), FOO_METADATA_IMAGE.cluster()); | ||||||||
|
|
||||||||
| HashFunction hf = Hashing.murmur3_128(); | ||||||||
| Hasher topicHasher = hf.newHasher() | ||||||||
| .putByte((byte) 0) // magic byte | ||||||||
| .putLong(FOO_TOPIC_ID.hashCode()) // topic Id | ||||||||
| .putString(FOO_TOPIC_NAME, StandardCharsets.UTF_8) // topic name | ||||||||
| .putInt(FOO_NUM_PARTITIONS) // number of partitions | ||||||||
| .putInt(0) // partition 0 | ||||||||
| .putString("rack1;rack0", StandardCharsets.UTF_8) // different rack order of partition 0 | ||||||||
| .putInt(1) // partition 1 | ||||||||
| .putString("rack1;rack2", StandardCharsets.UTF_8); // rack of partition 1 | ||||||||
| assertNotEquals(topicHasher.hash().asLong(), result); | ||||||||
| } | ||||||||
|
|
||||||||
| @ParameterizedTest | ||||||||
| @MethodSource("differentFieldGenerator") | ||||||||
| void testComputeTopicHashWithDifferentField(MetadataImage differentImage, Uuid topicId) { | ||||||||
| long result = Group.computeTopicHash(FOO_METADATA_IMAGE.topics().getTopic(FOO_TOPIC_ID), FOO_METADATA_IMAGE.cluster()); | ||||||||
|
|
||||||||
| assertNotEquals( | ||||||||
| Group.computeTopicHash( | ||||||||
| differentImage.topics().getTopic(topicId), | ||||||||
| differentImage.cluster() | ||||||||
| ), | ||||||||
| result | ||||||||
| ); | ||||||||
| } | ||||||||
|
|
||||||||
| private static Stream<Arguments> differentFieldGenerator() { | ||||||||
| Uuid differentTopicId = Uuid.randomUuid(); | ||||||||
| return Stream.of( | ||||||||
| Arguments.of(new MetadataImageBuilder() // different topic id | ||||||||
| .addTopic(differentTopicId, FOO_TOPIC_NAME, FOO_NUM_PARTITIONS) | ||||||||
| .addRacks() | ||||||||
| .build(), | ||||||||
| differentTopicId | ||||||||
| ), | ||||||||
| Arguments.of(new MetadataImageBuilder() // different topic name | ||||||||
| .addTopic(FOO_TOPIC_ID, "bar", FOO_NUM_PARTITIONS) | ||||||||
| .addRacks() | ||||||||
| .build(), | ||||||||
| FOO_TOPIC_ID | ||||||||
| ), | ||||||||
| Arguments.of(new MetadataImageBuilder() // different partitions | ||||||||
| .addTopic(FOO_TOPIC_ID, FOO_TOPIC_NAME, 1) | ||||||||
| .addRacks() | ||||||||
| .build(), | ||||||||
| FOO_TOPIC_ID | ||||||||
| ), | ||||||||
| Arguments.of(new MetadataImageBuilder() // different racks | ||||||||
| .addTopic(FOO_TOPIC_ID, FOO_TOPIC_NAME, FOO_NUM_PARTITIONS) | ||||||||
| .build(), | ||||||||
| FOO_TOPIC_ID | ||||||||
| ) | ||||||||
| ); | ||||||||
| } | ||||||||
|
|
||||||||
| @Test | ||||||||
| void testComputeGroupHash() { | ||||||||
| long result = Group.computeGroupHash(Map.of( | ||||||||
| BAR_TOPIC_NAME, 123L, | ||||||||
| FOO_TOPIC_NAME, 456L | ||||||||
| )); | ||||||||
|
|
||||||||
| long expected = Hashing.combineOrdered(List.of( | ||||||||
| HashCode.fromLong(123L), | ||||||||
| HashCode.fromLong(456L) | ||||||||
| )).asLong(); | ||||||||
| assertEquals(expected, result); | ||||||||
| } | ||||||||
|
|
||||||||
| @Test | ||||||||
| void testComputeGroupHashWithDifferentOrder() { | ||||||||
| long result = Group.computeGroupHash(Map.of( | ||||||||
| BAR_TOPIC_NAME, 123L, | ||||||||
| FOO_TOPIC_NAME, 456L | ||||||||
| )); | ||||||||
|
|
||||||||
| long unexpected = Hashing.combineOrdered(List.of( | ||||||||
| HashCode.fromLong(456L), | ||||||||
| HashCode.fromLong(123L) | ||||||||
| )).asLong(); | ||||||||
| assertNotEquals(unexpected, result); | ||||||||
| } | ||||||||
| } | ||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
Verify Guava version and consider lightweight alternatives.
Guava 33.4.0-jre is being added as a dependency. While Guava is a well-maintained library, it's quite large (~2.5 MB) and this PR only uses its hashing utilities. Consider:
Run the following script to check the Guava version and security status:
Additionally, consider searching for lightweight alternatives:
Also applies to: 151-151
🏁 Script executed:
Length of output: 972
🌐 Web query:
💡 Result:
Here are small/lightweight Java alternatives to Guava’s Murmur3, with short notes and Maven/artifact references:
Apache Commons Codec — org.apache.commons:commons-codec — includes MurmurHash3 (32/128-bit) (small, well-maintained). (commons.apache.org) [1]
io7m jmurmur — com.io7m.jmurmur:jmurmur — pure-Java Murmur3 (32/64), minimal dependency footprint, on Maven Central. (io7m.com) [2]
Apache DataSketches (memory module) — org.apache.datasketches:datasketches-memory — MurmurHash3 implementation used by DataSketches (no Guava). Good if you already use DataSketches. (apache.github.io) [3]
eprst/murmur3 (github / Maven) — com.github.eprst:murmur3 — small, fast Murmur3 port (Unlicense). (mvnrepository.com) [4]
kotlinx-murmurhash / com.goncalossilva (Kotlin Multiplatform) — usable from JVM for MurmurHash3; lightweight if you accept a small KMP lib. (libraries.io) [5]
If you want, I can give example Maven coordinates + tiny usage snippet for any of these.
Citations:
🏁 Script executed:
Length of output: 5248
🏁 Script executed:
Length of output: 160
🏁 Script executed:
Length of output: 2611
Update Guava to the latest version (currently 33.5.0-jre).
Guava 33.4.0-jre is outdated. The codebase uses Guava's hashing API (
com.google.common.hash.*forHashFunction,Hasher,HashCode,Hashing) ingroup-coordinator/src/main/java/org/apache/kafka/coordinator/group/Group.java. While there are no active security vulnerabilities in version 33.4.0-jre, newer versions are available (33.4.8-jre as a patch, or 33.5.0-jre as the current release).Consider upgrading to at least 33.4.8-jre or preferably 33.5.0-jre for bug fixes and improvements.
Regarding lightweight alternatives: while options like Apache Commons Codec exist for specific hash functions, they would not be direct drop-in replacements for Guava's full hashing API without refactoring the Group.java implementation.