dalli 3.0.2 → 3.0.6

data/lib/dalli/socket.rb

@@ -4,56 +4,85 @@ require 'openssl'
 require 'rbconfig'
 
 module Dalli
+  ##
+  # Various socket implementations used by Dalli.
+  ##
   module Socket
+    ##
+    # Common methods for all socket implementations.
+    ##
     module InstanceMethods
-
       def readfull(count)
-        value = +""
+        value = +''
         loop do
           result = read_nonblock(count - value.bytesize, exception: false)
-          if result == :wait_readable
-            raise Timeout::Error, "IO timeout: #{safe_options.inspect}" unless IO.select([self], nil, nil, options[:socket_timeout])
-          elsif result == :wait_writable
-            raise Timeout::Error, "IO timeout: #{safe_options.inspect}" unless IO.select(nil, [self], nil, options[:socket_timeout])
-          elsif result
-            value << result
-          else
-            raise Errno::ECONNRESET, "Connection reset: #{safe_options.inspect}"
-          end
+          value << result if append_to_buffer?(result)
           break if value.bytesize == count
         end
         value
       end
 
       def read_available
-        value = +""
+        value = +''
         loop do
           result = read_nonblock(8196, exception: false)
-          if result == :wait_readable
-            break
-          elsif result == :wait_writable
-            break
-          elsif result
-            value << result
-          else
-            raise Errno::ECONNRESET, "Connection reset: #{safe_options.inspect}"
-          end
+          break if WAIT_RCS.include?(result)
+          raise Errno::ECONNRESET, "Connection reset: #{logged_options.inspect}" unless result
+
+          value << result
         end
         value
       end
 
-      def safe_options
-        options.reject { |k, v| [:username, :password].include? k }
+      WAIT_RCS = %i[wait_writable wait_readable].freeze
+
+      def append_to_buffer?(result)
+        raise Timeout::Error, "IO timeout: #{logged_options.inspect}" if nonblock_timed_out?(result)
+        raise Errno::ECONNRESET, "Connection reset: #{logged_options.inspect}" unless result
+
+        !WAIT_RCS.include?(result)
+      end
+
+      def nonblock_timed_out?(result)
+        return true if result == :wait_readable && !wait_readable(options[:socket_timeout])
+
+        # TODO: Do we actually need this?  Looks to be only used in read_nonblock
+        result == :wait_writable && !wait_writable(options[:socket_timeout])
+      end
+
+      FILTERED_OUT_OPTIONS = %i[username password].freeze
+      def logged_options
+        options.reject { |k, _| FILTERED_OUT_OPTIONS.include? k }
       end
     end
 
+    ##
+    # Wraps the below TCP socket class in the case where the client
+    # has configured a TLS/SSL connection between Dalli and the
+    # Memcached server.
+    ##
     class SSLSocket < ::OpenSSL::SSL::SSLSocket
       include Dalli::Socket::InstanceMethods
       def options
         io.options
       end
+
+      unless method_defined?(:wait_readable)
+        def wait_readable(timeout = nil)
+          to_io.wait_readable(timeout)
+        end
+      end
+
+      unless method_defined?(:wait_writable)
+        def wait_writable(timeout = nil)
+          to_io.wait_writable(timeout)
+        end
+      end
     end
 
+    ##
+    # A standard TCP socket between the Dalli client and the Memcached server.
+    ##
     class TCP < TCPSocket
       include Dalli::Socket::InstanceMethods
       attr_accessor :options, :server
@@ -61,42 +90,57 @@ module Dalli
       def self.open(host, port, server, options = {})
         Timeout.timeout(options[:socket_timeout]) do
           sock = new(host, port)
-          sock.options = {host: host, port: port}.merge(options)
+          sock.options = { host: host, port: port }.merge(options)
           sock.server = server
-          sock.setsockopt(::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY, true)
-          sock.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_KEEPALIVE, true) if options[:keepalive]
-          sock.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_RCVBUF, options[:rcvbuf]) if options[:rcvbuf]
-          sock.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_SNDBUF, options[:sndbuf]) if options[:sndbuf]
-
-          return sock unless options[:ssl_context]
-
-          ssl_socket = Dalli::Socket::SSLSocket.new(sock, options[:ssl_context])
-          ssl_socket.hostname = host
-          ssl_socket.sync_close = true
-          ssl_socket.connect
-          ssl_socket
+          init_socket_options(sock, options)
+
+          options[:ssl_context] ? wrapping_ssl_socket(sock, host, options[:ssl_context]) : sock
         end
       end
-    end
-  end
 
-  if RbConfig::CONFIG['host_os'] =~ /mingw|mswin/
-    class Dalli::Socket::UNIX
-      def initialize(*args)
-        raise Dalli::DalliError, 'Unix sockets are not supported on Windows platform.'
+      def self.init_socket_options(sock, options)
+        sock.setsockopt(::Socket::IPPROTO_TCP, ::Socket::TCP_NODELAY, true)
+        sock.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_KEEPALIVE, true) if options[:keepalive]
+        sock.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_RCVBUF, options[:rcvbuf]) if options[:rcvbuf]
+        sock.setsockopt(::Socket::SOL_SOCKET, ::Socket::SO_SNDBUF, options[:sndbuf]) if options[:sndbuf]
+      end
+
+      def self.wrapping_ssl_socket(tcp_socket, host, ssl_context)
+        ssl_socket = Dalli::Socket::SSLSocket.new(tcp_socket, ssl_context)
+        ssl_socket.hostname = host
+        ssl_socket.sync_close = true
+        ssl_socket.connect
+        ssl_socket
       end
     end
-  else
-    class Dalli::Socket::UNIX < UNIXSocket
-      include Dalli::Socket::InstanceMethods
-      attr_accessor :options, :server
 
-      def self.open(path, server, options = {})
-        Timeout.timeout(options[:socket_timeout]) do
-          sock = new(path)
-          sock.options = {path: path}.merge(options)
-          sock.server = server
-          sock
+    if /mingw|mswin/.match?(RbConfig::CONFIG['host_os'])
+      ##
+      # UNIX domain sockets are not supported on Windows platforms.
+      ##
+      class UNIX
+        def initialize(*_args)
+          raise Dalli::DalliError, 'Unix sockets are not supported on Windows platform.'
+        end
+      end
+    else
+
+      ##
+      # UNIX represents a UNIX domain socket, which is an interprocess communication
+      # mechanism between processes on the same host.  Used when the Memcached server
+      # is running on the same machine as the Dalli client.
+      ##
+      class UNIX < UNIXSocket
+        include Dalli::Socket::InstanceMethods
+        attr_accessor :options, :server
+
+        def self.open(path, server, options = {})
+          Timeout.timeout(options[:socket_timeout]) do
+            sock = new(path)
+            sock.options = { path: path }.merge(options)
+            sock.server = server
+            sock
+          end
         end
       end
     end

data/lib/dalli/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
 module Dalli
-  VERSION = "3.0.2"
+  VERSION = '3.0.6'
+
+  MIN_SUPPORTED_MEMCACHED_VERSION = '1.4'
 end

data/lib/dalli.rb

@@ -1,30 +1,33 @@
 # frozen_string_literal: true
 
-require "dalli/compressor"
-require "dalli/client"
-require "dalli/ring"
-require "dalli/protocol"
-require "dalli/protocol/binary"
-require "dalli/socket"
-require "dalli/version"
-require "dalli/options"
-
+##
+# Namespace for all Dalli code.
+##
 module Dalli
-  autoload :Server, "dalli/server"
+  autoload :Server, 'dalli/server'
 
   # generic error
   class DalliError < RuntimeError; end
+
   # socket/server communication error
   class NetworkError < DalliError; end
+
   # no server available/alive error
   class RingError < DalliError; end
+
   # application error in marshalling serialization
   class MarshalError < DalliError; end
+
   # application error in marshalling deserialization or decompression
   class UnmarshalError < DalliError; end
+
   # payload too big for memcached
   class ValueOverMaxSize < DalliError; end
 
+  # Implements the NullObject pattern to store an application-defined value for 'Key not found' responses.
+  class NilObject; end # rubocop:disable Lint/EmptyClass
+  NOT_FOUND = NilObject.new
+
   def self.logger
     @logger ||= (rails_logger || default_logger)
   end
@@ -35,7 +38,7 @@ module Dalli
   end
 
   def self.default_logger
-    require "logger"
+    require 'logger'
     l = Logger.new($stdout)
     l.level = Logger::INFO
     l
@@ -45,3 +48,20 @@ module Dalli
     @logger = logger
   end
 end
+
+require_relative 'dalli/version'
+
+require_relative 'dalli/compressor'
+require_relative 'dalli/client'
+require_relative 'dalli/key_manager'
+require_relative 'dalli/ring'
+require_relative 'dalli/protocol'
+require_relative 'dalli/protocol/binary'
+require_relative 'dalli/protocol/server_config_parser'
+require_relative 'dalli/protocol/ttl_sanitizer'
+require_relative 'dalli/protocol/value_compressor'
+require_relative 'dalli/protocol/value_marshaller'
+require_relative 'dalli/protocol/value_serializer'
+require_relative 'dalli/servers_arg_normalizer'
+require_relative 'dalli/socket'
+require_relative 'dalli/options'

data/lib/rack/session/dalli.rb

@@ -1,17 +1,23 @@
 # frozen_string_literal: true
+
 require 'rack/session/abstract/id'
 require 'dalli'
 require 'connection_pool'
+require 'English'
 
 module Rack
   module Session
+    # Rack::Session::Dalli provides memcached based session management.
     class Dalli < Abstract::Persisted
       attr_reader :pool
 
+      # Don't freeze this until we fix the specs/implementation
+      # rubocop:disable Style/MutableConstant
       DEFAULT_DALLI_OPTIONS = {
-        :namespace => 'rack:session',
-        :memcache_server => 'localhost:11211'
+        namespace: 'rack:session',
+        memcache_server: 'localhost:11211'
       }
+      # rubocop:enable Style/MutableConstant
 
       # Brings in a new Rack::Session::Dalli middleware with the given
       # `:memcache_server`. The server is either a hostname, or a
@@ -67,7 +73,7 @@ module Rack
       # for more information about it and its default options (which would only
       # be applicable if you supplied one of the two options, but not both).
       #
-      def initialize(app, options={})
+      def initialize(app, options = {})
         # Parent uses DEFAULT_OPTIONS to build @default_options for Rack::Session
         super
 
@@ -80,10 +86,12 @@ module Rack
         @pool = ConnectionPool.new(popts || {}) { ::Dalli::Client.new(mserv, mopts) }
       end
 
-      def get_session(env, sid)
+      def get_session(_env, sid)
         with_block([nil, {}]) do |dc|
-          unless sid and !sid.empty? and session = dc.get(sid)
-            old_sid, sid, session = sid, generate_sid_with(dc), {}
+          unless sid && !sid.empty? && (session = dc.get(sid))
+            old_sid = sid
+            sid = generate_sid_with(dc)
+            session = {}
             unless dc.add(sid, session, @default_ttl)
               sid = old_sid
               redo # generate a new sid and try again
@@ -93,7 +101,7 @@ module Rack
         end
       end
 
-      def set_session(env, session_id, new_session, options)
+      def set_session(_env, session_id, new_session, options)
         return false unless session_id
 
         with_block(false) do |dc|
@@ -102,7 +110,7 @@ module Rack
         end
       end
 
-      def destroy_session(env, session_id, options)
+      def destroy_session(_env, session_id, options)
         with_block do |dc|
           dc.delete(session_id)
           generate_sid_with(dc) unless options[:drop]
@@ -124,14 +132,15 @@ module Rack
       private
 
       def extract_dalli_options(options)
-        raise "Rack::Session::Dalli no longer supports the :cache option." if options[:cache]
+        raise 'Rack::Session::Dalli no longer supports the :cache option.' if options[:cache]
 
-        popts = {}
         # Filter out Rack::Session-specific options and apply our defaults
-        mopts = DEFAULT_DALLI_OPTIONS.merge \
-          options.reject {|k, _| DEFAULT_OPTIONS.key? k }
+        # Filter out Rack::Session-specific options and apply our defaults
+        filtered_opts = options.reject { |k, _| DEFAULT_OPTIONS.key? k }
+        mopts = DEFAULT_DALLI_OPTIONS.merge(filtered_opts)
         mserv = mopts.delete :memcache_server
 
+        popts = {}
         if mopts[:pool_size] || mopts[:pool_timeout]
           popts[:size] = mopts.delete :pool_size if mopts[:pool_size]
           popts[:timeout] = mopts.delete :pool_timeout if mopts[:pool_timeout]
@@ -141,20 +150,21 @@ module Rack
         [mserv, mopts, popts]
       end
 
-      def generate_sid_with(dc)
-        while true
+      def generate_sid_with(client)
+        loop do
           sid = generate_sid
-          break sid unless dc.get(sid)
+          break sid unless client.get(sid)
         end
       end
 
-      def with_block(default=nil, &block)
+      def with_block(default = nil, &block)
         @pool.with(&block)
       rescue ::Dalli::DalliError, Errno::ECONNREFUSED
-        raise if $!.message =~ /undefined class/
+        raise if /undefined class/.match?($ERROR_INFO.message)
+
         if $VERBOSE
           warn "#{self} is unable to find memcached server."
-          warn $!.inspect
+          warn $ERROR_INFO.inspect
         end
         default
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dalli
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.0.6
 platform: ruby
 authors:
 - Peter M. Goldstein
@@ -9,8 +9,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-15 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -26,7 +40,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: connection_pool
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -40,7 +68,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: openssl-extensions
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -69,18 +111,29 @@ files:
 - lib/dalli/cas/client.rb
 - lib/dalli/client.rb
 - lib/dalli/compressor.rb
+- lib/dalli/key_manager.rb
 - lib/dalli/options.rb
 - lib/dalli/protocol.rb
 - lib/dalli/protocol/binary.rb
+- lib/dalli/protocol/binary/request_formatter.rb
+- lib/dalli/protocol/binary/response_processor.rb
+- lib/dalli/protocol/binary/sasl_authentication.rb
+- lib/dalli/protocol/server_config_parser.rb
+- lib/dalli/protocol/ttl_sanitizer.rb
+- lib/dalli/protocol/value_compressor.rb
+- lib/dalli/protocol/value_marshaller.rb
+- lib/dalli/protocol/value_serializer.rb
 - lib/dalli/ring.rb
 - lib/dalli/server.rb
+- lib/dalli/servers_arg_normalizer.rb
 - lib/dalli/socket.rb
 - lib/dalli/version.rb
 - lib/rack/session/dalli.rb
 homepage: https://github.com/petergoldstein/dalli
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -89,14 +142,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.29
+rubygems_version: 3.2.31
 signing_key:
 specification_version: 4
 summary: High performance memcached client for Ruby