Add xml docs, set package info.

Anthony Sneed · Anthony Sneed · commit 640e19275aee · 2021-04-26T18:28:58.000-05:00
diff --git a/reference-architecture/Common/Common.csproj b/reference-architecture/Common/Common.csproj
@@ -5,7 +5,7 @@
     </PropertyGroup>
 
     <ItemGroup>
-        <PackageReference Include="EventDriven.EventBus.Abstractions" Version="1.0.0-rc1" />
+        <PackageReference Include="EventDriven.EventBus.Abstractions" Version="1.0.0" />
     </ItemGroup>
 
 </Project>
diff --git a/reference-architecture/CustomerService/CustomerService.csproj b/reference-architecture/CustomerService/CustomerService.csproj
@@ -6,7 +6,7 @@
 
   <ItemGroup>
     <PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" Version="8.1.1" />
-    <PackageReference Include="EventDriven.EventBus.Dapr" Version="1.0.0-rc1" />
+    <PackageReference Include="EventDriven.EventBus.Dapr" Version="1.0.0" />
     <PackageReference Include="MongoDB.Driver" Version="2.12.2" />
     <PackageReference Include="Swashbuckle.AspNetCore" Version="6.1.3" />
     <PackageReference Include="URF.Core.Mongo" Version="3.1.3" />
diff --git a/reference-architecture/CustomerService/Domain/CustomerAggregate/CommandHandlers/CustomerCommandHandler.cs b/reference-architecture/CustomerService/Domain/CustomerAggregate/CommandHandlers/CustomerCommandHandler.cs
@@ -37,7 +37,7 @@ public CustomerCommandHandler(
         public async Task<CommandResult<Customer>> Handle(CreateCustomer command)
         {
             // Process command
-            _logger.LogInformation("Handling command: {commandName}", nameof(CreateCustomer));
+            _logger.LogInformation("Handling command: {CommandName}", nameof(CreateCustomer));
             var events = command.Customer.Process(command);
             
             // Apply events
@@ -54,7 +54,7 @@ public async Task<CommandResult<Customer>> Handle(CreateCustomer command)
         public async Task<CommandResult<Customer>> Handle(UpdateCustomer command)
         {
             // Compare shipping addresses
-            _logger.LogInformation("Handling command: {commandName}", nameof(UpdateCustomer));
+            _logger.LogInformation("Handling command: {CommandName}", nameof(UpdateCustomer));
             var existing = await _repository.Get(command.EntityId);
             var addressChanged = command.Customer.ShippingAddress != existing.ShippingAddress;
             
@@ -68,7 +68,7 @@ public async Task<CommandResult<Customer>> Handle(UpdateCustomer command)
                 if (addressChanged)
                 {
                     var shippingAddress = _mapper.Map<Integration.Models.Address>(entity.ShippingAddress);
-                    _logger.LogInformation("Publishing event: {eventName}", $"v1.{nameof(CustomerAddressUpdated)}");
+                    _logger.LogInformation("Publishing event: {EventName}", $"v1.{nameof(CustomerAddressUpdated)}");
                     await _eventBus.PublishAsync(
                         new CustomerAddressUpdated(entity.Id, shippingAddress),
                         null, "v1");
@@ -84,7 +84,7 @@ await _eventBus.PublishAsync(
         public async Task<CommandResult<Customer>> Handle(RemoveCustomer command)
         {
             // Persist entity
-            _logger.LogInformation("Handling command: {commandName}", nameof(RemoveCustomer));
+            _logger.LogInformation("Handling command: {CommandName}", nameof(RemoveCustomer));
             await _repository.Remove(command.EntityId);
             return new CommandResult<Customer>(CommandOutcome.Accepted);
         }
diff --git a/reference-architecture/OrderService/Domain/OrderAggregate/CommandHandlers/OrderCommandHandler.cs b/reference-architecture/OrderService/Domain/OrderAggregate/CommandHandlers/OrderCommandHandler.cs
@@ -29,7 +29,7 @@ public OrderCommandHandler(
         public async Task<CommandResult<Order>> Handle(CreateOrder command)
         {
             // Process command
-            _logger.LogInformation("Handling command: {commandName}", nameof(CreateOrder));
+            _logger.LogInformation("Handling command: {CommandName}", nameof(CreateOrder));
             var events = command.Order.Process(command);
             
             // Apply events
@@ -45,7 +45,7 @@ public async Task<CommandResult<Order>> Handle(CreateOrder command)
 
         public async Task<CommandResult<Order>> Handle(UpdateOrder command)
         {
-            _logger.LogInformation("Handling command: {commandName}", nameof(UpdateOrder));
+            _logger.LogInformation("Handling command: {CommandName}", nameof(UpdateOrder));
 
             try
             {
@@ -63,15 +63,15 @@ public async Task<CommandResult<Order>> Handle(UpdateOrder command)
         public async Task<CommandResult<Order>> Handle(RemoveOrder command)
         {
             // Persist entity
-            _logger.LogInformation("Handling command: {commandName}", nameof(RemoveOrder));
+            _logger.LogInformation("Handling command: {CommandName}", nameof(RemoveOrder));
             await _repository.RemoveOrder(command.EntityId);
             return new CommandResult<Order>(CommandOutcome.Accepted);
         }
 
         public async Task<CommandResult<Order>> Handle(ShipOrder command)
         {
             // Process command
-            _logger.LogInformation("Handling command: {commandName}", nameof(ShipOrder));
+            _logger.LogInformation("Handling command: {CommandName}", nameof(ShipOrder));
             var entity = await _repository.GetOrder(command.EntityId);
             if (entity == null) return new CommandResult<Order>(CommandOutcome.NotFound);
             var events = entity.Process(command);
@@ -97,7 +97,7 @@ public async Task<CommandResult<Order>> Handle(ShipOrder command)
         public async Task<CommandResult<Order>> Handle(CancelOrder command)
         {
             // Process command
-            _logger.LogInformation("Handling command: {commandName}", nameof(CancelOrder));
+            _logger.LogInformation("Handling command: {CommandName}", nameof(CancelOrder));
             var entity = await _repository.GetOrder(command.EntityId);
             if (entity == null) return new CommandResult<Order>(CommandOutcome.NotFound);
             var events = entity.Process(command);
diff --git a/reference-architecture/OrderService/Integration/EventHandlers/CustomerAddressUpdatedEventHandler.cs b/reference-architecture/OrderService/Integration/EventHandlers/CustomerAddressUpdatedEventHandler.cs
@@ -25,7 +25,7 @@ public CustomerAddressUpdatedEventHandler(IOrderRepository orderRepository,
 
         public override async Task HandleAsync(CustomerAddressUpdated @event)
         {
-            _logger.LogInformation("Handling CustomerAddressUpdated event.");
+            _logger.LogInformation("Handling CustomerAddressUpdated event");
             var orders = await _orderRepository.GetCustomerOrders(@event.CustomerId);
             foreach (var order in orders)
             {
diff --git a/reference-architecture/OrderService/OrderService.csproj b/reference-architecture/OrderService/OrderService.csproj
@@ -6,7 +6,7 @@
 
   <ItemGroup>
     <PackageReference Include="AutoMapper.Extensions.Microsoft.DependencyInjection" Version="8.1.1" />
-    <PackageReference Include="EventDriven.EventBus.Dapr" Version="1.0.0-rc1" />
+    <PackageReference Include="EventDriven.EventBus.Dapr" Version="1.0.0" />
     <PackageReference Include="MongoDB.Driver" Version="2.12.2" />
     <PackageReference Include="Swashbuckle.AspNetCore" Version="6.1.3" />
     <PackageReference Include="URF.Core.Mongo" Version="3.1.3" />
diff --git a/src/EventDriven.CQRS.Abstractions/Commands/Command.cs b/src/EventDriven.CQRS.Abstractions/Commands/Command.cs
@@ -2,32 +2,63 @@
 
 namespace EventDriven.CQRS.Abstractions.Commands
 {
+    /// <summary>
+    /// Represents a command.
+    /// </summary>
     public record Command : ICommand
     {
+        /// <inheritdoc />
         public Guid EntityId => default(Guid);
+
+        /// <inheritdoc />
         public string EntityEtag { get; set; }
+
+        /// <inheritdoc />
         public bool? EntityExists => false;
 
+        /// <summary>
+        /// Represents a Create command.
+        /// </summary>
+        /// <param name="EntityId">Represents the ID of the entity the command is in reference to.</param>
         public abstract record Create(
             Guid EntityId = default) : ICommand
         {
+            /// <inheritdoc />
             public string EntityEtag { get; set; }
+
+            /// <inheritdoc />
             public bool? EntityExists => false;
         }
 
+        /// <summary>
+        /// Represents an Update command.
+        /// </summary>
+        /// <param name="EntityId">Represents the ID of the entity the command is in reference to.</param>
+        /// <param name="EntityEtag">If provided, refers to the version of the entity to update.</param>
         public abstract record Update(
             Guid EntityId,
             string EntityEtag = null) : ICommand
         {
+            /// <inheritdoc />
             public string EntityEtag { get; set; } = EntityEtag;
+
+            /// <inheritdoc />
             public bool? EntityExists => true;
         }
 
+        /// <summary>
+        /// Represents a Remove command.
+        /// </summary>
+        /// <param name="EntityId">Represents the ID of the entity the command is in reference to.</param>
+        /// <param name="EntityEtag">If provided, refers to the version of the entity to update.</param>
         public abstract record Remove(
             Guid EntityId,
             string EntityEtag = null) : ICommand
         {
+            /// <inheritdoc />
             public string EntityEtag { get; set; } = EntityEtag;
+
+            /// <inheritdoc />
             public bool? EntityExists => true;
         }
     }
diff --git a/src/EventDriven.CQRS.Abstractions/Commands/CommandOutcome.cs b/src/EventDriven.CQRS.Abstractions/Commands/CommandOutcome.cs
@@ -1,18 +1,38 @@
 ﻿namespace EventDriven.CQRS.Abstractions.Commands
 {
+    /// <summary>
+    /// Outcome of a command.
+    /// </summary>
     public enum CommandOutcome
     {
-        /// only if the command was accepted
+        /// <summary>
+        /// Only if the command was accepted
+        /// </summary>
         Accepted,
-        /// if the command was rejected due to a conflict
+
+        /// <summary>
+        /// If the command was rejected due to a conflict.
+        /// </summary>
         Conflict,
-        /// if the command was invalid due to its parameters
+
+        /// <summary>
+        /// If the command was invalid due to its parameters.
+        /// </summary>
         InvalidCommand,
-        ///If the command was invalid due to the object state
+        
+        /// <summary>
+        /// If the command was invalid due to the object state.
+        /// </summary>
         InvalidState,
-        // Not handled
+
+        /// <summary>
+        /// Not handled.
+        /// </summary>
         NotHandled,
-        //Entity was not found
+
+        /// <summary>
+        /// Entity was not found.
+        /// </summary>
         NotFound
     }
 }
diff --git a/src/EventDriven.CQRS.Abstractions/Commands/CommandResult.cs b/src/EventDriven.CQRS.Abstractions/Commands/CommandResult.cs
@@ -5,28 +5,37 @@
 namespace EventDriven.CQRS.Abstractions.Commands
 {
     /// <summary>
-    /// Represents the result of dispatching a command
+    /// Represents the result of dispatching a command.
     /// </summary>
     public record CommandResult(
         CommandOutcome Outcome,
         IDictionary<string, string[]> Errors = null);
 
     /// <summary>
-    /// Represents the result of dispatching a command
+    /// Represents the result of dispatching a command.
     /// </summary>
     public record CommandResult<TEntity> : CommandResult
         where TEntity : Entity
     {
-        public List<TEntity> Entities { get; } = new List<TEntity>();
+        /// <summary>
+        /// Entities associated with the result.
+        /// </summary>
+        public List<TEntity> Entities { get; } = new();
 
+        /// <summary>
+        /// Entity associated with the result.
+        /// </summary>
         public TEntity Entity => Entities.FirstOrDefault();
 
+        /// <inheritdoc />
         public CommandResult(
             CommandOutcome outcome,
             params TEntity[] entities) : base(outcome)
         {
             foreach (var entity in entities) Entities.Add(entity);
         }
+
+        /// <inheritdoc />
         public CommandResult(
             CommandOutcome outcome,
             IDictionary<string, string[]> errors,
diff --git a/src/EventDriven.CQRS.Abstractions/Commands/ICommand.cs b/src/EventDriven.CQRS.Abstractions/Commands/ICommand.cs
@@ -3,7 +3,7 @@
 namespace EventDriven.CQRS.Abstractions.Commands
 {
     /// <summary>
-    /// Represents a command
+    /// An object that is sent to the domain for a state change which is handled by a command handler.
     /// </summary>
     public interface ICommand
     {
@@ -28,7 +28,6 @@ public interface ICommand
         /// <li>Otherwise, If the value is null, and the EntityEtag is null, no assertion for the entity existing or not will be made. </li>
         /// </ul> 
         /// </summary>
-        /// <value></value>
         bool? EntityExists { get; }
     }
 }
diff --git a/src/EventDriven.CQRS.Abstractions/Commands/ICommandProcessor.cs b/src/EventDriven.CQRS.Abstractions/Commands/ICommandProcessor.cs
@@ -4,16 +4,16 @@
 namespace EventDriven.CQRS.Abstractions.Commands
 {
     /// <summary>
-    /// Command handler.
+    /// Processes a command by generating one or more domain events.
     /// </summary>
     /// <typeparam name="TCommand">The type of command</typeparam>
     public interface ICommandProcessor<in TCommand> where TCommand : class, ICommand
     {
         /// <summary>
-        /// Process specified command by creating a domain event.
+        /// Process specified command by creating one or more domain events.
         /// </summary>
         /// <param name="command">The command to process.</param>
-        /// <returns>Domain events to apply.</returns>
+        /// <returns>Domain events resulting from the command.</returns>
         IEnumerable<IDomainEvent> Process(TCommand command);
     }
 }
diff --git a/src/EventDriven.CQRS.Abstractions/Entities/Entity.cs b/src/EventDriven.CQRS.Abstractions/Entities/Entity.cs
@@ -2,18 +2,32 @@
 
 namespace EventDriven.CQRS.Abstractions.Entities
 {
+    /// <inheritdoc />
     public abstract class Entity : IEntity
     {
+        /// <inheritdoc />
         public Guid Id { get; set; }
+
+        /// <inheritdoc />
         public long SequenceNumber { get; set; }
+
+        /// <inheritdoc />
         public string ETag { get; set; }
+
+        /// <inheritdoc />
         public EntityState State { get; set; } = EntityState.Active;
 
+        /// <summary>
+        /// Set entity state to Deleted.
+        /// </summary>
         protected void MarkDeleted()
         {
             State = EntityState.Deleted;
         }
 
+        /// <summary>
+        /// Set entity state to Frozen.
+        /// </summary>
         protected void Freeze()
         {
             State = EntityState.Frozen;
diff --git a/src/EventDriven.CQRS.Abstractions/Entities/EntityState.cs b/src/EventDriven.CQRS.Abstractions/Entities/EntityState.cs
@@ -1,9 +1,23 @@
 ﻿namespace EventDriven.CQRS.Abstractions.Entities
 {
+    /// <summary>
+    /// The state of an entity.
+    /// </summary>
     public enum EntityState
     {
+        /// <summary>
+        /// The entity is in an active state.
+        /// </summary>
         Active,
+
+        /// <summary>
+        /// The entity is in a frozen state.
+        /// </summary>
         Frozen,
+
+        /// <summary>
+        /// The entity is an a deleted state.
+        /// </summary>
         Deleted
     }
 }
diff --git a/src/EventDriven.CQRS.Abstractions/Entities/IEntity.cs b/src/EventDriven.CQRS.Abstractions/Entities/IEntity.cs
@@ -2,25 +2,25 @@
 
 namespace EventDriven.CQRS.Abstractions.Entities
 {
+    /// <summary>
+    /// A type that has an identity with behavior and state that can change over time.
+    /// </summary>
     public interface IEntity
     {
         /// <summary>
         /// The ID of the Entity.
         /// </summary>
-        /// <value></value>
         Guid Id { get; set; }
 
         /// <summary>
         /// The sequence number (equal to the highest event sequence number applied).
         /// </summary>
-        /// <value></value>
         long SequenceNumber { get; set; }
 
         /// <summary>
         /// Represents a unique ID that must change atomically with each store of the entity
         /// to its underlying storage medium.
         /// </summary>
-        /// <value></value>
         string ETag { get; set; }
 
         /// <summary>
diff --git a/src/EventDriven.CQRS.Abstractions/EventDriven.CQRS.Abstractions.csproj b/src/EventDriven.CQRS.Abstractions/EventDriven.CQRS.Abstractions.csproj
diff --git a/src/EventDriven.CQRS.Abstractions/Events/DomainEvent.cs b/src/EventDriven.CQRS.Abstractions/Events/DomainEvent.cs
diff --git a/src/EventDriven.CQRS.Abstractions/Events/Event.cs b/src/EventDriven.CQRS.Abstractions/Events/Event.cs
diff --git a/src/EventDriven.CQRS.Abstractions/Events/EventHandler.cs b/src/EventDriven.CQRS.Abstractions/Events/EventHandler.cs
diff --git a/src/EventDriven.CQRS.Abstractions/Events/IDomainEvent.cs b/src/EventDriven.CQRS.Abstractions/Events/IDomainEvent.cs
diff --git a/src/EventDriven.CQRS.Abstractions/Events/IEvent.cs b/src/EventDriven.CQRS.Abstractions/Events/IEvent.cs
diff --git a/src/EventDriven.CQRS.Abstractions/Events/IEventApplier.cs b/src/EventDriven.CQRS.Abstractions/Events/IEventApplier.cs

Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ public OrderCommandHandler(`
`29`	`29`	`public async Task<CommandResult<Order>> Handle(CreateOrder command)`
`30`	`30`	`{`
`31`	`31`	`// Process command`
`32`		`- _logger.LogInformation("Handling command: {commandName}", nameof(CreateOrder));`
	`32`	`+ _logger.LogInformation("Handling command: {CommandName}", nameof(CreateOrder));`
`33`	`33`	`var events = command.Order.Process(command);`
`34`	`34`
`35`	`35`	`// Apply events`
`@@ -45,7 +45,7 @@ public async Task<CommandResult<Order>> Handle(CreateOrder command)`
`45`	`45`
`46`	`46`	`public async Task<CommandResult<Order>> Handle(UpdateOrder command)`
`47`	`47`	`{`
`48`		`- _logger.LogInformation("Handling command: {commandName}", nameof(UpdateOrder));`
	`48`	`+ _logger.LogInformation("Handling command: {CommandName}", nameof(UpdateOrder));`
`49`	`49`
`50`	`50`	`try`
`51`	`51`	`{`
`@@ -63,15 +63,15 @@ public async Task<CommandResult<Order>> Handle(UpdateOrder command)`
`63`	`63`	`public async Task<CommandResult<Order>> Handle(RemoveOrder command)`
`64`	`64`	`{`
`65`	`65`	`// Persist entity`
`66`		`- _logger.LogInformation("Handling command: {commandName}", nameof(RemoveOrder));`
	`66`	`+ _logger.LogInformation("Handling command: {CommandName}", nameof(RemoveOrder));`
`67`	`67`	`await _repository.RemoveOrder(command.EntityId);`
`68`	`68`	`return new CommandResult<Order>(CommandOutcome.Accepted);`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`public async Task<CommandResult<Order>> Handle(ShipOrder command)`
`72`	`72`	`{`
`73`	`73`	`// Process command`
`74`		`- _logger.LogInformation("Handling command: {commandName}", nameof(ShipOrder));`
	`74`	`+ _logger.LogInformation("Handling command: {CommandName}", nameof(ShipOrder));`
`75`	`75`	`var entity = await _repository.GetOrder(command.EntityId);`
`76`	`76`	`if (entity == null) return new CommandResult<Order>(CommandOutcome.NotFound);`
`77`	`77`	`var events = entity.Process(command);`
`@@ -97,7 +97,7 @@ public async Task<CommandResult<Order>> Handle(ShipOrder command)`
`97`	`97`	`public async Task<CommandResult<Order>> Handle(CancelOrder command)`
`98`	`98`	`{`
`99`	`99`	`// Process command`
`100`		`- _logger.LogInformation("Handling command: {commandName}", nameof(CancelOrder));`
	`100`	`+ _logger.LogInformation("Handling command: {CommandName}", nameof(CancelOrder));`
`101`	`101`	`var entity = await _repository.GetOrder(command.EntityId);`
`102`	`102`	`if (entity == null) return new CommandResult<Order>(CommandOutcome.NotFound);`
`103`	`103`	`var events = entity.Process(command);`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ public CustomerAddressUpdatedEventHandler(IOrderRepository orderRepository,`
`25`	`25`
`26`	`26`	`public override async Task HandleAsync(CustomerAddressUpdated @event)`
`27`	`27`	`{`
`28`		`- _logger.LogInformation("Handling CustomerAddressUpdated event.");`
	`28`	`+ _logger.LogInformation("Handling CustomerAddressUpdated event");`
`29`	`29`	`var orders = await _orderRepository.GetCustomerOrders(@event.CustomerId);`
`30`	`30`	`foreach (var order in orders)`
`31`	`31`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`namespace EventDriven.CQRS.Abstractions.Commands`
`4`	`4`	`{`
`5`	`5`	`/// <summary>`
`6`		`- /// Represents a command`
	`6`	`+ /// An object that is sent to the domain for a state change which is handled by a command handler.`
`7`	`7`	`/// </summary>`
`8`	`8`	`public interface ICommand`
`9`	`9`	`{`
`@@ -28,7 +28,6 @@ public interface ICommand`
`28`	`28`	`/// <li>Otherwise, If the value is null, and the EntityEtag is null, no assertion for the entity existing or not will be made. </li>`
`29`	`29`	`/// </ul>`
`30`	`30`	`/// </summary>`
`31`		`- /// <value></value>`
`32`	`31`	`bool? EntityExists { get; }`
`33`	`32`	`}`
`34`	`33`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,16 +4,16 @@`
`4`	`4`	`namespace EventDriven.CQRS.Abstractions.Commands`
`5`	`5`	`{`
`6`	`6`	`/// <summary>`
`7`		`- /// Command handler.`
	`7`	`+ /// Processes a command by generating one or more domain events.`
`8`	`8`	`/// </summary>`
`9`	`9`	`/// <typeparam name="TCommand">The type of command</typeparam>`
`10`	`10`	`public interface ICommandProcessor<in TCommand> where TCommand : class, ICommand`
`11`	`11`	`{`
`12`	`12`	`/// <summary>`
`13`		`- /// Process specified command by creating a domain event.`
	`13`	`+ /// Process specified command by creating one or more domain events.`
`14`	`14`	`/// </summary>`
`15`	`15`	`/// <param name="command">The command to process.</param>`
`16`		`- /// <returns>Domain events to apply.</returns>`
	`16`	`+ /// <returns>Domain events resulting from the command.</returns>`
`17`	`17`	`IEnumerable<IDomainEvent> Process(TCommand command);`
`18`	`18`	`}`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,23 @@`
`1`	`1`	`namespace EventDriven.CQRS.Abstractions.Entities`
`2`	`2`	`{`
	`3`	`+ /// <summary>`
	`4`	`+ /// The state of an entity.`
	`5`	`+ /// </summary>`
`3`	`6`	`public enum EntityState`
`4`	`7`	`{`
	`8`	`+ /// <summary>`
	`9`	`+ /// The entity is in an active state.`
	`10`	`+ /// </summary>`
`5`	`11`	`Active,`
	`12`	`+`
	`13`	`+ /// <summary>`
	`14`	`+ /// The entity is in a frozen state.`
	`15`	`+ /// </summary>`
`6`	`16`	`Frozen,`
	`17`	`+`
	`18`	`+ /// <summary>`
	`19`	`+ /// The entity is an a deleted state.`
	`20`	`+ /// </summary>`
`7`	`21`	`Deleted`
`8`	`22`	`}`
`9`	`23`	`}`