feat(sdk): Introduce LinkedChunkUpdate
#3281
Merged
Conversation
This file contains 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
Hywan
force-pushed
the
feat-sdk-linked-chunk-listener
branch
2 times, most recently
from
6453764 to
abe2206
Compare
Hywan
force-pushed
the
feat-sdk-linked-chunk-listener
branch
from
665eca2 to
20398ea
Compare
This patch changes the signature of `LinkedChunk<Item, Gap, const CHUNK_CAPACITY = usize>` to `LinkedChunk<const CHUNK_CAPACITY = usize, Item, Gap>`. It allows to add more generic parameters if needed, without conflicting with generic constants.
Hywan
force-pushed
the
feat-sdk-linked-chunk-listener
branch
from
20398ea to
93b6134
Compare
Hywan
requested review from
andybalaam and
bnjbvr
and removed request for
a team and
andybalaam
bnjbvr
requested changes
Apr 29, 2024
Hywan
force-pushed
the
feat-sdk-linked-chunk-listener
branch
from
93b6134 to
88bde57
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3281 +/- ##
==========================================
- Coverage 83.65% 83.31% -0.35%
==========================================
Files 242 242
Lines 25012 25160 +148
==========================================
+ Hits 20924 20962 +38
- Misses 4088 4198 +110 ☔ View full report in Codecov by Sentry. |
Hywan
force-pushed
the
feat-sdk-linked-chunk-listener
branch
from
88bde57 to
10e2fbd
Compare
Hywan
changed the title
LinkedChunkListenerLinkedChunkUpdate
Hywan
force-pushed
the
feat-sdk-linked-chunk-listener
branch
2 times, most recently
from
cbc4e89 to
ae6f23a
Compare
bnjbvr
approved these changes
May 2, 2024
Hywan
force-pushed
the
feat-sdk-linked-chunk-listener
branch
from
1ed1c1a to
2b6c4db
Compare
This patch creates the `LinkedChunkListener` trait. This patch also updates `LinkedChunk` to be able to use a `LinkedChunkListener`.
This patch is a turn around about the `LinkedChunkListener`. Many patches have been removed because `LinkedChunkListener` needed to support I/O, so errors and async code. The whole code was affected by that, resulting in a complex API. The idea of this patch is to decoupled this. Here is how. First off, `LinkedChunkListener` is removed. So it's one less generic parameter on `LinkedChunk`. It's also one less trait, so less implementations. Second, now `LinkedChunk` accumulates/collects all “updates” under the form of a new enum `LinkedChunkUpdate`. These updates can be read with `LinkedChunk::updates(&mut self) -> &Vec<LinkedChunkUpdate>`. The reader can simply read them, or even drain them. The reader is responsible to handle these updates and to dispatch them in a storage or whatever. `LinkedChunk` is no longer responsible to do that, removing the need to support errors and to be async. Third, the simplification has led to an optimisation by introducing a new type `LinkedChunkLinks`. The documentation explains what it does and why it was needed. The benefit of this type is: it doesn't increase the size of `LinkedChunk`, but it simplifies the code: no more `Arc`, no more `Mutex` (it was required because with I/O and async), no more borrow checker trick, and the code stays as safe as before.
This patch makes the `LinkedChunk::update_history` field optional, so that it doesn't require the user to drain it to avoid eating the universe. The `new` constructor disabled the update history, the `new_with_update_history` enables it.
Hywan
force-pushed
the
feat-sdk-linked-chunk-listener
branch
from
2b6c4db to
443647a
Compare
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.
This patch introduces
LinkedChunkUpdateandLinkedChunk::updates(&mut self) -> &mut Vec<LinkedChunkUpdate>. It's a new mechanism that is used byLinkedChunkin order to get a list of all updates that happened in aLinkedChunk. This is the fundamental piece to write a persistent storage forLinkedChunk, and thus forEventCache, see #3280 to learn more.EventCachestorage #3280