Repository navigation
[fix][client] Don't clear shared broker entry metadata when recycling a pooled message - #27098
Merged
merlimat merged 3 commits intoOct 26, 2026
Conversation
… a pooled message With poolMessages=true, all messages of a batch share the same BrokerEntryMetadata instance. MessageImpl.recycle() cleared that instance, so releasing one message removed the broker timestamp and index of the other messages from the same batch that were still in use. Drop the reference in recycle() instead of clearing the shared instance. Assisted-by: Claude Code
sakshichitnis27
marked this pull request as ready for review
October 24, 2026 23:55
Contributor
|
Thanks for the fix! One small, non-blocking issue in the new test: pooled |
Pooled MessageImpl.create() retains the payload, so release the reference owned by the test after creating each message and release the messages that are still live in a finally block. Assisted-by: Claude Code
codelipenghui
approved these changes
Oct 26, 2026
codelipenghui
left a comment
Contributor
There was a problem hiding this comment.
Thanks for addressing the test cleanup. The previous finding is resolved, and all 25 focused test cases passed at 373277b. LGTM.
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
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.
Fixes #27076
Motivation
With
poolMessages=true, the messages of a batch share the sameBrokerEntryMetadatainstance (ConsumerImpl.newSingleMessagepasses the batch's reference to each message).MessageImpl.recycle()calledclear()on that instance, so releasing one message also removed the broker publish time and index of the other messages from the same batch that were still in use.I was able to reproduce this with a regression test: after releasing one of two pooled messages that share broker entry metadata, the other message reported
hasBrokerPublishTime() == false.Modifications
MessageImpl.recycle()now setsbrokerEntryMetadatatonullinstead of clearing it, so the shared instance is no longer modified. ABrokerEntryMetadatais parsed per entry and isn't pooled, so nothing relies on it being cleared.MessageImplTest#testReleaseKeepsBrokerMetadataOfPooledBatchSiblings, which releases the two messages of a batch in both orders and checks the broker publish time and index of the message that is still live.Verifying this change
This change added tests and can be verified as follows:
masterwithout the change and passes with it:./gradlew :pulsar-client-original:test --tests "MessageImplTest"./gradlew :pulsar-client-original:test --tests "org.apache.pulsar.client.impl.*"and./gradlew quickChecklocally.Does this pull request potentially affect one of the following parts:
Documentation
docdoc-requireddoc-not-neededdoc-complete