refactor: improve exception handling, modernize API versioning, and simplify Kafka setup

* refactor: add global IExceptionHandler and simplify CustomControllerBase

* refactor: migrate from Microsoft.AspNetCore.Mvc.Versioning to Asp.Versioning.Mvc 8.1.0

* chore: add Asp.Versioning global using to all service projects

* refactor: wire UseExceptionHandler middleware and rename AddApiVersioning calls

* refactor: remove Zookeeper, migrate Kafka to KRaft mode (cp-kafka 7.8.0)

Author: falberthen

Directory.Packages.props

@@ -26,8 +26,8 @@
   </ItemGroup>
 
   <ItemGroup Label="API Versioning">
-    <PackageVersion Include="Microsoft.AspNetCore.Mvc.Versioning" Version="5.1.0" />
-    <PackageVersion Include="Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer" Version="5.1.0" />
+    <PackageVersion Include="Asp.Versioning.Mvc" Version="8.1.0" />
+    <PackageVersion Include="Asp.Versioning.Mvc.ApiExplorer" Version="8.1.0" />
   </ItemGroup>
 
   <ItemGroup Label="API Gateway">

docker-compose.yml

@@ -32,28 +32,21 @@ services:
       - './scripts/db_init.sql:/docker-entrypoint-initdb.d/db_init.sql'
     restart: on-failure
 
-  zookeeper:
-    image: confluentinc/cp-zookeeper:7.6.1
-    ports:
-      - '2181:2181'
-    environment:
-      ZOOKEEPER_CLIENT_PORT: 2181
-      ZOOKEEPER_TICK_TIME: 2000
-    volumes:
-      - zookeeper-data:/var/lib/zookeeper/data
-      - zookeeper-log:/var/lib/zookeeper/log
-    restart: always
-
   kafka:
-    image: confluentinc/cp-kafka:7.6.1
+    image: confluentinc/cp-kafka:7.8.0
     ports:
       - '29092:29092'
       - '9092:9092'
     environment:
-      KAFKA_BROKER_ID: 1
-      KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
-      KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: PLAINTEXT:PLAINTEXT,PLAINTEXT_HOST:PLAINTEXT
+      KAFKA_NODE_ID: 1
+      KAFKA_PROCESS_ROLES: 'broker,controller'
+      KAFKA_CONTROLLER_QUORUM_VOTERS: '1@kafka:9093'
+      KAFKA_CONTROLLER_LISTENER_NAMES: 'CONTROLLER'
+      KAFKA_INTER_BROKER_LISTENER_NAME: 'PLAINTEXT'
+      KAFKA_LISTENERS: 'PLAINTEXT://kafka:29092,CONTROLLER://kafka:9093,PLAINTEXT_HOST://0.0.0.0:9092'
       KAFKA_ADVERTISED_LISTENERS: 'PLAINTEXT://kafka:29092,PLAINTEXT_HOST://kafka:9092'
+      KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: 'PLAINTEXT:PLAINTEXT,CONTROLLER:PLAINTEXT,PLAINTEXT_HOST:PLAINTEXT'
+      CLUSTER_ID: 'MkU3OEVBNTcwNTJENDM2Qk'
       KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1
       KAFKA_GROUP_INITIAL_REBALANCE_DELAY_MS: 0
       KAFKA_LOG_DIRS: /var/lib/kafka/data
@@ -71,9 +64,6 @@ services:
     volumes:
       - kafka-data:/var/lib/kafka/data
     restart: always
-    depends_on:
-      zookeeper:
-        condition: service_started
 
   kafka-ui:
     image: provectuslabs/kafka-ui:latest
@@ -359,8 +349,6 @@ networks:
 
 volumes:
   postgres:
-  zookeeper-data:
-  zookeeper-log:
   kafka-data:
   pgadmin:
   debezium-data:

src/Core/EcommerceDDD.Core.Infrastructure/EcommerceDDD.Core.Infrastructure.csproj

@@ -14,8 +14,8 @@
 		<PackageReference Include="Duende.IdentityServer.EntityFramework" />
 		<PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" />
 		<PackageReference Include="Microsoft.AspNetCore.Identity.EntityFrameworkCore" />
-		<PackageReference Include="Microsoft.AspNetCore.Mvc.Versioning" />
-		<PackageReference Include="Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer" />
+		<PackageReference Include="Asp.Versioning.Mvc" />
+		<PackageReference Include="Asp.Versioning.Mvc.ApiExplorer" />
 		<PackageReference Include="Microsoft.EntityFrameworkCore" />
 		<PackageReference Include="Microsoft.EntityFrameworkCore.Relational" />
 		<PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" />

src/Core/EcommerceDDD.Core.Infrastructure/Extensions/CoreInfrastructureExtensions.cs

@@ -11,6 +11,9 @@ public static IServiceCollection AddCoreInfrastructure(this IServiceCollection s
 		services
 			.AddMemoryCache()
 			.AddHttpContextAccessor()
+			// Exception handling
+			.AddExceptionHandler<GlobalExceptionHandler>()
+			.AddProblemDetails()
 			// CQRS
 			.AddScoped<ICommandBus, CommandBus>()
 			.AddScoped<IQueryBus, QueryBus>()

src/Core/EcommerceDDD.Core.Infrastructure/GlobalUsings.cs

@@ -27,7 +27,7 @@
 global using Microsoft.AspNetCore.Builder;
 global using Microsoft.AspNetCore.Http;
 global using Microsoft.AspNetCore.Mvc;
-global using Microsoft.AspNetCore.Mvc.Versioning;
+global using Asp.Versioning;
 global using Microsoft.Extensions.Caching.Memory;
 global using Microsoft.Extensions.Configuration;
 global using Microsoft.Extensions.DependencyInjection;

src/Core/EcommerceDDD.Core.Infrastructure/WebApi/ApiVersioningExtension.cs

@@ -1,18 +1,18 @@
-namespace EcommerceDDD.Core.Infrastructure.WebApi;
+namespace EcommerceDDD.Core.Infrastructure.WebApi;
 
 public static class ApiVersioningExtension
 {
-    public static IServiceCollection AddApiVersioning(this IServiceCollection services, string apiVersion = ApiVersions.V2)
+    public static IServiceCollection AddApiVersioning(
+		this IServiceCollection services, string apiVersion = ApiVersions.V2)
     {
 		services.AddApiVersioning(options =>
 		{
 			options.AssumeDefaultVersionWhenUnspecified = true;
-			options.DefaultApiVersion = ApiVersion.Parse(apiVersion);
+			options.DefaultApiVersion = ApiVersionParser.Default.Parse(apiVersion);
 			options.ReportApiVersions = true;
 			options.ApiVersionReader = new UrlSegmentApiVersionReader();
-		});
-
-		services.AddVersionedApiExplorer(options =>
+		})
+		.AddApiExplorer(options =>
 		{
 			options.GroupNameFormat = "'v'VVV";
 			options.SubstituteApiVersionInUrl = true;

src/Core/EcommerceDDD.Core.Infrastructure/WebApi/CustomControllerBase.cs

@@ -1,4 +1,4 @@
-namespace EcommerceDDD.Core.Infrastructure.WebApi;
+namespace EcommerceDDD.Core.Infrastructure.WebApi;
 
 public class CustomControllerBase : ControllerBase
 {
@@ -18,57 +18,21 @@ protected CustomControllerBase(ICommandBus commandBus, IQueryBus queryBus)
     protected async new Task<IActionResult> Response<TResult>(IQuery<TResult> query,
         CancellationToken cancellationToken)
     {
-        TResult result;
-
-        try
-        {
-            result = await _queryBus
-				.SendAsync(query, cancellationToken);
-        }
-        catch (OperationCanceledException)
-        {
-            return StatusCode(500, "Operation was canceled.");
-        }
-        catch (Exception e)
-        {
-            return BadRequestActionResult(e.Message);
-        }
-
+        var result = await _queryBus.SendAsync(query, cancellationToken);
         return Ok(new ApiResponse<TResult>
         {
             Data = result,
             Success = true
         });
     }
 
-    protected async new Task<IActionResult> Response(ICommand command, 
+    protected async new Task<IActionResult> Response(ICommand command,
 		CancellationToken cancellationToken)
     {
-        try
-        {
-            await _commandBus
-				.SendAsync(command, cancellationToken);
-        }
-        catch (OperationCanceledException)
-        {
-            // Handle cancellation
-            return StatusCode(500, "Operation was canceled.");
-        }
-        catch (Exception e)
-        {
-            return BadRequestActionResult(e.Message);
-        }
-
+        await _commandBus.SendAsync(command, cancellationToken);
         return Ok(new ApiResponse<IActionResult>
         {
             Success = true
         });
     }
-
-    protected IActionResult BadRequestActionResult(string resultErrors) 
-		=> BadRequest(new ApiResponse<IActionResult>
-			{
-				Success = false,
-				Message = resultErrors
-			});
-}
+}

src/Core/EcommerceDDD.Core.Infrastructure/WebApi/GlobalExceptionHandler.cs

@@ -0,0 +1,42 @@
+namespace EcommerceDDD.Core.Infrastructure.WebApi;
+
+public class GlobalExceptionHandler(ILogger<GlobalExceptionHandler> logger)
+	: Microsoft.AspNetCore.Diagnostics.IExceptionHandler
+{
+	public async ValueTask<bool> TryHandleAsync(
+		HttpContext httpContext,
+		Exception exception,
+		CancellationToken cancellationToken)
+	{
+		if (exception is OperationCanceledException)
+		{
+			logger.LogInformation("Request was canceled.");
+			return true;
+		}
+
+		var (statusCode, message) = exception switch
+		{
+			BusinessRuleException e => (StatusCodes.Status422UnprocessableEntity, e.Message),
+			RecordNotFoundException e => (StatusCodes.Status404NotFound, e.Message),
+			ApplicationLogicException e => (StatusCodes.Status500InternalServerError, e.Message),
+			_ => (StatusCodes.Status500InternalServerError, "An unexpected error occurred.")
+		};
+
+		if (statusCode >= 500)
+			logger.LogError(exception, "Server error: {Message}", exception.Message);
+		else
+			logger.LogWarning("Request error ({StatusCode}): {Message}", statusCode, exception.Message);
+
+		httpContext.Response.StatusCode = statusCode;
+		httpContext.Response.ContentType = "application/json";
+
+		var response = new ApiResponse<object>
+		{
+			Success = false,
+			Message = message
+		};
+
+		await httpContext.Response.WriteAsJsonAsync(response, cancellationToken);
+		return true;
+	}
+}

src/Crosscutting/EcommerceDDD.IdentityServer/API/Controllers/AccountsController.cs

@@ -1,4 +1,4 @@
-namespace EcommerceDDD.IdentityServer.Controllers;
+namespace EcommerceDDD.IdentityServer.Controllers;
 
 [AllowAnonymous]
 [ApiController]
@@ -13,38 +13,24 @@ public class AccountsController(IIdentityManager identityManager) : CustomContro
 	[ProducesResponseType(typeof(LoginResult), StatusCodes.Status200OK)]
 	public async Task<IActionResult> UserLogin(LoginRequest request)
     {
-        try
-        {
-			LoginResult result = await _identityManager
-                .AuthUserByCredentials(request);
+		LoginResult result = await _identityManager
+			.AuthUserByCredentials(request);
 
-            return Ok(result);
-        }
-        catch (Exception e)
-        {
-            return BadRequestActionResult(e.Message);
-        }
+		return Ok(result);
     }
 
     [HttpPost, Route("register")]
 	[MapToApiVersion(ApiVersions.V2)]
 	[ProducesResponseType(typeof(UserRegisteredResult), StatusCodes.Status200OK)]
 	public async Task<IActionResult> Register(RegisterUserRequest request)
     {
-        try
-        {
-			UserRegisteredResult result = await _identityManager
-                .RegisterNewUser(request);
+		UserRegisteredResult result = await _identityManager
+			.RegisterNewUser(request);
 
-            return Ok(new
-            {
-                data = result,
-                success = result.Succeeded
-            });
-        }
-        catch (Exception e)
-        {
-            return BadRequestActionResult(e.Message);            
-        }
+		return Ok(new
+		{
+			data = result,
+			success = result.Succeeded
+		});
     }
 }

src/Crosscutting/EcommerceDDD.IdentityServer/GlobalUsings.cs

@@ -18,6 +18,7 @@
 global using Microsoft.AspNetCore.Authorization;
 global using Microsoft.AspNetCore.Identity;
 global using Microsoft.AspNetCore.Identity.EntityFrameworkCore;
+global using Asp.Versioning;
 global using Microsoft.AspNetCore.Mvc;
 global using Microsoft.EntityFrameworkCore;
 global using Microsoft.Extensions.Options;