Delayed delivery as a experimental constructor instead of an internal property (#2615)

Co-authored-by: Szymon Pobiega <szymon.pobiega@gmail.com>
Co-authored-by: Tomek Masternak <tomasz.masternak@particular.net>

Author: 3 people

src/NServiceBus.Transport.SQS.AcceptanceTests/ConfigureEndpointSqsTransport.cs

@@ -43,7 +43,11 @@ public Task Configure(string endpointName, EndpointConfiguration configuration,
 
         public static SqsTransport PrepareSqsTransport(bool supportsPublishSubscribe = true)
         {
-            var transport = new SqsTransport(ClientFactories.CreateSqsClient(), ClientFactories.CreateSnsClient(), supportsPublishSubscribe)
+            var transport = new SqsTransport(
+                ClientFactories.CreateSqsClient(),
+                ClientFactories.CreateSnsClient(),
+                supportsPublishSubscribe: supportsPublishSubscribe
+            )
             {
                 QueueNamePrefix = SetupFixture.NamePrefix,
                 TopicNamePrefix = SetupFixture.NamePrefix,

src/NServiceBus.Transport.SQS.Tests/ApprovalFiles/APIApprovals.ApproveSqsTransport.approved.txt

@@ -72,6 +72,8 @@ namespace NServiceBus
     {
         public SqsTransport() { }
         public SqsTransport(Amazon.SQS.IAmazonSQS sqsClient, Amazon.SimpleNotificationService.IAmazonSimpleNotificationService snsClient) { }
+        [System.Diagnostics.CodeAnalysis.Experimental("NSBSQSEXP0001")]
+        public SqsTransport(Amazon.SQS.IAmazonSQS sqsClient, Amazon.SimpleNotificationService.IAmazonSimpleNotificationService snsClient, bool enableDelayedDelivery) { }
         public bool DoNotWrapOutgoingMessages { get; set; }
         [System.Obsolete("The SQS transport no longer supports 1.x compatibility mode. Will be removed in v" +
             "ersion 8.0.0.", true)]

src/NServiceBus.Transport.SQS/Configure/DiagnosticDescriptors.cs

@@ -0,0 +1,5 @@
+static class DiagnosticDescriptors
+{
+    // https://learn.microsoft.com/en-us/dotnet/csharp/roslyn-sdk/choosing-diagnostic-ids
+    public const string ExperimentalDisableDelayedDelivery = "NSBSQSEXP0001";
+}

src/NServiceBus.Transport.SQS/Configure/SqsTransport.cs

@@ -2,6 +2,7 @@
 {
     using System;
     using System.Collections.Generic;
+    using System.Diagnostics.CodeAnalysis;
     using System.Linq;
     using System.Threading;
     using System.Threading.Tasks;
@@ -57,11 +58,6 @@ internal set
         /// </summary>
         public string QueueNamePrefix { get; set; }
 
-        /// <summary>
-        /// Disable native delayed delivery infrastructure
-        /// </summary>
-        internal bool DisableDelayedDelivery { get; set; } = false;
-
         /// <summary>
         /// Specifies a lambda function that allows to take control of the queue name generation logic.
         /// This is useful to overcome any limitations imposed by SQS.
@@ -96,6 +92,7 @@ public TimeSpan MaxTimeToLive
                 {
                     throw new ArgumentException($"Max TTL needs to be between {MaxTimeToLiveLowerBound} and {MaxTimeToLiveUpperBound}.");
                 }
+
                 maxTimeToLive = value;
             }
         }
@@ -235,8 +232,38 @@ public SqsTransport()
             snsClient = DefaultClientFactories.SnsFactory();
         }
 
-        internal SqsTransport(IAmazonSQS sqsClient, IAmazonSimpleNotificationService snsClient, bool supportsPublishSubscribe)
-            : base(TransportTransactionMode.ReceiveOnly, true, supportsPublishSubscribe, true)
+        /// <summary>
+        /// Creates a new instance of the SQS transport definition.
+        /// </summary>
+        [Experimental(DiagnosticDescriptors.ExperimentalDisableDelayedDelivery)]
+        public SqsTransport(
+            IAmazonSQS sqsClient,
+            IAmazonSimpleNotificationService snsClient,
+            bool enableDelayedDelivery
+        )
+            : this(
+                sqsClient,
+                snsClient,
+                supportsPublishSubscribe: true,
+                enableDelayedDelivery: enableDelayedDelivery
+            )
+        {
+            this.sqsClient = sqsClient;
+            this.snsClient = snsClient;
+        }
+
+        internal SqsTransport(
+            IAmazonSQS sqsClient,
+            IAmazonSimpleNotificationService snsClient,
+            bool supportsPublishSubscribe,
+            bool enableDelayedDelivery = true
+        )
+            : base(
+                TransportTransactionMode.ReceiveOnly,
+                enableDelayedDelivery,
+                supportsPublishSubscribe,
+                supportsTTBR: true
+            )
         {
             this.sqsClient = sqsClient;
             this.snsClient = snsClient;
@@ -252,15 +279,38 @@ public override async Task<TransportInfrastructure> Initialize(HostSettings host
         {
             AssertQueueNameGeneratorIdempotent(queueNameGenerator);
 
-            var topicCache = new TopicCache(SnsClient, hostSettings.CoreSettings, eventToTopicsMappings, eventToEventsMappings, topicNameGenerator, topicNamePrefix);
-            var infra = new SqsTransportInfrastructure(hostSettings, receivers, SqsClient, SnsClient, QueueCache, topicCache, S3, Policies, QueueDelayTime, topicNamePrefix, DoNotWrapOutgoingMessages, !externallyManagedSqsClient, !externallyManagedSnsClient, DisableDelayedDelivery);
+            var topicCache = new TopicCache(
+                SnsClient,
+                hostSettings.CoreSettings,
+                eventToTopicsMappings,
+                eventToEventsMappings,
+                topicNameGenerator,
+                topicNamePrefix
+            );
+
+            var infra = new SqsTransportInfrastructure(
+                hostSettings,
+                receivers,
+                SqsClient,
+                SnsClient,
+                QueueCache,
+                topicCache,
+                S3,
+                Policies,
+                QueueDelayTime,
+                topicNamePrefix,
+                DoNotWrapOutgoingMessages,
+                !externallyManagedSqsClient,
+                !externallyManagedSnsClient,
+                !SupportsDelayedDelivery
+            );
 
             if (hostSettings.SetupInfrastructure)
             {
                 var queueCreator = new QueueCreator(SqsClient, QueueCache, S3, maxTimeToLive, QueueDelayTime);
 
                 var createQueueTasks = sendingAddresses.Select(x => queueCreator.CreateQueueIfNecessary(x, false, cancellationToken))
-                    .Concat(infra.Receivers.Values.Select(x => queueCreator.CreateQueueIfNecessary(x.ReceiveAddress, !DisableDelayedDelivery, cancellationToken))).ToArray();
+                    .Concat(infra.Receivers.Values.Select(x => queueCreator.CreateQueueIfNecessary(x.ReceiveAddress, SupportsDelayedDelivery, cancellationToken))).ToArray();
 
                 await Task.WhenAll(createQueueTasks).ConfigureAwait(false);
             }