dalli 2.7.11 → 3.2.0

data/lib/rack/session/dalli.rb

@@ -1,16 +1,22 @@
 # frozen_string_literal: true
+
 require 'rack/session/abstract/id'
 require 'dalli'
+require 'connection_pool'
+require 'English'
 
 module Rack
   module Session
-    class Dalli < defined?(Abstract::Persisted) ? Abstract::Persisted : Abstract::ID
-      attr_reader :pool, :mutex
+    # Rack::Session::Dalli provides memcached based session management.
+    class Dalli < Abstract::PersistedSecure
+      attr_reader :data
 
+      # 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'
       }
+      # 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
@@ -26,25 +32,14 @@ module Rack
       # 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".
+      # 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.
+      # It is not recommended 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
@@ -66,116 +61,121 @@ 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
 
         # 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
+        @default_ttl = ttl(@default_options[:expire_after])
+        @data = build_data_source(options)
       end
 
-      def get_session(env, sid)
-        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]
+      def find_session(_req, sid)
+        with_dalli_client([nil, {}]) do |dc|
+          existing_session = existing_session_for_sid(dc, sid)
+          return [sid, existing_session] unless existing_session.nil?
+
+          [create_sid_with_empty_session(dc), {}]
         end
       end
 
-      def set_session(env, session_id, new_session, options)
-        return false unless session_id
+      def write_session(_req, sid, session, options)
+        return false unless sid
 
-        with_block(env, false) do |dc|
-          dc.set(session_id, new_session, ttl(options[:expire_after]))
-          session_id
+        with_dalli_client(false) do |dc|
+          dc.set(memcached_key_from_sid(sid), session, ttl(options[:expire_after]))
+          sid
         end
       end
 
-      def destroy_session(env, session_id, options)
-        with_block(env) do |dc|
-          dc.delete(session_id)
+      def delete_session(_req, sid, options)
+        with_dalli_client do |dc|
+          dc.delete(memcached_key_from_sid(sid))
           generate_sid_with(dc) unless options[:drop]
         end
       end
 
-      if defined?(Abstract::Persisted)
-        def find_session(req, sid)
-          get_session req.env, sid
-        end
+      private
+
+      def memcached_key_from_sid(sid)
+        sid.private_id
+      end
+
+      def existing_session_for_sid(client, sid)
+        return nil unless sid && !sid.empty?
+
+        client.get(memcached_key_from_sid(sid))
+      end
 
-        def write_session(req, sid, session, options)
-          set_session req.env, sid, session, options
+      def create_sid_with_empty_session(client)
+        loop do
+          sid = generate_sid_with(client)
+
+          break sid if client.add(memcached_key_from_sid(sid), {}, @default_ttl)
         end
+      end
 
-        def delete_session(req, sid, options)
-          destroy_session req.env, sid, options
+      def generate_sid_with(client)
+        loop do
+          raw_sid = generate_sid
+          sid = raw_sid.is_a?(String) ? Rack::Session::SessionId.new(raw_sid) : raw_sid
+          break sid unless client.get(memcached_key_from_sid(sid))
         end
       end
 
-      private
+      def build_data_source(options)
+        server_configurations, client_options, pool_options = extract_dalli_options(options)
 
-      def extract_dalli_options(options)
-        return [options[:cache]] if options[:cache]
+        if pool_options.empty?
+          ::Dalli::Client.new(server_configurations, client_options)
+        else
+          ensure_connection_pool_added!
+          ConnectionPool.new(pool_options) do
+            ::Dalli::Client.new(server_configurations, client_options.merge(threadsafe: false))
+          end
+        end
+      end
 
-        # 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
+      def extract_dalli_options(options)
+        raise 'Rack::Session::Dalli no longer supports the :cache option.' if options[:cache]
 
-        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]
+        client_options = retrieve_client_options(options)
+        server_configurations = client_options.delete(:memcache_server)
 
-          # For a connection pool, locking is handled at the pool level
-          mopts[:threadsafe] = false unless mopts.key? :threadsafe
-        end
+        [server_configurations, client_options, retrieve_pool_options(options)]
+      end
 
-        [nil, mserv, mopts, popts]
+      def retrieve_client_options(options)
+        # Filter out Rack::Session-specific options and apply our defaults
+        filtered_opts = options.reject { |k, _| DEFAULT_OPTIONS.key? k }
+        DEFAULT_DALLI_OPTIONS.merge(filtered_opts)
       end
 
-      def generate_sid_with(dc)
-        while true
-          sid = generate_sid
-          break sid unless dc.get(sid)
+      def retrieve_pool_options(options)
+        {}.tap do |pool_options|
+          pool_options[:size] = options.delete(:pool_size) if options[:pool_size]
+          pool_options[:timeout] = options.delete(:pool_timeout) if options[:pool_timeout]
         end
       end
 
-      def with_block(env, default=nil, &block)
-        @mutex.lock if @mutex and env['rack.multithread']
-        @pool.with(&block)
+      def ensure_connection_pool_added!
+        require 'connection_pool'
+      rescue LoadError => e
+        warn "You don't have connection_pool installed in your application. "\
+             'Please add it to your Gemfile and run bundle install'
+        raise e
+      end
+
+      def with_dalli_client(result_on_error = nil, &block)
+        @data.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
-      ensure
-        @mutex.unlock if @mutex and @mutex.locked?
+        result_on_error
       end
 
       def ttl(expire_after)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dalli
 version: !ruby/object:Gem::Version
-  version: 2.7.11
+  version: 3.2.0
 platform: ruby
 authors:
 - Peter M. Goldstein
@@ -9,8 +9,98 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-26 00:00:00.000000000 Z
-dependencies: []
+date: 2022-01-03 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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  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:
+    - - ">="
+      - !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-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:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: High performance memcached client for Ruby
 email:
 - peter.m.goldstein@gmail.com
@@ -23,23 +113,42 @@ files:
 - 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
+- lib/dalli/key_manager.rb
 - lib/dalli/options.rb
-- lib/dalli/railtie.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
+- lib/dalli/protocol/binary/response_processor.rb
+- lib/dalli/protocol/binary/sasl_authentication.rb
+- lib/dalli/protocol/connection_manager.rb
+- lib/dalli/protocol/meta.rb
+- lib/dalli/protocol/meta/key_regularizer.rb
+- lib/dalli/protocol/meta/request_formatter.rb
+- lib/dalli/protocol/meta/response_processor.rb
+- lib/dalli/protocol/response_buffer.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:
@@ -48,15 +157,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: []
-rubyforge_project:
-rubygems_version: 2.7.6.2
+rubygems_version: 3.3.4
 signing_key:
 specification_version: 4
 summary: High performance memcached client for Ruby

data/lib/action_dispatch/middleware/session/dalli_store.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-require 'active_support/cache'
-require 'action_dispatch/middleware/session/abstract_store'
-require 'dalli'
-
-# Dalli-based session store for Rails 3.0.
-module ActionDispatch
-  module Session
-    class DalliStore < AbstractStore
-      def initialize(app, options = {})
-        # Support old :expires option
-        options[:expire_after] ||= options[:expires]
-
-        super
-
-        @default_options = { :namespace => 'rack:session' }.merge(@default_options)
-
-        @pool = options[:cache] || begin
-          Dalli::Client.new(
-              @default_options[:memcache_server], @default_options)
-        end
-        @namespace = @default_options[:namespace]
-
-        @raise_errors = !!@default_options[:raise_errors]
-
-        super
-      end
-
-      def reset
-        @pool.reset
-      end
-
-      private
-
-      def get_session(env, sid)
-        sid = generate_sid unless sid and !sid.empty?
-        begin
-          session = @pool.get(sid) || {}
-        rescue Dalli::DalliError => ex
-          # re-raise ArgumentError so Rails' session abstract_store.rb can autoload any missing models
-          raise ArgumentError, ex.message if ex.message =~ /unmarshal/
-          Rails.logger.warn("Session::DalliStore#get: #{ex.message}")
-          session = {}
-        end
-        [sid, session]
-      end
-
-      def set_session(env, sid, session_data, options = nil)
-        options ||= env[ENV_SESSION_OPTIONS_KEY]
-        expiry  = options[:expire_after]
-        @pool.set(sid, session_data, expiry)
-        sid
-      rescue Dalli::DalliError
-        Rails.logger.warn("Session::DalliStore#set: #{$!.message}")
-        raise if @raise_errors
-        false
-      end
-
-      def destroy_session(env, session_id, options)
-        begin
-          @pool.delete(session_id)
-        rescue Dalli::DalliError
-          Rails.logger.warn("Session::DalliStore#destroy_session: #{$!.message}")
-          raise if @raise_errors
-        end
-        return nil if options[:drop]
-        generate_sid
-      end
-
-      def destroy(env)
-        if sid = current_session_id(env)
-          @pool.delete(sid)
-        end
-      rescue Dalli::DalliError
-        Rails.logger.warn("Session::DalliStore#destroy: #{$!.message}")
-        raise if @raise_errors
-        false
-      end
-
-    end
-  end
-end