dalli 0.9.8 → 0.9.9

data/History.md

@@ -1,6 +1,23 @@
 Dalli Changelog
 =====================
 
+0.9.9
+----
+
+ - Add support for *_multi operations for add, set, replace and delete.  This implements
+   pipelined network operations; Dalli disables network replies so we're not limited by
+   latency, allowing for much higher throughput.
+
+    dc = Dalli::Client.new
+    dc.multi do
+      dc.set 'a', 1
+      dc.set 'b', 2
+      dc.set 'c', 3
+      dc.delete 'd'
+    end
+ - Minor fix to set the continuum sorted by value.
+ - Implement session store with Rails 2.3.  Update docs.
+
 0.9.8
 -----
 

data/README.md

@@ -61,6 +61,11 @@ A more comprehensive example (note that we are setting a reasonable default for
     config.cache_store = :dalli_store, 'cache-1.example.com', 'cache-2.example.com',
         :namespace => NAME_OF_RAILS_APP, :expires_in => 1.day, :compress => true, :compress_threshold => 64.kilobytes
 
+In `config/initializers/session_store.rb`:
+
+    require 'action_dispatch/middleware/session/dalli_store'
+    Rails.application.config.session_store :dalli_store, :key => ...
+
 
 Usage with Rails 2.3.x
 ----------------------------
@@ -71,9 +76,16 @@ In `config/environment.rb`:
 
 In `config/environments/production.rb`:
 
+    # Object cache
     require 'active_support/cache/dalli_store23'
     config.cache_store = :dalli_store
 
+In `config/initializers/session_store.rb`:
+
+    # Session cache
+    require 'action_controller/session/dalli_store'
+    ActionController::Base.session_store = :dalli_store
+
 
 Usage with Passenger
 ------------------------

data/TODO.md

@@ -2,6 +2,4 @@ TODO
 ========
 
  * More of the memcached instruction set.  This will be done based on user demand.  Email me if the API is missing a feature you'd like to use.
- * Better API documentation
- * Add noreply support for all commands
- * Better pipelining support
+ * Better API documentation

data/lib/action_controller/session/dalli_store.rb

@@ -0,0 +1,57 @@
+# Session store for Rails 2.3.x
+# Tested against 2.3.9.
+begin
+  require_library_or_gem 'dalli'
+
+  module ActionController
+    module Session
+      class DalliStore < AbstractStore
+        def initialize(app, options = {})
+          # Support old :expires option
+          options[:expire_after] ||= options[:expires]
+
+          super
+
+          @default_options = {
+            :namespace => 'rack:session',
+            :memcache_server => 'localhost:11211'
+          }.merge(@default_options)
+
+          @pool = Dalli::Client.new(@default_options[:memcache_server], @default_options)
+          super
+        end
+
+        private
+          def get_session(env, sid)
+            sid ||= generate_sid
+            begin
+              session = @pool.get(sid) || {}
+            rescue Dalli::DalliError
+              session = {}
+            end
+            [sid, session]
+          end
+
+          def set_session(env, sid, session_data)
+            options = env['rack.session.options']
+            expiry  = options[:expire_after] || 0
+            @pool.set(sid, session_data, expiry)
+            return true
+          rescue Dalli::DalliError
+            return false
+          end
+          
+          def destroy(env)
+            if sid = current_session_id(env)
+              @pool.delete(sid)
+            end
+          rescue Dalli::DalliError
+            false
+          end
+          
+      end
+    end
+  end
+rescue LoadError
+  # Dalli wasn't available so neither can the store be
+end

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

@@ -18,7 +18,6 @@ module ActionDispatch
         @default_options = {
           :namespace => 'rack:session',
           :memcache_server => 'localhost:11211',
-          :expires_in => options[:expire_after]
         }.merge(@default_options)
 
         @pool = options[:cache] || begin
@@ -36,16 +35,11 @@ module ActionDispatch
 
       private
       
-        def session_key(sid)
-          # Dalli does not support namespaces directly so we have
-          # to roll our own.
-          @namespace ? "#{@namespace}:#{sid}" : sid
-        end
-
         def get_session(env, sid)
+          sid ||= generate_sid
           begin
-            session = @pool.get(session_key(sid)) || {}
-          rescue Dalli::DalliError => de
+            session = @pool.get(sid) || {}
+          rescue Dalli::DalliError
             Rails.logger.warn("Session::DalliStore: #{$!.message}")
             session = {}
           end
@@ -55,7 +49,7 @@ module ActionDispatch
         def set_session(env, sid, session_data)
           options = env['rack.session.options']
           expiry  = options[:expire_after] || 0
-          @pool.set(session_key(sid), session_data, expiry)
+          @pool.set(sid, session_data, expiry)
           sid
         rescue Dalli::DalliError
           Rails.logger.warn("Session::DalliStore: #{$!.message}")
@@ -64,7 +58,7 @@ module ActionDispatch
 
         def destroy(env)
           if sid = current_session_id(env)
-            @pool.delete(session_key(sid))
+            @pool.delete(sid)
           end
         rescue Dalli::DalliError
           Rails.logger.warn("Session::DalliStore: #{$!.message}")

data/lib/dalli/client.rb

@@ -24,6 +24,18 @@ module Dalli
     # The standard memcached instruction set
     #
 
+    ##
+    # Turn on quiet aka noreply support.
+    # All relevant operations within this block with be effectively
+    # pipelined as Dalli will use 'quiet' operations where possible.
+    # Currently supports the set, add, replace and delete operations.
+    def multi
+      Thread.current[:multi] = true
+      yield
+    ensure
+      Thread.current[:multi] = nil
+    end
+
     def get(key, options=nil)
       resp = perform(:get, key)
       (!resp || resp == 'Not found') ? nil : deserialize(resp, options)
@@ -163,7 +175,7 @@ module Dalli
     # Chokepoint method for instrumentation
     def perform(op, *args)
       key = args.first
-      if key.is_a?(Symbol)
+      if !key.is_a?(String)
         key = key.to_s
         args[0] = key
       end

data/lib/dalli/ring.rb

@@ -20,8 +20,7 @@ module Dalli
             continuum << Dalli::Ring::Entry.new(value, server)
           end
         end
-        continuum.sort { |a, b| a.value <=> b.value }
-        @continuum = continuum
+        @continuum = continuum.sort { |a, b| a.value <=> b.value }
       end
 
       threadsafe! unless options[:threadsafe] == false

data/lib/dalli/server.rb

@@ -73,6 +73,10 @@ module Dalli
       nil
     end
 
+    def multi?
+      Thread.current[:multi]
+    end
+
     ONE_MB = 1024 * 1024
 
     def get(key)
@@ -89,9 +93,9 @@ module Dalli
     def set(key, value, ttl)
       raise Dalli::DalliError, "Value too large, memcached can only store 1MB of data per key" if value.size > ONE_MB
 
-      req = [REQUEST, OPCODES[:set], key.size, 8, 0, 0, value.size + key.size + 8, 0, 0, 0, ttl, key, value].pack(FORMAT[:set])
+      req = [REQUEST, OPCODES[multi? ? :setq : :set], key.size, 8, 0, 0, value.size + key.size + 8, 0, 0, 0, ttl, key, value].pack(FORMAT[:set])
       write(req)
-      generic_response
+      generic_response unless multi?
     end
 
     def flush(ttl)
@@ -103,9 +107,9 @@ module Dalli
     def add(key, value, ttl, cas)
       raise Dalli::DalliError, "Value too large, memcached can only store 1MB of data per key" if value.size > ONE_MB
 
-      req = [REQUEST, OPCODES[:add], key.size, 8, 0, 0, value.size + key.size + 8, 0, cas, 0, ttl, key, value].pack(FORMAT[:add])
+      req = [REQUEST, OPCODES[multi? ? :addq : :add], key.size, 8, 0, 0, value.size + key.size + 8, 0, cas, 0, ttl, key, value].pack(FORMAT[:add])
       write(req)
-      generic_response
+      generic_response unless multi?
     end
     
     def append(key, value)
@@ -115,9 +119,9 @@ module Dalli
     end
     
     def delete(key)
-      req = [REQUEST, OPCODES[:delete], key.size, 0, 0, 0, key.size, 0, 0, key].pack(FORMAT[:delete])
+      req = [REQUEST, OPCODES[multi? ? :deleteq : :delete], key.size, 0, 0, 0, key.size, 0, 0, key].pack(FORMAT[:delete])
       write(req)
-      generic_response
+      generic_response unless multi?
     end
 
     def decr(key, count, ttl, default)
@@ -157,9 +161,9 @@ module Dalli
     end
 
     def replace(key, value, ttl)
-      req = [REQUEST, OPCODES[:replace], key.size, 8, 0, 0, value.size + key.size + 8, 0, 0, 0, ttl, key, value].pack(FORMAT[:replace])
+      req = [REQUEST, OPCODES[multi? ? :replaceq : :replace], key.size, 8, 0, 0, value.size + key.size + 8, 0, 0, 0, ttl, key, value].pack(FORMAT[:replace])
       write(req)
-      generic_response
+      generic_response unless multi?
     end
 
     def stats(info='')
@@ -351,6 +355,12 @@ module Dalli
       :append => 0x0E,
       :prepend => 0x0F,
       :stat => 0x10,
+      :setq => 0x11,
+      :addq => 0x12,
+      :replaceq => 0x13,
+      :deleteq => 0x14,
+      :incrq => 0x15,
+      :decrq => 0x16,
       :auth_negotiation => 0x20,
       :auth_request => 0x21,
       :auth_continue => 0x22,

data/lib/dalli/version.rb

@@ -1,3 +1,3 @@
 module Dalli
-  VERSION = '0.9.8'
+  VERSION = '0.9.9'
 end

data/test/benchmark_test.rb

@@ -40,6 +40,20 @@ class TestBenchmark < Test::Unit::TestCase
           end
         end
 
+        @m = Dalli::Client.new(@servers)
+        x.report("setq:plain:dalli") do
+          @m.multi do
+            n.times do
+              @m.set @key1, @marshalled, 0, :raw => true
+              @m.set @key2, @marshalled, 0, :raw => true
+              @m.set @key3, @marshalled, 0, :raw => true
+              @m.set @key1, @marshalled, 0, :raw => true
+              @m.set @key2, @marshalled, 0, :raw => true
+              @m.set @key3, @marshalled, 0, :raw => true
+            end
+          end
+        end
+
         @m = Dalli::Client.new(@servers)
         x.report("set:ruby:dalli") do
           n.times do
@@ -114,6 +128,29 @@ class TestBenchmark < Test::Unit::TestCase
           end
         end
 
+        @m = Dalli::Client.new(@servers)
+        x.report("mixedq:ruby:dalli") do
+          @m.multi do
+            n.times do
+              @m.set @key1, @value
+              @m.set @key2, @value
+              @m.set @key3, @value
+              @m.get @key1
+              @m.get @key2
+              @m.get @key3
+              @m.set @key1, @value
+              @m.get @key1
+              @m.set @key2, @value
+              @m.replace @key2, @value
+              @m.delete @key3
+              @m.add @key3, @value
+              @m.get @key2
+              @m.set @key3, @value
+              @m.get @key3
+            end
+          end
+        end
+
         @m = Dalli::Client.new(@servers)
         x.report("incr:ruby:dalli") do
           n.times do

data/test/test_dalli.rb

@@ -26,6 +26,17 @@ class TestDalli < Test::Unit::TestCase
     assert_equal s2, s3
   end
 
+  should "have the continuum sorted by value" do
+    servers = [stub(:hostname => "localhost", :port => "11211", :weight => 1),
+               stub(:hostname => "localhost", :port => "9500", :weight => 1)]
+    ring = Dalli::Ring.new(servers, {})
+    previous_value = 0
+    ring.continuum.each do |entry|
+      assert entry.value > previous_value
+      previous_value = entry.value
+    end
+  end
+
   context 'using a live server' do
 
     should "support get/set" do
@@ -110,6 +121,19 @@ class TestDalli < Test::Unit::TestCase
         dc.set('c', %w(a b c))
         resp = dc.get_multi(%w(a b c d e f))
         assert_equal({ 'a' => 'foo', 'b' => 123, 'c' => %w(a b c) }, resp)
+
+        # Perform a huge multi-get with 10,000 elements.
+        arr = []
+        dc.multi do
+          10_000.times do |idx|
+            dc.set idx, idx
+            arr << idx
+          end
+        end
+
+        result = dc.get_multi(arr)
+        assert_equal(10_000, result.size)
+        assert_equal(1000, result['1000'])
       end
     end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 9
-  - 8
-  version: 0.9.8
+  - 9
+  version: 0.9.9
 platform: ruby
 authors: 
 - Mike Perham
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-29 00:00:00 -07:00
+date: 2010-10-06 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -82,6 +82,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/action_controller/session/dalli_store.rb
 - lib/action_dispatch/middleware/session/dalli_store.rb
 - lib/active_support/cache/dalli_store.rb
 - lib/active_support/cache/dalli_store23.rb