change(room_list): request space rooms through sliding sync and expose a room list filter for them (#5479)

This is a breaking change as spaces are now requested through sliding sync and they need to manually be excluded from the room list by using the newly introduced non-space filter.

Author: stefanceriu

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

@@ -16,7 +16,7 @@ use matrix_sdk_ui::{
     room_list_service::filters::{
         new_filter_all, new_filter_any, new_filter_category, new_filter_deduplicate_versions,
         new_filter_favourite, new_filter_fuzzy_match_room_name, new_filter_invite,
-        new_filter_joined, new_filter_non_left, new_filter_none,
+        new_filter_joined, new_filter_non_left, new_filter_non_space, new_filter_none,
         new_filter_normalized_match_room_name, new_filter_unread, BoxedFilterFn, RoomCategory,
     },
     unable_to_decrypt_hook::UtdHookManager,
@@ -454,7 +454,10 @@ impl RoomListDynamicEntriesController {
 pub enum RoomListEntriesDynamicFilterKind {
     All { filters: Vec<RoomListEntriesDynamicFilterKind> },
     Any { filters: Vec<RoomListEntriesDynamicFilterKind> },
+    NonSpace,
     NonLeft,
+    // Not { filter: RoomListEntriesDynamicFilterKind } - requires recursive enum
+    // support in uniffi https://github.com/mozilla/uniffi-rs/issues/396
     Joined,
     Unread,
     Favourite,
@@ -493,6 +496,7 @@ impl From<RoomListEntriesDynamicFilterKind> for BoxedFilterFn {
                 filters.into_iter().map(|filter| BoxedFilterFn::from(filter)).collect(),
             )),
             Kind::NonLeft => Box::new(new_filter_non_left()),
+            Kind::NonSpace => Box::new(new_filter_non_space()),
             Kind::Joined => Box::new(new_filter_joined()),
             Kind::Unread => Box::new(new_filter_unread()),
             Kind::Favourite => Box::new(new_filter_favourite()),

crates/matrix-sdk-ui/CHANGELOG.md

@@ -7,7 +7,9 @@ All notable changes to this project will be documented in this file.
 ## [Unreleased] - ReleaseDate
 
 ### Features
-
+- [**breaking**] Space rooms are now being retrieved through sliding sync and the newly introduced 
+  [`room_list_service::filters::new_filter_non_space`] filter should be used to exclude them from any room list.
+  ([5479](https://github.com/matrix-org/matrix-rust-sdk/pull/5479))
 - [**breaking**] [`Timeline::send_gallery()`] now automatically fills in the thread relationship,
   based on the timeline focus. As a result, the `GalleryConfig::reply()` builder method has been
   replaced with `GalleryConfig::in_reply_to`, and only takes an optional event id (the event that is

crates/matrix-sdk-ui/src/notification_client.rs

@@ -27,7 +27,6 @@ use ruma::{
     EventId, OwnedEventId, OwnedRoomId, RoomId, UserId,
     api::client::sync::sync_events::v5 as http,
     assign,
-    directory::RoomTypeFilter,
     events::{
         AnyFullStateEventContent, AnyMessageLikeEventContent, AnyStateEvent,
         AnySyncMessageLikeEvent, AnySyncTimelineEvent, FullStateEventContent, StateEventType,
@@ -496,7 +495,6 @@ impl NotificationClient {
             .required_state(required_state.clone())
             .filters(Some(assign!(http::request::ListFilters::default(), {
                 is_invite: Some(true),
-                not_room_types: vec![RoomTypeFilter::Space],
             })));
 
         let sync = self

crates/matrix-sdk-ui/src/room_list_service/filters/mod.rs

@@ -60,6 +60,7 @@ mod fuzzy_match_room_name;
 mod invite;
 mod joined;
 mod non_left;
+mod non_space;
 mod none;
 mod normalized_match_room_name;
 mod not;
@@ -79,6 +80,7 @@ use matrix_sdk::Room;
 #[cfg(test)]
 use matrix_sdk_test::{JoinedRoomBuilder, SyncResponseBuilder};
 pub use non_left::new_filter as new_filter_non_left;
+pub use non_space::new_filter as new_filter_non_space;
 pub use none::new_filter as new_filter_none;
 pub use normalized_match_room_name::new_filter as new_filter_normalized_match_room_name;
 pub use not::new_filter as new_filter_not;

crates/matrix-sdk-ui/src/room_list_service/filters/non_space.rs

@@ -0,0 +1,60 @@
+// Copyright 2025 The Matrix.org Foundation C.I.C.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+use super::{super::Room, Filter};
+
+struct NonSpaceRoomMatcher<F>
+where
+    F: Fn(&Room) -> bool,
+{
+    is_not_space: F,
+}
+
+impl<F> NonSpaceRoomMatcher<F>
+where
+    F: Fn(&Room) -> bool,
+{
+    fn matches(&self, room: &Room) -> bool {
+        (self.is_not_space)(room)
+    }
+}
+
+/// Create a new filter that will filter out rooms that are not spaces, i.e.
+/// room with a `room_type` of `m.space` as defined in <https://spec.matrix.org/latest/client-server-api/#spaces>
+pub fn new_filter() -> impl Filter {
+    let matcher = NonSpaceRoomMatcher { is_not_space: move |room| !room.is_space() };
+
+    move |room| -> bool { matcher.matches(room) }
+}
+
+#[cfg(test)]
+mod tests {
+    use matrix_sdk::test_utils::logged_in_client_with_server;
+    use matrix_sdk_test::async_test;
+    use ruma::room_id;
+
+    use super::{super::new_rooms, *};
+
+    #[async_test]
+    async fn test_not_space() {
+        let (client, server) = logged_in_client_with_server().await;
+        let [room] = new_rooms([room_id!("!a:b.c")], &client, &server).await;
+
+        let matcher = NonSpaceRoomMatcher { is_not_space: |_| false };
+        assert!(!matcher.matches(&room));
+
+        let matcher = NonSpaceRoomMatcher { is_not_space: |_| true };
+        assert!(matcher.matches(&room));
+    }
+}

crates/matrix-sdk-ui/src/room_list_service/mod.rs

@@ -68,7 +68,7 @@ use matrix_sdk::{
 pub use room_list::*;
 use ruma::{
     OwnedRoomId, RoomId, UInt, api::client::sync::sync_events::v5 as http, assign,
-    directory::RoomTypeFilter, events::StateEventType,
+    events::StateEventType,
 };
 pub use state::*;
 use thiserror::Error;
@@ -177,7 +177,6 @@ impl RoomListService {
                         // If unset, both invited and joined rooms are returned. If false, no invited rooms are
                         // returned. If true, only invited rooms are returned.
                         is_invite: None,
-                        not_room_types: vec![RoomTypeFilter::Space],
                     }))),
             )
             .await

crates/matrix-sdk-ui/tests/integration/notification_client.rs

@@ -233,7 +233,6 @@ async fn test_notification_client_sliding_sync() {
                     ],
                     "filters": {
                         "is_invite": true,
-                        "not_room_types": ["m.space"],
                     },
                     "timeline_limit": 8,
                 }
@@ -726,7 +725,6 @@ async fn test_notification_client_mixed() {
                     ],
                     "filters": {
                         "is_invite": true,
-                        "not_room_types": ["m.space"],
                     },
                     "timeline_limit": 8,
                 }

crates/matrix-sdk-ui/tests/integration/room_list_service.rs

@@ -370,9 +370,7 @@ async fn test_sync_all_states() -> Result<(), Error> {
                         ["m.room.history_visibility", ""],
                         ["io.element.functional_members", ""],
                     ],
-                    "filters": {
-                        "not_room_types": ["m.space"],
-                    },
+                    "filters": {},
                     "timeline_limit": 1,
                 },
             },