From 17ffade52b1802701804829d6efc26969af77eba Mon Sep 17 00:00:00 2001
From: Jonas Platte <jplatte+git@posteo.de>
Date: Sat, 4 Sep 2021 01:43:28 +0200
Subject: [PATCH] state-res: Use named fields instead of multiline messages for
 tracing events

---
 crates/ruma-state-res/src/event_auth.rs | 63 +++++++++++--------------
 1 file changed, 28 insertions(+), 35 deletions(-)

diff --git a/crates/ruma-state-res/src/event_auth.rs b/crates/ruma-state-res/src/event_auth.rs
index 80108582..36fc2f0d 100644
--- a/crates/ruma-state-res/src/event_auth.rs
+++ b/crates/ruma-state-res/src/event_auth.rs
@@ -447,10 +447,7 @@ fn valid_membership_change<E: Event>(
                 warn!("Can't make other user join");
                 false
             } else if let MembershipState::Ban = target_user_current_membership {
-                warn!(
-                    "Banned user can't join\nCurrent user state: {:?}",
-                    target_user_membership_event_id,
-                );
+                warn!(?target_user_membership_event_id, "Banned user can't join");
                 false
             } else {
                 let allow = join_rules == JoinRule::Invite
@@ -459,9 +456,10 @@ fn valid_membership_change<E: Event>(
                     || join_rules == JoinRule::Public;
 
                 if !allow {
-                    warn!("Can't join if join rules is not public and user is not invited/joined\nJoin Rules: {:?}\nCurrent user state: {:?}",
-                        join_rules_event.as_ref().map(|e| e.event_id()),
-                        target_user_membership_event_id,
+                    warn!(
+                        join_rules_event_id = ?join_rules_event.as_ref().map(|e| e.event_id()),
+                        ?target_user_membership_event_id,
+                        "Can't join if join rules is not public and user is not invited / joined",
                     );
                 }
                 allow
@@ -471,10 +469,7 @@ fn valid_membership_change<E: Event>(
             // If content has third_party_invite key
             if let Some(Ok(tp_id)) = third_party_invite {
                 if target_user_current_membership == MembershipState::Ban {
-                    warn!(
-                        "Can't invite banned user\nCurrent user state: {:?}",
-                        target_user_membership_event_id,
-                    );
+                    warn!(?target_user_membership_event_id, "Can't invite banned user");
                     false
                 } else {
                     let allow = verify_third_party_invite(
@@ -493,18 +488,19 @@ fn valid_membership_change<E: Event>(
                 || target_user_current_membership == MembershipState::Ban
             {
                 warn!(
-                    "Can't invite user if sender not joined or the user is currently joined or banned\nCurrent user state: {:?}\nSender user state: {:?}",
-                    target_user_membership_event_id,
-                    sender_membership_event_id,
+                    ?target_user_membership_event_id,
+                    ?sender_membership_event_id,
+                    "Can't invite user if sender not joined or the user is currently joined or \
+                     banned",
                 );
                 false
             } else {
                 let allow = sender_power.filter(|&p| p >= &power_levels.invite).is_some();
                 if !allow {
                     warn!(
-                        "User does not have enough power to invite\nCurrent user state: {:?}\nPower levels: {:?}",
-                        target_user_membership_event_id,
-                        power_levels_event_id,
+                        ?target_user_membership_event_id,
+                        ?power_levels_event_id,
+                        "User does not have enough power to invite",
                     );
                 }
                 allow
@@ -515,28 +511,27 @@ fn valid_membership_change<E: Event>(
                 let allow = target_user_current_membership == MembershipState::Join
                     || target_user_current_membership == MembershipState::Invite;
                 if !allow {
-                    warn!(
-                        "Can't leave if not invited or joined\nCurrent user state: {:?}",
-                        target_user_membership_event_id,
-                    );
+                    warn!(?target_user_membership_event_id, "Can't leave if not invited or joined");
                 }
                 allow
             } else if !sender_is_joined
                 || target_user_current_membership == MembershipState::Ban
                     && sender_power.filter(|&p| p < &power_levels.ban).is_some()
             {
-                warn!("Can't kick if sender not joined or user is already banned\nCurrent user state: {:?}\nSender user state: {:?}",
-                    target_user_membership_event_id,
-                    sender_membership_event_id
+                warn!(
+                    ?target_user_membership_event_id,
+                    ?sender_membership_event_id,
+                    "Can't kick if sender not joined or user is already banned",
                 );
                 false
             } else {
                 let allow = sender_power.filter(|&p| p >= &power_levels.kick).is_some()
                     && target_power < sender_power;
                 if !allow {
-                    warn!("User does not have enough power to kick\nCurrent user state: {:?}\nPower levels: {:?}",
-                        target_user_membership_event_id,
-                        power_levels_event_id,
+                    warn!(
+                        ?target_user_membership_event_id,
+                        ?power_levels_event_id,
+                        "User does not have enough power to kick",
                     );
                 }
                 allow
@@ -544,19 +539,17 @@ fn valid_membership_change<E: Event>(
         }
         MembershipState::Ban => {
             if !sender_is_joined {
-                warn!(
-                    "Can't ban user if sender is not joined\nSender user state: {:?}",
-                    sender_membership_event_id
-                );
+                warn!(?sender_membership_event_id, "Can't ban user if sender is not joined");
                 false
             } else {
                 let allow = sender_power.filter(|&p| p >= &power_levels.ban).is_some()
                     && target_power < sender_power;
                 if !allow {
-                    warn!("User does not have enough power to ban\nCurrent user state: {:?}\nPower levels: {:?}",
-                    target_user_membership_event_id,
-                    power_levels_event_id,
-                );
+                    warn!(
+                        ?target_user_membership_event_id,
+                        ?power_levels_event_id,
+                        "User does not have enough power to ban",
+                    );
                 }
                 allow
             }