dalli 3.1.1 → 3.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89dd04ff2b4fd6812f2fae613cc984c7d34029a2637ebf5c11d5398361fa7993
-  data.tar.gz: caf5ad6315ddb803ba61418d189c99ce7849f1acced49cf6e32e78e5ca35817f
+  metadata.gz: '0905b56adf194401de7755ab22ebef6b57f6e673e8332f7cb99b3ef9ed1dde63'
+  data.tar.gz: dac2014c748ef0c55fe171af0cec8dec807ae2468f758338c8968135acd47b92
 SHA512:
-  metadata.gz: e425b9704308ce7f3737c7e07dcd2699448ba173fd8fa3ac1e9d3d8867890ce1029dd69f98fb4856bab6c8d81685d34be1c41a192039fccb631c2d4b4749b85a
-  data.tar.gz: 0afdb9aa3fde689a6b84b72aa44aa228e23994f747cce60f8a3471f250a7fa60fdbb3481e4ab4f2665de80be4799b3294f308bb86efa815867e121cd7dc223c9
+  metadata.gz: 85d8382dfd13c2353a61c74525e17bd81e000308e8d476851ed25fdb6ef81e9aff4276eb0b1484e30c83001301a3500140cb46a595081e1b21f0801ea32d7e28
+  data.tar.gz: 7f0adfc09e31d435bbb3f6cff2f65392a58f81697e7025ca71d9423f9a536d9c984ed7ba0742d0c0f5de0e865a7ebd2dc5548a0406c86d7f1fe0c8135c7af363

data/History.md

@@ -4,6 +4,16 @@ Dalli Changelog
 Unreleased
 ==========
 
+3.1.3
+==========
+
+- Restore falsey behavior on delete/delete_cas for nonexistent key (petergoldstein)
+
+3.1.2
+==========
+
+- Make quiet? / multi? public on Dalli::Protocol::Binary (petergoldstein)
+
 3.1.1
 ==========
 

data/lib/dalli/protocol/base.rb

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'socket'
+require 'timeout'
+
+module Dalli
+  module Protocol
+    ##
+    # Base class for a single Memcached server, containing logic common to all
+    # protocols.  Contains logic for managing connection state to the server and value
+    # handling.
+    ##
+    class Base
+      extend Forwardable
+
+      attr_accessor :weight, :options
+
+      def_delegators :@value_marshaller, :serializer, :compressor, :compression_min_size, :compress_by_default?
+      def_delegators :@connection_manager, :name, :sock, :hostname, :port, :close, :connected?, :socket_timeout,
+                     :socket_type, :up!, :down!, :write, :reconnect_down_server?, :raise_down_error
+
+      def initialize(attribs, client_options = {})
+        hostname, port, socket_type, @weight, user_creds = ServerConfigParser.parse(attribs)
+        @options = client_options.merge(user_creds)
+        @value_marshaller = ValueMarshaller.new(@options)
+        @connection_manager = ConnectionManager.new(hostname, port, socket_type, @options)
+      end
+
+      # Chokepoint method for error handling and ensuring liveness
+      def request(opkey, *args)
+        verify_state(opkey)
+
+        begin
+          send(opkey, *args)
+        rescue Dalli::MarshalError => e
+          log_marshal_err(args.first, e)
+          raise
+        rescue Dalli::DalliError
+          raise
+        rescue StandardError => e
+          log_unexpected_err(e)
+          down!
+        end
+      end
+
+      ##
+      # Boolean method used by clients of this class to determine if this
+      # particular memcached instance is available for use.
+      def alive?
+        ensure_connected!
+      rescue Dalli::NetworkError
+        # ensure_connected! raises a NetworkError if connection fails.  We
+        # want to capture that error and convert it to a boolean value here.
+        false
+      end
+
+      def lock!; end
+
+      def unlock!; end
+
+      # Start reading key/value pairs from this connection. This is usually called
+      # after a series of GETKQ commands. A NOOP is sent, and the server begins
+      # flushing responses for kv pairs that were found.
+      #
+      # Returns nothing.
+      def pipeline_response_setup
+        verify_state(:getkq)
+        write_noop
+        response_buffer.reset
+        @connection_manager.start_request!
+      end
+
+      # Attempt to receive and parse as many key/value pairs as possible
+      # from this server. After #pipeline_response_setup, this should be invoked
+      # repeatedly whenever this server's socket is readable until
+      # #pipeline_complete?.
+      #
+      # Returns a Hash of kv pairs received.
+      def pipeline_next_responses
+        reconnect_on_pipeline_complete!
+        values = {}
+
+        response_buffer.read
+
+        resp_header, key, value = pipeline_response
+        # resp_header is not nil only if we have a full response to parse
+        # in the buffer
+        while resp_header
+          # If the status is ok and key is nil, then this is the response
+          # to the noop at the end of the pipeline
+          finish_pipeline && break if resp_header.ok? && key.nil?
+
+          # If the status is ok and the key is not nil, then this is a
+          # getkq response with a value that we want to set in the response hash
+          values[key] = [value, resp_header.cas] unless key.nil?
+
+          # Get the next response from the buffer
+          resp_header, key, value = pipeline_response
+        end
+
+        values
+      rescue SystemCallError, Timeout::Error, EOFError => e
+        @connection_manager.error_on_request!(e)
+      end
+
+      # Abort current pipelined get. Generally used to signal an external
+      # timeout during pipelined get.  The underlying socket is
+      # disconnected, and the exception is swallowed.
+      #
+      # Returns nothing.
+      def pipeline_abort
+        response_buffer.clear
+        @connection_manager.abort_request!
+        return true unless connected?
+
+        # Closes the connection, which ensures that our connection
+        # is in a clean state for future requests
+        @connection_manager.error_on_request!('External timeout')
+      rescue NetworkError
+        true
+      end
+
+      # Did the last call to #pipeline_response_setup complete successfully?
+      def pipeline_complete?
+        !response_buffer.in_progress?
+      end
+
+      def username
+        @options[:username] || ENV['MEMCACHE_USERNAME']
+      end
+
+      def password
+        @options[:password] || ENV['MEMCACHE_PASSWORD']
+      end
+
+      def require_auth?
+        !username.nil?
+      end
+
+      def quiet?
+        Thread.current[::Dalli::QUIET]
+      end
+      alias multi? quiet?
+
+      # NOTE: Additional public methods should be overridden in Dalli::Threadsafe
+
+      private
+
+      ##
+      # Checks to see if we can execute the specified operation.  Checks
+      # whether the connection is in use, and whether the command is allowed
+      ##
+      def verify_state(opkey)
+        @connection_manager.confirm_ready!
+        verify_allowed_quiet!(opkey) if quiet?
+
+        # The ensure_connected call has the side effect of connecting the
+        # underlying socket if it is not connected, or there's been a disconnect
+        # because of timeout or other error.  Method raises an error
+        # if it can't connect
+        raise_down_error unless ensure_connected!
+      end
+
+      # The socket connection to the underlying server is initialized as a side
+      # effect of this call.  In fact, this is the ONLY place where that
+      # socket connection is initialized.
+      #
+      # Both this method and connect need to be in this class so we can do auth
+      # as required
+      #
+      # Since this is invoked exclusively in verify_state!, we don't need to worry about
+      # thread safety.  Using it elsewhere may require revisiting that assumption.
+      def ensure_connected!
+        return true if connected?
+        return false unless reconnect_down_server?
+
+        connect # This call needs to be in this class so we can do auth
+        connected?
+      end
+
+      def cache_nils?(opts)
+        return false unless opts.is_a?(Hash)
+
+        opts[:cache_nils] ? true : false
+      end
+
+      def connect
+        @connection_manager.establish_connection
+        authenticate_connection if require_auth?
+        @version = version # Connect socket if not authed
+        up!
+      rescue Dalli::DalliError
+        raise
+      end
+
+      def pipelined_get(keys)
+        req = +''
+        keys.each do |key|
+          req << quiet_get_request(key)
+        end
+        # Could send noop here instead of in pipeline_response_setup
+        write(req)
+      end
+
+      def response_buffer
+        @response_buffer ||= ResponseBuffer.new(@connection_manager, response_processor)
+      end
+
+      def pipeline_response
+        response_buffer.process_single_getk_response
+      end
+
+      # Called after the noop response is received at the end of a set
+      # of pipelined gets
+      def finish_pipeline
+        response_buffer.clear
+        @connection_manager.finish_request!
+
+        true # to simplify response
+      end
+
+      def reconnect_on_pipeline_complete!
+        @connection_manager.reconnect! 'pipelined get has completed' if pipeline_complete?
+      end
+
+      def log_marshal_err(key, err)
+        Dalli.logger.error "Marshalling error for key '#{key}': #{err.message}"
+        Dalli.logger.error 'You are trying to cache a Ruby object which cannot be serialized to memcached.'
+      end
+
+      def log_unexpected_err(err)
+        Dalli.logger.error "Unexpected exception during Dalli request: #{err.class.name}: #{err.message}"
+        Dalli.logger.error err.backtrace.join("\n\t")
+      end
+    end
+  end
+end

data/lib/dalli/protocol/binary/response_processor.rb

@@ -89,6 +89,14 @@ module Dalli
           resp_header.cas
         end
 
+        def delete_response
+          resp_header, = read_response
+          return false if resp_header.not_found? || resp_header.not_stored?
+
+          raise_on_not_ok!(resp_header)
+          true
+        end
+
         def no_body_response
           resp_header, = read_response
           return false if resp_header.not_stored? # Not stored, possible status for append/prepend

data/lib/dalli/protocol/binary/sasl_authentication.rb

@@ -10,7 +10,7 @@ module Dalli
         def perform_auth_negotiation
           write(RequestFormatter.standard_request(opkey: :auth_negotiation))
 
-          status, content = @response_processor.auth_response
+          status, content = response_processor.auth_response
           return [status, []] if content.nil?
 
           # Substitute spaces for the \x00 returned by

data/lib/dalli/protocol/binary.rb

@@ -4,11 +4,6 @@ require 'forwardable'
 require 'socket'
 require 'timeout'
 
-require_relative 'binary/request_formatter'
-require_relative 'binary/response_header'
-require_relative 'binary/response_processor'
-require_relative 'binary/sasl_authentication'
-
 module Dalli
   module Protocol
     ##
@@ -16,170 +11,13 @@ module Dalli
     # protocol.  Contains logic for managing connection state to the server (retries, etc),
     # formatting requests to the server, and unpacking responses.
     ##
-    class Binary
-      extend Forwardable
-
-      attr_accessor :weight, :options
-
-      def_delegators :@value_marshaller, :serializer, :compressor, :compression_min_size, :compress_by_default?
-      def_delegators :@connection_manager, :name, :sock, :hostname, :port, :close, :connected?, :socket_timeout,
-                     :socket_type, :up!, :down!, :write, :reconnect_down_server?, :raise_down_error
-
-      def initialize(attribs, client_options = {})
-        hostname, port, socket_type, @weight, user_creds = ServerConfigParser.parse(attribs)
-        @options = client_options.merge(user_creds)
-        @value_marshaller = ValueMarshaller.new(@options)
-        @connection_manager = ConnectionManager.new(hostname, port, socket_type, @options)
-        @response_processor = ResponseProcessor.new(@connection_manager, @value_marshaller)
-      end
-
-      # Chokepoint method for error handling and ensuring liveness
-      def request(opkey, *args)
-        verify_state(opkey)
-
-        begin
-          send(opkey, *args)
-        rescue Dalli::MarshalError => e
-          log_marshal_err(args.first, e)
-          raise
-        rescue Dalli::DalliError
-          raise
-        rescue StandardError => e
-          log_unexpected_err(e)
-          down!
-        end
-      end
-
-      ##
-      # Boolean method used by clients of this class to determine if this
-      # particular memcached instance is available for use.
-      def alive?
-        ensure_connected!
-      rescue Dalli::NetworkError
-        # ensure_connected! raises a NetworkError if connection fails.  We
-        # want to capture that error and convert it to a boolean value here.
-        false
-      end
-
-      def lock!; end
-
-      def unlock!; end
-
-      # Start reading key/value pairs from this connection. This is usually called
-      # after a series of GETKQ commands. A NOOP is sent, and the server begins
-      # flushing responses for kv pairs that were found.
-      #
-      # Returns nothing.
-      def pipeline_response_setup
-        verify_state(:getkq)
-        write_noop
-        response_buffer.reset
-        @connection_manager.start_request!
-      end
-
-      # Attempt to receive and parse as many key/value pairs as possible
-      # from this server. After #pipeline_response_setup, this should be invoked
-      # repeatedly whenever this server's socket is readable until
-      # #pipeline_complete?.
-      #
-      # Returns a Hash of kv pairs received.
-      def pipeline_next_responses
-        reconnect_on_pipeline_complete!
-        values = {}
-
-        response_buffer.read
-
-        resp_header, key, value = pipeline_response
-        # resp_header is not nil only if we have a full response to parse
-        # in the buffer
-        while resp_header
-          # If the status is ok and key is nil, then this is the response
-          # to the noop at the end of the pipeline
-          finish_pipeline && break if resp_header.ok? && key.nil?
-
-          # If the status is ok and the key is not nil, then this is a
-          # getkq response with a value that we want to set in the response hash
-          values[key] = [value, resp_header.cas] unless key.nil?
-
-          # Get the next response from the buffer
-          resp_header, key, value = pipeline_response
-        end
-
-        values
-      rescue SystemCallError, Timeout::Error, EOFError => e
-        @connection_manager.error_on_request!(e)
-      end
-
-      # Abort current pipelined get. Generally used to signal an external
-      # timeout during pipelined get.  The underlying socket is
-      # disconnected, and the exception is swallowed.
-      #
-      # Returns nothing.
-      def pipeline_abort
-        response_buffer.clear
-        @connection_manager.abort_request!
-        return true unless connected?
-
-        # Closes the connection, which ensures that our connection
-        # is in a clean state for future requests
-        @connection_manager.error_on_request!('External timeout')
-      rescue NetworkError
-        true
-      end
-
-      # Did the last call to #pipeline_response_setup complete successfully?
-      def pipeline_complete?
-        !response_buffer.in_progress?
-      end
-
-      def username
-        @options[:username] || ENV['MEMCACHE_USERNAME']
-      end
-
-      def password
-        @options[:password] || ENV['MEMCACHE_PASSWORD']
-      end
-
-      def require_auth?
-        !username.nil?
+    class Binary < Base
+      def response_processor
+        @response_processor ||= ResponseProcessor.new(@connection_manager, @value_marshaller)
       end
 
-      # NOTE: Additional public methods should be overridden in Dalli::Threadsafe
-
       private
 
-      ##
-      # Checks to see if we can execute the specified operation.  Checks
-      # whether the connection is in use, and whether the command is allowed
-      ##
-      def verify_state(opkey)
-        @connection_manager.confirm_ready!
-        verify_allowed_quiet!(opkey) if quiet?
-
-        # The ensure_connected call has the side effect of connecting the
-        # underlying socket if it is not connected, or there's been a disconnect
-        # because of timeout or other error.  Method raises an error
-        # if it can't connect
-        raise_down_error unless ensure_connected!
-      end
-
-      # The socket connection to the underlying server is initialized as a side
-      # effect of this call.  In fact, this is the ONLY place where that
-      # socket connection is initialized.
-      #
-      # Both this method and connect need to be in this class so we can do auth
-      # as required
-      #
-      # Since this is invoked exclusively in verify_state!, we don't need to worry about
-      # thread safety.  Using it elsewhere may require revisiting that assumption.
-      def ensure_connected!
-        return true if connected?
-        return false unless reconnect_down_server?
-
-        connect # This call needs to be in this class so we can do auth
-        connected?
-      end
-
       ALLOWED_QUIET_OPS = %i[add replace set delete incr decr append prepend flush noop].freeze
       def verify_allowed_quiet!(opkey)
         return if ALLOWED_QUIET_OPS.include?(opkey)
@@ -187,34 +25,28 @@ module Dalli
         raise Dalli::NotPermittedMultiOpError, "The operation #{opkey} is not allowed in a quiet block."
       end
 
-      def quiet?
-        Thread.current[::Dalli::QUIET]
-      end
-
-      def cache_nils?(opts)
-        return false unless opts.is_a?(Hash)
-
-        opts[:cache_nils] ? true : false
-      end
-
       # Retrieval Commands
       def get(key, options = nil)
         req = RequestFormatter.standard_request(opkey: :get, key: key)
         write(req)
-        @response_processor.generic_response(unpack: true, cache_nils: cache_nils?(options))
+        response_processor.generic_response(unpack: true, cache_nils: cache_nils?(options))
+      end
+
+      def quiet_get_request(key)
+        RequestFormatter.standard_request(opkey: :getkq, key: key)
       end
 
       def gat(key, ttl, options = nil)
         ttl = TtlSanitizer.sanitize(ttl)
         req = RequestFormatter.standard_request(opkey: :gat, key: key, ttl: ttl)
         write(req)
-        @response_processor.generic_response(unpack: true, cache_nils: cache_nils?(options))
+        response_processor.generic_response(unpack: true, cache_nils: cache_nils?(options))
       end
 
       def touch(key, ttl)
         ttl = TtlSanitizer.sanitize(ttl)
         write(RequestFormatter.standard_request(opkey: :touch, key: key, ttl: ttl))
-        @response_processor.generic_response
+        response_processor.generic_response
       end
 
       # TODO: This is confusing, as there's a cas command in memcached
@@ -222,7 +54,7 @@ module Dalli
       def cas(key)
         req = RequestFormatter.standard_request(opkey: :get, key: key)
         write(req)
-        @response_processor.data_cas_response
+        response_processor.data_cas_response
       end
 
       # Storage Commands
@@ -250,7 +82,7 @@ module Dalli
                                                 value: value, bitflags: bitflags,
                                                 ttl: ttl, cas: cas)
         write(req)
-        @response_processor.storage_response unless quiet?
+        response_processor.storage_response unless quiet?
       end
       # rubocop:enable Metrics/ParameterLists
 
@@ -266,7 +98,7 @@ module Dalli
 
       def write_append_prepend(opkey, key, value)
         write(RequestFormatter.standard_request(opkey: opkey, key: key, value: value))
-        @response_processor.no_body_response unless quiet?
+        response_processor.no_body_response unless quiet?
       end
 
       # Delete Commands
@@ -274,7 +106,7 @@ module Dalli
         opkey = quiet? ? :deleteq : :delete
         req = RequestFormatter.standard_request(opkey: opkey, key: key, cas: cas)
         write(req)
-        @response_processor.no_body_response unless quiet?
+        response_processor.delete_response unless quiet?
       end
 
       # Arithmetic Commands
@@ -300,37 +132,37 @@ module Dalli
         initial ||= 0
         write(RequestFormatter.decr_incr_request(opkey: opkey, key: key,
                                                  count: count, initial: initial, expiry: expiry))
-        @response_processor.decr_incr_response unless quiet?
+        response_processor.decr_incr_response unless quiet?
       end
 
       # Other Commands
       def flush(ttl = 0)
         opkey = quiet? ? :flushq : :flush
         write(RequestFormatter.standard_request(opkey: opkey, ttl: ttl))
-        @response_processor.no_body_response unless quiet?
+        response_processor.no_body_response unless quiet?
       end
 
       # Noop is a keepalive operation but also used to demarcate the end of a set of pipelined commands.
       # We need to read all the responses at once.
       def noop
         write_noop
-        @response_processor.multi_with_keys_response
+        response_processor.multi_with_keys_response
       end
 
       def stats(info = '')
         req = RequestFormatter.standard_request(opkey: :stat, key: info)
         write(req)
-        @response_processor.multi_with_keys_response
+        response_processor.multi_with_keys_response
       end
 
       def reset_stats
         write(RequestFormatter.standard_request(opkey: :stat, key: 'reset'))
-        @response_processor.generic_response
+        response_processor.generic_response
       end
 
       def version
         write(RequestFormatter.standard_request(opkey: :version))
-        @response_processor.generic_response
+        response_processor.generic_response
       end
 
       def write_noop
@@ -338,55 +170,10 @@ module Dalli
         write(req)
       end
 
-      def connect
-        @connection_manager.establish_connection
-        authenticate_connection if require_auth?
-        @version = version # Connect socket if not authed
-        up!
-      rescue Dalli::DalliError
-        raise
-      end
-
-      def pipelined_get(keys)
-        req = +''
-        keys.each do |key|
-          req << RequestFormatter.standard_request(opkey: :getkq, key: key)
-        end
-        # Could send noop here instead of in pipeline_response_setup
-        write(req)
-      end
-
-      def response_buffer
-        @response_buffer ||= ResponseBuffer.new(@connection_manager, @response_processor)
-      end
-
-      def pipeline_response
-        response_buffer.process_single_getk_response
-      end
-
-      # Called after the noop response is received at the end of a set
-      # of pipelined gets
-      def finish_pipeline
-        response_buffer.clear
-        @connection_manager.finish_request!
-
-        true # to simplify response
-      end
-
-      def reconnect_on_pipeline_complete!
-        @connection_manager.reconnect! 'pipelined get has completed' if pipeline_complete?
-      end
-
-      def log_marshal_err(key, err)
-        Dalli.logger.error "Marshalling error for key '#{key}': #{err.message}"
-        Dalli.logger.error 'You are trying to cache a Ruby object which cannot be serialized to memcached.'
-      end
-
-      def log_unexpected_err(err)
-        Dalli.logger.error "Unexpected exception during Dalli request: #{err.class.name}: #{err.message}"
-        Dalli.logger.error err.backtrace.join("\n\t")
-      end
-
+      require_relative 'binary/request_formatter'
+      require_relative 'binary/response_header'
+      require_relative 'binary/response_processor'
+      require_relative 'binary/sasl_authentication'
       include SaslAuthentication
     end
   end

data/lib/dalli/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Dalli
-  VERSION = '3.1.1'
+  VERSION = '3.1.3'
 
   MIN_SUPPORTED_MEMCACHED_VERSION = '1.4'
 end

data/lib/dalli.rb

@@ -62,6 +62,7 @@ require_relative 'dalli/key_manager'
 require_relative 'dalli/pipelined_getter'
 require_relative 'dalli/ring'
 require_relative 'dalli/protocol'
+require_relative 'dalli/protocol/base'
 require_relative 'dalli/protocol/binary'
 require_relative 'dalli/protocol/connection_manager'
 require_relative 'dalli/protocol/response_buffer'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dalli
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.3
 platform: ruby
 authors:
 - Peter M. Goldstein
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-10 00:00:00.000000000 Z
+date: 2021-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -121,6 +121,7 @@ files:
 - lib/dalli/options.rb
 - lib/dalli/pipelined_getter.rb
 - lib/dalli/protocol.rb
+- lib/dalli/protocol/base.rb
 - lib/dalli/protocol/binary.rb
 - lib/dalli/protocol/binary/request_formatter.rb
 - lib/dalli/protocol/binary/response_header.rb
@@ -159,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.2.31
 signing_key:
 specification_version: 4
 summary: High performance memcached client for Ruby