Add HierarchyNamespace connection string parameter (#5317)

ngallegos · web-flow · commit 0cc8cb21714e · 2026-02-17T10:15:59.000-07:00
* Add HierarchyNamespace connection string parameter

# Conflicts:
#	src/Directory.Packages.props

* Update manifest with no empty default
diff --git a/src/ServiceControl.Transports.ASBS.Tests/ConnectionStringParserTests.cs b/src/ServiceControl.Transports.ASBS.Tests/ConnectionStringParserTests.cs
@@ -37,6 +37,9 @@ public static IEnumerable<TestCaseData> SupportedConnectionStrings
                 //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));
+                //HierarchyNamespace
+                yield return new TestCaseData("Endpoint=sb://some.endpoint.name/;HierarchyNamespace=my-hierarchy",
+                    new ConnectionSettings(new SharedAccessSignatureAuthentication("Endpoint=sb://some.endpoint.name/;HierarchyNamespace=my-hierarchy"), hierarchyNamespace: "my-hierarchy"));
             }
         }
 
@@ -86,4 +89,4 @@ public void VerifyNotSupported(string connectionString)
             Assert.Throws<Exception>(() => ConnectionStringParser.Parse(connectionString));
         }
     }
-}
+}
diff --git a/src/ServiceControl.Transports.ASBS/ASBSTransportCustomization.cs b/src/ServiceControl.Transports.ASBS/ASBSTransportCustomization.cs
@@ -42,6 +42,10 @@ protected override AzureServiceBusTransport CreateTransport(TransportSettings tr
             var transport = connectionSettings.AuthenticationMethod.CreateTransportDefinition(connectionSettings, selectedTopology);
             transport.UseWebSockets = connectionSettings.UseWebSockets;
             transport.EnablePartitioning = connectionSettings.EnablePartitioning;
+            if (!string.IsNullOrWhiteSpace(connectionSettings.HierarchyNamespace))
+            {
+                transport.HierarchyNamespaceOptions = new HierarchyNamespaceOptions { HierarchyNamespace = connectionSettings.HierarchyNamespace };
+            }
 
             transport.TransportTransactionMode = transport.GetSupportedTransactionModes().Contains(preferredTransactionMode) ? preferredTransactionMode : TransportTransactionMode.ReceiveOnly;
 
@@ -67,7 +71,8 @@ protected override void AddTransportForPrimaryCore(IServiceCollection services,
                 {
                     TopicToPublishTo = connectionSettings.TopicName,
                     TopicToSubscribeOn = connectionSettings.TopicName,
-                    EventsToMigrateMap = [
+                    EventsToMigrateMap =
+                    [
                         "ServiceControl.Contracts.CustomCheckFailed",
                         "ServiceControl.Contracts.CustomCheckSucceeded",
                         "ServiceControl.Contracts.HeartbeatRestored",
diff --git a/src/ServiceControl.Transports.ASBS/ConnectionSettings.cs b/src/ServiceControl.Transports.ASBS/ConnectionSettings.cs
@@ -8,13 +8,15 @@ public ConnectionSettings(AuthenticationMethod authenticationSettings,
             string topicName = default,
             bool useWebSockets = default,
             bool enablePartitioning = default,
-            TimeSpan? queryDelayInterval = default)
+            TimeSpan? queryDelayInterval = default,
+            string hierarchyNamespace = default)
         {
             AuthenticationMethod = authenticationSettings;
             TopicName = topicName;
             UseWebSockets = useWebSockets;
             EnablePartitioning = enablePartitioning;
             QueryDelayInterval = queryDelayInterval;
+            HierarchyNamespace = hierarchyNamespace;
         }
 
         public AuthenticationMethod AuthenticationMethod { get; }
@@ -26,5 +28,7 @@ public ConnectionSettings(AuthenticationMethod authenticationSettings,
         public bool UseWebSockets { get; }
 
         public bool EnablePartitioning { get; }
+
+        public string HierarchyNamespace { get; }
     }
 }
diff --git a/src/ServiceControl.Transports.ASBS/ConnectionStringParser.cs b/src/ServiceControl.Transports.ASBS/ConnectionStringParser.cs
@@ -35,6 +35,7 @@ public static ConnectionSettings Parse(string connectionString)
                 {
                     throw new Exception($"Can't parse {value} as a valid query delay interval.");
                 }
+
                 queryDelayInterval = TimeSpan.FromMilliseconds(delayInterval);
             }
 
@@ -72,18 +73,25 @@ public static ConnectionSettings Parse(string connectionString)
                 }
             }
 
+            string hierarchyNamespace = null;
+            if (builder.TryGetValue("HierarchyNamespace", out var hierarchyNamespaceString))
+            {
+                hierarchyNamespace = (string)hierarchyNamespaceString;
+            }
+
             var shouldUseManagedIdentity = builder.TryGetValue("Authentication", out var authType) && (string)authType == "Managed Identity";
 
             if (shouldUseManagedIdentity)
             {
                 var fullyQualifiedNamespace = endpoint.ToString().TrimEnd('/').Replace("sb://", "");
 
                 return new ConnectionSettings(
-                  new TokenCredentialAuthentication(fullyQualifiedNamespace, clientIdString),
-                  topicNameString,
-                  useWebSockets,
-                  enablePartitioning,
-                  queryDelayInterval);
+                    new TokenCredentialAuthentication(fullyQualifiedNamespace, clientIdString),
+                    topicNameString,
+                    useWebSockets,
+                    enablePartitioning,
+                    queryDelayInterval,
+                    hierarchyNamespace);
             }
 
             if (clientIdString != null)
@@ -96,7 +104,8 @@ public static ConnectionSettings Parse(string connectionString)
                 topicNameString,
                 useWebSockets,
                 enablePartitioning,
-                queryDelayInterval);
+                queryDelayInterval,
+                hierarchyNamespace);
         }
     }
-}
+}
diff --git a/src/ServiceControl.Transports.ASBS/transport.manifest b/src/ServiceControl.Transports.ASBS/transport.manifest
@@ -5,7 +5,7 @@
       "DisplayName": "Azure Service Bus",
       "AssemblyName": "ServiceControl.Transports.ASBS",
       "TypeName": "ServiceControl.Transports.ASBS.ASBSTransportCustomization, ServiceControl.Transports.ASBS",
-      "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)>",
+      "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)>;HierarchyNamespace=<hierarchyNamespacePrefix>",
       "AvailableInSCMU": true,
       "Aliases": [
         "ServiceControl.Transports.AzureServiceBus.AzureServiceBusTransport, ServiceControl.Transports.AzureServiceBus"

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,9 @@ public static IEnumerable<TestCaseData> SupportedConnectionStrings`
`37`	`37`	`//EnablePartitioning`
`38`	`38`	`yield return new TestCaseData("Endpoint=sb://some.endpoint.name/;EnablePartitioning=True",`
`39`	`39`	`new ConnectionSettings(new SharedAccessSignatureAuthentication("Endpoint=sb://some.endpoint.name/;EnablePartitioning=True"), enablePartitioning: true));`
	`40`	`+ //HierarchyNamespace`
	`41`	`+ yield return new TestCaseData("Endpoint=sb://some.endpoint.name/;HierarchyNamespace=my-hierarchy",`
	`42`	`+ new ConnectionSettings(new SharedAccessSignatureAuthentication("Endpoint=sb://some.endpoint.name/;HierarchyNamespace=my-hierarchy"), hierarchyNamespace: "my-hierarchy"));`
`40`	`43`	`}`
`41`	`44`	`}`
`42`	`45`
`@@ -86,4 +89,4 @@ public void VerifyNotSupported(string connectionString)`
`86`	`89`	`Assert.Throws<Exception>(() => ConnectionStringParser.Parse(connectionString));`
`87`	`90`	`}`
`88`	`91`	`}`
`89`		`-}`
	`92`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -8,13 +8,15 @@ public ConnectionSettings(AuthenticationMethod authenticationSettings,`
`8`	`8`	`string topicName = default,`
`9`	`9`	`bool useWebSockets = default,`
`10`	`10`	`bool enablePartitioning = default,`
`11`		`- TimeSpan? queryDelayInterval = default)`
	`11`	`+ TimeSpan? queryDelayInterval = default,`
	`12`	`+ string hierarchyNamespace = default)`
`12`	`13`	`{`
`13`	`14`	`AuthenticationMethod = authenticationSettings;`
`14`	`15`	`TopicName = topicName;`
`15`	`16`	`UseWebSockets = useWebSockets;`
`16`	`17`	`EnablePartitioning = enablePartitioning;`
`17`	`18`	`QueryDelayInterval = queryDelayInterval;`
	`19`	`+ HierarchyNamespace = hierarchyNamespace;`
`18`	`20`	`}`
`19`	`21`
`20`	`22`	`public AuthenticationMethod AuthenticationMethod { get; }`
`@@ -26,5 +28,7 @@ public ConnectionSettings(AuthenticationMethod authenticationSettings,`
`26`	`28`	`public bool UseWebSockets { get; }`
`27`	`29`
`28`	`30`	`public bool EnablePartitioning { get; }`
	`31`	`+`
	`32`	`+ public string HierarchyNamespace { get; }`
`29`	`33`	`}`
`30`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,7 @@ public static ConnectionSettings Parse(string connectionString)`
`35`	`35`	`{`
`36`	`36`	`throw new Exception($"Can't parse {value} as a valid query delay interval.");`
`37`	`37`	`}`
	`38`	`+`
`38`	`39`	`queryDelayInterval = TimeSpan.FromMilliseconds(delayInterval);`
`39`	`40`	`}`
`40`	`41`
`@@ -72,18 +73,25 @@ public static ConnectionSettings Parse(string connectionString)`
`72`	`73`	`}`
`73`	`74`	`}`
`74`	`75`
	`76`	`+ string hierarchyNamespace = null;`
	`77`	`+ if (builder.TryGetValue("HierarchyNamespace", out var hierarchyNamespaceString))`
	`78`	`+ {`
	`79`	`+ hierarchyNamespace = (string)hierarchyNamespaceString;`
	`80`	`+ }`
	`81`	`+`
`75`	`82`	`var shouldUseManagedIdentity = builder.TryGetValue("Authentication", out var authType) && (string)authType == "Managed Identity";`
`76`	`83`
`77`	`84`	`if (shouldUseManagedIdentity)`
`78`	`85`	`{`
`79`	`86`	`var fullyQualifiedNamespace = endpoint.ToString().TrimEnd('/').Replace("sb://", "");`
`80`	`87`
`81`	`88`	`return new ConnectionSettings(`
`82`		`- new TokenCredentialAuthentication(fullyQualifiedNamespace, clientIdString),`
`83`		`- topicNameString,`
`84`		`- useWebSockets,`
`85`		`- enablePartitioning,`
`86`		`- queryDelayInterval);`
	`89`	`+ new TokenCredentialAuthentication(fullyQualifiedNamespace, clientIdString),`
	`90`	`+ topicNameString,`
	`91`	`+ useWebSockets,`
	`92`	`+ enablePartitioning,`
	`93`	`+ queryDelayInterval,`
	`94`	`+ hierarchyNamespace);`
`87`	`95`	`}`
`88`	`96`
`89`	`97`	`if (clientIdString != null)`
`@@ -96,7 +104,8 @@ public static ConnectionSettings Parse(string connectionString)`
`96`	`104`	`topicNameString,`
`97`	`105`	`useWebSockets,`
`98`	`106`	`enablePartitioning,`
`99`		`- queryDelayInterval);`
	`107`	`+ queryDelayInterval,`
	`108`	`+ hierarchyNamespace);`
`100`	`109`	`}`
`101`	`110`	`}`
`102`		`-}`
	`111`	`+}`