Allow RavenDB search engine type to be configured

Author: andreasohlund

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

@@ -12,7 +12,8 @@ public class DatabaseConfiguration(
         int dataSpaceRemainingThreshold,
         int minimumStorageLeftRequiredForIngestion,
         ServerConfiguration serverConfiguration,
-        TimeSpan bulkInsertCommitTimeout)
+        TimeSpan bulkInsertCommitTimeout,
+        string searchEngineType)
     {
         public string Name { get; } = name;
 
@@ -33,5 +34,7 @@ public class DatabaseConfiguration(
         public int MinimumStorageLeftRequiredForIngestion { get; internal set; } = minimumStorageLeftRequiredForIngestion; //Setting for ATT only
 
         public TimeSpan BulkInsertCommitTimeout { get; } = bulkInsertCommitTimeout;
+
+        public string SearchEngineType { get; } = searchEngineType;
     }
-}
+}

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

@@ -36,8 +36,8 @@ async Task CreateDatabase(IDocumentStore documentStore, string databaseName, Can
                 try
                 {
                     var databaseRecord = new DatabaseRecord(databaseName);
-                    databaseRecord.Settings.Add("Indexing.Auto.SearchEngineType", "Corax");
-                    databaseRecord.Settings.Add("Indexing.Static.SearchEngineType", "Corax");
+                    databaseRecord.Settings.Add("Indexing.Auto.SearchEngineType", configuration.SearchEngineType);
+                    databaseRecord.Settings.Add("Indexing.Static.SearchEngineType", configuration.SearchEngineType);
 
                     await documentStore.Maintenance.Server.SendAsync(new CreateDatabaseOperation(databaseRecord), cancellationToken);
                 }
@@ -59,8 +59,33 @@ async Task UpdateDatabaseSettings(IDocumentStore documentStore, string databaseN
 
             var updated = false;
 
-            updated |= dbRecord.Settings.TryAdd("Indexing.Auto.SearchEngineType", "Corax");
-            updated |= dbRecord.Settings.TryAdd("Indexing.Static.SearchEngineType", "Corax");
+            if (dbRecord.Settings.TryGetValue(AutoSearchEngineTypeKey, out var searchEngineTypeAuto))
+            {
+                if (searchEngineTypeAuto != configuration.SearchEngineType)
+                {
+                    updated = true;
+                }
+            }
+            else
+            {
+                updated = true;
+            }
+
+            dbRecord.Settings[AutoSearchEngineTypeKey] = configuration.SearchEngineType;
+
+            if (dbRecord.Settings.TryGetValue(StaticSearchEngineTypeKey, out var searchEngineTypeStatic))
+            {
+                if (searchEngineTypeStatic != configuration.SearchEngineType)
+                {
+                    updated = true;
+                }
+            }
+            else
+            {
+                updated = true;
+            }
+
+            dbRecord.Settings[StaticSearchEngineTypeKey] = configuration.SearchEngineType;
 
             if (updated)
             {
@@ -116,5 +141,8 @@ async Task ConfigureExpiration(IDocumentStore documentStore, CancellationToken c
 
             await documentStore.Maintenance.SendAsync(new ConfigureExpirationOperation(expirationConfig), cancellationToken);
         }
+
+        const string AutoSearchEngineTypeKey = "Indexing.Auto.SearchEngineType";
+        const string StaticSearchEngineTypeKey = "Indexing.Static.SearchEngineType";
     }
-}
+}

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

@@ -22,22 +22,9 @@ public class RavenPersistenceConfiguration : IPersistenceConfiguration
         public const string MinimumStorageLeftRequiredForIngestionKey = "MinimumStorageLeftRequiredForIngestion";
         public const string BulkInsertCommitTimeoutInSecondsKey = "BulkInsertCommitTimeoutInSeconds";
         public const string DataSpaceRemainingThresholdKey = "DataSpaceRemainingThreshold";
+        public const string SearchEngineTypeKey = "SearchEngineType";
 
-        public IEnumerable<string> ConfigurationKeys => new[]{
-            DatabaseNameKey,
-            DatabasePathKey,
-            ConnectionStringKey,
-            ClientCertificatePathKey,
-            ClientCertificateBase64Key,
-            ClientCertificatePasswordKey,
-            DatabaseMaintenancePortKey,
-            ExpirationProcessTimerInSecondsKey,
-            LogPathKey,
-            RavenDbLogLevelKey,
-            DataSpaceRemainingThresholdKey,
-            MinimumStorageLeftRequiredForIngestionKey,
-            BulkInsertCommitTimeoutInSecondsKey
-        };
+        public IEnumerable<string> ConfigurationKeys => new[] { DatabaseNameKey, DatabasePathKey, ConnectionStringKey, ClientCertificatePathKey, ClientCertificateBase64Key, ClientCertificatePasswordKey, DatabaseMaintenancePortKey, ExpirationProcessTimerInSecondsKey, LogPathKey, RavenDbLogLevelKey, DataSpaceRemainingThresholdKey, MinimumStorageLeftRequiredForIngestionKey, BulkInsertCommitTimeoutInSecondsKey, SearchEngineTypeKey };
 
         public string Name => "RavenDB";
 
@@ -70,10 +57,12 @@ internal static DatabaseConfiguration GetDatabaseConfiguration(PersistenceSettin
                 {
                     serverConfiguration.ClientCertificatePath = clientCertificatePath;
                 }
+
                 if (settings.PersisterSpecificSettings.TryGetValue(ClientCertificateBase64Key, out var clientCertificateBase64))
                 {
                     serverConfiguration.ClientCertificateBase64 = clientCertificateBase64;
                 }
+
                 if (settings.PersisterSpecificSettings.TryGetValue(ClientCertificatePasswordKey, out var clientCertificatePassword))
                 {
                     serverConfiguration.ClientCertificatePassword = clientCertificatePassword;
@@ -120,6 +109,11 @@ internal static DatabaseConfiguration GetDatabaseConfiguration(PersistenceSettin
 
             var bulkInsertTimeout = TimeSpan.FromSeconds(GetBulkInsertCommitTimeout(settings));
 
+            if (!settings.PersisterSpecificSettings.TryGetValue(SearchEngineTypeKey, out var searchEngineType))
+            {
+                searchEngineType = "Corax";
+            }
+
             return new DatabaseConfiguration(
                 databaseName,
                 expirationProcessTimerInSeconds,
@@ -129,7 +123,8 @@ internal static DatabaseConfiguration GetDatabaseConfiguration(PersistenceSettin
                 dataSpaceRemainingThreshold,
                 minimumStorageLeftRequiredForIngestion,
                 serverConfiguration,
-                bulkInsertTimeout);
+                bulkInsertTimeout,
+                searchEngineType);
         }
 
         static int GetExpirationProcessTimerInSeconds(PersistenceSettings settings)
@@ -198,4 +193,4 @@ static string GetLogPath(PersistenceSettings settings)
         const int ExpirationProcessTimerInSecondsDefault = 600;
         const int BulkInsertCommitTimeoutInSecondsDefault = 60;
     }
-}
+}

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

@@ -84,7 +84,10 @@ public async Task Configure(Action<PersistenceSettings> setSettings)
             var documentStoreProvider = host.Services.GetRequiredService<IRavenDocumentStoreProvider>();
             DocumentStore = await documentStoreProvider.GetDocumentStore();
             var bulkInsert = DocumentStore.BulkInsert(
-                options: new BulkInsertOptions { SkipOverwriteIfUnchanged = true, });
+                options: new BulkInsertOptions
+                {
+                    SkipOverwriteIfUnchanged = true,
+                });
 
             var sessionProvider = host.Services.GetRequiredService<IRavenSessionProvider>();
 
@@ -103,11 +106,18 @@ public async Task Cleanup()
             if (DocumentStore != null)
             {
                 await DocumentStore.Maintenance.Server.SendAsync(new DeleteDatabasesOperation(
-                    new DeleteDatabasesOperation.Parameters { DatabaseNames = [databaseName], HardDelete = true }));
+                    new DeleteDatabasesOperation.Parameters
+                    {
+                        DatabaseNames = [databaseName],
+                        HardDelete = true
+                    }));
             }
 
-            await host.StopAsync();
-            host.Dispose();
+            if (host != null)
+            {
+                await host.StopAsync();
+                host.Dispose();
+            }
         }
 
 

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

@@ -36,7 +36,7 @@ public static async Task<EmbeddedDatabase> GetInstance(CancellationToken cancell
                 var logsMode = "Operations";
                 var serverUrl = $"http://localhost:{PortUtility.FindAvailablePort(33334)}";
 
-                var databaseConfiguration = new DatabaseConfiguration("audit", 60, true, TimeSpan.FromMinutes(5), 120000, 5, 5, new ServerConfiguration(dbPath, serverUrl, logPath, logsMode), TimeSpan.FromSeconds(60));
+                var databaseConfiguration = new DatabaseConfiguration("audit", 60, true, TimeSpan.FromMinutes(5), 120000, 5, 5, new ServerConfiguration(dbPath, serverUrl, logPath, logsMode), TimeSpan.FromSeconds(60), "Lucene");
                 var serverConfig = databaseConfiguration.ServerConfiguration;
 
                 // TODO: See if more refactoring can be done in configuration classes

src/ServiceControl.Persistence.RavenDB/DatabaseSetup.cs

@@ -35,8 +35,8 @@ async Task CreateDatabase(string databaseName, CancellationToken cancellationTok
                 try
                 {
                     var databaseRecord = new DatabaseRecord(databaseName);
-                    databaseRecord.Settings.Add("Indexing.Auto.SearchEngineType", "Corax");
-                    databaseRecord.Settings.Add("Indexing.Static.SearchEngineType", "Corax");
+                    databaseRecord.Settings.Add("Indexing.Auto.SearchEngineType", settings.SearchEngineType);
+                    databaseRecord.Settings.Add("Indexing.Static.SearchEngineType", settings.SearchEngineType);
 
                     await documentStore.Maintenance.Server.SendAsync(new CreateDatabaseOperation(databaseRecord), cancellationToken);
                 }
@@ -58,8 +58,8 @@ async Task UpdateDatabaseSettings(string databaseName, CancellationToken cancell
 
             var updated = false;
 
-            updated |= dbRecord.Settings.TryAdd("Indexing.Auto.SearchEngineType", "Corax");
-            updated |= dbRecord.Settings.TryAdd("Indexing.Static.SearchEngineType", "Corax");
+            updated |= dbRecord.Settings.TryAdd("Indexing.Auto.SearchEngineType", settings.SearchEngineType);
+            updated |= dbRecord.Settings.TryAdd("Indexing.Static.SearchEngineType", settings.SearchEngineType);
 
             if (updated)
             {

src/ServiceControl.Persistence.RavenDB/RavenPersisterSettings.cs

@@ -32,6 +32,7 @@ class RavenPersisterSettings : PersistenceSettings, IRavenClientCertificateInfo
     public string LogsMode { get; set; } = LogsModeDefault;
     public string DatabaseName { get; set; } = DatabaseNameDefault;
     public string ThroughputDatabaseName { get; set; } = ThroughputSettings.DefaultDatabaseName;
+    public string SearchEngineType { get; set; } = "Corax";
 
     public const string DatabaseNameDefault = "primary";
     public const int DatabaseMaintenancePortDefault = 33334;