Merge pull request #52 from PandaTechAM/development

HaikAsatryan · web-flow · commit 7dcfcc6b991a · 2024-12-17T16:14:12.000+04:00
Performance boost
diff --git a/src/ResponseCrafter/ExceptionHandlers/Http/ApiExceptionHandler.cs b/src/ResponseCrafter/ExceptionHandlers/Http/ApiExceptionHandler.cs
@@ -8,20 +8,16 @@
 using ResponseCrafter.Dtos;
 using ResponseCrafter.Enums;
 using ResponseCrafter.Extensions;
+using ResponseCrafter.Helpers;
 using ResponseCrafter.HttpExceptions;
 using ResponseCrafter.Options;
 using static ResponseCrafter.Helpers.ExceptionMessageBuilder;
 using IExceptionHandler = Microsoft.AspNetCore.Diagnostics.IExceptionHandler;
 
-namespace ResponseCrafter;
+namespace ResponseCrafter.ExceptionHandlers.Http;
 
-public class ApiExceptionHandler : IExceptionHandler
+internal class ApiExceptionHandler : IExceptionHandler
 {
-   private const string DefaultMessage = "something_went_wrong_please_try_again_later_and_or_contact_it_support";
-
-   private const string ConcurrencyMessage =
-      "a_concurrency_conflict_occurred._please_reload_the_resource_and_try_you_update_again";
-
    private readonly NamingConvention _convention;
    private readonly ILogger<ApiExceptionHandler> _logger;
    private readonly string _visibility;
@@ -32,14 +28,7 @@ public ApiExceptionHandler(ILogger<ApiExceptionHandler> logger,
    {
       _logger = logger;
       _convention = convention.NamingConvention;
-      _visibility = configuration["ResponseCrafterVisibility"]!;
-
-
-      if (string.IsNullOrWhiteSpace(_visibility) || (_visibility != "Private" && _visibility != "Public"))
-      {
-         _visibility = "Public";
-         _logger.LogWarning("Visibility configuration was not available. Defaulted to 'Public'.");
-      }
+      _visibility = configuration.GetResponseCrafterVisibility(_logger);
    }
 
    public async ValueTask<bool> TryHandleAsync(HttpContext httpContext,
@@ -73,7 +62,7 @@ public async ValueTask<bool> TryHandleAsync(HttpContext httpContext,
    private async Task HandleDbConcurrencyExceptionAsync(HttpContext httpContext, CancellationToken cancellationToken)
    {
       var exception =
-         new ConflictException(ConcurrencyMessage.ConvertCase(_convention));
+         new ConflictException(ExceptionMessages.ConcurrencyMessage.ConvertCase(_convention));
       await HandleApiExceptionAsync(httpContext, exception, cancellationToken);
    }
 
@@ -150,7 +139,7 @@ private async Task HandleGeneralExceptionAsync(HttpContext httpContext,
          Instance = CreateRequestPath(httpContext),
          StatusCode = 500,
          Type = "InternalServerError",
-         Message = DefaultMessage.ConvertCase(_convention)
+         Message = ExceptionMessages.DefaultMessage.ConvertCase(_convention)
       };
 
       if (_visibility == "Private")
diff --git a/src/ResponseCrafter/ExceptionHandlers/SignalR/HubArgument.cs b/src/ResponseCrafter/ExceptionHandlers/SignalR/HubArgument.cs
@@ -0,0 +1,6 @@
+﻿namespace ResponseCrafter.ExceptionHandlers.SignalR;
+
+public class HubArgument : IHubArgument
+{
+   public string? InvocationId { get; set; }
+}
diff --git a/src/ResponseCrafter/ExceptionHandlers/SignalR/IHubArgument.cs b/src/ResponseCrafter/ExceptionHandlers/SignalR/IHubArgument.cs
@@ -0,0 +1,6 @@
+﻿namespace ResponseCrafter.ExceptionHandlers.SignalR;
+
+internal interface IHubArgument
+{
+   public string InvocationId { get; set; }
+}
diff --git a/src/ResponseCrafter/ExceptionHandlers/SignalR/SignalRExceptionFilter.cs b/src/ResponseCrafter/ExceptionHandlers/SignalR/SignalRExceptionFilter.cs
@@ -11,15 +11,10 @@
 using ResponseCrafter.HttpExceptions;
 using ResponseCrafter.Options;
 
-namespace ResponseCrafter;
+namespace ResponseCrafter.ExceptionHandlers.SignalR;
 
 public class SignalRExceptionFilter : IHubFilter
 {
-   private const string DefaultMessage = "something_went_wrong_please_try_again_later_and_or_contact_it_support";
-
-   private const string ConcurrencyMessage =
-      "a_concurrency_conflict_occurred._please_reload_the_resource_and_try_you_update_again";
-
    private readonly NamingConvention _convention;
    private readonly ILogger<SignalRExceptionFilter> _logger;
    private readonly string _visibility;
@@ -30,14 +25,7 @@ public SignalRExceptionFilter(ILogger<SignalRExceptionFilter> logger,
    {
       _logger = logger;
       _convention = convention.NamingConvention;
-      _visibility = configuration["ResponseCrafterVisibility"]!;
-
-
-      if (string.IsNullOrWhiteSpace(_visibility) || (_visibility != "Private" && _visibility != "Public"))
-      {
-         _visibility = "Public";
-         _logger.LogWarning("Visibility configuration was not available. Defaulted to 'Public'.");
-      }
+      _visibility = configuration.GetResponseCrafterVisibility(_logger);
    }
 
 
@@ -48,12 +36,12 @@ public SignalRExceptionFilter(ILogger<SignalRExceptionFilter> logger,
 
       try
       {
-         invocationId = TryGetInvocationId(invocationContext);
+         invocationId = TryGetInvocationId<HubArgument>(invocationContext);
          return await next(invocationContext);
       }
       catch (DbUpdateConcurrencyException)
       {
-         var exception = new ConflictException(ConcurrencyMessage.ConvertCase(_convention));
+         var exception = new ConflictException(ExceptionMessages.ConcurrencyMessage.ConvertCase(_convention));
          return await HandleApiExceptionAsync(invocationContext, exception, invocationId);
       }
       catch (GridifyException ex)
@@ -71,23 +59,14 @@ public SignalRExceptionFilter(ILogger<SignalRExceptionFilter> logger,
       }
    }
 
-   private static string TryGetInvocationId(HubInvocationContext hubInvocationContext)
+   private static string TryGetInvocationId<T>(HubInvocationContext hubInvocationContext) where T : IHubArgument
    {
-      if (hubInvocationContext.HubMethodArguments.Count != 1)
+      if (hubInvocationContext.HubMethodArguments is not [T hubArgument])
       {
          throw new BadRequestException("Invalid hub method arguments. Expected a single HubArgument<T> parameter.");
       }
 
-      var hubArgument = hubInvocationContext.HubMethodArguments[0];
-      var invocationIdProperty = hubArgument?.GetType()
-                                            .GetProperty("InvocationId");
-
-      if (invocationIdProperty == null || invocationIdProperty.PropertyType != typeof(string))
-      {
-         throw new BadRequestException("Invalid hub method argument. Missing 'InvocationId' property.");
-      }
-
-      var invocationId = invocationIdProperty.GetValue(hubArgument) as string;
+      var invocationId = hubArgument.InvocationId;
       if (string.IsNullOrWhiteSpace(invocationId))
       {
          throw new BadRequestException("Invocation ID cannot be null, empty, or whitespace.");
@@ -138,7 +117,7 @@ private async Task<HubErrorResponse> HandleGeneralExceptionAsync(HubInvocationCo
          InvocationId = invocationId,
          Instance = invocationContext.HubMethodName,
          StatusCode = 500,
-         Message = DefaultMessage.ConvertCase(_convention)
+         Message = ExceptionMessages.DefaultMessage.ConvertCase(_convention)
       };
 
       if (_visibility == "Private")
diff --git a/src/ResponseCrafter/Extensions/ConfigurationExtensions.cs b/src/ResponseCrafter/Extensions/ConfigurationExtensions.cs
@@ -0,0 +1,22 @@
+﻿using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Logging;
+
+namespace ResponseCrafter.Extensions;
+
+internal static class ConfigurationExtensions
+{
+   private const string ResponseCrafterVisibility = "ResponseCrafterVisibility";
+
+   public static string GetResponseCrafterVisibility<T>(this IConfiguration configuration, ILogger<T> logger)
+   {
+      var visibility = configuration[ResponseCrafterVisibility];
+
+      if (!string.IsNullOrWhiteSpace(visibility) && visibility is "Private" or "Public")
+      {
+         return visibility;
+      }
+
+      logger.LogWarning("Visibility configuration was not available. Defaulted to 'Public'.");
+      return "Public";
+   }
+}
diff --git a/src/ResponseCrafter/Extensions/WebApplicationExtensions.cs b/src/ResponseCrafter/Extensions/WebApplicationExtensions.cs
@@ -1,6 +1,7 @@
 ﻿using Microsoft.AspNetCore.Builder;
 using Microsoft.Extensions.DependencyInjection;
 using ResponseCrafter.Enums;
+using ResponseCrafter.ExceptionHandlers.Http;
 using ResponseCrafter.Options;
 
 namespace ResponseCrafter.Extensions;
@@ -22,10 +23,7 @@ public static WebApplicationBuilder AddResponseCrafter(this WebApplicationBuilde
 
    public static WebApplication UseResponseCrafter(this WebApplication app)
    {
-      app.UseExceptionHandler(_ =>
-      {
-      }); //the lambda parameter is not needed it is just .net 8 bug which might be fixed in the future
-
+      app.UseExceptionHandler();
       return app;
    }
 }
diff --git a/src/ResponseCrafter/Helpers/ConstantMessageProvider.cs b/src/ResponseCrafter/Helpers/ConstantMessageProvider.cs
@@ -0,0 +1,9 @@
+﻿namespace ResponseCrafter.Helpers;
+
+internal static class ExceptionMessages
+{
+   internal const string DefaultMessage = "something_went_wrong_please_try_again_later_and_or_contact_it_support";
+
+   internal const string ConcurrencyMessage =
+      "a_concurrency_conflict_occurred._please_reload_the_resource_and_try_you_update_again";
+}
diff --git a/src/ResponseCrafter/ResponseCrafter.csproj b/src/ResponseCrafter/ResponseCrafter.csproj
@@ -8,13 +8,13 @@
         <Copyright>MIT</Copyright>
         <PackageIcon>pandatech.png</PackageIcon>
         <PackageReadmeFile>Readme.md</PackageReadmeFile>
-        <Version>5.1.1</Version>
+        <Version>5.1.2</Version>
         <PackageId>Pandatech.ResponseCrafter</PackageId>
         <PackageTags>Pandatech, library, exception handler, exception, middleware, Api response</PackageTags>
         <Title>ResponseCrafter</Title>
         <Description>Handling exceptions, custom Dtos.</Description>
         <RepositoryUrl>https://github.com/PandaTechAM/be-lib-response-crafter</RepositoryUrl>
-        <PackageReleaseNotes>New naming convention added</PackageReleaseNotes>
+        <PackageReleaseNotes>Performance boost</PackageReleaseNotes>
     </PropertyGroup>
 
     <ItemGroup>
diff --git a/test/ResponseCrafter.Demo/Program.cs b/test/ResponseCrafter.Demo/Program.cs
@@ -4,6 +4,7 @@
 using ResponseCrafter;
 using ResponseCrafter.Demo.Hubs;
 using ResponseCrafter.Enums;
+using ResponseCrafter.ExceptionHandlers.SignalR;
 using ResponseCrafter.Extensions;
 
 var builder = WebApplication.CreateBuilder(args);

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`using Microsoft.AspNetCore.Builder;`
`2`	`2`	`using Microsoft.Extensions.DependencyInjection;`
`3`	`3`	`using ResponseCrafter.Enums;`
	`4`	`+using ResponseCrafter.ExceptionHandlers.Http;`
`4`	`5`	`using ResponseCrafter.Options;`
`5`	`6`
`6`	`7`	`namespace ResponseCrafter.Extensions;`
`@@ -22,10 +23,7 @@ public static WebApplicationBuilder AddResponseCrafter(this WebApplicationBuilde`
`22`	`23`
`23`	`24`	`public static WebApplication UseResponseCrafter(this WebApplication app)`
`24`	`25`	`{`
`25`		`- app.UseExceptionHandler(_ =>`
`26`		`- {`
`27`		`- }); //the lambda parameter is not needed it is just .net 8 bug which might be fixed in the future`
`28`		`-`
	`26`	`+ app.UseExceptionHandler();`
`29`	`27`	`return app;`
`30`	`28`	`}`
`31`	`29`	`}`