(#130) Transactional Outbox Pattern

Author: phongnguyend

src/Microservices/Common/ClassifiedAds.Application/ApplicationServicesExtensions.cs

@@ -13,7 +13,7 @@ public static IServiceCollection AddApplicationServices(this IServiceCollection
         {
             services.AddScoped<Dispatcher>();
 
-            services.AddSingleton<IDomainEvents, DomainEvents>()
+            services.AddScoped<IDomainEvents, DomainEvents>()
                 .AddScoped(typeof(ICrudService<>), typeof(CrudService<>));
 
             return services;

src/Microservices/Common/ClassifiedAds.Domain/Events/DomainEvents.cs

@@ -11,7 +11,7 @@ namespace ClassifiedAds.Domain.Events
     public class DomainEvents : IDomainEvents
     {
         private static List<Type> _handlers = new List<Type>();
-        private static IServiceProvider _serviceProvider;
+        private IServiceProvider _serviceProvider;
 
         public static void RegisterHandlers(Assembly assembly, IServiceCollection services)
         {

src/Microservices/Services.AuditLog/ClassifiedAds.Services.AuditLog.Api/ClassifiedAds.Services.AuditLog.Api.csproj

@@ -3,6 +3,7 @@
 	<PropertyGroup>
 		<TargetFramework>net6.0</TargetFramework>
 		<CodeAnalysisRuleSet>ClassifiedAds.ruleset</CodeAnalysisRuleSet>
+		<UserSecretsId>c0d90214-b332-43c7-baa7-9a7ebf96ae71</UserSecretsId>
 	</PropertyGroup>
 
 	<ItemGroup>

src/Microservices/Services.AuditLog/ClassifiedAds.Services.AuditLog.Api/Startup.cs

@@ -1,6 +1,10 @@
+using ClassifiedAds.Application;
+using ClassifiedAds.Domain.Infrastructure.MessageBrokers;
 using ClassifiedAds.Infrastructure.DistributedTracing;
 using ClassifiedAds.Infrastructure.Web.Filters;
 using ClassifiedAds.Services.AuditLog.ConfigurationOptions;
+using ClassifiedAds.Services.AuditLog.DTOs;
+using ClassifiedAds.Services.AuditLog.Entities;
 using Microsoft.AspNetCore.Authentication.JwtBearer;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
@@ -84,6 +88,8 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
                 app.UseDeveloperExceptionPage();
             }
 
+            RunMessageBrokerReceivers(app.ApplicationServices.CreateScope().ServiceProvider);
+
             app.UseRouting();
 
             app.UseCors("AllowAnyOrigin");
@@ -96,5 +102,25 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
                 endpoints.MapControllers();
             });
         }
+
+        private void RunMessageBrokerReceivers(IServiceProvider serviceProvider)
+        {
+            var auditLogCreatedEventReceiver = serviceProvider.GetService<IMessageReceiver<AuditLogCreatedEvent>>();
+
+            auditLogCreatedEventReceiver?.Receive(async (data, metaData) =>
+            {
+                try
+                {
+                    using (var scope = serviceProvider.CreateScope())
+                    {
+                        var dispatcher = scope.ServiceProvider.GetRequiredService<Dispatcher>();
+                        data.AuditLog.Id = Guid.Empty;
+                        await dispatcher.DispatchAsync(new AddOrUpdateEntityCommand<AuditLogEntry>(data.AuditLog));
+                    }
+                }
+                catch (Exception ex)
+                { }
+            });
+        }
     }
 }

src/Microservices/Services.AuditLog/ClassifiedAds.Services.AuditLog.Api/appsettings.json

@@ -31,6 +31,27 @@
     }
   },
   "AllowedHosts": "*",
+  "MessageBroker": {
+    "Provider": "Fake",
+    "RabbitMQ": {
+      "HostName": "localhost",
+      "UserName": "guest",
+      "Password": "guest",
+      "ExchangeName": "amq.direct",
+      "RoutingKeys": {
+        "AuditLogCreatedEvent": "classifiedadds_auditlogcreated"
+      },
+      "QueueNames": {
+        "AuditLogCreatedEvent": "classifiedadds_auditlogcreated"
+      }
+    },
+    "AzureQueue": {
+      "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=xxx;AccountKey=xxx;EndpointSuffix=core.windows.net",
+      "QueueNames": {
+        "AuditLogCreatedEvent": "classifiedadds-auditlogcreated"
+      }
+    }
+  },
   "Services": {
     "AuditLog": {
       "Grpc": "https://localhost:5002"

src/Microservices/Services.AuditLog/ClassifiedAds.Services.AuditLog.Grpc/ClassifiedAds.Services.AuditLog.Grpc.csproj

@@ -2,6 +2,7 @@
 
   <PropertyGroup>
     <TargetFramework>net6.0</TargetFramework>
+	<UserSecretsId>c0d90214-b332-43c7-baa7-9a7ebf96ae71</UserSecretsId>
   </PropertyGroup>
 
   <ItemGroup>

src/Microservices/Services.AuditLog/ClassifiedAds.Services.AuditLog.Grpc/appsettings.json

@@ -42,6 +42,27 @@
       }
     }
   },
+  "MessageBroker": {
+    "Provider": "Fake",
+    "RabbitMQ": {
+      "HostName": "localhost",
+      "UserName": "guest",
+      "Password": "guest",
+      "ExchangeName": "amq.direct",
+      "RoutingKeys": {
+        "AuditLogCreatedEvent": "classifiedadds_auditlogcreated"
+      },
+      "QueueNames": {
+        "AuditLogCreatedEvent": "classifiedadds_auditlogcreated"
+      }
+    },
+    "AzureQueue": {
+      "ConnectionString": "DefaultEndpointsProtocol=https;AccountName=xxx;AccountKey=xxx;EndpointSuffix=core.windows.net",
+      "QueueNames": {
+        "AuditLogCreatedEvent": "classifiedadds-auditlogcreated"
+      }
+    }
+  },
   "Services": {
     "AuditLog": {
       "Grpc": "https://localhost:5002"

src/Microservices/Services.AuditLog/ClassifiedAds.Services.AuditLog/AuditLogModuleServiceCollectionExtensions.cs

@@ -1,11 +1,10 @@
 using ClassifiedAds.Domain.Repositories;
 using ClassifiedAds.Services.AuditLog.ConfigurationOptions;
+using ClassifiedAds.Services.AuditLog.DTOs;
 using ClassifiedAds.Services.AuditLog.Entities;
 using ClassifiedAds.Services.AuditLog.Repositories;
-using ClassifiedAds.Services.AuditLog.Services;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.EntityFrameworkCore;
-using System;
 using System.Reflection;
 
 namespace Microsoft.Extensions.DependencyInjection
@@ -21,13 +20,14 @@ public static IServiceCollection AddAuditLogModule(this IServiceCollection servi
                     sql.MigrationsAssembly(appSettings.ConnectionStrings.MigrationsAssembly);
                 }
             }))
-                .AddScoped<IRepository<AuditLogEntry, Guid>, Repository<AuditLogEntry, Guid>>()
-                .AddScoped(typeof(IAuditLogService), typeof(AuditLogService));
+                .AddScoped<IRepository<AuditLogEntry, Guid>, Repository<AuditLogEntry, Guid>>();
 
             services.AddMessageHandlers(Assembly.GetExecutingAssembly());
 
             services.AddAuthorizationPolicies(Assembly.GetExecutingAssembly());
 
+            services.AddMessageBusReceiver<AuditLogCreatedEvent>(appSettings.MessageBroker);
+
             return services;
         }
 

src/Microservices/Services.AuditLog/ClassifiedAds.Services.AuditLog/DTOs/AuditLogCreatedEvent.cs

@@ -0,0 +1,9 @@
+using ClassifiedAds.Services.AuditLog.Entities;
+
+namespace ClassifiedAds.Services.AuditLog.DTOs
+{
+    public class AuditLogCreatedEvent
+    {
+        public AuditLogEntry AuditLog { get; set; }
+    }
+}