Add logging for messages and do not send empty acks (#284)

Author: Shatur

CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Logging for sending and receiving messages.
+
+### Changed
+
+- Do not send empty ack messages from client.
+
 ## [0.26.2] - 2024-06-05
 
 ### Added

src/client.rs

@@ -156,12 +156,14 @@ fn apply_replication(
     // (unless user requested history via marker).
     let init_tick = *world.resource::<ServerInitTick>();
     let acks_size = mem::size_of::<u16>() * client.received_count(ReplicationChannel::Update);
-    let mut acks = Vec::with_capacity(acks_size);
-    for message in client.receive(ReplicationChannel::Update) {
-        let update_index = read_update_message(params, buffered_updates, message)?;
-        bincode::serialize_into(&mut acks, &update_index)?;
+    if acks_size != 0 {
+        let mut acks = Vec::with_capacity(acks_size);
+        for message in client.receive(ReplicationChannel::Update) {
+            let update_index = read_update_message(params, buffered_updates, message)?;
+            bincode::serialize_into(&mut acks, &update_index)?;
+        }
+        client.send(ReplicationChannel::Init, acks);
     }
-    client.send(ReplicationChannel::Init, acks);
 
     apply_update_messages(world, params, buffered_updates, init_tick)
 }

src/client/replicon_client.rs

@@ -63,6 +63,11 @@ impl RepliconClient {
             .get_mut(channel_id as usize)
             .unwrap_or_else(|| panic!("client should have a receive channel with id {channel_id}"));
 
+        trace!(
+            "received {} message(s) from channel {channel_id}",
+            channel_messages.len()
+        );
+
         channel_messages.drain(..)
     }
 
@@ -73,7 +78,12 @@ impl RepliconClient {
             return;
         }
 
-        self.sent_messages.push((channel_id.into(), message.into()));
+        let channel_id: u8 = channel_id.into();
+        let message: Bytes = message.into();
+
+        trace!("sending {} bytes over channel {channel_id}", message.len());
+
+        self.sent_messages.push((channel_id, message));
     }
 
     /// Sets the client connection status.

src/server/replicon_server.rs

@@ -56,12 +56,17 @@ impl RepliconServer {
         }
 
         let channel_id = channel_id.into();
-        let receive_channel = self
+        let channel_messages = self
             .received_messages
             .get_mut(channel_id as usize)
             .unwrap_or_else(|| panic!("server should have a receive channel with id {channel_id}"));
 
-        receive_channel.drain(..)
+        trace!(
+            "received {} message(s) from channel {channel_id}",
+            channel_messages.len()
+        );
+
+        channel_messages.drain(..)
     }
 
     /// Sends a message to a client over a channel.
@@ -76,8 +81,12 @@ impl RepliconServer {
             return;
         }
 
-        self.sent_messages
-            .push((client_id, channel_id.into(), message.into()));
+        let channel_id: u8 = channel_id.into();
+        let message: Bytes = message.into();
+
+        trace!("sending {} bytes over channel {channel_id}", message.len());
+
+        self.sent_messages.push((client_id, channel_id, message));
     }
 
     /// Marks the server as running or stopped.