Add support for Azure Service Bus entities partitioning (#3959) (#3961)

Co-authored-by: Mauro Servienti <[email protected]>
Co-authored-by: Poornima Nayar <[email protected]>

Author: 3 people

src/ServiceControl.Transports.ASBS.Tests/ConnectionStringParserTests.cs

@@ -34,6 +34,9 @@ public static IEnumerable<TestCaseData> SupportedConnectionStrings
                 //Custom query delay interval
                 yield return new TestCaseData("Endpoint=sb://some.endpoint.name/;QueueLengthQueryDelayInterval=15000",
                     new ConnectionSettings(new SharedAccessSignatureAuthentication("Endpoint=sb://some.endpoint.name/;QueueLengthQueryDelayInterval=15000"), queryDelayInterval: TimeSpan.FromSeconds(15)));
+                //EnablePartitioning
+                yield return new TestCaseData("Endpoint=sb://some.endpoint.name/;EnablePartitioning=True",
+                    new ConnectionSettings(new SharedAccessSignatureAuthentication("Endpoint=sb://some.endpoint.name/;EnablePartitioning=True"), enablePartitioning: true));
             }
         }
 
@@ -61,13 +64,13 @@ public void VerifySupported(string connectionString, ConnectionSettings expected
 
             Assert.AreEqual(JsonSerializer.Serialize(expected), JsonSerializer.Serialize(actual));
 
-            //needed since System..Text.Json doesn't handle polymorphic properties
+            //needed since System.Text.Json doesn't handle polymorphic properties
             Assert.AreEqual(
                 JsonSerializer.Serialize(expected.AuthenticationMethod, expected.AuthenticationMethod.GetType()),
                 JsonSerializer.Serialize(actual.AuthenticationMethod, actual.AuthenticationMethod.GetType()));
 
 
-            //needed since System..Text.Json doesn't handle polymorphic properties
+            //needed since System.Text.Json doesn't handle polymorphic properties
             if (expected.AuthenticationMethod is TokenCredentialAuthentication expectedAuthentication)
             {
                 var actualAuthentication = actual.AuthenticationMethod as TokenCredentialAuthentication;

src/ServiceControl.Transports.ASBS/ASBSTransportCustomization.cs

@@ -69,6 +69,11 @@ void CustomizeEndpoint(
                 transport.UseWebSockets();
             }
 
+            if (connectionSettings.EnablePartitioning)
+            {
+                transport.EnablePartitioning();
+            }
+
             transport.ConfigureNameShorteners();
             transport.Transactions(transportTransactionMode);
 

src/ServiceControl.Transports.ASBS/ConnectionSettings.cs

@@ -4,15 +4,16 @@
 
     public class ConnectionSettings
     {
-        public ConnectionSettings(
-            AuthenticationMethod authenticationSettings,
+        public ConnectionSettings(AuthenticationMethod authenticationSettings,
             string topicName = default,
             bool useWebSockets = default,
+            bool enablePartitioning = default,
             TimeSpan? queryDelayInterval = default)
         {
             AuthenticationMethod = authenticationSettings;
             TopicName = topicName;
             UseWebSockets = useWebSockets;
+            EnablePartitioning = enablePartitioning;
             QueryDelayInterval = queryDelayInterval;
         }
 
@@ -23,5 +24,7 @@ public ConnectionSettings(
         public string TopicName { get; }
 
         public bool UseWebSockets { get; }
+
+        public bool EnablePartitioning { get; }
     }
 }

src/ServiceControl.Transports.ASBS/ConnectionStringParser.cs

@@ -62,6 +62,16 @@ public static ConnectionSettings Parse(string connectionString)
                 clientIdString = (string)clientId;
             }
 
+            var enablePartitioning = false;
+            if (builder.TryGetValue("EnablePartitioning", out var enablePartitioningString))
+            {
+                if (!bool.TryParse((string)enablePartitioningString, out enablePartitioning))
+                {
+                    throw new Exception(
+                        $"Cannot enable partitioning, the specified value '{enablePartitioningString}' cannot be converted to a bool.");
+                }
+            }
+
             var shouldUseManagedIdentity = builder.TryGetValue("Authentication", out var authType) && (string)authType == "Managed Identity";
 
             if (shouldUseManagedIdentity)
@@ -72,6 +82,7 @@ public static ConnectionSettings Parse(string connectionString)
                   new TokenCredentialAuthentication(fullyQualifiedNamespace, clientIdString),
                   topicNameString,
                   useWebSockets,
+                  enablePartitioning,
                   queryDelayInterval);
             }
 
@@ -84,6 +95,7 @@ public static ConnectionSettings Parse(string connectionString)
                 new SharedAccessSignatureAuthentication(connectionString),
                 topicNameString,
                 useWebSockets,
+                enablePartitioning,
                 queryDelayInterval);
         }
     }

src/ServiceControlInstaller.Engine/Instances/ServiceControlCoreTransports.cs

@@ -31,7 +31,7 @@ public class ServiceControlCoreTransports
                 Name = TransportNames.AzureServiceBus,
                 TypeName = "ServiceControl.Transports.ASBS.ASBSTransportCustomization, ServiceControl.Transports.ASBS",
                 ZipName = "NetStandardAzureServiceBus",
-                SampleConnectionString = "Endpoint=sb://[namespace].servicebus.windows.net; SharedSecretIssuer=<owner>;SharedSecretValue=<someSecret>;QueueLengthQueryDelayInterval=<IntervalInMilliseconds(Default=500ms)>;TopicName=<TopicBundleName(Default=bundle-1)>",
+                SampleConnectionString = "Endpoint=sb://[namespace].servicebus.windows.net; SharedSecretIssuer=<owner>;SharedSecretValue=<someSecret>;QueueLengthQueryDelayInterval=<IntervalInMilliseconds(Default=500ms)>;TopicName=<TopicBundleName(Default=bundle-1)>;EnablePartitioning=<true|false(Default=false)>",
                 AvailableInSCMU = true,
                 Matches = name => name.Equals(TransportNames.AzureServiceBus, StringComparison.OrdinalIgnoreCase)
                                   || name.Equals("ServiceControl.Transports.ASBS.ASBSTransportCustomization, ServiceControl.Transports.ASBS", StringComparison.OrdinalIgnoreCase)