feat: Add a method to reset a SpaceRoomList.

Author: pixlwave

bindings/matrix-sdk-ffi/src/spaces.rs

@@ -156,7 +156,7 @@ impl SpaceService {
     }
 }
 
-/// The `SpaceRoomList`represents a paginated list of direct rooms
+/// The `SpaceRoomList` represents a paginated list of direct rooms
 /// that belong to a particular space.
 ///
 /// It can be used to paginate through the list (and have live updates on the
@@ -249,6 +249,18 @@ impl SpaceRoomList {
     pub async fn paginate(&self) -> Result<(), ClientError> {
         self.inner.paginate().await.map_err(ClientError::from)
     }
+
+    /// Clears the room list back to its initial state so that any new changes
+    /// to the hierarchy will be included the next time [`Self::paginate`] is
+    /// called.
+    ///
+    /// This is useful when you've added or removed children from the space as
+    /// the list is based on a cached state that lives server-side, meaning
+    /// the /hierarchy request needs to be restarted from scratch to pick up
+    /// the changes.
+    pub async fn reset(&self) {
+        self.inner.reset().await;
+    }
 }
 
 #[matrix_sdk_ffi_macros::export(callback_interface)]

crates/matrix-sdk-ui/src/spaces/room_list.rs

@@ -354,6 +354,24 @@ impl SpaceRoomList {
         }
     }
 
+    /// Clears the room list back to its initial state so that any new changes
+    /// to the hierarchy will be included the next time [`Self::paginate`] is
+    /// called.
+    ///
+    /// This is useful when you've added or removed children from the space as
+    /// the list is based on a cached state that lives server-side, meaning
+    /// the /hierarchy request needs to be restarted from scratch to pick up
+    /// the changes.
+    pub async fn reset(&self) {
+        let mut pagination_token = self.token.lock().await;
+        *pagination_token = None.into();
+
+        self.rooms.lock().clear();
+        self.children_state.lock().take();
+
+        self.pagination_state.set(SpaceRoomListPaginationState::Idle { end_reached: false });
+    }
+
     /// Sorts spare rooms by various criteria as defined in
     /// https://spec.matrix.org/latest/client-server-api/#ordering-of-children-within-a-space
     fn compare_rooms(
@@ -888,6 +906,44 @@ mod tests {
         );
     }
 
+    #[async_test]
+    async fn test_reset() {
+        let server = MatrixMockServer::new().await;
+        let client = server.client_builder().build().await;
+        let space_service = SpaceService::new(client.clone()).await;
+
+        let parent_space_id = room_id!("!parent_space:example.org");
+        let child_space_id_1 = room_id!("!1:example.org");
+
+        server
+            .mock_get_hierarchy()
+            .ok_with_room_ids(vec![child_space_id_1])
+            .expect(2)
+            .mount()
+            .await;
+
+        let room_list = space_service.space_room_list(parent_space_id.to_owned()).await;
+
+        room_list.paginate().await.unwrap();
+
+        // This space contains 1 room
+        assert_eq!(room_list.rooms().len(), 1);
+
+        // Resetting the room list
+        room_list.reset().await;
+
+        // Clears the rooms and pagination token
+        assert_eq!(room_list.rooms().len(), 0);
+        assert_matches!(
+            room_list.pagination_state(),
+            SpaceRoomListPaginationState::Idle { end_reached: false }
+        );
+
+        // Allows paginating again
+        room_list.paginate().await.unwrap();
+        assert_eq!(room_list.rooms().len(), 1);
+    }
+
     fn make_space_room(
         room_id: OwnedRoomId,
         order: Option<&str>,