redis-cluster-client 0.4.17 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc35dc957459313cb97b78fae42fadb612788e8e65eb49449db24b66294057fa
-  data.tar.gz: 03cf3604892eb1a881123bdfeabaeac30816ed940a827c5390b2320b3e9e26f0
+  metadata.gz: ac7d6ca1474a42ad2d4027de72dbd087f6d248b3678ad2e360ed55b56dc60790
+  data.tar.gz: ce4de83f3f601772df8c95381a65172245967bd9568ff7959aec5858e55fb7af
 SHA512:
-  metadata.gz: 7f8de53c53938381fb88c53ac2f13e8b7a78a3ee5653493fe0496acebaf0da57b568fb8c4436f8d19a7ba84d55018d9e4786c3726af2586581d0e7daee7b383f
-  data.tar.gz: 7b65b9e12fd251ca8a6c278c4fb245fc08b114c9cbfac58f88e5aca81d8b9ac9aa4939ef9dbf2ee042f313764b3205a9490453b7a2310915338e50c2871e4c47
+  metadata.gz: 3cb2167fb97c6ab7ccba66e888521a1a119e2f17a0c373829bce0abb41518ead4005c0a7c176373c45942e9cd9fca71355b9898e7cc2b67db22d6291a76b324e
+  data.tar.gz: 1da6192fcb6f33359b508ff4e3445ec029373ff9606f78170051a682a29371524d6f08864f4a0887b3cbc298e462d13fe8cc9080eb29bd9cf8d965c7a766409e

data/lib/redis_client/cluster/node/random_replica_or_primary.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'redis_client/cluster/node/replica_mixin'
+
+class RedisClient
+  class Cluster
+    class Node
+      class RandomReplicaOrPrimary
+        include ::RedisClient::Cluster::Node::ReplicaMixin
+
+        def replica_clients
+          keys = @replications.values.filter_map(&:sample)
+          @clients.select { |k, _| keys.include?(k) }
+        end
+
+        def clients_for_scanning(seed: nil)
+          random = seed.nil? ? Random : Random.new(seed)
+          keys = @replications.map do |primary_node_key, replica_node_keys|
+            decide_use_primary?(random, replica_node_keys.size) ? primary_node_key : replica_node_keys.sample(random: random)
+          end
+
+          clients.select { |k, _| keys.include?(k) }
+        end
+
+        def find_node_key_of_replica(primary_node_key, seed: nil)
+          random = seed.nil? ? Random : Random.new(seed)
+
+          replica_node_keys = @replications.fetch(primary_node_key, EMPTY_ARRAY)
+          if decide_use_primary?(random, replica_node_keys.size)
+            primary_node_key
+          else
+            replica_node_keys.sample(random: random) || primary_node_key
+          end
+        end
+
+        def any_replica_node_key(seed: nil)
+          random = seed.nil? ? Random : Random.new(seed)
+          @replica_node_keys.sample(random: random) || any_primary_node_key(seed: seed)
+        end
+
+        private
+
+        # Randomly equally likely choose node to read between primary and all replicas
+        # e.g. 1 primary + 1 replica = 50% probability to read from primary
+        # e.g. 1 primary + 2 replica = 33% probability to read from primary
+        # e.g. 1 primary + 0 replica = 100% probability to read from primary
+        def decide_use_primary?(random, replica_nodes)
+          primary_nodes = 1.0
+          total = primary_nodes + replica_nodes
+          random.rand < primary_nodes / total
+        end
+      end
+    end
+  end
+end

data/lib/redis_client/cluster/node.rb

@@ -5,6 +5,7 @@ require 'redis_client/config'
 require 'redis_client/cluster/errors'
 require 'redis_client/cluster/node/primary_only'
 require 'redis_client/cluster/node/random_replica'
+require 'redis_client/cluster/node/random_replica_or_primary'
 require 'redis_client/cluster/node/latency_replica'
 
 class RedisClient
@@ -284,6 +285,8 @@ class RedisClient
       def make_topology_class(with_replica, replica_affinity)
         if with_replica && replica_affinity == :random
           ::RedisClient::Cluster::Node::RandomReplica
+        elsif with_replica && replica_affinity == :random_with_primary
+          ::RedisClient::Cluster::Node::RandomReplicaOrPrimary
         elsif with_replica && replica_affinity == :latency
           ::RedisClient::Cluster::Node::LatencyReplica
         else

data/lib/redis_client/cluster/pipeline.rb

@@ -149,7 +149,7 @@ class RedisClient
         all_replies = errors = nil
         @pipelines&.each_slice(MAX_THREADS) do |chuncked_pipelines|
           chuncked_pipelines
-            .map { |node_key, pipeline| [node_key, build_thread_for_pipeline(@router, node_key, pipeline)] }
+            .map { |node_key, pipeline| [node_key, build_thread_for_pipeline(@router.find_node(node_key), pipeline)] }
             .each do |node_key, thread|
               case v = thread.value
               when ::RedisClient::Cluster::Pipeline::RedirectionNeeded
@@ -182,9 +182,9 @@ class RedisClient
         @pipelines[node_key]
       end
 
-      def build_thread_for_pipeline(router, node_key, pipeline)
-        Thread.new(router, node_key, pipeline) do |rt, nk, pl|
-          replies = do_pipelining(rt.find_node(nk), pl)
+      def build_thread_for_pipeline(client, pipeline)
+        Thread.new(client, pipeline) do |cli, pl|
+          replies = do_pipelining(cli, pl)
           raise ReplySizeError, "commands: #{pl._size}, replies: #{replies.size}" if pl._size != replies.size
 
           replies

data/lib/redis_client/cluster/pub_sub.rb

@@ -6,44 +6,44 @@ class RedisClient
   class Cluster
     class PubSub
       class State
-        def initialize(client)
+        def initialize(client, queue)
           @client = client
           @worker = nil
+          @queue = queue
         end
 
         def call(command)
           @client.call_v(command)
         end
 
+        def ensure_worker
+          @worker = spawn_worker(@client, @queue) unless @worker&.alive?
+        end
+
         def close
           @worker.exit if @worker&.alive?
           @client.close
         end
 
-        def take_message(timeout)
-          @worker = subscribe(@client, timeout) if @worker.nil?
-          return if @worker.alive?
-
-          message = @worker.value
-          @worker = nil
-          message
-        end
-
         private
 
-        def subscribe(client, timeout)
-          Thread.new(client, timeout) do |pubsub, to|
-            pubsub.next_event(to)
-          rescue StandardError => e
-            e
+        def spawn_worker(client, queue)
+          Thread.new(client, queue) do |pubsub, q|
+            loop do
+              q << pubsub.next_event
+            rescue StandardError => e
+              q << e
+            end
           end
         end
       end
 
+      BUF_SIZE = Integer(ENV.fetch('REDIS_CLIENT_PUBSUB_BUF_SIZE', 1024))
+
       def initialize(router, command_builder)
         @router = router
         @command_builder = command_builder
-        @state_list = []
+        @queue = SizedQueue.new(BUF_SIZE)
         @state_dict = {}
       end
 
@@ -56,26 +56,25 @@ class RedisClient
       end
 
       def close
-        @state_list.each(&:close)
-        @state_list.clear
+        @state_dict.each_value(&:close)
         @state_dict.clear
+        @queue.clear
       end
 
       def next_event(timeout = nil)
-        return if @state_list.empty?
-
-        @state_list.shuffle!
+        @state_dict.each_value(&:ensure_worker)
         max_duration = calc_max_duration(timeout)
         starting = obtain_current_time
+
         loop do
           break if max_duration > 0 && obtain_current_time - starting > max_duration
 
-          @state_list.each do |pubsub|
-            message = pubsub.take_message(timeout)
-            return message if message
+          case event = @queue.pop(true)
+          when StandardError then raise event
+          when Array then break event
           end
-
-          sleep 0.001
+        rescue ThreadError
+          sleep 0.005
         end
       end
 
@@ -100,8 +99,7 @@ class RedisClient
       def add_state(node_key)
         return @state_dict[node_key] if @state_dict.key?(node_key)
 
-        state = State.new(@router.find_node(node_key).pubsub)
-        @state_list << state
+        state = State.new(@router.find_node(node_key).pubsub, @queue)
         @state_dict[node_key] = state
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-cluster-client
 version: !ruby/object:Gem::Version
-  version: 0.4.17
+  version: 0.5.0
 platform: ruby
 authors:
 - Taishi Kasuga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-02 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-client
@@ -40,6 +40,7 @@ files:
 - lib/redis_client/cluster/node/latency_replica.rb
 - lib/redis_client/cluster/node/primary_only.rb
 - lib/redis_client/cluster/node/random_replica.rb
+- lib/redis_client/cluster/node/random_replica_or_primary.rb
 - lib/redis_client/cluster/node/replica_mixin.rb
 - lib/redis_client/cluster/node_key.rb
 - lib/redis_client/cluster/normalized_cmd_name.rb