Added aggregate root and tracking support.

Author: MarkGentHe1

docker-compose.yml

@@ -39,7 +39,7 @@ services:
     networks:
       - cdp-tenant
     ports:
-      - '27017:27017'
+      - '27018:27017'
     volumes:
       - mongodb-data:/data
     restart: always

src/KeeperData.Api/Controllers/SiteController.cs

@@ -0,0 +1,22 @@
+using Asp.Versioning;
+using KeeperData.Application;
+using KeeperData.Application.Queries.Sites;
+using Microsoft.AspNetCore.Mvc;
+
+namespace KeeperData.Api.Controllers
+{
+    [ApiController]
+    [ApiVersion("1.0")]
+    [Route("api/v{version:apiVersion}/[controller]")]
+    public class SiteController(IRequestExecutor executor) : ControllerBase
+    {
+        private readonly IRequestExecutor _executor = executor;
+
+        [HttpGet("{id}")]
+        public async Task<IActionResult> GetById(string id)
+        {
+            var result = await _executor.ExecuteQuery(new GetSiteByIdQuery(id));
+            return Ok(result);
+        }
+    }
+}

src/KeeperData.Api/KeeperData.Api.csproj

@@ -16,6 +16,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <PackageReference Include="Asp.Versioning.Mvc.ApiExplorer" Version="8.1.0" />
     <PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.22.1" />
   </ItemGroup>
 

src/KeeperData.Api/Program.cs

@@ -55,13 +55,6 @@ static void ConfigureBuilder(WebApplicationBuilder builder)
         }
     });
 
-    builder.Services.AddControllers()
-        .AddJsonOptions(opts =>
-        {
-            var enumConverter = new JsonStringEnumConverter();
-            opts.JsonSerializerOptions.Converters.Add(enumConverter);
-        });
-
     builder.Services.ConfigureApi(builder.Configuration);
 }
 

src/KeeperData.Api/Setup/ServiceCollectionExtensions.cs

@@ -1,13 +1,34 @@
+using Asp.Versioning;
 using KeeperData.Application.Setup;
 using KeeperData.Infrastructure.Database.Setup;
 using KeeperData.Infrastructure.Messaging.Setup;
+using System.Text.Json.Serialization;
 
 namespace KeeperData.Api.Setup;
 
 public static class ServiceCollectionExtensions
 {
     public static void ConfigureApi(this IServiceCollection services, IConfiguration configuration)
     {
+        services.AddControllers()
+            .AddJsonOptions(opts =>
+            {
+                var enumConverter = new JsonStringEnumConverter();
+                opts.JsonSerializerOptions.Converters.Add(enumConverter);
+            });
+
+        services.AddApiVersioning(options =>
+        {
+            options.ApiVersionReader = new UrlSegmentApiVersionReader();
+            options.DefaultApiVersion = new ApiVersion(1, 0);
+            options.ReportApiVersions = true;
+        })
+        .AddApiExplorer(options =>
+        {
+            options.GroupNameFormat = "'v'VVV";
+            options.SubstituteApiVersionInUrl = true;
+        });
+
         services.AddDefaultAWSOptions(configuration.GetAWSOptions());
 
         services.ConfigureHealthChecks();

src/KeeperData.Api/Setup/WebApplicationExtensions.cs

@@ -21,6 +21,11 @@ public static void ConfigureRequestPipeline(this WebApplication app)
         applicationLifetime.ApplicationStopped.Register(() =>
             logger.LogInformation("{applicationName} stopped", env.ApplicationName));
 
+        var versionSet = app.NewApiVersionSet()
+            .HasApiVersion(new Asp.Versioning.ApiVersion(1.0))
+            .ReportApiVersions()
+            .Build();
+
         app.UseMiddleware<ExceptionHandlingMiddleware>();
 
         app.UseHeaderPropagation();
@@ -40,9 +45,9 @@ public static void ConfigureRequestPipeline(this WebApplication app)
                 [HealthStatus.Degraded] = StatusCodes.Status200OK,
                 [HealthStatus.Unhealthy] = StatusCodes.Status503ServiceUnavailable
             }
-        });
+        }).WithApiVersionSet(versionSet).IsApiVersionNeutral();
 
-        app.MapGet("/", () => "Alive!");
+        app.MapGet("/", () => "Alive!").WithApiVersionSet(versionSet).IsApiVersionNeutral();
 
         app.MapControllers();
     }

src/KeeperData.Application/Commands/ITrackedCommandHandler.cs

@@ -0,0 +1,10 @@
+using KeeperData.Core.Domain.BuildingBlocks.Aggregates;
+using MediatR;
+
+namespace KeeperData.Application.Commands;
+
+public interface ITrackedCommandHandler<in TCommand, TResult>
+    : IRequestHandler<TCommand, TrackedResult<TResult>> where TCommand
+    : ICommand<TrackedResult<TResult>>
+{
+}

src/KeeperData.Application/Commands/Sites/CreateSiteCommand.cs

@@ -0,0 +1,9 @@
+using KeeperData.Core.Domain.BuildingBlocks.Aggregates;
+
+namespace KeeperData.Application.Commands.Sites;
+
+/// <summary>
+/// Example implementation only. To remove in future stories.
+/// </summary>
+/// <param name="Name"></param>
+public record CreateSiteCommand(string Name) : ICommand<TrackedResult<string>>;

src/KeeperData.Application/Commands/Sites/CreateSiteCommandHandler.cs

@@ -0,0 +1,27 @@
+using KeeperData.Core.Documents;
+using KeeperData.Core.Domain.BuildingBlocks.Aggregates;
+using KeeperData.Core.Domain.Sites;
+using KeeperData.Core.Repositories;
+
+namespace KeeperData.Application.Commands.Sites;
+
+/// <summary>
+/// Example implementation only. To remove in future stories.
+/// </summary>
+/// <param name="repository"></param>
+public class CreateSiteCommandHandler(IGenericRepository<SiteDocument> repository)
+    : ITrackedCommandHandler<CreateSiteCommand, string>
+{
+    private readonly IGenericRepository<SiteDocument> _repository = repository;
+
+    public async Task<TrackedResult<string>> Handle(CreateSiteCommand request, CancellationToken cancellationToken)
+    {
+        var site = Site.Create(Guid.NewGuid().ToString(), "Holding", request.Name, "England");
+        site.AddSiteIdentifier(Guid.NewGuid().ToString(), Guid.NewGuid().ToString(), "CPH");
+
+        var document = SiteDocument.FromDomain(site);
+        await _repository.AddAsync(document, cancellationToken);
+
+        return new TrackedResult<string>(site.Id, site);
+    }
+}

src/KeeperData.Application/IRequestExecutor.cs

@@ -1,10 +1,13 @@
 using KeeperData.Application.Commands;
 using KeeperData.Application.Queries;
+using KeeperData.Core.Domain.BuildingBlocks.Aggregates;
 
 namespace KeeperData.Application;
 
 public interface IRequestExecutor
 {
     Task<TResponse> ExecuteCommand<TResponse>(ICommand<TResponse> command, CancellationToken cancellationToken = default);
+    Task<TResponse> ExecuteCommand<TResponse>(ICommand<TrackedResult<TResponse>> command, CancellationToken cancellationToken = default);
+    Task<TrackedResult<TResponse>> ExecuteTrackedCommand<TResponse>(ICommand<TrackedResult<TResponse>> command, CancellationToken cancellationToken = default);
     Task<TResponse> ExecuteQuery<TResponse>(IQuery<TResponse> query, CancellationToken cancellationToken = default);
 }