Update to NServiceBus.RabbitMQ 10.0.0 and use management client (#4755)

* Update the transport manifest

* Use alpha version of RabbitMQ transport

* Update RabbitMQ manifest example

* Check connection string to disable management API

* Change lock to semaphoreSlim

* Update async/await for createConnection

* Cleanup transport method call

* Update RabbitMQQuery with managementApiUrl for throughput

* Add functionality for RabbitMQ connection string management options

* Fix diagnostic log text

* Add functionality for management options for direct routing

* Allow RabbitMQQuery to access the transport

* Update alpha version

* Update transport creation with new API surface

* Remove connection string parsing

* Enable strong naming

* Change connection string option to ValidateDeliveryLimit

* Make RabbitMQ transport internals visible to RabbitMQ transport tests

* Remove disableManagementApi

* Update RabbitMQQuery to use the transport management client

* Fix text

* Update API calls

* Remove HttpClient and testing for it

* Comment out Vhost property for now

* Update transport package

* Get code compiling

* Remove InternalsVisibleTo

* Fix formatting error

* First pass cleanup

* Update to 10.0.0-beta.1

* Improve how custom connection string settings are set

* Change how ManagementClient gets passed in

* Wire up settings that apparently have been lost

* Use classes from transport

* Formatting

* Fix text for transport manifest

* Fix connection string examples

* Remove signing from TestHelper

* Remove approval files for deleted tests

* Update QueueLengthProvider to use management client

* Get RabbitMQQuery tests working

* Remove unused parameter from RabbitMQQuery ctor

* Get QueueLengthProvider tests working

* Make IManagementClientProvider lazy to ensure endpoints have started

* Remove old settings

* Reorder methods

* Make GetPage private

* Remove unneeded conversion to RabbitMQBrokerQueueDetails

* Remove GetPage

* Check for DisableStats in TestConnectionCore

* Update to 10.0.0-beta.3

* Migrate RabbitMQ management API settings into connection string

* Migrate RabbitMQ management API settings from separate app.config entries into the connection string

* Renamed settings related to Licensing component's use of RabbitMQ management API
Removed unnecessary LINQ usage when working with DbConnectionStringBuilder in ServiceControlAppConfig

* Rename extension method

* Improve names

* Update to 10.0.0-beta.4

* Update to RTM

* Ensure connection string settings are migrated during upgrade

* Make customize methods consistent

* Update the RabbitMQ prereq prompts

* Update wording of prerequisites

---------

Co-authored-by: Brandon Ording <[email protected]>
Co-authored-by: Andreas Bednarz <[email protected]>

Author: 3 people

.reposync.yml

@@ -1,2 +1 @@
-exclusions:
-- src/NServiceBus.snk
+

src/Directory.Packages.props

@@ -38,7 +38,7 @@
     <PackageVersion Include="NServiceBus.Metrics" Version="5.0.1" />
     <PackageVersion Include="NServiceBus.Metrics.ServiceControl" Version="5.0.0" />
     <PackageVersion Include="NServiceBus.Persistence.NonDurable" Version="2.0.1" />
-    <PackageVersion Include="NServiceBus.RabbitMQ" Version="9.2.0" />
+    <PackageVersion Include="NServiceBus.RabbitMQ" Version="10.0.0" />
     <PackageVersion Include="NServiceBus.SagaAudit" Version="5.0.2" />
     <PackageVersion Include="NServiceBus.Testing" Version="9.0.1" />
     <PackageVersion Include="NServiceBus.Transport.AzureServiceBus" Version="5.0.0" />

src/NServiceBus.snk

@@ -2,6 +2,7 @@
 {
     using System;
     using System.Diagnostics;
+    using System.Text;
     using System.Threading.Tasks;
     using ServiceControl.Config.Framework;
     using ServiceControlInstaller.Engine;
@@ -21,12 +22,19 @@ protected override async Task<bool> PromptForRabbitMqCheck(bool isUpgrade)
         {
             var title = isUpgrade ? "UPGRADE WARNING" : "INSTALL WARNING";
             var beforeWhat = isUpgrade ? "upgrading" : "installing";
-            var message = $"ServiceControl version {Constants.CurrentVersion} requires RabbitMQ broker version 3.10.0 or higher. Also, the stream_queue and quorum_queue feature flags must be enabled on the broker. Please confirm your broker meets the minimum requirements before {beforeWhat}.";
             var question = "Do you want to proceed?";
             var yes = "Yes, my RabbitMQ broker meets the minimum requirements";
             var no = "No, cancel the install";
 
-            var continueInstall = await windowManager.ShowYesNoDialog(title, message, question, yes, no);
+            var message = new StringBuilder();
+            message.AppendLine($"ServiceControl version {Constants.CurrentVersion} requires:");
+            message.AppendLine("• RabbitMQ broker version 3.10.0 or higher");
+            message.AppendLine("• The stream_queue and quorum_queue feature flags must be enabled");
+            message.AppendLine($"• The management plugin API must be enabled and accessible. This might require custom settings to be added to the connection string before {beforeWhat}. See the ServiceControl documentation for details.");
+            message.AppendLine();
+            message.AppendLine($"Please confirm your broker meets the minimum requirements before {beforeWhat}.");
+
+            var continueInstall = await windowManager.ShowYesNoDialog(title, message.ToString(), question, yes, no);
             return continueInstall;
         }
 

src/ServiceControl.Config/Commands/ScmuCommandChecks.cs

@@ -3,5 +3,6 @@
     static class AcknowledgementValues
     {
         public const string RabbitMQBrokerVersion310 = "RabbitMQBrokerVersion310";
+        public const string RabbitMQManagementApi = "RabbitMQManagementApi";
     }
 }

src/ServiceControl.Management.PowerShell/Validation/AcknowledgementValues.cs

@@ -71,15 +71,23 @@ protected override Task NotifyForMissingSystemPrerequisites(string missingPrereq
 
         protected override Task<bool> PromptForRabbitMqCheck(bool isUpgrade)
         {
-            if (acknowledgements.Any(ack => ack.Equals(AcknowledgementValues.RabbitMQBrokerVersion310, StringComparison.OrdinalIgnoreCase)))
+            if (!acknowledgements.Any(ack => ack.Equals(AcknowledgementValues.RabbitMQBrokerVersion310, StringComparison.OrdinalIgnoreCase)))
             {
-                return Task.FromResult(true);
+                var terminateMsg = $"ServiceControl version {Constants.CurrentVersion} requires RabbitMQ broker version 3.10.0 or higher. Also, the stream_queue and quorum_queue feature flags must be enabled on the broker. Use -Acknowledgements {AcknowledgementValues.RabbitMQBrokerVersion310} if you are sure your broker meets these requirements.";
+
+                Terminate(terminateMsg, "Install Error", ErrorCategory.InvalidArgument);
+                return Task.FromResult(false);
             }
 
-            var terminateMsg = $"ServiceControl version {Constants.CurrentVersion} requires RabbitMQ broker version 3.10.0 or higher. Also, the stream_queue and quorum_queue feature flags must be enabled on the broker. Use -Acknowledgements {AcknowledgementValues.RabbitMQBrokerVersion310} if you are sure your broker meets these requirements.";
+            if (!acknowledgements.Any(ack => ack.Equals(AcknowledgementValues.RabbitMQManagementApi, StringComparison.OrdinalIgnoreCase)))
+            {
+                var terminateMsg = $"ServiceControl version {Constants.CurrentVersion} requires that the management plugin API must be enabled and accessible. This might require custom settings to be added to the connection string. See the ServiceControl documentation for details. Use -Acknowledgements {AcknowledgementValues.RabbitMQManagementApi} if you are sure your broker meets these requirements.";
 
-            Terminate(terminateMsg, "Install Error", ErrorCategory.InvalidArgument);
-            return Task.FromResult(false);
+                Terminate(terminateMsg, "Install Error", ErrorCategory.InvalidArgument);
+                return Task.FromResult(false);
+            }
+
+            return Task.FromResult(true);
         }
 
         protected override Task<bool> PromptToStopRunningInstance(BaseService instance)