Merge pull request #5926 from Particular/split-audit-store

Split up saga and message audit stores

Author: johnsimons

src/ServiceControl.Audit.Persistence.InMemory/InMemoryAuditDataStore.cs

@@ -11,7 +11,7 @@
     using ServiceControl.Audit.Infrastructure;
     using ServiceControl.SagaAudit;
 
-    class InMemoryAuditDataStore : IAuditDataStore
+    class InMemoryAuditDataStore : IAuditMessagesViewDataStore, ISagaHistoryDataStore
     {
         IBodyStorage bodyStorage;
         public List<FailedAuditImport> failedAuditImports;

src/ServiceControl.Audit.Persistence.InMemory/InMemoryPersistence.cs

@@ -10,7 +10,8 @@ public void AddPersistence(IServiceCollection services)
         {
             services.AddSingleton(persistenceSettings);
             services.AddSingleton<InMemoryAuditDataStore>();
-            services.AddSingleton<IAuditDataStore>(sp => sp.GetRequiredService<InMemoryAuditDataStore>());
+            services.AddSingleton<IAuditMessagesViewDataStore>(sp => sp.GetRequiredService<InMemoryAuditDataStore>());
+            services.AddSingleton<ISagaHistoryDataStore>(sp => sp.GetRequiredService<InMemoryAuditDataStore>());
             services.AddSingleton<IBodyStorage, InMemoryAttachmentsBodyStorage>();
             services.AddSingleton<IFailedAuditStorage, InMemoryFailedAuditStorage>();
             services.AddSingleton<IAuditIngestionUnitOfWorkFactory, InMemoryAuditIngestionUnitOfWorkFactory>();

src/ServiceControl.Audit.Persistence.RavenDB/RavenAuditDataStore.cs

@@ -16,7 +16,7 @@ namespace ServiceControl.Audit.Persistence.RavenDB
     using Transformers;
 
     class RavenAuditDataStore(IRavenSessionProvider sessionProvider, DatabaseConfiguration databaseConfiguration)
-        : IAuditDataStore
+        : IAuditMessagesViewDataStore, ISagaHistoryDataStore
     {
         public async Task<QueryResult<SagaHistory>> QuerySagaHistoryById(Guid input, CancellationToken cancellationToken = default)
         {

src/ServiceControl.Audit.Persistence.RavenDB/RavenPersistence.cs

@@ -25,7 +25,9 @@ public void AddPersistence(IServiceCollection services)
                 endpointConfiguration.AddCustomCheck<CheckRavenDBSearchEngine>();
             }
 
-            services.AddSingleton<IAuditDataStore, RavenAuditDataStore>();
+            services.AddSingleton<RavenAuditDataStore>();
+            services.AddSingleton<IAuditMessagesViewDataStore>(sp => sp.GetRequiredService<RavenAuditDataStore>());
+            services.AddSingleton<ISagaHistoryDataStore>(sp => sp.GetRequiredService<RavenAuditDataStore>());
             services.AddSingleton<IAuditIngestionUnitOfWorkFactory, RavenAuditIngestionUnitOfWorkFactory>();
             services.AddSingleton<IFailedAuditStorage, RavenFailedAuditStorage>();
             services.AddSingleton<MinimumRequiredStorageState>();

src/ServiceControl.Audit.Persistence.Tests.RavenDB/EmbeddedLifecycleTests.cs

@@ -37,7 +37,7 @@ public override async Task Setup()
         [Test]
         public async Task Verify_embedded_database()
         {
-            await DataStore.GetMessages(false, new PagingInfo(), new SortInfo("Id", "asc"), cancellationToken: TestContext.CurrentContext.CancellationToken);
+            await MessagesViewStore.GetMessages(false, new PagingInfo(), new SortInfo("Id", "asc"), cancellationToken: TestContext.CurrentContext.CancellationToken);
 
             using (Assert.EnterMultipleScope())
             {

src/ServiceControl.Audit.Persistence.Tests.RavenDB/PersistenceTestsConfiguration.cs

@@ -16,7 +16,9 @@
 
     class PersistenceTestsConfiguration
     {
-        public IAuditDataStore AuditDataStore { get; private set; }
+        public IAuditMessagesViewDataStore MessagesViewStore { get; private set; }
+
+        public ISagaHistoryDataStore SagaHistoryStore { get; private set; }
 
         public IFailedAuditStorage FailedAuditStorage { get; private set; }
 
@@ -78,7 +80,8 @@ public async Task Configure(Action<PersistenceSettings> setSettings)
             host = hostBuilder.Build();
             await host.StartAsync();
 
-            AuditDataStore = host.Services.GetRequiredService<IAuditDataStore>();
+            MessagesViewStore = host.Services.GetRequiredService<IAuditMessagesViewDataStore>();
+            SagaHistoryStore = host.Services.GetRequiredService<ISagaHistoryDataStore>();
             FailedAuditStorage = host.Services.GetRequiredService<IFailedAuditStorage>();
 
             var documentStoreProvider = host.Services.GetRequiredService<IRavenDocumentStoreProvider>();

src/ServiceControl.Audit.Persistence.Tests.RavenDB/ProcessedMessageIdTests.cs

@@ -33,7 +33,7 @@ public async Task Retains_existing_document_and_body_ids()
             var expectedId = $"ProcessedMessages-{started.UtcDateTime.Ticks}-{message.GetProcessingId()}";
             Assert.That(message.Id, Is.EqualTo(expectedId));
             Assert.That(message.MessageMetadata["BodyUrl"], Is.EqualTo($"/messages/{expectedId}/body"));
-            var body = await DataStore.GetMessageBody(expectedId);
+            var body = await MessagesViewStore.GetMessageBody(expectedId);
             Assert.That(body.HasContent, Is.True);
             body.StreamContent.Dispose();
         }

src/ServiceControl.Audit.Persistence.Tests.RavenDB/RetentionTests.cs

@@ -43,7 +43,7 @@ public async Task AuditMessageRetention()
             Assert.That(queryResultAfterExpiration.Results, Is.Empty);
 
             Task<QueryResult<IList<MessagesView>>> QueryMessages(CancellationToken cancellationToken) =>
-                DataStore.QueryMessages("MyMessageId", new PagingInfo(), new SortInfo("Id", "asc"), cancellationToken: cancellationToken);
+                MessagesViewStore.QueryMessages("MyMessageId", new PagingInfo(), new SortInfo("Id", "asc"), cancellationToken: cancellationToken);
         }
 
         [Test]
@@ -70,7 +70,7 @@ await IngestSagaAudits(
             Assert.That(queryResultAfterExpiration.Results, Is.Null);
 
             Task<QueryResult<SagaHistory>> QuerySagaHistory(CancellationToken cancellationToken) =>
-                DataStore.QuerySagaHistoryById(sagaId, cancellationToken);
+                SagaHistoryStore.QuerySagaHistoryById(sagaId, cancellationToken);
         }
 
         // The retention window starts at ingestion, so building the indexes of the fresh database must

src/ServiceControl.Audit.Persistence.Tests/AuditCountingTests.cs

@@ -46,9 +46,9 @@ public async Task ShouldCountAuditedMessages()
 
             await IngestProcessedMessagesAudits(messages);
 
-            var endpointA = (await DataStore.QueryAuditCounts("EndpointA", TestContext.CurrentContext.CancellationToken)).Results;
-            var endpointB = (await DataStore.QueryAuditCounts("EndpointB", TestContext.CurrentContext.CancellationToken)).Results;
-            var sysMsgEndpoint = (await DataStore.QueryAuditCounts("SystemEndpoint", TestContext.CurrentContext.CancellationToken)).Results;
+            var endpointA = (await MessagesViewStore.QueryAuditCounts("EndpointA", TestContext.CurrentContext.CancellationToken)).Results;
+            var endpointB = (await MessagesViewStore.QueryAuditCounts("EndpointB", TestContext.CurrentContext.CancellationToken)).Results;
+            var sysMsgEndpoint = (await MessagesViewStore.QueryAuditCounts("SystemEndpoint", TestContext.CurrentContext.CancellationToken)).Results;
 
             Assert.That(sysMsgEndpoint, Is.Empty);
 
@@ -83,7 +83,7 @@ public async Task Should_return_zero_throughput_entry_when_SendOnly()
             await IngestProcessedMessagesAudits(messages);
 
             // Act
-            var result = (await DataStore.QueryAuditCounts(sendOnlyEndpoint, TestContext.CurrentContext.CancellationToken)).Results;
+            var result = (await MessagesViewStore.QueryAuditCounts(sendOnlyEndpoint, TestContext.CurrentContext.CancellationToken)).Results;
 
             // Assert
             Assert.That(result, Is.Not.Empty, "Expected non-empty result for endpoint that only sent messages");

src/ServiceControl.Audit.Persistence.Tests/AuditDataStoreRegistrationTests.cs

@@ -0,0 +1,18 @@
+namespace ServiceControl.Audit.Persistence.Tests
+{
+    using Microsoft.Extensions.DependencyInjection;
+    using NUnit.Framework;
+
+    [TestFixture]
+    class AuditDataStoreRegistrationTests : PersistenceTestFixture
+    {
+        [Test]
+        public void Should_resolve_all_capabilities_from_one_store_instance()
+        {
+            var messagesViewStore = ServiceProvider.GetRequiredService<IAuditMessagesViewDataStore>();
+            var sagaHistoryStore = ServiceProvider.GetRequiredService<ISagaHistoryDataStore>();
+
+            Assert.That(sagaHistoryStore, Is.SameAs(messagesViewStore));
+        }
+    }
+}