feat(sdk): Improve ChunkIdentifierGenerator
#3256
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
As suggested in https://github.com/matrix-org/matrix-rust-sdk/ pull/3251#discussion_r1532103818 by Poljar, it is possible that the value of the atomic changes between the `fetch_add` and the `load` (if and only if it is used in a concurrency model, which is not the case right now, but anyway… better being correct now!). The idea is not `load` but repeat the addition manually to compute the “current” value.
This patch makes `ChunkIdentifierGenerator::generate_next` to panic if there is no more identifiers available. It was previously returning a `Result` but we were doing nothing with this `Result` except `unwrap`ping it. To simplify the API: let's panic.
Hywan
requested review from
bnjbvr and
poljar
and removed request for
a team and
bnjbvr
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3256 +/- ##
==========================================
- Coverage 83.72% 83.72% -0.01%
==========================================
Files 237 237
Lines 24560 24552 -8
==========================================
- Hits 20564 20556 -8
Misses 3996 3996 ☔ View full report in Codecov by Sentry. |
bnjbvr
approved these changes
Mar 21, 2024
| if current < previous { | ||
| return Err(ChunkIdentifier(previous)); | ||
| if previous == u64::MAX { | ||
| panic!("No more chunk identifiers available. Congrats, you did it. 2^64 identifiers have been consumed.") |
This patch renames `ChunkIdentifierGenerator::generate_next` to `next. This patch also simplifies a `.saturating_add(1)` to a simple `+ 1`, which is fine because we have checked for overflow just before.
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.
Follow up of #3251 (comment).
value of the atomic changes between the
fetch_addand theload(ifand only if it is used in a concurrency model, which is not the case
right now, but anyway… better being correct now!). The idea is not
loadbut repeat the addition manually to compute the “current” value.ChunkIdentifierGenerator::generate_nextto panicif there is no more identifiers available. It was previously returning
a
Resultbut we were doing nothing with thisResultexceptunwrapping it. To simplify the API: let's panic.