Dev (#9)

* - update modresults deps to latest
- update readme for ModEndpoints.Core package

* - add support to use different serializers from default service channel implementation

* - decouple ServiceChannel from System.Text.Json

* - bugfix: ServiceChannelSerializer not utilizing null DeserializationOptions

* - make created http request message in service channel customizable via action input parameter
- remove redundant input parameters

* - cleanup code

* - make http request customization delegate awaitable/async with additional cancellation token input

* - default service channel implementation now sends http request with ContentsRead option
- service channel send methods now accept an additional func parameter to process http response message received from remote endpoint and executes that function before deserialization starts
- rename various classes

* - code cleanup

* - update deps to latest
- bump version

Author: modabas

Directory.Build.props

@@ -18,6 +18,6 @@
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
 
-    <Version>0.5.2</Version>
+    <Version>0.6.0</Version>
   </PropertyGroup>
 </Project>

samples/Client/Client.csproj

@@ -6,8 +6,8 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Extensions.Hosting" Version="9.0.1" />
-    <PackageReference Include="Microsoft.Extensions.Http.Polly" Version="9.0.1" />
+    <PackageReference Include="Microsoft.Extensions.Hosting" Version="9.0.2" />
+    <PackageReference Include="Microsoft.Extensions.Http.Polly" Version="9.0.2" />
   </ItemGroup>
 
   <ItemGroup>

src/ModEndpoints.Core/ModEndpoints.Core.csproj

@@ -22,7 +22,7 @@
 
   <ItemGroup>
     <PackageReference Include="FluentValidation" Version="11.11.0" />
-    <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.1" />
+    <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.2" />
   </ItemGroup>
 
   <ItemGroup>

src/ModEndpoints.Core/assets/README.md

@@ -1,5 +1,15 @@
 # ModEndpoints.Core
 
-MinimalEndpoints is the barebone implementation for organizing ASP.NET Core Minimal Apis in REPR format endpoints. Does not come integrated with a result pattern like endpoints in ModEndpoints project.
+[MinimalEndpoints](#minimalendpoint) are the barebone implementation for organizing ASP.NET Core Minimal Apis in REPR format endpoints. They have built-in input validation and their handler methods may return Minimal Api IResult based, string or T (any other type) response.
 
 Also contains core classes for ModEndpoints project.
+
+## Key Features
+
+ - Organizes ASP.NET Core Minimal Apis in REPR pattern endpoints
+ - Encapsulates endpoint behaviors like request validation and request handling.
+ - Supports anything that Minimal Apis does. Configuration, parameter binding, authentication, Open Api tooling, filters, etc. are all Minimal Apis under the hood.
+ - Supports auto discovery and registration.
+ - Has built-in validation support with [FluentValidation](https://github.com/FluentValidation/FluentValidation). If a validator is registered for request model, request is automatically validated before being handled.
+ - Supports constructor dependency injection in endpoint implementations.
+ 

src/ModEndpoints.RemoteServices/ServiceChannel.cs renamed to src/ModEndpoints.RemoteServices/DefaultServiceChannel.cs

@@ -1,13 +1,10 @@
-using System.Net.Http.Headers;
-using System.Net.Http.Json;
-using System.Text.Json;
-using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.DependencyInjection;
 using ModEndpoints.RemoteServices.Core;
 using ModResults;
 
 namespace ModEndpoints.RemoteServices;
 
-public class ServiceChannel(
+public class DefaultServiceChannel(
   IHttpClientFactory clientFactory,
   IServiceProvider serviceProvider)
   : IServiceChannel
@@ -18,10 +15,10 @@ public async Task<Result<TResponse>> SendAsync<TRequest, TResponse>(
     TRequest req,
     CancellationToken ct,
     string? endpointUriPrefix = null,
-    MediaTypeHeaderValue? mediaType = null,
-    JsonSerializerOptions? jsonSerializerOptions = null,
-    Action<HttpRequestHeaders>? configureRequestHeaders = null,
-    string? uriResolverName = null)
+    Func<IServiceProvider, HttpRequestMessage, CancellationToken, Task>? processHttpRequest = null,
+    Func<IServiceProvider, HttpResponseMessage, CancellationToken, Task>? processHttpResponse = null,
+    string? uriResolverName = null,
+    string? serializerName = null)
     where TRequest : IServiceRequest<TResponse>
     where TResponse : notnull
   {
@@ -31,6 +28,8 @@ public async Task<Result<TResponse>> SendAsync<TRequest, TResponse>(
       {
         var uriResolver = scope.ServiceProvider.GetRequiredKeyedService<IServiceEndpointUriResolver>(
           uriResolverName ?? ServiceEndpointDefinitions.DefaultUriResolverName);
+        var serializer = scope.ServiceProvider.GetRequiredKeyedService<IServiceChannelSerializer>(
+          serializerName ?? ServiceEndpointDefinitions.DefaultSerializerName);
         var requestUriResult = uriResolver.Resolve(req);
         if (requestUriResult.IsFailed)
         {
@@ -42,14 +41,21 @@ public async Task<Result<TResponse>> SendAsync<TRequest, TResponse>(
         }
         using (HttpRequestMessage httpReq = new(
           HttpMethod.Post,
-          ServiceChannel.Combine(endpointUriPrefix, requestUriResult.Value)))
+          Combine(endpointUriPrefix, requestUriResult.Value)))
         {
-          httpReq.Content = JsonContent.Create(req, mediaType, jsonSerializerOptions);
-          configureRequestHeaders?.Invoke(httpReq.Headers);
+          httpReq.Content = await serializer.CreateContentAsync(req, ct);
+          if (processHttpRequest is not null)
+          {
+            await processHttpRequest(scope.ServiceProvider, httpReq, ct);
+          }
           var client = clientFactory.CreateClient(clientName);
-          using (var httpResponse = await client.SendAsync(httpReq, HttpCompletionOption.ResponseHeadersRead, ct))
+          using (var httpResponse = await client.SendAsync(httpReq, ct))
           {
-            return await httpResponse.DeserializeResultAsync<TResponse>(ct);
+            if (processHttpResponse is not null)
+            {
+              await processHttpResponse(scope.ServiceProvider, httpResponse, ct);
+            }
+            return await serializer.DeserializeResultAsync<TResponse>(httpResponse, ct);
           }
         }
       }
@@ -64,10 +70,10 @@ public async Task<Result> SendAsync<TRequest>(
     TRequest req,
     CancellationToken ct,
     string? endpointUriPrefix = null,
-    MediaTypeHeaderValue? mediaType = null,
-    JsonSerializerOptions? jsonSerializerOptions = null,
-    Action<HttpRequestHeaders>? configureRequestHeaders = null,
-    string? uriResolverName = null)
+    Func<IServiceProvider, HttpRequestMessage, CancellationToken, Task>? processHttpRequest = null,
+    Func<IServiceProvider, HttpResponseMessage, CancellationToken, Task>? processHttpResponse = null,
+    string? uriResolverName = null,
+    string? serializerName = null)
     where TRequest : IServiceRequest
   {
     try
@@ -76,6 +82,8 @@ public async Task<Result> SendAsync<TRequest>(
       {
         var uriResolver = scope.ServiceProvider.GetRequiredKeyedService<IServiceEndpointUriResolver>(
           uriResolverName ?? ServiceEndpointDefinitions.DefaultUriResolverName);
+        var serializer = scope.ServiceProvider.GetRequiredKeyedService<IServiceChannelSerializer>(
+          serializerName ?? ServiceEndpointDefinitions.DefaultSerializerName);
         var requestUriResult = uriResolver.Resolve(req);
         if (requestUriResult.IsFailed)
         {
@@ -87,14 +95,21 @@ public async Task<Result> SendAsync<TRequest>(
         }
         using (HttpRequestMessage httpReq = new(
           HttpMethod.Post,
-          ServiceChannel.Combine(endpointUriPrefix, requestUriResult.Value)))
+          Combine(endpointUriPrefix, requestUriResult.Value)))
         {
-          httpReq.Content = JsonContent.Create(req, mediaType, jsonSerializerOptions);
-          configureRequestHeaders?.Invoke(httpReq.Headers);
+          httpReq.Content = await serializer.CreateContentAsync(req, ct);
+          if (processHttpRequest is not null)
+          {
+            await processHttpRequest(scope.ServiceProvider, httpReq, ct);
+          }
           var client = clientFactory.CreateClient(clientName);
-          using (var httpResponse = await client.SendAsync(httpReq, HttpCompletionOption.ResponseHeadersRead, ct))
+          using (var httpResponse = await client.SendAsync(httpReq, ct))
           {
-            return await httpResponse.DeserializeResultAsync(ct);
+            if (processHttpResponse is not null)
+            {
+              await processHttpResponse(scope.ServiceProvider, httpResponse, ct);
+            }
+            return await serializer.DeserializeResultAsync(httpResponse, ct);
           }
         }
       }

src/ModEndpoints.RemoteServices/HttpResponseMessageExtensions.cs renamed to src/ModEndpoints.RemoteServices/DefaultServiceChannelSerializer.cs

@@ -1,18 +1,14 @@
-using System.Text.Json;
-using System.Text.Json.Serialization;
+using System.Net.Http.Json;
+using System.Text.Json;
+using ModEndpoints.RemoteServices.Core;
 using ModResults;
 
 namespace ModEndpoints.RemoteServices;
 
-public static class HttpResponseMessageExtensions
+public class DefaultServiceChannelSerializer(
+  ServiceChannelSerializerOptions options)
+  : IServiceChannelSerializer
 {
-  private static readonly JsonSerializerOptions _defaultJsonSerializerOptions = new()
-  {
-    PropertyNameCaseInsensitive = true,
-    PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
-    NumberHandling = JsonNumberHandling.AllowReadingFromString
-  };
-
   private const string DeserializationErrorMessage =
     "Cannot deserialize Result object from http response message.";
 
@@ -25,15 +21,26 @@ public static class HttpResponseMessageExtensions
   private const string InstanceFactMessage =
     "Instance: {0} {1}";
 
-  public static async Task<Result<T>> DeserializeResultAsync<T>(
-    this HttpResponseMessage response,
-    CancellationToken ct,
-    JsonSerializerOptions? jsonSerializerOptions = null)
-    where T : notnull
+  public ValueTask<HttpContent> CreateContentAsync<TRequest>(
+    TRequest request,
+    CancellationToken ct)
+    where TRequest : IServiceRequestMarker
+  {
+    return new ValueTask<HttpContent>(
+      JsonContent.Create(
+        request,
+        null,
+        options.SerializationOptions));
+  }
+
+  public async Task<Result<TResponse>> DeserializeResultAsync<TResponse>(
+    HttpResponseMessage response,
+    CancellationToken ct)
+    where TResponse : notnull
   {
     if (!response.IsSuccessStatusCode)
     {
-      return Result<T>
+      return Result<TResponse>
         .CriticalError(string.Format(
           string.IsNullOrWhiteSpace(response.ReasonPhrase) ? ResponseNotSuccessfulErrorMessage : ResponseNotSuccessfulWithReasonErrorMessage,
           (int)response.StatusCode,
@@ -43,19 +50,18 @@ public static async Task<Result<T>> DeserializeResultAsync<T>(
           response.RequestMessage?.Method,
           response.RequestMessage?.RequestUri));
     }
-    var resultObject = await response.DeserializeResultInternalAsync<Result<T>>(jsonSerializerOptions, ct);
-    return resultObject ?? Result<T>
+    var resultObject = await DeserializeResultInternalAsync<Result<TResponse>>(response, ct);
+    return resultObject ?? Result<TResponse>
       .CriticalError(DeserializationErrorMessage)
       .WithFact(string.Format(
         InstanceFactMessage,
         response.RequestMessage?.Method,
         response.RequestMessage?.RequestUri));
   }
 
-  public static async Task<Result> DeserializeResultAsync(
-    this HttpResponseMessage response,
-    CancellationToken ct,
-    JsonSerializerOptions? jsonSerializerOptions = null)
+  public async Task<Result> DeserializeResultAsync(
+    HttpResponseMessage response,
+    CancellationToken ct)
   {
     if (!response.IsSuccessStatusCode)
     {
@@ -69,7 +75,7 @@ public static async Task<Result> DeserializeResultAsync(
           response.RequestMessage?.Method,
           response.RequestMessage?.RequestUri));
     }
-    var resultObject = await response.DeserializeResultInternalAsync<Result>(jsonSerializerOptions, ct);
+    var resultObject = await DeserializeResultInternalAsync<Result>(response, ct);
     return resultObject ?? Result
       .CriticalError(DeserializationErrorMessage)
       .WithFact(string.Format(
@@ -78,9 +84,8 @@ public static async Task<Result> DeserializeResultAsync(
         response.RequestMessage?.RequestUri));
   }
 
-  private static async Task<TResult?> DeserializeResultInternalAsync<TResult>(
-    this HttpResponseMessage response,
-    JsonSerializerOptions? jsonSerializerOptions,
+  private async Task<TResult?> DeserializeResultInternalAsync<TResult>(
+    HttpResponseMessage response,
     CancellationToken ct)
     where TResult : IModResult
   {
@@ -91,7 +96,7 @@ public static async Task<Result> DeserializeResultAsync(
       ct.ThrowIfCancellationRequested();
       return await JsonSerializer.DeserializeAsync<TResult>(
         contentStream,
-        jsonSerializerOptions ?? _defaultJsonSerializerOptions,
+        options.DeserializationOptions,
         ct);
     }
   }

src/ModEndpoints.RemoteServices/ServiceEndpointUriResolver.cs renamed to src/ModEndpoints.RemoteServices/DefaultServiceEndpointUriResolver.cs

@@ -2,7 +2,7 @@
 using ModResults;
 
 namespace ModEndpoints.RemoteServices;
-public class ServiceEndpointUriResolver : IServiceEndpointUriResolver
+public class DefaultServiceEndpointUriResolver : IServiceEndpointUriResolver
 {
   private const string CannotResolveServiceEndpointUri = "Cannot resolve request uri for service endpoint.";
   public Result<string> Resolve(IServiceRequestMarker req)

src/ModEndpoints.RemoteServices/DependencyInjectionExtensions.cs

@@ -27,7 +27,7 @@ public static IServiceCollection AddRemoteServiceWithNewClient<TRequest>(
     Action<IHttpClientBuilder>? configureClientBuilder = null)
     where TRequest : IServiceRequestMarker
   {
-    var clientName = DefaultClientName.Resolve<TRequest>();
+    var clientName = ServiceClientNameResolver.GetDefaultName<TRequest>();
     return services.AddRemoteServiceWithNewClient<TRequest>(
       clientName,
       baseAddress,
@@ -81,7 +81,7 @@ public static IServiceCollection AddRemoteServiceWithNewClient<TRequest>(
     Action<IHttpClientBuilder>? configureClientBuilder = null)
     where TRequest : IServiceRequestMarker
   {
-    var clientName = DefaultClientName.Resolve<TRequest>();
+    var clientName = ServiceClientNameResolver.GetDefaultName<TRequest>();
     return services.AddRemoteServiceWithNewClient<TRequest>(
       clientName,
       configureClient,
@@ -277,9 +277,19 @@ private static IServiceCollection AddClientInternal(
   private static IServiceCollection AddRemoteServicesCore(
     this IServiceCollection services)
   {
-    services.TryAddKeyedSingleton<IServiceEndpointUriResolver, ServiceEndpointUriResolver>(
+    services.TryAddKeyedSingleton<IServiceEndpointUriResolver, DefaultServiceEndpointUriResolver>(
       ServiceEndpointDefinitions.DefaultUriResolverName);
-    services.TryAddTransient<IServiceChannel, ServiceChannel>();
+    services.AddKeyedTransient<IServiceChannelSerializer, DefaultServiceChannelSerializer>(
+      ServiceEndpointDefinitions.DefaultSerializerName,
+      (_, _) =>
+      {
+        return new DefaultServiceChannelSerializer(new ServiceChannelSerializerOptions()
+        {
+          SerializationOptions = null,
+          DeserializationOptions = ServiceEndpointDefinitions.DefaultJsonDeserializationOptions
+        });
+      });
+    services.TryAddTransient<IServiceChannel, DefaultServiceChannel>();
     return services;
   }
 

src/ModEndpoints.RemoteServices/IServiceChannel.cs

@@ -1,6 +1,4 @@
-using System.Net.Http.Headers;
-using System.Text.Json;
-using ModEndpoints.RemoteServices.Core;
+using ModEndpoints.RemoteServices.Core;
 using ModResults;
 
 namespace ModEndpoints.RemoteServices;
@@ -18,19 +16,19 @@ public interface IServiceChannel
   /// <param name="req">Request to be sent.</param>
   /// <param name="ct">The <see cref="CancellationToken"/> to cancel operation.</param>
   /// <param name="endpointUriPrefix">Path to append as prefix to resolved enpoint uri. Usually used to add path segments to configured client's base address.</param>
-  /// <param name="mediaType">The media type to use for the content.</param>
-  /// <param name="jsonSerializerOptions">Options to control the behavior during serialization.</param>
-  /// <param name="configureRequestHeaders">Delegate to configure HTTP request headers.</param>
+  /// <param name="processHttpRequest">Delegate to further configure created HTTP request message (headers, etc) before sending to ServiceEndpoint.</param>
+  /// <param name="processHttpResponse">Delegate to process received HTTP response message of ServiceEndpoint before deserialization.</param>
   /// <param name="uriResolverName"><see cref="IServiceEndpointUriResolver"/> name to be used to resolve ServiceEnpoint Uri.</param>
+  /// <param name="serializerName"><see cref="IServiceChannelSerializer"/> name to be used to resolve ServiceEnpoint Uri.</param>
   /// <returns>Response of remote service endpoint or failure result.</returns>
   Task<Result<TResponse>> SendAsync<TRequest, TResponse>(
     TRequest req,
     CancellationToken ct,
     string? endpointUriPrefix = null,
-    MediaTypeHeaderValue? mediaType = null,
-    JsonSerializerOptions? jsonSerializerOptions = null,
-    Action<HttpRequestHeaders>? configureRequestHeaders = null,
-    string? uriResolverName = null)
+    Func<IServiceProvider, HttpRequestMessage, CancellationToken, Task>? processHttpRequest = null,
+    Func<IServiceProvider, HttpResponseMessage, CancellationToken, Task>? processHttpResponse = null,
+    string? uriResolverName = null,
+    string? serializerName = null)
     where TRequest : IServiceRequest<TResponse>
     where TResponse : notnull;
 
@@ -41,18 +39,18 @@ Task<Result<TResponse>> SendAsync<TRequest, TResponse>(
   /// <param name="req">Request to be sent.</param>
   /// <param name="ct">The <see cref="CancellationToken"/> to cancel operation.</param>
   /// <param name="endpointUriPrefix">Path to append as prefix to resolved enpoint uri. Usually used to add path segments to configured client's base address.</param>
-  /// <param name="mediaType">The media type to use for the content.</param>
-  /// <param name="jsonSerializerOptions">Options to control the behavior during serialization.</param>
-  /// <param name="configureRequestHeaders">Delegate to configure HTTP request headers.</param>
+  /// <param name="processHttpRequest">Delegate to further configure created HTTP request message (headers, etc) before sending to ServiceEndpoint.</param>
+  /// <param name="processHttpResponse">Delegate to process received HTTP response message of ServiceEndpoint before deserialization.</param>
   /// <param name="uriResolverName"><see cref="IServiceEndpointUriResolver"/> name to be used to resolve ServiceEnpoint Uri.</param>
+  /// <param name="serializerName"><see cref="IServiceChannelSerializer"/> name to be used to resolve ServiceEnpoint Uri.</param>
   /// <returns>Response of remote service endpoint or failure result.</returns>
   Task<Result> SendAsync<TRequest>(
     TRequest req,
     CancellationToken ct,
     string? endpointUriPrefix = null,
-    MediaTypeHeaderValue? mediaType = null,
-    JsonSerializerOptions? jsonSerializerOptions = null,
-    Action<HttpRequestHeaders>? configureRequestHeaders = null,
-    string? uriResolverName = null)
+    Func<IServiceProvider, HttpRequestMessage, CancellationToken, Task>? processHttpRequest = null,
+    Func<IServiceProvider, HttpResponseMessage, CancellationToken, Task>? processHttpResponse = null,
+    string? uriResolverName = null,
+    string? serializerName = null)
     where TRequest : IServiceRequest;
 }