Merge branch 'main' into dotnet-upgrade

# Conflicts:
#	src/CustomExceptionMiddleware.csproj

Author: isaacnborges-ac

README-nuget.md

@@ -67,11 +67,11 @@ In both cases the output will include de stack trace in `detail` object property
 Example output
 ```json
 {
+    "type": "VALIDATION_ERRORS",
     "error": {
         "msg": "Custom domain exception message",
         "detail": "at CustomExceptionMiddleware.WebAppTest.Custom.ProductService.GetDomainException(Boolean returnProducts) in C:\\isaacnborges\\projects\\custom-exception-middleware\\tests\\CustomExceptionMiddleware.WebAppTest.Custom\\ProductService.cs:line 18\r\n   at CustomExceptionMiddleware.WebAppTest.Custom.Controllers.ProductController.GetDomain(Boolean returnProduct) in C:\\isaacnborges\\projects\\custom-exception-middleware\\tests\\CustomExceptionMiddleware.WebAppTest.Custom\\Controllers\\ProductController.cs:line 26"
     },
-    "type": "VALIDATION_ERRORS"
 }
 ```
 
@@ -95,8 +95,14 @@ Exception              InternalServerError         500
 ```c#
 public class InvalidStateException : DomainException
 {
-    public InvalidStateException(string message) : base(message)
-    { }
+        public InvalidStateException()
+        { }
+
+        public InvalidStateException(string message) : base(message)
+        { }
+
+        public InvalidStateException(string message, Exception innerException) : base(message, innerException)
+        { }
 }
 ```
 
@@ -108,8 +114,30 @@ throw new NotFoundException("Custom not found exception message");
 throw new Exception("Custom exception message");
 ```
 
-### Sample example
-Open `docs` folder, inside has a [postman](https://www.postman.com/) collection that could be used for test the sample projects with some requests and validate the middleware in use.
+#### Customize exception type
+It's possible to customize the exception type when throw an exception, just pass the type in an exception constructor. 
+```c#
+throw new CustomDomainException("Custom domain exception message", "OTHER_CUSTOM_TYPE");
+```
+
+### Samples
+Inside the `samples` folder has two projects that could be used for test the and validate the middleware.
+
+#### Run the sample projects
+- WebAppTest
+    ```
+    dotnet run --project .\samples\CustomExceptionMiddleware.WebAppTest\
+    ```
+- WebAppTest.Custom
+    ```
+    dotnet run --project .\samples\CustomExceptionMiddleware.WebAppTest.Custom\
+    ```
+#### Samples documentation
+- Swagger
+    - [WebAppTest](http://localhost:5000/swagger/index.html)
+    - [WebAppTest.Custom](http://localhost:5001/swagger/index.html)
+- Postman
+    - Open `docs` folder, inside has a [postman](https://www.postman.com/) collection that could be used for test.
 
 ## Logging
 This middleware will `Log` some informations that can be used for monitoring and observability, like `TraceIdentifier`, request and exception informations like message type and stack trace:

README.md

@@ -68,11 +68,11 @@ In both cases the output will include de stack trace in `detail` object property
 Example output
 ```json
 {
+    "type": "VALIDATION_ERRORS",
     "error": {
         "msg": "Custom domain exception message",
         "detail": "at CustomExceptionMiddleware.WebAppTest.Custom.ProductService.GetDomainException(Boolean returnProducts) in C:\\isaacnborges\\projects\\custom-exception-middleware\\tests\\CustomExceptionMiddleware.WebAppTest.Custom\\ProductService.cs:line 18\r\n   at CustomExceptionMiddleware.WebAppTest.Custom.Controllers.ProductController.GetDomain(Boolean returnProduct) in C:\\isaacnborges\\projects\\custom-exception-middleware\\tests\\CustomExceptionMiddleware.WebAppTest.Custom\\Controllers\\ProductController.cs:line 26"
-    },
-    "type": "VALIDATION_ERRORS"
+    }
 }
 ```
 
@@ -94,8 +94,14 @@ The custom middleware supports the following **Exceptions**:
 ```c#
 public class InvalidStateException : DomainException
 {
-    public InvalidStateException(string message) : base(message)
-    { }
+        public InvalidStateException()
+        { }
+
+        public InvalidStateException(string message) : base(message)
+        { }
+
+        public InvalidStateException(string message, Exception innerException) : base(message, innerException)
+        { }
 }
 ```
 
@@ -107,14 +113,35 @@ throw new NotFoundException("Custom not found exception message");
 throw new Exception("Custom exception message");
 ```
 
-### Sample example
-Open `docs` folder, inside has a [postman](https://www.postman.com/) collection that could be used for test the sample projects with some requests and validate the middleware in use.
+#### Customize exception type
+It's possible to customize the exception type when throw an exception, just pass the type in an exception constructor. 
+```c#
+throw new CustomDomainException("Custom domain exception message", "OTHER_CUSTOM_TYPE");
+```
+
+### Samples
+Inside the `samples` folder has two projects that could be used for test the and validate the middleware.
+
+#### Run the sample projects
+- WebAppTest
+    ```
+    dotnet run --project .\samples\CustomExceptionMiddleware.WebAppTest\
+    ```
+- WebAppTest.Custom
+    ```
+    dotnet run --project .\samples\CustomExceptionMiddleware.WebAppTest.Custom\
+    ```
+#### Samples documentation
+- Swagger
+    - [WebAppTest](http://localhost:5000/swagger/index.html)
+    - [WebAppTest.Custom](http://localhost:5001/swagger/index.html)
+- Postman
+    - Open `docs` folder, inside has a [postman](https://www.postman.com/) collection that could be used for test.
 
 ## Logging
 This middleware will `Log` some informations that can be used for monitoring and observability, like `TraceIdentifier`, request and exception informations like message type and stack trace:
 
 Example log:
-
 ```
 Occurred an exception - TraceId: 0HMBO9LGH0JHD:00000002 - ExceptionType: InvalidStateException - Message: Custom domain exception message
 CustomExceptionMiddleware.WebAppTest.InvalidStateException: Custom domain exception message

samples/CustomExceptionMiddleware.WebAppTest.Custom/Controllers/ProductController.cs

@@ -27,6 +27,13 @@ public IActionResult GetDomain([FromQuery] bool returnProduct = false)
             return Ok(result);
         }
 
+        [HttpGet("custom-domain")]
+        public IActionResult GetCustomDomain([FromQuery] bool returnProduct = false)
+        {
+            var result = _productService.GetCustomDomainException(returnProduct);
+            return Ok(result);
+        }
+
         [IgnoreCustomException]
         [HttpGet("ignore")]
         public IActionResult GetIgnore()

samples/CustomExceptionMiddleware.WebAppTest.Custom/CustomDomainException.cs

@@ -16,6 +16,16 @@ public CustomDomainException(string message) : base(message)
         public CustomDomainException(string message, Exception innerException) : base(message, innerException)
         { }
 
+        public CustomDomainException(string message, string exceptionType) : base(message, exceptionType)
+        {
+            ExceptionType = exceptionType;
+        }
+
+        public CustomDomainException(string message, string exceptionType, Exception innerException) : base(message, exceptionType, innerException)
+        {
+            ExceptionType = exceptionType;
+        }
+
         protected CustomDomainException(SerializationInfo info, StreamingContext context) : base(info, context)
         { }
     }

samples/CustomExceptionMiddleware.WebAppTest.Custom/IProductService.cs

@@ -6,5 +6,6 @@ public interface IProductService
     {
         IEnumerable<Product> Get(int productsCount);
         IEnumerable<Product> GetDomainException(bool returnProducts);
+        IEnumerable<Product> GetCustomDomainException(bool returnProducts);
     }
 }

samples/CustomExceptionMiddleware.WebAppTest.Custom/ProductService.cs

@@ -18,6 +18,14 @@ public IEnumerable<Product> GetDomainException(bool returnProducts)
             throw new CustomDomainException("Custom domain exception message");
         }
 
+        public IEnumerable<Product> GetCustomDomainException(bool returnProducts)
+        {
+            if (returnProducts)
+                return GetProducts();
+
+            throw new CustomDomainException("Custom domain exception message", "OTHER_CUSTOM_TYPE");
+        }
+
         private static IEnumerable<Product> GetProducts(int customersCount = 10)
         {
             var fake = new Faker<Product>()

samples/CustomExceptionMiddleware.WebAppTest/InvalidStateException.cs

@@ -16,6 +16,16 @@ public InvalidStateException(string message) : base(message)
         public InvalidStateException(string message, Exception innerException) : base(message, innerException)
         { }
 
+        public InvalidStateException(string message, string exceptionType) : base(message, exceptionType)
+        {
+            ExceptionType = exceptionType;
+        }
+
+        public InvalidStateException(string message, string exceptionType, Exception innerException) : base(message, exceptionType, innerException)
+        {
+            ExceptionType = exceptionType;
+        }
+
         protected InvalidStateException(SerializationInfo info, StreamingContext context) : base(info, context)
         { }
     }

src/CustomExceptionMiddlewareExtensions.cs renamed to src/ApplicationBuilderExtensions.cs

@@ -8,7 +8,7 @@ namespace CustomExceptionMiddleware
     /// <summary>
     /// Extension methods to add custom exception handling to an HTTP application pipeline.
     /// </summary>
-    public static class CustomExceptionMiddlewareExtensions
+    public static class ApplicationBuilderExtensions
     {
         /// <summary>
         /// Adds the <see cref="CustomExceptionMiddleware"/> to the specified <see cref="IApplicationBuilder"/>, which enables handling exceptions capabilities.