Add API for checking for mutate messages

src/client.rs

@@ -2,13 +2,15 @@ pub mod confirm_history;
 #[cfg(feature = "client_diagnostics")]
 pub mod diagnostics;
 pub mod events;
+pub mod server_mutate_ticks;
 
 use std::{io::Cursor, mem};
 
 use bevy::{ecs::world::CommandQueue, prelude::*};
 use bincode::{DefaultOptions, Options};
 use bytes::Bytes;
 use integer_encoding::{FixedIntReader, VarIntReader, VarIntWriter};
+use server_mutate_ticks::ServerMutateTicks;
 
 use crate::core::{
     channels::{ReplicationChannel, RepliconChannels},
@@ -21,6 +23,7 @@ use crate::core::{
             ctx::{DespawnCtx, RemoveCtx, WriteCtx},
             ReplicationRegistry,
         },
+        track_mutate_messages::TrackMutateMessages,
         Replicated,
     },
     replicon_client::RepliconClient,
@@ -67,6 +70,12 @@ impl Plugin for ClientPlugin {
             )
             .add_systems(PreUpdate, Self::reset.in_set(ClientSet::Reset));
     }
+
+    fn finish(&self, app: &mut App) {
+        if **app.world().resource::<TrackMutateMessages>() {
+            app.init_resource::<ServerMutateTicks>();
+        }
+    }
 }
 
 impl ClientPlugin {
@@ -101,10 +110,12 @@ impl ClientPlugin {
                     world.resource_scope(|world, command_markers: Mut<CommandMarkers>| {
                         world.resource_scope(|world, registry: Mut<ReplicationRegistry>| {
                             let mut stats = world.remove_resource::<ClientStats>();
+                            let mut mutate_ticks = world.remove_resource::<ServerMutateTicks>();
                             let mut params = ReceiveParams {
                                 queue: &mut queue,
                                 entity_markers: &mut entity_markers,
                                 entity_map: &mut entity_map,
+                                mutate_ticks: mutate_ticks.as_mut(),
                                 stats: stats.as_mut(),
                                 command_markers: &command_markers,
                                 registry: &registry,
@@ -120,6 +131,9 @@ impl ClientPlugin {
                             if let Some(stats) = stats {
                                 world.insert_resource(stats);
                             }
+                            if let Some(mutate_ticks) = mutate_ticks {
+                                world.insert_resource(mutate_ticks);
+                            }
 
                             Ok(())
                         })
@@ -267,11 +281,17 @@ fn buffer_mutate_message(
 
     let change_tick = DefaultOptions::new().deserialize_from(&mut cursor)?;
     let message_tick = DefaultOptions::new().deserialize_from(&mut cursor)?;
+    let messages_count = if params.mutate_ticks.is_some() {
+        cursor.read_varint()?
+    } else {
+        1
+    };
     let mutate_index = cursor.read_varint()?;
     trace!("received mutate message for {message_tick:?}");
     buffered_mutations.insert(BufferedMutate {
         change_tick,
         message_tick,
+        messages_count,
         message: message.slice(cursor.position() as usize..),
     });
 
@@ -308,6 +328,10 @@ fn apply_mutate_messages(
             Err(e) => result = Err(e),
         }
 
+        if let Some(mutate_ticks) = &mut params.mutate_ticks {
+            mutate_ticks.confirm(mutate.message_tick, mutate.messages_count);
+        }
+
         false
     });
 
@@ -611,6 +635,7 @@ struct ReceiveParams<'a> {
     queue: &'a mut CommandQueue,
     entity_markers: &'a mut EntityMarkers,
     entity_map: &'a mut ServerEntityMap,
+    mutate_ticks: Option<&'a mut ServerMutateTicks>,
     stats: Option<&'a mut ClientStats>,
     command_markers: &'a CommandMarkers,
     registry: &'a ReplicationRegistry,
@@ -675,6 +700,8 @@ pub enum ClientSet {
 ///
 /// In other words, last [`RepliconTick`] with a removal, insertion, spawn or despawn.
 /// When a component mutates, this value is not updated.
+///
+/// See also [`ServerMutateTicks`](server_mutate_ticks::ServerMutateTicks).
 #[derive(Clone, Copy, Debug, Default, Deref, Resource)]
 pub struct ServerChangeTick(RepliconTick);
 
@@ -708,6 +735,11 @@ pub(super) struct BufferedMutate {
     /// The tick this mutations corresponds to.
     message_tick: RepliconTick,
 
+    /// Number of all mutate messages sent by server for this tick.
+    ///
+    /// May not be equal to the number of received messages.
+    messages_count: usize,
+
     /// Mutations data.
     message: Bytes,
 }