fix: put an activity with the service handler context for better visibility into service behaviour

Author: corstian

src/Whaally.Domain/Abstractions/Service/IServiceHandlerContext.cs

@@ -2,7 +2,7 @@
 
 namespace Whaally.Domain.Abstractions;
 
-public interface IServiceHandlerContext : IContext
+public interface IServiceHandlerContext : IContext, IDisposable
 {
     /// <summary>
     /// The optimistic result of the evaluation of this service.

src/Whaally.Domain/DefaultEvaluationAgent.cs

@@ -34,7 +34,7 @@ public async Task<IResult<ICommandEnvelope[]>> Evaluate(IServiceEnvelope service
         if (serviceEnvelope.Messages.Count() != 1)
             throw new ArgumentException($"Expected {nameof(serviceEnvelope)} to contain one message");
 
-        var serviceContext = _contextFactory.CreateServiceHandlerContext(serviceEnvelope.Metadata);
+        using var serviceContext = _contextFactory.CreateServiceHandlerContext(serviceEnvelope.Metadata);
 
         var result = await _domainContext
             .GetServiceHandler(serviceEnvelope.Messages.Single().GetType())

src/Whaally.Domain/DomainContext.cs

@@ -209,6 +209,7 @@ public virtual async Task<IResult<IEventEnvelope[]>> Trigger(
                 metadata ?? new ServiceMetadata
                 {
                     CreatedAt = DateTimeOffset.UtcNow,
+                    ServiceType = service.GetType(),
                     ParentContext = activity?.Context
                 }, service));
     }

src/Whaally.Domain/Saga/SagaContext.cs

@@ -68,7 +68,8 @@ public virtual async Task<IResultBase> EvaluateService(IService service)
             new ServiceEnvelope(
                 new ServiceMetadata
                 {
-                    CreatedAt = DateTimeOffset.UtcNow
+                    CreatedAt = DateTimeOffset.UtcNow,
+                    ServiceType = service.GetType()
                 }, service));
 
         if (!result.IsSuccess) return result.ToResult();

src/Whaally.Domain/Service/ServiceHandlerContext.cs

@@ -13,7 +13,6 @@ public class ServiceHandlerContext : IServiceHandlerContext
     private readonly DomainContext _domainContext;
 
     private readonly Activity? _activity;
-    // ToDo: Add an activity here to track service evaluation
 
     public ServiceHandlerContext(IServiceProvider services, IServiceMetadata metadata)
     {
@@ -57,6 +56,7 @@ public virtual async Task<IResultBase> EvaluateService<TService>(TService servic
                 new ServiceMetadata
                 {
                     CreatedAt = DateTimeOffset.UtcNow,
+                    ServiceType = service.GetType(),
                     Attributes = new Dictionary<string, object>(Attributes),
                     ParentContext = ParentContext
                 }, service));
@@ -79,6 +79,8 @@ public virtual async Task<IResultBase> EvaluateService<TService>(TService servic
     /// <param name="command">The command to add to the current commands basket</param>
     public virtual void StageCommands(string aggregateId, params ICommand[] commands)
     {
+        foreach (var command in commands) _activity?.AddEvent(new ActivityEvent($"Stage {command.GetType().Name}"));
+        
         var aggregateType = _domainContext.GetCommonAggregateType(commands);
 
         if (!_envelopes.TryGetValue(aggregateId, out var envelope))
@@ -102,4 +104,10 @@ public virtual void StageCommands(string aggregateId, params ICommand[] commands
         _envelopes.Remove(aggregateId);
         _envelopes.Add(aggregateId, envelope);
     }
+
+    public void Dispose()
+    {
+        _evaluationAgent.Dispose();
+        _activity?.Dispose();
+    }
 }