Sealed types and reduced dependencies

Author: Bart Koelman

src/JsonApiDotNetCore/Middleware/JsonApiInputFormatter.cs

@@ -22,7 +22,10 @@ public async Task<InputFormatterResult> ReadAsync(InputFormatterContext context)
             ArgumentGuard.NotNull(context, nameof(context));
 
             var reader = context.HttpContext.RequestServices.GetRequiredService<IJsonApiReader>();
-            return await reader.ReadAsync(context.HttpContext.Request);
+
+            object model = await reader.ReadAsync(context.HttpContext.Request);
+
+            return model == null ? await InputFormatterResult.NoValueAsync() : await InputFormatterResult.SuccessAsync(model);
         }
     }
 }

src/JsonApiDotNetCore/Middleware/JsonApiOutputFormatter.cs

@@ -22,7 +22,7 @@ public async Task WriteAsync(OutputFormatterWriteContext context)
             ArgumentGuard.NotNull(context, nameof(context));
 
             var writer = context.HttpContext.RequestServices.GetRequiredService<IJsonApiWriter>();
-            await writer.WriteAsync(context);
+            await writer.WriteAsync(context.Object, context.HttpContext);
         }
     }
 }

src/JsonApiDotNetCore/Serialization/IJsonApiReader.cs

@@ -1,12 +1,11 @@
 using System.Threading.Tasks;
 using JetBrains.Annotations;
 using Microsoft.AspNetCore.Http;
-using Microsoft.AspNetCore.Mvc.Formatters;
 
 namespace JsonApiDotNetCore.Serialization
 {
     /// <summary>
-    /// Deserializes the incoming JSON request body and converts it to models, which are passed to controller actions by ASP.NET Core on `FromBody`
+    /// Deserializes the incoming JSON:API request body and converts it to models, which are passed to controller actions by ASP.NET Core on `FromBody`
     /// parameters.
     /// </summary>
     [PublicAPI]
@@ -15,6 +14,6 @@ public interface IJsonApiReader
         /// <summary>
         /// Reads an object from the request body.
         /// </summary>
-        Task<InputFormatterResult> ReadAsync(HttpRequest httpRequest);
+        Task<object> ReadAsync(HttpRequest httpRequest);
     }
 }

src/JsonApiDotNetCore/Serialization/IJsonApiWriter.cs

@@ -1,15 +1,18 @@
 using System.Threading.Tasks;
 using JetBrains.Annotations;
-using Microsoft.AspNetCore.Mvc.Formatters;
+using Microsoft.AspNetCore.Http;
 
 namespace JsonApiDotNetCore.Serialization
 {
     /// <summary>
-    /// Serializes models into the outgoing JSON response body.
+    /// Serializes ASP.NET models into the outgoing JSON:API response body.
     /// </summary>
     [PublicAPI]
     public interface IJsonApiWriter
     {
-        Task WriteAsync(OutputFormatterWriteContext context);
+        /// <summary>
+        /// Writes an object to the response body.
+        /// </summary>
+        Task WriteAsync(object model, HttpContext httpContext);
     }
 }

src/JsonApiDotNetCore/Serialization/JsonApiReader.cs

@@ -12,14 +12,12 @@
 using JsonApiDotNetCore.Serialization.RequestAdapters;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Http.Extensions;
-using Microsoft.AspNetCore.Mvc.Formatters;
 using Microsoft.Extensions.Logging;
 
 namespace JsonApiDotNetCore.Serialization
 {
     /// <inheritdoc />
-    [PublicAPI]
-    public class JsonApiReader : IJsonApiReader
+    public sealed class JsonApiReader : IJsonApiReader
     {
         private readonly IJsonApiOptions _options;
         private readonly IDocumentAdapter _documentAdapter;
@@ -37,14 +35,12 @@ public JsonApiReader(IJsonApiOptions options, IDocumentAdapter documentAdapter,
         }
 
         /// <inheritdoc />
-        public async Task<InputFormatterResult> ReadAsync(HttpRequest httpRequest)
+        public async Task<object> ReadAsync(HttpRequest httpRequest)
         {
             ArgumentGuard.NotNull(httpRequest, nameof(httpRequest));
 
             string requestBody = await GetRequestBodyAsync(httpRequest);
-            object model = GetModel(requestBody);
-
-            return model == null ? await InputFormatterResult.NoValueAsync() : await InputFormatterResult.SuccessAsync(model);
+            return GetModel(requestBody);
         }
 
         private async Task<string> GetRequestBodyAsync(HttpRequest httpRequest)

src/JsonApiDotNetCore/Serialization/JsonApiWriter.cs

@@ -6,26 +6,21 @@
 using System.Net.Http;
 using System.Text;
 using System.Threading.Tasks;
-using JetBrains.Annotations;
 using JsonApiDotNetCore.Diagnostics;
 using JsonApiDotNetCore.Errors;
 using JsonApiDotNetCore.Middleware;
 using JsonApiDotNetCore.Serialization.Objects;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Http.Extensions;
 using Microsoft.AspNetCore.Mvc;
-using Microsoft.AspNetCore.Mvc.Formatters;
+using Microsoft.AspNetCore.WebUtilities;
 using Microsoft.Extensions.Logging;
 using Microsoft.Net.Http.Headers;
 
 namespace JsonApiDotNetCore.Serialization
 {
-    /// <summary>
-    /// Formats the response data used (see https://docs.microsoft.com/en-us/aspnet/core/web-api/advanced/formatting?view=aspnetcore-3.0). It was intended to
-    /// have as little dependencies as possible in formatting layer for greater extensibility.
-    /// </summary>
-    [PublicAPI]
-    public class JsonApiWriter : IJsonApiWriter
+    /// <inheritdoc />
+    public sealed class JsonApiWriter : IJsonApiWriter
     {
         private readonly IJsonApiSerializer _serializer;
         private readonly IExceptionHandler _exceptionHandler;
@@ -45,21 +40,22 @@ public JsonApiWriter(IJsonApiSerializer serializer, IExceptionHandler exceptionH
             _traceWriter = new TraceLogWriter<JsonApiWriter>(loggerFactory);
         }
 
-        public async Task WriteAsync(OutputFormatterWriteContext context)
+        /// <inheritdoc />
+        public async Task WriteAsync(object model, HttpContext httpContext)
         {
-            ArgumentGuard.NotNull(context, nameof(context));
+            ArgumentGuard.NotNull(httpContext, nameof(httpContext));
 
             using IDisposable _ = CodeTimingSessionManager.Current.Measure("Write response body");
 
-            HttpRequest request = context.HttpContext.Request;
-            HttpResponse response = context.HttpContext.Response;
+            HttpRequest request = httpContext.Request;
+            HttpResponse response = httpContext.Response;
 
-            await using TextWriter writer = context.WriterFactory(response.Body, Encoding.UTF8);
+            await using TextWriter writer = new HttpResponseStreamWriter(response.Body, Encoding.UTF8);
             string responseContent;
 
             try
             {
-                responseContent = SerializeResponse(context.Object, (HttpStatusCode)response.StatusCode);
+                responseContent = SerializeResponse(model, (HttpStatusCode)response.StatusCode);
             }
 #pragma warning disable AV1210 // Catch a specific exception instead of Exception, SystemException or ApplicationException
             catch (Exception exception)

test/TestBuildingBlocks/IntegrationTest.cs

@@ -9,7 +9,7 @@
 namespace TestBuildingBlocks
 {
     /// <summary>
-    /// A base class for tests that conveniently enables to execute HTTP requests against json:api endpoints.
+    /// A base class for tests that conveniently enables to execute HTTP requests against JSON:API endpoints.
     /// </summary>
     public abstract class IntegrationTest
     {