orientdb4r 0.3.0 → 0.3.1

data/changelog.txt

@@ -1,3 +1,7 @@
+0.3.1 2012-08-27
+- Timeout for reuse of dirty (already failed) nodes in load balancing
+- Bug Fix #14, #15
+
 0.3.0 2012-08-01
 - introduced support for cluster of distributed servers
 - initial strategies for load balancing: sequence, round robin

data/fstudy/flat_class_perf.rb

@@ -20,7 +20,7 @@ class FlatClassPerf < FStudy::Case
     client.command 'DELETE FROM User'
   end
   def data
-    1.upto(10000) do |i|
+    1.upto(100000) do |i|
       Orientdb4r::logger.info "...done: #{i}" if 0 == (i % 1000)
       first_name = dg.word
       surname = dg.word

data/lib/orientdb4r/client.rb

@@ -9,10 +9,23 @@ module Orientdb4r
     # # Regexp to validate format of providet version.
     SERVER_VERSION_PATTERN = /^\d+\.\d+\.\d+/
 
+    # connection parameters
     attr_reader :user, :password, :database
+    # version loaded from server
     attr_reader :server_version
-    attr_reader :nodes, :connection_library
-    attr_reader :load_balancing, :lb_strategy
+    # type of connection library [:restclient, :excon]
+    attr_reader :connection_library
+    # type of load balancing [:sequence, :round_robin]
+    attr_reader :load_balancing
+    # proxy for remote communication
+    attr_reader :proxy
+
+    # intern structures
+
+    # nodes responsible for communication with a server
+    attr_reader :nodes
+    # object implementing a LB strategy
+    attr_reader :lb_strategy
 
     ###
     # Constructor.
@@ -282,6 +295,7 @@ module Orientdb4r
 
           rescue NodeError => e
             Orientdb4r::logger.error "node error, index=#{idx}, msg=#{e.message}, #{node}"
+            node.cleanup
             lb_strategy.bad_one idx
             idx = lb_strategy.node_index
           end

data/lib/orientdb4r/load_balancing.rb

@@ -4,7 +4,7 @@ module Orientdb4r
   # Base class for implementation of load balancing strategy.
   class LBStrategy
 
-    # If occures a new try to communicate from node can be tested.
+    # If occures a new try to communicate from node can be tested [s].
     RECOVERY_TIMEOUT = 30
 
     attr_reader :nodes_count, :bad_nodes
@@ -39,17 +39,39 @@ module Orientdb4r
 
     protected
 
+      ###
+      # Tries to find a new node if the given failed.
+      # Returns <i>nil</i> if no one found
       def search_next_good(bad_idx)
         Orientdb4r::logger.warn "identified bad node, idx=#{bad_idx}, age=#{Time.now - @bad_nodes[bad_idx]} [s]"
+
+        # alternative nodes of not found a good one
+        timeout_candidate = nil
+
+        # first round - try to find a first good one
         1.upto(nodes_count) do |i|
           candidate = (i + bad_idx) % nodes_count
-          unless @bad_nodes.include? candidate
+
+          if @bad_nodes.include? candidate
+            failure_time = @bad_nodes[candidate]
+            now = Time.now
+            # timeout candidate
+            if (now - failure_time) > RECOVERY_TIMEOUT
+              timeout_candidate = candidate
+              Orientdb4r::logger.debug "node timeout recovery, idx=#{candidate}"
+              good_one(candidate)
+            end
+          else
             Orientdb4r::logger.debug "found good node, idx=#{candidate}"
             return candidate
           end
         end
 
-        # TODO implement search based on LRU for next round
+        # no good index found -> try timeouted one
+        unless timeout_candidate.nil?
+          Orientdb4r::logger.debug "good node not found, delivering timeouted one, idx=#{timeout_candidate}"
+          return timeout_candidate
+        end
 
         Orientdb4r::logger.error 'no nodes more, all invalid'
         nil

data/lib/orientdb4r/rest/client.rb

@@ -12,18 +12,22 @@ module Orientdb4r
 
     def initialize(options) #:nodoc:
       super()
-      options_pattern = { :host => 'localhost', :port => 2480, :ssl => false,
-                          :nodes => :optional, :load_balancing => :sequence,
-                          :connection_library => Orientdb4r::connection_library}
+      options_pattern = {
+        :host => 'localhost', :port => 2480, :ssl => false,
+        :nodes => :optional,
+        :connection_library => :restclient,
+        :load_balancing => :sequence,
+        :proxy => :optional
+      }
       verify_and_sanitize_options(options, options_pattern)
 
       # fake nodes for single server
       if options[:nodes].nil?
         options[:nodes] = [{:host => options[:host], :port => options[:port], :ssl => options[:ssl]}]
       end
-      raise ArgumentError, 'nodes has to be arrray' unless options[:nodes].is_a? Array
+      raise ArgumentError, 'nodes has to be array' unless options[:nodes].is_a? Array
 
-      # instantiate nodes accroding to HTTP library
+      # instantiate nodes according to HTTP library
       @connection_library = options[:connection_library]
       node_clazz = case connection_library
         when :restclient then Orientdb4r::RestClientNode
@@ -45,6 +49,14 @@ module Orientdb4r
         else raise ArgumentError, "unknow load balancing type: #{load_balancing}"
       end
 
+      # proxy
+      @proxy = options[:proxy]
+      unless proxy.nil?
+        case connection_library
+          when :restclient then ::RestClient.proxy = proxy
+          when :excon then nodes.each { |node| node.proxy = proxy }
+        end
+      end
 
       Orientdb4r::logger.info "client initialized with #{@nodes.size} node(s) "
       Orientdb4r::logger.info "connection_library=#{options[:connection_library]}, load_balancing=#{load_balancing}"

data/lib/orientdb4r/rest/excon_node.rb

@@ -7,6 +7,8 @@ module Orientdb4r
   # accessible view REST API and 'excon' library on the client side.
   class ExconNode < RestNode
 
+    attr_accessor :proxy
+
     def request(options) #:nodoc:
       verify_options(options, {:user => :mandatory, :password => :mandatory, \
           :uri => :mandatory, :method => :mandatory, :content_type => :optional, :data => :optional})
@@ -77,10 +79,15 @@ module Orientdb4r
       ###
       # Gets Excon connection.
       def connection
-        @connection ||= Excon::Connection.new(url)
-          #:read_timeout => self.class.read_timeout,
-          #:write_timeout => self.class.write_timeout,
-          #:connect_timeout => self.class.connect_timeout
+        return @connection unless @connection.nil?
+
+        options = {}
+        options[:proxy] = proxy unless proxy.nil?
+
+        @connection ||= Excon::Connection.new(url, options)
+        #:read_timeout => self.class.read_timeout,
+        #:write_timeout => self.class.write_timeout,
+        #:connect_timeout => self.class.connect_timeout
       end
 
       ###

data/lib/orientdb4r/version.rb

@@ -2,6 +2,7 @@ module Orientdb4r
 
   # Version history.
   VERSION_HISTORY = [
+    ['0.3.1',   '2012-08-27', "Timeout for reuse of dirty nodes in load balancing; BF #14, BF #15"],
     ['0.3.0',   '2012-08-01', "Added support for cluster of distributed servers + load balancing"],
     ['0.2.10',  '2012-07-21', "Experimental support for Excon HTTP library with Keep-Alive connection"],
     ['0.2.9',   '2012-07-18', "Added feature Client#delete_database, New class Rid"],

data/lib/orientdb4r.rb

@@ -40,21 +40,10 @@ module Orientdb4r
       }
     end
 
-    ###
-    # All calls to REST API will use the proxy specified here.
-    def rest_proxy(url)
-      RestClient.proxy = url
-    end
-
     ###
     # Logger used for logging output
     attr_accessor :logger
 
-    ###
-    # Predefined connection library.
-    # Can be overriden by option in client initialization.
-    attr_accessor :connection_library
-
   end
 
 
@@ -99,10 +88,6 @@ end
 Orientdb4r::logger = Logger.new(STDOUT)
 Orientdb4r::logger.level = Logger::INFO
 
-# Default connection library
-Orientdb4r::connection_library = :restclient
-#Orientdb4r::connection_library = :excon
-
 Orientdb4r::logger.info \
     "Orientdb4r #{Orientdb4r::VERSION}, running on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
 

data/test/test_client.rb

@@ -0,0 +1,86 @@
+require 'test/unit'
+require 'orientdb4r'
+
+###
+# This class tests communication with OrientDB cluster and load balancing.
+class TestClient < Test::Unit::TestCase
+
+  Orientdb4r::logger.level = Logger::DEBUG
+
+  PROXY_URL = 'http://bad.domain.com'
+
+
+  ###
+  # Test inintialization of single node.
+  def test_one_node_initialization
+    client = Orientdb4r.client :instance => :new
+    assert_not_nil client.nodes
+    assert_instance_of Array, client.nodes
+    assert_equal 1, client.nodes.size
+    assert_equal 2480, client.nodes[0].port
+    assert_equal false, client.nodes[0].ssl
+  end
+
+  ###
+  # Test inintialization of more nodes.
+  def test_nodes_initialization
+    client = Orientdb4r.client :nodes => [{}, {:port => 2481}], :instance => :new
+    assert_not_nil client.nodes
+    assert_instance_of Array, client.nodes
+    assert_equal 2, client.nodes.size
+    assert_equal 2480, client.nodes[0].port
+    assert_equal 2481, client.nodes[1].port
+    assert_equal false, client.nodes[0].ssl
+    assert_equal false, client.nodes[1].ssl
+
+    client = Orientdb4r.client :nodes => [{}, {:port => 2481}, {:port => 2482}], :instance => :new
+    assert_equal 3, client.nodes.size
+  end
+
+  ###
+  # Tests initialization of connection library.
+  def test_connection_library
+    # restclient
+    client = Orientdb4r.client :instance => :new
+    assert_equal :restclient, client.connection_library
+    assert_instance_of Orientdb4r::RestClientNode, client.nodes[0]
+
+    # excon
+    client = Orientdb4r.client :connection_library => :excon, :instance => :new
+    assert_equal :excon, client.connection_library
+    assert_instance_of Orientdb4r::ExconNode, client.nodes[0]
+  end
+
+  ###
+  # Tests initialization of proxy.
+  def test_proxy
+    # no proxy - resclient
+    client = Orientdb4r.client :instance => :new
+    assert_nil client.proxy
+    assert_nil RestClient.proxy
+
+    # proxy - restclient
+    client = Orientdb4r.client :proxy => PROXY_URL, :instance => :new
+    assert_equal PROXY_URL, client.proxy
+    assert_equal PROXY_URL, RestClient.proxy
+    assert_raise Orientdb4r::ConnectionError do
+      client.connect :database => 'temp', :user => 'admin', :password => 'admin'
+    end
+    RestClient.proxy = nil # restore no setting
+
+    # no proxy - excon
+    client = Orientdb4r.client :connection_library => :excon, :instance => :new
+    assert_nil client.proxy
+    assert_nil client.nodes[0].proxy
+
+    # proxy - restclient
+    client = Orientdb4r.client :connection_library => :excon, :proxy => PROXY_URL, :instance => :new
+    assert_equal PROXY_URL, client.proxy
+    assert_equal PROXY_URL, client.nodes[0].proxy
+    assert_raise Orientdb4r::ConnectionError do
+      client.connect :database => 'temp', :user => 'admin', :password => 'admin'
+    end
+  end
+
+
+end

data/test/{test_distributed.rb → test_loadbalancing.rb}

@@ -3,39 +3,16 @@ require 'orientdb4r'
 
 ###
 # This class tests communication with OrientDB cluster and load balancing.
-class TestDatabase < Test::Unit::TestCase
+class TestLoadBalancing < Test::Unit::TestCase
 
   Orientdb4r::logger.level = Logger::DEBUG
 
 
-  ###
-  # Test inintialization of single node.
-  def test_one_node_initialization
-    client = Orientdb4r.client :instance => :new
-    assert_not_nil client.nodes
-    assert_instance_of Array, client.nodes
-    assert_equal 1, client.nodes.size
-    assert_equal 2480, client.nodes[0].port
-    assert_equal false, client.nodes[0].ssl
-  end
-
-  ###
-  # Test inintialization of more nodes.
-  def test_nodes_initialization
-    client = Orientdb4r.client :nodes => [{}, {:port => 2481}], :instance => :new
-    assert_not_nil client.nodes
-    assert_instance_of Array, client.nodes
-    assert_equal 2, client.nodes.size
-    assert_equal 2480, client.nodes[0].port
-    assert_equal 2481, client.nodes[1].port
-    assert_equal false, client.nodes[0].ssl
-    assert_equal false, client.nodes[1].ssl
-  end
-
   ###
   # Test default Sequence strategy.
   def test_sequence_loadbalancing
     client = Orientdb4r.client :nodes => [{}, {:port => 2481}], :instance => :new
+    assert_equal :sequence, client.load_balancing
     lb_strategy = client.lb_strategy
     assert_not_nil lb_strategy
     assert_instance_of Orientdb4r::Sequence, lb_strategy
@@ -49,6 +26,7 @@ class TestDatabase < Test::Unit::TestCase
   # Test RoundRobin strategy.
   def test_roundrobin_loadbalancing
     client = Orientdb4r.client :nodes => [{}, {:port => 2481}], :load_balancing => :round_robin, :instance => :new
+    assert_equal :round_robin, client.load_balancing
     lb_strategy = client.lb_strategy
     assert_not_nil lb_strategy
     assert_instance_of Orientdb4r::RoundRobin, lb_strategy
@@ -60,6 +38,8 @@ class TestDatabase < Test::Unit::TestCase
     assert_equal client.nodes[1], client.nodes[client.lb_strategy.node_index]
   end
 
+  ###
+  # Tests variant reasons for LB failure.
   def test_load_balancing_in_problems
     # invalid port
     client = Orientdb4r.client :port => 9999, :instance => :new

data/test/test_utils.rb

@@ -3,7 +3,7 @@ require 'orientdb4r'
 
 ###
 # This class tests Utils methods.
-class TestDmo < Test::Unit::TestCase
+class TestUtils < Test::Unit::TestCase
   include Orientdb4r::Utils
 
   def test_verify_options

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orientdb4r
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-01 00:00:00.000000000 Z
+date: 2012-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -65,11 +65,12 @@ files:
 - lib/orientdb4r/version.rb
 - orientdb4r.gemspec
 - test/readme_sample.rb
+- test/test_client.rb
 - test/test_database.rb
 - test/test_ddo.rb
-- test/test_distributed.rb
 - test/test_dmo.rb
 - test/test_document_crud.rb
+- test/test_loadbalancing.rb
 - test/test_utils.rb
 homepage: http://github.com/veny/orientdb4r
 licenses: []
@@ -92,15 +93,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.19
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Ruby binding for Orient DB.
 test_files:
 - test/readme_sample.rb
+- test/test_client.rb
 - test/test_database.rb
 - test/test_ddo.rb
-- test/test_distributed.rb
 - test/test_dmo.rb
 - test/test_document_crud.rb
+- test/test_loadbalancing.rb
 - test/test_utils.rb