Merge pull request #5260 from matrix-org/rav/join_room_logging

sdk: add logging to `Room::join()`

Author: richvdh

crates/matrix-sdk/CHANGELOG.md

@@ -6,6 +6,8 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased] - ReleaseDate
 
+- Add logging to `Room::join`.
+  ([#5260](https://github.com/matrix-org/matrix-rust-sdk/pull/5260))
 - `ClientServerCapabilities` has been renamed to `ClientServerInfo`. Alongside this,
   `Client::reset_server_info` is now `Client::reset_server_info` and `Client::fetch_server_capabilities`
   is now `Client::fetch_server_versions`, returning the server versions response directly.

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

@@ -375,6 +375,7 @@ impl Room {
     ///
     /// Only invited and left rooms can be joined via this method.
     #[doc(alias = "accept_invitation")]
+    #[instrument(skip_all, fields(room_id = ?self.inner.room_id()))]
     pub async fn join(&self) -> Result<()> {
         let prev_room_state = self.inner.state();
 
@@ -397,19 +398,28 @@ impl Room {
             None
         };
 
+        #[cfg(feature = "e2e-encryption")]
+        let enable_share_history_on_invite = self.client.inner.enable_share_history_on_invite;
+
+        #[cfg(not(feature = "e2e-encryption"))]
+        let enable_share_history_on_invite = false;
+
+        debug!(
+            ?prev_room_state,
+            inviter=?inviter.as_ref().map(|room_member| room_member.user_id()),
+            enable_share_history_on_invite,
+            "Joining room",
+        );
+
         self.client.join_room_by_id(self.room_id()).await?;
 
         #[cfg(feature = "e2e-encryption")]
-        if self.client.inner.enable_share_history_on_invite {
+        if enable_share_history_on_invite {
             if let Some(inviter) = inviter {
                 shared_room_history::maybe_accept_key_bundle(self, inviter.user_id()).await?;
             }
         }
 
-        #[cfg(not(feature = "e2e-encryption"))]
-        // Suppress "unused variable" lint
-        let _inviter = inviter;
-
         Ok(())
     }