Refactor persistence configuration to remove Settings dependency and streamline AssemblyLoadContextResolver usage

ramonsmits · ramonsmits · commit 15dd92d0927a · 2025-10-23T09:19:55.000+02:00
diff --git a/src/ServiceControl.AcceptanceTests.RavenDB/StartupModeTests.cs b/src/ServiceControl.AcceptanceTests.RavenDB/StartupModeTests.cs
@@ -4,6 +4,7 @@
     using System.Runtime.Loader;
     using System.Threading.Tasks;
     using Hosting.Commands;
+    using Microsoft.Extensions.DependencyInjection;
     using Microsoft.Extensions.Hosting;
     using Microsoft.Extensions.Logging.Abstractions;
     using NServiceBus;
@@ -22,6 +23,8 @@ class StartupModeTests : AcceptanceTest
         [SetUp]
         public async Task InitializeSettings()
         {
+            PersistenceFactory.AssemblyLoadContextResolver = static _ => AssemblyLoadContext.Default;
+
             var transportIntegration = new ConfigureEndpointLearningTransport();
 
             settings = new Settings
@@ -32,7 +35,6 @@ public async Task InitializeSettings()
                     ErrorRetentionPeriod = TimeSpan.FromDays(1),
                     PersistenceType = "RavenDB",
                     ConnectionString = transportIntegration.ConnectionString,
-                    AssemblyLoadContextResolver = static _ => AssemblyLoadContext.Default
                 }
             };
 
@@ -50,7 +52,7 @@ public async Task CanRunMaintenanceMode()
             // not terminating.
             var hostBuilder = Host.CreateApplicationBuilder();
             settings.ServiceControl.MaintenanceMode = true;
-            hostBuilder.Services.AddPersistence(hostBuilder.Configuration, settings); // TODO: Configuration needs to be initialized
+            hostBuilder.Services.AddPersistence(hostBuilder.Configuration); // TODO: Configuration needs to be initialized
 
             using var host = hostBuilder.Build();
             await host.StartAsync();
diff --git a/src/ServiceControl.AcceptanceTests/TestSupport/ServiceControlComponentRunner.cs b/src/ServiceControl.AcceptanceTests/TestSupport/ServiceControlComponentRunner.cs
@@ -21,6 +21,7 @@
     using NServiceBus.AcceptanceTesting.Support;
     using Particular.ServiceControl;
     using Particular.ServiceControl.Hosting;
+    using Persistence;
     using RavenDB.Shared;
     using ServiceBus.Management.Infrastructure.Settings;
     using ServiceControl.Infrastructure;
@@ -51,10 +52,14 @@ async Task InitializeServiceControl(ScenarioContext context)
             Directory.CreateDirectory(logPath);
             var loggingSettings = new LoggingSettings
             {
-                LogLevel = LogLevel.Debug, LogPath = logPath
+                LogLevel = LogLevel.Debug,
+                LogPath = logPath
             };
             LoggerUtil.ActiveLoggers = Loggers.Test;
 
+            PersistenceFactory.AssemblyLoadContextResolver = static _ => AssemblyLoadContext.Default;
+
+
             var settings = new Settings
             {
                 Logging = loggingSettings,
@@ -101,8 +106,7 @@ async Task InitializeServiceControl(ScenarioContext context)
                         }
 
                         return false;
-                    },
-                    AssemblyLoadContextResolver = static _ => AssemblyLoadContext.Default
+                    }
                 }
             };
 
diff --git a/src/ServiceControl.Transports/TransportFactory.cs b/src/ServiceControl.Transports/TransportFactory.cs
@@ -2,16 +2,19 @@ namespace ServiceControl.Transports
 {
     using System;
     using System.IO;
+    using System.Runtime.Loader;
+    using Infrastructure;
 
     public static class TransportFactory
     {
+        internal static Func<string, AssemblyLoadContext> AssemblyLoadContextResolver { get; set; } = static (assemblyPath) => new PluginAssemblyLoadContext(assemblyPath);
         public static ITransportCustomization Create(TransportSettings settings)
         {
             try
             {
                 var transportManifest = TransportManifestLibrary.Find(settings.TransportType);
                 var assemblyPath = Path.Combine(transportManifest.Location, $"{transportManifest.AssemblyName}.dll");
-                var loadContext = settings.AssemblyLoadContextResolver(assemblyPath);
+                var loadContext = AssemblyLoadContextResolver(assemblyPath);
                 var customizationType = Type.GetType(transportManifest.TypeName, loadContext.LoadFromAssemblyName, null, true);
 
                 return (ITransportCustomization)Activator.CreateInstance(customizationType);
diff --git a/src/ServiceControl.Transports/TransportSettings.cs b/src/ServiceControl.Transports/TransportSettings.cs
@@ -6,6 +6,7 @@
 
     public class TransportSettings : SettingsHolder
     {
+        [Obsolete("",true)]
         public Func<string, AssemblyLoadContext> AssemblyLoadContextResolver { get; set; }
 
         public string TransportType { get; set; }
diff --git a/src/ServiceControl/HostApplicationBuilderExtensions.cs b/src/ServiceControl/HostApplicationBuilderExtensions.cs
@@ -77,7 +77,7 @@ EndpointConfiguration configuration
             services.AddSingleton(provider => new Lazy<IMessageDispatcher>(provider.GetRequiredService<IMessageDispatcher>));
 
             services.AddLicenseCheck();
-            services.AddPersistence(hostBuilder.Configuration, settings);
+            services.AddPersistence(hostBuilder.Configuration);
             services.AddMetrics(settings.ServiceControl.PrintMetrics);
 
             NServiceBusFactory.Configure(settings, transportCustomization, transportSettings, configuration);
@@ -106,12 +106,13 @@ EndpointConfiguration configuration
             hostBuilder.AddServiceControlComponents(settings, transportCustomization, ServiceControlMainInstance.Components);
         }
 
-        public static void AddServiceControlInstallers(this IHostApplicationBuilder hostApplicationBuilder, Settings settings)
+        public static void AddServiceControlInstallers(this IHostApplicationBuilder hostApplicationBuilder)
         {
-            var persistence = PersistenceFactory.Create(hostApplicationBuilder.Configuration, settings);
+            var persistence = PersistenceFactory.Create(hostApplicationBuilder.Configuration);
             persistence.AddInstaller(hostApplicationBuilder.Services);
         }
 
+        // TODO: Move to start
         static void RecordStartup(Settings settings, EndpointConfiguration endpointConfiguration)
         {
             var version = FileVersionInfo.GetVersionInfo(typeof(HostApplicationBuilderExtensions).Assembly.Location).ProductVersion;
diff --git a/src/ServiceControl/Hosting/Commands/ImportFailedErrorsCommand.cs b/src/ServiceControl/Hosting/Commands/ImportFailedErrorsCommand.cs
@@ -77,10 +77,15 @@ public static void SetupApplicationConfiguration(this IHostApplicationBuilder ho
                 .AddLegacyAppSettings()
                 .AddEnvironmentVariables();
 
+            // TODO: Add LoggingOptions/Settings
             hostBuilder.Services.AddOptions<PrimaryOptions>()
                 .Bind(hostBuilder.Configuration.GetSection(PrimaryOptions.SectionName))
                 .ValidateDataAnnotations()
                 .ValidateOnStart();
+            hostBuilder.Services.AddOptions<ServiceBusOptions>()
+                .Bind(hostBuilder.Configuration.GetSection(ServiceBusOptions.SectionName))
+                .ValidateDataAnnotations()
+                .ValidateOnStart();
         }
     }
 }
diff --git a/src/ServiceControl/Hosting/Commands/MaintenanceModeCommand.cs b/src/ServiceControl/Hosting/Commands/MaintenanceModeCommand.cs
@@ -14,8 +14,7 @@ public override async Task Execute(HostArguments args)
         {
             var hostBuilder = Host.CreateApplicationBuilder();
             hostBuilder.SetupApplicationConfiguration();
-            var settings = hostBuilder.Configuration.Get<Settings>();
-            hostBuilder.Services.AddPersistence(hostBuilder.Configuration, settings);
+            hostBuilder.Services.AddPersistence(hostBuilder.Configuration);
 
             if (WindowsServiceHelpers.IsWindowsService())
             {
diff --git a/src/ServiceControl/Hosting/Commands/SetupCommand.cs b/src/ServiceControl/Hosting/Commands/SetupCommand.cs
@@ -20,7 +20,7 @@ public override async Task Execute(HostArguments args)
             hostBuilder.SetupApplicationConfiguration();
             var settings = hostBuilder.Configuration.Get<Settings>();
 
-            hostBuilder.AddServiceControlInstallers(settings);
+            hostBuilder.AddServiceControlInstallers();
 
             var componentSetupContext = new ComponentInstallationContext();
 
diff --git a/src/ServiceControl/Infrastructure/Settings/Settings.cs b/src/ServiceControl/Infrastructure/Settings/Settings.cs
@@ -37,13 +37,13 @@ public void Configure(Settings options)
 
 public class PrimaryOptions
 {
+
     public const string SectionName = "ServiceControl";
 
     public string TransportType { get; set; }
     public string PersistenceType { get; set; }
     public bool MaintenanceMode { get; set; }
     public ServiceControlSettings ServiceControlSettings { get; set; }
-    [JsonIgnore] public Func<string, AssemblyLoadContext> AssemblyLoadContextResolver { get; set; } = static (assemblyPath) => new PluginAssemblyLoadContext(assemblyPath);
     public string NotificationsFilter { get; set; }
     public bool AllowMessageEditing { get; set; }
     public Func<MessageContext, bool> MessageFilter { get; set; } //HINT: acceptance tests only
@@ -97,8 +97,7 @@ public TransportSettings ToTransportSettings()
             ConnectionString = ConnectionString,
             MaxConcurrency = MaximumConcurrencyLevel,
             RunCustomChecks = true,
-            TransportType = TransportType,
-            AssemblyLoadContextResolver = AssemblyLoadContextResolver
+            TransportType = TransportType
         };
         return transportSettings;
     }
diff --git a/src/ServiceControl/Infrastructure/Settings/SettingsConfiguration.cs b/src/ServiceControl/Infrastructure/Settings/SettingsConfiguration.cs
@@ -159,7 +159,7 @@ public void PostConfigure(string name, PrimaryOptions options)
         options.ConnectionString ??= System.Configuration.ConfigurationManager.ConnectionStrings["NServiceBus/Transport"]?.ConnectionString;
         options.InstanceId = InstanceIdGenerator.FromApiUrl(options.ApiUrl);
 
-        options.RemoteInstanceSettings= string.IsNullOrEmpty(options.RemoteInstances)
+        options.RemoteInstanceSettings = string.IsNullOrEmpty(options.RemoteInstances)
             ? []
             : ParseRemoteInstances(options.RemoteInstances);
     }
diff --git a/src/ServiceControl/Persistence/PersistenceFactory.cs b/src/ServiceControl/Persistence/PersistenceFactory.cs
@@ -2,33 +2,39 @@ namespace ServiceControl.Persistence
 {
     using System;
     using System.IO;
+    using System.Runtime.Loader;
     using Microsoft.Extensions.Configuration;
     using ServiceBus.Management.Infrastructure.Settings;
+    using ServiceControl.Infrastructure;
 
     static class PersistenceFactory
     {
-        public static IPersistence Create(IConfiguration configuration, Settings settings)
+        internal static Func<string, AssemblyLoadContext> AssemblyLoadContextResolver { get; set; } = static (assemblyPath) => new PluginAssemblyLoadContext(assemblyPath);
+
+        public static IPersistence Create(IConfiguration configuration)
         {
-            var persistenceConfiguration = CreatePersistenceConfiguration(settings);
+            var persistenceConfiguration = CreatePersistenceConfiguration(configuration);
             var section = configuration.GetSection(PrimaryOptions.SectionName);
             var persistence = persistenceConfiguration.Create(section);
             return persistence;
         }
 
-        static IPersistenceConfiguration CreatePersistenceConfiguration(Settings settings)
+        static IPersistenceConfiguration CreatePersistenceConfiguration(IConfiguration configuration)
         {
+            var persistenceType = configuration.GetValue<string>("PersistenceType");
             try
             {
-                var persistenceManifest = PersistenceManifestLibrary.Find(settings.ServiceControl.PersistenceType);
+                var persistenceManifest = PersistenceManifestLibrary.Find(persistenceType);
                 var assemblyPath = Path.Combine(persistenceManifest.Location, $"{persistenceManifest.AssemblyName}.dll");
-                var loadContext = settings.ServiceControl.AssemblyLoadContextResolver(assemblyPath);
+
+                var loadContext = AssemblyLoadContextResolver(assemblyPath);
                 var customizationType = Type.GetType(persistenceManifest.TypeName, loadContext.LoadFromAssemblyName, null, true);
 
                 return (IPersistenceConfiguration)Activator.CreateInstance(customizationType);
             }
             catch (Exception e)
             {
-                throw new Exception($"Could not load persistence customization type {settings.ServiceControl.PersistenceType}.", e);
+                throw new Exception($"Could not load persistence customization type {persistenceType}.", e);
             }
         }
     }
diff --git a/src/ServiceControl/Persistence/PersistenceServiceCollectionExtensions.cs b/src/ServiceControl/Persistence/PersistenceServiceCollectionExtensions.cs
@@ -8,11 +8,10 @@ static class PersistenceServiceCollectionExtensions
     {
         public static void AddPersistence(
             this IServiceCollection services,
-            IConfiguration configuration,
-            Settings settings
+            IConfiguration configuration
         )
         {
-            var persistence = PersistenceFactory.Create(configuration, settings);
+            var persistence = PersistenceFactory.Create(configuration);
             persistence.AddPersistence(services, configuration);
         }
     }

Original file line number	Diff line number	Diff line change
`@@ -2,16 +2,19 @@ namespace ServiceControl.Transports`
`2`	`2`	`{`
`3`	`3`	`using System;`
`4`	`4`	`using System.IO;`
	`5`	`+ using System.Runtime.Loader;`
	`6`	`+ using Infrastructure;`
`5`	`7`
`6`	`8`	`public static class TransportFactory`
`7`	`9`	`{`
	`10`	`+ internal static Func<string, AssemblyLoadContext> AssemblyLoadContextResolver { get; set; } = static (assemblyPath) => new PluginAssemblyLoadContext(assemblyPath);`
`8`	`11`	`public static ITransportCustomization Create(TransportSettings settings)`
`9`	`12`	`{`
`10`	`13`	`try`
`11`	`14`	`{`
`12`	`15`	`var transportManifest = TransportManifestLibrary.Find(settings.TransportType);`
`13`	`16`	`var assemblyPath = Path.Combine(transportManifest.Location, $"{transportManifest.AssemblyName}.dll");`
`14`		`- var loadContext = settings.AssemblyLoadContextResolver(assemblyPath);`
	`17`	`+ var loadContext = AssemblyLoadContextResolver(assemblyPath);`
`15`	`18`	`var customizationType = Type.GetType(transportManifest.TypeName, loadContext.LoadFromAssemblyName, null, true);`
`16`	`19`
`17`	`20`	`return (ITransportCustomization)Activator.CreateInstance(customizationType);`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`
`7`	`7`	`public class TransportSettings : SettingsHolder`
`8`	`8`	`{`
	`9`	`+ [Obsolete("",true)]`
`9`	`10`	`public Func<string, AssemblyLoadContext> AssemblyLoadContextResolver { get; set; }`
`10`	`11`
`11`	`12`	`public string TransportType { get; set; }`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ EndpointConfiguration configuration`
`77`	`77`	`services.AddSingleton(provider => new Lazy<IMessageDispatcher>(provider.GetRequiredService<IMessageDispatcher>));`
`78`	`78`
`79`	`79`	`services.AddLicenseCheck();`
`80`		`- services.AddPersistence(hostBuilder.Configuration, settings);`
	`80`	`+ services.AddPersistence(hostBuilder.Configuration);`
`81`	`81`	`services.AddMetrics(settings.ServiceControl.PrintMetrics);`
`82`	`82`
`83`	`83`	`NServiceBusFactory.Configure(settings, transportCustomization, transportSettings, configuration);`
`@@ -106,12 +106,13 @@ EndpointConfiguration configuration`
`106`	`106`	`hostBuilder.AddServiceControlComponents(settings, transportCustomization, ServiceControlMainInstance.Components);`
`107`	`107`	`}`
`108`	`108`
`109`		`- public static void AddServiceControlInstallers(this IHostApplicationBuilder hostApplicationBuilder, Settings settings)`
	`109`	`+ public static void AddServiceControlInstallers(this IHostApplicationBuilder hostApplicationBuilder)`
`110`	`110`	`{`
`111`		`- var persistence = PersistenceFactory.Create(hostApplicationBuilder.Configuration, settings);`
	`111`	`+ var persistence = PersistenceFactory.Create(hostApplicationBuilder.Configuration);`
`112`	`112`	`persistence.AddInstaller(hostApplicationBuilder.Services);`
`113`	`113`	`}`
`114`	`114`
	`115`	`+ // TODO: Move to start`
`115`	`116`	`static void RecordStartup(Settings settings, EndpointConfiguration endpointConfiguration)`
`116`	`117`	`{`
`117`	`118`	`var version = FileVersionInfo.GetVersionInfo(typeof(HostApplicationBuilderExtensions).Assembly.Location).ProductVersion;`
Original file line number	Diff line number	Diff line change
`@@ -77,10 +77,15 @@ public static void SetupApplicationConfiguration(this IHostApplicationBuilder ho`
`77`	`77`	`.AddLegacyAppSettings()`
`78`	`78`	`.AddEnvironmentVariables();`
`79`	`79`
	`80`	`+ // TODO: Add LoggingOptions/Settings`
`80`	`81`	`hostBuilder.Services.AddOptions<PrimaryOptions>()`
`81`	`82`	`.Bind(hostBuilder.Configuration.GetSection(PrimaryOptions.SectionName))`
`82`	`83`	`.ValidateDataAnnotations()`
`83`	`84`	`.ValidateOnStart();`
	`85`	`+ hostBuilder.Services.AddOptions<ServiceBusOptions>()`
	`86`	`+ .Bind(hostBuilder.Configuration.GetSection(ServiceBusOptions.SectionName))`
	`87`	`+ .ValidateDataAnnotations()`
	`88`	`+ .ValidateOnStart();`
`84`	`89`	`}`
`85`	`90`	`}`
`86`	`91`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,8 +14,7 @@ public override async Task Execute(HostArguments args)`
`14`	`14`	`{`
`15`	`15`	`var hostBuilder = Host.CreateApplicationBuilder();`
`16`	`16`	`hostBuilder.SetupApplicationConfiguration();`
`17`		`- var settings = hostBuilder.Configuration.Get<Settings>();`
`18`		`- hostBuilder.Services.AddPersistence(hostBuilder.Configuration, settings);`
	`17`	`+ hostBuilder.Services.AddPersistence(hostBuilder.Configuration);`
`19`	`18`
`20`	`19`	`if (WindowsServiceHelpers.IsWindowsService())`
`21`	`20`	`{`
Original file line number	Diff line number	Diff line change
`@@ -159,7 +159,7 @@ public void PostConfigure(string name, PrimaryOptions options)`
`159`	`159`	`options.ConnectionString ??= System.Configuration.ConfigurationManager.ConnectionStrings["NServiceBus/Transport"]?.ConnectionString;`
`160`	`160`	`options.InstanceId = InstanceIdGenerator.FromApiUrl(options.ApiUrl);`
`161`	`161`
`162`		`- options.RemoteInstanceSettings= string.IsNullOrEmpty(options.RemoteInstances)`
	`162`	`+ options.RemoteInstanceSettings = string.IsNullOrEmpty(options.RemoteInstances)`
`163`	`163`	`? []`
`164`	`164`	`: ParseRemoteInstances(options.RemoteInstances);`
`165`	`165`	`}`