fix: implement negotiation helper and add TestNegotiator attribute

Author: vinhdev17

src/Carter/Attributes/TestNegotiatorAttribute.cs

@@ -0,0 +1,6 @@
+namespace Carter.Attributes;
+
+using System;
+
+[AttributeUsage(AttributeTargets.Class)]
+public class TestNegotiatorAttribute : Attribute { }

src/Carter/Helpers/NegotiationHelper.cs

@@ -0,0 +1,50 @@
+namespace Carter.Helpers;
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Linq.Expressions;
+using Carter.Attributes;
+using Carter.Response;
+using Microsoft.AspNetCore.Http;
+using Microsoft.Net.Http.Headers;
+
+public static class NegotiationHelper
+{
+    /// <summary>
+    /// Selects the most appropriate <see cref="IResponseNegotiator"/> for content negotiation based on the current <see cref="HttpContext"/>'s "Accept" headers, 
+    /// or defaults to <see cref="DefaultJsonResponseNegotiator"/> if none match.
+    /// </summary>
+    /// <param name="httpContext">Current <see cref="HttpContext"/></param>
+    /// <param name="negotiators">List of available <see cref="IResponseNegotiator"/> instances</param>
+    /// <returns>The selected <see cref="IResponseNegotiator"/> for the response.</returns>
+    public static IResponseNegotiator SelectNegotiator(HttpContext httpContext, List<IResponseNegotiator> negotiators)
+    {
+        IResponseNegotiator negotiator = null;
+
+        MediaTypeHeaderValue.TryParseList(httpContext.Request.Headers["Accept"], out var accept);
+        if (accept != null)
+        {
+            var ordered = accept.OrderByDescending(x => x.Quality ?? 1);
+
+            foreach (var acceptHeader in ordered)
+            {
+                negotiator = negotiators.FirstOrDefault(x => x.CanHandle(acceptHeader));
+                if (negotiator != null)
+                {
+                    break;
+                }
+            }
+        }
+
+        if (negotiator == null)
+        {
+            negotiator = negotiators.First(x => x.GetType() == typeof(DefaultJsonResponseNegotiator));
+        }
+
+        return negotiator;
+    }
+    
+    public static bool IsTestNegotiator(IResponseNegotiator negotiator) 
+        => negotiator.GetType().IsDefined(typeof(TestNegotiatorAttribute), inherit: true);
+}

src/Carter/Response/ResponseExtensions.cs

@@ -7,6 +7,7 @@ namespace Carter.Response;
 using System.Net.Mime;
 using System.Threading;
 using System.Threading.Tasks;
+using Carter.Helpers;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Http.Extensions;
 using Microsoft.Extensions.DependencyInjection;
@@ -23,30 +24,14 @@ public static class ResponseExtensions
     /// <returns><see cref="Task"/></returns>
     public static Task Negotiate<T>(this HttpResponse response, T model, CancellationToken cancellationToken = default)
     {
-        var negotiators = response.HttpContext.RequestServices.GetServices<IResponseNegotiator>().ToList();
-        IResponseNegotiator negotiator = null;
-
-        MediaTypeHeaderValue.TryParseList(response.HttpContext.Request.Headers["Accept"], out var accept);
-        if (accept != null)
-        {
-            var ordered = accept.OrderByDescending(x => x.Quality ?? 1);
-
-            foreach (var acceptHeader in ordered)
-            {
-                negotiator = negotiators.FirstOrDefault(x => x.CanHandle(acceptHeader));
-                if (negotiator != null)
-                {
-                    break;
-                }
-            }
-        }
-
-        if (negotiator == null)
-        {
-            negotiator = negotiators.First(x => x.CanHandle(new MediaTypeHeaderValue("application/json")));
-        }
-
-        return negotiator.Handle(response.HttpContext.Request, response, model, cancellationToken);
+        var negotiators = response.HttpContext.RequestServices
+            .GetServices<IResponseNegotiator>()
+            .Where(n => !NegotiationHelper.IsTestNegotiator(n))
+            .ToList();
+        
+        var chosenNegotiator = NegotiationHelper.SelectNegotiator(response.HttpContext, negotiators);
+
+        return chosenNegotiator.Handle(response.HttpContext.Request, response, model, cancellationToken);
     }
 
     /// <summary>
@@ -58,7 +43,10 @@ public static Task Negotiate<T>(this HttpResponse response, T model, Cancellatio
     /// <returns><see cref="Task"/></returns>
     public static Task AsJson<T>(this HttpResponse response, T model, CancellationToken cancellationToken = default)
     {
-        var negotiators = response.HttpContext.RequestServices.GetServices<IResponseNegotiator>();
+        var negotiators = response.HttpContext.RequestServices
+            .GetServices<IResponseNegotiator>()
+            .Where(n => !NegotiationHelper.IsTestNegotiator(n))
+            .ToList();
 
         var negotiator = negotiators.First(x => x.CanHandle(new MediaTypeHeaderValue("application/json")));
 

test/Carter.ResponseNegotiators.Newtonsoft.Tests/NewtonsoftJsonResponseNegotiatorTests.cs

@@ -89,6 +89,7 @@ public async Task Should_pick_default_json_processor_last()
         }
     }
 
+    //TODO: Add [TestNegotiator] attribute when Carter supports it in this project
     internal class TestJsonResponseNegotiator : IResponseNegotiator
     {
         public bool CanHandle(MediaTypeHeaderValue accept) => accept

test/Carter.Tests/ContentNegotiation/NegotiatorModule.cs

@@ -1,6 +1,5 @@
 namespace Carter.Tests.ContentNegotiation
 {
-    using Carter.Response;
     using Microsoft.AspNetCore.Builder;
     using Microsoft.AspNetCore.Http;
     using Microsoft.AspNetCore.Routing;

test/Carter.Tests/ContentNegotiation/ResponseNegotiatorTests.cs

@@ -5,6 +5,7 @@ namespace Carter.Tests.ContentNegotiation
     using System.Net.Http.Headers;
     using System.Threading;
     using System.Threading.Tasks;
+    using Carter.Attributes;
     using Microsoft.AspNetCore.Builder;
     using Microsoft.AspNetCore.Hosting;
     using Microsoft.AspNetCore.Http;
@@ -125,6 +126,7 @@ public async Task Should_pick_default_json_processor_last()
         }
     }
 
+    [TestNegotiator]
     internal class TestResponseNegotiator : IResponseNegotiator
     {
         public bool CanHandle(MediaTypeHeaderValue accept) =>
@@ -137,6 +139,7 @@ public async Task Handle<T>(HttpRequest req, HttpResponse res, T model,
         }
     }
 
+    [TestNegotiator]
     internal class TestHtmlResponseNegotiator : IResponseNegotiator
     {
         public bool CanHandle(MediaTypeHeaderValue accept) =>
@@ -149,6 +152,7 @@ public async Task Handle<T>(HttpRequest req, HttpResponse res, T model,
         }
     }
 
+    [TestNegotiator]
     internal class TestXmlResponseNegotiator : IResponseNegotiator
     {
         public bool CanHandle(MediaTypeHeaderValue accept) =>
@@ -161,6 +165,7 @@ public async Task Handle<T>(HttpRequest req, HttpResponse res, T model,
         }
     }
 
+    [TestNegotiator]
     internal class TestJsonResponseNegotiator : IResponseNegotiator
     {
         public bool CanHandle(MediaTypeHeaderValue accept) => accept

test/Carter.Tests/ContentNegotiation/TestResponseExtensions.cs

@@ -0,0 +1,22 @@
+namespace Carter.Tests.ContentNegotiation;
+
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using Carter.Helpers;
+using Microsoft.AspNetCore.Http;
+using Microsoft.Extensions.DependencyInjection;
+
+public static class TestResponseExtensions
+{
+    public static Task Negotiate<T>(this HttpResponse response, T model, CancellationToken cancellationToken = default)
+    {
+        var negotiators = response.HttpContext.RequestServices
+            .GetServices<IResponseNegotiator>()
+            .ToList();
+        
+        var chosenNegotiator = NegotiationHelper.SelectNegotiator(response.HttpContext, negotiators);
+
+        return chosenNegotiator.Handle(response.HttpContext.Request, response, model, cancellationToken);
+    }
+}

test/Carter.Tests/InternalRooms/InternalResponseNegotiator.cs

@@ -2,9 +2,11 @@ namespace Carter.Tests.InternalRooms;
 
 using System.Threading;
 using System.Threading.Tasks;
+using Carter.Attributes;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Net.Http.Headers;
 
+[TestNegotiator]
 internal class InternalResponseNegotiator: IResponseNegotiator
 {
     public bool CanHandle(MediaTypeHeaderValue accept)

test/Carter.Tests/InternalRooms/NestedInternalResponseNegotiator.cs

@@ -2,11 +2,13 @@ namespace Carter.Tests.InternalRooms;
 
 using System.Threading;
 using System.Threading.Tasks;
+using Carter.Attributes;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Net.Http.Headers;
 
 internal static class NestedInternalResponseNegotiatorWrapper
 {
+    [TestNegotiator]
     internal class NestedInternalResponseNegotiator: IResponseNegotiator
     {
         public bool CanHandle(MediaTypeHeaderValue accept)