docuseal/vendor/bundle/ruby/4.0.0/gems/redis-client-0.28.0/CHANGELOG.md

Unreleased

0.28.0

• Added RedisClient::HashRing for horizontal sharing (compatible with Redis::Distributed from redis-rb).

0.27.0

• Added idle_timeout to revalidate connections that haven't been successfuly used in a long time. Defaults to 30 seconds.
• Added driver_info configuration, to issue CLIENT SETINFO during connection prelude.

0.26.4

• Further improve rediss:// URLs used with Redis sentinel. Now avoid override explictly set ssl: parameter.
• Fix compatibility with redis-rb in sentinel mode.

0.26.3

• Fix rediss:// (ssl) URLs used with Redis sentinel.
• Handle Ruby 4.0 connection timeout raising an IO::Timeout instead of Errno::ETIMEDOUT.
• Entirely close the connection on authentication failures.

0.26.2

• Fix compatibility with connection_pool version 3+.

0.26.1

• Fix a few corner cases where RedisClient::Error#final? was innacurate.
• hiredis-client: Properly reconnect to the new leader after a sentinel failover.

0.26.0

• Add RedisClient::Error#final? and #retriable? to allow middleware to filter out non-final errors.

• Fix precedence of db: nil initialization parameter.

  Redis.new(url: "redis://localhost:6379/3", db: nil).db
  

  Before: 0 After: 3

0.25.3

• Fix hiredis-client compilation with clang 21.

0.25.2

• Fix circuit breakers to respect the error_threshold_timeout config is provided.
• Fix circuit breakers to clear errors when closing back.

0.25.1

• Fix Ruby driver TCP keep alive TTL. It was intended to be 120 seconds but was mistakenly set to 15 seconds.

0.25.0

• Fix hiredis-client compilation with GCC 15.
• Fix hiredis-client from a work directory with spaces.
• Add CommandError#code.
• Add RedisClient::NoScriptError for EVALSHA.

0.24.0

• Allow sentinel_password to be provided as a Proc.
• Ensure Config#inspect and Config#to_s do not display stored passwords.

0.23.2

• Fix retry logic not to attempt to retry on an open circuit breaker. Fix #227.

0.23.1

• Fix a potential crash in hiredis-client when using subcriptions (next_event). See #221.

0.23.0

• Allow password to be a callable. Makes it easy to implement short lived password authentication strategies.
• Fix a thread safety issue in hiredis-client when using the pubsub client concurrently.

0.22.2

• Fix the sentinel client to properly extend timeout for blocking commands.
• Fix IPv6 support in RedisClient::Config#server_url.

0.22.1

• Fix ProtocolError: Unknown sigil type errors when using SSL connection. See #190.

0.22.0

• Made various performance optimizations to the Ruby driver. See #184.
• Always assume UTF-8 encoding instead of relying on Encoding.default_external.
• Add exception flag in pipelined allowing failed commands to be returned in the result array when set to false. See #187.

0.21.1

• Handle unresolved Sentinel master/replica error when displaying server URL in exceptions. See #182.

0.21.0

• Include redis server URL in most error messages. See #178.
• Close Redis Sentinel connection after resolving role. See #176.

0.20.0

• Accept unix:// schemes as well as simple paths in the url: config parameter. #170.
• Make basic usage Ractor compatible.

0.19.1

• Fixed a bug in hiredis-client that could cause a crash if interrupted by Timeout.timeout or other Thread#raise based mecanism.
• Fixed a GC bug that could cause crashes in hiredis-client.

0.19.0

• Revalidate connection in RedisClient#connected?
• Eagerly fail if db: isn't an Integer. #151.

0.18.0

• Expose more connection details such as host, db, etc on RedisClient.

0.17.1

• Add support for NaN in RESP3 protocol doubles. This was initially missing from the spec and added about a year ago.

0.17.0

• Adds sentinel_username and sentinel_password options for RedisClient#sentinel

0.16.0

• Add RedisClient#disable_reconnection.
• Reverted the special discard of connection. A regular close(2) should be enough.

0.15.0

• Discard sockets rather than explictly close them when a fork is detected. #126.
• Allow to configure sentinel client via url. #117.
• Fix sentinel to preverse the auth/password when refreshing the sentinel list. #107.
• Added RedisClient#measure_round_trip_delay method. #113.

0.14.1

• Include the timeout value in TimeoutError messages.
• Fix connection keep-alive on FreeBSD. #102.

0.14.0

• Implement Sentinels list automatic refresh.
• hiredis binding now implement GC compaction and write barriers.
• hiredis binding now properly release the GVL around connect(2).
• hiredis the client memory is now re-used on reconnection when possible to reduce allocation churn.

0.13.0

• Enable TCP keepalive on redis sockets. It sends a keep alive probe every 15 seconds for 2 minutes. #94.

0.12.2

• Cache calls to Process.pid on Ruby 3.1+. #91.

0.12.1

• Improve compatibility with uri 0.12.0 (default in Ruby 3.2.0).

0.12.0

• hiredis: fix a compilation issue on macOS and Ruby 3.2.0. See: #79
• Close connection on MASTERDOWN errors. Similar to READONLY.
• Add a circuit_breaker configuration option for cache servers and other disposable Redis servers. See #55 / #70

0.11.2

• Close connection on READONLY errors. Fix: #64
• Handle Redis 6+ servers with a missing HELLO command. See: #67
• Validate url parameters a bit more strictly. Fix #61

0.11.1

• hiredis: Workaround a compilation bug with Xcode 14.0. Fix: #58
• Accept URI instances as uri parameter.

0.11.0

• hiredis: do not eagerly close the connection on read timeout, let the caller decide if a timeout is final.
• Add Config#custom to store configuration metadata. It can be used for per server middleware configuration.

0.10.0

• Added instance scoped middlewares. See: #53
• Allow subclasses of accepted types as command arguments. Fix: #51
• Improve hiredis driver error messages.

0.9.0

• Automatically reconnect if the process was forked.

0.8.1

• Make the client resilient to Timeout.timeout or Thread#kill use (it still is very much discouraged to use either). Use of async interrupts could cause responses to be interleaved.
• hiredis: handle commands returning a top-level false (no command does this today, but some extensions might).
• Workaround a bug in Ruby 2.6 causing a crash if the debug gem is enabled when redis-client is being required. Fix: #48

0.8.0

• Add a connect interface to the instrumentation API.

0.7.4

• Properly parse script errors on pre 7.0 redis server.

0.7.3

• Fix a bug in url parsing conflicting with the path option.

0.7.2

• Raise a distinct RedisClient::OutOfMemoryError, for Redis OOM errors.
• Fix the instrumentation API to be called even for authentication commands.
• Fix url: configuration to accept a trailing slash.

0.7.1

• Fix #pubsub being called when reconnection is disabled (redis-rb compatibility fix).

0.7.0

• Sentinel config now accept a list of URLs: RedisClient.sentinel(sentinels: %w(redis://example.com:7000 redis://example.com:7001 ..))

0.6.2

• Fix sentinel to not connected to s_down or o_down replicas.

0.6.1

• Fix REDIS_REPLY_SET parsing in hiredis.

0.6.0

• Added protocol: 2 options to talk with Redis 5 and older servers.
• Added _v versions of call methods to make it easier to pass commands as arrays without splating.
• Fix calling blocking_call with a block in a pipeline.
• blocking_call now raise ReadTimeoutError if the command didn't complete in time.
• Fix blocking_call to not respect reconnect_attempts on timeout.
• Stop parsing RESP3 sets as Ruby Set instances.
• Fix SystemStackError when parsing very large hashes. Fix: #30
• hiredis now more properly release the GVL when doing IOs.

0.5.1

• Fix a regression in the scan familly of methods, they would raise with ArgumentError: can't issue an empty redis command. Fix: #24

0.5.0

• Fix handling of connection URLs with empty passwords (redis://:pass@example.com).
• Handle URLs with IPv6 hosts.
• Add RedisClient::Config#server_url as a quick way to identify which server the client is pointing to.
• Add CommandError#command to expose the command that caused the error.
• Raise a more explicit error when connecting to older redises without RESP3 support (5.0 and older).
• Properly reject empty commands early.

0.4.0

• The hiredis driver have been moved to the hiredis-client gem.

0.3.0

• hiredis is now the default driver when available.
• Add RedisClient.default_driver=.
• #call now takes an optional block to cast the return value.
• Treat #call keyword arguments as Redis flags.
• Fix RedisClient#multi returning some errors as values instead of raising them.

0.2.1

• Use a more robust way to detect the current compiler.

0.2.0

• Added RedisClient.register as a public instrumentation API.
• Fix read_timeout= and write_timeout= to apply even when the client or pool is already connected.
• Properly convert DNS resolution errors into RedisClient::ConnectionError. Previously it would raise SocketError

0.1.0

• Initial Release