KAFKA-20089 : clients - update javadocs -- while topic being created in background#21959
Merged
chia7712 merged 3 commits intoapache:trunkfrom Apr 9, 2026
Merged
KAFKA-20089 : clients - update javadocs -- while topic being created in background#21959chia7712 merged 3 commits intoapache:trunkfrom
chia7712 merged 3 commits intoapache:trunkfrom
Conversation
github-actions
bot
added
triage
muralibasani
changed the title
Contributor
Author
|
@chia7712 may I request your review pls. |
chia7712
reviewed
Apr 5, 2026
| val creatableTopicResponses = creatableTopics.keySet.toSeq.map { topic => | ||
| new MetadataResponseTopic() | ||
| .setErrorCode(Errors.UNKNOWN_TOPIC_OR_PARTITION.code) | ||
| .setErrorCode(Errors.LEADER_NOT_AVAILABLE.code) |
Member
There was a problem hiding this comment.
Modifying the returned error likely requires a KIP. For now, my preference is to simply update the partitionsFor javadoc. It might cause some friction for users who treated the ZK-mode bug as a feature, but it aligns better with the intended API contract.
Member
There was a problem hiding this comment.
I mean, some users tend to rely on this non-standard behavior, and it's time we wake them up :)
Contributor
Author
There was a problem hiding this comment.
Got it. I shall revert the code and add this javadoc to partitionsFor in KafkaConsumer
- @return The list of partitions, which will be empty when the given topic is not found.
- Note: when {@code auto.create.topics.enable} is {@code true}, this method may
- return an empty list even though the topic is being auto-created in the background.
- Callers should not assume the topic does not exist based solely on an empty result.
Is this ok?
Contributor
Author
There was a problem hiding this comment.
Thank you. Pushed that javadoc.
muralibasani
changed the title
muralibasani
changed the title
nileshkumar3
approved these changes
Apr 7, 2026
Contributor
nileshkumar3
left a comment
nileshkumar3
left a comment
There was a problem hiding this comment.
Thanks for the documentation update. LGTM !
chia7712
reviewed
Apr 9, 2026
| * | ||
| * @return The list of partitions, which will be empty when the given topic is not found | ||
| * @return The list of partitions, which will be empty when the given topic is not found. | ||
| * Note: when {@code auto.create.topics.enable} is {@code true}, this method may |
Member
There was a problem hiding this comment.
Should it mention allow.auto.create.topics as well?
Contributor
Author
There was a problem hiding this comment.
Good point. Updated.
chia7712
reviewed
Apr 9, 2026
| * | ||
| * @return The list of partitions, which will be empty when the given topic is not found | ||
| * @return The list of partitions, which will be empty when the given topic is not found. | ||
| * Note: when {@code auto.create.topics.enable} is {@code true}, this method may |
chia7712
approved these changes
Apr 9, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
https://issues.apache.org/jira/browse/KAFKA-20089
Changing the error code needs a kip. For now updating javadocs. A kip
will be proposed later.
Reviewers: Chia-Ping Tsai chia7712@gmail.com