Merge pull request #17 from ardalis/ardalis/add-domain-event-interfaces

Ardalis/add domain event interfaces

Author: ardalis

src/Ardalis.SharedKernel/Ardalis.SharedKernel.csproj

@@ -13,10 +13,9 @@
     <RepositoryUrl>https://github.com/ardalis/Ardalis.SharedKernel</RepositoryUrl>
     <PackageTags>DDD;Shared Kernel;SharedKernel;Domain-Driven Design;Repository;Specification;ValueObject;Value Object;Ardalis;Clean;Clean Architecture;Clean Architecture Template</PackageTags>
     <PackageIcon>icon.png</PackageIcon>
-    <Version>4.0.0</Version>
+    <Version>4.1.0</Version>
     <PackageReleaseNotes>
-      * Swapped out MediatR for Mediator Souregenerator and Mediator.Abstractions
-      * Updated dependencies to latest versions
+      * Added IDomainEvent and related interfaces
     </PackageReleaseNotes>
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
     <EmbedUntrackedSources>true</EmbedUntrackedSources>

src/Ardalis.SharedKernel/DomainEventBase.cs

@@ -1,12 +1,10 @@
-using Mediator;
-
-namespace Ardalis.SharedKernel;
+namespace Ardalis.SharedKernel;
 
 /// <summary>
 /// A base type for domain events. Depends on Mediator INotification.
 /// Includes DateOccurred which is set on creation.
 /// </summary>
-public abstract class DomainEventBase : INotification
+public abstract class DomainEventBase : IDomainEvent
 {
   public DateTime DateOccurred { get; protected set; } = DateTime.UtcNow;
 }

src/Ardalis.SharedKernel/HasDomainEventsBase.cs

@@ -4,9 +4,9 @@ namespace Ardalis.SharedKernel;
 
 public abstract class HasDomainEventsBase : IHasDomainEvents
 {
-  private readonly List<DomainEventBase> _domainEvents = new();
+  private readonly List<IDomainEvent> _domainEvents = new();
   [NotMapped]
-  public IReadOnlyCollection<DomainEventBase> DomainEvents => _domainEvents.AsReadOnly();
+  public IReadOnlyCollection<IDomainEvent> DomainEvents => _domainEvents.AsReadOnly();
 
   protected void RegisterDomainEvent(DomainEventBase domainEvent) => _domainEvents.Add(domainEvent);
   public void ClearDomainEvents() => _domainEvents.Clear();

src/Ardalis.SharedKernel/IDomainEvent.cs

@@ -0,0 +1,8 @@
+using Mediator;
+
+namespace Ardalis.SharedKernel;
+
+public interface IDomainEvent : INotification
+{
+  DateTime DateOccurred { get; }
+}

src/Ardalis.SharedKernel/IDomainEventHandler.cs

@@ -0,0 +1,7 @@
+using Mediator;
+
+namespace Ardalis.SharedKernel;
+
+public interface IDomainEventHandler<T> : INotificationHandler<T> where T : IDomainEvent
+{
+}

src/Ardalis.SharedKernel/IHasDomainEvents.cs

@@ -2,6 +2,6 @@
 
 public interface IHasDomainEvents
 {
-  IReadOnlyCollection<DomainEventBase> DomainEvents { get; }
+  IReadOnlyCollection<IDomainEvent> DomainEvents { get; }
   void ClearDomainEvents();
 }

…edKernel/MediatRDomainEventDispatcher.cs …dKernel/MediatorDomainEventDispatcher.cssrc/Ardalis.SharedKernel/MediatRDomainEventDispatcher.cs renamed to src/Ardalis.SharedKernel/MediatorDomainEventDispatcher.cs src/Ardalis.SharedKernel/MediatRDomainEventDispatcher.cs renamed to src/Ardalis.SharedKernel/MediatorDomainEventDispatcher.cs

@@ -20,10 +20,10 @@ public async Task DispatchAndClearEvents(IEnumerable<IHasDomainEvents> entitiesW
     {
       if (entity is IHasDomainEvents hasDomainEvents)
       {
-        DomainEventBase[] events = hasDomainEvents.DomainEvents.ToArray();
+        IDomainEvent[] events = hasDomainEvents.DomainEvents.ToArray();
         hasDomainEvents.ClearDomainEvents();
 
-        foreach (DomainEventBase domainEvent in events)
+        foreach (var domainEvent in events)
           await _mediator.Publish(domainEvent).ConfigureAwait(false);
       }
       else

src/Ardalis.SharedKernel/ValueObject.cs

@@ -4,6 +4,8 @@
 /// NOTE: Use `readonly record struct` for most cases in C# 10+
 /// See: https://nietras.com/2021/06/14/csharp-10-record-struct/
 /// 
+/// Alternately consider using Vogen
+/// 
 /// For this class implementation, reference:
 /// See: https://enterprisecraftsmanship.com/posts/value-object-better-implementation/
 /// </summary>

tests/Ardalis.SharedKernel.UnitTests/MediatorDomainEventDispatcherTests/DispatchAndClearEvents.cs

@@ -4,7 +4,7 @@
 
 namespace Ardalis.SharedKernel.UnitTests.MediatorDomainEventDispatcherTests;
 
-public class DispatchAndClearEvents : INotificationHandler<DispatchAndClearEvents.TestDomainEvent>
+public class DispatchAndClearEvents : IDomainEventHandler<DispatchAndClearEvents.TestDomainEvent>
 {
   public class TestDomainEvent : DomainEventBase { }
   private class TestEntity : EntityBase
@@ -29,7 +29,7 @@ public async Task CallsPublishAndClearDomainEvents()
     await domainEventDispatcher.DispatchAndClearEvents(new List<EntityBase> { entity });
 
     // Assert
-    mediatorMock.Verify(m => m.Publish(It.IsAny<DomainEventBase>(), It.IsAny<CancellationToken>()), Times.Once);
+    mediatorMock.Verify(m => m.Publish(It.IsAny<IDomainEvent>(), It.IsAny<CancellationToken>()), Times.Once);
     entity.DomainEvents.Should().BeEmpty();
   }
 

tests/Ardalis.SharedKernel.UnitTests/MediatorDomainEventDispatcherTests/DispatchAndClearEventsWithGuidId.cs

@@ -5,7 +5,7 @@
 
 namespace Ardalis.SharedKernel.UnitTests.MediatRDomainEventDispatcherTests;
 
-public class DispatchAndClearEventsWithGuidId : INotificationHandler<DispatchAndClearEventsWithGuidId.TestDomainEvent>
+public class DispatchAndClearEventsWithGuidId : IDomainEventHandler<DispatchAndClearEventsWithGuidId.TestDomainEvent>
 {
   public class TestDomainEvent : DomainEventBase { }
   private class TestEntity : EntityBase<Guid>
@@ -30,7 +30,7 @@ public async Task CallsPublishAndClearDomainEvents()
     await domainEventDispatcher.DispatchAndClearEvents(new List<EntityBase<Guid>> { entity });
 
     // Assert
-    mediatorMock.Verify(m => m.Publish(It.IsAny<DomainEventBase>(), It.IsAny<CancellationToken>()), Times.Once);
+    mediatorMock.Verify(m => m.Publish(It.IsAny<IDomainEvent>(), It.IsAny<CancellationToken>()), Times.Once);
     entity.DomainEvents.Should().BeEmpty();
   }