solid-redis 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c1a91886e9988d667a965cce4d26a331c87e020857e11e155c50b1d2f0f9974
-  data.tar.gz: ff0d3277cf6011e225c12953f9a5a8d0eb016070e10e399fc5b158f59730ed37
+  metadata.gz: e1a92b96853d5d381ae812b7440c9b50a718f9b67fc678e0cbee1d0c8014fc16
+  data.tar.gz: 679a2723c695c95b68f95432006fe93e111c2318106b0384e7a409eca475b480
 SHA512:
-  metadata.gz: de7efbf6005150a5c6986de65bbb3e4d2afbbda154c69d8a6ff60b43dc917c26ee0b4a2eb078f432c563e46a95507b646220aba4c699fbf37ebfb46bf0a34c94
-  data.tar.gz: 1b9f37eebe965da58f9ad0c097ed9020423cf8518a1690830478497fb550052a0e0ccb1bf583e2f06a02e608954c518d61df17ac6b8dbdfa907492a07a75563e
+  metadata.gz: 2ea6594459de7d81b8e8fbe1f0f323a397a6c99ff145489ecba44e0ff6ecb8c2409236283a0d21add112033377ceaab4ce787e7021afbfd6c79d18ffc1991f92
+  data.tar.gz: 4ddc0772aeb012163fced9a0bdca65c8da9d21019e82f25b36254fe2c0c3b32312052de47e707b1bcdf64fc35663363db4775155dcc4143ba9c44db93cdc6d48

data/CHANGELOG.md

@@ -0,0 +1,101 @@
+# Changelog
+
+All notable changes to this project are documented in this file. The format
+follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the
+project adheres to [Semantic Versioning](https://semver.org/).
+
+## [1.0.3] - 2026-09-27
+
+### Fixed
+
+- Consume complete RESP arrays, maps, sets, pushes, and attributes before
+  raising nested Redis errors, preventing connection desynchronization.
+- Handle `:wait_writable` during non-blocking reads and discard connections
+  after protocol errors without replaying commands.
+- Retry `TRYAGAIN` and `CLUSTERDOWN` pipeline replies consistently with direct
+  Cluster calls, and clear `ASKING` state before refreshing the topology.
+- Route `MEMORY USAGE` to the node owning its key.
+- Preserve an explicitly configured `db` when a Redis URL is also provided.
+
+### Changed
+
+- Clarify that Cluster commands are grouped into per-node pipelines rather
+  than sent concurrently.
+
+## [1.0.2] - 2026-09-27
+
+### Added
+
+- `CHANGELOG.md` and `changelog_uri` gem metadata.
+
+### Changed
+
+- README: describe the test suite's fake server and how to check against a
+  real Redis or local cluster.
+
+## [1.0.1] - 2026-09-27
+
+### Changed
+
+- README: document the Cluster architecture (`ClusterConfig`/`ClusterState`).
+
+## [1.0.0] - 2026-09-27
+
+### Added
+
+- `Client#blocking_call(timeout, *command)` and `#blocking_call_v` for BLPOP,
+  BRPOP, BZPOPMIN, XREAD BLOCK and similar commands. The read timeout is
+  extended by `timeout`; `nil`/`0` waits forever. Blocking commands are never
+  retried. Also available on `Pool`.
+- Pub/Sub: `Config#new_subscription` and `SentinelConfig#new_subscription`
+  return a `SolidRedis::Subscription` bound to a dedicated connection, with
+  `subscribe`/`psubscribe`/`ssubscribe`, `next_message(timeout:)`,
+  `each_message`, `ping`, and automatic resubscription after reconnect.
+- Redis Cluster: `SolidRedis.cluster(nodes:, max_redirections:, **options)`
+  builds a shareable `ClusterConfig`. Each Ractor keeps its own `ClusterState`
+  (slot table and per-node clients). `ClusterClient` handles `MOVED`, `ASK`,
+  `TRYAGAIN` and `CLUSTERDOWN`, extracts routing keys (hash tags, EVAL/FCALL,
+  XREAD STREAMS, ZUNION-style commands) and runs pipelines grouped per node
+  while preserving reply order.
+- `RESP::Reader#with_timeout` and `#wait_readable`.
+
+## [0.2.1] - 2026-09-27
+
+### Changed
+
+- README: refresh the downloads badge.
+
+## [0.2.0] - 2026-09-27
+
+### Added
+
+- `Client#pipelined(exception: false)` returns `CommandError` instances in
+  place instead of raising the first one.
+
+## [0.1.1] - 2026-09-27
+
+### Added
+
+- README usage examples.
+
+### Changed
+
+- Require Ruby >= 3.1; CI runs Ruby 3.1 through 4.0.
+
+## [0.1.0] - 2026-09-27
+
+### Added
+
+- Initial release: immutable, Ractor-shareable `Config` and `SentinelConfig`
+  with per-Ractor `SentinelState`, `Client` (RESP2/RESP3, TCP, Unix socket,
+  TLS, reconnection), `Pool` owned by a single Ractor, pipelines, and
+  lifecycle callbacks via `callback-collection`.
+
+[1.0.3]: https://github.com/nicolasva/solid-redis/compare/v1.0.2...v1.0.3
+[1.0.2]: https://github.com/nicolasva/solid-redis/compare/v1.0.1...v1.0.2
+[1.0.1]: https://github.com/nicolasva/solid-redis/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/nicolasva/solid-redis/compare/v0.2.1...v1.0.0
+[0.2.1]: https://github.com/nicolasva/solid-redis/compare/v0.2.0...v0.2.1
+[0.2.0]: https://github.com/nicolasva/solid-redis/compare/v0.1.1...v0.2.0
+[0.1.1]: https://github.com/nicolasva/solid-redis/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/nicolasva/solid-redis/releases/tag/v0.1.0

data/README.md

@@ -272,9 +272,9 @@ client.call("GET", "user:1")
 client.call("MGET", "{user:1}.name", "{user:1}.email") # same slot via hash tag
 
 client.pipelined do |pipeline|
-  pipeline.call("GET", "a")   # commands are grouped per node,
-  pipeline.call("GET", "b")   # sent in parallel pipelines,
-  pipeline.call("PING")       # and results come back in order
+  pipeline.call("GET", "a")   # commands are grouped into one pipeline
+  pipeline.call("GET", "b")   # per node, and results come back
+  pipeline.call("PING")       # in their original order
 end
 
 pool = CLUSTER.new_pool(size: 5) # a pool of cluster clients
@@ -308,6 +308,10 @@ Direct Redis options:
 | `ssl` | `false` | Enable TLS |
 | `ssl_params` | | Immutable `OpenSSL::SSL::SSLContext` attributes |
 
+An explicit `db:` option takes precedence over a database selected by the URL
+path or `?db=` query parameter. When neither specifies a database, it defaults
+to `0`.
+
 Sentinel additionally requires `name` and `sentinels`, and accepts `role`,
 `sentinel_username`, `sentinel_password`, `sentinel_ssl`, and
 `sentinel_ssl_params`. Sentinel defaults to two reconnect attempts.
@@ -589,6 +593,22 @@ bundle exec rake
 The default task runs the Minitest suite and builds the gem in `pkg/`.
 CI runs the suite on Ruby 3.1 through 4.0.
 
+The suite needs no running Redis: it uses an in-process fake server
+(`test/support/fake_redis_server.rb`) that speaks RESP2/RESP3, Sentinel,
+Pub/Sub and a three-node Cluster topology. To try a specific Ruby version:
+
+```sh
+RBENV_VERSION=4.0.1 rbenv exec bundle exec rake test
+```
+
+To exercise the client against a real server, start `redis-server` and run
+snippets from the examples above with `bundle exec ruby -Ilib`. A local
+cluster for manual checks can be created with three
+`redis-server --port 700X --cluster-enabled yes` processes followed by
+`redis-cli --cluster create 127.0.0.1:7000 127.0.0.1:7001 127.0.0.1:7002 --cluster-yes`.
+
+The changelog lives in `CHANGELOG.md`; add an entry for every release.
+
 ## Publishing
 
 Releases use RubyGems Trusted Publishing. Configure a pending trusted

data/lib/solid_redis/client.rb

@@ -44,10 +44,8 @@ module SolidRedis
       begin
         write(RESP.encode(command))
         @reader.with_timeout(read_timeout) { @reader.read }
-      rescue ConnectionError, IO::WaitReadable, IO::WaitWritable, SystemCallError => error
-        close
-        config.reset if config.sentinel?
-        config.notify(:connection_error, error.class.name, error.message)
+      rescue ProtocolError, ConnectionError, IO::WaitReadable, IO::WaitWritable, SystemCallError => error
+        handle_connection_failure(error)
         raise error if error.is_a?(Error)
 
         raise ConnectionError, error.message, cause: error
@@ -96,10 +94,11 @@ module SolidRedis
       begin
         connect unless connected?
         yield
+      rescue ProtocolError => error
+        handle_connection_failure(error)
+        raise
       rescue ConnectionError, IO::WaitReadable, IO::WaitWritable, SystemCallError => error
-        close
-        config.reset if config.sentinel?
-        config.notify(:connection_error, error.class.name, error.message)
+        handle_connection_failure(error)
         if attempts < config.reconnect_attempts
           attempts += 1
           retry
@@ -110,6 +109,12 @@ module SolidRedis
       end
     end
 
+    def handle_connection_failure(error)
+      close
+      config.reset if config.sentinel?
+      config.notify(:connection_error, error.class.name, error.message)
+    end
+
     def connect
       @target = config.sentinel? ? config.resolve : config
       @socket = open_socket(@target)

data/lib/solid_redis/cluster/command_key.rb

@@ -8,7 +8,7 @@ module SolidRedis
       KEYLESS = Ractor.make_shareable(
         %w[
           ACL ASKING AUTH BGREWRITEAOF BGSAVE CLIENT CLUSTER COMMAND CONFIG DBSIZE DEBUG DISCARD ECHO EXEC
-          FAILOVER FLUSHALL FLUSHDB FUNCTION HELLO INFO LASTSAVE LATENCY LOLWUT MEMORY MODULE MONITOR MULTI PING
+          FAILOVER FLUSHALL FLUSHDB FUNCTION HELLO INFO LASTSAVE LATENCY LOLWUT MODULE MONITOR MULTI PING
           PSUBSCRIBE PUBLISH PUBSUB PUNSUBSCRIBE QUIT RANDOMKEY READONLY READWRITE REPLICAOF RESET ROLE SAVE
           SCAN SCRIPT SELECT SHUTDOWN SLAVEOF SLOWLOG SUBSCRIBE SWAPDB SYNC TIME UNSUBSCRIBE UNWATCH WAIT
         ].to_h { |name| [name, true] },
@@ -42,6 +42,7 @@ module SolidRedis
         end
 
         case name
+        when "MEMORY" then command[1].to_s.casecmp?("USAGE") ? command[2] : nil
         when "XGROUP", "XINFO", "OBJECT" then command[2]
         when "MIGRATE" then command[3].to_s.empty? ? nil : command[3]
         else command[1]

data/lib/solid_redis/cluster_client.rb

@@ -7,6 +7,7 @@ module SolidRedis
   class ClusterClient
     REDIRECTION = /\A(MOVED|ASK) (\d+) (\S+):(\d+)\z/
     RETRY_DELAY = 0.05
+    TRANSIENT_ERRORS = %w[TRYAGAIN CLUSTERDOWN].freeze
 
     attr_reader :config
 
@@ -49,7 +50,8 @@ module SolidRedis
       end
 
       results.each_with_index do |result, index|
-        next unless result.is_a?(CommandError) && result.message.match?(REDIRECTION)
+        next unless result.is_a?(CommandError)
+        next unless result.message.match?(REDIRECTION) || transient_error?(result)
 
         results[index] = begin
           call_v(commands[index])
@@ -107,6 +109,7 @@ module SolidRedis
           redirections += 1
           raise FailoverError, "Cluster unavailable: #{error.message}" if redirections > config.max_redirections
 
+          asking = false
           sleep RETRY_DELAY
           config.state.refresh
           node = node_for(command)
@@ -129,6 +132,10 @@ module SolidRedis
       key ? config.state.node_for_slot(Cluster::KeySlot.for(key)) : config.state.any_node
     end
 
+    def transient_error?(error)
+      error.message.start_with?(*TRANSIENT_ERRORS)
+    end
+
     def client_for(node)
       @clients[node.server_key] ||= node.new_client(name: @name)
     end

data/lib/solid_redis/config.rb

@@ -6,6 +6,7 @@ module SolidRedis
   class Config
     DEFAULT_TIMEOUT = 1.0
     DEFAULT_PORT = 6379
+    UNSPECIFIED = Object.new.freeze
 
     attr_reader :host, :port, :path, :username, :password, :db,
       :connect_timeout, :read_timeout, :write_timeout, :reconnect_attempts,
@@ -18,7 +19,7 @@ module SolidRedis
       path: nil,
       username: nil,
       password: nil,
-      db: 0,
+      db: UNSPECIFIED,
       timeout: DEFAULT_TIMEOUT,
       connect_timeout: timeout,
       read_timeout: timeout,
@@ -35,9 +36,10 @@ module SolidRedis
         path = values[:path]
         username ||= values[:username]
         password ||= values[:password]
-        db = values[:db] unless values[:db].nil?
+        db = values[:db] if db.equal?(UNSPECIFIED) && !values[:db].nil?
         ssl ||= values[:ssl]
       end
+      db = 0 if db.equal?(UNSPECIFIED)
 
       @host = String(host).dup.freeze unless path
       @port = Integer(port) unless path
@@ -140,10 +142,10 @@ module SolidRedis
     end
 
     def query_db(uri)
-      return 0 unless uri.query
+      return unless uri.query
 
       value = URI.decode_www_form(uri.query).to_h["db"]
-      value ? Integer(value) : 0
+      Integer(value) if value
     end
 
     def decoded(value)

data/lib/solid_redis/resp.rb

@@ -72,7 +72,7 @@ module SolidRedis
         when "~", ">" then read_collection(exception)
         when "=" then read_verbatim
         when "!" then error_response(read_sized_string, exception)
-        when "|" then read_map(exception) && read(exception: exception)
+        when "|" then read_attribute(exception)
         else raise ProtocolError, "Unknown RESP type byte: #{type.inspect}"
         end
       rescue EOFError
@@ -94,18 +94,46 @@ module SolidRedis
         length = Integer(read_line)
         return if length == -1
 
-        Array.new(length) { read(exception: exception) }
+        finish_collection(Array.new(length) { read(exception: false) }, exception)
       end
 
       def read_collection(exception)
         length = Integer(read_line)
-        Array.new(length) { read(exception: exception) }
+        finish_collection(Array.new(length) { read(exception: false) }, exception)
       end
 
       def read_map(exception)
         length = Integer(read_line)
-        {}.tap do |map|
-          length.times { map[read(exception: exception)] = read(exception: exception) }
+        map = {}.tap do |result|
+          length.times { result[read(exception: false)] = read(exception: false) }
+        end
+        finish_collection(map, exception)
+      end
+
+      def read_attribute(exception)
+        attributes = read_map(false)
+        value = read(exception: false)
+        raise_nested_error(attributes) if exception
+        raise_nested_error(value) if exception
+        value
+      end
+
+      def finish_collection(value, exception)
+        raise_nested_error(value) if exception
+        value
+      end
+
+      def raise_nested_error(value)
+        case value
+        when CommandError
+          raise value
+        when Array
+          value.each { |element| raise_nested_error(element) }
+        when Hash
+          value.each do |key, element|
+            raise_nested_error(key)
+            raise_nested_error(element)
+          end
         end
       end
 
@@ -140,9 +168,12 @@ module SolidRedis
       end
 
       def fill_buffer
+        wait_for = :readable
         loop do
           if @io.respond_to?(:to_io)
-            unless IO.select([@io], nil, nil, @read_timeout)
+            readers = wait_for == :readable ? [@io] : nil
+            writers = wait_for == :writable ? [@io] : nil
+            unless IO.select(readers, writers, nil, @read_timeout)
               raise TimeoutError, "Redis read timed out after #{@read_timeout}s"
             end
 
@@ -151,7 +182,10 @@ module SolidRedis
             chunk = @io.read(16_384)
           end
 
-          next if chunk == :wait_readable
+          if chunk == :wait_readable || chunk == :wait_writable
+            wait_for = chunk == :wait_readable ? :readable : :writable
+            next
+          end
           raise EOFError if chunk.nil?
 
           @buffer << chunk

data/lib/solid_redis/subscription.rb

@@ -75,6 +75,9 @@ module SolidRedis
         return unless @reader.wait_readable(timeout)
 
         return decode(@reader.read)
+      rescue ProtocolError => error
+        handle_error(error)
+        raise
       rescue ConnectionError, IO::WaitReadable, IO::WaitWritable, SystemCallError => error
         handle_error(error)
         raise error if attempts >= config.reconnect_attempts
@@ -123,6 +126,9 @@ module SolidRedis
       loop do
         ensure_connected
         return write(RESP.encode(yield))
+      rescue ProtocolError => error
+        handle_error(error)
+        raise
       rescue ConnectionError, IO::WaitReadable, IO::WaitWritable, SystemCallError => error
         handle_error(error)
         raise error if attempts >= config.reconnect_attempts

data/lib/solid_redis/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SolidRedis
-  VERSION = "1.0.1"
+  VERSION = "1.0.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solid-redis
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Nicolas Vandenbogaerde
@@ -78,6 +78,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - lib/solid_redis.rb
@@ -103,8 +104,9 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-  documentation_uri: https://www.rubydoc.info/gems/solid-redis/1.0.1
+  documentation_uri: https://www.rubydoc.info/gems/solid-redis/1.0.3
   source_code_uri: https://github.com/nicolasva/solid-redis
+  changelog_uri: https://github.com/nicolasva/solid-redis/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib