dalli 1.0.0 → 1.0.1

data/History.md

@@ -1,6 +1,17 @@
 Dalli Changelog
 =====================
 
+1.0.1
+=======
+
+ - Explicitly handle application marshalling bugs, GH-56
+ - Add support for username/password as options, to allow multiple bucket access
+   from the same Ruby process, GH-52
+ - Add support for >1MB values with :value_max_bytes option, GH-54 (r-stu31)
+ - Add support for default TTL, :expires_in, in Rails 2.3. (Steven Novotny)
+   config.cache_store = :dalli_store, 'localhost:11211', {:expires_in => 4.hours}
+
+
 1.0.0
 =======
 

data/README.md

@@ -128,8 +128,13 @@ Dalli::Client accepts the following options. All times are in seconds.
 
 **socket_failure_delay**: Before retrying a socket operation, the process sleeps for this amount of time. Default is 0.01.  Set to nil for no delay.
 
-**down_retry_delay**: When a server has been marked down due to many failures, the server will be checked again for being alive only after this amount of time. Don't set this value to low, otherwise each request which tries the failed server might hang for the maximum timeout (see below). Default is 1 second.
+**down_retry_delay**: When a server has been marked down due to many failures, the server will be checked again for being alive only after this amount of time. Don't set this value to low, otherwise each request which tries the failed server might hang for the maximum **socket_timeout**. Default is 1 second.
 
+**value_max_bytes**: The maximum size of a value in memcached.  Defaults to 1MB, this can be increased with memcached's -I parameter.  You must also configure Dalli to allow the larger size here.
+
+**username**: The username to use for authenticating this client instance against a SASL-enabled memcached server.  Heroku users should not need to use this normally.
+
+**password**: The password to use for authenticating this client instance against a SASL-enabled memcached server.  Heroku users should not need to use this normally.
 
 Features and Changes
 ------------------------

data/Rakefile

@@ -22,4 +22,9 @@ task :default => :test
 task :test_all do
   system('rake test RAILS_VERSION="~> 2.3.0"')
   system('rake test RAILS_VERSION="~> 3.0.0"')
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rd|
+  rd.rdoc_files.include("lib/**/*.rb")
 end

data/lib/active_support/cache/dalli_store23.rb

@@ -37,6 +37,7 @@ module ActiveSupport
 
         mem_cache_options = options.dup
         @namespace = mem_cache_options.delete(:namespace)
+        @expires_in = mem_cache_options[:expires_in]
         @data = self.class.build_mem_cache(*(addresses + [mem_cache_options]))
 
         extend Strategy::LocalCache
@@ -154,7 +155,7 @@ module ActiveSupport
 
       # Exists in 2.3.8 but not in 2.3.2 so roll our own version
       def expires_in(options)
-        expires_in = options && options[:expires_in]
+        expires_in = (options && options[:expires_in]) || @expires_in
 
         raise ":expires_in must be a number" if expires_in && !expires_in.is_a?(Numeric)
 

data/lib/dalli/client.rb

@@ -19,7 +19,7 @@ module Dalli
     # - :threadsafe - ensure that only one thread is actively using a socket at a time. Default: true.
     # - :expires_in - default TTL in seconds if you do not pass TTL as a parameter to an individual operation, defaults to 0 or forever
     # - :compression - defaults to false, if true Dalli will compress values larger than 100 bytes before
-    #    sending them to memcached.
+    #   sending them to memcached.
     #
     def initialize(servers=nil, options={})
       @servers = env_servers || servers || 'localhost:11211'
@@ -145,9 +145,7 @@ module Dalli
     end
 
     # deprecated, please use #flush.
-    def flush_all(delay=0)
-      flush(delay)
-    end
+    alias_method :flush_all, :flush
 
     ##
     # Incr adds the given amount to the counter on the memcached server.

data/lib/dalli/server.rb

@@ -17,7 +17,11 @@ module Dalli
       # times a socket operation may fail before considering the server dead
       :socket_max_failures => 2,
       # amount of time to sleep between retries when a failure occurs
-      :socket_failure_delay => 0.01
+      :socket_failure_delay => 0.01,
+      # max size of value in bytes (default is 1 MB, can be overriden with "memcached -I <size>")
+      :value_max_bytes => 1024 * 1024,
+      :username => nil,
+      :password => nil,
     }
 
     def initialize(attribs, options = {})
@@ -41,6 +45,11 @@ module Dalli
         raise
       rescue Dalli::DalliError
         raise
+      rescue TypeError => ex
+        Dalli.logger.error "Application bug: #{ex.class.name}: #{ex.message}"
+        Dalli.logger.error "You are trying to cache a Ruby object which cannot be serialized to memcached."
+        Dalli.logger.error ex.backtrace.join("\n\t")
+        false
       rescue Exception => ex
         Dalli.logger.error "Unexpected exception in Dalli: #{ex.class.name}: #{ex.message}"
         Dalli.logger.error "This is a bug in Dalli, please enter an issue in Github if it does not already exist."
@@ -126,8 +135,6 @@ module Dalli
       Thread.current[:dalli_multi]
     end
 
-    ONE_MB = 1024 * 1024
-
     def get(key)
       req = [REQUEST, OPCODES[:get], key.bytesize, 0, 0, 0, key.bytesize, 0, 0, key].pack(FORMAT[:get])
       write(req)
@@ -255,7 +262,7 @@ module Dalli
         value = Zlib::Deflate.deflate(value)
         compressed = true
       end
-      raise Dalli::DalliError, "Value too large, memcached can only store 1MB of data per key" if value.bytesize > ONE_MB
+      raise Dalli::DalliError, "Value too large, memcached can only store #{@options[:value_max_bytes]} of data per key" if value.bytesize > @options[:value_max_bytes]
       flags = 0
       flags |= FLAG_COMPRESSED if compressed
       flags |= FLAG_MARSHALLED if marshalled
@@ -364,7 +371,7 @@ module Dalli
       begin
         @sock = KSocket.open(hostname, port, :timeout => options[:socket_timeout])
         @version = version # trigger actual connect
-        sasl_authentication if Dalli::Server.need_auth?
+        sasl_authentication if need_auth?
         up!
       rescue Dalli::DalliError # SASL auth failure
         raise
@@ -450,26 +457,19 @@ module Dalli
     # SASL authentication support for NorthScale
     #######
 
-    def self.need_auth?
-      ENV['MEMCACHE_USERNAME']
+    def need_auth?
+      @options[:username] || ENV['MEMCACHE_USERNAME']
     end
     
-    def init_sasl
-      require 'dalli/sasl/base'
-      require 'dalli/sasl/plain'
-    end
-
     def username
-      ENV['MEMCACHE_USERNAME']
+      @options[:username] || ENV['MEMCACHE_USERNAME']
     end
 
     def password
-      ENV['MEMCACHE_PASSWORD']
+      @options[:password] || ENV['MEMCACHE_PASSWORD']
     end
 
     def sasl_authentication
-      init_sasl if !defined?(::SASL)
-
       Dalli.logger.info { "Dalli/SASL authenticating as #{username}" }
 
       # negotiate
@@ -482,12 +482,11 @@ module Dalli
       content = read(count)
       return (Dalli.logger.debug("Authentication not required/supported by server")) if status == 0x81
       mechanisms = content.split(' ')
+      raise NotImplementedError, "Dalli only supports the PLAIN authentication mechanism" if !mechanisms.include?('PLAIN')
 
       # request
-      sasl = ::SASL.new(mechanisms)
-      msg = sasl.start[1]
-      mechanism = sasl.name
-      #p [mechanism, msg]
+      mechanism = 'PLAIN'
+      msg = "\x0#{username}\x0#{password}"
       req = [REQUEST, OPCODES[:auth_request], mechanism.bytesize, 0, 0, 0, mechanism.bytesize + msg.bytesize, 0, 0, mechanism, msg].pack(FORMAT[:auth_request])
       write(req)
 

data/lib/dalli/version.rb

@@ -1,3 +1,3 @@
 module Dalli
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/test/test_dalli.rb

@@ -329,6 +329,18 @@ class TestDalli < Test::Unit::TestCase
       end
     end
 
+    should "handle application marshalling issues" do
+      memcached do |dc|
+        old = Dalli.logger
+        Dalli.logger = Logger.new(nil)
+        begin
+          assert_equal false, dc.set('a', Proc.new { true })
+        ensure
+          Dalli.logger = old
+        end
+      end
+    end
+
     context 'with compression' do
       should 'allow large values' do
         memcached do |dc|

data/test/test_sasl.rb

@@ -6,7 +6,7 @@ class TestSasl < Test::Unit::TestCase
 
     context 'without authentication credentials' do
       setup do
-        ENV['MEMCACHE_USERNAME'] = 'testuser'
+        ENV['MEMCACHE_USERNAME'] = 'foo'
         ENV['MEMCACHE_PASSWORD'] = 'wrongpwd'
       end
 
@@ -24,6 +24,15 @@ class TestSasl < Test::Unit::TestCase
       end
     end
 
+    should 'fail SASL authentication with wrong options' do
+      memcached(19124, '-S') do |dc|
+        dc = Dalli::Client.new('localhost:19124', :username => 'foo', :password => 'wrongpwd')
+        assert_raise Dalli::DalliError, /32/ do
+          dc.set('abc', 123)
+        end
+      end
+    end
+
     # OSX: Create a SASL user for the memcached application like so:
     #
     # saslpasswd2 -a memcached -c testuser
@@ -40,16 +49,31 @@ class TestSasl < Test::Unit::TestCase
         ENV['MEMCACHE_PASSWORD'] = nil
       end
 
-      should 'support SASL authentication' do
+      should 'pass SASL authentication' do
         memcached(19124, '-S') do |dc|
           # I get "Dalli::DalliError: Error authenticating: 32" in OSX
           # but SASL works on Heroku servers. YMMV.
           assert_equal true, dc.set('abc', 123)
           assert_equal 123, dc.get('abc')
-          assert_equal({"localhost:19121"=>{}}, dc.stats)
+          results = dc.stats
+          assert_equal 1, results.size
+          assert_equal 38, results.values.first.size
         end
       end
     end
 
+    should 'pass SASL authentication with options' do
+      memcached(19124, '-S') do |dc|
+        dc = Dalli::Client.new('localhost:19124', :username => 'testuser', :password => 'testtest')
+        # I get "Dalli::DalliError: Error authenticating: 32" in OSX
+        # but SASL works on Heroku servers. YMMV.
+        assert_equal true, dc.set('abc', 123)
+        assert_equal 123, dc.get('abc')
+        results = dc.stats
+        assert_equal 1, results.size
+        assert_equal 38, results.values.first.size
+      end
+    end
+
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Mike Perham
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-28 00:00:00 -08:00
+date: 2011-01-05 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -89,9 +89,6 @@ files:
 - lib/dalli/client.rb
 - lib/dalli/options.rb
 - lib/dalli/ring.rb
-- lib/dalli/sasl/anonymous.rb
-- lib/dalli/sasl/base.rb
-- lib/dalli/sasl/plain.rb
 - lib/dalli/server.rb
 - lib/dalli/socket.rb
 - lib/dalli/version.rb

data/lib/dalli/sasl/anonymous.rb

@@ -1,14 +0,0 @@
-module SASL
-  ##
-  # SASL ANONYMOUS where you only send a username that may not get
-  # evaluated by the server.
-  #
-  # RFC 4505:
-  # http://tools.ietf.org/html/rfc4505
-  class Anonymous < Mechanism
-    def start
-      @state = nil
-      ['auth', preferences.username.to_s]
-    end
-  end
-end

data/lib/dalli/sasl/base.rb

@@ -1,89 +0,0 @@
-module SASL
-  
-  MECHANISMS = {
-  }
-  
-  class Preferences
-    def authzid
-      nil
-    end
-
-    def realm
-      raise NotImplementedError
-    end
-
-    def digest_uri
-      raise NotImplementedError
-    end
-
-    def username
-      ENV['MEMCACHE_USERNAME']
-    end
-
-    def has_password?
-      false
-    end
-
-    def allow_plaintext?
-      false
-    end
-
-    def password
-      ENV['MEMCACHE_PASSWORD']
-    end
-
-    def want_anonymous?
-      false
-    end
-  end
-
-  def SASL.new(mechanisms)
-    mechanisms.each do |mech|
-      if MECHANISMS.has_key?(mech)
-        x = MECHANISMS[mech]
-        return x.new(mech, Preferences.new)
-      end
-    end
-
-    raise NotImplementedError, "No supported mechanisms in #{mechanisms.join(',')}"
-  end
-
-  ##
-  # Common functions for mechanisms
-  #
-  # Mechanisms implement handling of methods start and receive. They
-  # return: [message_name, content] or nil where message_name is
-  # either 'auth' or 'response' and content is either a string which
-  # may transmitted encoded as Base64 or nil.
-  class Mechanism
-    attr_reader :preferences
-    attr_reader :name
-
-    def initialize(name, preferences)
-      @name = name
-      @preferences = preferences
-      @state = nil
-    end
-
-    def success?
-      @state == :success
-    end
-    def failure?
-      @state == :failure
-    end
-
-    def start
-      raise NotImplementedError
-    end
-
-    def receive(message_name, content)
-      case message_name
-      when 'success'
-        @state = :success
-      when 'failure'
-        @state = :failure
-      end
-      nil
-    end
-  end
-end

data/lib/dalli/sasl/plain.rb

@@ -1,18 +0,0 @@
-module SASL
-  ##
-  # RFC 4616:
-  # http://tools.ietf.org/html/rfc4616
-  class Plain < Mechanism
-    
-    def start
-      @state = nil
-      message = [preferences.authzid.to_s,
-                 preferences.username,
-                 preferences.password].join("\000")
-      ['auth', message]
-    end
-  end
-  
-  MECHANISMS['PLAIN'] = SASL::Plain
-  
-end