Implemented distributed locking for the event outbox

framework/src/Volo.Abp.DistributedLocking/Volo.Abp.DistributedLocking.csproj

@@ -18,4 +18,8 @@
         <ProjectReference Include="..\Volo.Abp.Core\Volo.Abp.Core.csproj" />
     </ItemGroup>
 
+    <ItemGroup>
+      <PackageReference Include="DistributedLock.Core" Version="1.0.2" />
+    </ItemGroup>
+
 </Project>

framework/src/Volo.Abp.EventBus.Boxes/Volo.Abp.EventBus.Boxes.csproj

@@ -16,6 +16,7 @@
 
     <ItemGroup>
         <ProjectReference Include="..\Volo.Abp.BackgroundWorkers\Volo.Abp.BackgroundWorkers.csproj" />
+        <ProjectReference Include="..\Volo.Abp.DistributedLocking\Volo.Abp.DistributedLocking.csproj" />
         <ProjectReference Include="..\Volo.Abp.EventBus\Volo.Abp.EventBus.csproj" />
     </ItemGroup>
 

framework/src/Volo.Abp.EventBus.Boxes/Volo/Abp/EventBus/Boxes/OutboxSender.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Threading.Tasks;
+using Medallion.Threading;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Logging.Abstractions;
@@ -15,17 +16,22 @@ namespace Volo.Abp.EventBus.Boxes
         protected IServiceProvider ServiceProvider { get; }
         protected AbpTimer Timer { get; }
         protected IDistributedEventBus DistributedEventBus { get; }
+        protected IDistributedLockProvider DistributedLockProvider { get; }
         protected IEventOutbox Outbox { get; private set; }
+        protected OutboxConfig OutboxConfig { get; private set; }
+        protected string DistributedLockName => "Outbox_" + OutboxConfig.Name;
         public ILogger<OutboxSender> Logger { get; set; }
 
         public OutboxSender(
             IServiceProvider serviceProvider,
             AbpTimer timer,
-            IDistributedEventBus distributedEventBus)
+            IDistributedEventBus distributedEventBus, 
+            IDistributedLockProvider distributedLockProvider)
         {
             ServiceProvider = serviceProvider;
             Timer = timer;
             DistributedEventBus = distributedEventBus;
+            DistributedLockProvider = distributedLockProvider;
             Timer.Period = 2000; //TODO: Config?
             Timer.Elapsed += TimerOnElapsed;
             Logger = NullLogger<OutboxSender>.Instance;
@@ -33,6 +39,7 @@ namespace Volo.Abp.EventBus.Boxes
 
         public virtual Task StartAsync(OutboxConfig outboxConfig)
         {
+            OutboxConfig = outboxConfig;
             Outbox = (IEventOutbox)ServiceProvider.GetRequiredService(outboxConfig.ImplementationType);
             Timer.Start();
             return Task.CompletedTask;
@@ -51,25 +58,39 @@ namespace Volo.Abp.EventBus.Boxes
 
         protected virtual async Task RunAsync()
         {
-            while (true)
+            await using (var handle = await DistributedLockProvider.TryAcquireLockAsync(DistributedLockName))
             {
-                var waitingEvents = await Outbox.GetWaitingEventsAsync(1000); //TODO: Config?
+                if (handle != null)
-                if (waitingEvents.Count <= 0)
                 {
-                    break;
+                    Logger.LogDebug("Obtained the distributed lock: " + DistributedLockName);
-                }
+                    
+                    while (true)
+                    {
+                        var waitingEvents = await Outbox.GetWaitingEventsAsync(1000); //TODO: Config?
+                        if (waitingEvents.Count <= 0)
+                        {
+                            break;
+                        }
 
-                Logger.LogInformation($"Found {waitingEvents.Count} events in the outbox.");
+                        Logger.LogInformation($"Found {waitingEvents.Count} events in the outbox.");
                 
-                foreach (var waitingEvent in waitingEvents)
+                        foreach (var waitingEvent in waitingEvents)
-                {
+                        {
-                    await DistributedEventBus
+                            await DistributedEventBus
-                        .AsRawEventPublisher()
+                                .AsRawEventPublisher()
-                        .PublishRawAsync(waitingEvent.Id, waitingEvent.EventName, waitingEvent.EventData);
+                                .PublishRawAsync(waitingEvent.Id, waitingEvent.EventName, waitingEvent.EventData);
 
-                    await Outbox.DeleteAsync(waitingEvent.Id);
+                            await Outbox.DeleteAsync(waitingEvent.Id);
                     
-                    Logger.LogInformation($"Sent the event to the message broker with id = {waitingEvent.Id:N}");
+                            Logger.LogInformation($"Sent the event to the message broker with id = {waitingEvent.Id:N}");
+                        }
+                    }
+
+                    await Task.Delay(30000);
+                }
+                else
+                {
+                    Logger.LogDebug("Could not obtain the distributed lock: " + DistributedLockName);
                 }
             }
         }

test/DistEvents/DistDemoApp/DistDemoApp.csproj

@@ -6,6 +6,7 @@
     </PropertyGroup>
 
     <ItemGroup>
+        <PackageReference Include="DistributedLock.Redis" Version="1.0.1" />
         <PackageReference Include="Microsoft.Extensions.Hosting" Version="5.0.*" />
         <PackageReference Include="Serilog.Extensions.Hosting" Version="3.1.0" />
         <PackageReference Include="Serilog.Sinks.Async" Version="1.4.0" />

test/DistEvents/DistDemoApp/DistDemoAppModule.cs

@@ -1,4 +1,7 @@
+using Medallion.Threading;
+using Medallion.Threading.Redis;
 using Microsoft.Extensions.DependencyInjection;
+using StackExchange.Redis;
 using Volo.Abp.Autofac;
 using Volo.Abp.Domain.Entities.Events.Distributed;
 using Volo.Abp.EntityFrameworkCore;
@@ -21,6 +24,8 @@ namespace DistDemoApp
     {
         public override void ConfigureServices(ServiceConfigurationContext context)
         {
+            var configuration = context.Services.GetConfiguration();
+            
             context.Services.AddHostedService<MyProjectNameHostedService>();
             
             context.Services.AddAbpDbContext<TodoDbContext>(options =>
@@ -46,6 +51,12 @@ namespace DistDemoApp
                     config.UseDbContext<TodoDbContext>();
                 });
             });
+
+            context.Services.AddSingleton<IDistributedLockProvider>(sp =>
+            {
+                var connection = ConnectionMultiplexer.Connect(configuration["Redis:Configuration"]);
+                return new RedisDistributedSynchronizationProvider(connection.GetDatabase());
+            });
         }
     }
 }

test/DistEvents/DistDemoApp/appsettings.json

@@ -12,5 +12,8 @@
             "ClientName": "DistDemoApp",
             "ExchangeName": "DistDemo"
         }
+    },
+    "Redis": {
+        "Configuration": "127.0.0.1"
     }
 }