dalli 2.7.2 → 3.0.0

data/lib/dalli/client.rb

@@ -1,20 +1,24 @@
-require 'digest/md5'
-require 'set'
+# frozen_string_literal: true
+
+require "digest/md5"
+require "set"
 
 # encoding: ascii
 module Dalli
   class Client
-
     ##
     # Dalli::Client is the main class which developers will use to interact with
     # the memcached server.  Usage:
     #
-    #   Dalli::Client.new(['localhost:11211:10', 'cache-2.example.com:11211:5', '192.168.0.1:22122:5'],
+    #   Dalli::Client.new(['localhost:11211:10', 'cache-2.example.com:11211:5', '192.168.0.1:22122:5', '/var/run/memcached/socket'],
     #                   :threadsafe => true, :failover => true, :expires_in => 300)
     #
     # servers is an Array of "host:port:weight" where weight allows you to distribute cache unevenly.
     # Both weight and port are optional.  If you pass in nil, Dalli will use the <tt>MEMCACHE_SERVERS</tt>
-    # environment variable or default to 'localhost:11211' if it is not present.
+    # environment variable or default to 'localhost:11211' if it is not present.  Dalli also supports
+    # the ability to connect to Memcached on localhost through a UNIX socket.  To use this functionality,
+    # use a full pathname (beginning with a slash character '/') in place of the "host:port" pair in
+    # the server configuration.
     #
     # Options:
     # - :namespace - prepend each key with this value to provide simple namespacing.
@@ -24,9 +28,13 @@ module Dalli
     # - :compress - defaults to false, if true Dalli will compress values larger than 1024 bytes before sending them to memcached.
     # - :serializer - defaults to Marshal
     # - :compressor - defaults to zlib
+    # - :cache_nils - defaults to false, if true Dalli will not treat cached nil values as 'not found' for #fetch operations.
+    # - :digest_class - defaults to Digest::MD5, allows you to pass in an object that responds to the hexdigest method, useful for injecting a FIPS compliant hash object.
+    # - :protocol_implementation - defaults to Dalli::Protocol::Binary which uses the binary protocol. Allows you to pass an alternative implementation using another protocol.
     #
-    def initialize(servers=nil, options={})
-      @servers = normalize_servers(servers || ENV["MEMCACHE_SERVERS"] || '127.0.0.1:11211')
+    def initialize(servers = nil, options = {})
+      validate_servers_arg(servers)
+      @servers = normalize_servers(servers || ENV["MEMCACHE_SERVERS"] || "127.0.0.1:11211")
       @options = normalize_options(options)
       @ring = nil
     end
@@ -49,8 +57,9 @@ module Dalli
 
     ##
     # Get the value associated with the key.
-    def get(key, options=nil)
-      perform(:get, key)
+    # If a value is not found, then +nil+ is returned.
+    def get(key, options = nil)
+      perform(:get, key, options)
     end
 
     ##
@@ -58,21 +67,38 @@ module Dalli
     # If a block is given, yields key/value pairs one at a time.
     # Otherwise returns a hash of { 'key' => 'value', 'key2' => 'value1' }
     def get_multi(*keys)
+      keys.flatten!
+      keys.compact!
+
+      return {} if keys.empty?
       if block_given?
-        get_multi_yielder(keys) {|k, data| yield k, data.first}
+        get_multi_yielder(keys) { |k, data| yield k, data.first }
       else
-         Hash.new.tap do |hash|
-          get_multi_yielder(keys) {|k, data| hash[k] = data.first}
+        {}.tap do |hash|
+          get_multi_yielder(keys) { |k, data| hash[k] = data.first }
         end
       end
     end
 
-    def fetch(key, ttl=nil, options=nil)
-      ttl ||= @options[:expires_in].to_i
+    CACHE_NILS = {cache_nils: true}.freeze
+
+    # Fetch the value associated with the key.
+    # If a value is found, then it is returned.
+    #
+    # If a value is not found and no block is given, then nil is returned.
+    #
+    # If a value is not found (or if the found value is nil and :cache_nils is false)
+    # and a block is given, the block will be invoked and its return value
+    # written to the cache and returned.
+    def fetch(key, ttl = nil, options = nil)
+      options = options.nil? ? CACHE_NILS : options.merge(CACHE_NILS) if @options[:cache_nils]
       val = get(key, options)
-      if val.nil? && block_given?
+      not_found = @options[:cache_nils] ?
+        val == Dalli::Protocol::NOT_FOUND :
+        val.nil?
+      if not_found && block_given?
         val = yield
-        add(key, val, ttl, options)
+        add(key, val, ttl_or_default(ttl), options)
       end
       val
     end
@@ -88,35 +114,37 @@ module Dalli
     # - nil if the key did not exist.
     # - false if the value was changed by someone else.
     # - true if the value was successfully updated.
-    def cas(key, ttl=nil, options=nil, &block)
-      ttl ||= @options[:expires_in].to_i
-      (value, cas) = perform(:cas, key)
-      value = (!value || value == 'Not found') ? nil : value
-      if value
-        newvalue = block.call(value)
-        perform(:set, key, newvalue, ttl, cas, options)
-      end
+    def cas(key, ttl = nil, options = nil, &block)
+      cas_core(key, false, ttl, options, &block)
     end
 
-    def set(key, value, ttl=nil, options=nil)
-      ttl ||= @options[:expires_in].to_i
-      perform(:set, key, value, ttl, 0, options)
+    ##
+    # like #cas, but will yield to the block whether or not the value
+    # already exists.
+    #
+    # Returns:
+    # - false if the value was changed by someone else.
+    # - true if the value was successfully updated.
+    def cas!(key, ttl = nil, options = nil, &block)
+      cas_core(key, true, ttl, options, &block)
+    end
+
+    def set(key, value, ttl = nil, options = nil)
+      perform(:set, key, value, ttl_or_default(ttl), 0, options)
     end
 
     ##
     # Conditionally add a key/value pair, if the key does not already exist
     # on the server.  Returns truthy if the operation succeeded.
-    def add(key, value, ttl=nil, options=nil)
-      ttl ||= @options[:expires_in].to_i
-      perform(:add, key, value, ttl, options)
+    def add(key, value, ttl = nil, options = nil)
+      perform(:add, key, value, ttl_or_default(ttl), options)
     end
 
     ##
     # Conditionally add a key/value pair, only if the key already exists
     # on the server.  Returns truthy if the operation succeeded.
-    def replace(key, value, ttl=nil, options=nil)
-      ttl ||= @options[:expires_in].to_i
-      perform(:replace, key, value, ttl, 0, options)
+    def replace(key, value, ttl = nil, options = nil)
+      perform(:replace, key, value, ttl_or_default(ttl), 0, options)
     end
 
     def delete(key)
@@ -137,7 +165,7 @@ module Dalli
       perform(:prepend, key, value.to_s)
     end
 
-    def flush(delay=0)
+    def flush(delay = 0)
       time = -delay
       ring.servers.map { |s| s.request(:flush, time += delay) }
     end
@@ -155,10 +183,9 @@ module Dalli
     # Note that the ttl will only apply if the counter does not already
     # exist.  To increase an existing counter and update its TTL, use
     # #cas.
-    def incr(key, amt=1, ttl=nil, default=nil)
+    def incr(key, amt = 1, ttl = nil, default = nil)
       raise ArgumentError, "Positive values only: #{amt}" if amt < 0
-      ttl ||= @options[:expires_in].to_i
-      perform(:incr, key, amt.to_i, ttl, default)
+      perform(:incr, key, amt.to_i, ttl_or_default(ttl), default)
     end
 
     ##
@@ -175,31 +202,37 @@ module Dalli
     # Note that the ttl will only apply if the counter does not already
     # exist.  To decrease an existing counter and update its TTL, use
     # #cas.
-    def decr(key, amt=1, ttl=nil, default=nil)
+    def decr(key, amt = 1, ttl = nil, default = nil)
       raise ArgumentError, "Positive values only: #{amt}" if amt < 0
-      ttl ||= @options[:expires_in].to_i
-      perform(:decr, key, amt.to_i, ttl, default)
+      perform(:decr, key, amt.to_i, ttl_or_default(ttl), default)
     end
 
     ##
     # Touch updates expiration time for a given key.
     #
     # Returns true if key exists, otherwise nil.
-    def touch(key, ttl=nil)
-      ttl ||= @options[:expires_in].to_i
-      resp = perform(:touch, key, ttl)
+    def touch(key, ttl = nil)
+      resp = perform(:touch, key, ttl_or_default(ttl))
       resp.nil? ? nil : true
     end
 
+    ##
+    # Gat (get and touch) fetch an item and simultaneously update its expiration time.
+    #
+    # If a value is not found, then +nil+ is returned.
+    def gat(key, ttl = nil)
+      perform(:gat, key, ttl_or_default(ttl))
+    end
+
     ##
     # Collect the stats for each server.
-    # You can optionally pass a type including :items or :slabs to get specific stats
+    # You can optionally pass a type including :items, :slabs or :settings to get specific stats
     # Returns a hash like { 'hostname:port' => { 'stat1' => 'value1', ... }, 'hostname2:port' => { ... } }
-    def stats(type=nil)
-      type = nil if ![nil, :items,:slabs].include? type
+    def stats(type = nil)
+      type = nil unless [nil, :items, :slabs, :settings].include? type
       values = {}
       ring.servers.each do |server|
-        values["#{server.hostname}:#{server.port}"] = server.alive? ? server.request(:stats,type.to_s) : nil
+        values[server.name.to_s] = server.alive? ? server.request(:stats, type.to_s) : nil
       end
       values
     end
@@ -223,11 +256,63 @@ module Dalli
     def version
       values = {}
       ring.servers.each do |server|
-        values["#{server.hostname}:#{server.port}"] = server.alive? ? server.request(:version) : nil
+        values[server.name.to_s] = server.alive? ? server.request(:version) : nil
       end
       values
     end
 
+    ##
+    # Get the value and CAS ID associated with the key.  If a block is provided,
+    # value and CAS will be passed to the block.
+    def get_cas(key)
+      (value, cas) = perform(:cas, key)
+      value = !value || value == "Not found" ? nil : value
+      if block_given?
+        yield value, cas
+      else
+        [value, cas]
+      end
+    end
+
+    ##
+    # Fetch multiple keys efficiently, including available metadata such as CAS.
+    # If a block is given, yields key/data pairs one a time.  Data is an array:
+    # [value, cas_id]
+    # If no block is given, returns a hash of
+    #   { 'key' => [value, cas_id] }
+    def get_multi_cas(*keys)
+      if block_given?
+        get_multi_yielder(keys) { |*args| yield(*args) }
+      else
+        {}.tap do |hash|
+          get_multi_yielder(keys) { |k, data| hash[k] = data }
+        end
+      end
+    end
+
+    ##
+    # Set the key-value pair, verifying existing CAS.
+    # Returns the resulting CAS value if succeeded, and falsy otherwise.
+    def set_cas(key, value, cas, ttl = nil, options = nil)
+      ttl ||= @options[:expires_in].to_i
+      perform(:set, key, value, ttl, cas, options)
+    end
+
+    ##
+    # Conditionally add a key/value pair, verifying existing CAS, only if the
+    # key already exists on the server.  Returns the new CAS value if the
+    # operation succeeded, or falsy otherwise.
+    def replace_cas(key, value, cas, ttl = nil, options = nil)
+      ttl ||= @options[:expires_in].to_i
+      perform(:replace, key, value, ttl, cas, options)
+    end
+
+    # Delete a key/value pair, verifying existing CAS.
+    # Returns true if succeeded, and falsy otherwise.
+    def delete_cas(key, cas = 0)
+      perform(:delete, key, cas)
+    end
+
     ##
     # Close our connection to each server.
     # If you perform another operation after this, the connections will be re-established.
@@ -239,41 +324,46 @@ module Dalli
     end
     alias_method :reset, :close
 
-    # Stub method so a bare Dalli client can pretend to be a connection pool.
-    def with
-      yield self
+    private
+
+    def cas_core(key, always_set, ttl = nil, options = nil)
+      (value, cas) = perform(:cas, key)
+      value = !value || value == "Not found" ? nil : value
+      return if value.nil? && !always_set
+      newvalue = yield(value)
+      perform(:set, key, newvalue, ttl_or_default(ttl), cas, options)
     end
 
-    private
+    def ttl_or_default(ttl)
+      (ttl || @options[:expires_in]).to_i
+    rescue NoMethodError
+      raise ArgumentError, "Cannot convert ttl (#{ttl}) to an integer"
+    end
 
     def groups_for_keys(*keys)
-      groups = mapped_keys(keys).flatten.group_by do |key|
+      keys.flatten!
+      keys.map! { |a| validate_key(a.to_s) }
+
+      keys.group_by { |key|
         begin
           ring.server_for_key(key)
         rescue Dalli::RingError
           Dalli.logger.debug { "unable to get key #{key}" }
           nil
         end
-      end
-      return groups
-    end
-
-    def mapped_keys(keys)
-      keys.flatten.map {|a| validate_key(a.to_s)}
+      }
     end
 
     def make_multi_get_requests(groups)
       groups.each do |server, keys_for_server|
-        begin
-          # TODO: do this with the perform chokepoint?
-          # But given the fact that fetching the response doesn't take place
-          # in that slot it's misleading anyway. Need to move all of this method
-          # into perform to be meaningful
-          server.request(:send_multiget, keys_for_server)
-        rescue DalliError, NetworkError => e
-          Dalli.logger.debug { e.inspect }
-          Dalli.logger.debug { "unable to get keys for server #{server.hostname}:#{server.port}" }
-        end
+        # TODO: do this with the perform chokepoint?
+        # But given the fact that fetching the response doesn't take place
+        # in that slot it's misleading anyway. Need to move all of this method
+        # into perform to be meaningful
+        server.request(:send_multiget, keys_for_server)
+      rescue DalliError, NetworkError => e
+        Dalli.logger.debug { e.inspect }
+        Dalli.logger.debug { "unable to get keys for server #{server.name}" }
       end
     end
 
@@ -292,42 +382,54 @@ module Dalli
     end
 
     ##
-    # Normalizes the argument into an array of servers. If the argument is a string, it's expected to be of
-    # the format "memcache1.example.com:11211[,memcache2.example.com:11211[,memcache3.example.com:11211[...]]]
+    # Ensures that the servers arg is either an array or a string.
+    def validate_servers_arg(servers)
+      return if servers.nil?
+      return if servers.is_a?(Array)
+      return if servers.is_a?(String)
+
+      raise ArgumentError, "An explicit servers argument must be a comma separated string or an array containing strings."
+    end
+
+    ##
+    # Normalizes the argument into an array of servers.
+    # If the argument is a string, or an array containing strings, it's expected that the URIs are comma separated e.g.
+    # "memcache1.example.com:11211,memcache2.example.com:11211,memcache3.example.com:11211"
     def normalize_servers(servers)
-      if servers.is_a? String
-        return servers.split(",")
-      else
-        return servers
+      Array(servers).flat_map do |server|
+        if server.is_a? String
+          server.split(",")
+        else
+          server
+        end
       end
     end
 
     def ring
       @ring ||= Dalli::Ring.new(
-        @servers.map do |s|
-         server_options = {}
-          if s =~ %r{\Amemcached://}
+        @servers.map { |s|
+          server_options = {}
+          if s.start_with?("memcached://")
             uri = URI.parse(s)
             server_options[:username] = uri.user
             server_options[:password] = uri.password
             s = "#{uri.host}:#{uri.port}"
           end
-          Dalli::Server.new(s, @options.merge(server_options))
-        end, @options
+          @options.fetch(:protocol_implementation, Dalli::Protocol::Binary).new(s, @options.merge(server_options))
+        }, @options
       )
     end
 
     # Chokepoint method for instrumentation
-    def perform(*all_args, &blk)
-      return blk.call if blk
-      op, key, *args = *all_args
+    def perform(*all_args)
+      return yield if block_given?
+      op, key, *args = all_args
 
       key = key.to_s
       key = validate_key(key)
       begin
         server = ring.server_for_key(key)
-        ret = server.request(op, key, *args)
-        ret
+        server.request(op, key, *args)
       rescue NetworkError => e
         Dalli.logger.debug { e.inspect }
         Dalli.logger.debug { "retrying request with new server" }
@@ -339,10 +441,11 @@ module Dalli
       raise ArgumentError, "key cannot be blank" if !key || key.length == 0
       key = key_with_namespace(key)
       if key.length > 250
-        max_length_before_namespace = 212 - (namespace || '').size
-        key = "#{key[0, max_length_before_namespace]}:md5:#{Digest::MD5.hexdigest(key)}"
+        digest_class = @options[:digest_class] || ::Digest::MD5
+        max_length_before_namespace = 212 - (namespace || "").size
+        key = "#{key[0, max_length_before_namespace]}:md5:#{digest_class.hexdigest(key)}"
       end
-      return key
+      key
     end
 
     def key_with_namespace(key)
@@ -350,7 +453,7 @@ module Dalli
     end
 
     def key_without_namespace(key)
-      (ns = namespace) ? key.sub(%r(\A#{ns}:), '') : key
+      (ns = namespace) ? key.sub(%r{\A#{Regexp.escape ns}:}, "") : key
     end
 
     def namespace
@@ -368,6 +471,9 @@ module Dalli
       rescue NoMethodError
         raise ArgumentError, "cannot convert :expires_in => #{opts[:expires_in].inspect} to an integer"
       end
+      if opts[:digest_class] && !opts[:digest_class].respond_to?(:hexdigest)
+        raise ArgumentError, "The digest_class object must respond to the hexdigest method"
+      end
       opts
     end
 
@@ -377,56 +483,52 @@ module Dalli
       perform do
         return {} if keys.empty?
         ring.lock do
-          begin
-            groups = groups_for_keys(keys)
-            if unfound_keys = groups.delete(nil)
-              Dalli.logger.debug { "unable to get keys for #{unfound_keys.length} keys because no matching server was found" }
-            end
-            make_multi_get_requests(groups)
-
-            servers = groups.keys
-            return if servers.empty?
-            servers = perform_multi_response_start(servers)
-
-            start = Time.now
-            loop do
-              # remove any dead servers
-              servers.delete_if { |s| s.sock.nil? }
-              break if servers.empty?
-
-              # calculate remaining timeout
-              elapsed = Time.now - start
-              timeout = servers.first.options[:socket_timeout]
-              if elapsed > timeout
-                readable = nil
-              else
-                sockets = servers.map(&:sock)
-                readable, _ = IO.select(sockets, nil, nil, timeout - elapsed)
+          groups = groups_for_keys(keys)
+          if (unfound_keys = groups.delete(nil))
+            Dalli.logger.debug { "unable to get keys for #{unfound_keys.length} keys because no matching server was found" }
+          end
+          make_multi_get_requests(groups)
+
+          servers = groups.keys
+          return if servers.empty?
+          servers = perform_multi_response_start(servers)
+
+          start = Time.now
+          loop do
+            # remove any dead servers
+            servers.delete_if { |s| s.sock.nil? }
+            break if servers.empty?
+
+            # calculate remaining timeout
+            elapsed = Time.now - start
+            timeout = servers.first.options[:socket_timeout]
+            time_left = elapsed > timeout ? 0 : timeout - elapsed
+
+            sockets = servers.map(&:sock)
+            readable, _ = IO.select(sockets, nil, nil, time_left)
+
+            if readable.nil?
+              # no response within timeout; abort pending connections
+              servers.each do |server|
+                Dalli.logger.debug { "memcached at #{server.name} did not response within timeout" }
+                server.multi_response_abort
               end
+              break
 
-              if readable.nil?
-                # no response within timeout; abort pending connections
-                servers.each do |server|
-                  Dalli.logger.debug { "memcached at #{server.name} did not response within timeout" }
-                  server.multi_response_abort
-                end
-                break
-
-              else
-                readable.each do |sock|
-                  server = sock.server
+            else
+              readable.each do |sock|
+                server = sock.server
 
-                  begin
-                    server.multi_response_nonblock.each_pair do |key, value_list|
-                      yield key_without_namespace(key), value_list
-                    end
+                begin
+                  server.multi_response_nonblock.each_pair do |key, value_list|
+                    yield key_without_namespace(key), value_list
+                  end
 
-                    if server.multi_response_completed?
-                      servers.delete(server)
-                    end
-                  rescue NetworkError
+                  if server.multi_response_completed?
                     servers.delete(server)
                   end
+                rescue NetworkError
+                  servers.delete(server)
                 end
               end
             end

data/lib/dalli/compressor.rb

@@ -1,5 +1,7 @@
-require 'zlib'
-require 'stringio'
+# frozen_string_literal: true
+
+require "zlib"
+require "stringio"
 
 module Dalli
   class Compressor
@@ -14,7 +16,7 @@ module Dalli
 
   class GzipCompressor
     def self.compress(data)
-      io = StringIO.new("w")
+      io = StringIO.new(+"", "w")
       gz = Zlib::GzipWriter.new(io)
       gz.write(data)
       gz.close

data/lib/dalli/options.rb

@@ -1,12 +1,12 @@
-require 'thread'
-require 'monitor'
+# frozen_string_literal: true
 
-module Dalli
+require "monitor"
 
+module Dalli
   # Make Dalli threadsafe by using a lock around all
   # public server methods.
   #
-  # Dalli::Server.extend(Dalli::Threadsafe)
+  # Dalli::Protocol::Binary.extend(Dalli::Threadsafe)
   #
   module Threadsafe
     def self.extended(obj)