Merge pull request #45 from PandaTechAM/development

HaikAsatryan · web-flow · commit 9203cd56b343 · 2024-11-11T14:24:33.000+04:00
updated missing feature
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,191 @@
+﻿###############################
+#   PandaTech Editor Config   #
+###############################
+
+
+################################
+# ReSharper Generated Settings #
+################################
+
+[*]
+charset = utf-8-bom
+end_of_line = crlf
+trim_trailing_whitespace = false
+insert_final_newline = false
+indent_style = space
+indent_size = 4
+
+# Microsoft .NET properties
+csharp_preferred_modifier_order = public, private, protected, internal, file, new, static, abstract, virtual, sealed, readonly, override, extern, unsafe, volatile, async, required:suggestion
+csharp_style_prefer_utf8_string_literals = true:suggestion
+csharp_style_var_elsewhere = true:suggestion
+csharp_style_var_for_built_in_types = true:suggestion
+csharp_style_var_when_type_is_apparent = true:suggestion
+dotnet_naming_rule.unity_serialized_field_rule.import_to_resharper = True
+dotnet_naming_rule.unity_serialized_field_rule.resharper_description = Unity serialized field
+dotnet_naming_rule.unity_serialized_field_rule.resharper_guid = 5f0fdb63-c892-4d2c-9324-15c80b22a7ef
+dotnet_naming_rule.unity_serialized_field_rule.severity = warning
+dotnet_naming_rule.unity_serialized_field_rule.style = lower_camel_case_style
+dotnet_naming_rule.unity_serialized_field_rule.symbols = unity_serialized_field_symbols
+dotnet_naming_style.lower_camel_case_style.capitalization = camel_case
+dotnet_naming_symbols.unity_serialized_field_symbols.applicable_accessibilities = *
+dotnet_naming_symbols.unity_serialized_field_symbols.applicable_kinds =
+dotnet_naming_symbols.unity_serialized_field_symbols.resharper_applicable_kinds = unity_serialised_field
+dotnet_naming_symbols.unity_serialized_field_symbols.resharper_required_modifiers = instance
+dotnet_style_parentheses_in_arithmetic_binary_operators = never_if_unnecessary:none
+dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:none
+dotnet_style_parentheses_in_relational_binary_operators = never_if_unnecessary:none
+dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion
+dotnet_style_predefined_type_for_member_access = true:suggestion
+dotnet_style_qualification_for_event = false:suggestion
+dotnet_style_qualification_for_field = false:suggestion
+dotnet_style_qualification_for_method = false:suggestion
+dotnet_style_qualification_for_property = false:suggestion
+dotnet_style_require_accessibility_modifiers = for_non_interface_members:suggestion
+
+# ReSharper properties
+resharper_align_linq_query = true
+resharper_align_multiline_calls_chain = true
+resharper_apply_auto_detected_rules = false
+resharper_braces_for_for = required
+resharper_braces_for_foreach = required
+resharper_braces_for_ifelse = required
+resharper_braces_for_while = required
+resharper_cpp_insert_final_newline = true
+resharper_csharp_indent_size = 3
+resharper_csharp_max_enum_members_on_line = 0
+resharper_csharp_tab_width = 3
+resharper_csharp_wrap_arguments_style = chop_if_long
+resharper_csharp_wrap_parameters_style = chop_if_long
+resharper_formatter_off_tag = @formatter:off
+resharper_formatter_on_tag = @formatter:on
+resharper_formatter_tags_enabled = true
+resharper_keep_existing_declaration_parens_arrangement = false
+resharper_keep_existing_expr_member_arrangement = false
+resharper_keep_existing_initializer_arrangement = false
+resharper_keep_existing_switch_expression_arrangement = false
+resharper_max_array_initializer_elements_on_line = 0
+resharper_max_initializer_elements_on_line = 0
+resharper_place_accessorholder_attribute_on_same_line = false
+resharper_place_accessor_attribute_on_same_line = false
+resharper_place_field_attribute_on_same_line = false
+resharper_place_simple_anonymousmethod_on_single_line = false
+resharper_place_simple_embedded_statement_on_same_line = false
+resharper_place_simple_initializer_on_single_line = false
+resharper_place_simple_property_pattern_on_single_line = false
+resharper_use_indent_from_vs = false
+resharper_wrap_after_property_in_chained_method_calls = true
+resharper_wrap_array_initializer_style = chop_if_long
+resharper_wrap_chained_method_calls = chop_always
+resharper_wrap_linq_expressions = chop_always
+resharper_wrap_list_pattern = chop_if_long
+resharper_wrap_object_and_collection_initializer_style = chop_always
+resharper_wrap_property_pattern = chop_always
+
+# ReSharper inspection severities
+resharper_arrange_redundant_parentheses_highlighting = hint
+resharper_arrange_this_qualifier_highlighting = hint
+resharper_arrange_type_member_modifiers_highlighting = hint
+resharper_arrange_type_modifiers_highlighting = hint
+resharper_built_in_type_reference_style_for_member_access_highlighting = hint
+resharper_built_in_type_reference_style_highlighting = hint
+resharper_enforce_foreach_statement_braces_highlighting = warning
+resharper_enforce_for_statement_braces_highlighting = warning
+resharper_enforce_if_statement_braces_highlighting = warning
+resharper_enforce_lock_statement_braces_highlighting = warning
+resharper_enforce_using_statement_braces_highlighting = warning
+resharper_enforce_while_statement_braces_highlighting = warning
+resharper_mvc_action_not_resolved_highlighting = warning
+resharper_mvc_area_not_resolved_highlighting = warning
+resharper_mvc_controller_not_resolved_highlighting = warning
+resharper_mvc_masterpage_not_resolved_highlighting = warning
+resharper_mvc_partial_view_not_resolved_highlighting = warning
+resharper_mvc_template_not_resolved_highlighting = warning
+resharper_mvc_view_component_not_resolved_highlighting = warning
+resharper_mvc_view_component_view_not_resolved_highlighting = warning
+resharper_mvc_view_not_resolved_highlighting = warning
+resharper_razor_assembly_not_resolved_highlighting = warning
+resharper_redundant_base_qualifier_highlighting = warning
+resharper_web_config_module_not_resolved_highlighting = warning
+resharper_web_config_type_not_resolved_highlighting = warning
+resharper_web_config_wrong_module_highlighting = warning
+
+[{*.har,*.jsb2,*.jsb3,*.json,*.jsonc,*.postman_collection,*.postman_collection.json,*.postman_environment,*.postman_environment.json,.babelrc,.eslintrc,.prettierrc,.stylelintrc,.ws-context,bowerrc,jest.config}]
+indent_style = space
+indent_size = 2
+
+[{*.yaml,*.yml}]
+indent_style = space
+indent_size = 2
+
+[*.cs]
+indent_style = space
+indent_size = 3
+tab_width = 3
+
+[*.{appxmanifest,asax,ascx,aspx,axaml,build,c,c++,c++m,cc,ccm,cginc,compute,cp,cpp,cppm,cshtml,cu,cuh,cxx,cxxm,dtd,fs,fsi,fsscript,fsx,fx,fxh,h,hh,hlsl,hlsli,hlslinc,hpp,hxx,inc,inl,ino,ipp,ixx,master,ml,mli,mpp,mq4,mq5,mqh,mxx,nuspec,paml,razor,resw,resx,shader,skin,tpp,usf,ush,uxml,vb,xaml,xamlx,xoml,xsd}]
+indent_style = space
+indent_size = 4
+tab_width = 4
+
+#########################
+# Custom added settings #
+#########################
+[*.cs]
+dotnet_diagnostic.cs8600.severity = error #Converting null literal or possible null value to non-nullable type.
+dotnet_diagnostic.cs8601.severity = error #Possible null reference assignment.
+dotnet_diagnostic.cs8602.severity = error #possible dereference of a null reference
+dotnet_diagnostic.cs8603.severity = error #possible null reference return
+dotnet_diagnostic.cs8604.severity = error #possible null reference argument for parameter
+dotnet_diagnostic.cs8605.severity = error #Unboxing a possibly null value
+dotnet_diagnostic.cs8618.severity = error # Non-nullable field is uninitialized. Consider declaring as nullable.
+dotnet_diagnostic.cs8625.severity = error # Cannot convert null literal to non-nullable reference type.
+dotnet_diagnostic.cs8762.severity = error # Nullability of reference types in type doesn't match overridden member.
+dotnet_diagnostic.cs1717.severity = error #variable is assigned to itself
+dotnet_diagnostic.cs1718.severity = error #comparison made to same variable
+dotnet_diagnostic.cs0659.severity = error #overriding object.Equals but not overriding object.GetHashCode
+dotnet_diagnostic.cs0251.severity = error #Indexing an array with a negative index (array indices always start at zero)
+dotnet_diagnostic.s3363.severity = none #Never set DateTime as PrimaryKey. Ignored as we never do it but have warnings for cache entities.
+dotnet_diagnostic.ca2016.severity = error #Forwarding cancellation tokens
+csharp_style_namespace_declarations = file_scoped:error
+resharper_entity_framework_model_validation_unlimited_string_length_highlighting = none
+
+
+#########################
+# VS added settings #
+#########################
+
+[*.cs]
+csharp_style_namespace_declarations = file_scoped:error
+csharp_indent_labels = one_less_than_current
+csharp_using_directive_placement = outside_namespace:silent
+csharp_prefer_simple_using_statement = true:suggestion
+csharp_prefer_braces = true:silent
+csharp_style_prefer_method_group_conversion = true:silent
+csharp_style_prefer_top_level_statements = true:silent
+csharp_style_prefer_primary_constructors = true:suggestion
+csharp_style_expression_bodied_methods = false:silent
+csharp_style_expression_bodied_constructors = false:silent
+csharp_style_expression_bodied_operators = false:silent
+csharp_style_expression_bodied_properties = true:silent
+csharp_style_expression_bodied_indexers = true:silent
+csharp_style_expression_bodied_accessors = true:silent
+csharp_style_expression_bodied_lambdas = true:silent
+csharp_style_expression_bodied_local_functions = false:silent
+
+[{*.yaml,*.yml}]
+dotnet_style_namespace_match_folder = true:suggestion
+dotnet_style_operator_placement_when_wrapping = beginning_of_line
+tab_width = 3
+dotnet_style_coalesce_expression = true:suggestion
+dotnet_style_null_propagation = true:suggestion
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
+dotnet_style_prefer_auto_properties = true:silent
+dotnet_style_object_initializer = true:suggestion
+dotnet_style_collection_initializer = true:suggestion
+dotnet_style_prefer_simplified_boolean_expressions = true:suggestion
+dotnet_style_prefer_conditional_expression_over_assignment = true:silent
+
+[*.csv]
+indent_style = tab
+tab_width = 4
diff --git a/Readme.md b/Readme.md
@@ -5,7 +5,7 @@
 **Pandatech.ResponseCrafter** is a comprehensive NuGet package for .NET 8+, specifically designed to enhance exception
 handling and logging in ASP.NET Core applications, and now extended to support SignalR hubs. This package simplifies
 managing standard and custom exceptions by crafting detailed error responses suitable for both development and
-production environments.
+production environments. It inherits all RFC 9457 Problem Details for HTTP APIs and even extends it.
 
 ## Features
 
@@ -26,30 +26,32 @@ production environments.
 
 ```json
 {
-  "TraceId": "0HMVFE0A284AM:00000001",
-  "Instance": "POST - 164.54.144.23:443/users/register",
-  "StatusCode": 400,
-  "Type": "BadRequestException",
-  "Errors": {
-    "email": "email_address_is_not_in_a_valid_format",
-    "password": "password_must_be_at_least_8_characters_long"
-  },
-  "Message": "the_request_was_invalid_or_cannot_be_otherwise_served."
+    "RequestId": "0HMVFE0A284AM:00000001",
+    "TraceId": "a55582ab204162e66e124b0378776ab7",
+    "Instance": "POST - 164.54.144.23:443/users/register",
+    "StatusCode": 400,
+    "Type": "BadRequestException",
+    "Errors": {
+        "email": "email_address_is_not_in_a_valid_format",
+        "password": "password_must_be_at_least_8_characters_long"
+    },
+    "Message": "the_request_was_invalid_or_cannot_be_otherwise_served."
 }
 ```
 
 For SignalR, the standard error response format is:
 
 ```json
 {
-  "InvocationId": "0HMVFE0A0HMVFE0A284AMHMV00HMVFE0A284AM0A284AM",
-  "Instance": "SendMessage",
-  "StatusCode": 400,
-  "Errors": {
-    "email": "email_address_is_not_in_a_valid_format",
-    "password": "password_must_be_at_least_8_characters_long"
-  },
-  "Message": "the_request_was_invalid_or_cannot_be_otherwise_served."
+    "TraceId": "a55582ab204162e66e124b0378776ab7",
+    "InvocationId": "0HMVFE0A0HMVFE0A284AMHMV00HMVFE0A284AM0A284AM",
+    "Instance": "SendMessage",
+    "StatusCode": 400,
+    "Errors": {
+        "email": "email_address_is_not_in_a_valid_format",
+        "password": "password_must_be_at_least_8_characters_long"
+    },
+    "Message": "the_request_was_invalid_or_cannot_be_otherwise_served."
 }
 ```
 
@@ -86,7 +88,7 @@ Configure visibility in your `appsettings.json`:
 
 ```json
 {
-  "ResponseCrafterVisibility": "Public"
+    "ResponseCrafterVisibility": "Public"
 }
 ```
 
diff --git a/ResponseCrafter.sln b/ResponseCrafter.sln
@@ -10,6 +10,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		.gitignore = .gitignore
 		Readme.md = Readme.md
 		global.json = global.json
+		.editorconfig = .editorconfig
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{C43D3C79-62B4-43AC-A166-F64BC869D0E9}"
diff --git a/src/ResponseCrafter/ApiExceptionHandler.cs b/src/ResponseCrafter/ApiExceptionHandler.cs
@@ -1,4 +1,5 @@
-﻿using FluentImporter.Exceptions;
+﻿using System.Diagnostics;
+using FluentImporter.Exceptions;
 using GridifyExtensions.Exceptions;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.Logging;
@@ -144,7 +145,8 @@ private async Task HandleApiExceptionAsync(HttpContext httpContext, ApiException
     {
         var response = new ErrorResponse
         {
-            TraceId = httpContext.TraceIdentifier,
+            RequestId = httpContext.TraceIdentifier,
+            TraceId = Activity.Current?.RootId ?? "",
             Instance = CreateRequestPath(httpContext),
             StatusCode = exception.StatusCode,
             Type = exception.GetType().Name,
@@ -173,7 +175,8 @@ private async Task HandleGeneralExceptionAsync(HttpContext httpContext, Exceptio
 
         var response = new ErrorResponse
         {
-            TraceId = httpContext.TraceIdentifier,
+            RequestId = httpContext.TraceIdentifier,
+            TraceId = Activity.Current?.RootId ?? "",
             Instance = CreateRequestPath(httpContext),
             StatusCode = 500,
             Type = "InternalServerError",
diff --git a/src/ResponseCrafter/Dtos/ErrorResponse.cs b/src/ResponseCrafter/Dtos/ErrorResponse.cs
@@ -2,10 +2,11 @@
 
 public class ErrorResponse
 {
-    public string TraceId { get; set; } = null!;
-    public string Instance { get; set; } = null!;
-    public int StatusCode { get; set; }
-    public string Type { get; set; } = null!;
-    public Dictionary<string, string>? Errors { get; set; }
-    public string Message { get; set; } = null!;
+   public required string RequestId { get; set; }
+   public required string TraceId { get; set; }
+   public required string Instance { get; set; }
+   public int StatusCode { get; init; }
+   public required string Type { get; set; }
+   public Dictionary<string, string>? Errors { get; set; }
+   public required string Message { get; set; }
 }
diff --git a/src/ResponseCrafter/Dtos/HubErrorResponse.cs b/src/ResponseCrafter/Dtos/HubErrorResponse.cs
@@ -5,6 +5,7 @@
 /// </summary>
 public class HubErrorResponse
 {
+   public required string TraceId { get; set; }
    public required string InvocationId { get; set; }
    public required string Instance { get; set; }
    public int StatusCode { get; set; }
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>4.0.0</Version>
+        <Version>4.0.1</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>SignalR ResponseCrafting Support Has Been Added</PackageReleaseNotes>
+        <PackageReleaseNotes>TraceId now shows real traceId. Before it was requestId. For RequestId new property has been added.</PackageReleaseNotes>
     </PropertyGroup>
 
     <ItemGroup>
@@ -23,12 +23,12 @@
     </ItemGroup>
 
     <ItemGroup>
-        <PackageReference Include="Humanizer" Version="2.14.1" />
-        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.8" />
-        <PackageReference Include="Microsoft.AspNetCore.SignalR.Client" Version="8.0.8" />
-        <PackageReference Include="PandaTech.FluentImporter" Version="2.0.13" />
-        <PackageReference Include="Pandatech.GridifyExtensions" Version="1.6.2" />
-        <PackageReference Include="PandaTech.ServiceResponse" Version="1.2.12" />
+        <PackageReference Include="Humanizer" Version="2.14.1"/>
+        <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.8"/>
+        <PackageReference Include="Microsoft.AspNetCore.SignalR.Client" Version="8.0.8"/>
+        <PackageReference Include="PandaTech.FluentImporter" Version="2.0.13"/>
+        <PackageReference Include="Pandatech.GridifyExtensions" Version="1.6.2"/>
+        <PackageReference Include="PandaTech.ServiceResponse" Version="1.2.12"/>
     </ItemGroup>
 
 </Project>
diff --git a/src/ResponseCrafter/SignalRExceptionFilter.cs b/src/ResponseCrafter/SignalRExceptionFilter.cs
@@ -1,4 +1,5 @@
-﻿using GridifyExtensions.Exceptions;
+﻿using System.Diagnostics;
+using GridifyExtensions.Exceptions;
 using Microsoft.AspNetCore.SignalR;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.Configuration;
@@ -96,11 +97,12 @@ private async Task<HubErrorResponse> HandleApiExceptionAsync(HubInvocationContex
    {
       var response = new HubErrorResponse
       {
+         TraceId = Activity.Current?.RootId ?? "",
          InvocationId = invocationId,
          Instance = invocationContext.HubMethodName,
          StatusCode = exception.StatusCode,
          Message = exception.Message.ConvertCase(_convention),
-         Errors = exception.Errors
+         Errors = exception.Errors,
       };
    
       if (response.Errors is null || response.Errors.Count == 0)
@@ -124,6 +126,7 @@ private async Task<HubErrorResponse> HandleGeneralExceptionAsync(HubInvocationCo
       
       var response = new HubErrorResponse
       {
+         TraceId = Activity.Current?.RootId ?? "",
          InvocationId = invocationId,
          Instance = invocationContext.HubMethodName,
          StatusCode = 500,
diff --git a/test/ResponseCrafter.Demo/Hubs/ChatHub.cs b/test/ResponseCrafter.Demo/Hubs/ChatHub.cs
@@ -22,5 +22,5 @@ public async Task SendMessage(HubArgument<Message> hubArgument)
 public class Message
 {
    public required string User { get; set; }
-   public string Content { get; set; }
+   public required string Content { get; set; }
 }

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`/// </summary>`
`6`	`6`	`public class HubErrorResponse`
`7`	`7`	`{`
	`8`	`+ public required string TraceId { get; set; }`
`8`	`9`	`public required string InvocationId { get; set; }`
`9`	`10`	`public required string Instance { get; set; }`
`10`	`11`	`public int StatusCode { get; set; }`
Original file line number	Diff line number	Diff line change
`@@ -22,5 +22,5 @@ public async Task SendMessage(HubArgument<Message> hubArgument)`
`22`	`22`	`public class Message`
`23`	`23`	`{`
`24`	`24`	`public required string User { get; set; }`
`25`		`- public string Content { get; set; }`
	`25`	`+ public required string Content { get; set; }`
`26`	`26`	`}`