room: rename the encrypted log field to is_room_encrypted (#3572)

Author: bnjbvr

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

@@ -32,7 +32,9 @@ use ruma::{
     serde::Raw,
     OwnedTransactionId, TransactionId,
 };
-use tracing::{debug, info, Instrument, Span};
+#[cfg(feature = "image-proc")]
+use tracing::debug;
+use tracing::{info, trace, Instrument, Span};
 
 use super::Room;
 #[cfg(feature = "image-proc")]
@@ -172,17 +174,17 @@ impl<'a> IntoFuture for SendRawMessageLikeEvent<'a> {
             Span::current().record("transaction_id", tracing::field::debug(&txn_id));
 
             #[cfg(not(feature = "e2e-encryption"))]
-            debug!("Sending plaintext event to room because we don't have encryption support.");
+            trace!("Sending plaintext event to room because we don't have encryption support.");
 
             #[cfg(feature = "e2e-encryption")]
             if room.is_encrypted().await? {
-                Span::current().record("encrypted", true);
+                Span::current().record("is_room_encrypted", true);
                 // Reactions are currently famously not encrypted, skip encrypting
                 // them until they are.
                 if event_type == "m.reaction" {
-                    debug!("Sending plaintext event because of the event type.");
+                    trace!("Sending plaintext event because of the event type.");
                 } else {
-                    debug!(
+                    trace!(
                         room_id = ?room.room_id(),
                         "Sending encrypted event because the room is encrypted.",
                     );
@@ -210,8 +212,8 @@ impl<'a> IntoFuture for SendRawMessageLikeEvent<'a> {
                     event_type = "m.room.encrypted";
                 }
             } else {
-                Span::current().record("encrypted", false);
-                debug!("Sending plaintext event because the room is NOT encrypted.",);
+                Span::current().record("is_room_encrypted", false);
+                trace!("Sending plaintext event because the room is NOT encrypted.",);
             };
 
             let request = send_message_event::v3::Request::new_raw(

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

@@ -1686,12 +1686,14 @@ impl Room {
     /// }
     /// # anyhow::Ok(()) };
     /// ```
-    #[instrument(skip_all, fields(event_type, room_id = ?self.room_id(), transaction_id, encrypted, event_id))]
+    #[instrument(skip_all, fields(event_type, room_id = ?self.room_id(), transaction_id, is_room_encrypted, event_id))]
     pub fn send_raw<'a>(
         &'a self,
         event_type: &'a str,
         content: impl IntoRawMessageLikeEventContent,
     ) -> SendRawMessageLikeEvent<'a> {
+        // Note: the recorded instrument fields are saved in
+        // `SendRawMessageLikeEvent::into_future`.
         SendRawMessageLikeEvent::new(self, event_type, content)
     }