PR review fixups.

rabbitmq · Dec 7, 2023 · 15f7d65 · 15f7d65
1 parent b1b86f5
commit 15f7d65
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 38 deletions.
diff --git a/projects/RabbitMQ.Client/client/api/ConnectionFactory.cs b/projects/RabbitMQ.Client/client/api/ConnectionFactory.cs
@@ -426,7 +426,7 @@ public IConnection CreateConnection()
         /// When the configured hostname was not reachable.
         /// </exception>
         public ValueTask<IConnection> CreateConnectionAsync(
-            CancellationToken cancellationToken = default(CancellationToken))
+            CancellationToken cancellationToken = default)
         {
             return CreateConnectionAsync(ClientProvidedName, cancellationToken);
         }
@@ -466,7 +466,7 @@ public IConnection CreateConnection(string clientProvidedName)
         /// When the configured hostname was not reachable.
         /// </exception>
         public ValueTask<IConnection> CreateConnectionAsync(string clientProvidedName,
-            CancellationToken cancellationToken = default(CancellationToken))
+            CancellationToken cancellationToken = default)
         {
             return CreateConnectionAsync(EndpointResolverFactory(LocalEndpoints()), clientProvidedName, cancellationToken);
         }
@@ -506,7 +506,7 @@ public IConnection CreateConnection(IEnumerable<string> hostnames)
         /// When no hostname was reachable.
         /// </exception>
         public ValueTask<IConnection> CreateConnectionAsync(IEnumerable<string> hostnames,
-            CancellationToken cancellationToken = default(CancellationToken))
+            CancellationToken cancellationToken = default)
         {
             return CreateConnectionAsync(hostnames, ClientProvidedName, cancellationToken);
         }
@@ -559,7 +559,7 @@ public IConnection CreateConnection(IEnumerable<string> hostnames, string client
         /// When no hostname was reachable.
         /// </exception>
         public ValueTask<IConnection> CreateConnectionAsync(IEnumerable<string> hostnames, string clientProvidedName,
-            CancellationToken cancellationToken = default(CancellationToken))
+            CancellationToken cancellationToken = default)
         {
             IEnumerable<AmqpTcpEndpoint> endpoints = hostnames.Select(h => new AmqpTcpEndpoint(h, Port, Ssl, MaxMessageSize));
             return CreateConnectionAsync(EndpointResolverFactory(endpoints), clientProvidedName, cancellationToken);
@@ -598,7 +598,7 @@ public IConnection CreateConnection(IEnumerable<AmqpTcpEndpoint> endpoints)
         /// When no hostname was reachable.
         /// </exception>
         public ValueTask<IConnection> CreateConnectionAsync(IEnumerable<AmqpTcpEndpoint> endpoints,
-            CancellationToken cancellationToken = default(CancellationToken))
+            CancellationToken cancellationToken = default)
         {
             return CreateConnectionAsync(endpoints, ClientProvidedName, cancellationToken);
         }
@@ -648,7 +648,7 @@ public IConnection CreateConnection(IEnumerable<AmqpTcpEndpoint> endpoints, stri
         /// When no hostname was reachable.
         /// </exception>
         public ValueTask<IConnection> CreateConnectionAsync(IEnumerable<AmqpTcpEndpoint> endpoints, string clientProvidedName,
-            CancellationToken cancellationToken = default(CancellationToken))
+            CancellationToken cancellationToken = default)
         {
             return CreateConnectionAsync(EndpointResolverFactory(endpoints), clientProvidedName, cancellationToken);
         }
@@ -687,9 +687,9 @@ public IConnection CreateConnection(IEndpointResolver endpointResolver, string c
                     return (Connection)c.Open();
                 }
             }
-            catch (Exception e)
+            catch (Exception ex)
             {
-                throw new BrokerUnreachableException(e);
+                throw new BrokerUnreachableException(ex);
             }
         }
 
@@ -711,7 +711,7 @@ public IConnection CreateConnection(IEndpointResolver endpointResolver, string c
         /// When no hostname was reachable.
         /// </exception>
         public async ValueTask<IConnection> CreateConnectionAsync(IEndpointResolver endpointResolver, string clientProvidedName,
-            CancellationToken cancellationToken = default(CancellationToken))
+            CancellationToken cancellationToken = default)
         {
             ConnectionConfig config = CreateConfig(clientProvidedName);
             try
@@ -731,19 +731,20 @@ public async ValueTask<IConnection> CreateConnectionAsync(IEndpointResolver endp
                         .ConfigureAwait(false);
                 }
             }
-            // TODO is this correct?
-            catch (TaskCanceledException)
+            catch (OperationCanceledException ex)
             {
-                throw;
-            }
-            // TODO is this correct?
-            catch (AggregateException)
-            {
-                throw;
+                if (cancellationToken.IsCancellationRequested)
+                {
+                    throw;
+                }
+                else
+                {
+                    throw new BrokerUnreachableException(ex);
+                }
             }
-            catch (Exception e)
+            catch (Exception ex)
             {
-                throw new BrokerUnreachableException(e);
+                throw new BrokerUnreachableException(ex);
             }
         }
 

diff --git a/projects/RabbitMQ.Client/client/api/DefaultEndpointResolver.cs b/projects/RabbitMQ.Client/client/api/DefaultEndpointResolver.cs
@@ -38,7 +38,7 @@ namespace RabbitMQ.Client
     public class DefaultEndpointResolver : IEndpointResolver
     {
 #if !NET6_0_OR_GREATER
-        private static readonly Random s_rnd = new Random();
+        private readonly Random s_rnd = new Random();
 #endif
         private readonly List<AmqpTcpEndpoint> _endpoints;
 

diff --git a/projects/RabbitMQ.Client/client/api/IConnectionFactory.cs b/projects/RabbitMQ.Client/client/api/IConnectionFactory.cs
@@ -107,7 +107,7 @@ public interface IConnectionFactory
         /// Asynchronously create a connection to the specified endpoint.
         /// </summary>
         /// <param name="cancellationToken">Cancellation token for this connection</param>
-        ValueTask<IConnection> CreateConnectionAsync(CancellationToken cancellationToken);
+        ValueTask<IConnection> CreateConnectionAsync(CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Create a connection to the specified endpoint.
@@ -132,7 +132,7 @@ public interface IConnectionFactory
         /// </param>
         /// <param name="cancellationToken">Cancellation token for this connection</param>
         /// <returns>Open connection</returns>
-        ValueTask<IConnection> CreateConnectionAsync(string clientProvidedName, CancellationToken cancellationToken);
+        ValueTask<IConnection> CreateConnectionAsync(string clientProvidedName, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Connects to the first reachable hostname from the list.
@@ -147,7 +147,7 @@ public interface IConnectionFactory
         /// <param name="hostnames">List of host names to use</param>
         /// <param name="cancellationToken">Cancellation token for this connection</param>
         /// <returns>Open connection</returns>
-        ValueTask<IConnection> CreateConnectionAsync(IEnumerable<string> hostnames, CancellationToken cancellationToken);
+        ValueTask<IConnection> CreateConnectionAsync(IEnumerable<string> hostnames, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Connects to the first reachable hostname from the list.
@@ -175,7 +175,7 @@ public interface IConnectionFactory
         /// <param name="cancellationToken">Cancellation token for this connection</param>
         /// <returns>Open connection</returns>
         ValueTask<IConnection> CreateConnectionAsync(IEnumerable<string> hostnames, string clientProvidedName,
-            CancellationToken cancellationToken);
+            CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Create a connection using a list of endpoints.
@@ -204,7 +204,7 @@ ValueTask<IConnection> CreateConnectionAsync(IEnumerable<string> hostnames, stri
         /// <exception cref="BrokerUnreachableException">
         /// When no hostname was reachable.
         /// </exception>
-        ValueTask<IConnection> CreateConnectionAsync(IEnumerable<AmqpTcpEndpoint> endpoints, CancellationToken cancellationToken);
+        ValueTask<IConnection> CreateConnectionAsync(IEnumerable<AmqpTcpEndpoint> endpoints, CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Create a connection using a list of endpoints.
@@ -246,7 +246,7 @@ ValueTask<IConnection> CreateConnectionAsync(IEnumerable<string> hostnames, stri
         /// When no hostname was reachable.
         /// </exception>
         ValueTask<IConnection> CreateConnectionAsync(IEnumerable<AmqpTcpEndpoint> endpoints, string clientProvidedName,
-            CancellationToken cancellationToken);
+            CancellationToken cancellationToken = default);
 
         /// <summary>
         /// Amount of time protocol handshake operations are allowed to take before

diff --git a/projects/RabbitMQ.Client/client/api/ITcpClient.cs b/projects/RabbitMQ.Client/client/api/ITcpClient.cs
@@ -19,7 +19,7 @@ public interface ITcpClient : IDisposable
 
         Socket Client { get; }
 
-        Task ConnectAsync(IPAddress host, int port, CancellationToken cancellationToken);
+        Task ConnectAsync(IPAddress host, int port, CancellationToken cancellationToken = default);
 
         NetworkStream GetStream();
 

diff --git a/projects/RabbitMQ.Client/client/api/TcpClientAdapter.cs b/projects/RabbitMQ.Client/client/api/TcpClientAdapter.cs
@@ -21,13 +21,13 @@ public TcpClientAdapter(Socket socket)
         }
 
 #if NET6_0_OR_GREATER
-        public virtual Task ConnectAsync(IPAddress ep, int port, CancellationToken cancellationToken)
+        public virtual Task ConnectAsync(IPAddress ep, int port, CancellationToken cancellationToken = default)
         {
             AssertSocket();
             return _sock.ConnectAsync(ep, port, cancellationToken).AsTask();
         }
 #else
-        public virtual Task ConnectAsync(IPAddress ep, int port, CancellationToken cancellationToken)
+        public virtual Task ConnectAsync(IPAddress ep, int port, CancellationToken cancellationToken = default)
         {
             return _sock.ConnectAsync(ep, port).WithCancellation(cancellationToken);
         }

diff --git a/projects/RabbitMQ.Client/client/impl/Connection.Commands.cs b/projects/RabbitMQ.Client/client/impl/Connection.Commands.cs
@@ -74,7 +74,7 @@ private async ValueTask StartAndTuneAsync(CancellationToken cancellationToken)
         {
             var connectionStartCell = new TaskCompletionSource<ConnectionStartDetails>(TaskCreationOptions.RunContinuationsAsynchronously);
 
-            cancellationToken.Register(() =>
+            using CancellationTokenRegistration ctr = cancellationToken.Register(() =>
             {
                 if (connectionStartCell.TrySetCanceled())
                 {

diff --git a/projects/Test/Unit/APIApproval.Approve.verified.txt b/projects/Test/Unit/APIApproval.Approve.verified.txt
@@ -599,12 +599,12 @@ namespace RabbitMQ.Client
         RabbitMQ.Client.IConnection CreateConnection(string clientProvidedName);
         RabbitMQ.Client.IConnection CreateConnection(System.Collections.Generic.IEnumerable<RabbitMQ.Client.AmqpTcpEndpoint> endpoints, string clientProvidedName);
         RabbitMQ.Client.IConnection CreateConnection(System.Collections.Generic.IEnumerable<string> hostnames, string clientProvidedName);
-        System.Threading.Tasks.ValueTask<RabbitMQ.Client.IConnection> CreateConnectionAsync(System.Threading.CancellationToken cancellationToken);
-        System.Threading.Tasks.ValueTask<RabbitMQ.Client.IConnection> CreateConnectionAsync(System.Collections.Generic.IEnumerable<RabbitMQ.Client.AmqpTcpEndpoint> endpoints, System.Threading.CancellationToken cancellationToken);
-        System.Threading.Tasks.ValueTask<RabbitMQ.Client.IConnection> CreateConnectionAsync(System.Collections.Generic.IEnumerable<string> hostnames, System.Threading.CancellationToken cancellationToken);
-        System.Threading.Tasks.ValueTask<RabbitMQ.Client.IConnection> CreateConnectionAsync(string clientProvidedName, System.Threading.CancellationToken cancellationToken);
-        System.Threading.Tasks.ValueTask<RabbitMQ.Client.IConnection> CreateConnectionAsync(System.Collections.Generic.IEnumerable<RabbitMQ.Client.AmqpTcpEndpoint> endpoints, string clientProvidedName, System.Threading.CancellationToken cancellationToken);
-        System.Threading.Tasks.ValueTask<RabbitMQ.Client.IConnection> CreateConnectionAsync(System.Collections.Generic.IEnumerable<string> hostnames, string clientProvidedName, System.Threading.CancellationToken cancellationToken);
+        System.Threading.Tasks.ValueTask<RabbitMQ.Client.IConnection> CreateConnectionAsync(System.Threading.CancellationToken cancellationToken = default);
+        System.Threading.Tasks.ValueTask<RabbitMQ.Client.IConnection> CreateConnectionAsync(System.Collections.Generic.IEnumerable<RabbitMQ.Client.AmqpTcpEndpoint> endpoints, System.Threading.CancellationToken cancellationToken = default);
+        System.Threading.Tasks.ValueTask<RabbitMQ.Client.IConnection> CreateConnectionAsync(System.Collections.Generic.IEnumerable<string> hostnames, System.Threading.CancellationToken cancellationToken = default);
+        System.Threading.Tasks.ValueTask<RabbitMQ.Client.IConnection> CreateConnectionAsync(string clientProvidedName, System.Threading.CancellationToken cancellationToken = default);
+        System.Threading.Tasks.ValueTask<RabbitMQ.Client.IConnection> CreateConnectionAsync(System.Collections.Generic.IEnumerable<RabbitMQ.Client.AmqpTcpEndpoint> endpoints, string clientProvidedName, System.Threading.CancellationToken cancellationToken = default);
+        System.Threading.Tasks.ValueTask<RabbitMQ.Client.IConnection> CreateConnectionAsync(System.Collections.Generic.IEnumerable<string> hostnames, string clientProvidedName, System.Threading.CancellationToken cancellationToken = default);
     }
     public interface ICredentialsProvider
     {
@@ -712,7 +712,7 @@ namespace RabbitMQ.Client
         bool Connected { get; }
         System.TimeSpan ReceiveTimeout { get; set; }
         void Close();
-        System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress host, int port, System.Threading.CancellationToken cancellationToken);
+        System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress host, int port, System.Threading.CancellationToken cancellationToken = default);
         System.Net.Sockets.NetworkStream GetStream();
     }
     public class PlainMechanism : RabbitMQ.Client.IAuthMechanism
@@ -831,7 +831,7 @@ namespace RabbitMQ.Client
         public virtual bool Connected { get; }
         public virtual System.TimeSpan ReceiveTimeout { get; set; }
         public virtual void Close() { }
-        public virtual System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress ep, int port, System.Threading.CancellationToken cancellationToken) { }
+        public virtual System.Threading.Tasks.Task ConnectAsync(System.Net.IPAddress ep, int port, System.Threading.CancellationToken cancellationToken = default) { }
         public void Dispose() { }
         protected virtual void Dispose(bool disposing) { }
         public virtual System.Net.Sockets.NetworkStream GetStream() { }