Real-world open-source project based on .NET 6 with DDD, ES, CQRS and Testing concepts

[hamed-shirbandi]

Hello to the community.

I would like to introduce a free and open-source project named TaskoMask that I have been working on it for about 2 years.
It is based on .NET 6 with Microservices, DDD, CQRS, Event Sourcing and Testing Concepts.
There are some documentations you can use to learn more about it. Also, the project is online and you can see how the things work.

Design

• Onion Architecture

  click for details

  • Architecture was Onion until this last commit

• Clean Architecture

• Vertical Slice Architecture

• Feature Folder Structure

• Monolithic Architecture

  click for details

  • Architecture was Monolithic until this last commit

• Microservices Architecture

  click for details

  • Strangler application pattern
  • Decompose by subdomain
  • Database per service
  • Saga
  • API Composition
  • Docker
  • Docker-Compose
  • Kubernetes
  • Messaging : MassTransit (RabbitMQ)
  • Remote Procedure Call : Grpc.AspNetCore
  • Idempotent Consumer
  • API Gateway : Ocelot
  • Backend for front-end
  • Service discovery : Kubernetes - Consul
  • Circuit Breaker : Polly
  • Log aggregation : Serilog - Seq
  • Application metrics : Opentelemetry-dotnet - Prometheus
  • Distributed tracing : Opentelemetry-dotnet - Jaeger
  • Health check API : AspNetCore.HealthChecks
  • IDP : DuendeSoftware IdentityServer

• Testing (TDD & BDD)

  click for details

  • Unit Testing : xUnit, FluenAssertion, NSubstitute
  • Integration Testing
  • API Testing
  • UI Testing: Selenium
  • Acceptance Testing : Gherkin, SpecFlow
  • Screenplay Pattern : Suzianna
  • Well written tests organized in :
    • Business Rule Layer
    • Business Flow Layer
    • Technical Layer
  • Object Mother Pattern
  • Test Data Builder
  • Test Hooks
  • Test Doubles
  • Dummy
  • Stub
  • Mock
  • Teardown
    • Sandbox
  • Fixture Management
    • Fresh
    • Shared
    • Transient
    • Persistent
  • Verification
    • State Verification
    • Output/Value Verification
    • Interaction/Behavior Verification

• DDD

  click for details

  • Rich Domain Model (for core domain)
  • Anemic Domain Model (for less important subdomains)
  • Aggregate
  • Value Object
  • Domain Event
  • Domain Service
  • Always Valid Domain Model
  • Invariants
  • Specification
  • Factory Method
  • Optimistic Concurrency
  • Separate Domain Model and Data Model

• CQRS

  click for details

  • Separate Read and Write Model
  • Separate Read Side DB and Write Side DB

• Use Case Driven Development

• Event Sourcing

• Unit of Work

• Repository

• Notification

Implementation

• Back-end:

  click for details

  • .Net 6
  • C#
  • ASP.NET Web API
  • ASP.NET MVC
  • ASP.NET Identity
  • MongoDB
  • Redis
  • Ocelot : .NET core API Gateway
  • DuendeSoftware IdentityServer : OpenID Connect and OAuth 2.x framework for ASP.NET Core
  • MassTransit : a framework on top of message transports such as RabbitMQ
  • xUnit : testing framework
  • FluenAssertion : write fluent assertions
  • NSubstitute : to make test double (Mock, stub, fake, spy)
  • Gherkin : use native language to describe test cases
  • SpecFlow : turns Gherkin scenarios into automated tests
  • Suzianna : writing acceptance tests, using Screenplay Pattern
  • Selenium : supporting browser automation
  • MediatR : simple mediator implementation
  • Grpc.AspNetCore : gRPC library for ASP.NET Core
  • AutoMapper : an object-object mapper
  • FluentValidation : building strongly-typed validation rules
  • Swagger : expose Swagger JSON endpoints from APIs
  • Serilog : provides diagnostic logging
  • AspNetCore.HealthChecks : ASP.NET Core Health Check
  • MvcPagedList.Core : easily paging in ASP.NET Core MVC
  • EasyCaching : caching library

• Front-end:

  click for details

  • Blazor
    • Blazor Server (last commit)
      • Cookie Authentication without ASP.NET Identity
    • Blazor WebAssembly (standalone)
      • JWT Authentication
    • Comunication between components
    • Local Storage
    • Consume REST API
    • Retry using HttpClientRetryHelper
    • Handle Drag and Drop
    • Using Modal, Toast, etc.
  • .HTML
  • CSS
  • JavaScript
  • JQuery
  • Bootstrap
  • Jquery.noty
  • Chart.js

• Some other Features:

  click for details

  • Caching Behavior using Pipeline Pattern
  • Validation Behavior using Pipeline Pattern (Check both Fluent Validation and Data Annotation Validation)
  • Event Storing Behavior using Pipeline Pattern
  • Exception Handling
  • Cookie Authentication
  • JWT Authentication
  • Role Permission Base User Management without ASP.NET Identity
  • Swagger UI with JWT Support

I would appreciate any support, contribute, help and advice ❤️🙏

[valentinajemuovic]

Thanks @hamed-shirbandi for your iniative and for making this GitHub project.

I have some questions regarding Libraries & Presentation:

1-Infrastructure

Infrastructure.CrossCutting

• What are the pros and cons of having interface IInMemoryBus vs just IBus?
• How did you choose to use IMappingAction compared to using just Profile? (I ask this since for me Profile was enough in the past)

Infrastructure.Data

• How did you decide to make the data generators here, is this just some sample data used for demos?
• What's the purpose of IMongoDbContext interface what is it abstracting?
• How did you decide to have IBaseRepository versus having separate like IActivityRepository? I see the expectation that then all the repositories will have the same CRUD operations.

3-Domain

Domain

• How did you decide to make public setters on the domain entities? Also what if someone sets invalid values?
• I noticed base.SetId(id), what about the possiblity of calling the base constructor?
• What is the purpose of SetAsDeleted(), SetAsRecycled(), SetAsUpdated()?

Domain.Core

• How did you decide to put JSonIgnore in the DomainEvent, compared to putting it into infrastructure?
• In the code there is DateTime.Now in the DomainEvent, so this would make the test non-deterministic, how do you handle this? (I ask this since I stopped using DateTime.Now in code directly, instead I have a IDateTimeService)

Presentation

UserPanelAPI

• BoardController - I see BoardInsertDto used for both Create and Update, do you always do it that way?
• In the route for HttpPut for BoardController.Update, would you use route parameters for the id?

[hamed-shirbandi]

Thanks @valentinacupac for the time that you spent on my repository. I really appreciate it.
I got so happy for your feedbacks and I will consider all your advices.

Here is some explanation about the questions:

What are the pros and cons of having interface IInMemoryBus vs just IBus?

I just like the contributors to know there is just an in-memory bus to sending messages when they see the IInMemoryBus is injected as a dependency. If I add new one, then it is better to use IBus as you said.

How did you choose to use IMappingAction compared to using just Profile?

MappingAction is used when you need to inject some dependencies like IConfiguration to be used in mapping. Profile doesn't support it.

How did you decide to make the data generators here, is this just some sample data used for demos?

Yes, just for a demo.

What's the purpose of IMongoDbContext interface what is it abstracting?

It abstracts some needed MongoDB functionalities and hides implementation detail and it is used to share a unique instance of DbContext during each request scope.

How did you decide to have IBaseRepository versus having separate like IActivityRepository?

IBaseRepository provides the same functionalities for all entities, but each entity (or aggregate) can have some specific functionalities. For example getting a user by its userName instead of its id in IUserRepository.

How did you decide to make public setters on the domain entities?

As I have described on documents related to Domain, I have tried to cover some examples around Rich Domain and Anemic Domain Modeling for implementing Generic and Supporting and Core Domains. I have used Anemic Models to implement less important subdomains (like Authorization and Membership) and Rich Models for the core domain (Workspace).

I noticed base.SetId(id), what about the possiblity of calling the base constructor?

base.SetId(id) is used for the entities that need to define a special id. Also it is protected and can't be called from the outside of the entities. Calling the base constructor will generate a random id for the entity. So each entity can decide it needs to set a special id or not.

What is the purpose of SetAsDeleted(), SetAsRecycled(), SetAsUpdated()?

They are just some behaviors related to domain.

How did you decide to put JsonIgnore in the DomainEvent, compared to putting it into infrastructure?

I just needed to skip some properties when doing Serialization. I could do it by implementing a helper class in infrastructure or by using JsonIgnore attribute in the main model. I chose the simpler. If I see a problem during the tests, I will refactor it.

In the code there is DateTime.Now in the DomainEvent, so this would make the test non-deterministic, how do you handle this?

I have been following test-last approach in the project and I will refactor it by using IDateTimeService during the tests just like what you adviced.

BoardController - I see BoardInsertDto used for both Create and Update, do you always do it that way?

I have tried to prepare a quick UI client and that is why most of the forms and input models are the same. I will continue developing the clients and then will separate the models during implementing the real features.

In the route for HttpPut for BoardController.Update, would you use route parameters for the id?

I will refactor it and follow the other REST conventions when I focus on clients.