Feature packet log (#1038)

* Created the network debugger for incomming and outgoing packets

* Sorted count of packets

* Cleaned up code

Author: EtienneDx

NitroxClient/ClientAutoFacRegistrar.cs

@@ -6,6 +6,7 @@
 using NitroxClient.Communication.MultiplayerSession;
 using NitroxClient.Communication.NetworkingLayer.LiteNetLib;
 using NitroxClient.Communication.Packets.Processors.Abstract;
+using NitroxClient.Debuggers;
 using NitroxClient.GameLogic;
 using NitroxClient.GameLogic.Bases;
 using NitroxClient.GameLogic.ChatUI;
@@ -24,6 +25,7 @@ namespace NitroxClient
 {
     public class ClientAutoFacRegistrar : IAutoFacRegistrar
     {
+        private static readonly Assembly currentAssembly = Assembly.GetExecutingAssembly();
         private readonly IModule[] modules;
 
         public ClientAutoFacRegistrar(params IModule[] modules)
@@ -46,31 +48,37 @@ public void RegisterDependencies(ContainerBuilder containerBuilder)
 
         private static void RegisterCoreDependencies(ContainerBuilder containerBuilder)
         {
-            containerBuilder.Register(c => new NitroxProtobufSerializer("NitroxModel.dll"));
+            containerBuilder.RegisterAssemblyTypes(currentAssembly)
+                            .AssignableTo<BaseDebugger>()
+                            .As<BaseDebugger>()
+                            .AsSelf()
+                            .SingleInstance();
 
+            containerBuilder.Register(c => new NitroxProtobufSerializer($"{nameof(NitroxModel)}.dll"));
+
             containerBuilder.RegisterType<UnityPreferenceStateProvider>()
-                .As<IPreferenceStateProvider>()
-                .SingleInstance();
+                            .As<IPreferenceStateProvider>()
+                            .SingleInstance();
 
             containerBuilder.RegisterType<PlayerPreferenceManager>().SingleInstance();
 
             containerBuilder.RegisterType<MultiplayerSessionManager>()
-                .As<IMultiplayerSession>()
-                .As<IPacketSender>()
-                .InstancePerLifetimeScope();
+                            .As<IMultiplayerSession>()
+                            .As<IPacketSender>()
+                            .InstancePerLifetimeScope();
 
             containerBuilder.RegisterType<LiteNetLibClient>()
-                .As<IClient>()
-                .InstancePerLifetimeScope();
+                            .As<IClient>()
+                            .InstancePerLifetimeScope();
 
             containerBuilder.RegisterType<LocalPlayer>()
-                .AsSelf() //Would like to deprecate this registration at some point and just work through an abstraction.
-                .As<ILocalNitroxPlayer>()
-                .InstancePerLifetimeScope();
+                            .AsSelf() //Would like to deprecate this registration at some point and just work through an abstraction.
+                            .As<ILocalNitroxPlayer>()
+                            .InstancePerLifetimeScope();
 
             containerBuilder.RegisterType<SubnauticaRotationMetadataFactory>()
-                .As<RotationMetadataFactory>()
-                .InstancePerLifetimeScope();
+                            .As<RotationMetadataFactory>()
+                            .InstancePerLifetimeScope();
 
             containerBuilder.RegisterType<PlayerManager>().InstancePerLifetimeScope();
             containerBuilder.RegisterType<PlayerModelManager>().InstancePerLifetimeScope();
@@ -109,15 +117,15 @@ private static void RegisterCoreDependencies(ContainerBuilder containerBuilder)
         private void RegisterPacketProcessors(ContainerBuilder containerBuilder)
         {
             containerBuilder
-                .RegisterAssemblyTypes(Assembly.GetAssembly(GetType()))
+                .RegisterAssemblyTypes(currentAssembly)
                 .AsClosedTypesOf(typeof(ClientPacketProcessor<>))
                 .InstancePerLifetimeScope();
         }
 
         private void RegisterColorSwapManagers(ContainerBuilder containerBuilder)
         {
             containerBuilder
-                .RegisterAssemblyTypes(Assembly.GetAssembly(GetType()))
+                .RegisterAssemblyTypes(currentAssembly)
                 .AssignableTo<IColorSwapManager>()
                 .As<IColorSwapManager>()
                 .InstancePerLifetimeScope();
@@ -126,7 +134,7 @@ private void RegisterColorSwapManagers(ContainerBuilder containerBuilder)
         private void RegisterInitialSyncProcessors(ContainerBuilder containerBuilder)
         {
             containerBuilder
-                .RegisterAssemblyTypes(Assembly.GetAssembly(GetType()))
+                .RegisterAssemblyTypes(currentAssembly)
                 .AssignableTo<InitialSyncProcessor>()
                 .As<InitialSyncProcessor>()
                 .InstancePerLifetimeScope();

NitroxClient/Communication/MultiplayerSession/MultiplayerSessionManager.cs

@@ -2,6 +2,7 @@
 using System.Collections.Generic;
 using NitroxClient.Communication.Abstract;
 using NitroxClient.Communication.MultiplayerSession.ConnectionState;
+using NitroxClient.Debuggers;
 using NitroxClient.GameLogic;
 using NitroxModel;
 using NitroxModel.Helper;

NitroxClient/Communication/NetworkingLayer/LiteNetLib/LiteNetLibClient.cs

@@ -2,6 +2,7 @@
 using LiteNetLib;
 using LiteNetLib.Utils;
 using NitroxClient.Communication.Abstract;
+using NitroxClient.Debuggers;
 using NitroxClient.MonoBehaviours.Gui.InGame;
 using NitroxModel.Core;
 using NitroxModel.Logger;
@@ -15,14 +16,16 @@ public class LiteNetLibClient : IClient
         public bool IsConnected { get; private set; }
 
         private readonly NetPacketProcessor netPacketProcessor = new NetPacketProcessor();
-        private AutoResetEvent connectedEvent = new AutoResetEvent(false);
+        private readonly AutoResetEvent connectedEvent = new AutoResetEvent(false);
         private readonly PacketReceiver packetReceiver;
+        private readonly NetworkDebugger networkDebugger;
 
         private NetManager client;
 
-        public LiteNetLibClient()
+        public LiteNetLibClient(PacketReceiver packetReceiver, NetworkDebugger networkDebugger)
         {
-            packetReceiver = NitroxServiceLocator.LocateService<PacketReceiver>();
+            this.packetReceiver = packetReceiver;
+            this.networkDebugger = networkDebugger;
         }
 
         public void Start(string ipAddress, int serverPort)
@@ -50,6 +53,7 @@ public void Start(string ipAddress, int serverPort)
 
         public void Send(Packet packet)
         {
+            networkDebugger?.PacketSent(packet);
             client.SendToAll(netPacketProcessor.Write(packet.ToWrapperPacket()), NitroxDeliveryMethod.ToLiteNetLib(packet.DeliveryMethod));
             client.Flush();
         }

NitroxClient/Communication/PacketReceiver.cs

@@ -1,22 +1,26 @@
 using System.Collections.Generic;
+using NitroxClient.Debuggers;
 using NitroxModel.Packets;
 
 namespace NitroxClient.Communication
 {
     // TODO: Spinlocks don't seem to be necessary here, but I don't know for certain.
     public class PacketReceiver
     {
+        private readonly NetworkDebugger networkDebugger;
         private readonly Queue<Packet> receivedPackets;
 
-        public PacketReceiver()
+        public PacketReceiver(NetworkDebugger networkDebugger = null)
         {
             receivedPackets = new Queue<Packet>();
+            this.networkDebugger = networkDebugger;
         }
 
         public void PacketReceived(Packet packet)
         {
             lock (receivedPackets)
             {
+                networkDebugger?.PacketReceived(packet);
                 receivedPackets.Enqueue(packet);
             }
         }