Feat: Application Info in Agent Signature (via IAgentSignatureAugment…

…er) (entitydb-io#37) * feat: agent signature augmenter * test: agent signature augmenter * refactor: don't allow null just use an empty dictionary * chore: fix warning
trax-retail · May 19, 2022 · 44eb07a · 44eb07a
1 parent bd4b735
commit 44eb07a
Show file tree

Hide file tree

Showing 8 changed files with 141 additions and 12 deletions.
diff --git a/src/EntityDb.Abstractions/Agents/IAgentSignatureAugmenter.cs b/src/EntityDb.Abstractions/Agents/IAgentSignatureAugmenter.cs
@@ -0,0 +1,16 @@
+using System.Collections.Generic;
+
+namespace EntityDb.Abstractions.Agents;
+
+/// <summary>
+///     Represents a type that can augment an agent signature by
+///     providing additional, application-specific information.
+/// </summary>
+public interface IAgentSignatureAugmenter
+{
+    /// <summary>
+    ///     Returns a dictionary of application-specific information.
+    /// </summary>
+    /// <returns>A dictionary of application-specific information.</returns>
+    Dictionary<string, string> GetApplicationInfo();
+}
diff --git a/src/EntityDb.Mvc/Agents/HttpContextAgent.cs b/src/EntityDb.Mvc/Agents/HttpContextAgent.cs
@@ -2,10 +2,16 @@
 using EntityDb.Abstractions.ValueObjects;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.Options;
+using System.Collections.Generic;
 
 namespace EntityDb.Mvc.Agents;
 
-internal record HttpContextAgent(HttpContext HttpContext, IOptionsFactory<HttpContextAgentSignatureOptions> HttpContextAgentSignatureOptionsFactory) : IAgent
+internal record HttpContextAgent
+(
+    HttpContext HttpContext,
+    IOptionsFactory<HttpContextAgentSignatureOptions> HttpContextAgentSignatureOptionsFactory,
+    Dictionary<string, string> ApplicationInfo
+) : IAgent
 {
     public TimeStamp GetTimeStamp()
     {
@@ -14,6 +20,11 @@ public TimeStamp GetTimeStamp()
 
     public object GetSignature(string signatureOptionsName)
     {
-        return HttpContextAgentSignature.GetSnapshot(HttpContext, HttpContextAgentSignatureOptionsFactory.Create(signatureOptionsName));
+        return HttpContextAgentSignature.GetSnapshot
+        (
+            HttpContext,
+            HttpContextAgentSignatureOptionsFactory.Create(signatureOptionsName),
+            ApplicationInfo
+        );
     }
 }
diff --git a/src/EntityDb.Mvc/Agents/HttpContextAgentAccessor.cs b/src/EntityDb.Mvc/Agents/HttpContextAgentAccessor.cs
@@ -3,20 +3,30 @@
 using EntityDb.Common.Exceptions;
 using Microsoft.AspNetCore.Http;
 using Microsoft.Extensions.Options;
+using System.Collections.Generic;
 
 namespace EntityDb.Mvc.Agents;
 
 internal sealed class HttpContextAgentAccessor : AgentAccessorBase
 {
     private readonly IHttpContextAccessor _httpContextAccessor;
     private readonly IOptionsFactory<HttpContextAgentSignatureOptions> _httpContextAgentOptionsFactory;
+    private readonly IAgentSignatureAugmenter? _agentSignatureAugmenter;
 
-    public HttpContextAgentAccessor(IHttpContextAccessor httpContextAccessor, IOptionsFactory<HttpContextAgentSignatureOptions> httpContextAgentOptionsFactory)
+    public HttpContextAgentAccessor
+    (
+        IHttpContextAccessor httpContextAccessor,
+        IOptionsFactory<HttpContextAgentSignatureOptions> httpContextAgentOptionsFactory,
+        IAgentSignatureAugmenter? agentSignatureAugmenter = null
+    )
     {
         _httpContextAccessor = httpContextAccessor;
         _httpContextAgentOptionsFactory = httpContextAgentOptionsFactory;
+        _agentSignatureAugmenter = agentSignatureAugmenter;
     }
 
+    private static readonly Dictionary<string, string> DefaultApplicationInfo = new();
+
     protected override IAgent CreateAgent()
     {
         var httpContext = _httpContextAccessor.HttpContext;
@@ -26,6 +36,9 @@ protected override IAgent CreateAgent()
             throw new NoAgentException();
         }
 
-        return new HttpContextAgent(httpContext, _httpContextAgentOptionsFactory);
+        var applicationInfo = _agentSignatureAugmenter?
+            .GetApplicationInfo() ?? DefaultApplicationInfo;
+
+        return new HttpContextAgent(httpContext, _httpContextAgentOptionsFactory, applicationInfo);
     }
 }
diff --git a/src/EntityDb.Mvc/Agents/HttpContextAgentSignature.cs b/src/EntityDb.Mvc/Agents/HttpContextAgentSignature.cs
@@ -52,7 +52,8 @@ int LocalPort
     public sealed record Snapshot
     (
         RequestSnapshot Request,
-        ConnectionSnapshot Connection
+        ConnectionSnapshot Connection,
+        Dictionary<string, string> ApplicationInfo
     );
 
     private static NameValuesPairSnapshot[] GetNameValuesPairSnapshots(IEnumerable<KeyValuePair<string, StringValues>> dictionary, string[] redactedKeys, string redactedValue)
@@ -92,12 +93,18 @@ private static ConnectionSnapshot GetConnectionSnapshot(ConnectionInfo connectio
         );
     }
 
-    internal static Snapshot GetSnapshot(HttpContext httpContext, HttpContextAgentSignatureOptions httpContextAgentOptions)
+    internal static Snapshot GetSnapshot
+    (
+        HttpContext httpContext,
+        HttpContextAgentSignatureOptions httpContextAgentOptions,
+        Dictionary<string, string> applicationInfo
+    )
     {
         return new Snapshot
         (
             GetRequestSnapshot(httpContext.Request, httpContextAgentOptions),
-            GetConnectionSnapshot(httpContext.Connection)
+            GetConnectionSnapshot(httpContext.Connection),
+            applicationInfo
         );
     }
 }
diff --git a/test/EntityDb.Common.Tests/Agents/AgentAccessorTestsBase.cs b/test/EntityDb.Common.Tests/Agents/AgentAccessorTestsBase.cs
@@ -4,6 +4,8 @@
 using Shouldly;
 using System;
 using System.Collections.Generic;
+using Microsoft.Extensions.DependencyInjection.Extensions;
+using Moq;
 using Xunit;
 
 namespace EntityDb.Common.Tests.Agents;
@@ -19,6 +21,8 @@ protected AgentAccessorTestsBase(IServiceProvider startupServiceProvider) : base
 
     protected abstract void ConfigureActiveAgentAccessor(IServiceCollection serviceCollection, TAgentAccessorConfiguration agentAccessorConfiguration);
 
+    protected abstract Dictionary<string, string>? GetApplicationInfo(object agentSignature);
+
     protected abstract IEnumerable<TAgentAccessorConfiguration> GetAgentAccessorOptions();
 
     [Fact]
@@ -109,4 +113,74 @@ public void GivenBackingServiceActive_WhenGettingAgentSignature_ThenReturnAgentS
             agentSignature.ShouldNotBeNull();
         }
     }
+
+    [Fact]
+    public void GivenBackingServiceActiveAndNoSignatureAugmenter_WhenGettingApplicationInfo_ThenReturnEmptyApplicationInfo()
+    {
+        foreach (var agentAccessorConfiguration in GetAgentAccessorOptions())
+        {
+            // ARRANGE
+
+            using var serviceScope = CreateServiceScope(serviceCollection =>
+            {
+                ConfigureActiveAgentAccessor(serviceCollection, agentAccessorConfiguration);
+
+                serviceCollection.RemoveAll(typeof(IAgentSignatureAugmenter));
+            });
+
+            var agentAccessor = serviceScope.ServiceProvider
+                .GetRequiredService<IAgentAccessor>();
+
+            // ACT
+
+            var agentSignature = agentAccessor.GetAgent().GetSignature("").ShouldNotBeNull();
+
+            var applicationInfo = GetApplicationInfo(agentSignature);
+
+            // ASSERT
+
+            applicationInfo.ShouldBeEmpty();
+        }
+    }
+
+
+    [Fact]
+    public void GivenBackingServiceActiveAndHasSignatureAugmenter_WhenGettingApplicationInfo_ThenReturnExpectedApplicationInfo()
+    {
+        foreach (var agentAccessorConfiguration in GetAgentAccessorOptions())
+        {
+            // ARRANGE
+
+            var expectedApplicationInfo = new Dictionary<string, string>
+            {
+                ["UserId"] = Guid.NewGuid().ToString()
+            };
+
+            var agentSignatureAugmenterMock = new Mock<IAgentSignatureAugmenter>(MockBehavior.Strict);
+
+            agentSignatureAugmenterMock
+                .Setup(x => x.GetApplicationInfo())
+                .Returns(expectedApplicationInfo);
+
+            using var serviceScope = CreateServiceScope(serviceCollection =>
+            {
+                ConfigureActiveAgentAccessor(serviceCollection, agentAccessorConfiguration);
+
+                serviceCollection.AddSingleton(agentSignatureAugmenterMock.Object);
+            });
+
+            var agentAccessor = serviceScope.ServiceProvider
+                .GetRequiredService<IAgentAccessor>();
+
+            // ACT
+
+            var agentSignature = agentAccessor.GetAgent().GetSignature("");
+
+            var actualApplicationInfo = GetApplicationInfo(agentSignature);
+
+            // ASSERT
+
+            actualApplicationInfo.ShouldBe(expectedApplicationInfo);
+        }
+    }
 }
diff --git a/test/EntityDb.Mvc.Tests/Agents/HttpContextAgentAccessorTests.cs b/test/EntityDb.Mvc.Tests/Agents/HttpContextAgentAccessorTests.cs
@@ -5,6 +5,7 @@
 using Moq;
 using System;
 using System.Collections.Generic;
+using EntityDb.Mvc.Agents;
 
 namespace EntityDb.Mvc.Tests.Agents;
 
@@ -58,4 +59,11 @@ protected override IEnumerable<HttpContextSeederOptions> GetAgentAccessorOptions
             }
         };
     }
+
+    protected override Dictionary<string, string>? GetApplicationInfo(object agentSignature)
+    {
+        return agentSignature is not HttpContextAgentSignature.Snapshot httpContextAgentSignature
+            ? null
+            : httpContextAgentSignature.ApplicationInfo;
+    }
 }
diff --git a/test/EntityDb.Mvc.Tests/Agents/HttpContextAgentSignatureTests.cs b/test/EntityDb.Mvc.Tests/Agents/HttpContextAgentSignatureTests.cs
@@ -32,7 +32,7 @@ public void GivenNoRedactedHeaders_WhenHttpContextHasHeader_ThenAgentSignatureHa
 
         // ACT
 
-        var (request, _) = HttpContextAgentSignature.GetSnapshot(httpContext, httpContextAgentOptions);
+        var (request, _, _) = HttpContextAgentSignature.GetSnapshot(httpContext, httpContextAgentOptions, default!);
 
         // ASSERT
 
@@ -67,7 +67,7 @@ public void GivenRedactedHeader_WhenHttpContextContainsOnlyThatHeader_ThenAgentS
 
         // ACT
 
-        var (request, _) = HttpContextAgentSignature.GetSnapshot(httpContext, httpContextAgentOptions);
+        var (request, _, _) = HttpContextAgentSignature.GetSnapshot(httpContext, httpContextAgentOptions, default!);
 
         // ASSERT
 
@@ -100,7 +100,7 @@ public void GivenNoRedactedQueryStringParams_WhenHttpContextHasQueryStringParam_
 
         // ACT
 
-        var (request, _) = HttpContextAgentSignature.GetSnapshot(httpContext, httpContextAgentOptions);
+        var (request, _, _) = HttpContextAgentSignature.GetSnapshot(httpContext, httpContextAgentOptions, default!);
 
         // ASSERT
 
@@ -135,7 +135,7 @@ public void GivenRedactedQueryStringParam_WhenHttpContextContainsOnlyThatQuerySt
 
         // ACT
 
-        var (request, _) = HttpContextAgentSignature.GetSnapshot(httpContext, httpContextAgentOptions);
+        var (request, _, _) = HttpContextAgentSignature.GetSnapshot(httpContext, httpContextAgentOptions, default!);
 
         // ASSERT
 

diff --git a/test/EntityDb.Mvc.Tests/Seeder/HttpContextSeeder.cs b/test/EntityDb.Mvc.Tests/Seeder/HttpContextSeeder.cs
@@ -15,7 +15,7 @@ private static ConnectionInfo CreateConnectionInfo(HttpContextSeederOptions http
 
         connectionInfoMock
             .SetupGet(info => info.Id)
-            .Returns(Id.NewId().ToString());
+            .Returns(Id.NewId().ToString()!);
 
         var faker = new Faker();