[Do not merge] Rename PersistenceType to StorageType

docs/load-testing.md

@@ -19,7 +19,7 @@ Useful flags, passed after `--`:
 | Flag | Description |
 |---|---|
 | `--tag <tag>` | Test a specific ServiceControl image tag, for example a PR prerelease like `pr-1234` |
-| `--persistence <type>` | Persistence for the error instance: `RavenDb` (default), `SqlServer`, or `PostgreSql` |
+| `--storage <type>` | Storage for the error instance: `RavenDb` (default), `SqlServer`, or `PostgreSql` |
 | `--error-ingestion-scale-unit <n>` | Start `n` additional error-ingestion-only ServiceControl instances |
 | `--azure-blob-body-storage "<connection string>"` | Store message bodies in Azure Blob Storage instead of the container file system. Applies only to `SqlServer` and `PostgreSql`. The error instance and its scale-out units share one container, and each audit instance gets its own |
 | `--s3-body-storage <bucket>` | Store message bodies in S3 instead of the container file system. Applies only to `SqlServer` and `PostgreSql`, and is mutually exclusive with `--azure-blob-body-storage`. The error instance and its scale-out units share the `error-bodies/` prefix, and each audit instance gets its own |

src/ServiceControl.AcceptanceTests.PostgreSql/AcceptanceTestStorageConfiguration.cs

@@ -13,7 +13,7 @@ namespace ServiceControl.AcceptanceTests.PostgreSql;
 
 public class AcceptanceTestStorageConfiguration : IAcceptanceTestStorageConfiguration
 {
-    public string PersistenceType { get; } = "PostgreSQL";
+    public string StorageType { get; } = "PostgreSQL";
 
     public async Task CustomizeSettings(Settings settings, CancellationToken cancellationToken = default)
     {

src/ServiceControl.AcceptanceTests.RavenDB/AcceptanceTestStorageConfiguration.cs

@@ -12,7 +12,7 @@
 
 public class AcceptanceTestStorageConfiguration : IAcceptanceTestStorageConfiguration
 {
-    public string PersistenceType { get; } = "RavenDB";
+    public string StorageType { get; } = "RavenDB";
 
 
     public async Task CustomizeSettings(Settings settings, CancellationToken cancellationToken = default)

src/ServiceControl.AcceptanceTests.RavenDB/StartupModeTests.cs

@@ -28,7 +28,7 @@ public async Task InitializeSettings()
                 transportType: transportIntegration.TypeName,
                 forwardErrorMessages: false,
                 errorRetentionPeriod: TimeSpan.FromDays(1),
-                persisterType: "RavenDB")
+                storageType: "RavenDB")
             {
                 TransportConnectionString = transportIntegration.ConnectionString,
                 AssemblyLoadContextResolver = static _ => AssemblyLoadContext.Default

src/ServiceControl.AcceptanceTests.SqlServer/AcceptanceTestStorageConfiguration.cs

@@ -13,7 +13,7 @@ namespace ServiceControl.AcceptanceTests.SqlServer;
 
 public class AcceptanceTestStorageConfiguration : IAcceptanceTestStorageConfiguration
 {
-    public string PersistenceType { get; } = "SQLServer";
+    public string StorageType { get; } = "SQLServer";
 
     public async Task CustomizeSettings(Settings settings, CancellationToken cancellationToken = default)
     {

src/ServiceControl.AcceptanceTests/ClockRegistrationTests.cs

@@ -20,7 +20,7 @@ public async Task InitializeSettings()
         {
             settings = new Settings(
                 transportType: TransportIntegration.TypeName,
-                persisterType: StorageConfiguration.PersistenceType,
+                storageType: StorageConfiguration.StorageType,
                 forwardErrorMessages: false,
                 errorRetentionPeriod: TimeSpan.FromDays(1))
             {

src/ServiceControl.AcceptanceTests/MaintenanceModeTests.cs

@@ -15,7 +15,7 @@ public void Should_refuse_maintenance_mode()
         {
             var settings = new Settings(
                 transportType: TransportIntegration.TypeName,
-                persisterType: StorageConfiguration.PersistenceType,
+                storageType: StorageConfiguration.StorageType,
                 forwardErrorMessages: false,
                 errorRetentionPeriod: TimeSpan.FromDays(1))
             {
@@ -25,7 +25,7 @@ public void Should_refuse_maintenance_mode()
 
             var exception = Assert.Throws<Exception>(() => new ServiceCollection().AddPersistence(settings, maintenanceMode: true));
 
-            Assert.That(exception.Message, Does.Contain("Maintenance mode is not supported").And.Contain(StorageConfiguration.PersistenceType));
+            Assert.That(exception.Message, Does.Contain("Maintenance mode is not supported").And.Contain(StorageConfiguration.StorageType));
         }
     }
 }

src/ServiceControl.AcceptanceTests/Recoverability/When_hosting_error_ingestion_only.cs

@@ -350,7 +350,7 @@ static async Task<FailedMessageEntity> WaitForFailedMessage(IHost host, string m
 
         async Task<Settings> CreateSettings()
         {
-            var settings = new Settings(TransportIntegration.TypeName, StorageConfiguration.PersistenceType,
+            var settings = new Settings(TransportIntegration.TypeName, StorageConfiguration.StorageType,
                 CreateLoggingSettings(), forwardErrorMessages: false, errorRetentionPeriod: TimeSpan.FromDays(10))
             {
                 InstanceName = $"IngestOnly.{Guid.NewGuid():n}",

src/ServiceControl.AcceptanceTests/TestSupport/IAcceptanceTestStorageConfiguration.cs

@@ -7,7 +7,7 @@ namespace ServiceControl.AcceptanceTests.TestSupport;
 
 public interface IAcceptanceTestStorageConfiguration
 {
-    string PersistenceType { get; }
+    string StorageType { get; }
 
     Task CustomizeSettings(Settings settings, CancellationToken cancellationToken = default);
 

src/ServiceControl.AcceptanceTests/TestSupport/ServiceControlComponentRunner.cs

@@ -61,7 +61,7 @@ async Task InitializeServiceControlCore(ScenarioContext context)
             var loggingSettings = new LoggingSettings(Settings.SettingsRootNamespace, defaultLevel: LogLevel.Debug, logPath: logPath);
             LoggerUtil.ActiveLoggers = Loggers.Test;
 
-            var settings = new Settings(transportToUse.TypeName, persistenceToUse.PersistenceType, loggingSettings, forwardErrorMessages: false, errorRetentionPeriod: TimeSpan.FromDays(10))
+            var settings = new Settings(transportToUse.TypeName, persistenceToUse.StorageType, loggingSettings, forwardErrorMessages: false, errorRetentionPeriod: TimeSpan.FromDays(10))
             {
                 InstanceName = instanceName,
                 AllowMessageEditing = true,

src/ServiceControl.AcceptanceTests/WebApi/When_triggering_a_manual_retention_purge.cs

@@ -17,7 +17,7 @@ class When_triggering_a_manual_retention_purge : AcceptanceTest
     [Test]
     public async Task Should_be_available_on_efcore_persisters()
     {
-        if (StorageConfiguration.PersistenceType == "RavenDB")
+        if (StorageConfiguration.StorageType == "RavenDB")
         {
             Assert.Ignore("RavenDB has no sweeper — covered by Should_return_501_on_a_ravendb_backed_instance.");
             return;
@@ -67,7 +67,7 @@ await Define<Context>()
     [Test]
     public async Task Should_report_background_completion_via_status()
     {
-        if (StorageConfiguration.PersistenceType == "RavenDB")
+        if (StorageConfiguration.StorageType == "RavenDB")
         {
             Assert.Ignore("RavenDB has no sweeper — covered by Should_return_501_on_a_ravendb_backed_instance.");
             return;
@@ -101,7 +101,7 @@ await Define<Context>()
     [Test]
     public async Task Should_return_501_on_a_ravendb_backed_instance()
     {
-        if (StorageConfiguration.PersistenceType != "RavenDB")
+        if (StorageConfiguration.StorageType != "RavenDB")
         {
             Assert.Ignore("EFCore persisters support the purge — covered by the efcore tests.");
             return;

src/ServiceControl.Audit.AcceptanceTests.PostgreSql/AcceptanceTestStorageConfiguration.cs

@@ -12,7 +12,7 @@ namespace ServiceControl.Audit.AcceptanceTests.PostgreSql;
 
 public class AcceptanceTestStorageConfiguration : IAcceptanceTestStorageConfiguration
 {
-    public string PersistenceType { get; } = "PostgreSQL";
+    public string StorageType { get; } = "PostgreSQL";
 
     public async Task<IDictionary<string, string>> CustomizeSettings(CancellationToken cancellationToken = default)
     {

src/ServiceControl.Audit.AcceptanceTests.RavenDB/AcceptanceTestStorageConfiguration.cs

@@ -13,7 +13,7 @@
 
     public class AcceptanceTestStorageConfiguration : IAcceptanceTestStorageConfiguration
     {
-        public string PersistenceType { get; } = "RavenDB";
+        public string StorageType { get; } = "RavenDB";
 
         EmbeddedDatabase databaseInstance;
         string databaseName;

src/ServiceControl.Audit.AcceptanceTests.SqlServer/AcceptanceTestStorageConfiguration.cs

@@ -12,7 +12,7 @@ namespace ServiceControl.Audit.AcceptanceTests.SqlServer;
 
 public class AcceptanceTestStorageConfiguration : IAcceptanceTestStorageConfiguration
 {
-    public string PersistenceType { get; } = "SQLServer";
+    public string StorageType { get; } = "SQLServer";
 
     public async Task<IDictionary<string, string>> CustomizeSettings(CancellationToken cancellationToken = default)
     {

src/ServiceControl.Audit.AcceptanceTests/AcceptanceTest.cs

@@ -47,7 +47,7 @@ public void Setup()
             StorageConfiguration = new AcceptanceTestStorageConfiguration();
 
             serviceControlRunnerBehavior = new ServiceControlComponentBehavior(TransportIntegration, StorageConfiguration, s => SetSettings(s), s => CustomConfiguration(s), d => SetStorageConfiguration(d), hb => CustomizeHostBuilder(hb));
-            TestContext.Out.WriteLine($"Using persistence {StorageConfiguration.PersistenceType}");
+            TestContext.Out.WriteLine($"Using storage type {StorageConfiguration.StorageType}");
         }
 
         [TearDown]

src/ServiceControl.Audit.AcceptanceTests/MaintenanceModeTests.cs

@@ -13,15 +13,15 @@ class MaintenanceModeTests : AcceptanceTest
         [Test]
         public void Should_refuse_unsupported_persister_before_starting_host()
         {
-            var settings = new Settings(persisterType: StorageConfiguration.PersistenceType)
+            var settings = new Settings(storageType: StorageConfiguration.StorageType)
             {
                 AssemblyLoadContextResolver = static _ => AssemblyLoadContext.Default
             };
 
             var exception = Assert.ThrowsAsync<InvalidOperationException>(async () =>
                 await new MaintenanceModeCommand().Execute(new HostArguments([]), settings));
 
-            Assert.That(exception.Message, Does.Contain("Maintenance mode is not supported").And.Contain(StorageConfiguration.PersistenceType));
+            Assert.That(exception.Message, Does.Contain("Maintenance mode is not supported").And.Contain(StorageConfiguration.StorageType));
         }
     }
 }

src/ServiceControl.Audit.AcceptanceTests/TestSupport/IAcceptanceTestStorageConfiguration.cs

@@ -7,7 +7,7 @@ namespace ServiceControl.Audit.AcceptanceTests.TestSupport;
 
 public interface IAcceptanceTestStorageConfiguration
 {
-    string PersistenceType { get; }
+    string StorageType { get; }
 
     Task<IDictionary<string, string>> CustomizeSettings(CancellationToken cancellationToken = default);
 

src/ServiceControl.Audit.AcceptanceTests/TestSupport/ServiceControlComponentRunner.cs

@@ -61,7 +61,7 @@ async Task InitializeServiceControlCore(ScenarioContext context)
             var loggingSettings = new LoggingSettings(Settings.SettingsRootNamespace, defaultLevel: LogLevel.Debug, logPath: logPath);
             LoggerUtil.ActiveLoggers = Loggers.Test;
 
-            settings = new Settings(transportToUse.TypeName, persistenceToUse.PersistenceType, loggingSettings)
+            settings = new Settings(transportToUse.TypeName, persistenceToUse.StorageType, loggingSettings)
             {
                 InstanceName = instanceName,
                 TransportConnectionString = transportToUse.ConnectionString,

src/ServiceControl.Audit.Persistence/PersistenceManifest.cs

@@ -26,10 +26,10 @@ public class PersistenceManifest
 
         public string[] Aliases { get; set; } = [];
 
-        internal bool IsMatch(string persistenceType) =>
-            string.Equals(TypeName, persistenceType, StringComparison.Ordinal) // Type names are case-sensitive
-            || string.Equals(Name, persistenceType, StringComparison.OrdinalIgnoreCase)
-            || Aliases.Contains(persistenceType, StringComparer.Ordinal);
+        internal bool IsMatch(string storageType) =>
+            string.Equals(TypeName, storageType, StringComparison.Ordinal) // Type names are case-sensitive
+            || string.Equals(Name, storageType, StringComparison.OrdinalIgnoreCase)
+            || Aliases.Contains(storageType, StringComparer.Ordinal);
     }
 
     public static class PersistenceManifestLibrary
@@ -95,14 +95,14 @@ static string GetAssemblyDirectory()
             return Path.GetDirectoryName(assemblyLocation);
         }
 
-        public static PersistenceManifest Find(string persistenceType)
+        public static PersistenceManifest Find(string storageType)
         {
-            if (persistenceType == null)
+            if (storageType == null)
             {
-                throw new Exception("No persistenceType has been configured. Either provide a Type or Name in the PersistenceType setting.");
+                throw new Exception("No storageType has been configured. Either provide a Type or Name in the StorageType setting.");
             }
 
-            var persistenceManifest = PersistenceManifests.FirstOrDefault(w => w.IsMatch(persistenceType));
+            var persistenceManifest = PersistenceManifests.FirstOrDefault(w => w.IsMatch(storageType));
 
             return persistenceManifest;
         }

src/ServiceControl.Audit.UnitTests/ApprovalFiles/APIApprovals.PlatformSampleSettings.approved.txt

@@ -50,7 +50,7 @@
   "Hostname": "localhost",
   "VirtualDirectory": "",
   "TransportType": "LearningTransport",
-  "PersistenceType": "RavenDB",
+  "StorageType": "RavenDB",
   "AuditQueue": "audit",
   "ForwardAuditMessages": false,
   "IngestAuditMessages": true,

src/ServiceControl.Audit.UnitTests/Infrastructure/PersistenceManifestLibraryTests.cs

@@ -33,8 +33,8 @@ public void Should_find_persistence_manifest_by_type()
         [Test]
         public void Should_return_null_for_not_found_persistence_type()
         {
-            var fakePersistenceType = "My.fake.persistence, fakeTransportAssembly";
-            var persistenceManifest = PersistenceManifestLibrary.Find(fakePersistenceType);
+            var fakeStorageType = "My.fake.persistence, fakeTransportAssembly";
+            var persistenceManifest = PersistenceManifestLibrary.Find(fakeStorageType);
 
             Assert.That(persistenceManifest, Is.Null);
         }

src/ServiceControl.Audit/App.config

@@ -18,10 +18,10 @@ These settings are only here so that we can debug ServiceControl while developin
     <!--<add key="ServiceControl.Audit/TransportType" value="RabbitMQ.QuorumConventionalRouting" />-->
     <!--<add key="ServiceControl.Audit/TransportType" value="SQLServer" />-->
 
-    <!-- DEVS - Pick a persistence to run Auditing instance on. -->
-    <add key="ServiceControl.Audit/PersistenceType" value="RavenDB" />
-    <!--<add key="ServiceControl.Audit/PersistenceType" value="SQLServer" />-->
-    <!--<add key="ServiceControl.Audit/PersistenceType" value="PostgreSQL" />-->
+    <!-- DEVS - Pick a storage type to run Auditing instance on. -->
+    <add key="ServiceControl.Audit/StorageType" value="RavenDB" />
+    <!--<add key="ServiceControl.Audit/StorageType" value="SQLServer" />-->
+    <!--<add key="ServiceControl.Audit/StorageType" value="PostgreSQL" />-->
     <!--<add key="ServiceControl.Audit/Database/ConnectionString" value="" />-->
     <!--<add key="ServiceControl.Audit/MessageBody/StorageType" value="FileSystem" />-->
     <!--<add key="ServiceControl.Audit/MessageBody/FileSystem/StoragePath" value="C:\ServiceControl.Audit\bodies" />-->

src/ServiceControl.Audit/Dockerfile

@@ -19,7 +19,7 @@ EXPOSE 44444
 COPY --from=build /deploy/Particular.ServiceControl.Audit /app
 COPY --from=build /healthcheck /healthcheck
 
-ENV PersistenceType=RavenDB \
+ENV StorageType=RavenDB \
     AuditRetentionPeriod=7
 
 HEALTHCHECK --start-period=10s CMD ["/healthcheck/healthcheck", "http://localhost:44444/api/configuration"]

src/ServiceControl.Audit/HostApplicationBuilderExtensions.cs

@@ -136,7 +136,7 @@ static void RecordStartup(Settings settings, EndpointConfiguration endpointConfi
 Forwarding Audit Messages:          {settings.ForwardAuditMessages}
 ServiceControl Logging Level:       {settings.LoggingSettings.LogLevel}
 Transport Customization:            {settings.TransportType},
-Persistence Customization:          {settings.PersistenceType},
+Persistence Customization:          {settings.StorageType},
 Persistence:                        {persistenceConfiguration.Name}
 -------------------------------------------------------------";
 

src/ServiceControl.Audit/Infrastructure/Hosting/Commands/MaintenanceModeCommand.cs

@@ -16,7 +16,7 @@ public override async Task Execute(HostArguments args, Settings settings, Cancel
             var persistenceConfiguration = PersistenceConfigurationFactory.LoadPersistenceConfiguration(settings);
             if (!persistenceConfiguration.SupportsMaintenanceMode)
             {
-                throw new InvalidOperationException($"Maintenance mode is not supported by the {settings.PersistenceType} persister.");
+                throw new InvalidOperationException($"Maintenance mode is not supported by the {settings.StorageType} persister.");
             }
 
             var persistenceSettings = persistenceConfiguration.BuildPersistenceSettings(settings);

src/ServiceControl.Audit/Infrastructure/Settings/Settings.cs

@@ -14,7 +14,7 @@
 
     public class Settings
     {
-        public Settings(string transportType = null, string persisterType = null, LoggingSettings loggingSettings = null)
+        public Settings(string transportType = null, string storageType = null, LoggingSettings loggingSettings = null)
         {
             LoggingSettings = loggingSettings ?? new(SettingsRootNamespace);
 
@@ -31,7 +31,7 @@ public Settings(string transportType = null, string persisterType = null, Loggin
 
             TransportType = transportType ?? SettingsReader.Read<string>(SettingsRootNamespace, "TransportType");
 
-            PersistenceType = persisterType ?? SettingsReader.Read<string>(SettingsRootNamespace, "PersistenceType");
+            StorageType = storageType ?? SettingsReader.Read<string>(SettingsRootNamespace, "StorageType");
 
             TransportConnectionString = GetConnectionString();
 
@@ -153,7 +153,7 @@ public string RootUrl
 
         public string TransportType { get; private set; }
 
-        public string PersistenceType { get; private set; }
+        public string StorageType { get; private set; }
 
         public string AuditQueue { get; set; }
 

src/ServiceControl.Audit/Infrastructure/WebApi/RootController.cs

@@ -76,7 +76,7 @@ public OkObjectResult Config()
                 },
                 Persistence = new
                 {
-                    settings.PersistenceType
+                    PersistenceType = settings.StorageType
                 },
                 Plugins = new
                 {

src/ServiceControl.Audit/Persistence/PersistenceConfigurationFactory.cs

@@ -11,7 +11,7 @@ public static IPersistenceConfiguration LoadPersistenceConfiguration(Settings se
         {
             try
             {
-                var persistenceManifest = PersistenceManifestLibrary.Find(settings.PersistenceType);
+                var persistenceManifest = PersistenceManifestLibrary.Find(settings.StorageType);
                 var assemblyPath = Path.Combine(persistenceManifest.Location, $"{persistenceManifest.AssemblyName}.dll");
                 var loadContext = settings.AssemblyLoadContextResolver(assemblyPath);
                 var customizationType = Type.GetType(persistenceManifest.TypeName, loadContext.LoadFromAssemblyName, null, true);
@@ -20,7 +20,7 @@ public static IPersistenceConfiguration LoadPersistenceConfiguration(Settings se
             }
             catch (Exception e)
             {
-                throw new Exception($"Could not load persistence customization type {settings.PersistenceType}.", e);
+                throw new Exception($"Could not load persistence customization type {settings.StorageType}.", e);
             }
         }
 

src/ServiceControl.MultiInstance.AcceptanceTests/TestSupport/SharedRavenStorageConfiguration.cs

@@ -18,9 +18,9 @@ namespace ServiceControl.MultiInstance.AcceptanceTests.TestSupport
     class SharedRavenStorageConfiguration : PrimaryStorageConfiguration, AuditStorageConfiguration
     {
         // Both persisters ship a manifest named RavenDB, and only one of them survives the copy into this project's output folder
-        string PrimaryStorageConfiguration.PersistenceType => TypeNameOf(typeof(RavenPersistenceConfiguration));
+        string PrimaryStorageConfiguration.StorageType => TypeNameOf(typeof(RavenPersistenceConfiguration));
 
-        string AuditStorageConfiguration.PersistenceType => TypeNameOf(typeof(AuditRavenPersistenceConfiguration));
+        string AuditStorageConfiguration.StorageType => TypeNameOf(typeof(AuditRavenPersistenceConfiguration));
 
         async Task PrimaryStorageConfiguration.CustomizeSettings(PrimaryInstanceSettings settings, CancellationToken cancellationToken)
         {