#101 Updated logging to avoid CA1848

Author: sam-s-maher

src/VerticalSliceArchitectureTemplate/Common/Behaviours/LoggingBehaviour.cs

@@ -3,6 +3,18 @@
 
 namespace VerticalSliceArchitectureTemplate.Common.Behaviours;
 
+public static class RequestInformationLogger
+{
+    private static readonly Action<ILogger, string, object, object, Exception?> LogAction =
+        LoggerMessage.Define<string, object, object>(
+            LogLevel.Information,
+            new EventId(2, nameof(RequestInformationLogger)),
+            "CleanArchitecture Request: {Name} {@UserId} {@Request}");
+
+    public static void Log(ILogger logger, string name, object userId, object request) =>
+        LogAction(logger, name, userId, request, null);
+}
+
 public class LoggingBehaviour<TRequest>(ILogger<TRequest> logger, CurrentUserService currentUserService)
     : IRequestPreProcessor<TRequest>
     where TRequest : notnull
@@ -12,8 +24,7 @@ public Task Process(TRequest request, CancellationToken cancellationToken)
         var requestName = typeof(TRequest).Name;
         var userId = currentUserService.UserId ?? string.Empty;
 
-        logger.LogInformation("CleanArchitecture Request: {Name} {@UserId} {@Request}",
-            requestName, userId, request);
+        RequestInformationLogger.Log(logger, requestName, userId, request);
 
         return Task.CompletedTask;
     }

src/VerticalSliceArchitectureTemplate/Common/Behaviours/PerformanceBehaviour.cs

@@ -4,6 +4,18 @@
 
 namespace VerticalSliceArchitectureTemplate.Common.Behaviours;
 
+public static class LongRunningRequestLog
+{
+    private static readonly Action<ILogger, string, long, string, object, Exception?> LogAction =
+        LoggerMessage.Define<string, long, string, object>(
+            LogLevel.Warning,
+            new EventId(3, nameof(LongRunningRequestLog)),
+            "VerticalSliceArchitecture Long Running Request: {Name} ({ElapsedMilliseconds} milliseconds) {@UserId} {@Request}");
+
+    public static void Log(ILogger logger, string name, long elapsedMilliseconds, string userId, object request) =>
+        LogAction(logger, name, elapsedMilliseconds, userId, request, null);
+}
+
 public class PerformanceBehaviour<TRequest, TResponse>(
     ILogger<TRequest> logger,
     CurrentUserService currentUserService)
@@ -28,9 +40,7 @@ public async Task<TResponse> Handle(TRequest request, RequestHandlerDelegate<TRe
             var requestName = typeof(TRequest).Name;
             var userId = currentUserService.UserId ?? string.Empty;
 
-            logger.LogWarning(
-                "CleanArchitecture Long Running Request: {Name} ({ElapsedMilliseconds} milliseconds) {@UserId} {@Request}",
-                requestName, elapsedMilliseconds, userId, request);
+            LongRunningRequestLog.Log(logger, requestName, elapsedMilliseconds, userId, request);
         }
 
         return response;

src/VerticalSliceArchitectureTemplate/Common/Behaviours/UnhandledExceptionBehaviour.cs

@@ -2,6 +2,18 @@
 
 namespace VerticalSliceArchitectureTemplate.Common.Behaviours;
 
+public static class UnhandledExceptionBehaviourLogger
+{
+    private static readonly Action<ILogger, string, object, Exception> LogAction =
+        LoggerMessage.Define<string, object>(
+            LogLevel.Error,
+            new EventId(1, nameof(UnhandledExceptionBehaviourLogger)),
+            "VerticalSliceArchitecture Request: Unhandled Exception for Request {Name} {@Request}");
+
+    public static void Log(ILogger logger, string name, object request, Exception exception) =>
+        LogAction(logger, name, request, exception);
+}
+
 public class UnhandledExceptionBehaviour<TRequest, TResponse>(ILogger<TRequest> logger)
     : IPipelineBehavior<TRequest, TResponse>
     where TRequest : notnull
@@ -17,8 +29,7 @@ public async Task<TResponse> Handle(TRequest request, RequestHandlerDelegate<TRe
         {
             var requestName = typeof(TRequest).Name;
 
-            logger.LogError(ex, "CleanArchitecture Request: Unhandled Exception for Request {Name} {@Request}",
-                requestName, request);
+            UnhandledExceptionBehaviourLogger.Log(logger, requestName, request, ex);
 
             throw;
         }

src/VerticalSliceArchitectureTemplate/Common/Domain/BaseEntity.cs

@@ -4,5 +4,10 @@ namespace VerticalSliceArchitectureTemplate.Common.Domain;
 
 public abstract class BaseEntity
 {
-    public readonly List<INotification> StagedEvents = [];
+    private readonly List<INotification> _stagedEvents = [];
+
+    public IReadOnlyList<INotification> StagedEvents => _stagedEvents;
+
+    protected void AddEvent(INotification notification) => _stagedEvents.Add(notification);
+    public void ClearEvents() => _stagedEvents.Clear();
 }

src/VerticalSliceArchitectureTemplate/Common/Persistence/EventPublisher.cs

@@ -35,7 +35,7 @@ private async Task DispatchDomainEvents(DbContext? context)
             .SelectMany(e => e.StagedEvents)
             .ToList();
 
-        entities.ForEach(e => e.StagedEvents.Clear());
+        entities.ForEach(e => e.ClearEvents());
 
         foreach (var domainEvent in domainEvents)
             await mediator.Publish(domainEvent);

src/VerticalSliceArchitectureTemplate/Features/Todos/Domain/Todo.cs

@@ -8,7 +8,7 @@ public class Todo : BaseEntity
 {
     public Todo()
     {
-        StagedEvents.Add(new TodoCreatedEvent(Id));
+        AddEvent(new TodoCreatedEvent(Id));
     }
 
     public Guid Id { get; init; }
@@ -27,6 +27,6 @@ public void Complete()
 
         IsCompleted = true;
 
-        StagedEvents.Add(new TodoCompletedEvent(Id));
+        AddEvent(new TodoCompletedEvent(Id));
     }
 }

src/VerticalSliceArchitectureTemplate/Host/EndpointDiscovery.cs

@@ -30,7 +30,7 @@ private static IEnumerable<Type> GetEndpointTypes(params Assembly[] assemblies)
                         x is { IsInterface: false, IsAbstract: false });
     }
 
-    private static MethodInfo? GetMapEndpointsMethod(IReflect type)
+    private static MethodInfo? GetMapEndpointsMethod(Type type)
     {
         return type.GetMethod(nameof(IEndpoints.MapEndpoints),
             BindingFlags.Static | BindingFlags.Public);

src/VerticalSliceArchitectureTemplate/Host/ExceptionHandler.cs

@@ -19,8 +19,8 @@ public static void UseProductionExceptionHandler(this WebApplication app)
 
     public sealed class KnownExceptionsHandler : IExceptionHandler
     {
-        private static readonly IDictionary<Type, Func<HttpContext, Exception, IResult>> ExceptionHandlers =
-            new Dictionary<Type, Func<HttpContext, Exception, IResult>>
+        private static readonly Dictionary<Type, Func<HttpContext, Exception, IResult>> ExceptionHandlers =
+            new()
             {
                 { typeof(ValidationException), HandleValidationException },
                 { typeof(InvalidOperationException), HandleInvalidOperationException },

src/VerticalSliceArchitectureTemplate/VerticalSliceArchitectureTemplate.csproj

@@ -15,4 +15,8 @@
         <PackageReference Include="ErrorOr" />
     </ItemGroup>
 
+    <ItemGroup>
+      <Folder Include="Common\Logging\" />
+    </ItemGroup>
+
 </Project>

tests/VerticalSliceArchitecture.ArchTests/TestBase.cs

@@ -7,7 +7,7 @@ public abstract class TestBase
 {
     private static readonly Types ProgramTypes = Types.InAssembly(typeof(Program).Assembly);
 
-    protected PredicateList TypesMatchingAnyPattern(params string[] patterns)
+    protected static PredicateList TypesMatchingAnyPattern(params string[] patterns)
     {
         var output = ProgramTypes.That();