Join queue despaghettification

Nitrox.Assets.Subnautica/LanguageFiles/en.json

@@ -64,6 +64,7 @@
     "Nitrox_PlayerKicked": "You've been kicked from the server",
     "Nitrox_PlayerLeft": "{PLAYER} left the game.",
     "Nitrox_PlayerListTabName": "Player List",
+    "Nitrox_QueueInfo": "You are at position #{POSITION} in the join queue. Maximum possible wait: {TIME}",
     "Nitrox_RejectedSessionPolicy": "Reservation rejected…",
     "Nitrox_RemotePlayerObstacle": "Another player's either inside or too close to the deconstructable target.",
     "Nitrox_RequestingSessionPolicy": "Requesting session policy info…",

Nitrox.Launcher/Views/LaunchGameView.axaml

@@ -35,7 +35,7 @@
                     Grid.Column="0"
                     Margin="0,0,20,0"
                     FontSize="14"
-                    Text="Start your Subnautica adventure in multiplayer mode together with your friends, powered by the Nitrox mod: An open-source, modification for the game Subnautica. The project is maintained by the community with regular support and updates from its contributors." />
+                    Text="Start your Subnautica adventure in multiplayer mode together with your friends, powered by the Nitrox mod: An open-source modification for the game Subnautica. The project is maintained by the community with regular support and updates from its contributors." />
                 <!--  Play buttons - Negative offset to add some overlap with the background image  -->
                 <StackPanel Grid.Column="1" Margin="0,-110,0,0">
                     <Border ClipToBounds="True" CornerRadius="10">

Nitrox.Test/Patcher/Patches/PatchesTranspilerTest.cs

@@ -43,6 +43,7 @@ public class PatchesTranspilerTest
         [typeof(EntityCell_AwakeAsync_Patch), 2],
         [typeof(EntityCell_SleepAsync_Patch), 2],
         [typeof(Equipment_RemoveItem_Patch), 7],
+        [typeof(ErrorMessage_OnLateUpdate_Patch), new[] {0, 0}],
         [typeof(EscapePod_Start_Patch), 43],
         [typeof(FireExtinguisherHolder_TakeTankAsync_Patch), 2],
         [typeof(FireExtinguisherHolder_TryStoreTank_Patch), 3],
@@ -103,23 +104,46 @@ public void AllTranspilerPatchesHaveSanityTest()
 
     [TestMethod]
     [DynamicData(nameof(TranspilerPatchClasses))]
-    public void AllPatchesTranspilerSanity(Type patchClassType, int ilDifference, bool logInstructions = false)
+    public void AllPatchesTranspilerSanity(Type patchClassType, object ilDifference, bool logInstructions = false)
     {
+        MethodInfo transpilerMethod = patchClassType.GetMethod("Transpiler");
+        if (transpilerMethod == null)
+        {
+            Assert.Fail($"Could not find a \"Transpiler\" method inside {patchClassType.Name}");
+        }
+
         FieldInfo targetMethodInfo = patchClassType.GetRuntimeFields().FirstOrDefault(x => string.Equals(x.Name.Replace("_", ""), "targetMethod", StringComparison.OrdinalIgnoreCase));
-        if (targetMethodInfo == null)
+        if (targetMethodInfo != null)
         {
-            Assert.Fail($"Could not find either \"TARGET_METHOD\" nor \"targetMethod\" inside {patchClassType.Name}");
+            MethodInfo targetMethod = targetMethodInfo.GetValue(null) as MethodInfo;
+            TestTranspilerMethod(patchClassType, targetMethod, transpilerMethod, (int)ilDifference, logInstructions);
         }
+        else
+        {
+            FieldInfo[] targetMethodInfos = patchClassType.GetRuntimeFields()
+                                                          .Where(x => x.Name.Replace("_", "").StartsWith("targetMethod", StringComparison.OrdinalIgnoreCase))
+                                                          .OrderBy(fieldInfo => fieldInfo.Name)
+                                                          .ToArray();
+            if (targetMethodInfos.Length == 0)
+            {
+                Assert.Fail($"Could not find a \"TARGET_METHOD\" or \"targetMethod\" field inside {patchClassType.Name}");
+            }
 
-        MethodInfo targetMethod = targetMethodInfo.GetValue(null) as MethodInfo;
-        List<CodeInstruction> originalIl = PatchTestHelper.GetInstructionsFromMethod(targetMethod).ToList();
-        List<CodeInstruction> originalIlCopy = PatchTestHelper.GetInstructionsFromMethod(targetMethod).ToList(); // Our custom pattern matching replaces OpCode/Operand in place, therefor we need a copy to compare if changes are present
+            // Should be put in alphabetical order of the corresponding "TARGET_METHOD" field name
+            int[] ilDifferences = (int[])ilDifference;
 
-        MethodInfo transpilerMethod = patchClassType.GetMethod("Transpiler");
-        if (transpilerMethod == null)
-        {
-            Assert.Fail($"Could not find \"Transpiler\" inside {patchClassType.Name}");
+            for (int i = 0; i < targetMethodInfos.Length; i++)
+            {
+                MethodInfo targetMethod = targetMethodInfos[i].GetValue(null) as MethodInfo;
+                TestTranspilerMethod(patchClassType, targetMethod, transpilerMethod, ilDifferences[i], logInstructions);
+            }
         }
+    }
+
+    private static void TestTranspilerMethod(Type patchClassType, MethodInfo targetMethod, MethodInfo transpilerMethod, int ilDifference, bool logInstructions = false)
+    {
+        List<CodeInstruction> originalIl = PatchTestHelper.GetInstructionsFromMethod(targetMethod).ToList();
+        List<CodeInstruction> originalIlCopy = PatchTestHelper.GetInstructionsFromMethod(targetMethod).ToList(); // Our custom pattern matching replaces OpCode/Operand in place, therefor we need a copy to compare if changes are present
 
         List<object> injectionParameters = [];
         foreach (ParameterInfo parameterInfo in transpilerMethod.GetParameters())
@@ -143,7 +167,7 @@ public void AllPatchesTranspilerSanity(Type patchClassType, int ilDifference, bo
         }
 
         List<CodeInstruction> transformedIl = (transpilerMethod.Invoke(null, injectionParameters.ToArray()) as IEnumerable<CodeInstruction>)?.ToList();
-        
+
         if (logInstructions)
         {
             Console.WriteLine(transformedIl.ToPrettyString());

NitroxClient/Communication/MultiplayerSession/MultiplayerSessionManager.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Threading.Tasks;
 using NitroxClient.Communication.Abstract;
 using NitroxClient.Communication.MultiplayerSession.ConnectionState;
@@ -82,28 +82,13 @@ public void ProcessSessionPolicy(MultiplayerSessionPolicy policy)
 
         public void RequestSessionReservation(PlayerSettings playerSettings, AuthenticationContext authenticationContext)
         {
-            // If a reservation has already been sent (in which case the client is enqueued in the join queue)
-            if (CurrentState.CurrentStage == MultiplayerSessionConnectionStage.AWAITING_SESSION_RESERVATION)
-            {
-                Log.Info("Waiting in join queue…");
-                Log.InGame(Language.main.Get("Nitrox_Waiting"));
-                return;
-            }
-
             PlayerSettings = playerSettings;
             AuthenticationContext = authenticationContext;
             CurrentState.NegotiateReservationAsync(this);
         }
 
         public void ProcessReservationResponsePacket(MultiplayerSessionReservation reservation)
         {
-            if (reservation.ReservationState == MultiplayerSessionReservationState.ENQUEUED_IN_JOIN_QUEUE)
-            {
-                Log.Info("Waiting in join queue…");
-                Log.InGame(Language.main.Get("Nitrox_Waiting"));
-                return;
-            }
-
             Reservation = reservation;
             CurrentState.NegotiateReservationAsync(this);
         }
@@ -123,7 +108,7 @@ public void Disconnect()
 
         public bool Send<T>(T packet) where T : Packet
         {
-            if (!PacketSuppressor<T>.IsSuppressed)
+            if (Client.IsConnected && !PacketSuppressor<T>.IsSuppressed)
             {
                 Client.Send(packet);
                 return true;

NitroxClient/Communication/Packets/Processors/InitialPlayerSyncProcessor.cs

@@ -13,7 +13,7 @@ public class InitialPlayerSyncProcessor : ClientPacketProcessor<InitialPlayerSyn
     {
         private readonly IPacketSender packetSender;
         private readonly HashSet<IInitialSyncProcessor> processors;
-        private readonly HashSet<Type> alreadyRan = new();
+        private readonly HashSet<Type> alreadyRan = [];
         private InitialPlayerSync packet;
 
         private WaitScreen.ManualWaitItem loadingMultiplayerWaitItem;
@@ -31,7 +31,10 @@ public InitialPlayerSyncProcessor(IPacketSender packetSender, IEnumerable<IIniti
         public override void Process(InitialPlayerSync packet)
         {
             this.packet = packet;
+
             loadingMultiplayerWaitItem = WaitScreen.Add(Language.main.Get("Nitrox_SyncingWorld"));
+            Log.InGame(Language.main.Get("Nitrox_SyncingWorld"));
+
             cumulativeProcessorsRan = 0;
             Multiplayer.Main.StartCoroutine(ProcessInitialSyncPacket(this, null));
         }

NitroxClient/Communication/Packets/Processors/JoinQueueInfoProcessor.cs

@@ -0,0 +1,15 @@
+using System;
+using NitroxClient.Communication.Packets.Processors.Abstract;
+using NitroxModel.Packets;
+
+namespace NitroxClient.Communication.Packets.Processors;
+
+public class JoinQueueInfoProcessor : ClientPacketProcessor<JoinQueueInfo>
+{
+    public override void Process(JoinQueueInfo packet)
+    {
+        Log.InGame(Language.main.Get("Nitrox_QueueInfo")
+            .Replace("{POSITION}", packet.Position.ToString())
+            .Replace("{TIME}", TimeSpan.FromMilliseconds(packet.Timeout * packet.Position).ToString(@"mm\:ss")));
+    }
+}

NitroxClient/MonoBehaviours/Multiplayer.cs

@@ -113,11 +113,14 @@ public static IEnumerator LoadAsync()
 
             WaitScreen.Remove(worldSettleItem);
 
-            WaitScreen.ManualWaitItem item = WaitScreen.Add(Language.main.Get("Nitrox_JoiningSession"));
+            WaitScreen.ManualWaitItem joiningItem = WaitScreen.Add(Language.main.Get("Nitrox_JoiningSession"));
             yield return Main.StartCoroutine(Main.StartSession());
-            WaitScreen.Remove(item);
+            WaitScreen.Remove(joiningItem);
 
+            WaitScreen.ManualWaitItem waitingItem = WaitScreen.Add(Language.main.Get("Nitrox_Waiting"));
+            Log.InGame(Language.main.Get("Nitrox_Waiting"));
             yield return new WaitUntil(() => Main.InitialSyncCompleted);
+            WaitScreen.Remove(waitingItem);
 
             SetLoadingComplete();
             OnLoadingComplete?.Invoke();

NitroxModel/DataStructures/ThreadSafeQueue.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections;
 using System.Collections.Generic;
 using System.Diagnostics;
@@ -121,6 +121,22 @@ public IEnumerable<T> Clone()
             }
         }
 
+        public void Filter(Func<T, bool> predicate)
+        {
+            lock (locker)
+            {
+                int count = queue.Count;
+                for (int i = 0; i < count; i++)
+                {
+                    T item = queue.Dequeue();
+                    if (predicate(item))
+                    {
+                        queue.Enqueue(item);
+                    }
+                }
+            }
+        }
+
         private Queue<T> CreateCopy(IEnumerable<T> data)
         {
             return new Queue<T>(data);

NitroxModel/MultiplayerSession/MultiplayerSessionReservationState.cs

@@ -23,11 +23,8 @@ public enum MultiplayerSessionReservationState
         [Description("The server is using hardcore gamemode, player is dead.")]
         HARDCORE_PLAYER_DEAD = 1 << 4,
 
-        [Description("Another user is currently joining the server.")]
-        ENQUEUED_IN_JOIN_QUEUE = 1 << 5,
-
         [Description("The player name is invalid, It must not contain any space or doubtful characters\n Allowed characters : A-Z a-z 0-9 _ . -\nLength : [3, 25]")]
-        INCORRECT_USERNAME = 1 << 6
+        INCORRECT_USERNAME = 1 << 5
     }
 
     public static class MultiplayerSessionReservationStateExtensions

NitroxModel/Packets/JoinQueueInfo.cs

@@ -0,0 +1,16 @@
+using System;
+
+namespace NitroxModel.Packets;
+
+[Serializable]
+public class JoinQueueInfo : Packet
+{
+    public int Position { get; }
+    public int Timeout { get; }
+
+    public JoinQueueInfo(int position, int timeout)
+    {
+        Position = position;
+        Timeout = timeout;
+    }
+}

NitroxModel/Serialization/SubnauticaServerConfig.cs

@@ -9,7 +9,7 @@ public class SubnauticaServerConfig : NitroxConfig<SubnauticaServerConfig>
     {
         private int maxConnectionsSetting = 100;
 
-        private int initialSyncTimeoutSetting = 300000;
+        private int initialSyncTimeoutSetting = 120000;
 
         [PropertyDescription("Set to true to Cache entities for the whole map on next run. \nWARNING! Will make server load take longer on the cache run but players will gain a performance boost when entering new areas.")]
         public bool CreateFullEntityCache { get; set; } = false;

NitroxPatcher/Patches/Dynamic/ErrorMessage_OnLateUpdate_Patch.cs

@@ -0,0 +1,52 @@
+using System.Collections.Generic;
+using System.Reflection;
+using System.Reflection.Emit;
+using HarmonyLib;
+using NitroxModel.Helper;
+using NitroxPatcher.Patches;
+using UnityEngine;
+
+/// <summary>
+/// Ensures the in-game log is animated smoothly regardless of the time scale.
+/// </summary>
+public sealed partial class ErrorMessage_OnLateUpdate_Patch : NitroxPatch, IDynamicPatch
+{
+    private static readonly MethodInfo TARGET_METHOD_ON_LATE_UPDATE = Reflect.Method((ErrorMessage t) => t.OnLateUpdate());
+    private static readonly MethodInfo TARGET_METHOD_ADD_MESSAGE = Reflect.Method((ErrorMessage t) => t._AddMessage(default));
+    private static readonly MethodInfo TARGET_OPERAND_TIME = Reflect.Property(() => PDA.time).GetMethod;
+    private static readonly MethodInfo TARGET_OPERAND_DELTA_TIME = Reflect.Property(() => PDA.deltaTime).GetMethod;
+    private static readonly MethodInfo INJECTION_OPERAND_UNSCALED_TIME = Reflect.Property(() => Time.unscaledTime).GetMethod;
+    private static readonly MethodInfo INJECTION_OPERAND_UNSCALED_DELTA_TIME = Reflect.Property(() => Time.unscaledDeltaTime).GetMethod;
+
+
+    /*
+     * Replace all calls to PDA.time with Time.unscaledTime and to
+     * PDA.deltaTime with Time.unscaledDeltaTime
+     */
+    public static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstruction> instructions)
+    {
+        CodeMatcher matcher = new CodeMatcher(instructions);
+
+        while (matcher.MatchStartForward(new CodeMatch(OpCodes.Call, TARGET_OPERAND_TIME)).IsValid)
+        {
+            matcher.SetOperandAndAdvance(INJECTION_OPERAND_UNSCALED_TIME);
+        }
+
+        matcher.Start();
+
+        while (matcher.MatchStartForward(new CodeMatch(OpCodes.Call, TARGET_OPERAND_DELTA_TIME)).IsValid)
+        {
+            matcher.SetOperandAndAdvance(INJECTION_OPERAND_UNSCALED_DELTA_TIME);
+        }
+
+        return matcher.InstructionEnumeration();
+    }
+
+    public override void Patch(Harmony harmony)
+    {
+        MethodInfo transpilerInfo = Reflect.Method(() => Transpiler(default));
+
+        PatchTranspiler(harmony, TARGET_METHOD_ON_LATE_UPDATE, transpilerInfo);
+        PatchTranspiler(harmony, TARGET_METHOD_ADD_MESSAGE, transpilerInfo);
+    }
+}

NitroxServer/Communication/LiteNetLib/LiteNetLibServer.cs

@@ -4,7 +4,6 @@
 using LiteNetLib;
 using LiteNetLib.Utils;
 using Mono.Nat;
-using NitroxModel.Helper;
 using NitroxModel.Packets;
 using NitroxModel.Serialization;
 using NitroxServer.Communication.Packets;
@@ -18,7 +17,7 @@ public class LiteNetLibServer : NitroxServer
     private readonly EventBasedNetListener listener;
     private readonly NetManager server;
 
-    public LiteNetLibServer(PacketHandler packetHandler, PlayerManager playerManager, EntitySimulation entitySimulation, SubnauticaServerConfig serverConfig) : base(packetHandler, playerManager, entitySimulation, serverConfig)
+    public LiteNetLibServer(PacketHandler packetHandler, PlayerManager playerManager, JoiningManager joiningManager, EntitySimulation entitySimulation, SubnauticaServerConfig serverConfig) : base(packetHandler, playerManager, joiningManager, entitySimulation, serverConfig)
     {
         listener = new EventBasedNetListener();
         server = new NetManager(listener);

NitroxServer/Communication/NitroxServer.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using System.Threading;
 using NitroxModel.DataStructures;
@@ -26,11 +26,13 @@ static NitroxServer()
         protected readonly EntitySimulation entitySimulation;
         protected readonly Dictionary<int, INitroxConnection> connectionsByRemoteIdentifier = new();
         protected readonly PlayerManager playerManager;
+        protected readonly JoiningManager joiningManager;
 
-        public NitroxServer(PacketHandler packetHandler, PlayerManager playerManager, EntitySimulation entitySimulation, SubnauticaServerConfig serverConfig)
+        public NitroxServer(PacketHandler packetHandler, PlayerManager playerManager, JoiningManager joiningManager, EntitySimulation entitySimulation, SubnauticaServerConfig serverConfig)
         {
             this.packetHandler = packetHandler;
             this.playerManager = playerManager;
+            this.joiningManager = joiningManager;
             this.entitySimulation = entitySimulation;
 
             portNumber = serverConfig.ServerPort;
@@ -47,24 +49,23 @@ protected void ClientDisconnected(INitroxConnection connection)
         {
             Player player = playerManager.GetPlayer(connection);
 
-            if (player != null)
+            if (player == null)
             {
-                playerManager.PlayerDisconnected(connection);
+                joiningManager.JoiningPlayerDisconnected(connection);
+                return;
+            }
 
-                Disconnect disconnect = new(player.Id);
-                playerManager.SendPacketToAllPlayers(disconnect);
+            playerManager.PlayerDisconnected(connection);
 
-                List<SimulatedEntity> ownershipChanges = entitySimulation.CalculateSimulationChangesFromPlayerDisconnect(player);
+            Disconnect disconnect = new(player.Id);
+            playerManager.SendPacketToAllPlayers(disconnect);
 
-                if (ownershipChanges.Count > 0)
-                {
-                    SimulationOwnershipChange ownershipChange = new(ownershipChanges);
-                    playerManager.SendPacketToAllPlayers(ownershipChange);
-                }
-            }
-            else
+            List<SimulatedEntity> ownershipChanges = entitySimulation.CalculateSimulationChangesFromPlayerDisconnect(player);
+
+            if (ownershipChanges.Count > 0)
             {
-                playerManager.NonPlayerDisconnected(connection);
+                SimulationOwnershipChange ownershipChange = new(ownershipChanges);
+                playerManager.SendPacketToAllPlayers(ownershipChange);
             }
         }
 

NitroxServer/Communication/Packets/PacketHandler.cs

@@ -1,4 +1,4 @@
-using System;
+using System;
 using System.Collections.Generic;
 using NitroxModel.Core;
 using NitroxModel.Packets;