renoir 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 461d2ccdb278c0d426ec55fdd18842ada523e45e
-  data.tar.gz: 55e8b51738dbfee6aa2e9e679ac5fce0e2cded25
+  metadata.gz: 1c38bafe64d4e6e17eb9e8ac7bfda4518a16831f
+  data.tar.gz: 934d5766ccfa78fe3d7113f937ced20a2d9e1ae5
 SHA512:
-  metadata.gz: b2d01e508710e5be5ae0b2c73abb2019686e3623731b7cb1dfa527fa745946f8164e2995ee5e0eade1a579afe89f7f049a1d31543fe48712641cbfa3b406b19e
-  data.tar.gz: 20e8bf79891cf2f5631aa535426d0ccb3cc047d305bef1821be0f13a9fe6f68f830831511b40932590307d89265b3e9c55ea8339bf229346b90e3079ffff5b8c
+  metadata.gz: 29202c8ae95394db795908d472645f1134c04a50ead0833c6fd7c7348e3b251b4f9a9f2f12d0e91f621c041cd379430fdd0cb81e920f77467a103f629a6b73a5
+  data.tar.gz: 2521e02fd50177c9e2a380eb5025122177964d1d708ed4b2693873d417ec96771c27653a77271a326f4bae11b8aa9e956252dae49cce8c8c7ee0f113de89f07a

data/README.md

@@ -46,10 +46,37 @@ rc = Renoir::Client.new(
 
   # redis-rb options
   timeout: 100,
-  password: 'password'
+  password: 'password',
+  driver: :hiredis
 )
 ```
 
+### Pipelining
+
+Command pipelining is supported although "future" variable is not available at this point.
+
+```ruby
+rc.pipeliend do |pipeline|
+  pipeline.set('hoge{1}', 123)
+  pipeline.get('hoge{1}')
+  pipeline.get('fuga{1}')
+end
+# => ["OK", "123", nil]
+```
+
+If pipelined commands use different slot of key, it fails without dispatching command.
+
+You can also execute commands atomically with `#multi`:
+
+```ruby
+rc.multi do |pipeline|
+  pipeline.set('hoge{1}', 123)
+  pipeline.get('hoge{1}')
+  pipeline.get('fuga{1}')
+end
+# => ["OK", "123", nil]
+```
+
 ### Dispatch command to nodes directly
 
 Renoir dispatches a command only if a slot is determined by the command. This also includes no-keys commands like `KEYS`, `BGSAVE` and so on.

data/lib/renoir/client.rb

@@ -1,5 +1,6 @@
 require 'thread'
 require "renoir/cluster_info"
+require "renoir/pipeline"
 require "renoir/connection_adapters"
 require "renoir/crc16"
 
@@ -50,23 +51,30 @@ module Renoir
     end
 
     def eval(*args, &block)
-      call(eval, *args, &block)
+      call(:eval, *args, &block)
     end
 
-    def call(*command, &block)
-      keys = @adapter_class.get_keys_from_command(command)
-      slots = keys.map { |key| key_slot(key) }.uniq
-      fail "No way to dispatch this command to Redis Cluster." if slots.size != 1
-      slot = slots.first
+    def multi(&block)
+      commands = pipeline_commands(&block)
+      slot = get_slot_from_commands(commands)
 
-      refresh = @refresh_slots_mutex.synchronize do
-        refresh = @refresh_slots
-        @refresh_slots = false
-        refresh
-      end
-      refresh_slots if refresh
+      refresh_slots
+      call_with_redirection(slot, [[:multi]] + commands + [[:exec]])
+    end
+
+    def pipelined(&block)
+      commands = pipeline_commands(&block)
+      slot = get_slot_from_commands(commands)
+
+      refresh_slots
+      call_with_redirection(slot, commands)
+    end
+
+    def call(*command, &block)
+      slot = get_slot_from_commands([command])
 
-      call_with_redirection(slot, command, &block)
+      refresh_slots
+      call_with_redirection(slot, [command], &block)[0]
     end
 
     def close
@@ -102,7 +110,22 @@ module Renoir
       CRC16.crc16(key) % REDIS_CLUSTER_HASH_SLOTS
     end
 
-    def call_with_redirection(slot, command, &block)
+    def get_slot_from_commands(commands)
+      keys = commands.flat_map { |command| @adapter_class.get_keys_from_command(command) }.uniq
+      slots = keys.map { |key| key_slot(key) }.uniq
+      fail "No way to dispatch this command to Redis Cluster." if slots.size != 1
+      slots.first
+    end
+
+    def pipeline_commands(&block)
+      pipeline = Pipeline.new(
+        connection_adapter: @options[:connection_adapter]
+      )
+      yield pipeline
+      pipeline.commands
+    end
+
+    def call_with_redirection(slot, commands, &block)
       nodes = @cluster_info.nodes.dup
       node = @cluster_info.slot_node(slot) || nodes.sample
 
@@ -114,7 +137,7 @@ module Renoir
         nodes.delete(node)
 
         conn = fetch_connection(node)
-        reply = conn.call(command, asking, &block)
+        reply = conn.call(commands, asking, &block)
         case reply
         when ConnectionAdapters::Reply::RedirectionError
           asking = reply.ask
@@ -140,10 +163,17 @@ module Renoir
     end
 
     def refresh_slots
+      refresh = @refresh_slots_mutex.synchronize do
+        refresh = @refresh_slots
+        @refresh_slots = false
+        refresh
+      end
+      return unless refresh
+
       slots = nil
       @cluster_info.nodes.each do |node|
         conn = fetch_connection(node)
-        reply = conn.call(["cluster", "slots"])
+        reply = conn.call([["cluster", "slots"]])
         case reply
         when ConnectionAdapters::Reply::RedirectionError
           fail "never reach here"
@@ -152,7 +182,7 @@ module Renoir
             @logger.warn("CLUSTER SLOTS command failed: node_name=#{node[:name]}, message=#{reply.cause}")
           end
         else
-          slots = reply
+          slots = reply[0]
           break
         end
       end

data/lib/renoir/connection_adapters/base.rb

@@ -7,7 +7,7 @@ module Renoir
         end
       end
 
-      def call(command, asking=false, &block)
+      def call(commands, asking=false, &block)
         fail "a connection adapter must override #call"
       end
 

data/lib/renoir/connection_adapters/redis.rb

@@ -59,15 +59,30 @@ module Renoir
         @conn = ::Redis.new(options.merge(host: host, port: port))
       end
 
-      def call(command, asking=false, &block)
-        command, *args = command
-        if asking
-          @conn.multi do |tx|
-            tx.asking
-            tx.send(command, *args, &block)
+      def call(commands, asking=false, &block)
+        if commands[0][0].to_sym == :multi
+          fail 'EXEC command is required for MULTI' if commands[-1][0].to_sym != :exec
+          commands = commands[1..-2]
+          multi = true
+        end
+
+        if multi || asking
+          replies = @conn.multi do |tx|
+            tx.asking if asking
+            commands.each do |command, *args|
+              tx.send(command, *args, &block)
+            end
+          end
+          asking ? replies.slice(1..-1) : replies
+        elsif commands.size > 1
+          @conn.pipelined do |pipeline|
+            commands.each do |command, *args|
+              pipeline.send(command, *args, &block)
+            end
           end
         else
-          @conn.send(command, *args, &block)
+          command, *args = commands[0]
+          [@conn.send(command, *args, &block)]
         end
       rescue ::Redis::CommandError => e
         errv = e.to_s.split

data/lib/renoir/pipeline.rb

@@ -0,0 +1,21 @@
+module Renoir
+  class Pipeline
+    attr_reader :commands
+
+    def initialize(options={})
+      @commands = []
+    end
+
+    def eval(*args)
+      call(:eval, *args)
+    end
+
+    def call(*command)
+      @commands << command
+    end
+
+    def method_missing(command, *args, &block)
+      call(command, *args, &block)
+    end
+  end
+end

data/lib/renoir/version.rb

@@ -1,3 +1,3 @@
 module Renoir
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: renoir
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Hiroshi Saito
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-06 00:00:00.000000000 Z
+date: 2017-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -90,6 +90,7 @@ files:
 - lib/renoir/connection_adapters/redis.rb
 - lib/renoir/connection_adapters/reply.rb
 - lib/renoir/crc16.rb
+- lib/renoir/pipeline.rb
 - lib/renoir/version.rb
 - renoir.gemspec
 homepage: https://github.com/saidie/renoir
@@ -112,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Reliable Redis Cluster client library