redis-client 0.1.0

data/lib/redis_client.rb

@@ -0,0 +1,438 @@
+# frozen_string_literal: true
+
+require "redis_client/version"
+require "redis_client/config"
+require "redis_client/sentinel_config"
+require "redis_client/connection"
+
+class RedisClient
+  Error = Class.new(StandardError)
+
+  ConnectionError = Class.new(Error)
+
+  FailoverError = Class.new(ConnectionError)
+
+  TimeoutError = Class.new(ConnectionError)
+  ReadTimeoutError = Class.new(TimeoutError)
+  WriteTimeoutError = Class.new(TimeoutError)
+  ConnectTimeoutError = Class.new(TimeoutError)
+  CheckoutTimeoutError = Class.new(ConnectTimeoutError)
+
+  class CommandError < Error
+    class << self
+      def parse(error_message)
+        code = error_message.split(' ', 2).first
+        klass = ERRORS.fetch(code, self)
+        klass.new(error_message)
+      end
+    end
+  end
+
+  AuthenticationError = Class.new(CommandError)
+  PermissionError = Class.new(CommandError)
+
+  CommandError::ERRORS = {
+    "WRONGPASS" => AuthenticationError,
+    "NOPERM" => PermissionError,
+  }.freeze
+
+  class << self
+    def config(**kwargs)
+      Config.new(**kwargs)
+    end
+
+    def sentinel(**kwargs)
+      SentinelConfig.new(**kwargs)
+    end
+
+    def new(arg = nil, **kwargs)
+      if arg.is_a?(Config::Common)
+        super
+      else
+        super(config(**(arg || {}), **kwargs))
+      end
+    end
+  end
+
+  attr_reader :config, :id
+  attr_accessor :connect_timeout, :read_timeout, :write_timeout
+
+  def initialize(
+    config,
+    id: config.id,
+    connect_timeout: config.connect_timeout,
+    read_timeout: config.read_timeout,
+    write_timeout: config.write_timeout
+  )
+    @config = config
+    @id = id
+    @connect_timeout = connect_timeout
+    @read_timeout = read_timeout
+    @write_timeout = write_timeout
+    @raw_connection = nil
+    @disable_reconnection = false
+  end
+
+  def size
+    1
+  end
+
+  def with(_options = nil)
+    yield self
+  end
+  alias_method :then, :with
+
+  def timeout=(timeout)
+    @connect_timeout = @read_timeout = @write_timeout = timeout
+  end
+
+  def pubsub
+    sub = PubSub.new(ensure_connected)
+    @raw_connection = nil
+    sub
+  end
+
+  def call(*command)
+    command = RESP3.coerce_command!(command)
+    result = ensure_connected do |connection|
+      connection.write(command)
+      connection.read
+    end
+
+    if result.is_a?(CommandError)
+      raise result
+    else
+      result
+    end
+  end
+
+  def call_once(*command)
+    command = RESP3.coerce_command!(command)
+    result = ensure_connected(retryable: false) do |connection|
+      connection.write(command)
+      connection.read
+    end
+
+    if result.is_a?(CommandError)
+      raise result
+    else
+      result
+    end
+  end
+
+  def blocking_call(timeout, *command)
+    command = RESP3.coerce_command!(command)
+    result = ensure_connected do |connection|
+      connection.write(command)
+      connection.read(timeout)
+    end
+
+    if result.is_a?(CommandError)
+      raise result
+    else
+      result
+    end
+  end
+
+  def scan(*args, &block)
+    unless block_given?
+      return to_enum(__callee__, *args)
+    end
+
+    scan_list(1, ["SCAN", 0, *args], &block)
+  end
+
+  def sscan(key, *args, &block)
+    unless block_given?
+      return to_enum(__callee__, key, *args)
+    end
+
+    scan_list(2, ["SSCAN", key, 0, *args], &block)
+  end
+
+  def hscan(key, *args, &block)
+    unless block_given?
+      return to_enum(__callee__, key, *args)
+    end
+
+    scan_pairs(2, ["HSCAN", key, 0, *args], &block)
+  end
+
+  def zscan(key, *args, &block)
+    unless block_given?
+      return to_enum(__callee__, key, *args)
+    end
+
+    scan_pairs(2, ["ZSCAN", key, 0, *args], &block)
+  end
+
+  def connected?
+    @raw_connection&.connected?
+  end
+
+  def close
+    @raw_connection&.close
+    @raw_connection = nil
+    self
+  end
+
+  def pipelined
+    pipeline = Pipeline.new
+    yield pipeline
+
+    if pipeline._size == 0
+      []
+    else
+      ensure_connected(retryable: pipeline._retryable?) do |connection|
+        call_pipelined(connection, pipeline._commands, pipeline._timeouts)
+      end
+    end
+  end
+
+  def multi(watch: nil, &block)
+    if watch
+      # WATCH is stateful, so we can't reconnect if it's used, the whole transaction
+      # has to be redone.
+      ensure_connected(retryable: false) do |connection|
+        call("WATCH", *watch)
+        begin
+          if transaction = build_transaction(&block)
+            call_pipelined(connection, transaction._commands).last
+          else
+            call("UNWATCH")
+            []
+          end
+        rescue
+          call("UNWATCH") if connected? && watch
+          raise
+        end
+      end
+    else
+      transaction = build_transaction(&block)
+      if transaction._empty?
+        []
+      else
+        ensure_connected(retryable: transaction._retryable?) do |connection|
+          call_pipelined(connection, transaction._commands).last
+        end
+      end
+    end
+  end
+
+  class PubSub
+    def initialize(raw_connection)
+      @raw_connection = raw_connection
+    end
+
+    def call(*command)
+      raw_connection.write(RESP3.coerce_command!(command))
+      nil
+    end
+
+    def close
+      raw_connection&.close
+      @raw_connection = nil
+      self
+    end
+
+    def next_event(timeout = nil)
+      unless raw_connection
+        raise ConnectionError, "Connection was closed or lost"
+      end
+
+      raw_connection.read(timeout)
+    rescue ReadTimeoutError
+      nil
+    end
+
+    private
+
+    attr_reader :raw_connection
+  end
+
+  class Multi
+    def initialize
+      @size = 0
+      @commands = []
+      @retryable = true
+    end
+
+    def call(*command)
+      @commands << RESP3.coerce_command!(command)
+      nil
+    end
+
+    def call_once(*command)
+      @retryable = false
+      @commands << RESP3.coerce_command!(command)
+      nil
+    end
+
+    def _commands
+      @commands
+    end
+
+    def _size
+      @commands.size
+    end
+
+    def _empty?
+      @commands.size <= 2
+    end
+
+    def _timeouts
+      nil
+    end
+
+    def _retryable?
+      @retryable
+    end
+  end
+
+  class Pipeline < Multi
+    def initialize
+      super
+      @timeouts = nil
+    end
+
+    def blocking_call(timeout, *command)
+      @timeouts ||= []
+      @timeouts[@commands.size] = timeout
+      @commands << RESP3.coerce_command!(command)
+      nil
+    end
+
+    def _timeouts
+      @timeouts
+    end
+
+    def _empty?
+      @commands.empty?
+    end
+  end
+
+  private
+
+  def build_transaction
+    transaction = Multi.new
+    transaction.call("MULTI")
+    yield transaction
+    transaction.call("EXEC")
+    transaction
+  end
+
+  def scan_list(cursor_index, command, &block)
+    cursor = 0
+    while cursor != "0"
+      command[cursor_index] = cursor
+      cursor, elements = call(*command)
+      elements.each(&block)
+    end
+    nil
+  end
+
+  def scan_pairs(cursor_index, command)
+    cursor = 0
+    while cursor != "0"
+      command[cursor_index] = cursor
+      cursor, elements = call(*command)
+
+      index = 0
+      size = elements.size
+      while index < size
+        yield elements[index], elements[index + 1]
+        index += 2
+      end
+    end
+    nil
+  end
+
+  def call_pipelined(connection, commands, timeouts = nil)
+    exception = nil
+
+    size = commands.size
+    results = Array.new(commands.size)
+    connection.write_multi(commands)
+
+    size.times do |index|
+      timeout = timeouts && timeouts[index]
+      result = connection.read(timeout)
+      if result.is_a?(CommandError)
+        exception ||= result
+      end
+      results[index] = result
+    end
+
+    if exception
+      raise exception
+    else
+      results
+    end
+  end
+
+  def ensure_connected(retryable: true)
+    if @disable_reconnection
+      yield @raw_connection
+    elsif retryable
+      tries = 0
+      connection = nil
+      begin
+        connection = raw_connection
+        if block_given?
+          yield connection
+        else
+          connection
+        end
+      rescue ConnectionError => error
+        connection&.close
+        close
+
+        if !@disable_reconnection && config.retry_connecting?(tries, error)
+          tries += 1
+          retry
+        else
+          raise
+        end
+      end
+    else
+      previous_disable_reconnection = @disable_reconnection
+      connection = ensure_connected
+      begin
+        @disable_reconnection = true
+        yield connection
+      ensure
+        @disable_reconnection = previous_disable_reconnection
+      end
+    end
+  end
+
+  def raw_connection
+    @raw_connection ||= begin
+      connection = config.driver.new(
+        config,
+        connect_timeout: connect_timeout,
+        read_timeout: read_timeout,
+        write_timeout: write_timeout,
+      )
+
+      prelude = config.connection_prelude.dup
+
+      if id
+        prelude << ["CLIENT", "SETNAME", id.to_s]
+      end
+
+      if config.sentinel?
+        prelude << ["ROLE"]
+        role, = call_pipelined(connection, prelude).last
+        config.check_role!(role)
+      else
+        call_pipelined(connection, prelude)
+      end
+
+      connection
+    end
+  end
+end
+
+require "redis_client/resp3"
+require "redis_client/pooled"

data/redis-client.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/redis_client/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "redis-client"
+  spec.version = RedisClient::VERSION
+  spec.authors = ["Jean Boussier"]
+  spec.email = ["jean.boussier@gmail.com"]
+
+  spec.summary = "Simple low-level client for Redis 6+"
+  spec.homepage = "https://github.com/redis-rb/redis-client"
+  spec.required_ruby_version = ">= 2.5.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = File.join(spec.homepage, "blob/master/CHANGELOG.md")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features|benchmark)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.extensions = ["ext/redis_client/hiredis/extconf.rb"]
+
+  spec.add_runtime_dependency "connection_pool"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: redis-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jean Boussier
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- jean.boussier@gmail.com
+executables: []
+extensions:
+- ext/redis_client/hiredis/extconf.rb
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- ext/redis_client/hiredis/extconf.rb
+- ext/redis_client/hiredis/hiredis_connection.c
+- ext/redis_client/hiredis/vendor/.gitignore
+- ext/redis_client/hiredis/vendor/.travis.yml
+- ext/redis_client/hiredis/vendor/CHANGELOG.md
+- ext/redis_client/hiredis/vendor/CMakeLists.txt
+- ext/redis_client/hiredis/vendor/COPYING
+- ext/redis_client/hiredis/vendor/Makefile
+- ext/redis_client/hiredis/vendor/README.md
+- ext/redis_client/hiredis/vendor/adapters/ae.h
+- ext/redis_client/hiredis/vendor/adapters/glib.h
+- ext/redis_client/hiredis/vendor/adapters/ivykis.h
+- ext/redis_client/hiredis/vendor/adapters/libev.h
+- ext/redis_client/hiredis/vendor/adapters/libevent.h
+- ext/redis_client/hiredis/vendor/adapters/libuv.h
+- ext/redis_client/hiredis/vendor/adapters/macosx.h
+- ext/redis_client/hiredis/vendor/adapters/qt.h
+- ext/redis_client/hiredis/vendor/alloc.c
+- ext/redis_client/hiredis/vendor/alloc.h
+- ext/redis_client/hiredis/vendor/appveyor.yml
+- ext/redis_client/hiredis/vendor/async.c
+- ext/redis_client/hiredis/vendor/async.h
+- ext/redis_client/hiredis/vendor/async_private.h
+- ext/redis_client/hiredis/vendor/dict.c
+- ext/redis_client/hiredis/vendor/dict.h
+- ext/redis_client/hiredis/vendor/fmacros.h
+- ext/redis_client/hiredis/vendor/hiredis-config.cmake.in
+- ext/redis_client/hiredis/vendor/hiredis.c
+- ext/redis_client/hiredis/vendor/hiredis.h
+- ext/redis_client/hiredis/vendor/hiredis.pc.in
+- ext/redis_client/hiredis/vendor/hiredis_ssl-config.cmake.in
+- ext/redis_client/hiredis/vendor/hiredis_ssl.h
+- ext/redis_client/hiredis/vendor/hiredis_ssl.pc.in
+- ext/redis_client/hiredis/vendor/net.c
+- ext/redis_client/hiredis/vendor/net.h
+- ext/redis_client/hiredis/vendor/read.c
+- ext/redis_client/hiredis/vendor/read.h
+- ext/redis_client/hiredis/vendor/sds.c
+- ext/redis_client/hiredis/vendor/sds.h
+- ext/redis_client/hiredis/vendor/sdsalloc.h
+- ext/redis_client/hiredis/vendor/sockcompat.c
+- ext/redis_client/hiredis/vendor/sockcompat.h
+- ext/redis_client/hiredis/vendor/ssl.c
+- ext/redis_client/hiredis/vendor/test.c
+- ext/redis_client/hiredis/vendor/test.sh
+- ext/redis_client/hiredis/vendor/win32.h
+- lib/redis-client.rb
+- lib/redis_client.rb
+- lib/redis_client/buffered_io.rb
+- lib/redis_client/config.rb
+- lib/redis_client/connection.rb
+- lib/redis_client/hiredis_connection.rb
+- lib/redis_client/pooled.rb
+- lib/redis_client/resp3.rb
+- lib/redis_client/sentinel_config.rb
+- lib/redis_client/version.rb
+- redis-client.gemspec
+homepage: https://github.com/redis-rb/redis-client
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/redis-rb/redis-client
+  source_code_uri: https://github.com/redis-rb/redis-client
+  changelog_uri: https://github.com/redis-rb/redis-client/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Simple low-level client for Redis 6+
+test_files: []