redis-rpc 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0e33433f97014ca9e292fc721e48271ff83ec58
-  data.tar.gz: ea4b5130c90bbb44a926a3e88e5be2d46adb0189
+  metadata.gz: d608b2b9dcd7726ea7cf1bd599a2660c14bdcb61
+  data.tar.gz: b092789f2589d8a295e5d107eec22fded3b0d99a
 SHA512:
-  metadata.gz: f08569b5d4f2186c956efd1bb195adc56577269551c823645d0affad65c309a9efe1808b59d125e7254580ed5deb4ab236d2c8c22a40c86782b89b862c94efa2
-  data.tar.gz: fa9ebbd23ebf9912181f1a09fe7a241892be87d1dc985f2757a640ca14770506248db2c2f87f6fa28f6a3c702f7250140a25092c9baea0698bd75575479b88d4
+  metadata.gz: ec293260273ea94bda89e29b7d0529446de63e2f1ed0fd0ecc29dbcdfbe02e74c003a1627ee7622da45653ed6008a1d9ece7317d99fbbb84e5906a1aa892b1a4
+  data.tar.gz: 01b70312c304a9a27b98356aa0fcfd86d1e3518ad4d03d9a7d514918de618e41969b09bf8fbee8ea844e178cc04ddf2d217ff6e5946b6586891e4ab734cc953d

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    redis-rpc (1.1.0)
+    redis-rpc (1.2.0)
       multi_json (~> 1.3)
       redis
 
 GEM
   remote: http://rubygems.org/
   specs:
+    byebug (10.0.2)
     diff-lcs (1.3)
     multi_json (1.13.1)
     rake (0.9.2)
@@ -31,6 +32,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
+  byebug
   rake
   redis-rpc!
   rspec

data/lib/redis-rpc.rb

@@ -48,13 +48,23 @@ module RedisRpc
     end
 
     alias :send! :send
+
+    def get_timeout_at
+      # allow mock to manipulate timeout to verify safety behavior
+      Time.now.to_i + @timeout + 60
+    end
+
     def send( method_name, *args)
       raise MalformedRequestException, 'block not allowed over RPC' if block_given?
 
       # request setup
       function_call = {'name' => method_name.to_s, 'args' => args}
       response_queue = @message_queue + ':rpc:' + rand_string
-      rpc_request = {'function_call' => function_call, 'response_queue' => response_queue}
+      rpc_request = {
+        'function_call' => function_call, 'response_queue' => response_queue,
+        'timeout_at' => get_timeout_at,
+      }
+
       rpc_raw_request = MultiJson.dump rpc_request
 
       # transport
@@ -121,9 +131,17 @@ module RedisRpc
 
       # request execution
       begin
+        if rpc_request['timeout_at'].nil?
+          raise "Unsafe RPC call: timeout_at not specified"
+        end
+
+        if rpc_request['timeout_at'] < Time.now.to_i
+          raise "Expired RPC call. timeout_at = #{rpc_request['timeout_at']}. Time.now = #{Time.now.to_i}"
+        end
+
         return_value = @local_object.send( function_call['name'].to_sym, *function_call['args'] )
         rpc_response = {'return_value' => return_value}
-      rescue Object => err
+      rescue Exception => err
         rpc_response = {'exception' => err.to_s, 'backtrace' => err.backtrace}
       end
 
@@ -142,7 +160,7 @@ module RedisRpc
 
     def timeout
       @timeout or
-      $REDISRPC_SERVER_TIMEOUT or
+        $REDISRPC_SERVER_TIMEOUT or
       0
     end
   end

data/lib/redis-rpc/version.rb

@@ -1,3 +1,3 @@
 module RedisRpc
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/redis-rpc.gemspec

@@ -42,4 +42,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
+  s.add_development_dependency 'byebug'
 end

data/spec/calculator_spec.rb

@@ -2,40 +2,57 @@ require File.expand_path( '../spec_helper.rb', __FILE__ )
 require File.expand_path( '../../examples/calc.rb', __FILE__ )
 
 describe Calculator do
-  [true,false].each do |over_redisrpc|
-    context "when run #{( over_redisrpc ? 'over redisrpc' : 'locally')}" do
-
-      if( over_redisrpc )
-        let(:rpc_server_builder){ lambda{ RedisRpc::Server.new( Redis.new($REDIS_CONFIG), 'calc', Calculator.new ) } }
-        before(:each) do
-          @server_pid = fork{ rpc_server_builder.call.run }
-        end
-        after(:each){ Process.kill(9, @server_pid); rpc_server_builder.call.flush_queue! }
-        let(:calculator){ RedisRpc::Client.new( $REDIS,'calc', 1) }
-      else
-        let(:calculator){ Calculator.new }
-      end
+  context "locally" do
+    let(:calculator){ Calculator.new }
 
-      it 'should calculate' do
-        calculator.val.should == 0.0
-        calculator.add(3).should == 3.0
-        calculator.sub(2).should == 1.0
-        calculator.mul(14).should == 14.0
-        calculator.div(7).should == 2.0
-        calculator.val.should == 2.0
-        calculator.clr.should == 0.0
-        calculator.val.should == 0.0
-      end
+    it 'should calculate' do
+      calculator.val.should == 0.0
+      calculator.add(3).should == 3.0
+      calculator.sub(2).should == 1.0
+      calculator.mul(14).should == 14.0
+      calculator.div(7).should == 2.0
+      calculator.val.should == 2.0
+      calculator.clr.should == 0.0
+      calculator.val.should == 0.0
+    end
 
-      it 'should raise when missing method is called' do
-        expect{ calculator.a_missing_method }.to raise_error(
-          over_redisrpc ? RedisRpc::RemoteException : NoMethodError
-        )
-      end
+    it 'should raise when missing method is called' do
+      expect{ calculator.a_missing_method }.to raise_error(NoMethodError)
+    end
+  end
+
+  context "over rpc" do
+    let(:rpc_server_builder){ lambda{ RedisRpc::Server.new( Redis.new($REDIS_CONFIG), 'calc', Calculator.new ) } }
+    before(:each) do
+      @server_pid = fork{ rpc_server_builder.call.run }
+    end
+    after(:each){ Process.kill(9, @server_pid); rpc_server_builder.call.flush_queue! }
+    let(:calculator){ RedisRpc::Client.new( $REDIS,'calc', 1) }
 
-      it 'should raise timeout when execution expires' do
-        expect{ calculator.send(:sleep,2) }.to raise_error RedisRpc::TimeoutException
-      end if over_redisrpc
+    it 'should calculate' do
+      calculator.val.should == 0.0
+      calculator.add(3).should == 3.0
+      calculator.sub(2).should == 1.0
+      calculator.mul(14).should == 14.0
+      calculator.div(7).should == 2.0
+      calculator.val.should == 2.0
+      calculator.clr.should == 0.0
+      calculator.val.should == 0.0
+    end
+
+    it 'should raise when missing method is called' do
+      expect{ calculator.a_missing_method }.to raise_error(RedisRpc::RemoteException)
+    end
+
+    it 'should raise timeout when execution expires' do
+      expect{ calculator.send(:sleep,2) }.to raise_error RedisRpc::TimeoutException
+    end
+
+    context "the request is executed late" do
+      it "won't be executed" do
+        allow(calculator).to receive(:get_timeout_at).and_return(Time.now.to_i - 1)
+        expect { calculator.val }.to raise_error(RedisRpc::RemoteException, /Expired RPC call/)
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-rpc
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Phuong Nguyen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-20 00:00:00.000000000 Z
+date: 2018-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -81,6 +81,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: |2
       RedisRpc is the easiest to use RPC library in the world. (No small claim!).
       This version is a repackage that only has Ruby implementation.