Feature based api for gateway persisters (#776)

andreasohlund · danielmarbach · web-flow · commit cabaccf8ff7f · 2025-11-10T21:50:33.000+01:00
* Feature based api for persisters

* Use expose settings

* Update src/NServiceBus.Gateway.AcceptanceTests/NonDurableTestSuiteConstaints.cs

Co-authored-by: Daniel Marbach &lt;daniel.marbach@openplace.net&gt;

* Make ctor public

* Rename file

---------

Co-authored-by: Daniel Marbach &lt;daniel.marbach@openplace.net&gt;
diff --git a/src/NServiceBus.Gateway.AcceptanceTests/GatewayEndpoint.cs b/src/NServiceBus.Gateway.AcceptanceTests/GatewayEndpoint.cs
@@ -14,14 +14,13 @@ public override Task<EndpointConfiguration> GetConfiguration(RunDescriptor runDe
                 var endpointName = endpointCustomizationConfiguration.CustomEndpointName ?? configuration.GetSettings().EndpointName();
 
                 var constraints = new GatewayTestSuiteConstraints();
-                var deduplicationConfiguration = constraints.ConfigureDeduplicationStorage(
+
+                var gatewaySettings = constraints.ConfigureGateway(
                     endpointName,
                     configuration,
-                    runDescriptor.Settings)
-                    .GetAwaiter().GetResult();
-
-                var gatewaySettings = configuration.Gateway(deduplicationConfiguration);
+                    runDescriptor.Settings);
 
+                // This is needed to enable the tests to access and modify gateway settings
                 configuration.GetSettings().Set(gatewaySettings);
 
                 runDescriptor.OnTestCompleted(_ => constraints.Cleanup());
diff --git a/src/NServiceBus.Gateway.AcceptanceTests/IGatewayTestSuiteConstraints.cs b/src/NServiceBus.Gateway.AcceptanceTests/IGatewayTestSuiteConstraints.cs
@@ -1,15 +1,11 @@
-﻿namespace NServiceBus.Gateway.AcceptanceTests
-{
-    using System.Threading.Tasks;
-    using AcceptanceTesting.Support;
+﻿namespace NServiceBus.Gateway.AcceptanceTests;
+
+using System.Threading.Tasks;
+using AcceptanceTesting.Support;
 
-    public interface IGatewayTestSuiteConstraints
-    {
-        /// <summary>
-        /// Return the GatewayDeduplicationConfiguration only. The test infrastructure will call endpoingConfig.Gateway(…)
-        /// </summary>
-        Task<GatewayDeduplicationConfiguration> ConfigureDeduplicationStorage(string endpointName, EndpointConfiguration configuration, RunSettings settings);
+public interface IGatewayTestSuiteConstraints
+{
+    GatewaySettings ConfigureGateway(string endpointName, EndpointConfiguration configuration, RunSettings settings);
 
-        Task Cleanup();
-    }
-}
+    Task Cleanup();
+}
diff --git a/src/NServiceBus.Gateway.AcceptanceTests/NServiceBus.Gateway.AcceptanceTests.csproj b/src/NServiceBus.Gateway.AcceptanceTests/NServiceBus.Gateway.AcceptanceTests.csproj
@@ -33,7 +33,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <RemoveSourceFileFromPackage Include="NonDurableTestSuiteConstaints.cs" />
+    <RemoveSourceFileFromPackage Include="NonDurableTestSuiteConstraints.cs" />
   </ItemGroup>
 
 </Project>
diff --git a/src/NServiceBus.Gateway.AcceptanceTests/NonDurableTestSuiteConstaints.cs b/src/NServiceBus.Gateway.AcceptanceTests/NonDurableTestSuiteConstaints.cs
diff --git a/src/NServiceBus.Gateway.AcceptanceTests/NonDurableTestSuiteConstraints.cs b/src/NServiceBus.Gateway.AcceptanceTests/NonDurableTestSuiteConstraints.cs
@@ -0,0 +1,13 @@
+﻿namespace NServiceBus.Gateway.AcceptanceTests
+{
+    using System.Threading.Tasks;
+    using AcceptanceTesting.Support;
+
+    //we don't ship this class in the source package since downstreams should provide their own storage config.
+    public partial class GatewayTestSuiteConstraints
+    {
+        public GatewaySettings ConfigureGateway(string endpointName, EndpointConfiguration configuration, RunSettings settings) => configuration.Gateway(new NonDurableDeduplicationConfiguration());
+
+        public Task Cleanup() => Task.CompletedTask;
+    }
+}
diff --git a/src/NServiceBus.Gateway.Tests/ApprovalFiles/APIApprovals.Approve.approved.txt b/src/NServiceBus.Gateway.Tests/ApprovalFiles/APIApprovals.Approve.approved.txt
@@ -18,8 +18,7 @@ namespace NServiceBus.Gateway
     public abstract class GatewayDeduplicationConfiguration
     {
         protected GatewayDeduplicationConfiguration() { }
-        public abstract NServiceBus.Gateway.IGatewayDeduplicationStorage CreateStorage(System.IServiceProvider builder);
-        public virtual void Setup(NServiceBus.Settings.IReadOnlySettings settings) { }
+        protected abstract void EnableFeature(NServiceBus.Settings.SettingsHolder settings);
     }
     public interface IChannelReceiver
     {
@@ -44,7 +43,7 @@ namespace NServiceBus.Gateway
     {
         public NonDurableDeduplicationConfiguration() { }
         public int CacheSize { get; set; }
-        public override NServiceBus.Gateway.IGatewayDeduplicationStorage CreateStorage(System.IServiceProvider builder) { }
+        protected override void EnableFeature(NServiceBus.Settings.SettingsHolder settings) { }
     }
     public class ReceiveChannel : NServiceBus.Gateway.Channels.Channel
     {
@@ -89,10 +88,12 @@ namespace NServiceBus
 {
     public static class GatewayExtensions
     {
-        public static NServiceBus.GatewaySettings Gateway(this NServiceBus.EndpointConfiguration config, NServiceBus.Gateway.GatewayDeduplicationConfiguration storageConfiguration) { }
+        public static NServiceBus.GatewaySettings Gateway<TGatewayDeduplicationConfiguration>(this NServiceBus.EndpointConfiguration config, TGatewayDeduplicationConfiguration storageConfiguration)
+            where TGatewayDeduplicationConfiguration : NServiceBus.Gateway.GatewayDeduplicationConfiguration { }
     }
-    public class GatewaySettings
+    public class GatewaySettings : NServiceBus.Configuration.AdvancedExtensibility.ExposeSettings
     {
+        public GatewaySettings(NServiceBus.Settings.SettingsHolder settings) { }
         public void AddReceiveChannel(string address, string type = "http", int maxConcurrency = 1, bool isDefault = false) { }
         public void AddSite(string siteKey, string address, string type = "http", bool legacyMode = false) { }
         public void ChannelFactories(System.Func<string, NServiceBus.Gateway.IChannelSender> senderFactory, System.Func<string, NServiceBus.Gateway.IChannelReceiver> receiverFactory) { }
diff --git a/src/NServiceBus.Gateway/Configuration/GatewayDeduplicationConfiguration.cs b/src/NServiceBus.Gateway/Configuration/GatewayDeduplicationConfiguration.cs
@@ -1,23 +1,14 @@
-﻿namespace NServiceBus.Gateway
-{
-    using System;
-    using Settings;
+﻿namespace NServiceBus.Gateway;
+
+using Settings;
 
+/// <summary>
+/// Configures the deduplication storage.
+/// </summary>
+public abstract class GatewayDeduplicationConfiguration
+{
     /// <summary>
-    /// Configures the deduplication storage.
+    /// Called when the deduplication implementation should enable its feature.
     /// </summary>
-    public abstract class GatewayDeduplicationConfiguration
-    {
-        /// <summary>
-        /// Invoked when the endpoint configuration completed to initialize the storage or verify configuration before the endpoint starts.
-        /// </summary>
-        public virtual void Setup(IReadOnlySettings settings)
-        {
-        }
-
-        /// <summary>
-        /// Creates an instance of the deduplication storage.
-        /// </summary>
-        public abstract IGatewayDeduplicationStorage CreateStorage(IServiceProvider builder);
-    }
+    protected internal abstract void EnableFeature(SettingsHolder settings);
 }
diff --git a/src/NServiceBus.Gateway/Configuration/GatewayExtensions.cs b/src/NServiceBus.Gateway/Configuration/GatewayExtensions.cs
@@ -2,6 +2,7 @@
 {
     using System;
     using Configuration.AdvancedExtensibility;
+    using Features;
     using Gateway;
 
     /// <summary>
@@ -14,17 +15,21 @@ public static class GatewayExtensions
         /// </summary>
         /// <param name="config">The <see cref="EndpointConfiguration"/> instance to apply the settings to.</param>
         /// <param name="storageConfiguration">the storage configuration for the gateway's deduplication mechanism</param>
-        public static GatewaySettings Gateway(this EndpointConfiguration config, GatewayDeduplicationConfiguration storageConfiguration)
+        public static GatewaySettings Gateway<TGatewayDeduplicationConfiguration>(this EndpointConfiguration config, TGatewayDeduplicationConfiguration storageConfiguration)
+            where TGatewayDeduplicationConfiguration : GatewayDeduplicationConfiguration
         {
             ArgumentNullException.ThrowIfNull(config);
             ArgumentNullException.ThrowIfNull(storageConfiguration);
 
-            config.EnableFeature<Features.Gateway>();
+            var settings = config.GetSettings();
 
-            config.GetSettings().Set(storageConfiguration);
-            config.GetSettings().SetDefault("Gateway.Retries.RetryPolicy", DefaultRetryPolicy.BuildWithDefaults());
+            settings.EnableFeature<Features.Gateway>();
 
-            return new GatewaySettings(config);
+            storageConfiguration.EnableFeature(settings);
+
+            settings.Set(storageConfiguration);
+
+            return new GatewaySettings(settings);
         }
     }
 }
diff --git a/src/NServiceBus.Gateway/Gateway.cs b/src/NServiceBus.Gateway/Gateway.cs
@@ -35,9 +35,6 @@ protected override void Setup(FeatureConfigurationContext context)
                 throw new InvalidOperationException("Gateway is not supported for send only endpoints.");
             }
 
-            var storageConfiguration = context.Settings.Get<GatewayDeduplicationConfiguration>();
-            storageConfiguration.Setup(context.Settings);
-
             var transportDefinition = context.Settings.Get<TransportDefinition>();
 
             ConfigureTransaction(context);
@@ -79,7 +76,7 @@ protected override void Setup(FeatureConfigurationContext context)
                 channelReceiverFactory,
                 GetEndpointRouter(context),
                 b.GetRequiredService<IMessageDispatcher>(),
-                storageConfiguration.CreateStorage(b),
+                b.GetRequiredService<IGatewayDeduplicationStorage>(),
                 b.GetServices<IClaimCheck>()?.FirstOrDefault(),
                 b.GetRequiredService<ITransportAddressResolver>().ToTransportAddress(logicalGatewayAddress),
                 transportDefinition.TransportTransactionMode));
diff --git a/src/NServiceBus.Gateway/NonDurableStorage/NonDurableDeduplicationConfiguration.cs b/src/NServiceBus.Gateway/NonDurableStorage/NonDurableDeduplicationConfiguration.cs
@@ -1,6 +1,9 @@
 ﻿namespace NServiceBus.Gateway
 {
     using System;
+    using Features;
+    using Microsoft.Extensions.DependencyInjection;
+    using Settings;
 
     /// <summary>
     /// Configuration class for the in-memory gateway deduplication storage.
@@ -21,6 +24,11 @@ public int CacheSize
         } = 10000;
 
         /// <inheritdoc />
-        public override IGatewayDeduplicationStorage CreateStorage(IServiceProvider builder) => new NonDurableDeduplicationStorage(CacheSize);
+        protected internal override void EnableFeature(SettingsHolder settings) => settings.EnableFeature<NonDurableDeduplication>();
+
+        class NonDurableDeduplication : Feature
+        {
+            protected override void Setup(FeatureConfigurationContext context) => context.Services.AddSingleton<IGatewayDeduplicationStorage>(_ => new NonDurableDeduplicationStorage(context.Settings.Get<NonDurableDeduplicationConfiguration>().CacheSize));
+        }
     }
 }
diff --git a/src/NServiceBus.Gateway/NonDurableStorage/NonDurableDeduplicationSession.cs b/src/NServiceBus.Gateway/NonDurableStorage/NonDurableDeduplicationSession.cs
@@ -4,16 +4,9 @@
     using System.Threading;
     using System.Threading.Tasks;
 
-    class NonDurableDeduplicationSession : IDeduplicationSession
+    class NonDurableDeduplicationSession(string messageId, Dictionary<string, LinkedListNode<string>> clientIdSet, LinkedList<string> clientIdList, int cacheSize)
+        : IDeduplicationSession
     {
-        public NonDurableDeduplicationSession(string messageId, Dictionary<string, LinkedListNode<string>> clientIdSet, LinkedList<string> clientIdList, int cacheSize)
-        {
-            this.messageId = messageId;
-            this.clientIdSet = clientIdSet;
-            this.clientIdList = clientIdList;
-            this.cacheSize = cacheSize;
-        }
-
         public bool IsDuplicate
         {
             get
@@ -55,10 +48,5 @@ public Task MarkAsDispatched(CancellationToken cancellationToken = default)
         public void Dispose()
         {
         }
-
-        readonly string messageId;
-        readonly Dictionary<string, LinkedListNode<string>> clientIdSet;
-        readonly LinkedList<string> clientIdList;
-        readonly int cacheSize;
     }
 }
diff --git a/src/NServiceBus.Gateway/Settings/GatewaySettings.cs b/src/NServiceBus.Gateway/Settings/GatewaySettings.cs
@@ -12,13 +12,17 @@
     /// <summary>
     /// Placeholder for the various settings and extension points related to gateway.
     /// </summary>
-    public class GatewaySettings
+    public class GatewaySettings : ExposeSettings
     {
-        internal GatewaySettings(EndpointConfiguration config)
+        /// <summary>
+        /// Constructs the settings.
+        /// </summary>
+        public GatewaySettings(SettingsHolder settings) : base(settings)
         {
-            settings = config.GetSettings();
-        }
+            this.settings = settings;
 
+            settings.SetDefault("Gateway.Retries.RetryPolicy", DefaultRetryPolicy.BuildWithDefaults());
+        }
 
         /// <summary>
         /// Register custom factories for creating channel receivers and channel senders. This allows for overriding the default
@@ -67,10 +71,7 @@ public void CustomRetryPolicy(Func<IncomingMessage, Exception, int, TimeSpan> cu
         /// <summary>
         /// Failed messages will not be retried and will be sent directly to the configured error queue.
         /// </summary>
-        public void DisableRetries()
-        {
-            SetDefaultRetryPolicySettings(0, TimeSpan.MinValue);
-        }
+        public void DisableRetries() => SetDefaultRetryPolicySettings(0, TimeSpan.MinValue);
 
         /// <summary>
         /// The site key to use, this goes hand in hand with Bus.SendToSites(key, message).
@@ -176,4 +177,4 @@ void SetDefaultRetryPolicySettings(int numberOfRetries, TimeSpan timeIncrease)
 
         readonly SettingsHolder settings;
     }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -18,8 +18,7 @@ namespace NServiceBus.Gateway`
`18`	`18`	`public abstract class GatewayDeduplicationConfiguration`
`19`	`19`	`{`
`20`	`20`	`protected GatewayDeduplicationConfiguration() { }`
`21`		`- public abstract NServiceBus.Gateway.IGatewayDeduplicationStorage CreateStorage(System.IServiceProvider builder);`
`22`		`- public virtual void Setup(NServiceBus.Settings.IReadOnlySettings settings) { }`
	`21`	`+ protected abstract void EnableFeature(NServiceBus.Settings.SettingsHolder settings);`
`23`	`22`	`}`
`24`	`23`	`public interface IChannelReceiver`
`25`	`24`	`{`
`@@ -44,7 +43,7 @@ namespace NServiceBus.Gateway`
`44`	`43`	`{`
`45`	`44`	`public NonDurableDeduplicationConfiguration() { }`
`46`	`45`	`public int CacheSize { get; set; }`
`47`		`- public override NServiceBus.Gateway.IGatewayDeduplicationStorage CreateStorage(System.IServiceProvider builder) { }`
	`46`	`+ protected override void EnableFeature(NServiceBus.Settings.SettingsHolder settings) { }`
`48`	`47`	`}`
`49`	`48`	`public class ReceiveChannel : NServiceBus.Gateway.Channels.Channel`
`50`	`49`	`{`
`@@ -89,10 +88,12 @@ namespace NServiceBus`
`89`	`88`	`{`
`90`	`89`	`public static class GatewayExtensions`
`91`	`90`	`{`
`92`		`- public static NServiceBus.GatewaySettings Gateway(this NServiceBus.EndpointConfiguration config, NServiceBus.Gateway.GatewayDeduplicationConfiguration storageConfiguration) { }`
	`91`	`+ public static NServiceBus.GatewaySettings Gateway<TGatewayDeduplicationConfiguration>(this NServiceBus.EndpointConfiguration config, TGatewayDeduplicationConfiguration storageConfiguration)`
	`92`	`+ where TGatewayDeduplicationConfiguration : NServiceBus.Gateway.GatewayDeduplicationConfiguration { }`
`93`	`93`	`}`
`94`		`- public class GatewaySettings`
	`94`	`+ public class GatewaySettings : NServiceBus.Configuration.AdvancedExtensibility.ExposeSettings`
`95`	`95`	`{`
	`96`	`+ public GatewaySettings(NServiceBus.Settings.SettingsHolder settings) { }`
`96`	`97`	`public void AddReceiveChannel(string address, string type = "http", int maxConcurrency = 1, bool isDefault = false) { }`
`97`	`98`	`public void AddSite(string siteKey, string address, string type = "http", bool legacyMode = false) { }`
`98`	`99`	`public void ChannelFactories(System.Func<string, NServiceBus.Gateway.IChannelSender> senderFactory, System.Func<string, NServiceBus.Gateway.IChannelReceiver> receiverFactory) { }`