Adding popup messages for errors with status codes alongside the exception message

.vscode/launch.json

@@ -0,0 +1,7 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": []
+}

Nitrox.Test/Model/StatusCodeTests.cs

@@ -0,0 +1,153 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using System;
+using System.Windows.Forms;
+using static NitroxModel.DisplayStatusCodes;
+using System.Diagnostics;
+namespace NitroxModel;
+
+[TestClass]
+public class StatusCodeTests
+{
+    // Vars for counting repeat codes to check if they are infinitely repeating and therefore fatal
+    private static int repeatCodeCountDisplay = 0;
+    private static StatusCode lastCodeDisplay = StatusCode.SUCCESS;
+    private static int repeatCodeCountPrint = 0;
+    private static StatusCode lastCodePrint = StatusCode.SUCCESS;
+    public static bool TestFatalDisplayStatusCode(StatusCode statusCode, bool fatal, string exception)
+    {
+        // If the statusCode is the same as the last one, increase the repeat code count
+        if (statusCode == lastCodeDisplay && statusCode != StatusCode.CONNECTION_FAIL_CLIENT)
+        {
+            repeatCodeCountDisplay++;
+        }
+        else
+        {
+            repeatCodeCountDisplay = 0;
+        }
+        // If there have been 3 of the same code in a row, including this one, then the error is fatal
+        if (repeatCodeCountDisplay == 2)
+        {
+            fatal = true;
+        }
+        // Set the last code variable
+        lastCodeDisplay = statusCode;
+        // Display a popup message box using CustomMessageBox.cs which has most of the buttons and strings filled in with a placeholder for the statusCode
+        CustomMessageBox customMessage = new(statusCode, exception);
+        customMessage.StartPosition = FormStartPosition.CenterParent;
+        customMessage.ShowDialog();
+        // If the error is fatal,
+        if (fatal)
+        {
+            // Normally we would exit nitrox, but we return true for testing
+            return true;
+        }
+        // If the error is not fatal, we would continue running but we return false for testing
+        return false;
+    }
+
+    // Print the statusCode to the server console(only for statusCodes that are due to a server-side crash)
+    public static bool TestFatalPrintStatusCode(StatusCode statusCode, bool fatal, string exception)
+    {
+        // If the code is the same as the one we last printed, increment the repeated codes counter
+        if (statusCode == lastCodePrint && statusCode != StatusCode.CONNECTION_FAIL_CLIENT)
+        {
+            repeatCodeCountPrint++;
+        }
+        // If the code is different, reset the counter
+        else
+        {
+            repeatCodeCountPrint = 0;
+        }
+        // If the same code happens 3 times in a row, then the error is fatal
+        if (repeatCodeCountPrint == 2)
+        {
+            fatal = true;
+        }
+        // Set the last StatusCode variable
+        lastCodePrint = statusCode;
+        // Log the statusCode message to console
+        Debug.WriteLine(string.Concat("Status code = ", statusCode.ToString("D"), " <- Look up this code on the nitrox website for more information about this error." + "Exception message: " + exception));
+        // If the error is fatal,
+        if (fatal)
+        {
+            // Normally we would exit nitrox, but we return true for testing
+            return true;
+        }
+        // If the error is not fatal, we would continue running but we return false for testing purposes
+        return false;
+    }
+
+
+    [TestMethod]
+    public void ThrowStatusCodesNonFatalDisplay()
+    {
+        var statusCodeNames = Enum.GetNames(typeof(StatusCode));
+        // Display one of every status code once non-fatally, should display all of them once and show "test passed"
+        for (int i = 0; i < statusCodeNames.Length; i++)
+        {
+            DisplayStatusCode((StatusCode)Enum.Parse(typeof(StatusCode), statusCodeNames[i]), false, statusCodeNames[i] + " Testing exception");
+        }
+    }
+    [TestMethod]
+    public void ThrowStatusCodesFatalDisplay()
+    {
+        // Display one of every status code once fatally, should only display the first one and then exit, showing "Test aborted"
+        if (!TestFatalDisplayStatusCode(StatusCode.DEAD_PIRATES_TELL_NO_TALES, true, StatusCode.DEAD_PIRATES_TELL_NO_TALES.ToString() + " Testing exception"))
+        {
+            throw new Exception("Test failed: Program continued to run after a fatal StatusCode call");
+        }
+
+    }
+    [TestMethod]
+    public void ThrowStatusCodesLongExceptionDisplay()
+    {
+
+        // Test if the text will wrap or if the messageBox will expand to accomodate for a long exception message
+        DisplayStatusCode(StatusCode.FILE_SYSTEM_ERR, false, "This is a testing exception that is super long to test if text will wrap to fit the message box space, or potentially expand the message box as needed. Did you know that you are wasting your time reading this? Like actually there is nothing here you can stop reading, just run the test and you will see this text there. Alright this is probably long enough hopefully it works :) and btw Crabsnake is the best mod.");
+    }
+    [TestMethod]
+    public void InfinitelyThrowSameCodeDisplay()
+    { // Test if after throwing the same message 3 times, if it will exit fatally
+        TestFatalDisplayStatusCode(StatusCode.INVALID_VARIABLE_VAL, false, " Infinite loop testing exception");
+        TestFatalDisplayStatusCode(StatusCode.INVALID_VARIABLE_VAL, false, " Infinite loop testing exception");
+        if (!TestFatalDisplayStatusCode(StatusCode.INVALID_VARIABLE_VAL, false, " Infinite loop testing exception"))
+        {
+            throw new Exception("Test failed: program did not exit after 3 StatusCode exception calls for the same error");
+        }
+    }
+    [TestMethod]
+    public void InfinitelyThrowSameCodePrint()
+    {
+        TestFatalPrintStatusCode(StatusCode.INVALID_VARIABLE_VAL, false, " Infinite loop testing exception");
+        TestFatalPrintStatusCode(StatusCode.INVALID_VARIABLE_VAL, false, " Infinite loop testing exception");
+        if (!TestFatalPrintStatusCode(StatusCode.INVALID_VARIABLE_VAL, false, " Infinite loop testing exception"))
+        {
+            throw new Exception("Test failed: program did not exit after 3 StatusCode exception calls for the same error");
+        }
+    }
+    [TestMethod]
+    public void ThrowStatusCodesNonFatalPrint()
+    {
+        // Display one of every status code once non-fatally, should display all of them once and show "test passed"
+        var statusCodeNames = Enum.GetNames(typeof(StatusCode));
+        for (int i = 0; i < statusCodeNames.Length; i++)
+        {
+            PrintStatusCode((StatusCode)Enum.Parse(typeof(StatusCode), statusCodeNames[i]), false, statusCodeNames[i] + " Testing exception");
+        }
+    }
+    [TestMethod]
+    public void ThrowStatusCodesFatalPrint()
+    {
+        // Display one of every status code once fatally, should only display the first one
+        if (!TestFatalPrintStatusCode(StatusCode.DEAD_PIRATES_TELL_NO_TALES, true, StatusCode.DEAD_PIRATES_TELL_NO_TALES.ToString() + "Testing exception"))
+        {
+            throw new Exception("Test failed: Program continued to run after a fatal StatusCode call");
+        }
+    }
+    [TestMethod]
+    public void ThrowStatusCodesLongExceptionPrint()
+    {
+        // Test if the text will wrap or if the messageBox will expand to accomodate for a long exception message
+        PrintStatusCode(StatusCode.FILE_SYSTEM_ERR, false, "This is a testing exception that is super long to test if text will wrap to fit the message box space, or potentially expand the message box as needed. Did you know that you are wasting your time reading this? Like actually there is nothing here you can stop reading, just run the test and you will see this text there. Alright this is probably long enough hopefully it works :) and btw Crabsnake is the best mod.");
+    }
+}

Nitrox.Test/Nitrox.Test.csproj

@@ -22,6 +22,10 @@
         <ProjectReference Include="..\NitroxServer\NitroxServer.csproj" />
     </ItemGroup>
 
+    <ItemGroup>
+      <Reference Include="System.Windows.Forms" />
+    </ItemGroup>
+
     <Target Name="MoveNitroxAssetsToTestOutput" AfterTargets="Build" Condition="'$(OS)' == 'Windows_NT'">
         <ItemGroup>
             <NitroxSubnauticaAssets Include="..\Nitrox.Assets.Subnautica\**\*." />

NitroxClient/Communication/Exceptions/ClientConnectionFailedException.cs

@@ -1,15 +1,17 @@
-using System;
-
+using System;
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.Exceptions
 {
     public class ClientConnectionFailedException : Exception
     {
         public ClientConnectionFailedException(string message) : base(message)
         {
+            DisplayStatusCode(StatusCode.CONNECTION_FAIL_CLIENT, false, "Client failed to connect to the server and has been disconnected" + message);
         }
 
         public ClientConnectionFailedException(string message, Exception innerException) : base(message, innerException)
         {
+            DisplayStatusCode(StatusCode.CONNECTION_FAIL_CLIENT, false, "Client failed to connect to the server and has been disconnected" + message);
         }
     }
 }

NitroxClient/Communication/MultiplayerSession/ConnectionState/AwaitingReservationCredentials.cs

@@ -1,10 +1,10 @@
-using System;
+using System;
 using System.Threading.Tasks;
 using NitroxClient.Communication.Abstract;
 using NitroxModel.Helper;
 using NitroxModel.MultiplayerSession;
 using NitroxModel.Packets;
-
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.MultiplayerSession.ConnectionState
 {
     public class AwaitingReservationCredentials : ConnectionNegotiatingState
@@ -56,7 +56,7 @@ private static void ClientIsConnected(IMultiplayerSessionConnectionContext sessi
         {
             if (!sessionConnectionContext.Client.IsConnected)
             {
-                throw new InvalidOperationException("The client is not connected.");
+                DisplayStatusCode(StatusCode.INVALID_PACKET, false, "The client is not connected.");
             }
         }
 
@@ -68,7 +68,7 @@ private static void PlayerSettingsIsNotNull(IMultiplayerSessionConnectionContext
             }
             catch (ArgumentNullException ex)
             {
-                throw new InvalidOperationException("The context does not contain player settings.", ex);
+                DisplayStatusCode(StatusCode.INVALID_PACKET, false, "The context does not contain player settings." + ex);
             }
         }
 
@@ -80,7 +80,7 @@ private static void AuthenticationContextIsNotNull(IMultiplayerSessionConnection
             }
             catch (ArgumentNullException ex)
             {
-                throw new InvalidOperationException("The context does not contain an authentication context.", ex);
+                DisplayStatusCode(StatusCode.INVALID_PACKET, false, "The context does not contain an authentication context." + ex);
             }
         }
     }

NitroxClient/Communication/MultiplayerSession/ConnectionState/AwaitingSessionReservation.cs

@@ -1,10 +1,10 @@
-using System;
+using System;
 using System.Threading.Tasks;
 using NitroxClient.Communication.Abstract;
 using NitroxModel.Helper;
 using NitroxModel.MultiplayerSession;
 using NitroxModel.Packets.Exceptions;
-
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.MultiplayerSession.ConnectionState
 {
     public class AwaitingSessionReservation : ConnectionNegotiatingState
@@ -59,14 +59,15 @@ private static void ReservationIsNotNull(IMultiplayerSessionConnectionContext se
             }
             catch (ArgumentNullException ex)
             {
-                throw new InvalidOperationException("The context does not have a reservation.", ex);
+                DisplayStatusCode(StatusCode.INVALID_PACKET, false, "The context does not have a reservation." + ex.ToString());
             }
         }
 
         private void ReservationPacketIsCorrelated(IMultiplayerSessionConnectionContext sessionConnectionContext)
         {
             if (!reservationCorrelationId.Equals(sessionConnectionContext.Reservation.CorrelationId))
             {
+                DisplayStatusCode(StatusCode.INVALID_PACKET, false, sessionConnectionContext.Reservation.ToString() + reservationCorrelationId.ToString());
                 throw new UncorrelatedPacketException(sessionConnectionContext.Reservation, reservationCorrelationId);
             }
         }

NitroxClient/Communication/MultiplayerSession/ConnectionState/CommunicatingState.cs

@@ -1,6 +1,7 @@
-using System.Threading.Tasks;
+using System.Threading.Tasks;
 using NitroxClient.Communication.Abstract;
-
+using NitroxModel;
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.MultiplayerSession.ConnectionState
 {
     public abstract class CommunicatingState : IMultiplayerSessionConnectionState
@@ -14,7 +15,7 @@ public virtual void Disconnect(IMultiplayerSessionConnectionContext sessionConne
         {
             sessionConnectionContext.ClearSessionState();
             sessionConnectionContext.Client.Stop();
-
+            DisplayStatusCode(StatusCode.CONNECTION_FAIL_CLIENT, false, "Client was disconnected.");
             Disconnected newConnectionState = new Disconnected();
             sessionConnectionContext.UpdateConnectionState(newConnectionState);
         }

NitroxClient/Communication/MultiplayerSession/ConnectionState/ConnectionNegotiatedState.cs

@@ -1,14 +1,15 @@
-using System;
+using System;
 using System.Threading.Tasks;
 using NitroxClient.Communication.Abstract;
-
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.MultiplayerSession.ConnectionState
 {
     public abstract class ConnectionNegotiatedState : CommunicatingState
     {
         public override Task NegotiateReservationAsync(IMultiplayerSessionConnectionContext sessionConnectionContext)
         {
-            throw new InvalidOperationException("Unable to negotiate a session connection in the current state.");
+            DisplayStatusCode(StatusCode.CONNECTION_FAIL_CLIENT, false, "Unable to negotiate a session connection in the current state.");
+            throw new Exception();
         }
     }
 }

NitroxClient/Communication/MultiplayerSession/ConnectionState/ConnectionNegotiatingState.cs

@@ -1,13 +1,13 @@
-using System;
+using System;
 using NitroxClient.Communication.Abstract;
-
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.MultiplayerSession.ConnectionState
 {
     public abstract class ConnectionNegotiatingState : CommunicatingState
     {
         public override void JoinSession(IMultiplayerSessionConnectionContext sessionConnectionContext)
         {
-            throw new InvalidOperationException("Cannot join a session until a reservation has been negotiated with the server.");
+            DisplayStatusCode(StatusCode.CONNECTION_FAIL_CLIENT, false, "Cannot join a session until a reservation has been negotiated with the server.");
         }
     }
 }

NitroxClient/Communication/MultiplayerSession/ConnectionState/Disconnected.cs

@@ -1,10 +1,10 @@
-using System;
+using System;
 using System.Threading.Tasks;
 using NitroxClient.Communication.Abstract;
 using NitroxClient.Communication.Exceptions;
 using NitroxModel.Helper;
 using NitroxModel.Packets;
-
+using static NitroxModel.DisplayStatusCodes;
 namespace NitroxClient.Communication.MultiplayerSession.ConnectionState
 {
     public class Disconnected : IMultiplayerSessionConnectionState
@@ -32,7 +32,7 @@ private void ValidateState(IMultiplayerSessionConnectionContext sessionConnectio
             }
             catch (ArgumentNullException ex)
             {
-                throw new InvalidOperationException("The context is missing an IP address.", ex);
+                DisplayStatusCode(StatusCode.CONNECTION_FAIL_CLIENT, false, "The context is missing an IP address." + ex.ToString());
             }
         }
 
@@ -44,7 +44,7 @@ private static void ValidateClient(IMultiplayerSessionConnectionContext sessionC
             }
             catch (ArgumentNullException ex)
             {
-                throw new InvalidOperationException("The client must be set on the connection context before trying to negotiate a session reservation.", ex);
+                DisplayStatusCode(StatusCode.CONNECTION_FAIL_CLIENT, false, "The client must be set on the connection context before trying to negotiate a session reservation." + ex.ToString());
             }
         }
 
@@ -56,7 +56,7 @@ private static async Task StartClientAsync(string ipAddress, IClient client, int
 
                 if (!client.IsConnected)
                 {
-                    throw new ClientConnectionFailedException("The client failed to connect without providing a reason why.");
+                    DisplayStatusCode(StatusCode.CONNECTION_FAIL_CLIENT, false, "The client failed to connect without providing a reason why.");
                 }
             }
         }
@@ -74,12 +74,12 @@ private static void EstablishSessionPolicy(IMultiplayerSessionConnectionContext
 
         public void JoinSession(IMultiplayerSessionConnectionContext sessionConnectionContext)
         {
-            throw new InvalidOperationException("Cannot join a session until a reservation has been negotiated with the server.");
+            DisplayStatusCode(StatusCode.CONNECTION_FAIL_CLIENT, false, "Cannot join a session until a reservation has been negotiated with the server.");
         }
 
         public void Disconnect(IMultiplayerSessionConnectionContext sessionConnectionContext)
         {
-            throw new InvalidOperationException("Not connected to a multiplayer server.");
+            DisplayStatusCode(StatusCode.CONNECTION_FAIL_CLIENT, false, "Not connected to a multiplayer server.");
         }
     }
 }