Added some more comments and finished unit testing, just need to play…

…test and then it's ready for review

Nitrox.Test/Model/StatusCodeTests.cs

@@ -1,35 +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)
+        {
+            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)
+        {
+            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 ThrowStatusCodesNonFatal()
+    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 < Enum.GetNames(typeof(StatusCode)).Length; i++)
+        for (int i = 0; i < statusCodeNames.Length; i++)
         {
-            DisplayStatusCode((StatusCode)i, false, "Testing exception");
+            DisplayStatusCode((StatusCode)Enum.Parse(typeof(StatusCode), statusCodeNames[i]), false, statusCodeNames[i] + " Testing exception");
         }
     }
     [TestMethod]
-    public void ThrowStatusCodesFatal() // Should show up as "aborted" after running it in VS
+    public void ThrowStatusCodesFatalDisplay()
     {
-        // Display one of every status code once fatally, should only display the first one
-        for (int i = 0; i < Enum.GetNames(typeof(StatusCode)).Length; i++)
+        // 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"))
         {
-            DisplayStatusCode((StatusCode)i, true, "Testing exception");
+            throw new Exception("Test failed: Program continued to run after a fatal StatusCode call");
         }
-        throw new Exception("Test failed: Program continued to run after a fatal StatusCode call");
+
     }
     [TestMethod]
-    public void ThrowStatusCodesLongException()
+    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\**\*." />

NitroxModel/DisplayStatusCodes.cs

@@ -4,7 +4,12 @@ namespace NitroxModel
 {
     public class DisplayStatusCodes
     {
-        // List all possible status codes, might be a better way to do something repetive like this(could add more descriptive names too)
+        // Counter variables to check if the same code is happening over and over again to mark it as fatal
+        private static int repeatCodeCountDisplay = 0;
+        private static StatusCode lastCodeDisplay = StatusCode.SUCCESS;
+        private static int repeatCodeCountPrint = 0;
+        private static StatusCode lastCodePrint = StatusCode.SUCCESS;
+        // All possible status codes, uses HTTP error codes
         public enum StatusCode
         {
             SUCCESS = 200,
@@ -31,8 +36,25 @@ public enum StatusCode
             LOCK_ERR = 503,
             INVALID_FUNCTION_CALL = 405
         }
-        public static bool DisplayStatusCode(StatusCode statusCode, bool fatal, string exception)
+        public static void DisplayStatusCode(StatusCode statusCode, bool fatal, string exception)
         {
+            // If the statusCode is the same as the last one we displayed, increase the repeated codes counter
+            if (statusCode == lastCodeDisplay)
+            {
+                repeatCodeCountDisplay++;
+            }
+            // If the statusCode is not the same, reset the repeated codes counter
+            else
+            {
+                repeatCodeCountDisplay = 0;
+            }
+            // If the same code is repeated 3 times in a row(including this code), then the error is fatal
+            if (repeatCodeCountDisplay == 2)
+            {
+                fatal = true;
+            }
+            // Set the last statusCode variable for the next time the function runs
+            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;
@@ -42,19 +64,37 @@ public static bool DisplayStatusCode(StatusCode statusCode, bool fatal, string e
             {
                 Environment.Exit(1);
             }
-            return true;
+            // If the error is not fatal, continue running
         }
+
         // Print the statusCode to the server console(only for statusCodes that are due to a server-side crash)
-        public static bool PrintStatusCode(StatusCode statusCode, bool fatal, string exception)
+        public static void PrintStatusCode(StatusCode statusCode, bool fatal, string exception)
         {
-            // ToString("D") prints the integer value of the statusCode enum
+            // If the statusCode is the same as the last one we printed, increase the repeated codes counter
+            if(statusCode == lastCodePrint)
+            {
+                repeatCodeCountPrint++;
+            }
+            // If the statusCode is different, reset the counter
+            else
+            {
+                repeatCodeCountPrint = 0;
+            }
+            // If the same code happens 3 times in a row, then the error is fatal and we will exit nitrox
+            if(repeatCodeCountPrint == 2)
+            {
+                fatal = true;
+            }
+            // Set the last code printed variable for the next time the function runs
+            lastCodePrint = statusCode;
+            // Log the status code to console along with the exception message
             Log.Error(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, exit nitrox
             if (fatal)
             {
                 Environment.Exit(1);
             }
-            return true;
+            // If the error is not fatal, continue running
         }
     }
 }