tests: rename RoomMessagesResponse to RoomMessagesResponseTemplate

matrix-org · Jan 13, 2025 · 9514388 · 9514388
1 parent e6dc109
commit 9514388
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 29 deletions.
diff --git a/crates/matrix-sdk-ui/tests/integration/room_list_service.rs b/crates/matrix-sdk-ui/tests/integration/room_list_service.rs
@@ -7,7 +7,7 @@ use matrix_sdk::{
     config::RequestConfig,
     test_utils::{
         logged_in_client_with_server,
-        mocks::{MatrixMockServer, RoomMessagesResponse},
+        mocks::{MatrixMockServer, RoomMessagesResponseTemplate},
         set_client_session, test_client_builder,
     },
     Client,
@@ -2846,7 +2846,7 @@ async fn test_multiple_timeline_init() {
     // Send back-pagination responses with a small delay.
     server
         .mock_room_messages()
-        .ok(RoomMessagesResponse::default()
+        .ok(RoomMessagesResponseTemplate::default()
             .events(vec![f.text_msg("hello").into_raw_timeline()])
             .delayed(Duration::from_millis(500)))
         .mount()

diff --git a/crates/matrix-sdk-ui/tests/integration/timeline/edit.rs b/crates/matrix-sdk-ui/tests/integration/timeline/edit.rs
@@ -24,7 +24,7 @@ use matrix_sdk::{
     room::edit::EditedContent,
     test_utils::{
         logged_in_client_with_server,
-        mocks::{MatrixMockServer, RoomMessagesResponse},
+        mocks::{MatrixMockServer, RoomMessagesResponseTemplate},
     },
     Client,
 };
@@ -870,7 +870,7 @@ impl PendingEditHelper {
     async fn handle_backpagination(&mut self, events: Vec<Raw<AnyTimelineEvent>>, batch_size: u16) {
         self.server
             .mock_room_messages()
-            .ok(RoomMessagesResponse::default().end_token("yolo").events(events))
+            .ok(RoomMessagesResponseTemplate::default().end_token("yolo").events(events))
             .mock_once()
             .mount()
             .await;

diff --git a/crates/matrix-sdk/src/test_utils/mocks.rs b/crates/matrix-sdk/src/test_utils/mocks.rs
@@ -1895,7 +1895,7 @@ impl<'a> MockEndpoint<'a, RoomMessagesEndpoint> {
     ///
     /// Note: pass `chunk` in the correct order: topological for forward
     /// pagination, reverse topological for backwards pagination.
-    pub fn ok(self, response: RoomMessagesResponse) -> MatrixMock<'a> {
+    pub fn ok(self, response: RoomMessagesResponseTemplate) -> MatrixMock<'a> {
         let mut template = ResponseTemplate::new(200).set_body_json(json!({
             "start": response.start,
             "end": response.end,
@@ -1913,7 +1913,7 @@ impl<'a> MockEndpoint<'a, RoomMessagesEndpoint> {
 }
 
 /// A response to a [`RoomMessagesEndpoint`] query.
-pub struct RoomMessagesResponse {
+pub struct RoomMessagesResponseTemplate {
     /// The start token for this /messages query.
     pub start: String,
     /// The end token for this /messages query (previous batch for back
@@ -1927,7 +1927,7 @@ pub struct RoomMessagesResponse {
     pub delay: Option<Duration>,
 }
 
-impl RoomMessagesResponse {
+impl RoomMessagesResponseTemplate {
     /// Fill the events returned as part of this response.
     pub fn events(mut self, chunk: Vec<impl Into<Raw<AnyTimelineEvent>>>) -> Self {
         self.chunk = chunk.into_iter().map(Into::into).collect();
@@ -1947,7 +1947,7 @@ impl RoomMessagesResponse {
     }
 }
 
-impl Default for RoomMessagesResponse {
+impl Default for RoomMessagesResponseTemplate {
     fn default() -> Self {
         Self {
             start: "start-token-unused".to_owned(),

diff --git a/crates/matrix-sdk/tests/integration/event_cache.rs b/crates/matrix-sdk/tests/integration/event_cache.rs
@@ -16,7 +16,7 @@ use matrix_sdk::{
     },
     test_utils::{
         assert_event_matches_msg,
-        mocks::{MatrixMockServer, RoomMessagesResponse},
+        mocks::{MatrixMockServer, RoomMessagesResponseTemplate},
     },
 };
 use matrix_sdk_test::{
@@ -261,7 +261,7 @@ async fn test_backpaginate_once() {
         server
             .mock_room_messages()
             .from("prev_batch")
-            .ok(RoomMessagesResponse::default().events(vec![
+            .ok(RoomMessagesResponseTemplate::default().events(vec![
                 f.text_msg("world").event_id(event_id!("$2")),
                 f.text_msg("hello").event_id(event_id!("$3")),
             ]))
@@ -349,7 +349,7 @@ async fn test_backpaginate_many_times_with_many_iterations() {
     server
         .mock_room_messages()
         .from("prev_batch")
-        .ok(RoomMessagesResponse::default().end_token("prev_batch2").events(vec![
+        .ok(RoomMessagesResponseTemplate::default().end_token("prev_batch2").events(vec![
             f.text_msg("world").event_id(event_id!("$2")),
             f.text_msg("hello").event_id(event_id!("$3")),
         ]))
@@ -361,7 +361,7 @@ async fn test_backpaginate_many_times_with_many_iterations() {
     server
         .mock_room_messages()
         .from("prev_batch2")
-        .ok(RoomMessagesResponse::default()
+        .ok(RoomMessagesResponseTemplate::default()
             .events(vec![f.text_msg("oh well").event_id(event_id!("$4"))]))
         .mock_once()
         .mount()
@@ -487,7 +487,7 @@ async fn test_backpaginate_many_times_with_one_iteration() {
     server
         .mock_room_messages()
         .from("prev_batch")
-        .ok(RoomMessagesResponse::default().end_token("prev_batch2").events(vec![
+        .ok(RoomMessagesResponseTemplate::default().end_token("prev_batch2").events(vec![
             f.text_msg("world").event_id(event_id!("$2")),
             f.text_msg("hello").event_id(event_id!("$3")),
         ]))
@@ -499,7 +499,7 @@ async fn test_backpaginate_many_times_with_one_iteration() {
     server
         .mock_room_messages()
         .from("prev_batch2")
-        .ok(RoomMessagesResponse::default()
+        .ok(RoomMessagesResponseTemplate::default()
             .events(vec![f.text_msg("oh well").event_id(event_id!("$4"))]))
         .mock_once()
         .mount()
@@ -641,7 +641,7 @@ async fn test_reset_while_backpaginating() {
     server
         .mock_room_messages()
         .from("first_backpagination")
-        .ok(RoomMessagesResponse::default()
+        .ok(RoomMessagesResponseTemplate::default()
             .events(vec![f.text_msg("lalala").into_raw_timeline()])
             .delayed(Duration::from_millis(500)))
         .mock_once()
@@ -653,7 +653,7 @@ async fn test_reset_while_backpaginating() {
     server
         .mock_room_messages()
         .from("second_backpagination")
-        .ok(RoomMessagesResponse::default()
+        .ok(RoomMessagesResponseTemplate::default()
             .end_token("third_backpagination")
             .events(vec![f.text_msg("finally!").into_raw_timeline()]))
         .mock_once()
@@ -764,7 +764,7 @@ async fn test_backpaginating_without_token() {
 
     server
         .mock_room_messages()
-        .ok(RoomMessagesResponse::default()
+        .ok(RoomMessagesResponseTemplate::default()
             .events(vec![f.text_msg("hi").event_id(event_id!("$2")).into_raw_timeline()]))
         .mock_once()
         .mount()
@@ -822,7 +822,7 @@ async fn test_limited_timeline_resets_pagination() {
 
     server
         .mock_room_messages()
-        .ok(RoomMessagesResponse::default()
+        .ok(RoomMessagesResponseTemplate::default()
             .events(vec![f.text_msg("hi").event_id(event_id!("$2")).into_raw_timeline()]))
         .mock_once()
         .mount()
@@ -992,7 +992,7 @@ async fn test_limited_timeline_without_storage() {
     server
         .mock_room_messages()
         .from("prev-batch")
-        .ok(RoomMessagesResponse::default()
+        .ok(RoomMessagesResponseTemplate::default()
             .events(vec![f.text_msg("oh well").event_id(event_id!("$1"))]))
         .mock_once()
         .mount()
@@ -1058,7 +1058,7 @@ async fn test_backpaginate_with_no_initial_events() {
     let wait_time = Duration::from_millis(500);
     server
         .mock_room_messages()
-        .ok(RoomMessagesResponse::default()
+        .ok(RoomMessagesResponseTemplate::default()
             .end_token("prev_batch")
             .events(vec![
                 f.text_msg("world").event_id(event_id!("$2")).into_raw_timeline(),
@@ -1073,7 +1073,7 @@ async fn test_backpaginate_with_no_initial_events() {
     server
         .mock_room_messages()
         .from("prev_batch")
-        .ok(RoomMessagesResponse::default()
+        .ok(RoomMessagesResponseTemplate::default()
             .events(vec![f.text_msg("oh well").event_id(event_id!("$1"))]))
         .mock_once()
         .mount()
@@ -1146,7 +1146,7 @@ async fn test_backpaginate_replace_empty_gap() {
     // The first back-pagination will return a previous-batch token, but no events.
     server
         .mock_room_messages()
-        .ok(RoomMessagesResponse::default().end_token("prev_batch"))
+        .ok(RoomMessagesResponseTemplate::default().end_token("prev_batch"))
         .mock_once()
         .mount()
         .await;
@@ -1155,7 +1155,7 @@ async fn test_backpaginate_replace_empty_gap() {
     server
         .mock_room_messages()
         .from("prev_batch")
-        .ok(RoomMessagesResponse::default()
+        .ok(RoomMessagesResponseTemplate::default()
             .events(vec![f.text_msg("hello").event_id(event_id!("$1"))]))
         .mock_once()
         .mount()
@@ -1218,7 +1218,12 @@ async fn test_no_gap_stored_after_deduplicated_sync() {
     drop(events);
 
     // Backpagination will return nothing.
-    server.mock_room_messages().ok(RoomMessagesResponse::default()).mock_once().mount().await;
+    server
+        .mock_room_messages()
+        .ok(RoomMessagesResponseTemplate::default())
+        .mock_once()
+        .mount()
+        .await;
 
     let pagination = room_event_cache.pagination();
 
@@ -1328,7 +1333,7 @@ async fn test_no_gap_stored_after_deduplicated_backpagination() {
     server
         .mock_room_messages()
         .from("prev-batch2")
-        .ok(RoomMessagesResponse::default())
+        .ok(RoomMessagesResponseTemplate::default())
         .mock_once()
         .mount()
         .await;
@@ -1338,7 +1343,7 @@ async fn test_no_gap_stored_after_deduplicated_backpagination() {
     server
         .mock_room_messages()
         .from("prev-batch")
-        .ok(RoomMessagesResponse::default().end_token("prev-batch3").events(vec![
+        .ok(RoomMessagesResponseTemplate::default().end_token("prev-batch3").events(vec![
             // Items in reverse order, since this is back-pagination.
             f.text_msg("world").event_id(event_id!("$2")).into_raw_timeline(),
             f.text_msg("hello").event_id(event_id!("$1")).into_raw_timeline(),
@@ -1424,7 +1429,7 @@ async fn test_dont_delete_gap_that_wasnt_inserted() {
     server
         .mock_room_messages()
         .from("prev-batch")
-        .ok(RoomMessagesResponse::default())
+        .ok(RoomMessagesResponseTemplate::default())
         .mock_once()
         .mount()
         .await;

diff --git a/crates/matrix-sdk/tests/integration/widget.rs b/crates/matrix-sdk/tests/integration/widget.rs
@@ -18,7 +18,7 @@ use assert_matches::assert_matches;
 use async_trait::async_trait;
 use futures_util::FutureExt;
 use matrix_sdk::{
-    test_utils::mocks::{MatrixMockServer, RoomMessagesResponse},
+    test_utils::mocks::{MatrixMockServer, RoomMessagesResponseTemplate},
     widget::{
         Capabilities, CapabilitiesProvider, WidgetDriver, WidgetDriverHandle, WidgetSettings,
     },
@@ -313,7 +313,7 @@ async fn test_read_messages_with_msgtype_capabilities() {
         mock_server
             .mock_room_messages()
             .limit(3)
-            .ok(RoomMessagesResponse::default().end_token(end).events(chunk2))
+            .ok(RoomMessagesResponseTemplate::default().end_token(end).events(chunk2))
             .mock_once()
             .mount()
             .await;