add a correlation and causation ids manager to the frontend

Author: aalmada

docs/correlation-causation-guide.md

@@ -298,6 +298,22 @@ logger.LogInformation(
 3. **`LoggingEnricherMiddleware`**:
    - Automatically adds `CorrelationId` and `CausationId` to the structured logging scope for every request.
 
+### Blazor Frontend Implementation
+
+The Blazor frontend automatically manages and propagates these IDs using a dedicated service and message handler:
+
+1. **`CorrelationService`**:
+   - Stores the current `CorrelationId` (persistent per circuit/session).
+   - Manages the `CausationId`, which updates dynamically.
+
+2. **`AuthorizationMessageHandler`**:
+   - Automatically injects `X-Correlation-ID` and `X-Causation-ID` headers into all outgoing API requests.
+   - Captures `X-Event-ID` from backend responses to update the `CausationId` for subsequent calls.
+
+3. **`BookStoreEventsService`**:
+   - Updates the `CorrelationService` with the `EventId` from incoming Server-Sent Events (SSE).
+   - Ensures that reactive UI updates and subsequent background data reloads are correctly linked to the event that triggered them.
+
 ## Summary
 
 - **Correlation ID**: Tracks the entire business workflow

src/ApiService/BookStore.ApiService/Endpoints/JwtAuthenticationEndpoints.cs

@@ -184,7 +184,7 @@ static async Task<IResult> ConfirmEmailAsync(
         var result = await userManager.ConfirmEmailAsync(user, code);
         if (result.Succeeded)
         {
-            await bus.PublishAsync(new BookStore.Shared.Notifications.UserVerifiedNotification(user.Id, user.Email!, DateTimeOffset.UtcNow));
+            await bus.PublishAsync(new BookStore.Shared.Notifications.UserVerifiedNotification(Guid.Empty, user.Id, user.Email!, DateTimeOffset.UtcNow));
             return Results.Ok("Email confirmed successfully.");
         }
 

src/ApiService/BookStore.ApiService/Handlers/Books/BookCoverHandlers.cs

@@ -61,6 +61,7 @@ public static class BookCoverHandlers
 
         // Return notification for SignalR
         var notification = new BookCoverUpdatedNotification(
+            Guid.Empty,
             aggregate.Id,
             coverUrl);
 

src/ApiService/BookStore.ApiService/Infrastructure/MartenCommitListener.cs

@@ -119,7 +119,7 @@ async Task HandleUserChangeAsync(UserProfile profile, ChangeType _, Cancellation
         // - Shopping cart operations: BookAddedToCart, BookRemovedFromCart, CartItemQuantityUpdated, ShoppingCartCleared
         // "UserUpdated" is a good catch-all for ReactiveQuery invalidation.
 
-        IDomainEventNotification notification = new UserUpdatedNotification(profile.Id, timestamp);
+        IDomainEventNotification notification = new UserUpdatedNotification(Guid.Empty, profile.Id, timestamp);
 
         await NotifyAsync("User", notification, token);
     }
@@ -134,9 +134,9 @@ async Task HandleCategoryChangeAsync(CategoryProjection category, ChangeType cha
         var name = category.Names.Values.FirstOrDefault() ?? "Unknown";
         IDomainEventNotification notification = effectiveChangeType switch
         {
-            ChangeType.Insert => new CategoryCreatedNotification(category.Id, name, category.LastModified),
-            ChangeType.Update => new CategoryUpdatedNotification(category.Id, category.LastModified),
-            ChangeType.Delete => new CategoryDeletedNotification(category.Id, category.LastModified),
+            ChangeType.Insert => new CategoryCreatedNotification(Guid.Empty, category.Id, name, category.LastModified),
+            ChangeType.Update => new CategoryUpdatedNotification(Guid.Empty, category.Id, category.LastModified),
+            ChangeType.Delete => new CategoryDeletedNotification(Guid.Empty, category.Id, category.LastModified),
             _ => throw new ArgumentOutOfRangeException(nameof(effectiveChangeType))
         };
 
@@ -153,9 +153,9 @@ async Task HandleBookChangeAsync(BookSearchProjection book, ChangeType changeTyp
         var timestamp = DateTimeOffset.UtcNow;
         IDomainEventNotification notification = effectiveChangeType switch
         {
-            ChangeType.Insert => new BookCreatedNotification(book.Id, book.Title, timestamp),
-            ChangeType.Update => new BookUpdatedNotification(book.Id, book.Title, timestamp),
-            ChangeType.Delete => new BookDeletedNotification(book.Id, timestamp),
+            ChangeType.Insert => new BookCreatedNotification(Guid.Empty, book.Id, book.Title, timestamp),
+            ChangeType.Update => new BookUpdatedNotification(Guid.Empty, book.Id, book.Title, timestamp),
+            ChangeType.Delete => new BookDeletedNotification(Guid.Empty, book.Id, timestamp),
             _ => throw new ArgumentOutOfRangeException(nameof(effectiveChangeType))
         };
 
@@ -170,9 +170,9 @@ async Task HandleAuthorChangeAsync(AuthorProjection author, ChangeType changeTyp
 
         IDomainEventNotification notification = effectiveChangeType switch
         {
-            ChangeType.Insert => new AuthorCreatedNotification(author.Id, author.Name, author.LastModified),
-            ChangeType.Update => new AuthorUpdatedNotification(author.Id, author.Name, author.LastModified),
-            ChangeType.Delete => new AuthorDeletedNotification(author.Id, author.LastModified),
+            ChangeType.Insert => new AuthorCreatedNotification(Guid.Empty, author.Id, author.Name, author.LastModified),
+            ChangeType.Update => new AuthorUpdatedNotification(Guid.Empty, author.Id, author.Name, author.LastModified),
+            ChangeType.Delete => new AuthorDeletedNotification(Guid.Empty, author.Id, author.LastModified),
             _ => throw new ArgumentOutOfRangeException(nameof(effectiveChangeType))
         };
 
@@ -187,9 +187,9 @@ async Task HandlePublisherChangeAsync(PublisherProjection publisher, ChangeType
 
         IDomainEventNotification notification = effectiveChangeType switch
         {
-            ChangeType.Insert => new PublisherCreatedNotification(publisher.Id, publisher.Name, publisher.LastModified),
-            ChangeType.Update => new PublisherUpdatedNotification(publisher.Id, publisher.Name, publisher.LastModified),
-            ChangeType.Delete => new PublisherDeletedNotification(publisher.Id, publisher.LastModified),
+            ChangeType.Insert => new PublisherCreatedNotification(Guid.Empty, publisher.Id, publisher.Name, publisher.LastModified),
+            ChangeType.Update => new PublisherUpdatedNotification(Guid.Empty, publisher.Id, publisher.Name, publisher.LastModified),
+            ChangeType.Delete => new PublisherDeletedNotification(Guid.Empty, publisher.Id, publisher.LastModified),
             _ => throw new ArgumentOutOfRangeException(nameof(effectiveChangeType))
         };
 
@@ -202,7 +202,7 @@ async Task HandleBookStatisticsChangeAsync(BookStatistics stats, ChangeType _, C
 
         // Emit BookUpdated so clients refetch the book (including new stats)
         // Title is unknown here, but usually not critical for simple invalidation signals
-        IDomainEventNotification notification = new BookUpdatedNotification(stats.Id, "Statistics Updated", DateTimeOffset.UtcNow);
+        IDomainEventNotification notification = new BookUpdatedNotification(Guid.Empty, stats.Id, "Statistics Updated", DateTimeOffset.UtcNow);
 
         await NotifyAsync("Book", notification, token);
     }

src/Client/BookStore.Client/BookStoreEventsService.cs

@@ -14,6 +14,7 @@ public class BookStoreEventsService : IAsyncDisposable
 {
     readonly HttpClient _httpClient;
     readonly ILogger<BookStoreEventsService> _logger;
+    readonly Services.CorrelationService _correlationService;
     CancellationTokenSource? _cts;
     Task? _listenerTask;
 
@@ -34,10 +35,14 @@ public class BookStoreEventsService : IAsyncDisposable
         { "UserVerified", typeof(UserVerifiedNotification) }
     };
 
-    public BookStoreEventsService(HttpClient httpClient, ILogger<BookStoreEventsService> logger)
+    public BookStoreEventsService(
+        HttpClient httpClient,
+        ILogger<BookStoreEventsService> logger,
+        Services.CorrelationService correlationService)
     {
         _httpClient = httpClient;
         _logger = logger;
+        _correlationService = correlationService;
     }
 
     public void StartListening()
@@ -75,6 +80,11 @@ async Task ListenToStreamAsync(CancellationToken ct)
                         var notification = DeserializeNotification(item.EventType, item.Data);
                         if (notification != null)
                         {
+                            if (notification.EventId != Guid.Empty)
+                            {
+                                _correlationService.UpdateCausationId(notification.EventId.ToString());
+                            }
+
                             OnNotificationReceived?.Invoke(notification);
                         }
                     }

src/Client/BookStore.Client/ICreateAuthorEndpoint.cs

@@ -20,7 +20,7 @@ public partial interface ICreateAuthorEndpoint
     {
         [Headers("Content-Type: application/json")]
         [Post("/api/admin/authors")]
-        Task Execute([Body] CreateAuthorRequest body, [Header("api-version")] object api_version, [Header("Accept-Language")] object accept_Language, [Header("X-Correlation-ID")] object x_Correlation_ID, [Header("X-Causation-ID")] object x_Causation_ID, CancellationToken cancellationToken = default);
+        Task Execute([Body] CreateAuthorRequest body, [Header("api-version")] object api_version, [Header("Accept-Language")] object accept_Language, [Header("X-Correlation-ID")] object? x_Correlation_ID = null, [Header("X-Causation-ID")] object? x_Causation_ID = null, CancellationToken cancellationToken = default);
     }
 
 }

src/Client/BookStore.Client/ICreateBookEndpoint.cs

@@ -20,7 +20,7 @@ public partial interface ICreateBookEndpoint
     {
         [Headers("Content-Type: application/json")]
         [Post("/api/admin/books")]
-        Task CreateBookAsync([Body] CreateBookRequest body, [Header("api-version")] object api_version, [Header("Accept-Language")] object accept_Language, [Header("X-Correlation-ID")] object x_Correlation_ID, [Header("X-Causation-ID")] object x_Causation_ID, CancellationToken cancellationToken = default);
+        Task CreateBookAsync([Body] CreateBookRequest body, [Header("api-version")] object api_version, [Header("Accept-Language")] object accept_Language, [Header("X-Correlation-ID")] object? x_Correlation_ID = null, [Header("X-Causation-ID")] object? x_Causation_ID = null, CancellationToken cancellationToken = default);
     }
 
 }

src/Client/BookStore.Client/ICreateCategoryEndpoint.cs

@@ -20,7 +20,7 @@ public partial interface ICreateCategoryEndpoint
     {
         [Headers("Content-Type: application/json")]
         [Post("/api/admin/categories")]
-        Task Execute([Body] CreateCategoryRequest body, [Header("api-version")] object api_version, [Header("Accept-Language")] object accept_Language, [Header("X-Correlation-ID")] object x_Correlation_ID, [Header("X-Causation-ID")] object x_Causation_ID, CancellationToken cancellationToken = default);
+        Task Execute([Body] CreateCategoryRequest body, [Header("api-version")] object api_version, [Header("Accept-Language")] object accept_Language, [Header("X-Correlation-ID")] object? x_Correlation_ID = null, [Header("X-Causation-ID")] object? x_Causation_ID = null, CancellationToken cancellationToken = default);
     }
 
 }

src/Client/BookStore.Client/ICreatePublisherEndpoint.cs

@@ -20,7 +20,7 @@ public partial interface ICreatePublisherEndpoint
     {
         [Headers("Content-Type: application/json")]
         [Post("/api/admin/publishers")]
-        Task Execute([Body] CreatePublisherRequest body, [Header("api-version")] object api_version, [Header("Accept-Language")] object accept_Language, [Header("X-Correlation-ID")] object x_Correlation_ID, [Header("X-Causation-ID")] object x_Causation_ID, CancellationToken cancellationToken = default);
+        Task Execute([Body] CreatePublisherRequest body, [Header("api-version")] object api_version, [Header("Accept-Language")] object accept_Language, [Header("X-Correlation-ID")] object? x_Correlation_ID = null, [Header("X-Causation-ID")] object? x_Causation_ID = null, CancellationToken cancellationToken = default);
     }
 
 }

src/Client/BookStore.Client/IGetAllBooksAdminEndpoint.cs

@@ -19,7 +19,7 @@ namespace BookStore.Client
     public partial interface IGetAllBooksAdminEndpoint
     {
         [Get("/api/admin/books")]
-        Task GetAllBooksAdminAsync([Header("api-version")] object api_version, [Header("Accept-Language")] object accept_Language, [Header("X-Correlation-ID")] object x_Correlation_ID, [Header("X-Causation-ID")] object x_Causation_ID, CancellationToken cancellationToken = default);
+        Task GetAllBooksAdminAsync([Header("api-version")] object api_version, [Header("Accept-Language")] object accept_Language, [Header("X-Correlation-ID")] object? x_Correlation_ID = null, [Header("X-Causation-ID")] object? x_Causation_ID = null, CancellationToken cancellationToken = default);
     }
 
 }