test(sdk): add a mocking endpoint for listing threads and test Room::list_threads()

Author: bnjbvr

crates/matrix-sdk/src/room/mod.rs

@@ -4242,4 +4242,46 @@ mod tests {
         assert!(ret.sender_info.is_some());
         assert_eq!(ret.sender_info.unwrap().event().user_id(), sender_id);
     }
+
+    #[async_test]
+    async fn test_list_threads() {
+        let server = MatrixMockServer::new().await;
+        let client = server.client_builder().build().await;
+
+        let room_id = room_id!("!a:b.c");
+        let sender_id = user_id!("@alice:b.c");
+        let f = EventFactory::new().room(room_id).sender(sender_id);
+
+        let eid1 = event_id!("$1");
+        let eid2 = event_id!("$2");
+        let batch1 = vec![f.text_msg("Thread root 1").event_id(eid1).into_raw_sync().cast()];
+        let batch2 = vec![f.text_msg("Thread root 2").event_id(eid2).into_raw_sync().cast()];
+
+        server
+            .mock_room_threads()
+            .ok(batch1.clone(), Some("prev_batch".to_owned()))
+            .mock_once()
+            .mount()
+            .await;
+        server
+            .mock_room_threads()
+            .match_from("prev_batch")
+            .ok(batch2, None)
+            .mock_once()
+            .mount()
+            .await;
+
+        let room = server.sync_joined_room(&client, room_id).await;
+        let result =
+            room.list_threads(ListThreadsOptions::default()).await.expect("Failed to list threads");
+        assert_eq!(result.chunk.len(), 1);
+        assert_eq!(result.chunk[0].event_id().unwrap(), eid1);
+        assert!(result.prev_batch_token.is_some());
+
+        let opts = ListThreadsOptions { from: result.prev_batch_token, ..Default::default() };
+        let result = room.list_threads(opts).await.expect("Failed to list threads");
+        assert_eq!(result.chunk.len(), 1);
+        assert_eq!(result.chunk[0].event_id().unwrap(), eid2);
+        assert!(result.prev_batch_token.is_none());
+    }
 }

crates/matrix-sdk/src/test_utils/mocks/mod.rs

@@ -1001,6 +1001,14 @@ impl MatrixMockServer {
         let mock = Mock::given(method("POST")).and(path("/_matrix/client/v3/logout"));
         self.mock_endpoint(mock, LogoutEndpoint).expect_default_access_token()
     }
+
+    /// Create a prebuilt mock for the endpoint used to get the list of thread
+    /// roots.
+    pub fn mock_room_threads(&self) -> MockEndpoint<'_, RoomThreadsEndpoint> {
+        let mock =
+            Mock::given(method("GET")).and(path_regex(r"^/_matrix/client/v1/rooms/.*/threads$"));
+        self.mock_endpoint(mock, RoomThreadsEndpoint).expect_default_access_token()
+    }
 }
 
 /// Parameter to [`MatrixMockServer::sync_room`].
@@ -2570,3 +2578,26 @@ impl<'a> MockEndpoint<'a, LogoutEndpoint> {
         self.respond_with(ResponseTemplate::new(200).set_body_json(json!({})))
     }
 }
+
+/// A prebuilt mock for a `GET /rooms/{roomId}/threads` request.
+pub struct RoomThreadsEndpoint;
+
+impl<'a> MockEndpoint<'a, RoomThreadsEndpoint> {
+    /// Expects an optional `from` to be set on the request.
+    pub fn match_from(self, from: &str) -> Self {
+        Self { mock: self.mock.and(query_param("from", from)), ..self }
+    }
+
+    /// Returns a successful response with some optional events and previous
+    /// batch token.
+    pub fn ok(
+        self,
+        chunk: Vec<Raw<AnyTimelineEvent>>,
+        next_batch: Option<String>,
+    ) -> MatrixMock<'a> {
+        self.respond_with(ResponseTemplate::new(200).set_body_json(json!({
+            "chunk": chunk,
+            "next_batch": next_batch
+        })))
+    }
+}