Upgrades SC to the new Azure Topology:

SzymonPobiega · SzymonPobiega · commit e320ca4b16b0 · 2025-02-18T12:26:25.000+01:00
- By default uses migration topology with budnle-1 topic
 - Can override the single topic via connection string
 - Can provide custom topology options via ServiceControl.Transport.ASBS/Topic setting
diff --git a/src/Directory.Packages.props b/src/Directory.Packages.props
@@ -28,7 +28,7 @@
     <PackageVersion Include="Microsoft-WindowsAPICodePack-Shell" Version="1.1.5" />
     <PackageVersion Include="Mindscape.Raygun4Net.NetCore" Version="11.2.1" />
     <PackageVersion Include="NLog.Extensions.Logging" Version="5.4.0" />
-    <PackageVersion Include="NServiceBus" Version="9.2.4" />
+    <PackageVersion Include="NServiceBus" Version="9.2.5" />
     <PackageVersion Include="NServiceBus.AcceptanceTesting" Version="9.2.4" />
     <PackageVersion Include="NServiceBus.AmazonSQS" Version="7.1.1" />
     <PackageVersion Include="NServiceBus.CustomChecks" Version="5.0.1" />
@@ -41,7 +41,7 @@
     <PackageVersion Include="NServiceBus.RabbitMQ" Version="9.2.0" />
     <PackageVersion Include="NServiceBus.SagaAudit" Version="5.0.2" />
     <PackageVersion Include="NServiceBus.Testing" Version="9.0.1" />
-    <PackageVersion Include="NServiceBus.Transport.AzureServiceBus" Version="4.2.4" />
+    <PackageVersion Include="NServiceBus.Transport.AzureServiceBus" Version="5.0.0-alpha.4" />
     <PackageVersion Include="NServiceBus.Transport.AzureStorageQueues" Version="13.0.2" />
     <PackageVersion Include="NServiceBus.Transport.Msmq.Sources" Version="3.0.2" />
     <PackageVersion Include="NServiceBus.Transport.SqlServer" Version="8.1.7" />
diff --git a/src/ServiceControl.Transports.ASBS/ASBSTransportCustomization.cs b/src/ServiceControl.Transports.ASBS/ASBSTransportCustomization.cs
@@ -1,12 +1,17 @@
 ﻿namespace ServiceControl.Transports.ASBS
 {
     using System.Linq;
+    using System.Text.Json;
     using BrokerThroughput;
+    using Configuration;
     using Microsoft.Extensions.DependencyInjection;
     using NServiceBus;
+    using NServiceBus.Transport.AzureServiceBus;
 
     public class ASBSTransportCustomization : TransportCustomization<AzureServiceBusTransport>
     {
+        const string DefaultSingleTopic = "bundle-1";
+
         protected override void CustomizeTransportForPrimaryEndpoint(EndpointConfiguration endpointConfiguration, AzureServiceBusTransport transportDefinition, TransportSettings transportSettings) =>
             transportDefinition.TransportTransactionMode = TransportTransactionMode.SendsAtomicWithReceive;
 
@@ -19,18 +24,39 @@ protected override void CustomizeTransportForMonitoringEndpoint(EndpointConfigur
         protected override AzureServiceBusTransport CreateTransport(TransportSettings transportSettings, TransportTransactionMode preferredTransactionMode = TransportTransactionMode.ReceiveOnly)
         {
             var connectionSettings = ConnectionStringParser.Parse(transportSettings.ConnectionString);
-            var transport = connectionSettings.AuthenticationMethod.CreateTransportDefinition(connectionSettings);
-            transport.UseWebSockets = connectionSettings.UseWebSockets;
+            TopologyOptions topologyOptions;
 
-            if (connectionSettings.TopicName != null)
+            var serviceBusRootNamespace = new SettingsRootNamespace("ServiceControl.Transport.ASBS");
+            if (SettingsReader.TryRead<string>(serviceBusRootNamespace, "Topology", out var topologyJson))
+            {
+                topologyOptions = JsonSerializer.Deserialize<TopologyOptions>(topologyJson);
+            }
+            else
             {
-                transport.Topology = TopicTopology.Single(connectionSettings.TopicName);
+                var options = new MigrationTopologyOptions
+                {
+                    TopicToPublishTo = connectionSettings.TopicName ?? DefaultSingleTopic,
+                    TopicToSubscribeOn = connectionSettings.TopicName ?? DefaultSingleTopic,
+                    PublishedEventToTopicsMap =
+                    {
+                        ["ServiceControl.Contracts.CustomCheckFailed"] = "ServiceControl.Contracts.CustomCheckFailed",
+                        ["ServiceControl.Contracts.CustomCheckSucceeded"] = "ServiceControl.Contracts.CustomCheckSucceeded",
+                        ["ServiceControl.Contracts.HeartbeatRestored"] = "ServiceControl.Contracts.HeartbeatRestored",
+                        ["ServiceControl.Contracts.HeartbeatStopped"] = "ServiceControl.Contracts.HeartbeatStopped",
+                        ["ServiceControl.Contracts.FailedMessagesArchived"] = "ServiceControl.Contracts.FailedMessagesArchived",
+                        ["ServiceControl.Contracts.FailedMessagesUnArchived"] = "ServiceControl.Contracts.FailedMessagesUnArchived",
+                        ["ServiceControl.Contracts.MessageFailed"] = "ServiceControl.Contracts.MessageFailed",
+                        ["ServiceControl.Contracts.MessageFailureResolvedByRetry"] = "ServiceControl.Contracts.MessageFailureResolvedByRetry",
+                        ["ServiceControl.Contracts.MessageFailureResolvedManually"] = "ServiceControl.Contracts.MessageFailureResolvedManually"
+                    }
+                };
+                topologyOptions = options;
             }
 
+            var transport = connectionSettings.AuthenticationMethod.CreateTransportDefinition(connectionSettings, TopicTopology.FromOptions(topologyOptions));
+            transport.UseWebSockets = connectionSettings.UseWebSockets;
             transport.EnablePartitioning = connectionSettings.EnablePartitioning;
 
-            transport.ConfigureNameShorteners();
-
             transport.TransportTransactionMode = transport.GetSupportedTransactionModes().Contains(preferredTransactionMode) ? preferredTransactionMode : TransportTransactionMode.ReceiveOnly;
 
             return transport;
diff --git a/src/ServiceControl.Transports.ASBS/AuthenticationMethod.cs b/src/ServiceControl.Transports.ASBS/AuthenticationMethod.cs
@@ -6,6 +6,6 @@
     public abstract class AuthenticationMethod
     {
         public abstract ServiceBusAdministrationClient BuildManagementClient();
-        public abstract AzureServiceBusTransport CreateTransportDefinition(ConnectionSettings connectionSettings);
+        public abstract AzureServiceBusTransport CreateTransportDefinition(ConnectionSettings connectionSettings, TopicTopology topology);
     }
 }
diff --git a/src/ServiceControl.Transports.ASBS/Helper.cs b/src/ServiceControl.Transports.ASBS/Helper.cs
diff --git a/src/ServiceControl.Transports.ASBS/ServiceControl.Transports.ASBS.csproj b/src/ServiceControl.Transports.ASBS/ServiceControl.Transports.ASBS.csproj
@@ -3,6 +3,7 @@
   <PropertyGroup>
     <TargetFramework>net8.0</TargetFramework>
     <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
+    <NoWarn>CS0618</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>
@@ -15,7 +16,7 @@
     <PackageReference Include="Azure.Monitor.Query" />
     <PackageReference Include="Azure.ResourceManager.ServiceBus" />
     <PackageReference Include="NServiceBus.CustomChecks" />
-    <PackageReference Include="NServiceBus.Transport.AzureServiceBus" />
+    <PackageReference Include="NServiceBus.Transport.AzureServiceBus"/>
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/ServiceControl.Transports.ASBS/SharedAccessSignatureAuthentication.cs b/src/ServiceControl.Transports.ASBS/SharedAccessSignatureAuthentication.cs
@@ -12,7 +12,7 @@ public class SharedAccessSignatureAuthentication : AuthenticationMethod
         public override ServiceBusAdministrationClient BuildManagementClient()
             => new ServiceBusAdministrationClient(ConnectionString);
 
-        public override AzureServiceBusTransport CreateTransportDefinition(ConnectionSettings connectionSettings)
-            => new AzureServiceBusTransport(ConnectionString);
+        public override AzureServiceBusTransport CreateTransportDefinition(ConnectionSettings connectionSettings, TopicTopology topology)
+            => new AzureServiceBusTransport(ConnectionString, topology);
     }
 }
diff --git a/src/ServiceControl.Transports.ASBS/TokenCredentialAuthentication.cs b/src/ServiceControl.Transports.ASBS/TokenCredentialAuthentication.cs
@@ -4,7 +4,6 @@
     using Azure.Identity;
     using Azure.Messaging.ServiceBus.Administration;
     using NServiceBus;
-    using NServiceBus.Transport;
 
     public class TokenCredentialAuthentication : AuthenticationMethod
     {
@@ -30,9 +29,9 @@ public TokenCredentialAuthentication(string fullyQualifiedNamespace, string clie
         public override ServiceBusAdministrationClient BuildManagementClient()
             => new ServiceBusAdministrationClient(FullyQualifiedNamespace, Credential);
 
-        public override AzureServiceBusTransport CreateTransportDefinition(ConnectionSettings connectionSettings)
+        public override AzureServiceBusTransport CreateTransportDefinition(ConnectionSettings connectionSettings, TopicTopology topology)
         {
-            var transport = new AzureServiceBusTransport(FullyQualifiedNamespace, Credential);
+            var transport = new AzureServiceBusTransport(FullyQualifiedNamespace, Credential, topology);
             return transport;
         }
     }
diff --git a/src/ServiceControl.Transports/ServiceControl.Transports.csproj b/src/ServiceControl.Transports/ServiceControl.Transports.csproj
@@ -4,6 +4,11 @@
     <TargetFramework>net8.0</TargetFramework>
   </PropertyGroup>
 
+  <ItemGroup>
+    <!-- Private=false & ExcludeAssets=runtime prevent repeatedly including binary dependencies of ServiceControl.Transports in each transport directory -->
+    <ProjectReference Include="..\ServiceControl.Configuration\ServiceControl.Configuration.csproj" Private="false" ExcludeAssets="runtime" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" />
     <PackageReference Include="NServiceBus" />

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,6 @@`
`6`	`6`	`public abstract class AuthenticationMethod`
`7`	`7`	`{`
`8`	`8`	`public abstract ServiceBusAdministrationClient BuildManagementClient();`
`9`		`- public abstract AzureServiceBusTransport CreateTransportDefinition(ConnectionSettings connectionSettings);`
	`9`	`+ public abstract AzureServiceBusTransport CreateTransportDefinition(ConnectionSettings connectionSettings, TopicTopology topology);`
`10`	`10`	`}`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ public class SharedAccessSignatureAuthentication : AuthenticationMethod`
`12`	`12`	`public override ServiceBusAdministrationClient BuildManagementClient()`
`13`	`13`	`=> new ServiceBusAdministrationClient(ConnectionString);`
`14`	`14`
`15`		`- public override AzureServiceBusTransport CreateTransportDefinition(ConnectionSettings connectionSettings)`
`16`		`- => new AzureServiceBusTransport(ConnectionString);`
	`15`	`+ public override AzureServiceBusTransport CreateTransportDefinition(ConnectionSettings connectionSettings, TopicTopology topology)`
	`16`	`+ => new AzureServiceBusTransport(ConnectionString, topology);`
`17`	`17`	`}`
`18`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,6 @@`
`4`	`4`	`using Azure.Identity;`
`5`	`5`	`using Azure.Messaging.ServiceBus.Administration;`
`6`	`6`	`using NServiceBus;`
`7`		`- using NServiceBus.Transport;`
`8`	`7`
`9`	`8`	`public class TokenCredentialAuthentication : AuthenticationMethod`
`10`	`9`	`{`
`@@ -30,9 +29,9 @@ public TokenCredentialAuthentication(string fullyQualifiedNamespace, string clie`
`30`	`29`	`public override ServiceBusAdministrationClient BuildManagementClient()`
`31`	`30`	`=> new ServiceBusAdministrationClient(FullyQualifiedNamespace, Credential);`
`32`	`31`
`33`		`- public override AzureServiceBusTransport CreateTransportDefinition(ConnectionSettings connectionSettings)`
	`32`	`+ public override AzureServiceBusTransport CreateTransportDefinition(ConnectionSettings connectionSettings, TopicTopology topology)`
`34`	`33`	`{`
`35`		`- var transport = new AzureServiceBusTransport(FullyQualifiedNamespace, Credential);`
	`34`	`+ var transport = new AzureServiceBusTransport(FullyQualifiedNamespace, Credential, topology);`
`36`	`35`	`return transport;`
`37`	`36`	`}`
`38`	`37`	`}`