Deprecate WithFilter on IHttpRequestMessagesCheck

Author: dnperfors

CHANGELOG.md

@@ -7,6 +7,7 @@ this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 ## [0.12] - unplanned
 ### Deprecated
 - The methods `WithRequestHeader` and `WithContentHeader` are deprecated, please use `WithHeader` instead.
+- The `WithFilter` method is deprecated and will be made internal or be removed. If there is a specific assertion that is missing, please open an issue.
 
 ### Removed
 - .NET 6.0 target, since it is no longer supported

src/TestableHttpClient/IHttpRequestMessagesCheck.cs

@@ -16,6 +16,7 @@ public interface IHttpRequestMessagesCheck
     /// <param name="requestFilter">The filter to filter requests with before asserting.</param>
     /// <param name="condition">The name of the condition, used in the exception message.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+    [Obsolete("WithFilter will be made internal, since it should no longer be necesary to use.")]
     public IHttpRequestMessagesCheck WithFilter(Func<HttpRequestMessage, bool> requestFilter, string condition);
 
     /// <summary>
@@ -25,6 +26,7 @@ public interface IHttpRequestMessagesCheck
     /// <param name="expectedNumberOfRequests">The expected number of requests.</param>
     /// <param name="condition">The name of the condition, used in the exception message.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+    [Obsolete("WithFilter will be made internal, since it should no longer be necesary to use.")]
     public IHttpRequestMessagesCheck WithFilter(Func<HttpRequestMessage, bool> requestFilter, int expectedNumberOfRequests, string condition);
 
     /// <summary>
@@ -34,6 +36,7 @@ public interface IHttpRequestMessagesCheck
     /// <param name="expectedNumberOfRequests">The expected number of requests, when null is passed "at least one" is presumed.</param>
     /// <param name="condition">The name of the condition, used in the exception message.</param>
     /// <returns>The <seealso cref="IHttpRequestMessagesCheck"/> for further assertions.</returns>
+    [Obsolete("WithFilter will be made internal, since it should no longer be necesary to use.")]
     public IHttpRequestMessagesCheck WithFilter(Func<HttpRequestMessage, bool> requestFilter, int? expectedNumberOfRequests, string condition);
 
     /// <summary>

test/TestableHttpClient.IntegrationTests/AssertingRequests.cs

@@ -200,16 +200,4 @@ public async Task AssertJsonContent()
 
         testHandler.ShouldHaveMadeRequests().WithJsonContent(new { });
     }
-
-    [Fact]
-    public async Task CustomAssertions()
-    {
-        using TestableHttpMessageHandler testHandler = new();
-        using HttpClient client = new(testHandler);
-
-        using StringContent content = new("", Encoding.UTF8, "application/json");
-        _ = await client.PostAsync("https://httpbin.org/post", content, TestContext.Current.CancellationToken);
-
-        testHandler.ShouldHaveMadeRequests().WithFilter(x => x.Content is not null && x.Content.Headers.ContentType?.MediaType == "application/json", "");
-    }
 }