Add space_room_from_id function (#5944)

Useful to get a specific space room if available given its id.

---------

Co-authored-by: Doug <[email protected]>

Author: Velin92

bindings/matrix-sdk-ffi/CHANGELOG.md

@@ -8,6 +8,8 @@ All notable changes to this project will be documented in this file.
 
 ### Features
 
+- Add `SpaceService::get_space_room` to get a space given its id from the space graph if available.
+[#5944](https://github.com/matrix-org/matrix-rust-sdk/pull/5944)
 - Add `QrCodeData::to_bytes()` to allow generation of a QR code.
   ([#5939](https://github.com/matrix-org/matrix-rust-sdk/pull/5939))
 - [**breaking**]: The new Latest Event API replaces the old API.

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

@@ -108,6 +108,13 @@ impl SpaceService {
         Ok(parents.into_iter().map(Into::into).collect())
     }
 
+    /// Returns the corresponding `SpaceRoom` for the given room ID, or `None`
+    /// if it isn't known.
+    pub async fn get_space_room(&self, room_id: String) -> Result<Option<SpaceRoom>, ClientError> {
+        let room_id = RoomId::parse(room_id.as_str())?;
+        Ok(self.inner.get_space_room(&room_id).await.map(Into::into))
+    }
+
     pub async fn add_child_to_space(
         &self,
         child_id: String,

crates/matrix-sdk-ui/CHANGELOG.md

@@ -8,6 +8,8 @@ All notable changes to this project will be documented in this file.
 
 ### Features
 
+- Add `SpaceService::get_space_room` to get a space given its id from the space graph if available.
+[#5944](https://github.com/matrix-org/matrix-rust-sdk/pull/5944)
 - [**breaking**]: The new Latest Event API replaces the old API. All the
   `new_` prefixes have been removed. The following methods are removed:
   `EventTimelineItem::from_latest_event`, and `Timeline::latest_event`. See the

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

@@ -257,6 +257,20 @@ impl SpaceService {
             .collect()
     }
 
+    /// Returns the corresponding `SpaceRoom` for the given room ID, or `None`
+    /// if it isn't known.
+    pub async fn get_space_room(&self, room_id: &RoomId) -> Option<SpaceRoom> {
+        let graph = &self.space_state.lock().await.graph;
+
+        if graph.has_node(room_id)
+            && let Some(room) = self.client.get_room(room_id)
+        {
+            Some(SpaceRoom::new_from_known(&room, graph.children_of(room.room_id()).len() as u64))
+        } else {
+            None
+        }
+    }
+
     pub async fn add_child_to_space(
         &self,
         child_id: OwnedRoomId,
@@ -894,6 +908,44 @@ mod tests {
         );
     }
 
+    #[async_test]
+    async fn test_get_space_room_for_id() {
+        let server = MatrixMockServer::new().await;
+        let client = server.client_builder().build().await;
+        let user_id = client.user_id().unwrap();
+        let factory = EventFactory::new();
+
+        server.mock_room_state_encryption().plain().mount().await;
+
+        let space_id = room_id!("!single_space:example.org");
+
+        add_space_rooms(
+            vec![MockSpaceRoomParameters {
+                room_id: space_id,
+                order: None,
+                parents: vec![],
+                children: vec![],
+                power_level: None,
+            }],
+            &client,
+            &server,
+            &factory,
+            user_id,
+        )
+        .await;
+
+        let space_service = SpaceService::new(client.clone());
+
+        // Ensure internal state is populated.
+        _ = space_service.joined_spaces().await;
+
+        let found = space_service.get_space_room(space_id).await;
+        assert!(found.is_some());
+
+        let expected = SpaceRoom::new_from_known(&client.get_room(space_id).unwrap(), 0);
+        assert_eq!(found.unwrap(), expected);
+    }
+
     #[async_test]
     async fn test_add_child_to_space() {
         // Given a space and child room where the user is admin of both.