Render index definitions with the conventions the instances deploy with

Author: ramonsmits

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

@@ -6,7 +6,6 @@ namespace ServiceControl.Audit.Persistence.RavenDB
     using System.Threading;
     using System.Threading.Tasks;
     using Raven.Client.Documents;
-    using Raven.Client.Documents.Conventions;
     using ServiceControl.RavenDB;
 
     sealed class RavenExternalPersistenceLifecycle(DatabaseConfiguration configuration) : IRavenPersistenceLifecycle, IRavenDocumentStoreProvider, IDisposable
@@ -40,10 +39,7 @@ public async Task Initialize(CancellationToken cancellationToken = default)
                     Database = configuration.Name,
                     Urls = [configuration.ServerConfiguration.ConnectionString],
                     Certificate = RavenClientCertificate.FindClientCertificate(configuration.ServerConfiguration),
-                    Conventions = new DocumentConventions
-                    {
-                        SaveEnumsAsIntegers = true
-                    }
+                    Conventions = DocumentStoreConventions.Create()
                 };
 
                 documentStore = store.Initialize();

src/ServiceControl.Audit.Persistence.Tests.RavenDB/ApprovalFiles/IndexDefinitionApprovals.Verify_index_definitions_are_unchanged.approved.txt

@@ -10,7 +10,7 @@ MessagesViewIndex
         MessageId = ((string) message.MessageMetadata["MessageId"]),
         MessageType = ((string) message.MessageMetadata["MessageType"]),
         IsSystemMessage = ((bool) message.MessageMetadata["IsSystemMessage"]),
-        Status = ((bool) message.MessageMetadata["IsRetried"]) ? "ResolvedSuccessfully" : "Successful",
+        Status = ((bool) message.MessageMetadata["IsRetried"]) ? 4 : 3,
         TimeSent = ((DateTime) message.MessageMetadata["TimeSent"]),
         ProcessedAt = message.ProcessedAt,
         ReceivingEndpointName = ((message.MessageMetadata["ReceivingEndpoint"])).Name,
@@ -32,7 +32,7 @@ MessagesViewIndexWithFullTextSearch
         MessageId = ((string) message.MessageMetadata["MessageId"]),
         MessageType = ((string) message.MessageMetadata["MessageType"]),
         IsSystemMessage = ((bool) message.MessageMetadata["IsSystemMessage"]),
-        Status = ((bool) message.MessageMetadata["IsRetried"]) ? "ResolvedSuccessfully" : "Successful",
+        Status = ((bool) message.MessageMetadata["IsRetried"]) ? 4 : 3,
         TimeSent = ((DateTime) message.MessageMetadata["TimeSent"]),
         ProcessedAt = message.ProcessedAt,
         ReceivingEndpointName = ((message.MessageMetadata["ReceivingEndpoint"])).Name,

src/ServiceControl.Persistence.RavenDB/RavenExternalPersistenceLifecycle.cs

@@ -6,7 +6,6 @@ namespace ServiceControl.Persistence.RavenDB
     using System.Threading;
     using System.Threading.Tasks;
     using Raven.Client.Documents;
-    using Raven.Client.Documents.Conventions;
     using ServiceControl.RavenDB;
 
     sealed class RavenExternalPersistenceLifecycle(RavenPersisterSettings settings) : IRavenPersistenceLifecycle, IRavenDocumentStoreProvider, IDisposable
@@ -40,10 +39,7 @@ public async Task Initialize(CancellationToken cancellationToken = default)
                     Database = settings.DatabaseName,
                     Urls = [settings.ConnectionString],
                     Certificate = RavenClientCertificate.FindClientCertificate(settings),
-                    Conventions = new DocumentConventions
-                    {
-                        SaveEnumsAsIntegers = true
-                    }
+                    Conventions = DocumentStoreConventions.Create()
                 };
 
                 documentStore = store.Initialize();

src/ServiceControl.Persistence.Tests.RavenDB/ApprovalFiles/IndexDefinitionApprovals.Verify_index_definitions_are_unchanged.approved.txt

@@ -1,6 +1,6 @@
 ArchivedGroupsViewIndex
   Maps:
-    docs.FailedMessages.Where(doc => doc.Status == "Archived").Select(doc => new {
+    docs.FailedMessages.Where(doc => doc.Status == 4).Select(doc => new {
         doc = doc,
         failureTimes = doc.ProcessingAttempts.Select(x => x.FailureDetails.TimeOfFailure)
     }).SelectMany(this0 => this0.doc.FailureGroups, (this0, failureGroup) => new {
@@ -49,7 +49,7 @@ FailedErrorImportIndex
 
 FailedMessageFacetsIndex
   Maps:
-    docs.FailedMessages.Where(failure => failure.Status == "Unresolved").Select(failure => new {
+    docs.FailedMessages.Where(failure => failure.Status == 1).Select(failure => new {
         failure = failure,
         t = ((DynamicEnumerable.LastOrDefault(failure.ProcessingAttempts)).MessageMetadata["ReceivingEndpoint"])
     }).Select(this0 => new {
@@ -105,7 +105,7 @@ FailedMessages/ByGroup
 
 FailureGroupsViewIndex
   Maps:
-    docs.FailedMessages.Where(doc => doc.Status == "Unresolved").Select(doc => new {
+    docs.FailedMessages.Where(doc => doc.Status == 1).Select(doc => new {
         doc = doc,
         failureTimes = doc.ProcessingAttempts.Select(x => x.FailureDetails.TimeOfFailure)
     }).SelectMany(this0 => this0.doc.FailureGroups, (this0, failureGroup) => new {
@@ -155,7 +155,7 @@ MessagesViewIndex
         MessageId = this0.last.MessageId,
         MessageType = ((string) this0.last.MessageMetadata["MessageType"]),
         IsSystemMessage = ((bool) this0.last.MessageMetadata["IsSystemMessage"]),
-        Status = this0.message.Status == "Archived" ? "ArchivedFailure" : (this0.message.Status == "Resolved" ? "ResolvedSuccessfully" : (this0.message.ProcessingAttempts.Count == 1 ? "Failed" : "RepeatedFailure")),
+        Status = this0.message.Status == 4 ? 5 : (this0.message.Status == 2 ? 4 : (this0.message.ProcessingAttempts.Count == 1 ? 1 : 2)),
         TimeSent = ((DateTime) this0.last.MessageMetadata["TimeSent"]),
         ProcessedAt = this0.last.AttemptedAt,
         ReceivingEndpointName = ((this0.last.MessageMetadata["ReceivingEndpoint"])).Name,
@@ -190,8 +190,8 @@ RetryBatches/ByStatus/ReduceInitialBatchSize
     docs.RetryBatches.Select(doc => new {
         RequestId = doc.RequestId,
         RetryType = doc.RetryType,
-        HasStagingBatches = doc.Status == "Staging",
-        HasForwardingBatches = doc.Status == "Forwarding",
+        HasStagingBatches = doc.Status == 2,
+        HasForwardingBatches = doc.Status == 3,
         InitialBatchSize = doc.InitialBatchSize,
         Originator = doc.Originator,
         Classifier = doc.Classifier,

src/ServiceControl.RavenDB/DocumentStoreConventions.cs

@@ -0,0 +1,11 @@
+namespace ServiceControl.RavenDB
+{
+    using Raven.Client.Documents.Conventions;
+
+    public static class DocumentStoreConventions
+    {
+        // The conventions are part of every deployed index definition: a change rebuilds every index. The index
+        // definition approval tests render the definitions with the same conventions, so keep them in one place.
+        public static DocumentConventions Create() => new() { SaveEnumsAsIntegers = true };
+    }
+}

src/ServiceControl.RavenDB/EmbeddedDatabase.cs

@@ -12,7 +12,6 @@ namespace ServiceControl.RavenDB
     using Microsoft.Extensions.Hosting;
     using Microsoft.Extensions.Logging;
     using Raven.Client.Documents;
-    using Raven.Client.Documents.Conventions;
     using Raven.Embedded;
     using ServiceControl.Infrastructure;
     using Sparrow.Logging;
@@ -171,10 +170,7 @@ public async Task<IDocumentStore> Connect(CancellationToken cancellationToken =
         {
             var dbOptions = new DatabaseOptions(configuration.Name)
             {
-                Conventions = new DocumentConventions
-                {
-                    SaveEnumsAsIntegers = true
-                },
+                Conventions = DocumentStoreConventions.Create(),
                 SkipCreatingDatabase = true
             };
 

src/TestHelper/IndexDefinitionText.cs

@@ -6,6 +6,7 @@ namespace TestHelper;
 using System.Reflection;
 using System.Text;
 using Raven.Client.Documents.Indexes;
+using ServiceControl.RavenDB;
 
 /// <summary>
 /// Renders the parts of an index definition that RavenDB compares when ServiceControl deploys its indexes at
@@ -29,6 +30,8 @@ public static string Render(IEnumerable<AbstractIndexCreationTask> indexes)
 
         foreach (var index in indexes.OrderBy(i => i.IndexName, StringComparer.Ordinal))
         {
+            // The conventions change the rendered definition, for example how enum literals appear in a map.
+            index.Conventions = DocumentStoreConventions.Create();
             Render(builder, index.CreateIndexDefinition());
             builder.AppendLine();
         }