redis 4.1.0 → 4.6.0

data/lib/redis/cluster/option.rb

@@ -15,36 +15,36 @@ class Redis
       def initialize(options)
         options = options.dup
         node_addrs = options.delete(:cluster)
-        @node_uris = build_node_uris(node_addrs)
+        @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_uris.map { |uri| [NodeKey.build_from_uri(uri), @options.merge(url: uri.to_s)] }
+        @node_opts.map { |opt| [NodeKey.build_from_host_port(opt[:host], opt[:port]), @options.merge(opt)] }
                   .to_h
       end
 
-      def secure?
-        @node_uris.any? { |uri| uri.scheme == SECURE_SCHEME } || @options[:ssl_params] || false
-      end
-
       def use_replica?
         @replica
       end
 
       def update_node(addrs)
-        @node_uris = build_node_uris(addrs)
+        @node_opts = build_node_options(addrs)
       end
 
       def add_node(host, port)
-        @node_uris << parse_node_hash(host: host, port: port)
+        @node_opts << { host: host, port: port }
       end
 
       private
 
-      def build_node_uris(addrs)
+      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
 
@@ -53,7 +53,7 @@ class Redis
         when String
           parse_node_url(addr)
         when Hash
-          parse_node_hash(addr)
+          parse_node_option(addr)
         else
           raise InvalidClientOptionError, 'Redis option of `cluster` must includes String or Hash'
         end
@@ -62,15 +62,31 @@ class Redis
       def parse_node_url(addr)
         uri = URI(addr)
         raise InvalidClientOptionError, "Invalid uri scheme #{addr}" unless VALID_SCHEMES.include?(uri.scheme)
-        uri
+
+        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_hash(addr)
+      def parse_node_option(addr)
         addr = addr.map { |k, v| [k.to_sym, v] }.to_h
-        raise InvalidClientOptionError, 'Redis option of `cluster` must includes `:host` and `:port` keys' if addr.values_at(:host, :port).any?(&:nil?)
-        URI::Generic.build(scheme: DEFAULT_SCHEME, host: addr[:host], port: addr[:port].to_i)
+        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

data/lib/redis/cluster/slot.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'set'
-
 class Redis
   class Cluster
     # Keep slot and node key map for Redis Cluster Client
@@ -28,11 +26,20 @@ class Redis
         return nil unless exists?(slot)
         return find_node_key_of_master(slot) if replica_disabled?
 
-        @map[slot][:slaves].to_a.sample
+        @map[slot][:slaves].sample
       end
 
       def put(slot, node_key)
-        assign_node_key(@map, 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
 
@@ -50,19 +57,29 @@ class Redis
         @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)
-        available_slots.each_with_object({}) do |(node_key, slots), acc|
-          slots.each { |slot| assign_node_key(acc, slot, node_key) }
+        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
-      end
 
-      def assign_node_key(mappings, slot, node_key)
-        mappings[slot] ||= { master: nil, slaves: Set.new }
-        if master?(node_key)
-          mappings[slot][:master] = node_key
-        else
-          mappings[slot][:slaves].add(node_key)
+        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

data/lib/redis/cluster/slot_loader.rb

@@ -13,7 +13,7 @@ class Redis
         info = {}
 
         nodes.each do |node|
-          info = Hash[*fetch_slot_info(node)]
+          info = fetch_slot_info(node)
           info.empty? ? next : break
         end
 
@@ -23,9 +23,10 @@ class Redis
       end
 
       def fetch_slot_info(node)
+        hash_with_default_arr = Hash.new { |h, k| h[k] = [] }
         node.call(%i[cluster slots])
-            .map { |arr| parse_slot_info(arr, default_ip: node.host) }
-            .flatten
+            .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
@@ -34,7 +35,6 @@ class Redis
         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] }
-                  .flatten
       end
 
       def stringify_node_key(arr, default_ip)

data/lib/redis/cluster.rb

@@ -78,10 +78,13 @@ class Redis
     end
 
     def call_pipeline(pipeline)
-      node_keys, command_keys = extract_keys_in_pipeline(pipeline)
-      raise CrossSlotPipeliningError, command_keys if node_keys.size > 1
-      node = find_node(node_keys.first)
-      try_send(node, :call_pipeline, pipeline)
+      node_keys = pipeline.commands.map { |cmd| find_node_key(cmd, primary_only: true) }.compact.uniq
+      if node_keys.size > 1
+        raise(CrossSlotPipeliningError,
+              pipeline.commands.map { |cmd| @command.extract_first_key(cmd) }.reject(&:empty?).uniq)
+      end
+
+      try_send(find_node(node_keys.first), :call_pipeline, pipeline)
     end
 
     def call_with_timeout(command, timeout, &block)
@@ -112,12 +115,11 @@ class Redis
       node = Node.new(option.per_node_key)
       available_slots = SlotLoader.load(node)
       node_flags = NodeLoader.load_flags(node)
-      available_node_urls = NodeKey.to_node_urls(available_slots.keys, secure: option.secure?)
-      option.update_node(available_node_urls)
+      option.update_node(available_slots.keys.map { |k| NodeKey.optionize(k) })
       [Node.new(option.per_node_key, node_flags, option.use_replica?),
        Slot.new(available_slots, node_flags, option.use_replica?)]
     ensure
-      node.map(&:disconnect)
+      node&.each(&:disconnect)
     end
 
     def fetch_command_details(nodes)
@@ -128,13 +130,14 @@ class Redis
     def send_command(command, &block)
       cmd = command.first.to_s.downcase
       case cmd
-      when 'auth', 'bgrewriteaof', 'bgsave', 'quit', 'save'
+      when 'acl', 'auth', 'bgrewriteaof', 'bgsave', 'quit', 'save'
         @node.call_all(command, &block).first
       when 'flushall', 'flushdb'
         @node.call_master(command, &block).first
       when 'wait'     then @node.call_master(command, &block).reduce(:+)
       when 'keys'     then @node.call_slave(command, &block).flatten.sort
       when 'dbsize'   then @node.call_slave(command, &block).reduce(:+)
+      when 'scan'     then _scan(command, &block)
       when 'lastsave' then @node.call_all(command, &block).sort
       when 'role'     then @node.call_all(command, &block)
       when 'config'   then send_config_command(command, &block)
@@ -216,9 +219,14 @@ class Redis
       node.public_send(method_name, *args, &block)
     rescue CommandError => err
       if err.message.start_with?('MOVED')
-        assign_redirection_node(err.message).public_send(method_name, *args, &block)
+        raise if retry_count <= 0
+
+        node = assign_redirection_node(err.message)
+        retry_count -= 1
+        retry
       elsif err.message.start_with?('ASK')
         raise if retry_count <= 0
+
         node = assign_asking_node(err.message)
         node.call(%i[asking])
         retry_count -= 1
@@ -226,6 +234,32 @@ class Redis
       else
         raise
       end
+    rescue CannotConnectError
+      update_cluster_info!
+      raise
+    end
+
+    def _scan(command, &block)
+      input_cursor = Integer(command[1])
+
+      client_index = input_cursor % 256
+      raw_cursor = input_cursor >> 8
+
+      clients = @node.scale_reading_clients
+
+      client = clients[client_index]
+      return ['0', []] unless client
+
+      command[1] = raw_cursor.to_s
+
+      result_cursor, result_keys = client.call(command, &block)
+      result_cursor = Integer(result_cursor)
+
+      if result_cursor == 0
+        client_index += 1
+      end
+
+      [((result_cursor << 8) + client_index).to_s, result_keys]
     end
 
     def assign_redirection_node(err_msg)
@@ -245,14 +279,14 @@ class Redis
       find_node(node_key)
     end
 
-    def find_node_key(command)
+    def find_node_key(command, primary_only: false)
       key = @command.extract_first_key(command)
       return if key.empty?
 
       slot = KeySlotConverter.convert(key)
       return unless @slot.exists?(slot)
 
-      if @command.should_send_to_master?(command)
+      if @command.should_send_to_master?(command) || primary_only
         @slot.find_node_key_of_master(slot)
       else
         @slot.find_node_key_of_slave(slot)
@@ -261,6 +295,7 @@ class Redis
 
     def find_node(node_key)
       return @node.sample if node_key.nil?
+
       @node.find_by(node_key)
     rescue Node::ReloadNeeded
       update_cluster_info!(node_key)
@@ -276,11 +311,5 @@ class Redis
       @node.map(&:disconnect)
       @node, @slot = fetch_cluster_info!(@option)
     end
-
-    def extract_keys_in_pipeline(pipeline)
-      node_keys = pipeline.commands.map { |cmd| find_node_key(cmd) }.compact.uniq
-      command_keys = pipeline.commands.map { |cmd| @command.extract_first_key(cmd) }.reject(&:empty?)
-      [node_keys, command_keys]
-    end
   end
 end

data/lib/redis/commands/bitmaps.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+class Redis
+  module Commands
+    module Bitmaps
+      # Sets or clears the bit at offset in the string value stored at key.
+      #
+      # @param [String] key
+      # @param [Integer] offset bit offset
+      # @param [Integer] value bit value `0` or `1`
+      # @return [Integer] the original bit value stored at `offset`
+      def setbit(key, offset, value)
+        send_command([:setbit, key, offset, value])
+      end
+
+      # Returns the bit value at offset in the string value stored at key.
+      #
+      # @param [String] key
+      # @param [Integer] offset bit offset
+      # @return [Integer] `0` or `1`
+      def getbit(key, offset)
+        send_command([:getbit, key, offset])
+      end
+
+      # Count the number of set bits in a range of the string value stored at key.
+      #
+      # @param [String] key
+      # @param [Integer] start start index
+      # @param [Integer] stop stop index
+      # @return [Integer] the number of bits set to 1
+      def bitcount(key, start = 0, stop = -1)
+        send_command([:bitcount, key, start, stop])
+      end
+
+      # Perform a bitwise operation between strings and store the resulting string in a key.
+      #
+      # @param [String] operation e.g. `and`, `or`, `xor`, `not`
+      # @param [String] destkey destination key
+      # @param [String, Array<String>] keys one or more source keys to perform `operation`
+      # @return [Integer] the length of the string stored in `destkey`
+      def bitop(operation, destkey, *keys)
+        send_command([:bitop, operation, destkey, *keys])
+      end
+
+      # Return the position of the first bit set to 1 or 0 in a string.
+      #
+      # @param [String] key
+      # @param [Integer] bit whether to look for the first 1 or 0 bit
+      # @param [Integer] start start index
+      # @param [Integer] stop stop index
+      # @return [Integer] the position of the first 1/0 bit.
+      #                  -1 if looking for 1 and it is not found or start and stop are given.
+      def bitpos(key, bit, start = nil, stop = nil)
+        raise(ArgumentError, 'stop parameter specified without start parameter') if stop && !start
+
+        command = [:bitpos, key, bit]
+        command << start if start
+        command << stop if stop
+        send_command(command)
+      end
+    end
+  end
+end

data/lib/redis/commands/cluster.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+class Redis
+  module Commands
+    module Cluster
+      # Sends `CLUSTER *` command to random node and returns its reply.
+      #
+      # @see https://redis.io/commands#cluster Reference of cluster command
+      #
+      # @param subcommand [String, Symbol] the subcommand of cluster command
+      #   e.g. `:slots`, `:nodes`, `:slaves`, `:info`
+      #
+      # @return [Object] depends on the subcommand
+      def cluster(subcommand, *args)
+        subcommand = subcommand.to_s.downcase
+        block = case subcommand
+        when 'slots'
+          HashifyClusterSlots
+        when 'nodes'
+          HashifyClusterNodes
+        when 'slaves'
+          HashifyClusterSlaves
+        when 'info'
+          HashifyInfo
+        else
+          Noop
+        end
+
+        # @see https://github.com/antirez/redis/blob/unstable/src/redis-trib.rb#L127 raw reply expected
+        block = Noop unless @cluster_mode
+
+        send_command([:cluster, subcommand] + args, &block)
+      end
+
+      # Sends `ASKING` command to random node and returns its reply.
+      #
+      # @see https://redis.io/topics/cluster-spec#ask-redirection ASK redirection
+      #
+      # @return [String] `'OK'`
+      def asking
+        send_command(%i[asking])
+      end
+    end
+  end
+end

data/lib/redis/commands/connection.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+class Redis
+  module Commands
+    module Connection
+      # Authenticate to the server.
+      #
+      # @param [Array<String>] args includes both username and password
+      #   or only password
+      # @return [String] `OK`
+      # @see https://redis.io/commands/auth AUTH command
+      def auth(*args)
+        send_command([:auth, *args])
+      end
+
+      # Ping the server.
+      #
+      # @param [optional, String] message
+      # @return [String] `PONG`
+      def ping(message = nil)
+        send_command([:ping, message].compact)
+      end
+
+      # Echo the given string.
+      #
+      # @param [String] value
+      # @return [String]
+      def echo(value)
+        send_command([:echo, value])
+      end
+
+      # Change the selected database for the current connection.
+      #
+      # @param [Integer] db zero-based index of the DB to use (0 to 15)
+      # @return [String] `OK`
+      def select(db)
+        synchronize do |client|
+          client.db = db
+          client.call([:select, db])
+        end
+      end
+
+      # Close the connection.
+      #
+      # @return [String] `OK`
+      def quit
+        synchronize do |client|
+          begin
+            client.call([:quit])
+          rescue ConnectionError
+          ensure
+            client.disconnect
+          end
+        end
+      end
+    end
+  end
+end

data/lib/redis/commands/geo.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+class Redis
+  module Commands
+    module Geo
+      # Adds the specified geospatial items (latitude, longitude, name) to the specified key
+      #
+      # @param [String] key
+      # @param [Array] member arguemnts for member or members: longitude, latitude, name
+      # @return [Integer] number of elements added to the sorted set
+      def geoadd(key, *member)
+        send_command([:geoadd, key, *member])
+      end
+
+      # Returns geohash string representing position for specified members of the specified key.
+      #
+      # @param [String] key
+      # @param [String, Array<String>] member one member or array of members
+      # @return [Array<String, nil>] returns array containg geohash string if member is present, nil otherwise
+      def geohash(key, member)
+        send_command([:geohash, key, member])
+      end
+
+      # Query a sorted set representing a geospatial index to fetch members matching a
+      # given maximum distance from a point
+      #
+      # @param [Array] args key, longitude, latitude, radius, unit(m|km|ft|mi)
+      # @param ['asc', 'desc'] sort sort returned items from the nearest to the farthest
+      #   or the farthest to the nearest relative to the center
+      # @param [Integer] count limit the results to the first N matching items
+      # @param ['WITHDIST', 'WITHCOORD', 'WITHHASH'] options to return additional information
+      # @return [Array<String>] may be changed with `options`
+      def georadius(*args, **geoptions)
+        geoarguments = _geoarguments(*args, **geoptions)
+
+        send_command([:georadius, *geoarguments])
+      end
+
+      # Query a sorted set representing a geospatial index to fetch members matching a
+      # given maximum distance from an already existing member
+      #
+      # @param [Array] args key, member, radius, unit(m|km|ft|mi)
+      # @param ['asc', 'desc'] sort sort returned items from the nearest to the farthest or the farthest
+      #   to the nearest relative to the center
+      # @param [Integer] count limit the results to the first N matching items
+      # @param ['WITHDIST', 'WITHCOORD', 'WITHHASH'] options to return additional information
+      # @return [Array<String>] may be changed with `options`
+      def georadiusbymember(*args, **geoptions)
+        geoarguments = _geoarguments(*args, **geoptions)
+
+        send_command([:georadiusbymember, *geoarguments])
+      end
+
+      # Returns longitude and latitude of members of a geospatial index
+      #
+      # @param [String] key
+      # @param [String, Array<String>] member one member or array of members
+      # @return [Array<Array<String>, nil>] returns array of elements, where each
+      #   element is either array of longitude and latitude or nil
+      def geopos(key, member)
+        send_command([:geopos, key, member])
+      end
+
+      # Returns the distance between two members of a geospatial index
+      #
+      # @param [String ]key
+      # @param [Array<String>] members
+      # @param ['m', 'km', 'mi', 'ft'] unit
+      # @return [String, nil] returns distance in spefied unit if both members present, nil otherwise.
+      def geodist(key, member1, member2, unit = 'm')
+        send_command([:geodist, key, member1, member2, unit])
+      end
+
+      private
+
+      def _geoarguments(*args, options: nil, sort: nil, count: nil)
+        args.push sort if sort
+        args.push 'count', count if count
+        args.push options if options
+        args
+      end
+    end
+  end
+end