Clean up IChannelExtensions

lukebakken · lukebakken · commit fd0f5bdedad4 · 2024-09-06T08:06:18.000-07:00
* Remove extension method that could create an ambiguous situation when parameter names were used
diff --git a/projects/RabbitMQ.Client/PublicAPI.Shipped.txt b/projects/RabbitMQ.Client/PublicAPI.Shipped.txt
@@ -856,7 +856,6 @@ virtual RabbitMQ.Client.TcpClientAdapter.ReceiveTimeout.set -> void
 ~static RabbitMQ.Client.RabbitMQActivitySource.ContextExtractor.set -> void
 ~static RabbitMQ.Client.RabbitMQActivitySource.ContextInjector.get -> System.Action<System.Diagnostics.Activity, System.Collections.Generic.IDictionary<string, object>>
 ~static RabbitMQ.Client.RabbitMQActivitySource.ContextInjector.set -> void
-static RabbitMQ.Client.IChannelExtensions.BasicConsumeAsync(this RabbitMQ.Client.IChannel! channel, RabbitMQ.Client.IAsyncBasicConsumer! consumer, string! queue, bool autoAck = false, string! consumerTag = "", bool noLocal = false, bool exclusive = false, System.Collections.Generic.IDictionary<string!, object?>? arguments = null, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<string!>!
 static RabbitMQ.Client.IChannelExtensions.BasicConsumeAsync(this RabbitMQ.Client.IChannel! channel, string! queue, bool autoAck, RabbitMQ.Client.IAsyncBasicConsumer! consumer, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<string!>!
 static RabbitMQ.Client.IChannelExtensions.BasicConsumeAsync(this RabbitMQ.Client.IChannel! channel, string! queue, bool autoAck, string! consumerTag, RabbitMQ.Client.IAsyncBasicConsumer! consumer, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<string!>!
 static RabbitMQ.Client.IChannelExtensions.BasicConsumeAsync(this RabbitMQ.Client.IChannel! channel, string! queue, bool autoAck, string! consumerTag, System.Collections.Generic.IDictionary<string!, object?>? arguments, RabbitMQ.Client.IAsyncBasicConsumer! consumer, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) -> System.Threading.Tasks.Task<string!>!
diff --git a/projects/RabbitMQ.Client/client/api/IChannelExtensions.cs b/projects/RabbitMQ.Client/client/api/IChannelExtensions.cs
@@ -31,7 +31,6 @@
 
 using System;
 using System.Collections.Generic;
-using System.Diagnostics;
 using System.Threading;
 using System.Threading.Tasks;
 using RabbitMQ.Client.client.impl;
@@ -42,105 +41,124 @@ public static class IChannelExtensions
     {
         /// <summary>Asynchronously start a Basic content-class consumer.</summary>
         public static Task<string> BasicConsumeAsync(this IChannel channel,
-            IAsyncBasicConsumer consumer,
             string queue,
-            bool autoAck = false,
-            string consumerTag = "",
-            bool noLocal = false,
-            bool exclusive = false,
-            IDictionary<string, object?>? arguments = null,
-            CancellationToken cancellationToken = default)
-        {
-            return channel.BasicConsumeAsync(queue, autoAck, consumerTag, noLocal, exclusive, arguments, consumer, cancellationToken);
-        }
-
-        /// <summary>Asynchronously start a Basic content-class consumer.</summary>
-        public static Task<string> BasicConsumeAsync(this IChannel channel, string queue,
             bool autoAck,
             IAsyncBasicConsumer consumer,
-            CancellationToken cancellationToken = default)
-        {
-            return channel.BasicConsumeAsync(queue, autoAck, string.Empty, false, false, null, consumer, cancellationToken);
-        }
+            CancellationToken cancellationToken = default) =>
+            channel.BasicConsumeAsync(queue: queue, autoAck: autoAck, consumerTag: string.Empty,
+                noLocal: false, exclusive: false, arguments: null, consumer: consumer,
+                cancellationToken);
 
         /// <summary>Asynchronously start a Basic content-class consumer.</summary>
-        public static Task<string> BasicConsumeAsync(this IChannel channel, string queue,
+        public static Task<string> BasicConsumeAsync(this IChannel channel,
+            string queue,
             bool autoAck,
             string consumerTag,
             IAsyncBasicConsumer consumer,
-            CancellationToken cancellationToken = default)
-        {
-            return channel.BasicConsumeAsync(queue, autoAck, consumerTag, false, false, null, consumer, cancellationToken);
-        }
+            CancellationToken cancellationToken = default) =>
+            channel.BasicConsumeAsync(queue: queue, autoAck: autoAck, consumerTag: consumerTag,
+                noLocal: false, exclusive: false, arguments: null, consumer: consumer,
+                cancellationToken);
 
         /// <summary>Asynchronously start a Basic content-class consumer.</summary>
-        public static Task<string> BasicConsumeAsync(this IChannel channel, string queue,
+        public static Task<string> BasicConsumeAsync(this IChannel channel,
+            string queue,
             bool autoAck,
             string consumerTag,
             IDictionary<string, object?>? arguments,
             IAsyncBasicConsumer consumer,
-            CancellationToken cancellationToken = default)
-        {
-            return channel.BasicConsumeAsync(queue, autoAck, consumerTag, false, false, arguments, consumer, cancellationToken);
-        }
+            CancellationToken cancellationToken = default) =>
+            channel.BasicConsumeAsync(queue: queue, autoAck: autoAck, consumerTag: consumerTag,
+                noLocal: false, exclusive: false, arguments: arguments, consumer: consumer,
+                cancellationToken);
 
         /// <summary>
         /// (Extension method) Convenience overload of BasicPublish.
         /// </summary>
         /// <remarks>
         /// The publication occurs with mandatory=false and immediate=false.
         /// </remarks>
-        public static ValueTask BasicPublishAsync<T>(this IChannel channel, PublicationAddress addr, T basicProperties,
-            ReadOnlyMemory<byte> body, CancellationToken cancellationToken = default)
-            where T : IReadOnlyBasicProperties, IAmqpHeader
-        {
-            return channel.BasicPublishAsync(addr.ExchangeName, addr.RoutingKey, basicProperties, body, false, cancellationToken);
-        }
+        public static ValueTask BasicPublishAsync<T>(this IChannel channel,
+            PublicationAddress addr,
+            T basicProperties,
+            ReadOnlyMemory<byte> body,
+            CancellationToken cancellationToken = default)
+            where T : IReadOnlyBasicProperties, IAmqpHeader =>
+            channel.BasicPublishAsync(exchange: addr.ExchangeName, routingKey: addr.RoutingKey,
+                basicProperties: basicProperties, body: body, mandatory: false,
+                cancellationToken);
 
-        public static ValueTask BasicPublishAsync(this IChannel channel, string exchange, string routingKey,
-            ReadOnlyMemory<byte> body = default, bool mandatory = false, CancellationToken cancellationToken = default) =>
-            channel.BasicPublishAsync(exchange, routingKey, EmptyBasicProperty.Empty, body, mandatory, cancellationToken);
+        public static ValueTask BasicPublishAsync(this IChannel channel,
+            string exchange,
+            string routingKey,
+            ReadOnlyMemory<byte> body = default,
+            bool mandatory = false,
+            CancellationToken cancellationToken = default) =>
+            channel.BasicPublishAsync(exchange: exchange, routingKey: routingKey,
+                basicProperties: EmptyBasicProperty.Empty, body: body, mandatory: mandatory,
+                cancellationToken);
 
-        public static ValueTask BasicPublishAsync(this IChannel channel, CachedString exchange,
-            CachedString routingKey, ReadOnlyMemory<byte> body = default, bool mandatory = false, CancellationToken cancellationToken = default) =>
-            channel.BasicPublishAsync(exchange, routingKey, EmptyBasicProperty.Empty, body, mandatory, cancellationToken);
+        public static ValueTask BasicPublishAsync(this IChannel channel,
+            CachedString exchange,
+            CachedString routingKey,
+            ReadOnlyMemory<byte> body = default,
+            bool mandatory = false,
+            CancellationToken cancellationToken = default) =>
+            channel.BasicPublishAsync(exchange: exchange, routingKey: routingKey,
+               basicProperties: EmptyBasicProperty.Empty, body: body, mandatory: mandatory,
+               cancellationToken);
 
         /// <summary>
         /// Asynchronously declare a queue.
         /// </summary>
-        public static Task<QueueDeclareOk> QueueDeclareAsync(this IChannel channel, string queue = "", bool durable = false, bool exclusive = true,
-            bool autoDelete = true, IDictionary<string, object?>? arguments = null, bool noWait = false, CancellationToken cancellationToken = default)
-        {
-            return channel.QueueDeclareAsync(queue: queue, passive: false,
+        public static Task<QueueDeclareOk> QueueDeclareAsync(this IChannel channel,
+            string queue = "",
+            bool durable = false,
+            bool exclusive = true,
+            bool autoDelete = true,
+            IDictionary<string, object?>? arguments = null,
+            bool noWait = false,
+            CancellationToken cancellationToken = default) =>
+            channel.QueueDeclareAsync(queue: queue, passive: false,
                 durable: durable, exclusive: exclusive, autoDelete: autoDelete,
-                arguments: arguments, noWait: noWait, cancellationToken: cancellationToken);
-        }
+                arguments: arguments, noWait: noWait,
+                cancellationToken: cancellationToken);
 
         /// <summary>
         /// Asynchronously declare an exchange.
         /// </summary>
-        public static Task ExchangeDeclareAsync(this IChannel channel, string exchange, string type, bool durable = false, bool autoDelete = false,
-            IDictionary<string, object?>? arguments = null, bool noWait = false, CancellationToken cancellationToken = default)
-        {
-            return channel.ExchangeDeclareAsync(exchange, type, durable, autoDelete,
-                arguments: arguments, passive: false, noWait: noWait, cancellationToken: cancellationToken);
-        }
+        public static Task ExchangeDeclareAsync(this IChannel channel,
+            string exchange,
+            string type,
+            bool durable = false,
+            bool autoDelete = false,
+            IDictionary<string, object?>? arguments = null,
+            bool noWait = false,
+            CancellationToken cancellationToken = default) =>
+            channel.ExchangeDeclareAsync(exchange: exchange, type: type, durable: durable,
+                autoDelete: autoDelete, arguments: arguments, passive: false, noWait: noWait,
+                cancellationToken: cancellationToken);
 
         /// <summary>
         /// Asynchronously deletes a queue.
         /// </summary>
-        public static Task<uint> QueueDeleteAsync(this IChannel channel, string queue, bool ifUnused = false, bool ifEmpty = false, CancellationToken cancellationToken = default)
-        {
-            return channel.QueueDeleteAsync(queue, ifUnused, ifEmpty, false, cancellationToken);
-        }
+        public static Task<uint> QueueDeleteAsync(this IChannel channel,
+            string queue,
+            bool ifUnused = false,
+            bool ifEmpty = false,
+            CancellationToken cancellationToken = default) =>
+            channel.QueueDeleteAsync(queue, ifUnused, ifEmpty, false, cancellationToken);
 
         /// <summary>
         /// Asynchronously unbinds a queue.
         /// </summary>
-        public static Task QueueUnbindAsync(this IChannel channel, string queue, string exchange, string routingKey, IDictionary<string, object?>? arguments = null, CancellationToken cancellationToken = default)
-        {
-            return channel.QueueUnbindAsync(queue, exchange, routingKey, arguments, cancellationToken);
-        }
+        public static Task QueueUnbindAsync(this IChannel channel,
+            string queue,
+            string exchange,
+            string routingKey,
+            IDictionary<string, object?>? arguments = null,
+            CancellationToken cancellationToken = default) =>
+            channel.QueueUnbindAsync(queue, exchange, routingKey, arguments, cancellationToken);
 
         /// <summary>
         /// Asynchronously abort this session.
@@ -153,11 +171,10 @@ public static Task QueueUnbindAsync(this IChannel channel, string queue, string
         /// In comparison to normal <see cref="CloseAsync(IChannel, CancellationToken)"/> method, <see cref="AbortAsync(IChannel, CancellationToken)"/> will not throw
         /// <see cref="Exceptions.AlreadyClosedException"/> or <see cref="System.IO.IOException"/> or any other <see cref="Exception"/> during closing channel.
         /// </remarks>
-        public static Task AbortAsync(this IChannel channel, CancellationToken cancellationToken = default)
-        {
-            return channel.CloseAsync(Constants.ReplySuccess, "Goodbye", true,
+        public static Task AbortAsync(this IChannel channel,
+            CancellationToken cancellationToken = default) =>
+            channel.CloseAsync(Constants.ReplySuccess, "Goodbye", true,
                 cancellationToken);
-        }
 
         /// <summary>Asynchronously close this session.</summary>
         /// <remarks>
@@ -166,11 +183,10 @@ public static Task AbortAsync(this IChannel channel, CancellationToken cancellat
         /// operation to complete. This method will not return to the
         /// caller until the shutdown is complete.
         /// </remarks>
-        public static Task CloseAsync(this IChannel channel, CancellationToken cancellationToken = default)
-        {
-            return channel.CloseAsync(Constants.ReplySuccess, "Goodbye", false,
+        public static Task CloseAsync(this IChannel channel,
+            CancellationToken cancellationToken = default) =>
+            channel.CloseAsync(Constants.ReplySuccess, "Goodbye", false,
                 cancellationToken);
-        }
 
         /// <summary>
         /// Asynchronously close this channel.
@@ -189,10 +205,10 @@ public static Task CloseAsync(this IChannel channel, CancellationToken cancellat
         /// A message indicating the reason for closing the channel
         /// </para>
         /// </remarks>
-        public static Task CloseAsync(this IChannel channel, ushort replyCode, string replyText,
-            CancellationToken cancellationToken = default)
-        {
-            return channel.CloseAsync(replyCode, replyText, false, cancellationToken);
-        }
+        public static Task CloseAsync(this IChannel channel,
+            ushort replyCode,
+            string replyText,
+            CancellationToken cancellationToken = default) =>
+            channel.CloseAsync(replyCode, replyText, false, cancellationToken);
     }
 }
diff --git a/projects/Test/Integration/ConnectionRecovery/EventHandlerRecovery/Connection/TestRecoveringConsumerEventHandlers.cs b/projects/Test/Integration/ConnectionRecovery/EventHandlerRecovery/Connection/TestRecoveringConsumerEventHandlers.cs
@@ -79,7 +79,8 @@ public async Task TestRecoveringConsumerEventHandler_EventArgumentsArePassedDown
 
             RabbitMQ.Client.QueueDeclareOk q = await _channel.QueueDeclareAsync(GenerateQueueName(), false, false, false);
             var cons = new AsyncEventingBasicConsumer(_channel);
-            string expectedCTag = await _channel.BasicConsumeAsync(cons, q, arguments: arguments);
+            string expectedCTag = await _channel.BasicConsumeAsync(consumer: cons, queue: q, autoAck: false,
+                arguments: arguments, consumerTag: string.Empty);
 
             bool ctagMatches = false;
             bool consumerArgumentMatches = false;
diff --git a/projects/Test/Integration/TestAsyncConsumer.cs b/projects/Test/Integration/TestAsyncConsumer.cs
@@ -664,7 +664,7 @@ public async Task TestCloseWithinEventHandler_GH1567()
                 tcs.TrySetResult(true);
             };
 
-            await _channel.BasicConsumeAsync(consumer, queueName, true);
+            await _channel.BasicConsumeAsync(consumer: consumer, queue: queueName, autoAck: true);
 
             var bp = new BasicProperties();
 
