Rename method to

LookupLeaderOrRandomReplicasConnection Signed-off-by: Gabriele Santomaggio <G.santomaggio@gmail.com>
rabbitmq · Feb 6, 2024 · cfb6b24 · cfb6b24
1 parent 8138f53
commit cfb6b24
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 12 deletions.
diff --git a/RabbitMQ.Stream.Client/PublicAPI.Unshipped.txt b/RabbitMQ.Stream.Client/PublicAPI.Unshipped.txt
@@ -301,4 +301,4 @@ static RabbitMQ.Stream.Client.RawSuperStreamProducer.Create(RabbitMQ.Stream.Clie
 static RabbitMQ.Stream.Client.Reliable.DeduplicatingProducer.Create(RabbitMQ.Stream.Client.Reliable.DeduplicatingProducerConfig producerConfig, Microsoft.Extensions.Logging.ILogger<RabbitMQ.Stream.Client.Reliable.Producer> logger = null) -> System.Threading.Tasks.Task<RabbitMQ.Stream.Client.Reliable.DeduplicatingProducer>
 static RabbitMQ.Stream.Client.Reliable.ReliableBase.RandomWait() -> System.Threading.Tasks.Task
 static RabbitMQ.Stream.Client.RoutingHelper<T>.LookupLeaderConnection(RabbitMQ.Stream.Client.ClientParameters clientParameters, RabbitMQ.Stream.Client.StreamInfo metaDataInfo, RabbitMQ.Stream.Client.ConnectionsPool pool, Microsoft.Extensions.Logging.ILogger logger = null) -> System.Threading.Tasks.Task<RabbitMQ.Stream.Client.IClient>
-static RabbitMQ.Stream.Client.RoutingHelper<T>.LookupRandomConnection(RabbitMQ.Stream.Client.ClientParameters clientParameters, RabbitMQ.Stream.Client.StreamInfo metaDataInfo, RabbitMQ.Stream.Client.ConnectionsPool pool, Microsoft.Extensions.Logging.ILogger logger = null) -> System.Threading.Tasks.Task<RabbitMQ.Stream.Client.IClient>
+static RabbitMQ.Stream.Client.RoutingHelper<T>.LookupLeaderOrRandomReplicasConnection(RabbitMQ.Stream.Client.ClientParameters clientParameters, RabbitMQ.Stream.Client.StreamInfo metaDataInfo, RabbitMQ.Stream.Client.ConnectionsPool pool, Microsoft.Extensions.Logging.ILogger logger = null) -> System.Threading.Tasks.Task<RabbitMQ.Stream.Client.IClient>
diff --git a/RabbitMQ.Stream.Client/RawConsumer.cs b/RabbitMQ.Stream.Client/RawConsumer.cs
@@ -202,7 +202,7 @@ public static async Task<IConsumer> Create(
         )
         {
             var client = await RoutingHelper<Routing>
-                .LookupRandomConnection(clientParameters, metaStreamInfo, config.Pool, logger)
+                .LookupLeaderOrRandomReplicasConnection(clientParameters, metaStreamInfo, config.Pool, logger)
                 .ConfigureAwait(false);
             var consumer = new RawConsumer((Client)client, config, logger);
             await consumer.Init().ConfigureAwait(false);

diff --git a/RabbitMQ.Stream.Client/RoutingClient.cs b/RabbitMQ.Stream.Client/RoutingClient.cs
@@ -181,12 +181,13 @@ await LookupConnection(clientParameters, metaDataInfo.Leader, MaxAttempts(metaDa
         }
 
         /// <summary>
-        /// Gets a random connection. The consumer can connect to a replica or leader.
+        /// Gets a random connection a random replica.
+        /// If the replicas are not available it will connect to the leader.
         /// </summary>
-        public static async Task<IClient> LookupRandomConnection(ClientParameters clientParameters,
+        public static async Task<IClient> LookupLeaderOrRandomReplicasConnection(ClientParameters clientParameters,
             StreamInfo metaDataInfo, ConnectionsPool pool, ILogger logger = null)
         {
-            var brokers = new List<Broker>() { };
+            var brokers = new List<Broker>();
             if (metaDataInfo.Replicas is { Count: <= 0 })
             {
                 brokers.Add(metaDataInfo.Leader);

diff --git a/Tests/ConnectionsPoolTests.cs b/Tests/ConnectionsPoolTests.cs
@@ -80,9 +80,9 @@ public async void RoutingShouldReturnTwoConnectionsGivenOneItemPerConnection()
             var metaDataInfo = new StreamInfo("stream", ResponseCode.Ok, new Broker("localhost", 3939),
                 new List<Broker>());
             var pool = new ConnectionsPool(0, 1);
-            var c1 = await RoutingHelper<PoolRouting>.LookupRandomConnection(clientParameters, metaDataInfo, pool);
+            var c1 = await RoutingHelper<PoolRouting>.LookupLeaderOrRandomReplicasConnection(clientParameters, metaDataInfo, pool);
             c1.Consumers.Add(1, default);
-            var c2 = await RoutingHelper<PoolRouting>.LookupRandomConnection(clientParameters, metaDataInfo, pool);
+            var c2 = await RoutingHelper<PoolRouting>.LookupLeaderOrRandomReplicasConnection(clientParameters, metaDataInfo, pool);
             c2.Consumers.Add(1, default);
             // here we have two different connections
             // and must be different since we have only one id per connection

diff --git a/Tests/UnitTests.cs b/Tests/UnitTests.cs
@@ -160,7 +160,7 @@ public async Task GiveProperExceptionWhenUnableToConnect()
             var metaDataInfo = new StreamInfo("stream", ResponseCode.Ok, new Broker("localhost", 3939),
                 new List<Broker>());
             await Assert.ThrowsAsync<AggregateException>(() =>
-                RoutingHelper<Routing>.LookupRandomConnection(clientParameters, metaDataInfo,
+                RoutingHelper<Routing>.LookupLeaderOrRandomReplicasConnection(clientParameters, metaDataInfo,
                     new ConnectionsPool(1, 1)));
         }
 
@@ -233,7 +233,7 @@ public void RandomReplicaLeader()
             var metaDataInfo = new StreamInfo("stream", ResponseCode.Ok, new Broker("leader", 5552),
                 new List<Broker>());
             var client =
-                RoutingHelper<LeaderRouting>.LookupRandomConnection(clientParameters, metaDataInfo,
+                RoutingHelper<LeaderRouting>.LookupLeaderOrRandomReplicasConnection(clientParameters, metaDataInfo,
                     new ConnectionsPool(1, 1));
             Assert.Equal("5552", client.Result.ConnectionProperties["advertised_port"]);
             var res = (client.Result.ConnectionProperties["advertised_host"] == "leader" ||
@@ -254,7 +254,7 @@ public void RandomOnlyReplicaIfThereAre()
                     new Broker("replica2", 5553),
                 });
             var client =
-                RoutingHelper<ReplicaseRouting>.LookupRandomConnection(clientParameters, metaDataInfo,
+                RoutingHelper<ReplicaseRouting>.LookupLeaderOrRandomReplicasConnection(clientParameters, metaDataInfo,
                     new ConnectionsPool(1, 1));
             Assert.Equal("5553", client.Result.ConnectionProperties["advertised_port"]);
             var res = (client.Result.ConnectionProperties["advertised_host"] == "replica2");

diff --git a/docs/ReliableClient/Program.cs b/docs/ReliableClient/Program.cs
@@ -9,8 +9,8 @@
 {
     ProducersPerConnection = 2, 
     ConsumersPerConnection = 100,
-    Host = "node1",
-    Port = 5553,
+    Host = "localhost",
+    Port = 5552,
     LoadBalancer = true,
     SuperStream = false,
     Streams = 10,