feat(sdk): Add RoomPagination::run_backwards(…, until)
#3472
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3472 +/- ##
==========================================
- Coverage 83.29% 83.28% -0.02%
==========================================
Files 248 248
Lines 25236 25243 +7
==========================================
+ Hits 21021 21024 +3
- Misses 4215 4219 +4 ☔ View full report in Codecov by Sentry. |
bnjbvr
requested changes
May 28, 2024
This patch adds a new argument to `RoomPagination::run_backwards`:
`until`. It becomes:
pub async fn run_backwards<F, B, Fut>(&self,
batch_size: u16,
mut until: F
) -> Result<B>
where
F: FnMut(BackPaginationOutcome) -> Fut,
Fut: Future<Output = ControlFlow<B, ()>>,
The idea behind `until` is to run pagination _until_ `until` returns
`ControlFlow::Break`, otherwise it continues paginating.
This is useful is many scenearii (cf. the documentation). This is
also and primarily the first step to stop adding events directly from
the pagination, and starts adding events only and strictly only from
`event_cache::RoomEventCacheUpdate` (again, see the `TODO` in the
documentation). This is not done in this patch for the sake of ease
of review.
This patch adds a new argument to the `until` argument closure of `RoomPagination::run_backwards`: `timeline_has_been_reset`, which designates when the timeline has been reset. A test has been updated accordingly.
This patch adds a test for `until` when it returns `ControlFlow::Continue` multiple times instead of `ControlFlow::Break` immediately.
Hywan
force-pushed
the
feat-sdk-event-cache-pagination-through-update
branch
from
bb0f598 to
7377971
Compare
|
This didn't pass tests on CI, and it's been force-merged. Will revert because it was incorrectly merged. |
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 adds a new argument to
RoomPagination::run_backwards:until. It becomes:The idea behind
untilis to run pagination untiluntilreturnsControlFlow::Break, otherwise it continues paginating.This is useful is many scenearii (cf. the documentation). This is also and primarily the first step to stop adding events directly from the pagination, and starts adding events only and strictly only from
event_cache::RoomEventCacheUpdate(again, see theTODOin the documentation). This is not done in this patch for the sake of ease of review.EventCachestorage #3280