ffi: make room and timeline creation orthogonal #4716
Closed
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
This gets rid of the `Timeline` stored in an FFI `Room`. There's no good reason why we should create and hold on to a live timeline instance when we have a `Room` instance, since we might want a `Room` to only perform `Room`-related operations. As a result, this gets rid of `Room::timeline`, which would return the cached timeline instance. `Room::timeline_with_configuration()` can be used to create a new timeline instance for a given room, or `RoomListItem::init_timeline()` and then `RoomListItem::timeline()`.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4716 +/- ##
=======================================
Coverage 85.97% 85.97%
=======================================
Files 290 290
Lines 34065 34065
=======================================
+ Hits 29288 29289 +1
+ Misses 4777 4776 -1 ☔ View full report in Codecov by Sentry. |
5 tasks
Hywan
approved these changes
Feb 26, 2025
bindings/matrix-sdk-ffi/src/room.rs
Outdated
Comment on lines
602
to
605
| let timeline = SdkTimeline::builder(&self.inner) | ||
| .track_read_marker_and_receipts() | ||
| .build() | ||
| .await |
There was a problem hiding this comment.
Is there a risk that the creation of the Timeline and the installation of all its tasks, take a lot of time? Maybe we should add a big warning in the doc?
There was a problem hiding this comment.
We know it can be slow, if there are many events, especially because of read receipts, so yeah I'll add a comment 👍
bnjbvr
added a commit
to matrix-org/complement-crypto
that referenced
this pull request
Feb 26, 2025
|
Dropping this PR:
See dependencies in #4718. |
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 gets rid of the
Timelinestored in an FFIRoom. There's no good reason why we should create and hold on to a live timeline instance when we have aRoominstance, since we might want aRoomto only performRoom-related operations.In general, holding onto live timelines in scattered places may lead to having the auto-linked-chunk-shrink optimization not trigger, so we need to be careful and minimize the number of live timelines at all costs.
As a result, this gets rid of
Room::timeline, which would return the cached timeline instance.Room::timeline_with_configuration()can be used to create a new timeline instance for a given room, orRoomListItem::init_timeline()and thenRoomListItem::timeline().Also renamed the FFI
Room::inner(which is a… SDK Room) toRoom::sdk. Is this too cute? 🥺cc @jmartinesp @stefanceriu, if you could test it out please :-)