feature(#6): this commit implements correlation support to improve tracing and observability

Author: https-richardy

Boundaries/Comanda.Subscriptions/Source/Comanda.Subscriptions.WebApi/Constants/Headers.cs

@@ -0,0 +1,12 @@
+namespace Comanda.Subscriptions.WebApi.Constants;
+
+public static class Headers
+{
+    public const string Credential = "X-Credential";
+    public const string Location = "Location";
+    public const string Link = "Link";
+    public const string Pagination = "X-Pagination";
+    public const string Authorization = "Authorization";
+    public const string Idempotency = "Idempotency-Key";
+    public const string Correlation = "Correlation";
+}

Boundaries/Comanda.Subscriptions/Source/Comanda.Subscriptions.WebApi/Extensions/HttpPipelineExtension.cs

@@ -13,9 +13,10 @@ public static void UseHttpPipeline(this IApplicationBuilder app)
         app.UseAuthentication();
         app.UseAuthorization();
 
+        app.UseCorrelationMiddleware();
         app.UseEndpoints(endpoints =>
         {
             endpoints.MapControllers();
         });
     }
-}
+}

Boundaries/Comanda.Subscriptions/Source/Comanda.Subscriptions.WebApi/Middlewares/CorrelationMiddleware.cs

@@ -0,0 +1,29 @@
+namespace Comanda.Subscriptions.WebApi.Middlewares;
+
+public sealed class CorrelationMiddleware(RequestDelegate next)
+{
+    public async Task InvokeAsync(HttpContext context)
+    {
+        var correlationId = context.Request.Headers[Headers.Correlation].FirstOrDefault();
+
+        if (string.IsNullOrWhiteSpace(correlationId))
+            correlationId = context.TraceIdentifier;
+
+        context.Items[Headers.Correlation] = correlationId;
+        context.Response.Headers[Headers.Correlation] = correlationId;
+
+        /* enriches the logging scope with the current correlation identifier, ensuring all logs within this request pipeline share the same identifier */
+        /* more details: https://microsoft.github.io/code-with-engineering-playbook/observability/correlation-id/ */
+
+        using (LogContext.PushProperty(Headers.Correlation, correlationId))
+        using (SentrySdk.PushScope())
+        {
+            SentrySdk.ConfigureScope(scope =>
+            {
+                scope.SetTag("correlation_id", correlationId);
+            });
+
+            await next(context);
+        }
+    }
+}

Boundaries/Comanda.Subscriptions/Source/Comanda.Subscriptions.WebApi/Middlewares/CorrelationMiddlewareExtension.cs

@@ -0,0 +1,10 @@
+namespace Comanda.Subscriptions.WebApi.Middlewares;
+
+[ExcludeFromCodeCoverage(Justification = "contains only dependency injection")]
+public static class CorrelationMiddlewareExtension
+{
+    public static IApplicationBuilder UseCorrelationMiddleware(this IApplicationBuilder app)
+    {
+        return app.UseMiddleware<CorrelationMiddleware>();
+    }
+}

Boundaries/Comanda.Subscriptions/Source/Comanda.Subscriptions.WebApi/Usings.cs

@@ -6,6 +6,7 @@
 
 global using Comanda.Subscriptions.WebApi.Extensions;
 global using Comanda.Subscriptions.WebApi.Constants;
+global using Comanda.Subscriptions.WebApi.Middlewares;
 global using Comanda.Subscriptions.Domain.Errors;
 
 global using Comanda.Subscriptions.Application.Payloads.Traceability;
@@ -19,4 +20,5 @@
 
 global using Scalar.AspNetCore;
 global using Serilog;
+global using Serilog.Context;
 global using FluentValidation.AspNetCore;