# encoding: UTF-8 require 'redis-store' require 'maybe_client' module ActiveSupport module Cache class FaultTolerantRedisStore < Store # Instantiate the store. # # Example: # RedisStore.new # # => host: localhost, port: 6379, db: 0 # # RedisStore.new "example.com" # # => host: example.com, port: 6379, db: 0 # # RedisStore.new "example.com:23682" # # => host: example.com, port: 23682, db: 0 # # RedisStore.new "example.com:23682/1" # # => host: example.com, port: 23682, db: 1 # # RedisStore.new "example.com:23682/1/theplaylist" # # => host: example.com, port: 23682, db: 1, namespace: theplaylist # # RedisStore.new "localhost:6379/0", "localhost:6380/0" # # => instantiate a cluster def initialize(*addresses) @data = MaybeClient.new(client: ::Redis::Store::Factory.create(addresses)) super(addresses.extract_options!) end def write(name, value, options = nil) options = merged_options(options) instrument(:write, name, options) do |payload| entry = options[:raw].present? ? value : Entry.new(value, options) write_entry(namespaced_key(name, options), entry, options) end end # Delete objects for matched keys. # # Performance note: this operation can be dangerous for large production # databases, as it uses the Redis "KEYS" command, which is O(N) over the # total number of keys in the database. Users of large Redis caches should # avoid this method. # # Example: # cache.del_matched "rab*" def delete_matched(matcher, options = nil) options = merged_options(options) instrument(:delete_matched, matcher.inspect) do matcher = key_matcher(matcher, options) begin !(keys = @data.keys(matcher)).empty? && @data.del(*keys) rescue Errno::ECONNREFUSED => e false end end end # Reads multiple keys from the cache using a single call to the # servers for all keys. Options can be passed in the last argument. # # Example: # cache.read_multi "rabbit", "white-rabbit" # cache.read_multi "rabbit", "white-rabbit", :raw => true def read_multi(*names) values = @data.mget(*names) values.map! { |v| v.is_a?(ActiveSupport::Cache::Entry) ? v.value : v } # Remove the options hash before mapping keys to values names.extract_options! result = Hash[names.zip(values)] result.reject!{ |k,v| v.nil? } result end # Increment a key in the store. # # If the key doesn't exist it will be initialized on 0. # If the key exist but it isn't a Fixnum it will be initialized on 0. # # Example: # We have two objects in cache: # counter # => 23 # rabbit # => # # # cache.increment "counter" # cache.read "counter", :raw => true # => "24" # # cache.increment "counter", 6 # cache.read "counter", :raw => true # => "30" # # cache.increment "a counter" # cache.read "a counter", :raw => true # => "1" # # cache.increment "rabbit" # cache.read "rabbit", :raw => true # => "1" def increment(key, amount = 1) instrument(:increment, key, :amount => amount) do @data.incrby key, amount end end # Decrement a key in the store # # If the key doesn't exist it will be initialized on 0. # If the key exist but it isn't a Fixnum it will be initialized on 0. # # Example: # We have two objects in cache: # counter # => 23 # rabbit # => # # # cache.decrement "counter" # cache.read "counter", :raw => true # => "22" # # cache.decrement "counter", 2 # cache.read "counter", :raw => true # => "20" # # cache.decrement "a counter" # cache.read "a counter", :raw => true # => "-1" # # cache.decrement "rabbit" # cache.read "rabbit", :raw => true # => "-1" def decrement(key, amount = 1) instrument(:decrement, key, :amount => amount) do @data.decrby key, amount end end def expire(key, ttl) @data.expire key, ttl end # Clear all the data from the store. def clear instrument(:clear, nil, nil) do @data.flushdb end end # fixed problem with invalid exists? method # https://github.com/rails/rails/commit/cad2c8f5791d5bd4af0f240d96e00bae76eabd2f def exist?(name, options = nil) res = super(name, options) res || false end def stats @data.info end # Force client reconnection, useful Unicorn deployed apps. def reconnect @data.reconnect end protected def write_entry(key, entry, options) method = options && options[:unless_exist] ? :setnx : :set @data.send method, key, entry, options rescue Errno::ECONNREFUSED => e false end def read_entry(key, options) entry = @data.get key, options if entry entry.is_a?(ActiveSupport::Cache::Entry) ? entry : ActiveSupport::Cache::Entry.new(entry) end rescue Errno::ECONNREFUSED => e nil end ## # Implement the ActiveSupport::Cache#delete_entry # # It's really needed and use # def delete_entry(key, options) @data.del key rescue Errno::ECONNREFUSED => e false end # Add the namespace defined in the options to a pattern designed to match keys. # # This implementation is __different__ than ActiveSupport: # __it doesn't accept Regular expressions__, because the Redis matcher is designed # only for strings with wildcards. def key_matcher(pattern, options) prefix = options[:namespace].is_a?(Proc) ? options[:namespace].call : options[:namespace] if prefix raise "Regexps aren't supported, please use string with wildcards." if pattern.is_a?(Regexp) "#{prefix}:#{pattern}" else pattern end end end end end