Revert to using features as the building block for custom check implementations (#111)

* Provide access to settings

* Approve api

* Go back to features

* Use feature deps

* Make ctor internal

Author: andreasohlund

src/NServiceBus.ClaimCheck.Tests/APIApprovals.cs

@@ -10,7 +10,7 @@ public class APIApprovals
     [Test]
     public void ApproveClaimCheck()
     {
-        var publicApi = typeof(ClaimCheckFeature).Assembly.GeneratePublicApi(new ApiGeneratorOptions
+        var publicApi = typeof(IClaimCheck).Assembly.GeneratePublicApi(new ApiGeneratorOptions
         {
             ExcludeAttributes = ["System.Runtime.Versioning.TargetFrameworkAttribute", "System.Reflection.AssemblyMetadataAttribute"]
         });

src/NServiceBus.ClaimCheck.Tests/ApprovalFiles/APIApprovals.ApproveClaimCheck.approved.txt

@@ -9,7 +9,7 @@ namespace NServiceBus.ClaimCheck
     public abstract class ClaimCheckDefinition
     {
         protected ClaimCheckDefinition() { }
-        protected abstract void ConfigureServices(Microsoft.Extensions.DependencyInjection.IServiceCollection services);
+        protected abstract void EnableFeature(NServiceBus.Settings.SettingsHolder settings);
     }
     public class ClaimCheckExtensions : NServiceBus.Configuration.AdvancedExtensibility.ExposeSettings
     {
@@ -69,7 +69,7 @@ namespace NServiceBus
     public class FileShareClaimCheck : NServiceBus.ClaimCheck.ClaimCheckDefinition
     {
         public FileShareClaimCheck() { }
-        protected override void ConfigureServices(Microsoft.Extensions.DependencyInjection.IServiceCollection services) { }
+        protected override void EnableFeature(NServiceBus.Settings.SettingsHolder settings) { }
     }
     public interface IClaimCheckProperty
     {
@@ -98,11 +98,8 @@ namespace NServiceBus
 }
 namespace NServiceBus.Features
 {
-    [System.Obsolete("The ClaimCheck feature should not be referenced explicitly. Will be removed in ve" +
-        "rsion 3.0.0.", true)]
     public sealed class ClaimCheck : NServiceBus.Features.Feature
     {
-        public ClaimCheck() { }
         protected override void Setup(NServiceBus.Features.FeatureConfigurationContext context) { }
     }
 }

src/NServiceBus.ClaimCheck/ClaimCheck.cs

@@ -1,16 +1,21 @@
-namespace NServiceBus;
+namespace NServiceBus.Features;
 
 using System;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
-using Features;
 using Microsoft.Extensions.DependencyInjection;
-using ClaimCheck;
+using NServiceBus.ClaimCheck;
 
-sealed class ClaimCheckFeature : Feature
+/// <summary>
+/// Used to configure the claim check implementation.
+/// </summary>
+public sealed class ClaimCheck : Feature
 {
+    internal ClaimCheck() { }
+
+    /// <inheritdoc />
     protected override void Setup(FeatureConfigurationContext context)
     {
         if (context.Services.Any(sd => sd.ServiceType == typeof(IClaimCheckSerializer)))
@@ -21,9 +26,6 @@ protected override void Setup(FeatureConfigurationContext context)
         var serializer = context.Settings.Get<IClaimCheckSerializer>();
         var additionalDeserializers = context.Settings.Get<List<IClaimCheckSerializer>>();
         var conventions = context.Settings.Get<ClaimCheckConventions>();
-        var definition = context.Settings.Get<ClaimCheckDefinition>();
-
-        definition.ConfigureServices(context.Services);
 
         context.RegisterStartupTask(b => new ClaimCheckInitializer(b.GetRequiredService<IClaimCheck>()));
         context.Pipeline.Register(new ClaimCheckSendBehavior.Registration(conventions, serializer));

src/NServiceBus.ClaimCheck/ClaimCheckDefinition.cs

@@ -1,15 +1,14 @@
 namespace NServiceBus.ClaimCheck;
 
-using Microsoft.Extensions.DependencyInjection;
+using Settings;
 
 /// <summary>
 /// Defines an implementation of the claim check pattern that can be used by NServiceBus.
 /// </summary>
 public abstract class ClaimCheckDefinition
 {
     /// <summary>
-    /// Called when the claim check implementation should register itself in the container.
+    /// Called when the claim check implementation should enable its feature.
     /// </summary>
-    /// <param name="services">The service collection to register in.</param>
-    protected internal abstract void ConfigureServices(IServiceCollection services);
+    protected internal abstract void EnableFeature(SettingsHolder settings);
 }

src/NServiceBus.ClaimCheck/CustomClaimCheck.cs

@@ -2,9 +2,27 @@
 
 using System;
 using ClaimCheck;
+using Features;
 using Microsoft.Extensions.DependencyInjection;
+using Settings;
 
 class CustomClaimCheck(Func<IServiceProvider, IClaimCheck> claimCheckFactory) : ClaimCheckDefinition
 {
-    protected internal override void ConfigureServices(IServiceCollection services) => services.AddSingleton(claimCheckFactory);
+    protected internal override void EnableFeature(SettingsHolder settings)
+    {
+        settings.Set(claimCheckFactory);
+        settings.EnableFeature<CustomClaimCheckFeature>();
+    }
+
+    class CustomClaimCheckFeature : Feature
+    {
+        public CustomClaimCheckFeature()
+        {
+            EnableByDefault<Features.ClaimCheck>();
+
+            DependsOn<Features.ClaimCheck>();
+        }
+
+        protected override void Setup(FeatureConfigurationContext context) => context.Services.AddSingleton(context.Settings.Get<Func<IServiceProvider, IClaimCheck>>());
+    }
 }

src/NServiceBus.ClaimCheck/FileShareClaimCheck.cs

@@ -1,23 +1,43 @@
 namespace NServiceBus;
 
 using ClaimCheck;
+using Features;
 using Microsoft.Extensions.DependencyInjection;
+using Settings;
 
 /// <summary>
 /// Base class for implementations of the claim check pattern definitions.
 /// </summary>
 public class FileShareClaimCheck : ClaimCheckDefinition
 {
-    internal string BasePath { get; set; }
+    internal string BasePath;
 
     /// <inheritdoc />
-    protected internal override void ConfigureServices(IServiceCollection services)
+    protected internal override void EnableFeature(SettingsHolder settings) => settings.EnableFeature<FileShareClaimCheckFeature>();
+
+    class FileShareClaimCheckFeature : Feature
     {
-        if (string.IsNullOrEmpty(BasePath))
+        public FileShareClaimCheckFeature()
         {
-            throw new InvalidOperationException("Specify the basepath for FileShareClaimCheck, eg endpointConfiguration.UseClaimCheck<FileShareClaimCheck>().BasePath(\"c:\\claimcheck\")");
+            EnableByDefault<Features.ClaimCheck>();
+
+            DependsOn<Features.ClaimCheck>();
         }
 
-        services.AddSingleton<IClaimCheck>(new FileShareClaimCheckImplementation(BasePath));
+        protected override void Setup(FeatureConfigurationContext context)
+        {
+            var basePath = context.Settings.Get<FileShareClaimCheck>().BasePath;
+            if (string.IsNullOrWhiteSpace(basePath))
+            {
+                throw new InvalidOperationException("Specify the basepath for FileShareClaimCheck, eg endpointConfiguration.UseClaimCheck<FileShareClaimCheck>().BasePath(\"c:\\claimcheck\")");
+            }
+
+            context.Services.AddSingleton<IClaimCheck>(new FileShareClaimCheckImplementation(basePath));
+
+            context.Settings.AddStartupDiagnosticsSection("FileShareClaimCheck", new
+            {
+                basePath
+            });
+        }
     }
 }

src/NServiceBus.ClaimCheck/NServiceBus.ClaimCheck.csproj

@@ -10,7 +10,6 @@
   <ItemGroup>
     <PackageReference Include="NServiceBus" Version="10.0.0-alpha.10" />
     <PackageReference Include="Particular.Packaging" Version="4.5.0" PrivateAssets="All" />
-    <PackageReference Include="Particular.Obsoletes" Version="1.0.0" PrivateAssets="All" ExcludeAssets="runtime" />
 
   </ItemGroup>
 

src/NServiceBus.ClaimCheck/UseClaimCheckExtensions.cs

@@ -67,6 +67,6 @@ static void EnableClaimCheck<TDefinition>(EndpointConfiguration config, TDefinit
         _ = settings.GetOrCreate<List<IClaimCheckSerializer>>();
         _ = settings.GetOrCreate<ClaimCheckConventions>();
 
-        config.EnableFeature<ClaimCheckFeature>();
+        selectedClaimCheck.EnableFeature(settings);
     }
 }