Lewee.Application 0.6.0

Lewee.Application

This package assists with building the application layer of an application using domain-driven design principles.

Dependencies

• FluentValidation
• Mediatr
• Serilog
• Lewee.Domain
• Lewee.Contracts

Configuration

To use this packages add the following lines to your service configuration of your application (services in the code below is Microsoft.Extensions.DependencyInjection.ServicesCollection).

services.AddApplication(typeof(ApplicationLayerClass).Assembly, typeof(DomainLayerClass).Assembly);
services.AddPipelineBehaviors();

The assembly parameters of AddApplication are used to configure Mediatr (it will scan these assemblies for request and notification classes/handlers). In addition to this, the application layer assembly will by used to configure FluentValidation (it will use this assembly to scan for validators).

AddPipelineBehaviors adds the Mediatr request pipelines behaviors listed in the Pipeline Behaviors section. This only needs to be added once per application/solution; not for once each project that uses this package.

Additional behaviors can be added as parameters to AddPipelineBehaviors.

Mediation

Mediatr is used to assist with mediation, which allows the presentation layer of the application to have less dependencies e.g. API controller classes only need to inject the IMediator interface to handle web requests.

There a several interfaces that add a further layer of command-query responsibility separation (CQRS) on top of the IRequest interface in Mediatr.

• IQuery
• ICommand
• ITenantedRequest

IQuery & ICommand

Both IQuery and ICommand implement IApplicationRequest, which has a CorrelationId Guid property.

As mentioned in the Pipeline Behaviors section, the CorrelationId property is used in the CorelationIdLoggingBehavior to decorate the logs with the correlation ID for every Mediatr request that implements IApplicationRequest.

Query handlers that handle IQuery input types are required to have QueryResult as the return type. QueryResult has a type parameter that is used to specify the query data type.

Command handlers that handle ICommand input types are required to return a CommandResult.

Both QueryResult and CommandResult inherit from Result, which has the following properties.

• IsSuccess
  • Whether the request was successful.
• Status
  • An ResultStatus enum used to specify the type of result.
• Errors
  • A dictionary keyed by request property for any errors encountered

Sample Code

Query

Command

ITenantRequest

ITenantedRequest has a TenantId Guid property used to specify the tenant ID for multi-tenanted applications.

As mentioned in the Pipeline Behaviors section, the TenantId property is used in the TenantLoggingBehavior to decorate the logs with tenant ID for every Mediatr request that implements ITenantedRequest.

Pipeline Behaviors

• CorelationIdLoggingBehavior
  • Adds a CorrelationId structured logging property for every request. Uses CorrelationId property if the request implemenats IApplicationRequest, otherwise it generates a new GUID.
• DomainExceptionBehavior
  • Catches DomainException, which is defined in the Lewee.Domain package, and returns a failure result.
• FailureLoggingBehavior
  • Checks the Status of requests that have Result return types and logs an error if there was an unexpected failure, or an information log if there was domain/validation failure.
• PerformanceLoggingBehavior
  • Uses Serilog's BeginTimedOperation functionality to log the time taken to execute the request.
• TenantLoggingBehavior
  • Adds a TenantId structured logging property for every request that implements ITenantedRequest.
• UnhandledExceptionBehavior
  • Catches unhandled exceptions and logs them as errors
• ValidationBehavior
  • Executes FluentValidation validators for the request and returns a CommandResult with the errors dictionary populated if there are validation errors found, otherwise the rest of the pipeline is executed.

ClientEvent Notification

The ClientEvent can be published via Mediatr.IMediator.Publish to send a SignalR event to the a client application.

Sample

Client Event.