Release 5.0.0: known compatibility issues

[byroot]

This issue aim to maintain a list of known compatibility issues with redis-rb 5.0, as well as links to where they are being handled.

If you have an error not yet reported it after upgrading, feel free to comment and I'll triage it.

• NoMethodError: undefined method 'drivers' for Redis::Commands::Connection:Module (Redis nomethod error since Redis 5.0.0 #1140)
  • Caused by older versions of Sidekiq, is worked around by redis-rb 5.0.1
• Rails Action Cable and RedisCacheStore compatibility:
  • Fixed in Rails 7-0-stable branch
  • Will be released as part of Rails 7.0.4.
• Resque compatibility (Unknown keyword: thread_safe)
  • This one will be tricky, best to lock redis-rb for now (Unknown keyword: thread_safe with redis 5.0.1 resque/resque#1821)
• kredis compatibility
  • The PR is merged, no changed was needed aside from the gemspec.
  • Still need a release.

[jason-hobbs]

I bundle updated and am now getting:
Error loading the 'redis' Action Cable pubsub adapter. Missing a gem it depends on? can't activate redis (>= 3, < 5), already activated redis-5.0.1. Make sure all dependencies are added to Gemfile.

Never mind, just saw the Rails 7.0.4 fix.

[tonobo]

Howdy guys, redis-client gem won't support reconnect_delay and reconnect_delay_max arguments, is it planned to adopt this?

[byroot]

won't support reconnect_delay and reconnect_delay_max arguments, is it planned to adopt this?

No, this feature was wonky, so I replaced it by reconnect_attempts accepting a list of sleep durations, e.g:

Redis.new(reconnect_attempts: [
  0, # retry once immediately
  0.1, # retry a second time after sleeping 100ms
  0.5, # retry a third time after sleeping 500ms more.
])

I think it's way way easier to reason about it with this format.

If you absolutely want reconnect_delay and reconnect_delay_max, you can implement a function that takes these two parameters and return an array of durations like redis 5 expects.

[runephilosof-karnovgroup]

Rails 7.0.4 has been released (Sep 10th), so I guess you can check that checkmark (in the issue description)

[byroot]

Thanks, all known outstanding issues are fixed. I'll leave open in case someone else find something.

[jmthomas]

@byroot It seems like the redis-client code does not allow Boolean parameters yet the original redis gem defines them. Here is a relavent stack trace:

TypeError : Unsupported command argument type: FalseClass 
/usr/lib/ruby/gems/3.1.0/gems/redis-client-0.10.0/lib/redis_client/command_builder.rb:37:in `block in generate'
/usr/lib/ruby/gems/3.1.0/gems/redis-client-0.10.0/lib/redis_client/command_builder.rb:28:in `map!'
/usr/lib/ruby/gems/3.1.0/gems/redis-client-0.10.0/lib/redis_client/command_builder.rb:28:in `generate'
/usr/lib/ruby/gems/3.1.0/gems/redis-client-0.10.0/lib/redis_client.rb:212:in `call_v'
/usr/lib/ruby/gems/3.1.0/gems/redis-5.0.5/lib/redis/client.rb:73:in `call_v'
/usr/lib/ruby/gems/3.1.0/gems/redis-5.0.5/lib/redis.rb:167:in `block in send_command'
/usr/lib/ruby/gems/3.1.0/gems/redis-5.0.5/lib/redis.rb:166:in `synchronize'
/usr/lib/ruby/gems/3.1.0/gems/redis-5.0.5/lib/redis.rb:166:in `send_command'
/usr/lib/ruby/gems/3.1.0/gems/redis-5.0.5/lib/redis/commands/streams.rb:57:in `xadd' 

When calling xadd with something like:

redis.xadd(topic, msg_hash, id: '*', approximate: true)

Looks like the redis-client code doesn't allow Boolean keyword arguments: https://github.com/redis-rb/redis-client/blob/master/lib/redis_client/command_builder.rb#L28

[jmthomas]

I'm also seeing an error trying to call call on the client:

NoMethodError : undefined method `call' for #<Redis::Client redis://openc3-redis-ephemeral:6380/0> synchronize { |client| client.call(args) } ^^^^^ Did you mean? call_v

We have client code which tries to use call like so:

class Redis
  def xtrim_minid(key, minid, approximate: true, limit: nil)
    args = [:xtrim, key, :MINID, (approximate ? '~' : nil), minid].compact
    args.concat([:LIMIT, limit]) if limit
    synchronize { |client| client.call(args) }
  end
end

Mostly because the redis client had not implemented xtrim. Has call been deprecated?