sswconsulting / ssw.cleanarchitecture Goto Github PK

View Code? Open in Web Editor NEW

103.0 11.0 19.0 3.06 MB

SSW Clean Architecture Template

Home Page: https://sswconsulting.github.io/SSW.CleanArchitecture/

License: MIT License

C# 99.65% PowerShell 0.35%

clean-architecture cqrs dotnet ef-core minimal-api ssw

ssw.cleanarchitecture's People

Contributors

Stargazers

Watchers

Forkers

greatvivek11 pro-coded-external wildgenie jernejk xchinjo wicksipedia feroxneto stormwild peterstegnar allann jscarle calinator444 burak-renew-it hhko hakimdotdev dorucioclea bradystroud

ssw.cleanarchitecture's Issues

↔️ Create a flow when moving between project personas

✉️ Software Architectures Whiterobes Email Group

🧪 Add XUnit Unit and Integration Tests

🧑‍🚀 Review different architectures to use in the personas

📝 CA Announcement PPT

Split the original Clean Architecture v2 PPT from the retreat into smaller PPT specific for announcing CA v2 template

🎥 Monthly Video Publishing

Work out where to publish the monthly videos

💪 Strongly Typed IDs

❌ Primitive obsession for IDs
Build error for misuse of strings!

♻️ Using Result object as control flow instead of exceptions

Premise:

Exceptions are slower than Result objects (https://youtu.be/a1ye9eGTB98 - quick benchmark shows ~1us slower)
Using Exceptions as a control flow is a questionable approach, since it allows code to jump from nested method all the way to the caller (questionable = both good and bad)
Using result objects everywhere means more codes to write

Consideration:

Using mixed method is a brain overload for a small performance benefit
We haven't seen any big performance problems yet on our clients

Proposed decision:

Keep using exceptions for now - keep it simple
When there's a need arise (e.g. performance requirement, validation requirement) - handle it case-by-case

🗣️ Agree on how to record decisions

While working on this template we often have discussions on particular concepts and decide to go one way or another. These decisions should be documented in an organized fashion and made public.

Some possible options:

https://github.com/thomvaill/log4brains
https://github.com/endjin/dotnet-adr
GitHub discussions
Architectural Decision Records (ADRs)
Key Design Decisions
Wiki
(Other?)

Resources:

Ensure any tool allows you to easily access the content if we switch to something else.

Tasks

Beta Give feedback

Decide on decision making framework - Log4Brains
Implement decision making framework #113
Publish ADR static site #114
Document current decisions #115
Add ADR Link to readme #125
Drop 'log4brains' slug from ADR site URL #126
ADR Done video #124
Options

📝 Develop the project personas

🔒 Make repo public friendly

♻️ Migrate from Controllers to Minimal APIs

Common Base Entity Configuration

public class TodoItemConfiguration : IEntityTypeConfiguration<TodoItem>
{
    // TODO: Rip out the common pieces that are from BaseEntity
    // virtual method, override 
    // Good marker to enforce that all entities have configuration defined via arch tests
    public void Configure(EntityTypeBuilder<TodoItem> builder)
    {
        builder.HasKey(t => t.Id);
        builder.Property(t => t.Id)
            .HasConversion(x => x.Value, 
                x => new TodoItemId(x))
            .ValueGeneratedOnAdd();
        
        builder.Property(t => t.Title)
            .HasMaxLength(200)
            .IsRequired();
    }
}

📝 Create an Awesome list for reference architectures & compelling examples

github.com/sindresorhus/awesome/blob/main/create-list.md

https://github.com/SSWConsulting/awesome-clean-architecture

Test Unhandled Exceptions

    private static IResult HandleException(this HttpContext context, Exception exception)
    {
        var type = exception.GetType();

        if (ExceptionHandlers.ContainsKey(type))
            return ExceptionHandlers[type].Invoke(context, exception);

        // TODO: Testing around unhandled exceptions
        return Results.Problem(statusCode: StatusCodes.Status500InternalServerError,
            type: "https://tools.ietf.org/html/rfc7231#section-6.6.1");
    }

👀 Review of Slide Deck

✨ Add GraphQL example

Add an example of using GraphQL with CAv2 core template

Discussion Use of String in CreatedBy/UpdatedBY

public abstract class AuditableEntity
{
    public DateTimeOffset CreatedAt { get; set; }
    public string? CreatedBy { get; set; } // TODO: String as userId?
    public DateTimeOffset? UpdatedAt { get; set; }
    public string? UpdatedBy { get; set; } // TODO: String as userId?
}

✨ Auditable Entities

🧪 Add Architecture unit tests

AC: GIVEN I am a developer
WHEN I Violate CA
THEN I get build/unit test errors

GIVEN I am a tech lead
WHEN I setup a project best practice
AND Developers violate the practices
THEN They get build/unit test errors

✨ Add 404 status code to minimal api helper

✨ Validation

📦 Dotnet CLI Template (dotnet new cleanarchitecture)

To quickly set up a new project, utilize the dotnet CLI templates so that we can execute a command like:

dotnet new ssw-ca -n MyCleanArchitectureProject --ui BlazorWasm

to produce a ready-to-use solution.

Tasks:

create template
package via nuget
automate publish template via CI/CD pipeline

Resources

♻️ Organize Template Based on Features

This includes, WebApi, Application, and Domain Layers

♻️ Migrate Domain Event Dispatcher to use Interceptor

This provides a consistent way to add behavior before / after SaveChangesAsync()

Discuss Use of System Clock

public interface IDateTime
{
    // TODO: Talk to Gordon about this - System Clock
    public DateTimeOffset Now => DateTimeOffset.UtcNow;
}

🧪 Testing - Add test-containers

Document Domain Events Decision

Record via GH Discussion

♻️ Make events record based

This makes records easier to define

Move template TODO's to PBIs

Find appropriate name for the public template

As per the poll in Teams, we chose the name to be SSW.ClearArchitecture 👍

🎓 Develop CA v2 Workshop

♻️ Remove Repositories from the Template

Also move to reference architecture
Remove Repositories
Add EF Back to Application
Show benefits of using Specifications with DbContext
Investigate testing of Specifications

📝 CA Workshop Marketing PPT

Split the original Clean Architecture PPT from the retreat into smaller PPT specific for Workshops

🔒 .NET 8 - Add NuGet security auditing to csproj files

We should enable NuGet security auditing by default to our csproj files as per:

https://devblogs.microsoft.com/dotnet/announcing-dotnet-8-preview-4/#enabling-security-auditing

🎓 Workshop - Review CA v1 workshop/Superpowers

Review Gitbook to extract pieces to remove or update to focus more on CA and not external pieces like identity

TODO: Focus on SOLID principles

👷 Add Test Pipeline

✨ EF Core Healthcheck

Currently we have a health check endpoint:

app.UseHealthChecks("/health");

Add comprehensive health checks:

Consider adding healthcheck UI

✨ CA + GraphQL Reference Architecture

Add link and close

♻️ Switch from MediatR to MediatR.Contracts in the Domain layer

This adds a smaller dependency on MediatR

🎉 Create an SSW CA Template

🧑‍🚀 Define 3 application personas

#57
Decision tree to determine project size

Split off to its own issues:

Better Swagger Docs

Investigate examples for swagger docs. i.e. better docs than:

myWeirdField: "string" vs myWeirdField: "this-silly-string"

👷 Add Build Pipeline

👷 Update action to use global.json

✨ Add interface for auto endpoint registration

Could do this with the use of interfaces + Scrutor

🔙 Restore Domain Events feature

Keep Domain Events and Application Events separate.

Domain Events are added to the Domain Entities and raised from ApplicationDbContext when changes are saved. The domain events are handled using the MediatR INotificationHandler

Application Events can be raised from within the Application Commands/Queries using mediator.Publish() and are also handled using the MediatR INotificationHandler

This does mean that we will need to pay the price of depending on MediatR in our Domain Layer - but it is a small price to pay.

✨ Add Specifications for querying data

APPROACH: Remove dependency from EF Core in application layer by adding repository pattern.

AC: Spec pattern allowing better unit testing for things that might be integration tested when using EF Core in application layer

🐛 Remove Static User Secrets ID

Currently we have the following in WebApi.csproj:

<UserSecretsId>fc525b0c-3d84-4847-9b4f-840f8db76d87</UserSecretsId>

By having a static UserSecretsId, we will always pick up the same underlying JSON file across all projects.

This should be removed so that a unique UserSecretsId is generated per project when managing secrets.

📝 CA Ubiquitous Language

https://medium.com/@tiendvlp/some-important-terms-in-clean-architecture-5bdcbdbcdd2

sswconsulting / ssw.cleanarchitecture Goto Github PK

ssw.cleanarchitecture's People

Contributors

Stargazers

Watchers

Forkers

ssw.cleanarchitecture's Issues

Tasks

Tasks

Recommend Projects

Recommend Topics

Recommend Org