Skip to content

MINOR: Remove topic null check from TopicIdPartition and adjust constructor order #11403

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ijuma merged 2 commits into from
Nov 10, 2021
Merged

MINOR: Remove topic null check from TopicIdPartition and adjust constructor order #11403

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
160f97d
MINOR: Remove topic null check from `TopicIdPartition` and adjust con…
ijuma Oct 15, 2021
7ba2353
Minor comment adjustment
ijuma Nov 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions clients/src/main/java/org/apache/kafka/common/TopicIdPartition.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,27 @@ public class TopicIdPartition {
private final Uuid topicId;
private final TopicPartition topicPartition;

/**
* Create an instance with the provided parameters.
*
* @param topicId the topic id
* @param topicPartition the topic partition
*/
public TopicIdPartition(Uuid topicId, TopicPartition topicPartition) {
this.topicId = Objects.requireNonNull(topicId, "topicId can not be null");
this.topicPartition = Objects.requireNonNull(topicPartition, "topicPartition can not be null");
}

public TopicIdPartition(String topic, Uuid topicId, int partition) {
/**
* Create an instance with the provided parameters.
*
* @param topicId the topic id
* @param partition the partition id
* @param topic the topic name or null
*/
public TopicIdPartition(Uuid topicId, int partition, String topic) {
this.topicId = Objects.requireNonNull(topicId, "topicId can not be null");
this.topicPartition = new TopicPartition(
Objects.requireNonNull(topic, "topic can not be null"),
partition);
this.topicPartition = new TopicPartition(topic, partition);
}

/**
Expand All @@ -47,7 +58,7 @@ public Uuid topicId() {
}

/**
* @return the topic name.
* @return the topic name or null.

@showuon showuon Oct 18, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should add more explanation for null return value:
ex: @return the topic name or null if there's only topic ID set.

@ijuma ijuma Oct 28, 2021

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if that adds any value. The topic id is always set, so how is saying "there's only topic id set" helping? Maybe "the topic name or null if it is unknown"?

@showuon showuon Oct 29, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right. "the topic name or null if it is unknown" is what I meant.

*/
public String topic() {
return topicPartition.topic();
Expand Down
26 changes: 22 additions & 4 deletions clients/src/test/java/org/apache/kafka/common/TopicIdPartitionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,34 +30,52 @@ class TopicIdPartitionTest {
private final int partition1 = 1;
private final TopicPartition topicPartition0 = new TopicPartition(topicName0, partition1);
private final TopicIdPartition topicIdPartition0 = new TopicIdPartition(topicId0, topicPartition0);
private final TopicIdPartition topicIdPartition1 = new TopicIdPartition(topicName0, topicId0,
partition1);
private final TopicIdPartition topicIdPartition1 = new TopicIdPartition(topicId0,
partition1, topicName0);

private final TopicIdPartition topicIdPartitionWithNullTopic0 = new TopicIdPartition(topicId0,
partition1, null);
private final TopicIdPartition topicIdPartitionWithNullTopic1 = new TopicIdPartition(topicId0,
new TopicPartition(null, partition1));

private final Uuid topicId1 = new Uuid(7759286116672424028L, -5081215629859775948L);
private final String topicName1 = "another_topic_name";
private final TopicIdPartition topicIdPartition2 = new TopicIdPartition(topicName1, topicId1,
partition1);
private final TopicIdPartition topicIdPartition2 = new TopicIdPartition(topicId1,
partition1, topicName1);
private final TopicIdPartition topicIdPartitionWithNullTopic2 = new TopicIdPartition(topicId1,
new TopicPartition(null, partition1));

@Test
public void testEquals() {
assertEquals(topicIdPartition0, topicIdPartition1);
assertEquals(topicIdPartition1, topicIdPartition0);
assertEquals(topicIdPartitionWithNullTopic0, topicIdPartitionWithNullTopic1);

assertNotEquals(topicIdPartition0, topicIdPartition2);
assertNotEquals(topicIdPartition2, topicIdPartition0);
assertNotEquals(topicIdPartition0, topicIdPartitionWithNullTopic0);
assertNotEquals(topicIdPartitionWithNullTopic0, topicIdPartitionWithNullTopic2);
}

@Test
public void testHashCode() {
assertEquals(Objects.hash(topicIdPartition0.topicId(), topicIdPartition0.topicPartition()),
topicIdPartition0.hashCode());
assertEquals(topicIdPartition0.hashCode(), topicIdPartition1.hashCode());

assertEquals(Objects.hash(topicIdPartitionWithNullTopic0.topicId(),
new TopicPartition(null, partition1)), topicIdPartitionWithNullTopic0.hashCode());
assertEquals(topicIdPartitionWithNullTopic0.hashCode(), topicIdPartitionWithNullTopic1.hashCode());

assertNotEquals(topicIdPartition0.hashCode(), topicIdPartition2.hashCode());
assertNotEquals(topicIdPartition0.hashCode(), topicIdPartitionWithNullTopic0.hashCode());
assertNotEquals(topicIdPartitionWithNullTopic0.hashCode(), topicIdPartitionWithNullTopic2.hashCode());
}

@Test
public void testToString() {
assertEquals("vDiRhkpVQgmtSLnsAZx7lA:a_topic_name-1", topicIdPartition0.toString());
assertEquals("vDiRhkpVQgmtSLnsAZx7lA:null-1", topicIdPartitionWithNullTopic0.toString());
}

}