Merge pull request #29 from futurum-dev/feature/turn-on-code-analysis

Turn on 'EnforceCodeStyleInBuild' and 'AnalysisLevel' and fix issues

Author: futurum-dev

src/Futurum.WebApiEndpoint.Micro/FormFileWithPayload.cs

@@ -1,3 +1,4 @@
+using System.Globalization;
 using System.Reflection;
 using System.Text.Json;
 
@@ -20,7 +21,9 @@ public class FormFileWithPayload<TPayload> : IBindableFromHttpContext<FormFileWi
 
     public required IFormFile File { get; init; }
 
+#pragma warning disable CA1000
     public static async ValueTask<FormFileWithPayload<TPayload>?> BindAsync(HttpContext context, ParameterInfo parameter)
+#pragma warning restore CA1000
     {
         var jsonOptions = context.RequestServices.GetService<JsonOptions>()?.SerializerOptions ?? DefaultSerializerOptions;
 
@@ -41,7 +44,7 @@ public class FormFileWithPayload<TPayload> : IBindableFromHttpContext<FormFileWi
 
     private static TPayload? GetPayload(IFormCollection form, JsonSerializerOptions jsonOptions)
     {
-        if (form.TryGetValue(nameof(Payload).ToLower(), out var payloadStringValues))
+        if (form.TryGetValue(nameof(Payload).ToLower(CultureInfo.CurrentCulture), out var payloadStringValues))
         {
             var payloadString = payloadStringValues.ToString();
             var payload = JsonSerializer.Deserialize<TPayload>(payloadString, jsonOptions);
@@ -57,7 +60,9 @@ public class FormFileWithPayload<TPayload> : IBindableFromHttpContext<FormFileWi
             ? default
             : form.Files.Single();
 
+#pragma warning disable CA1000
     public static void PopulateMetadata(ParameterInfo parameter, EndpointBuilder builder)
+#pragma warning restore CA1000
     {
         builder.Metadata.Add(new ConsumesAttribute(typeof(FormFileWithPayload<TPayload>), "multipart/form-data"));
     }

src/Futurum.WebApiEndpoint.Micro/FormFilesWithPayload.cs

@@ -1,3 +1,4 @@
+using System.Globalization;
 using System.Reflection;
 using System.Text.Json;
 
@@ -20,7 +21,9 @@ public class FormFilesWithPayload<TPayload> : IBindableFromHttpContext<FormFiles
 
     public required IFormFileCollection Files { get; init; } = new FormFileCollection();
 
+#pragma warning disable CA1000
     public static async ValueTask<FormFilesWithPayload<TPayload>?> BindAsync(HttpContext context, ParameterInfo parameter)
+#pragma warning restore CA1000
     {
         var jsonOptions = context.RequestServices.GetService<JsonOptions>()?.SerializerOptions ?? DefaultSerializerOptions;
 
@@ -41,7 +44,7 @@ public class FormFilesWithPayload<TPayload> : IBindableFromHttpContext<FormFiles
 
     private static TPayload? GetPayload(IFormCollection form, JsonSerializerOptions jsonOptions)
     {
-        if (form.TryGetValue(nameof(Payload).ToLower(), out var payloadStringValues))
+        if (form.TryGetValue(nameof(Payload).ToLower(CultureInfo.CurrentCulture), out var payloadStringValues))
         {
             var payloadString = payloadStringValues.ToString();
             var payload = JsonSerializer.Deserialize<TPayload>(payloadString, jsonOptions);
@@ -57,7 +60,9 @@ public class FormFilesWithPayload<TPayload> : IBindableFromHttpContext<FormFiles
             ? null
             : form.Files;
 
+#pragma warning disable CA1000
     public static void PopulateMetadata(ParameterInfo parameter, EndpointBuilder builder)
+#pragma warning restore CA1000
     {
         builder.Metadata.Add(new ConsumesAttribute(typeof(FormFilesWithPayload<TPayload>), "multipart/form-data"));
     }

src/Futurum.WebApiEndpoint.Micro/Futurum.WebApiEndpoint.Micro.csproj

@@ -6,6 +6,8 @@
         <Nullable>enable</Nullable>
         <ImplicitUsings>enable</ImplicitUsings>
         <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+        <EnforceCodeStyleInBuild>True</EnforceCodeStyleInBuild>
+        <AnalysisLevel>latest-recommended</AnalysisLevel>
         <IsPackable>true</IsPackable>
         <LangVersion>default</LangVersion>
     </PropertyGroup>

src/Futurum.WebApiEndpoint.Micro/GlobalExceptionHandler.cs

@@ -1,16 +1,21 @@
 using Microsoft.AspNetCore.Diagnostics;
 
+using static Microsoft.Extensions.Logging.LoggerMessage;
+
 namespace Futurum.WebApiEndpoint.Micro;
 
 /// <summary>
 /// Global exception handler, for unhandled exceptions
 /// <remarks>Utilises <see cref="IExceptionToProblemDetailsMapperService"/></remarks>
 /// </summary>
-public sealed class GlobalExceptionHandler(ILogger<GlobalExceptionHandler> logger, IExceptionToProblemDetailsMapperService exceptionToProblemDetailsMapperService) : IExceptionHandler
+public sealed class GlobalExceptionHandler(ILogger<GlobalExceptionHandler> logger, IExceptionToProblemDetailsMapperService exceptionToProblemDetailsMapperService)
+    : IExceptionHandler
 {
+    private static readonly Action<ILogger, string, Exception> LogErrorMessage = Define<string>(LogLevel.Error, eventId: new EventId(id: 0, name: "ERROR"), formatString: "Exception occurred: {Message}");
+
     public async ValueTask<bool> TryHandleAsync(HttpContext httpContext, Exception exception, CancellationToken cancellationToken)
     {
-        logger.LogError(exception, "Exception occurred: {Message}", exception.Message);
+        LogErrorMessage(logger, exception.Message, exception);
 
         var problemDetails = exceptionToProblemDetailsMapperService.Map(exception, httpContext, null);
 

src/Futurum.WebApiEndpoint.Micro/WebApiEndpoint.cs

@@ -44,7 +44,7 @@ private static IEndpointRouteBuilder CreateVersionedEndpointRouteBuilder(IEndpoi
     {
         var apiVersion = (ApiVersion)webApiEndpointVersion;
 
-        var formattedVersion = apiVersion.ToString(configuration.Version.Format);
+        var formattedVersion = apiVersion.ToString(configuration.Version.Format, new ApiVersionFormatProvider());
 
         return app.NewVersionedApi($"{configuration.Version.Prefix}{formattedVersion}");
     }
@@ -82,7 +82,7 @@ private static IEndpointRouteBuilder ConfigureWithWebApiVersionEndpoint(IEndpoin
         }
     }
 
-    private static IEndpointRouteBuilder ApplyVersionedRoute(IEndpointRouteBuilder app, WebApiEndpointConfiguration configuration) =>
+    private static RouteGroupBuilder ApplyVersionedRoute(IEndpointRouteBuilder app, WebApiEndpointConfiguration configuration) =>
         app.MapGroup($"{configuration.Version.Prefix}{{version:apiVersion}}");
 
     private static RouteGroupBuilder ApplySpecificRouteAndTag(IEndpointRouteBuilder endpointRouteBuilder, string route, string tag, WebApiEndpointVersion webApiEndpointVersion)