Roadmap to .NET 8 Upgrade 🚀

[iammukeshm]

There will be a complete rewrite to reduce the project's complexity and make it more adaptable for everyone. I have gone into a very opinionated approach while building this solution, at the same time keeping in mind that the project should be extensible.

• .NET 8
• Complete Rewrite
• By default supports only InMemory Database and PostgreSQL
• MediatR
• EFCore only!
• In Memory Caching & Redis Distributed Caching
• Minimal APIs only
• Serilog, as usual with sinks
• Supports both Vertical Slice Architecture & Clean Architecture 🚀
• Modular Monolith
• GitHub Workflows
• NuGet Generation Pipeline
• Code Generation and templates for easier development
• Multitenancy with Finbuckle
• Docker for Containers
• JWT Auth, and also extensible to 3rd party like KeyCloak or auth0
• Permission Management
• Repository Pattern
• Audit Logging with EF Interceptors
• Advanced Paging and Filtering
• NextJS Frontend, with Tailwind (this project will be part of this same repository, under client/ folder)
• HttpClientFactory for External Service calls, with Polly Retry Mechanism
• Rate Limiting
• Unit Tests
• Domain Driven Design
• Cloud Ready. Can be deployed to AWS Infrastructure as ECS Containers using Terraform!
• Open API
• Fluent Validations
• File Storage Service - Local / S3
• API Versioning
• Hangfire Support
• Code Analysis with SonarAnalyzers
• Centralized Package Management
• SignalR for Notifications
• Mapster
• Nextra-based Documentation Website (Final Priority)
• Add Grafana / Prometheus based Metrics and Dashboard with Open Telemetry
• Add Performance Tests using K6

Pull Request WIP - #905

[PedroVentura235]

Hi mukesh, how are you on the code generation?
I thought we could use this library CodegenCS
Below an simple example for the controller.
It has an Visual studio extension, only right click on the template file and click generate.
What you think?

[iammukeshm]

I have kept codegen/templating for the last. But this looks nice. So, where are the template files stored? and how does VS fetch it?

[PedroVentura235]

Just like that. I am still studying the library, but so far seems nice.
I tjust generates a .cs file, it doesnt depend on runtime and compile.
We can generate them as partial, so we can make changes to the generated code

[fcantenot]

@iammukeshm I don't know NextJS to create a frontend. With .Net Api + Blazor, it is easy to connect both through NSwag. Is it also easy with NextJS ? what about notification with SignalR too please ?

[iammukeshm]

NSwag has TypeScript client generation too. That wouldn't be a problem. I will check the feasibility and decide on the client. Just trying to complete the Web API first as soon as possible, for now.

[PedroVentura235]

I have a nextjs project, cant open source it, since it is a paid theme, but I integrate it with the nwsag studio in the nextjs project.

[zrediet]

So this means Blazor is not included?

[hardikp2010]

There will be a complete rewrite to reduce the project's complexity and make it more adaptable for everyone. I have gone into a very opinionated approach while building this solution, at the same time keeping in mind that the project should be extensible.

• .NET 8

• Complete Rewrite

• By default supports only InMemory Database and PostgreSQL

• MediatR or Wolverine? (Testing with Wolverine)

• EFCore only!

• In Memory Caching & Redis Distributed Caching

• Minimal APIs only

• Serilog, as usual with sinks

• Vertical Slice Architecture

• Modular Monolith

• GitHub Workflows

• NuGet Generation Pipeline

• Code Generation and templates for easier development

• Multitenancy with Finbuckle

• Docker for Containers

• JWT Auth, and also extensible to 3rd party like KeyCloak or auth0

• Permission Management

• Repository Pattern

• Audit Logging with EF Interceptors

• Advanced Paging and Filtering

• NextJS Frontend, with Tailwind (this project will be part of this same repository, under client/ folder)

• HttpClientFactory for External Service calls, with Polly Retry Mechanism

• Rate Limiting

• Unit Tests

• Domain Driven Design

• Cloud Ready. Can be deployed to AWS Infrastructure as ECS Containers using Terraform!

• Open API

• Fluent Validations

• File Storage Service - Local / S3

• API Versioning

• Hangfire Support

• Code Analysis with SonarAnalyzers

• Centralized Package Management

• SignalR for Notifications

• Mapster

• Nextra-based Documentation Website (Final Priority)

• Add Grafana / Prometheus based Metrics and Dashboard with Open Telemetry

• Add Performance Tests using K6

Pull Request WIP - #905

I think database facility remain as it is for all databases support with multiple DB support more user can use this project

[hardikp2010]

@iammukeshm we Create extension for visual studio or vscode to generate code like below link in this project casual studio extension is installed using this we can easily generated code backend and frontend https://github.com/neozhu/CleanArchitectureCodeGenerator

[kirkey]

@iammukeshm, I would like to suggest to preserve the Net7/Net8 versions and create new repository for Net8 so people can decide which pattern to use (Onion or Sliced).
As for personal reference, I find Onion suits my needs. Sliced Architecture is also good but not for my current project.

[iammukeshm]

the current version will be still preserved as part of the v1 branch, and existing nuget packages.

[gfo2007]

@iammukeshm is there a reason you are limiting it to minimal apis? Is it not possible to allow the use of controllers as an option for those of us who prefer controllers?

[iammukeshm]

You can always use Controllers if you want to. It's just that MinimalAPIs make more sense for mid scale projects, and has finer controls. Also Microsoft is actively pushing it and adding quite good number of features into it.

[gfo2007]

Thanks for your quick response @iammukeshm . I see fullstackhero as an enterprise grade boilerplate so I was thinking going with controllers as the default would have been the more intuitive option. So that in cases where people are undertaking simple projects, they can rather choose minimal apis.

One more question. Since Microsoft has introduced Blazor United, do you have any plans at all to upgrade the blazor-wasm project to .net 8 ? I am asking since the roadmap does not list it

[punkouter25]

I like the new way.. Is there a good reason why the old way with controllers is better?

[zrediet]

"From bard.google.com"
https://g.co/bard/share/b11c1f1a930f

In summary:

Choose Controller-based APIs for larger, complex APIs requiring many features, ease of use, and automatic documentation.
Choose Minimal APIs for smaller, performance-critical APIs, microservices, or situations where you need finer control and flexibility.

[stamahto]

I'm super excited!

[ngoquoctoandev]

Hi, @iammukeshm

1. I saw in the previous commit you used Wolverine, but then I saw you used MediatR again. Can you give me more clear information about this decision? I think wolverine is a very good library.
2. How do you feel about using the Fast-Endpoints library (https://fast-endpoints.com) instead of Minimal-API. It's also the same vertical slicing model without rewriting too much code.

[iammukeshm]

hi,

1. Wolverine is cool, but there is too much magic to its implementation, and might not entertain everyone. Whereas MediatR is far more adapted and people know how to work with it. Also, the Pipeline Behavior just works right like I wanted. What are your thoughts about it?
2. I guess Minimal API is faster than fast-endpoints. Performance is on par with Minimal APIs - quoted from their landing page. I haven't explored fast-endpoint much though.

[fcantenot]

@iammukeshm , will it be possible to add FastEndpoint for those who wish by themselves ?

[mrashed]

I plan to add FastEndpoint too, it's fantastic library

[fcantenot]

@iammukeshm , I try to install the template but I can't. I tried just 'tba' inside visual studio console package manager with package source 'nuget.org', I tried Install-Package tba but it didn't work. How can install the package to test it ? do you plan to release a new web site with a documentation please ? thanks

[iammukeshm]

Hi, sorry for the confusion, by tba I meant to-be-announced. For now there is no template / nuget published with the new upgrade since this is a work in progress. You can clone the repo and switch to the v2 branch if you need to check something. I am pushing new changes on a daily basis.

[iammukeshm]

And yes, the documentation website also will be revamped after the project reaches a stable stage. Planning to use nextra for documentation. (https://nextra.site/)

[fcantenot]

thanks for your answer Mukesh, no problem, sorry I'm not familiar with abreviation in English !

[PedroVentura235]

Hello Mukesh, Do you have any blog post, or where you based to change from Clean to an vertical slice architecture?
Because I have been reading, and honestly, I like more the Clean Architecture although I understand the benefits of Vertical Slice

[punkouter25]

im the opposite.. I did the CA thing and it was fine.. But when I read up on VS that seemed more efficient for my simple apps so I am looking forward to using that

[iammukeshm]

@PedroVentura235 The idea behind the new rewrite is to support both Clean Architecture and VSA under modules. It will be your choice to decide whether to go with CA or VSA with your modules. This way you get the best of both worlds, and I feel that this aligns with Microservice concepts, and is an efficient way to build applications. You really won't need CA in every use case/module.

[iammukeshm]

Once the NuGet packages are published, you will get an option to generate CA / VSA templates within your FSH solutions. This is what I have in mind for now.

[PedroVentura235]

@iammukeshm Do you have any roadmap or something, i will have some time and could assist on this, and could advance on some things, What you suggest?

[iammukeshm]

@PedroVentura235,Yes I will need help. I will come up with a list of issues/features that have to be implemented in this new rewrite. You can pick up something once it's available. Sounds good?

[gfo2007]

A database first code generator will be a life saver for many. That is, you create the database or if you have an existing database, you can use the database tables and columns to generate entity classes and properties respectively.

@iammukeshm is it something worth adding to the roadmap?

[maxiar]

There will be a complete rewrite to reduce the project's complexity and make it more adaptable for everyone. I have gone into a very opinionated approach while building this solution, at the same time keeping in mind that the project should be extensible.

• .NET 8

• Complete Rewrite

• By default supports only InMemory Database and PostgreSQL

• MediatR

• EFCore only!

• In Memory Caching & Redis Distributed Caching

• Minimal APIs only

• Serilog, as usual with sinks

• Supports both Vertical Slice Architecture & Clean Architecture 🚀

• Modular Monolith

• GitHub Workflows

• NuGet Generation Pipeline

• Code Generation and templates for easier development

• Multitenancy with Finbuckle

• Docker for Containers

• JWT Auth, and also extensible to 3rd party like KeyCloak or auth0

• Permission Management

• Repository Pattern

• Audit Logging with EF Interceptors

• Advanced Paging and Filtering

• NextJS Frontend, with Tailwind (this project will be part of this same repository, under client/ folder)

• HttpClientFactory for External Service calls, with Polly Retry Mechanism

• Rate Limiting

• Unit Tests

• Domain Driven Design

• Cloud Ready. Can be deployed to AWS Infrastructure as ECS Containers using Terraform!

• Open API

• Fluent Validations

• File Storage Service - Local / S3

• API Versioning

• Hangfire Support

• Code Analysis with SonarAnalyzers

• Centralized Package Management

• SignalR for Notifications

• Mapster

• Nextra-based Documentation Website (Final Priority)

• Add Grafana / Prometheus based Metrics and Dashboard with Open Telemetry

• Add Performance Tests using K6

Pull Request WIP - #905

Excelent plan! And ambicious project... it's a big change with the latear technologies.. but I'm thinking Why mantaint two project web api and microservice boilerplates…. if a microservice can be containt a webapi perfectly…. and also you need to upgrade the blazor ui to be compatible with webapi and microservice.. but now for this version nextJS is perfect!! But another repo to mantaint... I think that is too job for you.. (and the community) .. May be we need an integral plan to unified all boirplates in a modular design… what do you think?
Thanks in advanced!

[iammukeshm]

Yes, thought about this same issue. Plan is to maintain only this repository, which has a .NET 8 WebAPI (Modular Monolith), and a couple of frontends within the same repository. I will start with NextJs, and add blazor later on. I will also include a detailed guide on how you can migrate this modular monolith application to a microservice architecture. Should be do-able.

[xlogex]

what do you think about fluentui for blazor?

[ngoquoctoandev]

Personal opinion: I feel MudBlazor is great for Blazor projects. However, after the release of .NET 8, it seems that a lot of work needs to be done to make MudBlazor compatible with SSR, CSR...

[maxiar]

Perfect! we are in the same page! I think that if we combine the best code of the both repositorios (microservice/webapi net 8) we can get a better an unique témplate... May be when the v2 roadmap was finished the nectario v2.1 roadmap could be add the missing microservice features like yarp gateway in a isolated project, and masstransit for services bus(rabbitmq) in the infraestructure common layer to be available for use/or not in the webapi/microservice.

[iammukeshm]

How far has fullstackhero's progress reached? 🤔

Here is a quick overview.

• I am going forward with the complete rewrite approach, however, the .NET 7 version is still available from the v1 branch. The new .NET 8 changes will be on the v2 branch.
• Multitenancy is re-implemented with a few bug fixes.
• The starter kit uses PostgreSQL & InMemoryDb with EFCore by default.
• The solution follows a modular architecture. Each Module can have its own architecture. For example, I have included 2 Modules by default, Catalog, which follows Clean Architecture and a more domain-centric design. The other module, Todo follows more of a flexible vertical slice architecture, for rapid development, and fewer abstractions. This way, you are never really stuck with a certain architecture.
• Central Package Management.
• Repository Pattern with Ardalis Specifications.
• Automatic Database Migrations and Seeding.
• MediatR, Domain Events, and Pipeline Behaviors.
• Logging with Serilog.
• Docker Compose Support & Integrated Docker Build with Server project.
• Swagger UI and Versioned APIs.

Overall, the rewrite has neared a stable state. The major work pending is related to Identity and Permission Management. I will use the same codebase from v1 for this, and add certain improvements. As for the front end, I will go with NextJS 14 initially, and later on, add Blazor. Frontend is one of the lower priorities for now. Suggestions?

I will add a list of issues/features on the GitHub repository so that some of you can pick up tasks. V2 is on the way!

To get more updates, subscribe to my newsletter: https://staging.codewithmukesh.com/newsletter

Check out the repository: https://github.com/fullstackhero/dotnet-webapi-starter-kit/tree/v2

[iammukeshm]

How would you manage user creation/tenant assignment in this case? How would token generation work?

[maxiar]

The users creation can be initialized by keycloack API/container and use the attributes to Store the tenantId.. something like that https://danielwertheim.se/keycloak-and-multi-tenancy-using-single-realm/...

[maxiar]

... Happy new year! 😃

[iammukeshm]

The problem is if you push the tenantId to keycloak, users wont be able to switch to an another OpenID provider like Auth0. I am thinking about this flow.

1. User has to be created in KeyCloak Realm/Auth0.
2. The same user has to registered into the application database, but without any password. This is just to attach the API specific data like tenantId, etc to the user email. User Email should match in both the application database as well as the Keycloak Db.
3. User Token is generated by KeyCloak API, using the Code Flow PKCE.
4. Once token is passed to the API, we have to figure out which tenant the user belongs to. and also have a mechanism to derive the app specific permissions.

What do you think? I don't find any good references to implement this in a very practical way.

[maxiar]

I think that the hybrid approach is better to save the tenantId from the app side and security from the IdentityProvider (OAuth o Keycloack) ... And.. to avoid coupled to keyclock or another provider you can use this design: https://medium.com/@ahmed.gaduo_93938/how-to-implement-keycloak-authentication-in-a-net-core-application-ce8603698f24

[hardikp2010]

@iammukeshm why not use azure? Is there any reason because it is more suitable with visual studio and Microsoft ecosystem

[JonasDev17]

I know this may be a little late but I have come across the following library by JohnPSmith: https://github.com/JonPSmith/AuthPermissions.AspNetCore

this is a Multitenancy Library that has a lot more features and is actively being worked on. It also supports Hierarchical Multitenancy.

[tvprasad]

@iammukeshm -
Additionally, I suggest incorporating the secure storage of application secrets, building on the practice of reading from configuration/*.json files.
I recommend ensuring a smooth migration process for previous releases when rewriting the current version.

[maxiar]

Hi! @iammukeshm Did you stop working on Net8 upgrade? Your last commit was a month ago.. Sorry You and me, and others have another jobs that pay the bills :) .... I understand but you have a big community use this template in production and it's waiting for it....... Did you need help to upgrade it more faster? What is the upgrade status? .. Thanks in advanced!

[iammukeshm]

Yep, I didn't get much time to concentrate on the upgrade for the past few weeks. I think I will first come up with a list of TODOs to be taken care of for this project. From there, it will be clearer on the status. I am looking to complete this upgrade soon. Sorry for the delay!

[maxiar]

🙄

[ngoquoctoandev]

I highly appreciate your efforts and dedication to the community. I saw your comprehensive upgrade roadmap to .NET 8 from October 2023. You shared and announced it very strongly with the community, your fans and supporters of the project. It's been 5 months now and still haven't received the .NET 8 release in production environment. I believe you still maintain the credibility of your words, as well as what you have planned, which I see you marked as a high priority but seems to be left open. I want to confirm with you whether this project is dead or will continue. Thank you very much.

[shivakb]

Hi @iammukeshm ,

Nice to here an update on the web api template to .net 8.

Additionally, I suggest incorporating the finbuckle multitenant with identityserve4 integration to web api.

Thanks in advance

[ngoquoctoandev]

That's right, IS4 is enough to use

[maxiar]

Any news? The project is dead?

[punkouter25]

i see the server side is updated.. the client side is next?

[maxiar]

I don't know.. I think that re repo is deprecates..., @iammukeshm create one commit for month.. 😭😭

[iammukeshm]

Guys, really sorry. No, this project will not be dead anytime soon ;) I am just not able to find enough time for this. I have resumed the work from yesterday and have done over 20+ commits. I hope at least the server side will be completed in a week. The major thing to add is,

• Multitenancy (code changes are done, integrations have to be tested)
• cicd
• terraform
• searching
• interceptors
• signalr
• hangfire

[Lokman-Simsek]

On behalf of those who are waiting for this project, I would like to thank you for your time. I hope you will finish this week. You will have prepared an excellent infrastructure for beginners like me who have been waiting for this project for a long time. I wish you convenience.

[maxiar]

Excelent News! @iammukeshm !
When you complete a beta versión, you can request help to the community to fix bugs or add new features vía pull request in orden to help you to create a best framework app! And you can continué with the Client website app... I think that of a good idea to finish or keep updated this project continously... the net9 is around the corner.. 😂😂

[iammukeshm]

Update:

Here is what's done,

• Terraform: One single command to deploy the entire app with pg db into aws infrastructure. This is done and tested. Improvements over the folder structure of Terraform can be made. I'll be sure to pick this up last. We have to modularize the resources.
• Multitenancy is done and tested.
• Hangfire integration is done.

What's Pending?

• Few Identity Endpoints
• Blazor Client : Priority 1
• File Storage Service
• NuGet Generation Pipeline
• Source Code Generation
• Searching / Sorting : Priority 1

[PedroVentura235]

Hi mukesh, regarding the source code generation.
I am writing a basic template for myself, and added a source code generation, not on runtime, but when the user wants(how I prefer)
https://github.com/PedroVentura235/BasicWebApi/tree/master/Application/Features.
On the file FeatureTemplate.csx , we just right click it and run it(through the extension CodeGenCS, and it generats all the files we want.
In my example I have all the create, gets, updates deletes and dtos all auto generated, and is only generated for the ones I add on the file

[dsolteszopyn]

Are you adding in HangfireMediatorBridge in V2 brnach

[iammukeshm]

job dispatching is already available for Hangfire. Currently when a new user is registered, a hangfire job is dispatched to send the registration email. Are you referring to this one?

[dsolteszopyn]

to support IRequest
`
using MediatR;
using System.Linq.Expressions;

public interface IJobService
{
void AddOrUpdate(string recurringJobId, IBaseRequest request, string cronExpression, TimeZoneInfo? timeZone = null, string queue = "default");

bool Delete(string jobId);

bool Delete(string jobId, string fromState);
string Enqueue(IBaseRequest request);
string Enqueue(Expression<Action> methodCall);
string Enqueue(Expression<Func<Task>> methodCall);

string Enqueue<T>(Expression<Action<T>> methodCall);

string Enqueue<T>(Expression<Func<T, Task>> methodCall);

bool IsRunning(string recurringJobId);

void RemoveIfExists(string recurringJobId);

bool Requeue(string jobId);

bool Requeue(string jobId, string fromState);

string Schedule(IBaseRequest request, TimeSpan delay);

string Schedule(Expression<Action> methodCall, TimeSpan delay);

string Schedule(Expression<Func<Task>> methodCall, TimeSpan delay);

string Schedule(Expression<Action> methodCall, DateTimeOffset enqueueAt);

string Schedule(Expression<Func<Task>> methodCall, DateTimeOffset enqueueAt);

string Schedule<T>(Expression<Action<T>> methodCall, TimeSpan delay);

string Schedule<T>(Expression<Func<T, Task>> methodCall, TimeSpan delay);

string Schedule<T>(Expression<Action<T>> methodCall, DateTimeOffset enqueueAt);

string Schedule<T>(Expression<Func<T, Task>> methodCall, DateTimeOffset enqueueAt);

}
`

`
internal class HangfireMediatorBridge(ISender mediator, ICurrentUserInitializer currentUserInitializer, IMultiTenantStore tenantStore, IMultiTenantContextSetter tenantContextAccessor)
{
///

/// It takes a request, and sends the request to the mediator.
///

///
/// The user id of the user who is making the request.
/// The request that will be sent to the mediator.
/// This is a token that can be used to cancel the job.
[DisplayName("{1}")]
public async Task SendAsync(string tenantId, string userId, IBaseRequest request, CancellationToken ct)
{
tenantContextAccessor.MultiTenantContext =
await tenantStore.TryGetAsync(tenantId) is { } tenantInfo
? new MultiTenantContext { TenantInfo = tenantInfo }
: throw new InvalidOperationException("Invalid tenant.");
currentUserInitializer.SetCurrentUserId(userId);

    await mediator.Send(request, ct);
}

/// <summary>
///     It takes a request, and a cancellation token, and returns a task.
/// </summary>
/// <param name="request">The request object that will be sent to the mediator.</param>
/// <param name="ct">This is a token that can be used to cancel the job.</param>
/// <returns>
///     A Task.
/// </returns>
[DisplayName("{0}")]
public Task SendAsync(IBaseRequest request, CancellationToken ct)
{
    return mediator.Send(request, ct);
}

}
`

[dsolteszopyn]

Are you porting over signalR intergration into V2?

[wtmaxim]

Here is the link to the PR where we have started working on this integration: #956 . Feel free to review and provide your feedback.

[wtmaxim]

@iammukeshm What are we missing to launch v2?

[iammukeshm]

@iammukeshm What are we missing to launch v2?

What about file storage service, unit test, mapster, permission management from the original net 8 migration scope... #907 (comment)

and also, I think that an event systems like masstransit is a "must feature" to include...

I can help to the another features from the inicial scope, like add grafana/prometheous metrics that I already done in v1...

Are you agree?

I would not keep masstransit / graffana / prometheus as priority for now. Once Blazor Client is done, with these essentials,

1. Login / Logout
2. Dark Mode
3. Responsive Design
4. CRUD Operations Screen
5. User Management Screen
6. Tenant Management
7. Forgot Password / Reset

Once the above is done, we can have a beta release, and after that we can concentrate on the other stuff. That's the plan i have for now.

[iang0ld]

Any idea on when this Beta will be available so we can start new projects with this? Or can we start now? Is the API is good enough shape to begin building out an API?

[maxiar]

weekend.

This weekend? 😃

[iammukeshm]

Blazor / Products Grid is done, Supporting all CRUD operations. However, there are still some bits that need fixing. Someone please try to run it on local and let me know.

[wtmaxim]

it looks good to me

[PedroVentura235]

Hi @iammukeshm , regarding the source code generation.
I am writing a basic template for myself, and added a source code generation, not on runtime, but when the user wants(how I prefer)
https://github.com/PedroVentura235/BasicWebApi/tree/master/Application/Features.
On the file FeatureTemplate.csx , we just right click it and run it(through the extension CodeGenCS, and it generats all the files we want.
In my example I have all the create, gets, updates deletes and dtos all auto generated, and is only generated for the ones I add on the file