[fix] Recursion causing stack overflow when disposing client/service (#588)

- Fix recursion causing stack overflow when disposing client/service
- Add unit tests to verify disposal does not cause stack overflow
- Don't dispose of client via service due to shared reference (service can be disposed of via client)

Author: nwithan8

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Next Release
 
 - Corrects all API documentation link references to point to their new locations
+- Fix recursion during disposal causing stack overflow
 
 ## v6.7.2 (2024-08-16)
 

EasyPost.Tests/ClientTest.cs

@@ -1,5 +1,4 @@
 using System;
-using System.Linq;
 using System.Net;
 using System.Net.Http;
 using System.Threading;
@@ -9,6 +8,7 @@
 using EasyPost.Tests._Utilities;
 using EasyPost.Tests._Utilities.Attributes;
 using Xunit;
+using CustomAssertions = EasyPost.Tests._Utilities.Assertions.Assert;
 
 namespace EasyPost.Tests
 {
@@ -70,6 +70,13 @@ public void TestThreadSafety()
 
         private const string FakeApikey = "fake_api_key";
 
+        [Fact]
+        public void TestClientDisposal()
+        {
+            Client client = new(new ClientConfiguration(FakeApikey));
+            CustomAssertions.DoesNotThrow(() => client.Dispose());
+        }
+
         [Fact]
         public void TestBaseUrlOverride()
         {

EasyPost.Tests/HttpTests/ClientConfigurationTest.cs

@@ -1,13 +1,21 @@
 using System;
 using EasyPost.Tests._Utilities.Attributes;
 using Xunit;
+using CustomAssertions = EasyPost.Tests._Utilities.Assertions.Assert;
 
 namespace EasyPost.Tests.HttpTests
 {
     public class ClientConfigurationTest
     {
         #region Tests
 
+        [Fact]
+        public void TestClientConfigurationDisposal()
+        {
+            ClientConfiguration configuration = new("not_a_real_api_key");
+            CustomAssertions.DoesNotThrow(() => configuration.Dispose());
+        }
+
         [Fact]
         [Testing.Function]
         public void TestClientConfiguration()

EasyPost.Tests/HttpTests/RequestTest.cs

@@ -0,0 +1,21 @@
+using System.Collections.Generic;
+using EasyPost._base;
+using EasyPost.Http;
+using Xunit;
+using CustomAssertions = EasyPost.Tests._Utilities.Assertions.Assert;
+
+namespace EasyPost.Tests.HttpTests;
+
+public class RequestTest
+{
+    #region Tests
+
+    [Fact]
+    public void TestRequestDisposal()
+    {
+        Request request = new("https://google.com", "not_a_real_endpoint", Method.Get, ApiVersion.V2, new Dictionary<string, object> { { "key", "value" } }, new Dictionary<string, string> { { "header_key", "header_value" } });
+        CustomAssertions.DoesNotThrow(() => request.Dispose());
+    }
+
+    #endregion
+}

EasyPost.Tests/ServicesTests/ServiceTest.cs

@@ -5,10 +5,12 @@
 using EasyPost.Exceptions.General;
 using EasyPost.Http;
 using EasyPost.Models.API;
+using EasyPost.Services;
 using EasyPost.Tests._Utilities;
 using EasyPost.Tests._Utilities.Attributes;
 using EasyPost.Utilities.Internal.Attributes;
 using Xunit;
+using CustomAssertions = EasyPost.Tests._Utilities.Assertions.Assert;
 
 namespace EasyPost.Tests.ServicesTests
 {
@@ -21,6 +23,15 @@ public ServiceTests() : base("base_service")
         {
         }
 
+        [Fact]
+        public void TestServiceDisposal()
+        {
+            Client client = new(new ClientConfiguration("not_a_real_api_key"));
+
+            AddressService addressService = client.Address;
+            CustomAssertions.DoesNotThrow(() => addressService.Dispose());
+        }
+
         /// <summary>
         ///     This test confirms that the GetNextPage method works as expected.
         ///     This method is implemented on a per-service, but rather than testing in each service, we'll test it once here.

EasyPost.Tests/_Utilities/Assertions/AnyException.cs

@@ -3,7 +3,7 @@
 namespace EasyPost.Tests._Utilities.Assertions
 {
     /// <summary>
-    /// Exception thrown when an Any assertion has one or more items fail an assertion.
+    ///     Exception thrown when an Any assertion has one or more items fail an assertion.
     /// </summary>
     public class AnyException : XunitException
     {

EasyPost.Tests/_Utilities/Assertions/CollectionAsserts.cs

@@ -6,12 +6,6 @@ namespace EasyPost.Tests._Utilities.Assertions
     // ReSharper disable once PartialTypeWithSinglePart
     public abstract partial class Assert
     {
-        private static void GuardArgumentNotNull(string argName, object argValue)
-        {
-            if (argValue == null)
-                throw new ArgumentNullException(argName);
-        }
-
         /// <summary>
         /// Verifies that any items in the collection pass when executed against
         /// action.

EasyPost.Tests/_Utilities/Assertions/DoesNotThrowAssert.cs

@@ -0,0 +1,50 @@
+using System;
+
+namespace EasyPost.Tests._Utilities.Assertions
+{
+    // ReSharper disable once PartialTypeWithSinglePart
+    public abstract partial class Assert
+    {
+        /// <summary>
+        ///     Verifies that an action does not throw an exception.
+        /// </summary>
+        /// <param name="action">The action to test</param>
+        /// <exception cref="DoesNotThrowException">Thrown when the action throws an exception</exception>
+        public static void DoesNotThrow(Action action)
+        {
+            GuardArgumentNotNull(nameof(action), action);
+
+            try
+            {
+                action();
+            }
+            catch (Exception ex)
+            {
+                throw new DoesNotThrowException(ex);
+            }
+        }
+
+        /// <summary>
+        ///     Verifies that an action does not throw a specific exception.
+        /// </summary>
+        /// <param name="action">The action to test</param>
+        /// <typeparam name="T">The type of the exception to not throw</typeparam>
+        /// <exception cref="DoesNotThrowException">Thrown when the action throws an exception of type T</exception>
+        public static void DoesNotThrow<T>(Action action) where T : Exception
+        {
+            GuardArgumentNotNull(nameof(action), action);
+
+            try
+            {
+                action();
+            }
+            catch (Exception ex)
+            {
+                if (ex.GetType() == typeof(T))
+                {
+                    throw new DoesNotThrowException(ex);
+                }
+            }
+        }
+    }
+}

EasyPost.Tests/_Utilities/Assertions/DoesNotThrowException.cs

@@ -0,0 +1,19 @@
+using System;
+using Xunit.Sdk;
+
+namespace EasyPost.Tests._Utilities.Assertions
+{
+    /// <summary>
+    ///     Exception thrown when a DoesNotThrow assertion fails.
+    /// </summary>
+    public class DoesNotThrowException : XunitException
+    {
+        /// <summary>
+        ///     Creates a new instance of the <see cref="DoesNotThrowException"/> class.
+        /// </summary>
+        public DoesNotThrowException(Exception ex)
+            : base("Assert.DoesNotThrow() Failure", ex)
+        {
+        }
+    }
+}

EasyPost.Tests/_Utilities/Assertions/GuardArgumentNotNull.cs

@@ -0,0 +1,14 @@
+using System;
+
+namespace EasyPost.Tests._Utilities.Assertions
+{
+    // ReSharper disable once PartialTypeWithSinglePart
+    public abstract partial class Assert
+    {
+        private static void GuardArgumentNotNull(string argName, object argValue)
+        {
+            if (argValue == null)
+                throw new ArgumentNullException(argName);
+        }
+    }
+}