Skip to content
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.

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

[fix][client] Fix the javadoc for startMessageIdInclusive #23508

Merged
merged 1 commit into from
Oct 30, 2024

Conversation

summeriiii
Copy link
Contributor

@summeriiii summeriiii commented Oct 23, 2024

Fixes #23498

Motivation

The Consumer#seek(long) and startMessageIdInclusive have no relation. Whether startMessageIdInclusive is present or not, Consumer#seek(long) that seek by timestamp will contain the firstMessageId.
In the code, we can see that the Consumer#seek(long) seekMessageId use the MessageId.earliest.

@Override
public CompletableFuture<Void> seekAsync(long timestamp) {
    String seekBy = String.format("the timestamp %d", timestamp);
    long requestId = client.newRequestId();
    return seekAsyncInternal(requestId, Commands.newSeek(consumerId, requestId, timestamp),
            MessageId.earliest, timestamp, seekBy);
}

Modifications

remove the Consumer#seek(long) in comment of ReaderBuilder#startMessageIdInclusive and ConsumerBuilder#startMessageIdInclusive

Documentation

  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

Matching PR in forked repository

PR in forked repository:

@github-actions github-actions bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Oct 23, 2024
@summeriiii
Copy link
Contributor Author

@BewareMyPower @lhotari @Technoboy- PTAL~

@Technoboy- Technoboy- added this to the 4.1.0 milestone Oct 30, 2024
@Technoboy- Technoboy- added ready-to-test and removed doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. labels Oct 30, 2024
@Technoboy- Technoboy- closed this Oct 30, 2024
@Technoboy- Technoboy- reopened this Oct 30, 2024
@github-actions github-actions bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Oct 30, 2024
@codecov-commenter
Copy link

codecov-commenter commented Oct 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.35%. Comparing base (bbc6224) to head (0d75283).
Report is 702 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff              @@
##             master   #23508      +/-   ##
============================================
+ Coverage     73.57%   74.35%   +0.77%     
- Complexity    32624    34428    +1804     
============================================
  Files          1877     1943      +66     
  Lines        139502   147045    +7543     
  Branches      15299    16205     +906     
============================================
+ Hits         102638   109330    +6692     
- Misses        28908    29282     +374     
- Partials       7956     8433     +477     
Flag Coverage Δ
inttests 27.30% <ø> (+2.71%) ⬆️
systests 24.39% <ø> (+0.06%) ⬆️
unittests 73.72% <ø> (+0.88%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 659 files with indirect coverage changes

@lhotari lhotari merged commit 170be11 into apache:master Oct 30, 2024
74 of 78 checks passed
heesung-sn pushed a commit to heesung-sn/pulsar that referenced this pull request Nov 5, 2024
visxu pushed a commit to vissxu/pulsar that referenced this pull request Nov 6, 2024
lhotari pushed a commit that referenced this pull request Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cherry-picked/branch-4.0 doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. ready-to-test release/4.0.1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc] the javadoc of ReaderBuilder#startMessageIdInclusive and ConsumerBuilder#startMessageIdInclusive
5 participants