Dima/matrix-rust-sdk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

sliding sync: make the maximum number of room facultative when updating a room

Browse Source
This commit is contained in:
Benjamin Bouvier
2024-01-08 16:32:41 +01:00
parent f48695cc95
commit 463b0dfb91
2 changed files with 55 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crates/matrix-sdk/src/sliding_sync/list/mod.rs
+48 -35
View File
@@ -200,29 +200,35 @@ impl SlidingSyncList {
self.inner.cache_policy
}
/// Update the list based on the response from the server.
/// Update the list based on the server's response.
///
/// The `maximum_number_of_rooms` is the `lists.$this_list.count` value,
/// i.e. maximum number of available rooms as defined by the server. The
/// `list_sync_operations` is the `list.$this_list.ops` value
/// received from the server for this specific list. It consists of
/// operations to “move” rooms' positions. Finally,
/// the `rooms_that_have_received_an_update` is the `rooms` value received
/// from the server, which represents aggregated rooms that have received an
/// update. Maybe their position has changed, maybe they have received a new
/// event in their timeline. We need this information to update the
/// `room_list` even if the position of the room hasn't be modified: it
/// helps the user to know that a room has received an update.
/// # Parameters
///
/// - `maximum_number_of_rooms`: the `lists.$this_list.count` value, i.e.
/// maximum number of available rooms in this list, as defined by the
/// server.
/// - `list_sync_operations` is the `list.$this_list.ops` value received
/// from the server for this specific list. It consists of operations to
/// “move” rooms' positions.
/// - `rooms_that_have_received_an_update` is the `rooms` value received
/// from the server, which represents aggregated rooms that have received
/// an update. Maybe their position has changed, maybe they have received
/// a new event in their timeline, maybe their `RoomInfo` has been
/// updated. We need this information to update the `room_list` even if
/// the position of the room hasn't be modified: it helps the user to know
/// that a room has received an update.
#[instrument(skip(self, list_sync_operations), fields(name = self.name(), list_sync_operations_count = list_sync_operations.len()))]
pub(super) fn update(
&mut self,
maximum_number_of_rooms: u32,
maximum_number_of_rooms: Option<u32>,
list_sync_operations: &[v4::SyncOp],
rooms_that_have_received_an_update: &[OwnedRoomId],
) -> Result<bool, Error> {
// Make sure to update the generator state first; ordering matters because
// `update_room_list` observes the latest ranges in the response.
self.inner.update_request_generator_state(maximum_number_of_rooms)?;
if let Some(maximum_number_of_rooms) = maximum_number_of_rooms {
self.inner.update_request_generator_state(maximum_number_of_rooms)?;
}
let new_changes = self.inner.update_room_list(
maximum_number_of_rooms,
@@ -389,34 +395,41 @@ impl SlidingSyncListInner {
/// helps the user to know that a room has received an update.
fn update_room_list(
&self,
maximum_number_of_rooms: u32,
maximum_number_of_rooms: Option<u32>,
list_sync_operations: &[v4::SyncOp],
rooms_that_have_received_an_update: &[OwnedRoomId],
) -> Result<bool, Error> {
let mut new_changes = false;
// Adjust room list entries.
{
let number_of_missing_rooms = (maximum_number_of_rooms as usize)
.saturating_sub(self.room_list.read().unwrap().len());
if let Some(maximum_number_of_rooms) = maximum_number_of_rooms {
// Adjust room list entries.
{
let number_of_missing_rooms = (maximum_number_of_rooms as usize)
.saturating_sub(self.room_list.read().unwrap().len());
if number_of_missing_rooms > 0 {
self.room_list.write().unwrap().append(
iter::repeat(RoomListEntry::Empty).take(number_of_missing_rooms).collect(),
);
if number_of_missing_rooms > 0 {
self.room_list.write().unwrap().append(
iter::repeat(RoomListEntry::Empty).take(number_of_missing_rooms).collect(),
);
new_changes = true;
new_changes = true;
}
}
}
// Update the `maximum_number_of_rooms` if it has changed.
{
let mut maximum_number_of_rooms_lock = self.maximum_number_of_rooms.write().unwrap();
// Update the `maximum_number_of_rooms` if it has changed.
{
let mut maximum_number_of_rooms_lock =
self.maximum_number_of_rooms.write().unwrap();
if Observable::get(&maximum_number_of_rooms_lock) != &Some(maximum_number_of_rooms) {
Observable::set(&mut maximum_number_of_rooms_lock, Some(maximum_number_of_rooms));
if Observable::get(&maximum_number_of_rooms_lock) != &Some(maximum_number_of_rooms)
{
Observable::set(
&mut maximum_number_of_rooms_lock,
Some(maximum_number_of_rooms),
);
new_changes = true;
new_changes = true;
}
}
}
@@ -998,7 +1011,7 @@ mod tests {
}))
.unwrap();
list.update(6, &[sync0], &[]).unwrap();
list.update(Some(6), &[sync0], &[]).unwrap();
assert_eq!(list.get_room_id(0), Some(room0.to_owned()));
assert_eq!(list.get_room_id(1), Some(room1.to_owned()));
@@ -1035,7 +1048,7 @@ mod tests {
);
// Fake a response.
let _ = $list.update($maximum_number_of_rooms, &[], &[]);
let _ = $list.update(Some($maximum_number_of_rooms), &[], &[]);
assert_eq!(
$list.inner.request_generator.read().unwrap().is_fully_loaded(),
@@ -1491,7 +1504,7 @@ mod tests {
}))
.unwrap();
let new_changes = list.update(5, &[sync], &[]).unwrap();
let new_changes = list.update(Some(5), &[sync], &[]).unwrap();
assert!(new_changes);
@@ -1536,7 +1549,7 @@ mod tests {
let new_changes = list
.update(
5,
Some(5),
&[sync],
// Let's imagine `room2` has received an update, but its position doesn't
// change.
crates/matrix-sdk/src/sliding_sync/mod.rs
+7 -6
View File
@@ -428,14 +428,15 @@ impl SlidingSync {
let maximum_number_of_rooms: u32 =
updates.count.try_into().expect("failed to convert `count` to `u32`");
if list.update(maximum_number_of_rooms, &updates.ops, &updated_rooms)? {
updated_lists.push(name.clone());
}
} else {
let maximum_number_of_rooms = list.maximum_number_of_rooms().unwrap_or(0);
if list.update(maximum_number_of_rooms, &[], &updated_rooms)? {
if list.update(
Some(maximum_number_of_rooms),
&updates.ops,
&updated_rooms,
)? {
updated_lists.push(name.clone());
}
} else if list.update(None, &[], &updated_rooms)? {
updated_lists.push(name.clone());
}
}