better problem detail support in endpoints

loresoft · Nov 14, 2024 · f57a930 · f57a930
1 parent 09c4715
commit f57a930
Show file tree

Hide file tree

Showing 20 changed files with 364 additions and 152 deletions.
diff --git a/samples/Tracker.WebService.EntityFrameworkCore/Domain/DomainJsonContext.cs b/samples/Tracker.WebService.EntityFrameworkCore/Domain/DomainJsonContext.cs
@@ -11,7 +11,7 @@
 namespace Tracker.WebService.Domain;
 
 [JsonSourceGenerationOptions(
-    DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
+    DefaultIgnoreCondition = System.Text.Json.Serialization.JsonIgnoreCondition.WhenWritingNull,
     PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase)]
 #region Generated Attributes
 [JsonSerializable(typeof(AuditReadModel))]
@@ -51,7 +51,7 @@ namespace Tracker.WebService.Domain;
 [JsonSerializable(typeof(UserUpdateModel))]
 [JsonSerializable(typeof(EntityQuery))]
 [JsonSerializable(typeof(EntitySelect))]
-[JsonSerializable(typeof(JsonPatchDocument))]
+[JsonSerializable(typeof(IJsonPatchDocument))]
 #endregion
 public partial class DomainJsonContext : JsonSerializerContext
 {

diff --git a/samples/Tracker.WebService.EntityFrameworkCore/Endpoints/AuditEndpoint.cs b/samples/Tracker.WebService.EntityFrameworkCore/Endpoints/AuditEndpoint.cs
@@ -1,14 +1,18 @@
 using System;
 using MediatR;
 using MediatR.CommandQuery.Endpoints;
+
+using Microsoft.Extensions.Logging;
+
 using Tracker.WebService.Domain.Models;
 
 namespace Tracker.WebService.Endpoints;
 
 [RegisterTransient<IFeatureEndpoint>(Duplicate = DuplicateStrategy.Append)]
 public class AuditEndpoint : EntityCommandEndpointBase<Guid, AuditReadModel, AuditReadModel, AuditCreateModel, AuditUpdateModel>
 {
-    public AuditEndpoint(IMediator mediator) : base(mediator, "Audit")
+    public AuditEndpoint(ILoggerFactory loggerFactory, IMediator mediator)
+        : base(loggerFactory, mediator, "Audit")
     {
 
     }

diff --git a/samples/Tracker.WebService.EntityFrameworkCore/Endpoints/PriorityEndpoint.cs b/samples/Tracker.WebService.EntityFrameworkCore/Endpoints/PriorityEndpoint.cs
@@ -1,14 +1,17 @@
 using System;
 using MediatR;
 using MediatR.CommandQuery.Endpoints;
+using Microsoft.Extensions.Logging;
+
 using Tracker.WebService.Domain.Models;
 
 namespace Tracker.WebService.Endpoints;
 
 [RegisterTransient<IFeatureEndpoint>(Duplicate = DuplicateStrategy.Append)]
 public class PriorityEndpoint : EntityCommandEndpointBase<Guid, PriorityReadModel, PriorityReadModel, PriorityCreateModel, PriorityUpdateModel>
 {
-    public PriorityEndpoint(IMediator mediator) : base(mediator, "Priority")
+    public PriorityEndpoint(ILoggerFactory loggerFactory, IMediator mediator)
+        : base(loggerFactory, mediator, "Priority")
     {
 
     }

diff --git a/samples/Tracker.WebService.EntityFrameworkCore/Endpoints/RoleEndpoint.cs b/samples/Tracker.WebService.EntityFrameworkCore/Endpoints/RoleEndpoint.cs
@@ -1,14 +1,18 @@
 using System;
 using MediatR;
 using MediatR.CommandQuery.Endpoints;
+
+using Microsoft.Extensions.Logging;
+
 using Tracker.WebService.Domain.Models;
 
 namespace Tracker.WebService.Endpoints;
 
 [RegisterTransient<IFeatureEndpoint>(Duplicate = DuplicateStrategy.Append)]
 public class RoleEndpoint : EntityCommandEndpointBase<Guid, RoleReadModel, RoleReadModel, RoleCreateModel, RoleUpdateModel>
 {
-    public RoleEndpoint(IMediator mediator) : base(mediator, "Role")
+    public RoleEndpoint(ILoggerFactory loggerFactory, IMediator mediator)
+        : base(loggerFactory, mediator, "Role")
     {
 
     }

diff --git a/samples/Tracker.WebService.EntityFrameworkCore/Endpoints/StatusEndpoint.cs b/samples/Tracker.WebService.EntityFrameworkCore/Endpoints/StatusEndpoint.cs
@@ -1,14 +1,18 @@
 using System;
 using MediatR;
 using MediatR.CommandQuery.Endpoints;
+
+using Microsoft.Extensions.Logging;
+
 using Tracker.WebService.Domain.Models;
 
 namespace Tracker.WebService.Endpoints;
 
 [RegisterTransient<IFeatureEndpoint>(Duplicate = DuplicateStrategy.Append)]
 public class StatusEndpoint : EntityCommandEndpointBase<Guid, StatusReadModel, StatusReadModel, StatusCreateModel, StatusUpdateModel>
 {
-    public StatusEndpoint(IMediator mediator) : base(mediator, "Status")
+    public StatusEndpoint(ILoggerFactory loggerFactory, IMediator mediator)
+        : base(loggerFactory, mediator, "Status")
     {
 
     }

diff --git a/samples/Tracker.WebService.EntityFrameworkCore/Endpoints/TaskEndpoint.cs b/samples/Tracker.WebService.EntityFrameworkCore/Endpoints/TaskEndpoint.cs
@@ -1,14 +1,18 @@
 using System;
 using MediatR;
 using MediatR.CommandQuery.Endpoints;
+
+using Microsoft.Extensions.Logging;
+
 using Tracker.WebService.Domain.Models;
 
 namespace Tracker.WebService.Endpoints;
 
 [RegisterTransient<IFeatureEndpoint>(Duplicate = DuplicateStrategy.Append)]
 public class TaskEndpoint : EntityCommandEndpointBase<Guid, TaskReadModel, TaskReadModel, TaskCreateModel, TaskUpdateModel>
 {
-    public TaskEndpoint(IMediator mediator) : base(mediator, "Task")
+    public TaskEndpoint(ILoggerFactory loggerFactory, IMediator mediator)
+        : base(loggerFactory, mediator, "Task")
     {
 
     }

diff --git a/samples/Tracker.WebService.EntityFrameworkCore/Endpoints/UserEndpoint.cs b/samples/Tracker.WebService.EntityFrameworkCore/Endpoints/UserEndpoint.cs
@@ -1,14 +1,18 @@
 using System;
 using MediatR;
 using MediatR.CommandQuery.Endpoints;
+
+using Microsoft.Extensions.Logging;
+
 using Tracker.WebService.Domain.Models;
 
 namespace Tracker.WebService.Endpoints;
 
 [RegisterTransient<IFeatureEndpoint>(Duplicate = DuplicateStrategy.Append)]
 public class UserEndpoint : EntityCommandEndpointBase<Guid, UserReadModel, UserReadModel, UserCreateModel, UserUpdateModel>
 {
-    public UserEndpoint(IMediator mediator) : base(mediator, "User")
+    public UserEndpoint(ILoggerFactory loggerFactory, IMediator mediator)
+        : base(loggerFactory, mediator, "User")
     {
 
     }

diff --git a/samples/Tracker.WebService.EntityFrameworkCore/Endpoints/UserLoginEndpoint.cs b/samples/Tracker.WebService.EntityFrameworkCore/Endpoints/UserLoginEndpoint.cs
@@ -1,14 +1,18 @@
 using System;
 using MediatR;
 using MediatR.CommandQuery.Endpoints;
+
+using Microsoft.Extensions.Logging;
+
 using Tracker.WebService.Domain.Models;
 
 namespace Tracker.WebService.Endpoints;
 
 [RegisterTransient<IFeatureEndpoint>(Duplicate = DuplicateStrategy.Append)]
 public class UserLoginEndpoint : EntityCommandEndpointBase<Guid, UserLoginReadModel, UserLoginReadModel, UserLoginCreateModel, UserLoginUpdateModel>
 {
-    public UserLoginEndpoint(IMediator mediator) : base(mediator, "UserLogin")
+    public UserLoginEndpoint(ILoggerFactory loggerFactory, IMediator mediator)
+        : base(loggerFactory, mediator, "UserLogin")
     {
 
     }

diff --git a/samples/Tracker.WebService.EntityFrameworkCore/generation.yml b/samples/Tracker.WebService.EntityFrameworkCore/generation.yml
@@ -6,6 +6,8 @@ project:
 database:
   provider: SqlServer
   connectionString: 'Data Source=(local);Initial Catalog=TrackerService;Integrated Security=True;TrustServerCertificate=True'
+  schemas:
+    - dbo
 data:
   context:
     name: '{Database.Name}Context'

diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -40,7 +40,7 @@
   <ItemGroup>
     <PackageReference Include="AssemblyMetadata.Generators" Version="2.1.0" PrivateAssets="All" />
     <PackageReference Include="MinVer" Version="6.0.0" PrivateAssets="All" />
-    <PackageReference Include="Meziantou.Analyzer" Version="2.0.177" PrivateAssets="All" />
+    <PackageReference Include="Meziantou.Analyzer" Version="2.0.178" PrivateAssets="All" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/src/MediatR.CommandQuery.Endpoints/DispatcherEndpoint.cs b/src/MediatR.CommandQuery.Endpoints/DispatcherEndpoint.cs
@@ -4,8 +4,10 @@
 
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Http.HttpResults;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Routing;
+using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 
 namespace MediatR.CommandQuery.Endpoints;
@@ -14,11 +16,17 @@ public class DispatcherEndpoint : IFeatureEndpoint
 {
     private readonly ISender _sender;
     private readonly DispatcherOptions _dispatcherOptions;
+    private readonly ILogger<DispatcherEndpoint> _logger;
 
-    public DispatcherEndpoint(ISender sender, IOptions<DispatcherOptions> dispatcherOptions)
+    public DispatcherEndpoint(ILogger<DispatcherEndpoint> logger, ISender sender, IOptions<DispatcherOptions> dispatcherOptions)
     {
+        ArgumentNullException.ThrowIfNull(logger);
+        ArgumentNullException.ThrowIfNull(sender);
+        ArgumentNullException.ThrowIfNull(dispatcherOptions);
+
         _sender = sender;
         _dispatcherOptions = dispatcherOptions.Value;
+        _logger = logger ?? throw new ArgumentNullException(nameof(logger));
     }
 
     public void AddRoutes(IEndpointRouteBuilder app)
@@ -28,27 +36,30 @@ public void AddRoutes(IEndpointRouteBuilder app)
 
         group
             .MapPost(_dispatcherOptions.SendRoute, Send)
-            .WithTags("Dispatcher")
+            .WithEntityMetadata("Dispatcher")
             .WithName($"Send")
             .WithSummary("Send Mediator command")
             .WithDescription("Send Mediator command");
     }
 
-    protected virtual async Task<IResult> Send(
+    protected virtual async Task<Results<Ok<object>, ProblemHttpResult>> Send(
         [FromBody] DispatchRequest dispatchRequest,
         ClaimsPrincipal? user = default,
         CancellationToken cancellationToken = default)
     {
         try
         {
             var request = dispatchRequest.Request;
+
             var result = await _sender.Send(request, cancellationToken).ConfigureAwait(false);
-            return Results.Ok(result);
+            return TypedResults.Ok(result);
         }
         catch (Exception ex)
         {
+            _logger.LogError(ex, "Error dispatching request: {ErrorMessage}", ex.Message);
+
             var details = ex.ToProblemDetails();
-            return Results.Problem(details);
+            return TypedResults.Problem(details);
         }
     }
 }