dalli 2.7.0 → 2.7.11

data/lib/dalli/socket.rb

@@ -1,3 +1,15 @@
+# frozen_string_literal: true
+require 'rbconfig'
+
+module Dalli::Server::TCPSocketOptions
+  def setsockopts(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
+end
+
 begin
   require 'kgio'
   puts "Using kgio socket IO" if defined?($TESTING) && $TESTING
@@ -13,22 +25,11 @@ begin
       IO.select(nil, [self], nil, options[:socket_timeout]) || raise(Timeout::Error, "IO timeout")
     end
 
-    def self.open(host, port, server, options = {})
-      addr = Socket.pack_sockaddr_in(port, host)
-      sock = start(addr)
-      sock.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, true)
-      sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true) if options[:keepalive]
-      sock.options = options
-      sock.server = server
-      sock.kgio_wait_writable
-      sock
-    end
-
     alias :write :kgio_write
 
     def readfull(count)
-      value = ''
-      loop do
+      value = String.new('')
+      while true
         value << kgio_read!(count - value.bytesize)
         break if value.bytesize == count
       end
@@ -36,8 +37,8 @@ begin
     end
 
     def read_available
-      value = ''
-      loop do
+      value = String.new('')
+      while true
         ret = kgio_tryread(8196)
         case ret
         when nil
@@ -50,7 +51,37 @@ begin
       end
       value
     end
+  end
 
+  class Dalli::Server::KSocket::TCP < Dalli::Server::KSocket
+    extend Dalli::Server::TCPSocketOptions
+
+    def self.open(host, port, server, options = {})
+      addr = Socket.pack_sockaddr_in(port, host)
+      sock = start(addr)
+      setsockopts(sock, options)
+      sock.options = options
+      sock.server = server
+      sock.kgio_wait_writable
+      sock
+    rescue Timeout::Error
+      sock.close if sock
+      raise
+    end
+  end
+
+  class Dalli::Server::KSocket::UNIX < Dalli::Server::KSocket
+    def self.open(path, server, options = {})
+      addr = Socket.pack_sockaddr_un(path)
+      sock = start(addr)
+      sock.options = options
+      sock.server = server
+      sock.kgio_wait_writable
+      sock
+    rescue Timeout::Error
+      sock.close if sock
+      raise
+    end
   end
 
   if ::Kgio.respond_to?(:wait_readable=)
@@ -61,47 +92,78 @@ begin
 rescue LoadError
 
   puts "Using standard socket IO (#{RUBY_DESCRIPTION})" if defined?($TESTING) && $TESTING
-  class Dalli::Server::KSocket < TCPSocket
-    attr_accessor :options, :server
+  module Dalli::Server::KSocket
+    module InstanceMethods
+      def readfull(count)
+        value = String.new('')
+        begin
+          while true
+            value << read_nonblock(count - value.bytesize)
+            break if value.bytesize == count
+          end
+        rescue Errno::EAGAIN, Errno::EWOULDBLOCK
+          if IO.select([self], nil, nil, options[:socket_timeout])
+            retry
+          else
+            safe_options = options.reject{|k,v| [:username, :password].include? k}
+            raise Timeout::Error, "IO timeout: #{safe_options.inspect}"
+          end
+        end
+        value
+      end
+
+      def read_available
+        value = String.new('')
+        while true
+          begin
+            value << read_nonblock(8196)
+          rescue Errno::EAGAIN, Errno::EWOULDBLOCK
+            break
+          end
+        end
+        value
+      end
+    end
+
+    def self.included(receiver)
+      receiver.send(:attr_accessor, :options, :server)
+      receiver.send(:include, InstanceMethods)
+    end
+  end
+
+  class Dalli::Server::KSocket::TCP < TCPSocket
+    extend Dalli::Server::TCPSocketOptions
+    include Dalli::Server::KSocket
 
     def self.open(host, port, server, options = {})
       Timeout.timeout(options[:socket_timeout]) do
         sock = new(host, port)
-        sock.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, true)
-        sock.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true) if options[:keepalive]
-        sock.options = { :host => host, :port => port }.merge(options)
+        setsockopts(sock, options)
+        sock.options = {:host => host, :port => port}.merge(options)
         sock.server = server
         sock
       end
     end
+  end
 
-    def readfull(count)
-      value = ''
-      begin
-        loop do
-          value << read_nonblock(count - value.bytesize)
-          break if value.bytesize == count
-        end
-      rescue Errno::EAGAIN, Errno::EWOULDBLOCK
-        if IO.select([self], nil, nil, options[:socket_timeout])
-          retry
-        else
-          raise Timeout::Error, "IO timeout: #{options.inspect}"
-        end
+  if RbConfig::CONFIG['host_os'] =~ /mingw|mswin/
+    class Dalli::Server::KSocket::UNIX
+      def initialize(*args)
+        raise Dalli::DalliError, "Unix sockets are not supported on Windows platform."
       end
-      value
     end
+  else
+    class Dalli::Server::KSocket::UNIX < UNIXSocket
+      include Dalli::Server::KSocket
 
-    def read_available
-      value = ''
-      loop do
-        begin
-          value << read_nonblock(8196)
-        rescue Errno::EAGAIN, Errno::EWOULDBLOCK
-          break
+      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
-      value
     end
 
   end

data/lib/dalli/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Dalli
-  VERSION = '2.7.0'
+  VERSION = '2.7.11'
 end

data/lib/dalli.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'dalli/compressor'
 require 'dalli/client'
 require 'dalli/ring'
@@ -18,6 +19,8 @@ module Dalli
   class MarshalError < DalliError; end
   # application error in marshalling deserialization or decompression
   class UnmarshalError < DalliError; end
+  # payload too big for memcached
+  class ValueOverMaxSize < DalliError; end
 
   def self.logger
     @logger ||= (rails_logger || default_logger)

data/lib/rack/session/dalli.rb

@@ -1,36 +1,104 @@
+# frozen_string_literal: true
 require 'rack/session/abstract/id'
 require 'dalli'
 
 module Rack
   module Session
-    class Dalli < Abstract::ID
+    class Dalli < defined?(Abstract::Persisted) ? Abstract::Persisted : Abstract::ID
       attr_reader :pool, :mutex
 
-      DEFAULT_OPTIONS = Abstract::ID::DEFAULT_OPTIONS.merge \
+      DEFAULT_DALLI_OPTIONS = {
         :namespace => 'rack:session',
         :memcache_server => 'localhost:11211'
+      }
 
+      # Brings in a new Rack::Session::Dalli middleware with the given
+      # `:memcache_server`. The server is either a hostname, or a
+      # host-with-port string in the form of "host_name:port", or an array of
+      # such strings. For example:
+      #
+      #   use Rack::Session::Dalli,
+      #     :memcache_server => "mc.example.com:1234"
+      #
+      # If no `:memcache_server` option is specified, Rack::Session::Dalli will
+      # connect to localhost, port 11211 (the default memcached port). If
+      # `:memcache_server` is set to nil, Dalli::Client will look for
+      # ENV['MEMCACHE_SERVERS'] and use that value if it is available, or fall
+      # back to the same default behavior described above.
+      #
+      # Rack::Session::Dalli is intended to be a drop-in replacement for
+      # Rack::Session::Memcache. It accepts additional options that control the
+      # behavior of Rack::Session, Dalli::Client, and an optional
+      # ConnectionPool. First and foremost, if you wish to instantiate your own
+      # Dalli::Client (or ConnectionPool) and use that instead of letting
+      # Rack::Session::Dalli instantiate it on your behalf, simply pass it in
+      # as the `:cache` option. Please note that you will be responsible for
+      # setting the namespace and any other options on Dalli::Client.
+      #
+      # Secondly, if you're not using the `:cache` option, Rack::Session::Dalli
+      # accepts the same options as Dalli::Client, so it's worth reviewing its
+      # documentation. Perhaps most importantly, if you don't specify a
+      # `:namespace` option, Rack::Session::Dalli will default to using
+      # "rack:session".
+      #
+      # Whether you are using the `:cache` option or not, it is not recommend
+      # to set `:expires_in`. Instead, use `:expire_after`, which will control
+      # both the expiration of the client cookie as well as the expiration of
+      # the corresponding entry in memcached.
+      #
+      # Rack::Session::Dalli also accepts a host of options that control how
+      # the sessions and session cookies are managed, including the
+      # aforementioned `:expire_after` option. Please see the documentation for
+      # Rack::Session::Abstract::Persisted for a detailed explanation of these
+      # options and their default values.
+      #
+      # Finally, if your web application is multithreaded, the
+      # Rack::Session::Dalli middleware can become a source of contention. You
+      # can use a connection pool of Dalli clients by passing in the
+      # `:pool_size` and/or `:pool_timeout` options. For example:
+      #
+      #   use Rack::Session::Dalli,
+      #     :memcache_server => "mc.example.com:1234",
+      #     :pool_size => 10
+      #
+      # You must include the `connection_pool` gem in your project if you wish
+      # to use pool support. Please see the documentation for ConnectionPool
+      # 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={})
+        # Parent uses DEFAULT_OPTIONS to build @default_options for Rack::Session
         super
-        @mutex = Mutex.new
-        mserv = @default_options[:memcache_server]
-        mopts = @default_options.reject{|k,v| !DEFAULT_OPTIONS.include? k }
-        @pool = options[:cache] || ::Dalli::Client.new(mserv, mopts)
-      end
 
-      def generate_sid
-        loop do
-          sid = super
-          break sid unless @pool.get(sid)
+        # Determine the default TTL for newly-created sessions
+        @default_ttl = ttl @default_options[:expire_after]
+
+        # Normalize and validate passed options
+        cache, mserv, mopts, popts = extract_dalli_options options
+
+        @pool =
+          if cache # caller passed a Dalli::Client or ConnectionPool instance
+            cache
+          elsif popts # caller passed ConnectionPool options
+            ConnectionPool.new(popts) { ::Dalli::Client.new(mserv, mopts) }
+          else
+            ::Dalli::Client.new(mserv, mopts)
+          end
+
+        if @pool.respond_to?(:alive!) # is a Dalli::Client
+          @mutex = Mutex.new
+
+          @pool.alive!
         end
       end
 
       def get_session(env, sid)
-        with_lock(env, [nil, {}]) do
-          unless sid and session = @pool.get(sid)
-            sid, session = generate_sid, {}
-            unless @pool.add(sid, session)
-              raise "Session collision on '#{sid.inspect}'"
+        with_block(env, [nil, {}]) do |dc|
+          unless sid and !sid.empty? and session = dc.get(sid)
+            old_sid, sid, session = sid, generate_sid_with(dc), {}
+            unless dc.add(sid, session, @default_ttl)
+              sid = old_sid
+              redo # generate a new sid and try again
             end
           end
           [sid, session]
@@ -38,25 +106,67 @@ module Rack
       end
 
       def set_session(env, session_id, new_session, options)
-        expiry = options[:expire_after]
-        expiry = expiry.nil? ? 0 : expiry + 1
+        return false unless session_id
 
-        with_lock(env, false) do
-          @pool.set session_id, new_session, expiry
+        with_block(env, false) do |dc|
+          dc.set(session_id, new_session, ttl(options[:expire_after]))
           session_id
         end
       end
 
       def destroy_session(env, session_id, options)
-        with_lock(env) do
-          @pool.delete(session_id)
-          generate_sid unless options[:drop]
+        with_block(env) do |dc|
+          dc.delete(session_id)
+          generate_sid_with(dc) unless options[:drop]
+        end
+      end
+
+      if defined?(Abstract::Persisted)
+        def find_session(req, sid)
+          get_session req.env, sid
+        end
+
+        def write_session(req, sid, session, options)
+          set_session req.env, sid, session, options
+        end
+
+        def delete_session(req, sid, options)
+          destroy_session req.env, sid, options
         end
       end
 
-      def with_lock(env, default=nil)
-        @mutex.lock if env['rack.multithread']
-        yield
+      private
+
+      def extract_dalli_options(options)
+        return [options[:cache]] if options[:cache]
+
+        # Filter out Rack::Session-specific options and apply our defaults
+        mopts = DEFAULT_DALLI_OPTIONS.merge \
+          options.reject {|k, _| DEFAULT_OPTIONS.key? k }
+        mserv = mopts.delete :memcache_server
+
+        if mopts[:pool_size] || mopts[:pool_timeout]
+          popts = {}
+          popts[:size] = mopts.delete :pool_size if mopts[:pool_size]
+          popts[:timeout] = mopts.delete :pool_timeout if mopts[:pool_timeout]
+
+          # For a connection pool, locking is handled at the pool level
+          mopts[:threadsafe] = false unless mopts.key? :threadsafe
+        end
+
+        [nil, mserv, mopts, popts]
+      end
+
+      def generate_sid_with(dc)
+        while true
+          sid = generate_sid
+          break sid unless dc.get(sid)
+        end
+      end
+
+      def with_block(env, default=nil, &block)
+        @mutex.lock if @mutex and env['rack.multithread']
+        @pool.with(&block)
       rescue ::Dalli::DalliError, Errno::ECONNREFUSED
         raise if $!.message =~ /undefined class/
         if $VERBOSE
@@ -65,9 +175,12 @@ module Rack
         end
         default
       ensure
-        @mutex.unlock if @mutex.locked?
+        @mutex.unlock if @mutex and @mutex.locked?
       end
 
+      def ttl(expire_after)
+        expire_after.nil? ? 0 : expire_after + 1
+      end
     end
   end
 end

metadata

@@ -1,65 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: dalli
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.7.11
 platform: ruby
 authors:
+- Peter M. Goldstein
 - Mike Perham
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-01-07 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 4.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 4.2.0
-- !ruby/object:Gem::Dependency
-  name: mocha
-  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: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3'
+date: 2020-09-26 00:00:00.000000000 Z
+dependencies: []
 description: High performance memcached client for Ruby
-email: mperham@gmail.com
+email:
+- peter.m.goldstein@gmail.com
+- mperham@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- History.md
+- LICENSE
+- README.md
 - lib/action_dispatch/middleware/session/dalli_store.rb
 - lib/active_support/cache/dalli_store.rb
+- lib/dalli.rb
 - lib/dalli/cas/client.rb
 - lib/dalli/client.rb
 - lib/dalli/compressor.rb
@@ -69,68 +35,29 @@ files:
 - lib/dalli/server.rb
 - lib/dalli/socket.rb
 - lib/dalli/version.rb
-- lib/dalli.rb
 - lib/rack/session/dalli.rb
-- LICENSE
-- README.md
-- History.md
-- Rakefile
-- Gemfile
-- dalli.gemspec
-- Performance.md
-- test/benchmark_test.rb
-- test/helper.rb
-- test/memcached_mock.rb
-- test/sasldb
-- test/test_active_support.rb
-- test/test_cas_client.rb
-- test/test_compressor.rb
-- test/test_dalli.rb
-- test/test_encoding.rb
-- test/test_failover.rb
-- test/test_network.rb
-- test/test_rack_session.rb
-- test/test_ring.rb
-- test/test_sasl.rb
-- test/test_serializer.rb
-homepage: http://github.com/mperham/dalli
+homepage: https://github.com/petergoldstein/dalli
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
-rdoc_options:
-- --charset=UTF-8
+post_install_message:
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.14
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
 specification_version: 4
 summary: High performance memcached client for Ruby
-test_files:
-- test/benchmark_test.rb
-- test/helper.rb
-- test/memcached_mock.rb
-- test/sasldb
-- test/test_active_support.rb
-- test/test_cas_client.rb
-- test/test_compressor.rb
-- test/test_dalli.rb
-- test/test_encoding.rb
-- test/test_failover.rb
-- test/test_network.rb
-- test/test_rack_session.rb
-- test/test_ring.rb
-- test/test_sasl.rb
-- test/test_serializer.rb
+test_files: []

data/Performance.md

@@ -1,42 +0,0 @@
-Performance
-====================
-
-Caching is all about performance, so I carefully track Dalli performance to ensure no regressions.
-You can optionally use kgio to give Dalli a 10-20% performance boost: `gem install kgio`.
-
-Note I've added some benchmarks over time to Dalli that the other libraries don't necessarily have.
-
-memcache-client
----------------
-
-Testing 1.8.5 with ruby 1.9.3p0 (2011-10-30 revision 33570) [x86_64-darwin11.2.0]
-
-                                          user     system      total        real
-    set:plain:memcache-client         1.860000   0.310000   2.170000 (  2.188030)
-    set:ruby:memcache-client          1.830000   0.290000   2.120000 (  2.130212)
-    get:plain:memcache-client         1.830000   0.340000   2.170000 (  2.176156)
-    get:ruby:memcache-client          1.900000   0.330000   2.230000 (  2.235045)
-    multiget:ruby:memcache-client     0.860000   0.120000   0.980000 (  0.987348)
-    missing:ruby:memcache-client      1.630000   0.320000   1.950000 (  1.954867)
-    mixed:ruby:memcache-client        3.690000   0.670000   4.360000 (  4.364469)
-
-
-dalli
------
-
-Testing with Rails 3.2.1
-Using kgio socket IO
-Testing 2.0.0 with ruby 1.9.3p125 (2012-02-16 revision 34643) [x86_64-darwin11.3.0]
-
-                                          user     system      total        real
-    mixed:rails:dalli                 1.580000   0.570000   2.150000 (  3.008839)
-    set:plain:dalli                   0.730000   0.300000   1.030000 (  1.567098)
-    setq:plain:dalli                  0.520000   0.120000   0.640000 (  0.634402)
-    set:ruby:dalli                    0.800000   0.300000   1.100000 (  1.640348)
-    get:plain:dalli                   0.840000   0.330000   1.170000 (  1.668425)
-    get:ruby:dalli                    0.850000   0.330000   1.180000 (  1.665716)
-    multiget:ruby:dalli               0.700000   0.260000   0.960000 (  0.965423)
-    missing:ruby:dalli                0.720000   0.320000   1.040000 (  1.511720)
-    mixed:ruby:dalli                  1.660000   0.640000   2.300000 (  3.320743)
-    mixedq:ruby:dalli                 1.630000   0.510000   2.140000 (  2.629734)
-    incr:ruby:dalli                   0.270000   0.100000   0.370000 (  0.547618)

data/Rakefile

@@ -1,42 +0,0 @@
-require 'appraisal'
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.warning = true
-  test.verbose = true
-end
-
-Rake::TestTask.new(:bench) do |test|
-  test.libs << 'test'
-  test.pattern = 'test/benchmark_test.rb'
-end
-
-begin
-  require 'metric_fu'
-  MetricFu::Configuration.run do |config|
-    config.rcov[:rcov_opts] << "-Itest:lib"
-  end
-rescue LoadError
-end
-
-task :default => :test
-
-task :test_all do
-  system('rake test RAILS_VERSION="~> 3.0.0"')
-  system('rake test RAILS_VERSION=">= 3.0.0"')
-end
-
-# 'gem install rdoc' to upgrade RDoc if this is giving you errors
-begin
-  require 'rdoc/task'
-  RDoc::Task.new do |rd|
-    rd.rdoc_files.include("lib/**/*.rb")
-  end
-rescue LoadError
-  puts "Unable to load rdoc, run 'gem install rdoc' to fix this."
-end
-
-require 'rake/clean'
-CLEAN.include "**/*.rbc"
-CLEAN.include "**/.DS_Store"