✨ 364 Add Vogen for Strongly Typed IDs (#441)

Author: danielmackay

docs/adr/20241118-produce-useful-sql-server-exceptions.md

@@ -25,3 +25,7 @@ Chosen option: "Option 1", because it does what we need and is far better than t
 
 - ✅ Strongly typed exceptions
 - ❌ Additional dependency added
+
+## Links
+
+- https://youtube.com/watch?v=QKwZlWvfh-o&si=yVnd5a7CVZaSV_Gr

docs/adr/20241118-replace-automapper-with-manual-mapping.md

@@ -49,3 +49,7 @@ Chosen option: "Option 2 - Manual Mapper", because it reduces the runtime errors
 - ✅ Reduced runtime issues due to missing fields or mappings
 - ✅ No need to learn a new library
 - ❌ More code needed for mapping
+
+## Links
+
+- https://www.youtube.com/watch?v=RsnEZdc3MrE

docs/adr/20241118-use-vogen-to-simplify-strongly-typed-ids.md

@@ -0,0 +1,46 @@
+# Use Vogen to simplify strongly typed IDs
+
+- Status: approved
+- Deciders: Daniel Mackay
+- Date: 2024-11-19
+- Tags: ddd, vogen, strongly-typed-ids
+
+Technical Story: https://github.com/SSWConsulting/SSW.CleanArchitecture/issues/364
+
+## Context and Problem Statement
+
+Strongly typed IDs are a great way to combat primitive obsession. However, they can be a bit of a pain to set up especially with EF Core. We want to make it easier to use strongly typed IDs or any simple value objects in our projects.
+
+## Decision Drivers <!-- optional -->
+
+- Simplify usage of strongly typed IDs
+
+## Considered Options
+
+1. Manual Approach
+2. Vogen
+
+## Decision Outcome
+
+Chosen option: "Option 2 - Vogen", because configuration, validation, and usage of strongly typed IDs is much simpler (espeicially from the EF Core point of view).
+
+## Pros and Cons of the Options <!-- optional -->
+
+### Option 1 - Manual Approach
+
+- ✅ Avoid additional dependencies
+- ❌ Extra EF Core boilerplate needed
+- ❌ Not easy to add value object validation with current record-based approach
+
+### Option 2 - Vogen
+
+- ✅ Simple to create and use strongly typed IDs
+- ✅ Easy to add value object validation
+- ✅ Easy to add EF Core configuration
+- ✅ Can be used for any simple value object
+- ❌ Extra dependency added
+
+## Links
+
+- https://stevedunn.github.io/Vogen/overview.html
+- https://github.com/SteveDunn/Vogen

src/Application/UseCases/Heroes/Commands/UpdateHero/UpdateHeroCommand.cs

@@ -20,7 +20,7 @@ internal sealed class UpdateHeroCommandHandler(IApplicationDbContext dbContext)
 {
     public async Task<ErrorOr<Guid>> Handle(UpdateHeroCommand request, CancellationToken cancellationToken)
     {
-        var heroId = new HeroId(request.HeroId);
+        var heroId = HeroId.From(request.HeroId);
         var hero = await dbContext.Heroes
             .Include(h => h.Powers)
             .FirstOrDefaultAsync(h => h.Id == heroId, cancellationToken);

src/Application/UseCases/Teams/Commands/AddHeroToTeam/AddHeroToTeamCommand.cs

@@ -11,8 +11,8 @@ internal sealed class AddHeroToTeamCommandHandler(IApplicationDbContext dbContex
 {
     public async Task<ErrorOr<Success>> Handle(AddHeroToTeamCommand request, CancellationToken cancellationToken)
     {
-        var teamId = new TeamId(request.TeamId);
-        var heroId = new HeroId(request.HeroId);
+        var teamId = TeamId.From(request.TeamId);
+        var heroId = HeroId.From(request.HeroId);
 
         var team = dbContext.Teams
             .WithSpecification(new TeamByIdSpec(teamId))

src/Application/UseCases/Teams/Commands/CompleteMission/CompleteMissionCommand.cs

@@ -10,7 +10,7 @@ internal sealed class CompleteMissionCommandHandler(IApplicationDbContext dbCont
 {
     public async Task<ErrorOr<Success>> Handle(CompleteMissionCommand request, CancellationToken cancellationToken)
     {
-        var teamId = new TeamId(request.TeamId);
+        var teamId = TeamId.From(request.TeamId);
         var team = dbContext.Teams
             .WithSpecification(new TeamByIdSpec(teamId))
             .FirstOrDefault();

src/Application/UseCases/Teams/Commands/ExecuteMission/ExecuteMissionCommand.cs

@@ -14,7 +14,7 @@ internal sealed class ExecuteMissionCommandHandler(IApplicationDbContext dbConte
 {
     public async Task<ErrorOr<Success>> Handle(ExecuteMissionCommand request, CancellationToken cancellationToken)
     {
-        var teamId = new TeamId(request.TeamId);
+        var teamId = TeamId.From(request.TeamId);
         var team = dbContext.Teams
             .WithSpecification(new TeamByIdSpec(teamId))
             .FirstOrDefault();

src/Application/UseCases/Teams/Events/PowerLevelUpdatedEventHandler.cs

@@ -26,7 +26,7 @@ public async Task Handle(PowerLevelUpdatedEvent notification, CancellationToken
         }
 
         var team = dbContext.Teams
-            .WithSpecification(new TeamByIdSpec(hero.TeamId))
+            .WithSpecification(new TeamByIdSpec(hero.TeamId.Value))
             .FirstOrDefault();
 
         if (team is null)

src/Application/UseCases/Teams/Queries/GetTeam/GetTeamQuery.cs

@@ -16,7 +16,7 @@ public async Task<ErrorOr<TeamDto>> Handle(
         GetTeamQuery request,
         CancellationToken cancellationToken)
     {
-        var teamId = new TeamId(request.TeamId);
+        var teamId = TeamId.From(request.TeamId);
 
         var team = await dbContext.Teams
             .Where(t => t.Id == teamId)

src/Domain/Domain.csproj

@@ -7,5 +7,6 @@
     <PackageReference Include="Ardalis.Specification" Version="8.0.0" />
     <PackageReference Include="ErrorOr" Version="2.0.1" />
     <PackageReference Include="MediatR.Contracts" Version="2.0.1" />
+    <PackageReference Include="Vogen" Version="5.0.5" />
   </ItemGroup>
 </Project>