Changes to make LocalDistributedEventBus able to use outbox/inbox patterns

[NunoGamaVieira]

Description

The existing LocalDistributedEventBus doesn't make use of the outbox/inbox patterns if these are enabled.
With these changes, we make it possible to use those mechanisms while still publishing through LocalEventBus.

Resolve #22053

Checklist

• I fully tested it as developer / designer and created unit / integration tests
• I documented it (or no need to document or I will create a separate documentation issue)

[CLAassistant]

All committers have signed the CLA.

[maliming]

@hikalkan Do you think the LocalDistributedEventBus should support outbox/inbox?

[hikalkan]

@maliming Yes, it should support. This is necessary for modular monolith applications where each module has a separate physical database.

[maliming]

I will add a test app to make sure it works as expected

[maliming]

hi @hikalkan

If this is not a design, you can merge this PR, I have tested it in a real application.

---

You have return true if an event has been added to one of Outbox, but Inbox has a different logic. It will try to add events to all Inboxes.

I changed the code to add an event to all inboxes/outboxes. 95bd271

await eventOutbox.EnqueueAsync(outgoingEventInfo);
return true;

abp/framework/src/Volo.Abp.EventBus/Volo/Abp/EventBus/Distributed/DistributedEventBusBase.cs

Lines 120 to 143 in 489c74f

	foreach (var outboxConfig in AbpDistributedEventBusOptions.Outboxes.Values.OrderBy(x => x.Selector is null))
	{
	if (outboxConfig.Selector == null || outboxConfig.Selector(eventType))
	{
	var eventOutbox = (IEventOutbox)unitOfWork.ServiceProvider.GetRequiredService(outboxConfig.ImplementationType);
	var eventName = EventNameAttribute.GetNameOrDefault(eventType);
	await OnAddToOutboxAsync(eventName, eventType, eventData);
	var outgoingEventInfo = new OutgoingEventInfo(
	GuidGenerator.Create(),
	eventName,
	Serialize(eventData),
	Clock.Now
	);
	var correlationId = CorrelationIdProvider.Get();
	if (correlationId != null)
	{
	outgoingEventInfo.SetCorrelationId(correlationId);
	}
	await eventOutbox.EnqueueAsync(outgoingEventInfo);
	return true;

abp/framework/src/Volo.Abp.EventBus/Volo/Abp/EventBus/Distributed/DistributedEventBusBase.cs

Lines 167 to 197 in 489c74f

	using (var scope = ServiceScopeFactory.CreateScope())
	{
	foreach (var inboxConfig in AbpDistributedEventBusOptions.Inboxes.Values.OrderBy(x => x.EventSelector is null))
	{
	if (inboxConfig.EventSelector == null || inboxConfig.EventSelector(eventType))
	{
	var eventInbox =
	(IEventInbox)scope.ServiceProvider.GetRequiredService(inboxConfig.ImplementationType);
	if (!messageId.IsNullOrEmpty())
	{
	if (await eventInbox.ExistsByMessageIdAsync(messageId!))
	{
	continue;
	}
	}
	var incomingEventInfo = new IncomingEventInfo(
	GuidGenerator.Create(),
	messageId!,
	eventName,
	Serialize(eventData),
	Clock.Now
	);
	incomingEventInfo.SetCorrelationId(correlationId!);
	await eventInbox.EnqueueAsync(incomingEventInfo);
	}
	}
	}
	return true;

[codecov]

Codecov Report

Attention: Patch coverage is 44.73684% with 63 lines in your changes missing coverage. Please review.

Project coverage is 52.02%. Comparing base (0a1c637) to head (fea2a39).
Report is 3 commits behind head on dev.

Files with missing lines	Patch %	Lines
...p/EventBus/Distributed/LocalDistributedEventBus.cs	43.01%	51 Missing and 2 partials ⚠️
...bp/EventBus/Distributed/DistributedEventBusBase.cs	50.00%	4 Missing ⚠️
....EventBus/Volo/Abp/EventBus/Local/LocalEventBus.cs	0.00%	3 Missing ⚠️
...ntBus/Volo/Abp/EventBus/Local/NullLocalEventBus.cs	0.00%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##              dev   #21965      +/-   ##
==========================================
+ Coverage   52.01%   52.02%   +0.01%     
==========================================
  Files        3183     3184       +1     
  Lines      102337   102380      +43     
  Branches     7773     7780       +7     
==========================================
+ Hits        53227    53260      +33     
- Misses      47462    47469       +7     
- Partials     1648     1651       +3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.