Clone HttpRequestMessage so the copy is asserted and the original request can be disposed properly

Author: dnperfors

CHANGELOG.md

@@ -10,7 +10,9 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 - .NET Framework 4.6.2, 4.7.0 and 4.7.2, since these can't be tested using xUnit v3
 ### Added
 - Support for .NET 9.0
-- support for .NET 10.0
+- Support for .NET 10.0
+### Changed
+- The TestableHttpMessageHandler now makes a clone of the original request, so that the original request can be disposed.
 
 ## [0.11] - 2024-06-15
 ### Removed

src/TestableHttpClient/PublicAPI.Unshipped.txt

@@ -1 +1 @@
-
+override TestableHttpClient.TestableHttpMessageHandler.Dispose(bool disposing) -> void

src/TestableHttpClient/TestableHttpMessageHandler.cs

@@ -17,9 +17,20 @@ public class TestableHttpMessageHandler : HttpMessageHandler
     /// </summary>
     public IEnumerable<HttpRequestMessage> Requests => httpRequestMessages;
 
+    protected override void Dispose(bool disposing)
+    {
+        DisposeRequestMessages();
+        base.Dispose(disposing);
+    }
+
+    [System.Diagnostics.CodeAnalysis.SuppressMessage("Reliability", "CA2000:Dispose objects before losing scope", Justification = "It gets disposed in the dispose method")]
     protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
     {
-        httpRequestMessages.Enqueue(request);
+#if NET8_0_OR_GREATER
+        ArgumentNullException.ThrowIfNull(request);
+#endif
+
+        httpRequestMessages.Enqueue(await HttpRequestMessageCloner.ClonaAsync(request, cancellationToken).ConfigureAwait(false));
 
         HttpResponseMessage responseMessage = new();
         HttpResponseContext context = new(request, httpRequestMessages, responseMessage, Options);
@@ -55,6 +66,15 @@ public void RespondWith(IResponse response)
     /// <remarks>The configuration itself (Options and the configured IResponse) will not be cleared or reset.</remarks>
     public void ClearRequests()
     {
+        DisposeRequestMessages();
         httpRequestMessages.Clear();
     }
+
+    private void DisposeRequestMessages()
+    {
+        foreach (HttpRequestMessage request in httpRequestMessages)
+        {
+            request.Dispose();
+        }
+    }
 }

src/TestableHttpClient/Utils/HttpRequestMessageCloner.cs

@@ -0,0 +1,38 @@
+using System.Diagnostics.CodeAnalysis;
+
+namespace TestableHttpClient.Utils;
+
+internal static class HttpRequestMessageCloner
+{
+    internal static async Task<HttpRequestMessage> ClonaAsync(HttpRequestMessage request, CancellationToken cancellationToken)
+    {
+        HttpRequestMessage clone = new()
+        {
+            Method = request.Method,
+            RequestUri = request.RequestUri,
+            Version = request.Version,
+        };
+
+        foreach (var item in request.Headers)
+        {
+            clone.Headers.TryAddWithoutValidation(item.Key, item.Value);
+        }
+
+        // Copy content (buffered)
+        if (request.Content is not null)
+        {
+            var bytes = await request.Content.ReadAsByteArrayAsync().ConfigureAwait(false);
+            var contentClone = new ByteArrayContent(bytes);
+
+            // copy content headers
+            foreach (var header in request.Content.Headers)
+            {
+                contentClone.Headers.TryAddWithoutValidation(header.Key, header.Value);
+            }
+
+            clone.Content = contentClone;
+        }
+
+        return clone;
+    }
+}

test/TestableHttpClient.IntegrationTests/AssertingRequests.cs

@@ -162,6 +162,30 @@ public async Task AssertingContent()
         using StringContent content = new("my special content");
         _ = await client.PostAsync("https://httpbin.org/post", content, TestContext.Current.CancellationToken);
 
+#if NETFRAMEWORK
+        // On .NET Framework the HttpClient disposes the content automatically. So we can't perform the same test.
+        testHandler.ShouldHaveMadeRequests();
+#else
+        testHandler.ShouldHaveMadeRequests().WithContent("my special content");
+        testHandler.ShouldHaveMadeRequests().WithContent("my*content");
+        testHandler.ShouldHaveMadeRequests().WithContent("*");
+
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithContent(""));
+        Assert.Throws<HttpRequestMessageAssertionException>(() => testHandler.ShouldHaveMadeRequests().WithContent("my"));
+#endif
+    }
+
+    [Fact]
+    public async Task AssertingContent_WhenOriginalContentIsDisposed()
+    {
+        using TestableHttpMessageHandler testHandler = new();
+        using HttpClient client = new(testHandler);
+
+        using (StringContent content = new("my special content"))
+        {
+            _ = await client.PostAsync("https://httpbin.org/post", content, TestContext.Current.CancellationToken);
+        }
+
 #if NETFRAMEWORK
         // On .NET Framework the HttpClient disposes the content automatically. So we can't perform the same test.
         testHandler.ShouldHaveMadeRequests();

test/TestableHttpClient.Tests/TestableHttpMessageHandlerTests.cs

@@ -16,7 +16,7 @@ public async Task SendAsync_WhenRequestsAreMade_LogsRequests()
 
         _ = await client.SendAsync(request, TestContext.Current.CancellationToken);
 
-        Assert.Contains(request, sut.Requests);
+        Assert.Contains(request, sut.Requests, new SimpleHttpRequestMessageComparer());
     }
 
     [Fact]
@@ -34,7 +34,7 @@ public async Task SendAsync_WhenMultipleRequestsAreMade_AllRequestsAreLogged()
         _ = await client.SendAsync(request3, TestContext.Current.CancellationToken);
         _ = await client.SendAsync(request4, TestContext.Current.CancellationToken);
 
-        Assert.Equal([request1, request2, request3, request4], sut.Requests);
+        Assert.Equal([request1, request2, request3, request4], sut.Requests, new SimpleHttpRequestMessageComparer());
     }
 
     [Fact]
@@ -210,4 +210,24 @@ public void Dispose()
             GC.SuppressFinalize(this);
         }
     }
+
+    private sealed class SimpleHttpRequestMessageComparer : IEqualityComparer<HttpRequestMessage>
+    {
+        public bool Equals(HttpRequestMessage? x, HttpRequestMessage? y)
+        {
+            if (x is null && y is null)
+            {
+                return true;
+            }
+
+            if (x is null || y is null)
+            {
+                return false;
+            }
+
+            return x.Method == y.Method && x.RequestUri == y.RequestUri && x.Version == y.Version;
+        }
+
+        public int GetHashCode([DisallowNull] HttpRequestMessage obj) => HashCode.Combine(obj.Method, obj.RequestUri, obj.Version);
+    }
 }