[API-338] Improve Ringbuffer#read_many #393
Merged
Conversation
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
Before this, read_many was returning an immutable lazy list of items read. However, there were more information sent by the server which we were omitting. Now, read_many returns an instance of ReadResult, which the user can get the read count, size, next sequence to read from and item sequences. Note that, this is not a breaking change. ReadResult inherits from the ImmutableLazyDataList and hence is a list. So, the users of this API can use their code as it is without any change when they upgrade to 4.1. New users might benefit from the new APIs provided. Also added a filter parameter to read_many, refactored the implementation and updated some docstrings.
Contributor
Author
|
Failed because of an unrelated test. The bug behind the failure is fixed in #394. I will restart tests after getting 394 merged. |
Contributor
Author
|
verify |
srknzl
reviewed
Apr 26, 2021
Contributor
There was a problem hiding this comment.
Left some comments.
Some tests that are missing that I would consider adding:
- Some unit tests for start_sequence, min_count and max_count assertions (I could not find any unit test for ringbuffer, maybe we can add them later together with readMany unit test)
- readyManyAsync_whenSomeWaitingForSingleItemNeeded
- readManyAsync_whenSomeWaitingNeeded
- readManyAsync_whenMinZeroAndItemAvailable
- readManyAsync_whenMinZeroAndNoItemAvailable
- readManyAsync_whenMoreAvailableThanMinimumLessThanMaximum
Contributor
Author
|
@srknzl added some of the tests you mentioned, not all of them because some of them feel unnecessary or already tested. As you said, lets add unit tests later, this is not the main concern of this PR |
Contributor
Author
|
verify |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Before this, read_many was returning an immutable lazy list of
items read. However, there were more information sent by the server
which we were omitting.
Now, read_many returns an instance of ReadResult, which the user
can get the read count, size, next sequence to read from and
item sequences. Note that, this is not a breaking change. ReadResult
inherits from the ImmutableLazyDataList and hence is a list. So, the
users of this API can use their code as it is without any change when
they upgrade to 4.1. New users might benefit from the new APIs provided.
Also added a filter parameter to read_many, refactored the implementation
and updated some docstrings.