redis 3.3.5 → 4.3.1

data/lib/redis/cluster/node.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require_relative '../errors'
+
+class Redis
+  class Cluster
+    # Keep client list of node for Redis Cluster Client
+    class Node
+      include Enumerable
+
+      ReloadNeeded = Class.new(StandardError)
+
+      ROLE_SLAVE = 'slave'
+
+      def initialize(options, node_flags = {}, with_replica = false)
+        @with_replica = with_replica
+        @node_flags = node_flags
+        @clients = build_clients(options)
+      end
+
+      def each(&block)
+        @clients.values.each(&block)
+      end
+
+      def sample
+        @clients.values.sample
+      end
+
+      def find_by(node_key)
+        @clients.fetch(node_key)
+      rescue KeyError
+        raise ReloadNeeded
+      end
+
+      def call_all(command, &block)
+        try_map { |_, client| client.call(command, &block) }.values
+      end
+
+      def call_master(command, &block)
+        try_map do |node_key, client|
+          next if slave?(node_key)
+
+          client.call(command, &block)
+        end.values
+      end
+
+      def call_slave(command, &block)
+        return call_master(command, &block) if replica_disabled?
+
+        try_map do |node_key, client|
+          next if master?(node_key)
+
+          client.call(command, &block)
+        end.values
+      end
+
+      def process_all(commands, &block)
+        try_map { |_, client| client.process(commands, &block) }.values
+      end
+
+      private
+
+      def replica_disabled?
+        !@with_replica
+      end
+
+      def master?(node_key)
+        !slave?(node_key)
+      end
+
+      def slave?(node_key)
+        @node_flags[node_key] == ROLE_SLAVE
+      end
+
+      def build_clients(options)
+        clients = options.map do |node_key, option|
+          next if replica_disabled? && slave?(node_key)
+
+          client = Client.new(option)
+          client.call(%i[readonly]) if slave?(node_key)
+          [node_key, client]
+        end
+
+        clients.compact.to_h
+      end
+
+      def try_map
+        errors = {}
+        results = {}
+
+        @clients.each do |node_key, client|
+          begin
+            reply = yield(node_key, client)
+            results[node_key] = reply unless reply.nil?
+          rescue CommandError => err
+            errors[node_key] = err
+            next
+          end
+        end
+
+        return results if errors.empty?
+
+        raise CommandErrorCollection, errors
+      end
+    end
+  end
+end

data/lib/redis/cluster/node_key.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+class Redis
+  class Cluster
+    # Node key's format is `<ip>:<port>`.
+    # It is different from node id.
+    # Node id is internal identifying code in Redis Cluster.
+    module NodeKey
+      DELIMITER = ':'
+
+      module_function
+
+      def optionize(node_key)
+        host, port = split(node_key)
+        { host: host, port: port }
+      end
+
+      def split(node_key)
+        node_key.split(DELIMITER)
+      end
+
+      def build_from_uri(uri)
+        "#{uri.host}#{DELIMITER}#{uri.port}"
+      end
+
+      def build_from_host_port(host, port)
+        "#{host}#{DELIMITER}#{port}"
+      end
+    end
+  end
+end

data/lib/redis/cluster/node_loader.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative '../errors'
+
+class Redis
+  class Cluster
+    # Load and hashify node info for Redis Cluster Client
+    module NodeLoader
+      module_function
+
+      def load_flags(nodes)
+        info = {}
+
+        nodes.each do |node|
+          info = fetch_node_info(node)
+          info.empty? ? next : break
+        end
+
+        return info unless info.empty?
+
+        raise CannotConnectError, 'Redis client could not connect to any cluster nodes'
+      end
+
+      def fetch_node_info(node)
+        node.call(%i[cluster nodes])
+            .split("\n")
+            .map { |str| str.split(' ') }
+            .map { |arr| [arr[1].split('@').first, (arr[2].split(',') & %w[master slave]).first] }
+            .to_h
+      rescue CannotConnectError, ConnectionError, CommandError
+        {} # can retry on another node
+      end
+
+      private_class_method :fetch_node_info
+    end
+  end
+end

data/lib/redis/cluster/option.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require_relative '../errors'
+require_relative 'node_key'
+require 'uri'
+
+class Redis
+  class Cluster
+    # Keep options for Redis Cluster Client
+    class Option
+      DEFAULT_SCHEME = 'redis'
+      SECURE_SCHEME = 'rediss'
+      VALID_SCHEMES = [DEFAULT_SCHEME, SECURE_SCHEME].freeze
+
+      def initialize(options)
+        options = options.dup
+        node_addrs = options.delete(:cluster)
+        @node_opts = build_node_options(node_addrs)
+        @replica = options.delete(:replica) == true
+        add_common_node_option_if_needed(options, @node_opts, :scheme)
+        add_common_node_option_if_needed(options, @node_opts, :username)
+        add_common_node_option_if_needed(options, @node_opts, :password)
+        @options = options
+      end
+
+      def per_node_key
+        @node_opts.map { |opt| [NodeKey.build_from_host_port(opt[:host], opt[:port]), @options.merge(opt)] }
+                  .to_h
+      end
+
+      def use_replica?
+        @replica
+      end
+
+      def update_node(addrs)
+        @node_opts = build_node_options(addrs)
+      end
+
+      def add_node(host, port)
+        @node_opts << { host: host, port: port }
+      end
+
+      private
+
+      def build_node_options(addrs)
+        raise InvalidClientOptionError, 'Redis option of `cluster` must be an Array' unless addrs.is_a?(Array)
+
+        addrs.map { |addr| parse_node_addr(addr) }
+      end
+
+      def parse_node_addr(addr)
+        case addr
+        when String
+          parse_node_url(addr)
+        when Hash
+          parse_node_option(addr)
+        else
+          raise InvalidClientOptionError, 'Redis option of `cluster` must includes String or Hash'
+        end
+      end
+
+      def parse_node_url(addr)
+        uri = URI(addr)
+        raise InvalidClientOptionError, "Invalid uri scheme #{addr}" unless VALID_SCHEMES.include?(uri.scheme)
+
+        db = uri.path.split('/')[1]&.to_i
+
+        { scheme: uri.scheme, username: uri.user, password: uri.password, host: uri.host, port: uri.port, db: db }
+          .reject { |_, v| v.nil? || v == '' }
+      rescue URI::InvalidURIError => err
+        raise InvalidClientOptionError, err.message
+      end
+
+      def parse_node_option(addr)
+        addr = addr.map { |k, v| [k.to_sym, v] }.to_h
+        if addr.values_at(:host, :port).any?(&:nil?)
+          raise InvalidClientOptionError, 'Redis option of `cluster` must includes `:host` and `:port` keys'
+        end
+
+        addr
+      end
+
+      # Redis cluster node returns only host and port information.
+      # So we should complement additional information such as:
+      #   scheme, username, password and so on.
+      def add_common_node_option_if_needed(options, node_opts, key)
+        return options if options[key].nil? && node_opts.first[key].nil?
+
+        options[key] ||= node_opts.first[key]
+      end
+    end
+  end
+end

data/lib/redis/cluster/slot.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+class Redis
+  class Cluster
+    # Keep slot and node key map for Redis Cluster Client
+    class Slot
+      ROLE_SLAVE = 'slave'
+
+      def initialize(available_slots, node_flags = {}, with_replica = false)
+        @with_replica = with_replica
+        @node_flags = node_flags
+        @map = build_slot_node_key_map(available_slots)
+      end
+
+      def exists?(slot)
+        @map.key?(slot)
+      end
+
+      def find_node_key_of_master(slot)
+        return nil unless exists?(slot)
+
+        @map[slot][:master]
+      end
+
+      def find_node_key_of_slave(slot)
+        return nil unless exists?(slot)
+        return find_node_key_of_master(slot) if replica_disabled?
+
+        @map[slot][:slaves].sample
+      end
+
+      def put(slot, node_key)
+        # Since we're sharing a hash for build_slot_node_key_map, duplicate it
+        # if it already exists instead of preserving as-is.
+        @map[slot] = @map[slot] ? @map[slot].dup : { master: nil, slaves: [] }
+
+        if master?(node_key)
+          @map[slot][:master] = node_key
+        elsif !@map[slot][:slaves].include?(node_key)
+          @map[slot][:slaves] << node_key
+        end
+
+        nil
+      end
+
+      private
+
+      def replica_disabled?
+        !@with_replica
+      end
+
+      def master?(node_key)
+        !slave?(node_key)
+      end
+
+      def slave?(node_key)
+        @node_flags[node_key] == ROLE_SLAVE
+      end
+
+      # available_slots is mapping of node_key to list of slot ranges
+      def build_slot_node_key_map(available_slots)
+        by_ranges = {}
+        available_slots.each do |node_key, slots_arr|
+          by_ranges[slots_arr] ||= { master: nil, slaves: [] }
+
+          if master?(node_key)
+            by_ranges[slots_arr][:master] = node_key
+          elsif !by_ranges[slots_arr][:slaves].include?(node_key)
+            by_ranges[slots_arr][:slaves] << node_key
+          end
+        end
+
+        by_slot = {}
+        by_ranges.each do |slots_arr, nodes|
+          slots_arr.each do |slots|
+            slots.each do |slot|
+              by_slot[slot] = nodes
+            end
+          end
+        end
+
+        by_slot
+      end
+    end
+  end
+end

data/lib/redis/cluster/slot_loader.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative '../errors'
+require_relative 'node_key'
+
+class Redis
+  class Cluster
+    # Load and hashify slot info for Redis Cluster Client
+    module SlotLoader
+      module_function
+
+      def load(nodes)
+        info = {}
+
+        nodes.each do |node|
+          info = fetch_slot_info(node)
+          info.empty? ? next : break
+        end
+
+        return info unless info.empty?
+
+        raise CannotConnectError, 'Redis client could not connect to any cluster nodes'
+      end
+
+      def fetch_slot_info(node)
+        hash_with_default_arr = Hash.new { |h, k| h[k] = [] }
+        node.call(%i[cluster slots])
+            .flat_map { |arr| parse_slot_info(arr, default_ip: node.host) }
+            .each_with_object(hash_with_default_arr) { |arr, h| h[arr[0]] << arr[1] }
+      rescue CannotConnectError, ConnectionError, CommandError
+        {} # can retry on another node
+      end
+
+      def parse_slot_info(arr, default_ip:)
+        first_slot, last_slot = arr[0..1]
+        slot_range = (first_slot..last_slot).freeze
+        arr[2..-1].map { |addr| [stringify_node_key(addr, default_ip), slot_range] }
+      end
+
+      def stringify_node_key(arr, default_ip)
+        ip, port = arr
+        ip = default_ip if ip.empty? # When cluster is down
+        NodeKey.build_from_host_port(ip, port)
+      end
+
+      private_class_method :fetch_slot_info, :parse_slot_info, :stringify_node_key
+    end
+  end
+end

data/lib/redis/connection.rb

@@ -1,4 +1,6 @@
-require "redis/connection/registry"
+# frozen_string_literal: true
+
+require_relative "connection/registry"
 
 # If a connection driver was required before this file, the array
 # Redis::Connection.drivers will contain one or more classes. The last driver
@@ -6,4 +8,4 @@ require "redis/connection/registry"
 # the plain Ruby driver as our default. Another driver can be required at a
 # later point in time, causing it to be the last element of the #drivers array
 # and therefore be chosen by default.
-require "redis/connection/ruby" if Redis::Connection.drivers.empty?
+require_relative "connection/ruby" if Redis::Connection.drivers.empty?

data/lib/redis/connection/command_helper.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 class Redis
   module Connection
     module CommandHelper
-
       COMMAND_DELIMITER = "\r\n"
 
       def build_command(args)
@@ -28,16 +29,10 @@ class Redis
         command.join(COMMAND_DELIMITER)
       end
 
-    protected
+      protected
 
-      if defined?(Encoding::default_external)
-        def encode(string)
-          string.force_encoding(Encoding::default_external)
-        end
-      else
-        def encode(string)
-          string
-        end
+      def encode(string)
+        string.force_encoding(Encoding.default_external)
       end
     end
   end