code clean & set exception message for loggers

Author: yoldascevik

ARConsistency/ARConsistency.csproj

@@ -7,8 +7,8 @@
     <RepositoryUrl>https://github.com/yoldascevik/ARConsistency</RepositoryUrl>
     <PackageProjectUrl>https://github.com/yoldascevik/ARConsistency</PackageProjectUrl>
     <PackageLicenseFile>LICENSE.md</PackageLicenseFile>
-    <Version>1.1</Version>
-    <PackageVersion>1.1</PackageVersion>
+    <Version>1.1.2</Version>
+    <PackageVersion>1.1.2</PackageVersion>
   </PropertyGroup>
 
   <ItemGroup>

ARConsistency/Configuration/ExceptionStatusCodeHandler.cs

@@ -19,7 +19,7 @@ public void RegisterStatusCodedExceptionBaseType<TException>(
             if (!(statusCodeExpression.Body is MemberExpression memberExpression))
                 throw new ArgumentException("Unable to resolve StatusCode member in expression.");
 
-            var memberType = memberExpression.Member.MemberType;
+            MemberTypes memberType = memberExpression.Member.MemberType;
             if (memberType != MemberTypes.Field && memberType != MemberTypes.Property)
                 throw new ArgumentException("StatusCode expression can be only Property or Field member.");
 

ARConsistency/ConsistencyMiddleware.cs

@@ -108,13 +108,11 @@ private async Task HandleRequestAsync(HttpContext context, string body)
         private async Task HandleExceptionAsync(HttpContext context, ApiException exception)
         {
             ConsistentApiResponse response = exception.As<IConsistentable>().GetConsistentApiResponse();
-
-            _logger.LogError(exception, null);
             _responseHelper.FormatResponseAccordingToOptions(ref response, exception.StatusCode);
-
+            _logger.LogError(exception, ResponseMessage.GetResponseMessageByStatusCode(response.StatusCode));
+            
             string serializedResponse = JsonHelper.ConvertResponseToJsonString(response, _options);
-            await _responseHelper.WriteFormattedResponseToHttpContextAsync(context, exception.StatusCode,
-                serializedResponse);
+            await _responseHelper.WriteFormattedResponseToHttpContextAsync(context, exception.StatusCode, serializedResponse);
         }
     }
 }

ARConsistency/Helpers/JsonHelper.cs

@@ -10,8 +10,8 @@ namespace ARConsistency.Helpers
 {
     internal static class JsonHelper
     {
-        internal static string ConvertToJsonString(object rawJSON)
-            => JsonConvert.SerializeObject(rawJSON);
+        internal static string ConvertToJsonString(object rawJson)
+            => JsonConvert.SerializeObject(rawJson);
 
         internal static string ConvertResponseToJsonString(ConsistentApiResponse response, ResponseOptions options)
             => JsonConvert.SerializeObject(response, Formatting.Indented, new JsonSerializerSettings()
@@ -25,6 +25,5 @@ internal static string ConvertResponseToJsonString(ConsistentApiResponse respons
 
         internal static ConsistentApiResponse GetConsistentApiResponseFromJsonToken(JToken jsonToken)
             => new ConsistentApiResponse(jsonToken.ToObject<object>());
-
     }
 }

ARConsistency/Helpers/ResponseMessage.cs

@@ -5,16 +5,16 @@ namespace ARConsistency.Helpers
     internal class ResponseMessage
     {
         internal const string Success = "Request successful.";
-        internal const string NotFound = "Request not found. The specified uri does not exist.";
+        internal const string NotFound = "Request not found. The specified uri or entity does not exist.";
         internal const string BadRequest = "Request invalid.";
         internal const string MethodNotAllowed = "Request responded with 'Method Not Allowed'.";
         internal const string NotContent = "Request no content. The specified uri does not contain any content.";
         internal const string Exception = "Request responded with exceptions.";
-        internal const string UnAuthorized = "Request denied. Unauthorized access.";
+        internal const string UnAuthorized = "Access denied.";
         internal const string ValidationError = "Request responded with validation error(s). Please correct the specified validation errors and try again.";
-        internal const string Unhandled = "Unhandled Exception occurred. Unable to process the request.";
+        internal const string Unhandled = "An unhandled exception was thrown by the application.";
 
-        internal static string GetResponseMessageByStatusCode(int statusCode) =>
+        internal static string GetResponseMessageByStatusCode(int? statusCode) =>
             statusCode switch
             {
                 StatusCodes.Status200OK => ResponseMessage.Success,
@@ -24,7 +24,7 @@ internal static string GetResponseMessageByStatusCode(int statusCode) =>
                 StatusCodes.Status404NotFound => ResponseMessage.NotFound,
                 StatusCodes.Status405MethodNotAllowed => ResponseMessage.MethodNotAllowed,
                 StatusCodes.Status500InternalServerError => ResponseMessage.Unhandled,
-                _ => null
+                _ => ResponseMessage.Unhandled
             };
     }
 }

ARConsistency/ResponseModels/Base/ArcObjectResult.cs

@@ -11,7 +11,7 @@ public abstract class ArcObjectResult : ActionResult
 
         public override Task ExecuteResultAsync(ActionContext context)
         {
-            IActionResultExecutor<ObjectResult> executor = context.HttpContext.RequestServices.GetRequiredService<IActionResultExecutor<ObjectResult>>();
+            var executor = context.HttpContext.RequestServices.GetRequiredService<IActionResultExecutor<ObjectResult>>();
 
             context.HttpContext.Response.StatusCode = StatusCode;
             return executor.ExecuteAsync(context, new ObjectResult(this));

ARConsistency/ResponseModels/Base/ConsistentApiResponse.cs

@@ -12,15 +12,13 @@ public class ConsistentApiResponse
         public string Message { get; set; }
         public bool IsError => !string.IsNullOrEmpty(ExceptionMessage) || (ValidationErrors != null && ValidationErrors.Any());
         public string ExceptionMessage { get; set; }
-        public string ExceptionDetails { get; set; }
+        public string ExceptionDetails { get; set; } 
         public IEnumerable<ValidationError> ValidationErrors { get; set; }
- 
+        
         [JsonProperty(NullValueHandling =  NullValueHandling.Include)]
         public object Payload { get; set; }
 
-        public ConsistentApiResponse()
-        {
-        }
+        public ConsistentApiResponse() { }
 
         public ConsistentApiResponse(object payload)
             :this()

ARConsistency/ServiceExtensions.cs …onsistency/ServiceCollectionExtension.csARConsistency/ServiceExtensions.cs renamed to ARConsistency/ServiceCollectionExtension.cs ARConsistency/ServiceExtensions.cs renamed to ARConsistency/ServiceCollectionExtension.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Linq;
 using ARConsistency.Configuration;
 using ARConsistency.ContractResolver;
@@ -11,7 +12,7 @@
 
 namespace ARConsistency
 {
-    public static class ServiceExtensions
+    public static class ServiceCollectionExtension
     {
         public static IMvcBuilder AddApiResponseConsistency(this IMvcBuilder builder, 
             Action<ArcConfiguration> configurationBuilder)
@@ -42,8 +43,7 @@ public static IApplicationBuilder UseApiResponseConsistency(this IApplicationBui
         #region Private Helper Methods
         private static void Configure(IServiceCollection services,  Action<ArcConfiguration> configurationBuilder)
         {
-            ArcConfiguration configuration = new ArcConfiguration();
-            
+            var configuration = new ArcConfiguration();
             configurationBuilder.Invoke(configuration);
             services.AddSingleton(configuration.ResponseOptions);
             services.AddSingleton(configuration.ExceptionStatusCodeHandler);
@@ -55,7 +55,7 @@ private static void SuppressBadRequestResponse(IServiceCollection services)
             {
                 options.InvalidModelStateResponseFactory = context =>
                 {
-                    var validationErrors = context.ModelState.Keys
+                    List<ValidationError> validationErrors = context.ModelState.Keys
                         .SelectMany(key => context.ModelState[key].Errors.Select(x => new ValidationError(key, x.ErrorMessage)))
                         .ToList();
 

Test/TestApi/Startup.cs

@@ -1,5 +1,4 @@
 using ARConsistency;
-using ARConsistency.Configuration;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Configuration;

Test/WebApiTest/ActionTest.cs

@@ -3,7 +3,6 @@
 using System.Net;
 using System.Net.Http;
 using ARConsistency.ResponseModels.Base;
-using Microsoft.AspNetCore.Mvc.Infrastructure;
 using Newtonsoft.Json;
 using TestApi.Models;
 using WebApiTest.Helpers;