Refactor and update nullability and configurations

Refactored multiple methods for better readability and updated several methods to return nullable types. Added XML documentation to `IFabioHttpClient` and updated `README_NUGET.md` to reflect new load balancing focus. Introduced new `BindRequestFromRoute` property in `WebApiOptions`. Removed outdated configurations from `appsettings.development.json` and added new `webApi` section to `appsettings.json`.

Refactor methods and update configurations

Refactored multiple methods for better readability and null safety. Updated `CreateConsulAgentRegistration`, `GetServiceAgentsAsync`, and `DeserializeJsonFromStream` to return nullable types. Refactored `HttpResult` class to use a primary constructor. Added XML documentation to `IFabioHttpClient`. Updated `README_NUGET.md` to reflect new package focus. Added `BindRequestFromRoute` property to `WebApiOptions`. Improved null handling in `ReadJsonAsync`. Removed `prometheus` and `vault` configurations and the empty `appsettings.Development.json`. Added `webApi` section to `appsettings.json`.

Author: giovanninocco

src/Genocs.Discovery.Consul/Extensions.cs

@@ -80,7 +80,7 @@ public static void AddConsulHttpClient(this IGenocsBuilder builder, string clien
                 c.GetRequiredService<IConsulServicesRegistry>(),
                 c.GetRequiredService<ConsulOptions>(), serviceName, true));
 
-    private static ServiceRegistration CreateConsulAgentRegistration(this IGenocsBuilder builder, ConsulOptions options)
+    private static ServiceRegistration? CreateConsulAgentRegistration(this IGenocsBuilder builder, ConsulOptions options)
     {
         bool enabled = options.Enabled;
         string? consulEnabled = Environment.GetEnvironmentVariable("CONSUL_ENABLED")?.ToLowerInvariant();

src/Genocs.Discovery.Consul/IConsulService.cs

@@ -6,5 +6,5 @@ public interface IConsulService
 {
     Task<HttpResponseMessage> RegisterServiceAsync(ServiceRegistration registration);
     Task<HttpResponseMessage> DeregisterServiceAsync(string id);
-    Task<IDictionary<string, ServiceAgent>> GetServiceAgentsAsync(string? service = null);
+    Task<IDictionary<string, ServiceAgent>?> GetServiceAgentsAsync(string? service = null);
 }

src/Genocs.Discovery.Consul/Services/ConsulService.cs

@@ -21,7 +21,7 @@ public Task<HttpResponseMessage> RegisterServiceAsync(ServiceRegistration regist
     public Task<HttpResponseMessage> DeregisterServiceAsync(string id)
         => _client.PutAsync(GetEndpoint($"agent/service/deregister/{id}"), EmptyRequest);
 
-    public async Task<IDictionary<string, ServiceAgent>> GetServiceAgentsAsync(string? service = null)
+    public async Task<IDictionary<string, ServiceAgent>?> GetServiceAgentsAsync(string? service = null)
     {
         string filter = string.IsNullOrWhiteSpace(service) ? string.Empty : $"?filter=Service==\"{service}\"";
         var response = await _client.GetAsync(GetEndpoint($"agent/services{filter}"));
@@ -38,5 +38,6 @@ public async Task<IDictionary<string, ServiceAgent>> GetServiceAgentsAsync(strin
     private static StringContent GetPayload(object request)
         => new(JsonSerializer.Serialize(request), Encoding.UTF8, "application/json");
 
-    private static string GetEndpoint(string endpoint) => $"{Version}/{endpoint}";
+    private static string GetEndpoint(string endpoint)
+        => $"{Version}/{endpoint}";
 }

src/Genocs.HTTP/GenocsHttpClient.cs

@@ -170,7 +170,8 @@ public void SetHeaders(IDictionary<string, string> headers)
         }
     }
 
-    public void SetHeaders(Action<HttpRequestHeaders> headers) => headers?.Invoke(_client.DefaultRequestHeaders);
+    public void SetHeaders(Action<HttpRequestHeaders> headers)
+        => headers?.Invoke(_client.DefaultRequestHeaders);
 
     protected virtual async Task<T> SendAsync<T>(string uri, Method method, HttpContent? content = null, IHttpClientSerializer? serializer = null)
     {
@@ -241,7 +242,7 @@ protected virtual Task<HttpResponseMessage> GetResponseAsync(string uri, Method
         return content;
     }
 
-    protected async Task<T> DeserializeJsonFromStream<T>(Stream stream, IHttpClientSerializer? serializer = null)
+    protected async Task<T?> DeserializeJsonFromStream<T>(Stream stream, IHttpClientSerializer? serializer = null)
     {
         if (stream is null || stream.CanRead is false)
         {

src/Genocs.HTTP/HttpResult.cs

@@ -1,14 +1,8 @@
 namespace Genocs.HTTP;
 
-public class HttpResult<T>
+public class HttpResult<T>(T result, HttpResponseMessage response)
 {
-    public T Result { get; }
-    public HttpResponseMessage Response { get; }
+    public T Result { get; } = result;
+    public HttpResponseMessage Response { get; } = response;
     public bool HasResult => Result is not null;
-
-    public HttpResult(T result, HttpResponseMessage response)
-    {
-        Result = result;
-        Response = response;
-    }
 }

src/Genocs.LoadBalancing.Fabio/Extensions.cs

@@ -37,22 +37,32 @@ public static IGenocsBuilder AddFabio(
                                 b => b.AddConsul(consulOptions, httpClientOptions));
     }
 
-    public static IGenocsBuilder AddFabio(this IGenocsBuilder builder,
-        Func<IFabioOptionsBuilder, IFabioOptionsBuilder> buildOptions,
-        Func<IConsulOptionsBuilder, IConsulOptionsBuilder> buildConsulOptions,
-        HttpClientOptions httpClientOptions)
+    public static IGenocsBuilder AddFabio(
+                                            this IGenocsBuilder builder,
+                                            Func<IFabioOptionsBuilder, IFabioOptionsBuilder> buildOptions,
+                                            Func<IConsulOptionsBuilder, IConsulOptionsBuilder> buildConsulOptions,
+                                            HttpClientOptions httpClientOptions)
     {
         var fabioOptions = buildOptions(new FabioOptionsBuilder()).Build();
-        return builder.AddFabio(fabioOptions, httpClientOptions,
-            b => b.AddConsul(buildConsulOptions, httpClientOptions));
+
+        return builder.AddFabio(
+                                fabioOptions,
+                                httpClientOptions,
+                                b => b.AddConsul(buildConsulOptions, httpClientOptions));
     }
 
-    public static IGenocsBuilder AddFabio(this IGenocsBuilder builder, FabioOptions fabioOptions,
-        ConsulOptions consulOptions, HttpClientOptions httpClientOptions)
+    public static IGenocsBuilder AddFabio(
+                                            this IGenocsBuilder builder,
+                                            FabioOptions fabioOptions,
+                                            ConsulOptions consulOptions,
+                                            HttpClientOptions httpClientOptions)
         => builder.AddFabio(fabioOptions, httpClientOptions, b => b.AddConsul(consulOptions, httpClientOptions));
 
-    private static IGenocsBuilder AddFabio(this IGenocsBuilder builder, FabioOptions fabioOptions,
-        HttpClientOptions httpClientOptions, Action<IGenocsBuilder> registerConsul)
+    private static IGenocsBuilder AddFabio(
+                                            this IGenocsBuilder builder,
+                                            FabioOptions fabioOptions,
+                                            HttpClientOptions httpClientOptions,
+                                            Action<IGenocsBuilder> registerConsul)
     {
         registerConsul(builder);
         builder.Services.AddSingleton(fabioOptions);
@@ -64,19 +74,24 @@ private static IGenocsBuilder AddFabio(this IGenocsBuilder builder, FabioOptions
 
         if (httpClientOptions.Type?.ToLowerInvariant() == "fabio")
         {
-            builder.Services.AddTransient<FabioMessageHandler>();
-            builder.Services.AddHttpClient<IFabioHttpClient, FabioHttpClient>("fabio-http")
-                .AddHttpMessageHandler<FabioMessageHandler>();
+            builder.Services
+                            .AddTransient<FabioMessageHandler>();
 
+            builder.Services
+                            .AddHttpClient<IFabioHttpClient, FabioHttpClient>("fabio-http")
+                            .AddHttpMessageHandler<FabioMessageHandler>();
 
             builder.RemoveHttpClient();
-            builder.Services.AddHttpClient<IHttpClient, FabioHttpClient>("fabio")
-                .AddHttpMessageHandler<FabioMessageHandler>();
+
+            builder.Services
+                            .AddHttpClient<IHttpClient, FabioHttpClient>("fabio")
+                            .AddHttpMessageHandler<FabioMessageHandler>();
         }
 
         using var serviceProvider = builder.Services.BuildServiceProvider();
         var registration = serviceProvider.GetRequiredService<ServiceRegistration>();
         var tags = GetFabioTags(registration.Name, fabioOptions.Service);
+
         if (registration.Tags is null)
         {
             registration.Tags = tags;
@@ -91,12 +106,17 @@ private static IGenocsBuilder AddFabio(this IGenocsBuilder builder, FabioOptions
         return builder;
     }
 
-    public static void AddFabioHttpClient(this IGenocsBuilder builder, string clientName, string serviceName)
-        => builder.Services.AddHttpClient<IHttpClient, FabioHttpClient>(clientName)
-            .AddHttpMessageHandler(c => new FabioMessageHandler(c.GetRequiredService<FabioOptions>(), serviceName));
-
-    private static void UpdateConsulRegistration(this IServiceCollection services,
-        ServiceRegistration registration)
+    public static void AddFabioHttpClient(
+                                            this IGenocsBuilder builder,
+                                            string clientName,
+                                            string serviceName)
+        => builder.Services
+                            .AddHttpClient<IHttpClient, FabioHttpClient>(clientName)
+                            .AddHttpMessageHandler(c => new FabioMessageHandler(c.GetRequiredService<FabioOptions>(), serviceName));
+
+    private static void UpdateConsulRegistration(
+                                                    this IServiceCollection services,
+                                                    ServiceRegistration registration)
     {
         var serviceDescriptor = services.FirstOrDefault(sd => sd.ServiceType == typeof(ServiceRegistration));
         services.Remove(serviceDescriptor);

src/Genocs.LoadBalancing.Fabio/IFabioHttpClient.cs

@@ -2,6 +2,9 @@
 
 namespace Genocs.LoadBalancing.Fabio;
 
+/// <summary>
+/// The Fabio HTTP client interface definition.
+/// </summary>
 public interface IFabioHttpClient : IHttpClient
 {
 }

src/Genocs.LoadBalancing.Fabio/README_NUGET.md

@@ -1,11 +1,13 @@
-# .NET query builder library
+# Genocs Load Balancing library
+
+This package contains support for load balancing functionality by means of Fabio.
 
-This package contains a query builder that is agnostic about the persistence layer. The library is designed by Genocs.
-The libraries are built using .NET standard 2.1.
 
 ## Description
 
-Persistence agnostic query builder service.
+Fabio is a fast, modern, zero-conf load balancing HTTP(S) router for deploying microservices managed by consul.
+
+The libraries are built using .NET Core.
 
 
 ## Support
@@ -14,52 +16,3 @@ Please check the GitHub repository getting more info.
 
 
 ## Release notes
-
-### [2024-01-23] 5.0.6
-- Refactory Settings
-- Updated nuget packages
-
-### [2023-11-25] 5.0.5
-- Moved to NET8
-
-### [yyyy-mm-dd] 5.0.4
-- 
-
-### [yyyy-mm-dd] 5.0.3
-- 
-
-### [yyyy-mm-dd] 5.0.2
-- 
-
-### [yyyy-mm-dd] 5.0.1
-- 
-
-### [2023-11-25] 5.0.0
-- Moved to NET8
-
-### [2023-10-13] 5.0.0-preview.5.0
-- Added [editorconfig](https://editorconfig.org/)
-- Added StyleCop
-- Updated logo
-- Updated readme
-
-### [2023-03-12] 5.0.0-preview.4.0
-- Implemented MongoDB repository interfaces
-
-### [2023-03-12] 5.0.0
-- New Architecture
-
-### [2023-03-12] 3.1.0
-- Added Builders
-
-### [2023-03-12] 3.0.0
-- Refactory to implement CQRS pattern
-
-### [2023-03-04] 2.4.1
-- Updated System.Text.Json
-
-### [2023-01-23] 1.1.0
-- Refactory enum
-
-### [2023-01-13] 1.0.0
-- First Release

src/Genocs.WebApi/Configurations/WebApiOptions.cs

@@ -5,5 +5,8 @@ namespace Genocs.WebApi.Configurations;
 /// </summary>
 public class WebApiOptions
 {
+    /// <summary>
+    /// It defines whether the request body should be bound from the route or from body.
+    /// </summary>
     public bool BindRequestFromRoute { get; set; }
 }

src/Genocs.WebApi/Extensions.cs

@@ -303,7 +303,7 @@ public static async Task WriteJsonAsync<T>(this HttpResponse response, T value)
         await serializer.SerializeAsync(response.Body, value);
     }
 
-    public static async Task<T> ReadJsonAsync<T>(this HttpContext httpContext)
+    public static async Task<T?> ReadJsonAsync<T>(this HttpContext httpContext)
     {
         var logger = httpContext.RequestServices.GetService<ILogger>();
 
@@ -323,18 +323,31 @@ public static async Task<T> ReadJsonAsync<T>(this HttpContext httpContext)
             if (_bindRequestFromRoute && request.HasRouteData())
             {
                 var values = request.HttpContext.GetRouteData().Values;
+
+                if (values is null)
+                {
+                    return payload;
+                }
+
                 foreach (var (key, value) in values)
                 {
-                    var field = payload.GetType().GetFields(BindingFlags.Instance | BindingFlags.NonPublic)
-                        .SingleOrDefault(f => f.Name.ToLowerInvariant().StartsWith($"<{key}>",
-                            StringComparison.InvariantCultureIgnoreCase));
+                    var field = payload?.GetType()
+                                                    .GetFields(BindingFlags.Instance | BindingFlags.NonPublic)
+                                                    .SingleOrDefault(f => f.Name.ToLowerInvariant().StartsWith(
+                                                                                                                $"<{key}>",
+                                                                                                                StringComparison.InvariantCultureIgnoreCase));
 
                     if (field is null)
                     {
                         continue;
                     }
 
-                    var fieldValue = TypeDescriptor.GetConverter(field.FieldType)
+                    if (value is null)
+                    {
+                        continue;
+                    }
+
+                    object? fieldValue = TypeDescriptor.GetConverter(field.FieldType)
                         .ConvertFromInvariantString(value.ToString());
                     field.SetValue(payload, fieldValue);
                 }