[refactor][client] Introduce PulsarApiMessageId to access fields of MessageIdData#11
Open
BewareMyPower wants to merge 1 commit intomasterfrom
Open
[refactor][client] Introduce PulsarApiMessageId to access fields of MessageIdData#11BewareMyPower wants to merge 1 commit intomasterfrom
BewareMyPower wants to merge 1 commit intomasterfrom
Conversation
BewareMyPower
changed the title
BewareMyPower
changed the title
BewareMyPower
changed the title
BewareMyPower
force-pushed
the
bewaremypower/introduce-msg-id-data-wrapper
branch
4 times, most recently
from
ef4ce86 to
1f5c2e9
Compare
BewareMyPower
changed the title
BewareMyPower
force-pushed
the
bewaremypower/introduce-msg-id-data-wrapper
branch
2 times, most recently
from
4200a62 to
ed8933d
Compare
4 tasks
BewareMyPower
force-pushed
the
bewaremypower/introduce-msg-id-data-wrapper
branch
from
ed8933d to
539b150
Compare
BewareMyPower
changed the title
Currently the `MessageId` interface hiddens all fields of the
`MessageIdData` struct defined in `PulsarApi.proto`. It's usually enough
for application users because they don't need to access the fields. But
for client developers and developers of other Pulsar ecosystems (e.g.
the built-in Kafka connector and the Flink connector in another repo),
the `MessageId` interface is too simple and there is no common used
abstraction. We can see many code usages like:
```java
if (msgId instanceof BatchMessageIdImpl) {
// Do type cast and then access fields like ledger id...
} else if (msgId instanceof MessageIdImpl) {
// Do type cast and then access fields like ledger id...
// NOTE: don't put this else if before the previous one because
// BatchMessageIdImpl is also a MessageIdImpl
} // ...
```
These `MessageId` implementations are used directly. It's a very bad
design because any change to the public APIs of these implementations
could bring breaking changes.
Also, there is a `TopicMessageIdImpl` that each time a
`getInnerMessageId()` method must be used to get the underlying
`MessageId` object, then do the type assertion and cast again. It makes
code unnecessarily complicated.
### Modifications
Introduce the `PulsarApiMessageId` interface into the `pulsar-common`
module. All `MessageId` implementations so far (except `MultiMessageId`)
should extend this interface so we can do the following conversion
safely in client code or other modules:
```java
long ledgerId = ((PulsarApiMessageId) msgId).getLedgerId();
```
Regarding the `ack_set` field, use a `BitSet` instead of the
`BatchMessageAcker` to record if a message in the batch is acknowledged.
Since the `TopicMessageId` is just a proxy of other `MessageId`
implementations, it's stored as key or value in the map directly because
the `compareTo`/`equal`/`hashCode` methods have the same semantics with
the underlying `MessageId`. There is no need to cast the type and call
`getInnerMessageId`.
Remove all other usages and mark the public methods as deprecated to
avoid breaking changes. They could be removed in the next major release.
Add a `CustomMessageIdTest` to verify any valid `MessageId` implementation
works for `seek` and `acknowledge` APIs.
BewareMyPower
force-pushed
the
bewaremypower/introduce-msg-id-data-wrapper
branch
from
539b150 to
4029416
Compare
|
The pr had no activity for 30 days, mark with Stale label. |
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
1 participant
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.
No description provided.