* Use ConnectionSettingsViaUris when specifying a set of Uri instances to which to connect.

Author: lukebakken

RabbitMQ.AMQP.Client/ConnectionSettings.cs

@@ -159,7 +159,7 @@ public ConnectionSettings Build()
             }
             else if (_uris is not null)
             {
-                return new ConnectionSettings(_uris,
+                return new ConnectionSettingsViaUris(_uris,
                     _uriSelector,
                     _containerId, _saslMechanism,
                     _recoveryConfiguration,
@@ -191,11 +191,8 @@ private void ValidateUris()
     // </summary>
     public class ConnectionSettings : IEquatable<ConnectionSettings>
     {
-        private readonly Address _address = new("amqp://localhost:5672");
-        private readonly List<Uri>? _uris;
-        private readonly Dictionary<Uri, Address>? _uriToAddress;
-        private readonly IUriSelector _uriSelector = new RandomUriSelector();
-        private readonly string _virtualHost = Consts.DefaultVirtualHost;
+        protected Address _address = new("amqp://localhost:5672");
+        protected string _virtualHost = Consts.DefaultVirtualHost;
         private readonly string _containerId = string.Empty;
         private readonly uint _maxFrameSize = Consts.DefaultMaxFrameSize;
         private readonly TlsSettings? _tlsSettings;
@@ -227,66 +224,6 @@ public ConnectionSettings(Uri uri,
             }
         }
 
-        public ConnectionSettings(IEnumerable<Uri> uris,
-            IUriSelector? uriSelector = null,
-            string? containerId = null,
-            SaslMechanism? saslMechanism = null,
-            IRecoveryConfiguration? recoveryConfiguration = null,
-            uint? maxFrameSize = null,
-            TlsSettings? tlsSettings = null)
-            : this(containerId, saslMechanism, recoveryConfiguration, maxFrameSize, tlsSettings)
-        {
-            _uris = uris.ToList();
-
-            if (uriSelector is not null)
-            {
-                _uriSelector = uriSelector;
-            }
-
-            _uriToAddress = new(_uris.Count);
-
-            string? tmpVirtualHost = null;
-
-            bool first = true;
-            foreach (Uri uri in _uris)
-            {
-                (string? user, string? password) = ProcessUserInfo(uri);
-
-                if (tmpVirtualHost is null)
-                {
-                    tmpVirtualHost = ProcessUriSegmentsForVirtualHost(uri);
-                }
-                else
-                {
-                    string thisVirtualHost = ProcessUriSegmentsForVirtualHost(uri);
-                    if (false == thisVirtualHost.Equals(tmpVirtualHost, StringComparison.InvariantCultureIgnoreCase))
-                    {
-                        throw new ArgumentException($"All AMQP URIs must use the same virtual host. Expected '{tmpVirtualHost}', got '{thisVirtualHost}'");
-                    }
-                }
-
-                var address = new Address(host: uri.Host,
-                    port: uri.Port,
-                    user: user,
-                    password: password,
-                    path: "/",
-                    scheme: uri.Scheme);
-
-                _uriToAddress[uri] = address;
-
-                if (first)
-                {
-                    _address = address;
-                    first = false;
-                }
-            }
-
-            if (tmpVirtualHost is not null)
-            {
-                _virtualHost = tmpVirtualHost;
-            }
-        }
-
         public ConnectionSettings(string scheme,
             string host,
             int port,
@@ -315,7 +252,7 @@ public ConnectionSettings(string scheme,
             }
         }
 
-        private ConnectionSettings(
+        protected ConnectionSettings(
             string? containerId = null,
             SaslMechanism? saslMechanism = null,
             IRecoveryConfiguration? recoveryConfiguration = null,
@@ -364,38 +301,9 @@ private ConnectionSettings(
         public TlsSettings? TlsSettings => _tlsSettings;
         public IRecoveryConfiguration Recovery => _recoveryConfiguration;
 
-        internal Address Address
-        {
-            get
-            {
-                if (_uris is not null &&
-                    _uriSelector is not null &&
-                    _uriToAddress is not null)
-                {
-                    Uri uri = _uriSelector.Select(_uris);
-                    return _uriToAddress[uri];
-                }
-                else
-                {
-                    return _address;
-                }
-            }
-        }
+        internal virtual Address Address => _address;
 
-        internal List<Address>? Addresses
-        {
-            get
-            {
-                if (_uriToAddress is not null)
-                {
-                    return _uriToAddress.Values.ToList();
-                }
-                else
-                {
-                    return null;
-                }
-            }
-        }
+        internal virtual IList<Address> Addresses => new[] { _address };
 
         public override string ToString()
         {
@@ -456,15 +364,7 @@ public override int GetHashCode()
                 _address.Scheme, _containerId, _address.Path);
         }
 
-        ///<summary>
-        /// Unescape a string, protecting '+'.
-        /// </summary>
-        private static string UriDecode(string str)
-        {
-            return Uri.UnescapeDataString(str.Replace("+", "%2B"));
-        }
-
-        private static (string? user, string? password) ProcessUserInfo(Uri uri)
+        protected static (string? user, string? password) ProcessUserInfo(Uri uri)
         {
             string? user = null;
             string? password = null;
@@ -487,7 +387,7 @@ private static (string? user, string? password) ProcessUserInfo(Uri uri)
             return (user, password);
         }
 
-        private static string ProcessUriSegmentsForVirtualHost(Uri uri)
+        protected static string ProcessUriSegmentsForVirtualHost(Uri uri)
         {
             // C# automatically changes URIs into a canonical form
             // that has at least the path segment "/"
@@ -505,6 +405,96 @@ private static string ProcessUriSegmentsForVirtualHost(Uri uri)
                 return Consts.DefaultVirtualHost;
             }
         }
+
+        ///<summary>
+        /// Unescape a string, protecting '+'.
+        /// </summary>
+        private static string UriDecode(string str)
+        {
+            return Uri.UnescapeDataString(str.Replace("+", "%2B"));
+        }
+    }
+
+    public class ConnectionSettingsViaUris : ConnectionSettings
+    {
+        private readonly List<Uri> _uris;
+        private readonly Dictionary<Uri, Address> _uriToAddress;
+        private readonly IUriSelector _uriSelector = new RandomUriSelector();
+
+        public ConnectionSettingsViaUris(IEnumerable<Uri> uris,
+            IUriSelector? uriSelector = null,
+            string? containerId = null,
+            SaslMechanism? saslMechanism = null,
+            IRecoveryConfiguration? recoveryConfiguration = null,
+            uint? maxFrameSize = null,
+            TlsSettings? tlsSettings = null)
+            : base(containerId, saslMechanism, recoveryConfiguration, maxFrameSize, tlsSettings)
+        {
+            _uris = uris.ToList();
+            if (_uris.Count == 0)
+            {
+                throw new ArgumentOutOfRangeException(nameof(uris), "At least one Uri is required.");
+            }
+
+            _uriToAddress = new(_uris.Count);
+
+            if (uriSelector is not null)
+            {
+                _uriSelector = uriSelector;
+            }
+
+            string? tmpVirtualHost = null;
+
+            bool first = true;
+            foreach (Uri uri in _uris)
+            {
+                (string? user, string? password) = ProcessUserInfo(uri);
+
+                if (tmpVirtualHost is null)
+                {
+                    tmpVirtualHost = ProcessUriSegmentsForVirtualHost(uri);
+                }
+                else
+                {
+                    string thisVirtualHost = ProcessUriSegmentsForVirtualHost(uri);
+                    if (false == thisVirtualHost.Equals(tmpVirtualHost, StringComparison.InvariantCultureIgnoreCase))
+                    {
+                        throw new ArgumentException($"All AMQP URIs must use the same virtual host. Expected '{tmpVirtualHost}', got '{thisVirtualHost}'");
+                    }
+                }
+
+                var address = new Address(host: uri.Host,
+                    port: uri.Port,
+                    user: user,
+                    password: password,
+                    path: "/",
+                    scheme: uri.Scheme);
+
+                _uriToAddress[uri] = address;
+
+                if (first)
+                {
+                    _address = address;
+                    first = false;
+                }
+            }
+
+            if (tmpVirtualHost is not null)
+            {
+                _virtualHost = tmpVirtualHost;
+            }
+        }
+
+        internal override Address Address
+        {
+            get
+            {
+                Uri uri = _uriSelector.Select(_uris);
+                return _uriToAddress[uri];
+            }
+        }
+
+        internal override IList<Address> Addresses => _uriToAddress.Values.ToList();
     }
 
     public class TlsSettings

RabbitMQ.AMQP.Client/PublicAPI.Unshipped.txt

@@ -59,7 +59,7 @@ RabbitMQ.AMQP.Client.ConnectionException.ConnectionException(string! message) ->
 RabbitMQ.AMQP.Client.ConnectionException.ConnectionException(string! message, System.Exception! innerException) -> void
 RabbitMQ.AMQP.Client.ConnectionSettings
 RabbitMQ.AMQP.Client.ConnectionSettings.ConnectionSettings(string! scheme, string! host, int port, string? user = null, string? password = null, string? virtualHost = null, string! containerId = "", RabbitMQ.AMQP.Client.SaslMechanism? saslMechanism = null, RabbitMQ.AMQP.Client.IRecoveryConfiguration? recoveryConfiguration = null, uint? maxFrameSize = null, RabbitMQ.AMQP.Client.TlsSettings? tlsSettings = null) -> void
-RabbitMQ.AMQP.Client.ConnectionSettings.ConnectionSettings(System.Collections.Generic.IEnumerable<System.Uri!>! uris, RabbitMQ.AMQP.Client.IUriSelector? uriSelector = null, string? containerId = null, RabbitMQ.AMQP.Client.SaslMechanism? saslMechanism = null, RabbitMQ.AMQP.Client.IRecoveryConfiguration? recoveryConfiguration = null, uint? maxFrameSize = null, RabbitMQ.AMQP.Client.TlsSettings? tlsSettings = null) -> void
+RabbitMQ.AMQP.Client.ConnectionSettings.ConnectionSettings(string? containerId = null, RabbitMQ.AMQP.Client.SaslMechanism? saslMechanism = null, RabbitMQ.AMQP.Client.IRecoveryConfiguration? recoveryConfiguration = null, uint? maxFrameSize = null, RabbitMQ.AMQP.Client.TlsSettings? tlsSettings = null) -> void
 RabbitMQ.AMQP.Client.ConnectionSettings.ConnectionSettings(System.Uri! uri, string? containerId = null, RabbitMQ.AMQP.Client.SaslMechanism? saslMechanism = null, RabbitMQ.AMQP.Client.IRecoveryConfiguration? recoveryConfiguration = null, uint? maxFrameSize = null, RabbitMQ.AMQP.Client.TlsSettings? tlsSettings = null) -> void
 RabbitMQ.AMQP.Client.ConnectionSettings.ContainerId.get -> string!
 RabbitMQ.AMQP.Client.ConnectionSettings.Host.get -> string!
@@ -74,6 +74,8 @@ RabbitMQ.AMQP.Client.ConnectionSettings.TlsSettings.get -> RabbitMQ.AMQP.Client.
 RabbitMQ.AMQP.Client.ConnectionSettings.User.get -> string?
 RabbitMQ.AMQP.Client.ConnectionSettings.UseSsl.get -> bool
 RabbitMQ.AMQP.Client.ConnectionSettings.VirtualHost.get -> string!
+RabbitMQ.AMQP.Client.ConnectionSettings._address -> Amqp.Address!
+RabbitMQ.AMQP.Client.ConnectionSettings._virtualHost -> string!
 RabbitMQ.AMQP.Client.ConnectionSettingsBuilder
 RabbitMQ.AMQP.Client.ConnectionSettingsBuilder.Build() -> RabbitMQ.AMQP.Client.ConnectionSettings!
 RabbitMQ.AMQP.Client.ConnectionSettingsBuilder.ConnectionSettingsBuilder() -> void
@@ -91,6 +93,8 @@ RabbitMQ.AMQP.Client.ConnectionSettingsBuilder.Uris(System.Collections.Generic.I
 RabbitMQ.AMQP.Client.ConnectionSettingsBuilder.UriSelector(RabbitMQ.AMQP.Client.IUriSelector! uriSelector) -> RabbitMQ.AMQP.Client.ConnectionSettingsBuilder!
 RabbitMQ.AMQP.Client.ConnectionSettingsBuilder.User(string! user) -> RabbitMQ.AMQP.Client.ConnectionSettingsBuilder!
 RabbitMQ.AMQP.Client.ConnectionSettingsBuilder.VirtualHost(string! virtualHost) -> RabbitMQ.AMQP.Client.ConnectionSettingsBuilder!
+RabbitMQ.AMQP.Client.ConnectionSettingsViaUris
+RabbitMQ.AMQP.Client.ConnectionSettingsViaUris.ConnectionSettingsViaUris(System.Collections.Generic.IEnumerable<System.Uri!>! uris, RabbitMQ.AMQP.Client.IUriSelector? uriSelector = null, string? containerId = null, RabbitMQ.AMQP.Client.SaslMechanism? saslMechanism = null, RabbitMQ.AMQP.Client.IRecoveryConfiguration? recoveryConfiguration = null, uint? maxFrameSize = null, RabbitMQ.AMQP.Client.TlsSettings? tlsSettings = null) -> void
 RabbitMQ.AMQP.Client.Consts
 RabbitMQ.AMQP.Client.ConsumerException
 RabbitMQ.AMQP.Client.ConsumerException.ConsumerException(string! message) -> void
@@ -761,6 +765,8 @@ static RabbitMQ.AMQP.Client.ByteCapacity.Gb(long gigabytes) -> RabbitMQ.AMQP.Cli
 static RabbitMQ.AMQP.Client.ByteCapacity.Kb(long megabytes) -> RabbitMQ.AMQP.Client.ByteCapacity!
 static RabbitMQ.AMQP.Client.ByteCapacity.Mb(long megabytes) -> RabbitMQ.AMQP.Client.ByteCapacity!
 static RabbitMQ.AMQP.Client.ByteCapacity.Tb(long terabytes) -> RabbitMQ.AMQP.Client.ByteCapacity!
+static RabbitMQ.AMQP.Client.ConnectionSettings.ProcessUriSegmentsForVirtualHost(System.Uri! uri) -> string!
+static RabbitMQ.AMQP.Client.ConnectionSettings.ProcessUserInfo(System.Uri! uri) -> (string? user, string? password)
 static RabbitMQ.AMQP.Client.ConnectionSettingsBuilder.Create() -> RabbitMQ.AMQP.Client.ConnectionSettingsBuilder!
 static RabbitMQ.AMQP.Client.Impl.AddressBuilderHelper.AddressBuilder() -> RabbitMQ.AMQP.Client.Impl.AddressBuilder!
 static RabbitMQ.AMQP.Client.Impl.AmqpConnection.CreateAsync(RabbitMQ.AMQP.Client.ConnectionSettings! connectionSettings, RabbitMQ.AMQP.Client.IMetricsReporter? metricsReporter = null) -> System.Threading.Tasks.Task<RabbitMQ.AMQP.Client.IConnection!>!

Tests/ConnectionTests/ConnectionSettingsTests.cs

@@ -121,7 +121,7 @@ public void ConnectionSettingsViaUris()
         var uri2 = new Uri($"{scheme}://{user}:{pass}@{host}:5691/%2Ffrazzle");
 
         List<Uri> uris = [uri0, uri1, uri2];
-        var connectionSettings = new ConnectionSettings(uris);
+        var connectionSettings = new ConnectionSettingsViaUris(uris);
 
         Assert.True(connectionSettings.UseSsl);
         Assert.Equal(host, connectionSettings.Host);
@@ -233,7 +233,7 @@ public void ConnectionSettingsViaUrisThrowsWithDifferentVirtualHosts()
         var uri2 = new Uri($"{scheme}://{user}:{pass}@{host}:5691/foo");
 
         List<Uri> uris = [uri0, uri1, uri2];
-        Assert.ThrowsAny<ArgumentException>(() => new ConnectionSettings(uris));
+        Assert.ThrowsAny<ArgumentException>(() => new ConnectionSettingsViaUris(uris));
     }
 
     [Fact]