redis 3.3.5 → 4.8.0

data/lib/redis/cluster.rb

@@ -0,0 +1,315 @@
+# frozen_string_literal: true
+
+require_relative 'errors'
+require_relative 'client'
+require_relative 'cluster/command'
+require_relative 'cluster/command_loader'
+require_relative 'cluster/key_slot_converter'
+require_relative 'cluster/node'
+require_relative 'cluster/node_key'
+require_relative 'cluster/node_loader'
+require_relative 'cluster/option'
+require_relative 'cluster/slot'
+require_relative 'cluster/slot_loader'
+
+class Redis
+  # Redis Cluster client
+  #
+  # @see https://github.com/antirez/redis-rb-cluster POC implementation
+  # @see https://redis.io/topics/cluster-spec Redis Cluster specification
+  # @see https://redis.io/topics/cluster-tutorial Redis Cluster tutorial
+  #
+  # Copyright (C) 2013 Salvatore Sanfilippo <antirez@gmail.com>
+  class Cluster
+    def initialize(options = {})
+      @option = Option.new(options)
+      @node, @slot = fetch_cluster_info!(@option)
+      @command = fetch_command_details(@node)
+    end
+
+    def id
+      @node.map(&:id).sort.join(' ')
+    end
+
+    # db feature is disabled in cluster mode
+    def db
+      0
+    end
+
+    # db feature is disabled in cluster mode
+    def db=(_db); end
+
+    def timeout
+      @node.first.timeout
+    end
+
+    def connected?
+      @node.any?(&:connected?)
+    end
+
+    def disconnect
+      @node.each(&:disconnect)
+      true
+    end
+
+    def connection_info
+      @node.sort_by(&:id).map do |client|
+        {
+          host: client.host,
+          port: client.port,
+          db: client.db,
+          id: client.id,
+          location: client.location
+        }
+      end
+    end
+
+    def with_reconnect(val = true, &block)
+      try_send(@node.sample, :with_reconnect, val, &block)
+    end
+
+    def call(command, &block)
+      send_command(command, &block)
+    end
+
+    def call_loop(command, timeout = 0, &block)
+      node = assign_node(command)
+      try_send(node, :call_loop, command, timeout, &block)
+    end
+
+    def 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)
+      node = assign_node(command)
+      try_send(node, :call_with_timeout, command, timeout, &block)
+    end
+
+    def call_without_timeout(command, &block)
+      call_with_timeout(command, 0, &block)
+    end
+
+    def process(commands, &block)
+      if commands.size == 1 &&
+         %w[unsubscribe punsubscribe].include?(commands.first.first.to_s.downcase) &&
+         commands.first.size == 1
+
+        # Node is indeterminate. We do just a best-effort try here.
+        @node.process_all(commands, &block)
+      else
+        node = assign_node(commands.first)
+        try_send(node, :process, commands, &block)
+      end
+    end
+
+    private
+
+    def fetch_cluster_info!(option)
+      node = Node.new(option.per_node_key)
+      available_slots = SlotLoader.load(node)
+      node_flags = NodeLoader.load_flags(node)
+      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&.each(&:disconnect)
+    end
+
+    def fetch_command_details(nodes)
+      details = CommandLoader.load(nodes)
+      Command.new(details)
+    end
+
+    def send_command(command, &block)
+      cmd = command.first.to_s.downcase
+      case cmd
+      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)
+      when 'client'   then send_client_command(command, &block)
+      when 'cluster'  then send_cluster_command(command, &block)
+      when 'readonly', 'readwrite', 'shutdown'
+        raise OrchestrationCommandNotSupported, cmd
+      when 'memory'   then send_memory_command(command, &block)
+      when 'script'   then send_script_command(command, &block)
+      when 'pubsub'   then send_pubsub_command(command, &block)
+      when 'discard', 'exec', 'multi', 'unwatch'
+        raise AmbiguousNodeError, cmd
+      else
+        node = assign_node(command)
+        try_send(node, :call, command, &block)
+      end
+    end
+
+    def send_config_command(command, &block)
+      case command[1].to_s.downcase
+      when 'resetstat', 'rewrite', 'set'
+        @node.call_all(command, &block).first
+      else assign_node(command).call(command, &block)
+      end
+    end
+
+    def send_memory_command(command, &block)
+      case command[1].to_s.downcase
+      when 'stats' then @node.call_all(command, &block)
+      when 'purge' then @node.call_all(command, &block).first
+      else assign_node(command).call(command, &block)
+      end
+    end
+
+    def send_client_command(command, &block)
+      case command[1].to_s.downcase
+      when 'list' then @node.call_all(command, &block).flatten
+      when 'pause', 'reply', 'setname'
+        @node.call_all(command, &block).first
+      else assign_node(command).call(command, &block)
+      end
+    end
+
+    def send_cluster_command(command, &block)
+      subcommand = command[1].to_s.downcase
+      case subcommand
+      when 'addslots', 'delslots', 'failover', 'forget', 'meet', 'replicate',
+           'reset', 'set-config-epoch', 'setslot'
+        raise OrchestrationCommandNotSupported, 'cluster', subcommand
+      when 'saveconfig' then @node.call_all(command, &block).first
+      else assign_node(command).call(command, &block)
+      end
+    end
+
+    def send_script_command(command, &block)
+      case command[1].to_s.downcase
+      when 'debug', 'kill'
+        @node.call_all(command, &block).first
+      when 'flush', 'load'
+        @node.call_master(command, &block).first
+      else assign_node(command).call(command, &block)
+      end
+    end
+
+    def send_pubsub_command(command, &block)
+      case command[1].to_s.downcase
+      when 'channels' then @node.call_all(command, &block).flatten.uniq.sort
+      when 'numsub'
+        @node.call_all(command, &block).reject(&:empty?).map { |e| Hash[*e] }
+             .reduce({}) { |a, e| a.merge(e) { |_, v1, v2| v1 + v2 } }
+      when 'numpat' then @node.call_all(command, &block).reduce(:+)
+      else assign_node(command).call(command, &block)
+      end
+    end
+
+    # @see https://redis.io/topics/cluster-spec#redirection-and-resharding
+    #   Redirection and resharding
+    def try_send(node, method_name, *args, retry_count: 3, &block)
+      node.public_send(method_name, *args, &block)
+    rescue CommandError => err
+      if err.message.start_with?('MOVED')
+        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
+        retry
+      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)
+      _, slot, node_key = err_msg.split(' ')
+      slot = slot.to_i
+      @slot.put(slot, node_key)
+      find_node(node_key)
+    end
+
+    def assign_asking_node(err_msg)
+      _, _, node_key = err_msg.split(' ')
+      find_node(node_key)
+    end
+
+    def assign_node(command)
+      node_key = find_node_key(command)
+      find_node(node_key)
+    end
+
+    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) || primary_only
+        @slot.find_node_key_of_master(slot)
+      else
+        @slot.find_node_key_of_slave(slot)
+      end
+    end
+
+    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)
+      @node.find_by(node_key)
+    end
+
+    def update_cluster_info!(node_key = nil)
+      unless node_key.nil?
+        host, port = NodeKey.split(node_key)
+        @option.add_node(host, port)
+      end
+
+      @node.map(&:disconnect)
+      @node, @slot = fetch_cluster_info!(@option)
+    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