feat(base) Client-side sorting, prelude: Implement Client::rooms_stream
#3068
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-roomlist-sorting
branch
from
64e8798
to
e0dc148
Compare
bnjbvr
reviewed
Feb 8, 2024
Hywan
force-pushed
the
feat-roomlist-sorting
branch
from
e0dc148
to
0e7e6be
Compare
Hywan
force-pushed
the
feat-roomlist-sorting
branch
2 times, most recently
from
54c587b
to
0186631
Compare
1 task
Hywan
force-pushed
the
feat-roomlist-sorting
branch
3 times, most recently
from
1375bbf
to
20e62dc
Compare
Hywan
changed the title
Client::rooms_stream
Hywan
force-pushed
the
feat-roomlist-sorting
branch
2 times, most recently
from
57d54a9
to
ff04efb
Compare
This patch updates `Store::rooms` from a `Arc<StdRwLock<BTreeMap<OwnedRoomId, Room>>>` to a `Arc<StdRwLock<Rooms>>` where `Rooms` is a new type that mimics a `BTreeMap` but that is observable. It uses an `ObservableVector` for saving us the costs of writing a new `ObservableMap` type in `eyeball-im`. It would have too much implications that are clearly not necessary. The major one being that an `ObservableMap` must emit `MapDiff`, but we expect `VectorDiff` everywhere in the SDK where rooms are observable. It would break too many API and too many projects. The benchmark is coming, but here are the results (for 10'000 rooms, extreme case): * `get_rooms` and `get_rooms_filtered` are twice faster (in practise, it means 650µs is saved per call), * `get_room` and `get_or_create_room` are 10% slower (in practise, it means 8-10ns is lost per call). Overall, I believe these results are acceptable, and even an improvement for the first one.
This patch rewrites `Rooms` to a generic `ObservableMap` struct. It also adds documentation and tests for this type.
This patch basically implements `ObservableMap::stream` which returns a batched stream of the values.
This patch implements a new `Store::rooms_stream` method that forwards the result of `ObservableMap::stream`.
…tion` is enabled. Running `cargo test -p matrix-sdk-base --features e2e-encryption` makes the code to fail to compile because `crate::latest_event` isn't defined. And indeed, it must be defined if `experimental-sliding-sync` is enabled, but also if `e2e-encryption` is enabled.
This patch implements `Client::rooms_stream`, which forwards the result of the recently added `Store::rooms_stream` method.
…iding-sync` aren't enabled.
Hywan
force-pushed
the
feat-roomlist-sorting
branch
from
ff04efb
to
858f56d
Compare
bnjbvr
requested changes
Jun 17, 2024
| Some(position) => *position, | ||
| None => { | ||
| let value = default(); | ||
| self.insert(key.to_owned(), value) |
There was a problem hiding this comment.
(Same comment as previous applies here too, we may be doing the lookup once too many)
This patch implements `Client::rooms_stream` by forwarding the result of `matrix_sdk_base::Client::rooms_stream`, and mapping the `matrix_sdk_base::Room` to `matrix_sdk::Room`.
This patch creates an `ObservableMap` for `wasm32-unknown-unknown` which simply wraps a `BTreeMap`, and without the `stream` method. Indeed, the first implementation uses `eyeball_im::ObservableVector` which requires `Send` and `Sync` on its values, which cannot compile to Wasm.
Hywan
force-pushed
the
feat-roomlist-sorting
branch
from
858f56d
to
cb029ce
Compare
bnjbvr
approved these changes
Jun 18, 2024
This patch adds an integration test for `Client::rooms_stream`.
Hywan
force-pushed
the
feat-roomlist-sorting
branch
from
d5698c2
to
717c68d
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #3068 +/- ##
==========================================
- Coverage 83.83% 83.80% -0.04%
==========================================
Files 253 254 +1
Lines 25884 25931 +47
==========================================
+ Hits 21701 21731 +30
- Misses 4183 4200 +17 ☔ View full report in Codecov by Sentry. |
4 tasks
Hywan
changed the title
Client::rooms_streamClient::rooms_stream
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 defines the basis to get client-side sorting inside the
RoomList. The first step is to get aStreamofRoomfrom aClient, and this is what this patch does! It's only for non-wasm targets.It's built on top of #3561 to avoid Clippy warnings.
Blocked by:
SortBystream adapter jplatte/eyeball#43[Meta]SlidingSyncRoomtech debt #3079