right_support 2.10.1 → 2.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45713709a34db9049a788ea3bd6e371bc9cdcb2c
-  data.tar.gz: 9ae79e61f4b120b3bdc15c03da6df873d8bed016
+  metadata.gz: 169232720914f75758ba15e8bb1b14864c143226
+  data.tar.gz: a7a1d9eb7ba2a0686ee2ddc0a5839a0d4ede6166
 SHA512:
-  metadata.gz: b4eef7bc6bc87bcd4c275935533be46b4f222291fce03e48a995595c952d0d8116cba0ce6fe1769ec660b3ec92536a112aa3008a40a4283c4f9a4ea4d9c2017a
-  data.tar.gz: 5074d0f87841daa8df2a59dfcf4f9ca0e724ee0c9cdc1748ebe07719b1fa7e513722e8bb24b92eb4aee3047c44d5fe45cf553bd5d3c24411ecd89ceb200ec84c
+  metadata.gz: 57e4fd72803654f3e772cebe5c9f4a22066067dac8926b507edcadad35931ddebf9fd51a33916dbd06a27abae561144e075b840d77c9a4bd1e37286c4d1b26b1
+  data.tar.gz: ca11d752bb148b96d426f228d23215b7a751d26df821d1e43f8be7200b7a71fb395f18df9640d02d276b7642787a89b26cdb8fc173e6cb047073994cb0d03a38

data/VERSION

@@ -1 +1 @@
-2.10.1
+2.11.2

data/lib/right_support/data/token.rb

@@ -0,0 +1,51 @@
+#
+# Copyright (c) 2016 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'digest/md5'
+
+module RightSupport::Data
+
+  # unique token generator. short tokens that are friendler than raw UUIDs for
+  # logging purposes, etc.
+  class Token
+
+    # exact length of all generated tokens.
+    TOKEN_LENGTH = 13
+
+    # Generate new token
+    #
+    # @return [String] token
+    def self.generate
+      # MD5 is 128bit = 25 chars in base 36, need to fit in less
+      # The code below produces a 64 bit value evenly distributed.
+      i = ::Digest::MD5.hexdigest(::RightSupport::Data::UUID.generate).to_i(16)
+      t = ((i >> 64) ^ (i & 0xFFFFFFFFFFFFFFFF)).to_s(36)
+
+      # left-pad with zeros to keep token length consistant.
+      if t.length < TOKEN_LENGTH
+        t = '0' * (TOKEN_LENGTH - t.length) + t
+      end
+      t
+    end
+
+  end
+end

data/lib/right_support/data.rb

@@ -34,3 +34,4 @@ require 'right_support/data/serializer'
 require 'right_support/data/hash_tools'
 require 'right_support/data/uuid'
 require 'right_support/data/mash'
+require 'right_support/data/token'

data/lib/right_support/net/lb/base.rb

@@ -0,0 +1,96 @@
+#
+# Copyright (c) 2016 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module RightSupport::Net::LB
+
+  # base class for load balancer policies.
+  class Base
+
+    # @param [Hash] options provided for derived policies
+    def initialize(options = {})
+      @options = options.dup
+      @endpoints = []
+      @counter = rand(0xffff)
+
+      # note that not all policies require health-checking but the request
+      # balancer will provide the callback by default.
+      @health_check = @options.delete(:health_check)
+      if @health_check && !@health_check.respond_to?(:call)
+        raise ::ArgumentError, ':health_check is invalid.'
+      end
+    end
+
+    # override only if endpoint selection is non-trivial
+    def set_endpoints(endpoints)
+      @endpoints = endpoints
+      true
+    end
+
+    # override only if endpoint selection is non-trivial
+    def next
+      result = nil
+      unless @endpoints.empty?
+        # endpoint, no health-check required.
+        result = [ @endpoints[@counter % @endpoints.size], false ]
+        @counter += 1
+      end
+      result
+    end
+
+    # override only if statisics are kept
+    #
+    # @return [TrueClass] always true
+    def good(endpoint, t0, t1)
+      true
+    end
+
+    # override only if statisics are kept
+    #
+    # @return [TrueClass] always true
+    def bad(endpoint, t0, t1)
+      true
+    end
+
+    # performs a basic health-check for given endpoint using functor and updates
+    # statistics, if kept.
+    #
+    # @param [String] endpoint for check
+    #
+    # @return [TrueClass] always true
+    def health_check(endpoint)
+      t0 = ::Time.now
+      result = @health_check.call(endpoint)
+      t1 = ::Time.now
+      if result
+        good(endpoint, t0, t1)
+        return true
+      end
+      bad(endpoint, t0, t1)
+      return false
+    rescue ::Exception
+      t1 = ::Time.now
+      bad(endpoint, t0, t1)
+      raise
+    end
+
+  end
+end

data/lib/right_support/net/lb/health_check.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2011 RightScale Inc
+# Copyright (c) 2011-2016 RightScale Inc
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -89,9 +89,10 @@ module RightSupport::Net::LB
     # Returns a hash of endpoints and their colored health status
     # Useful for logging and debugging
     def get_stats
-      stats = {}
-      @endpoints.each { |k, v| stats[k] = state_color(v[:n_level]) }
-      stats
+      @endpoints.inject({}) do |stats, (k, v)|
+        stats[k] = state_color(v[:n_level])
+        stats
+      end
     end
 
     # Replace the set of endpoints that this object knows about. If any
@@ -129,71 +130,46 @@ module RightSupport::Net::LB
   # reported on the way back down, e.g., yellow is reported as soon as the first endpoint
   # transitions from red to yellow, and so on.
 
-  class HealthCheck
+  class HealthCheck < ::RightSupport::Net::LB::Base
     include RightSupport::Log::Mixin
 
     def initialize(options = {})
-      @options = options
+      super
+      @stack = nil
     end
 
     def set_endpoints(endpoints)
       if @stack
         @stack.update!(endpoints)
       else
-        @health_check = @options.delete(:health_check)
-        @counter = Process.pid
-        @last_size = endpoints.size
         @stack = EndpointsStack.new(self, endpoints, @options[:yellow_states], @options[:reset_time], @options[:on_health_change])
       end
+      true
     end
 
     def next
-      # Returns the array of hashes which consists of yellow and green endpoints with the
-      # following structure: [ [EP1, {:n_level => ..., :timestamp => ... }], [EP2, ... ] ]
-      endpoints = @stack.sweep_and_return_yellow_and_green
-      return nil if endpoints.empty?
-
-      # From the available set, use a RoundRobin-like algorithm to select the next endpoint.
-      # When the size of the available set changes, try not to disturb our index into the list.
-      @counter += 1 unless endpoints.size < @last_size
-      @counter %= endpoints.size
-      @last_size = endpoints.size
-
-      # Hash#select returns a Hash in ruby1.9, but an Array of pairs in ruby1.8.
-      # This should really be encapsulated in EndpointsStack...
-      if RUBY_VERSION >= '1.9'
-        key = endpoints.keys[@counter]
-        next_endpoint = [ key, endpoints[key][:n_level] != 0 ]
-      else
-        next_endpoint = [ endpoints[@counter][0], endpoints[@counter][1][:n_level] != 0 ]
+      # avoid red endpoints until they timeout, which may leave us with none
+      # temporarily. the idea is to have multiple endpoints such that one or
+      # more can go down while others continue to respond.
+      result = nil
+      yg_eps = @stack.sweep_and_return_yellow_and_green
+      unless yg_eps.empty?
+        @endpoints = yg_eps.keys
+        if result = super
+          result[1] = yg_eps[result[0]][:n_level] != 0
+        end
       end
-
-      next_endpoint
+      result
     end
 
     def good(endpoint, t0, t1)
       @stack.decrease_state(endpoint, t0, t1)
+      true
     end
 
     def bad(endpoint, t0, t1)
       @stack.increase_state(endpoint, t0, t1)
-    end
-
-    def health_check(endpoint)
-      t0 = Time.now
-      result = @health_check.call(endpoint)
-      t1 = Time.now
-      if result
-        @stack.decrease_state(endpoint, t0, t1)
-        return true
-      else
-        @stack.increase_state(endpoint, t0, t1)
-        return false
-      end
-    rescue Exception => e
-      t1 = Time.now
-      @stack.increase_state(endpoint, t0, t1)
-      raise
+      true
     end
 
     # Proxy to EndpointStack

data/lib/right_support/net/lb/round_robin.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2011 RightScale Inc
+# Copyright (c) 2011-2016 RightScale Inc
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -21,32 +21,14 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 module RightSupport::Net::LB
-  class RoundRobin
+  class RoundRobin < ::RightSupport::Net::LB::Base
 
-    def initialize(options ={})
-      @endpoints = []
-      @counter = rand(0xffff)
-    end
-
-    def set_endpoints(endpoints)
-      @endpoints = endpoints
-    end
-
-    def next
-      @counter += 1
-      [ @endpoints[@counter % @endpoints.size], false ] unless @endpoints.empty?
-    end
-
-    def good(endpoint, t0, t1)
-      #no-op; round robin does not care about failures
-    end
-
-    def bad(endpoint, t0, t1)
-      #no-op; round robin does not care about failures
+    def initialize(options = {})
+      super
     end
 
     def health_check(endpoint)
-      #no-op; round robin does not perform health checks
+      # no-op; round robin does not perform health checks
       true
     end
   end

data/lib/right_support/net/lb/sticky.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2011 RightScale Inc
+# Copyright (c) 2011-2016 RightScale Inc
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -29,52 +29,35 @@ module RightSupport::Net::LB
   # - re-iterate through each endpoint when it's endpoint loses validity;
   # - return an Exception if it performs a complete iteration though each endpoint and finds none valid;
 
-  class Sticky
+  class Sticky < ::RightSupport::Net::LB::Base
 
     def initialize(options = {})
-      @health_check = options.delete(:health_check)
-      @endpoints = []
-      @counter = rand(0xffff)
+      super
     end
 
     def set_endpoints(endpoints)
       unless @endpoints.empty?
-        last_chosen = self.next.first
+        last_chosen = @endpoints[@counter % @endpoints.size]
         @endpoints = []
         if endpoints.include?(last_chosen)
           @endpoints << last_chosen
           @counter = 0
         end
       end
-      @endpoints |= endpoints
+      @endpoints |= endpoints  # a union of endpoints
+      true
     end
 
     def next
+      # note that counter is not incremented here; hence stickyness.
       [ @endpoints[@counter % @endpoints.size], false ] unless @endpoints.empty?
     end
 
-    def good(endpoint, t0, t1)
-      #no-op; round robin does not care about failures
-    end
-
     def bad(endpoint, t0, t1)
+      # increment from bad endpoint index to unstick. this is only meaningful if
+      # there are multiple endpoints.
       @counter += 1
-    end
-
-    def health_check(endpoint)
-      t0 = Time.now
-      result = @health_check.call(endpoint)
-      t1 = Time.now
-      if result
-        return true
-      else
-        @counter += 1
-        return false
-      end
-    rescue Exception => e
-      t1 = Time.now
-      @counter += 1
-      raise
+      nil
     end
 
   end

data/lib/right_support/net/lb.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2011 RightScale Inc
+# Copyright (c) 2011-2016 RightScale Inc
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -28,6 +28,7 @@ module RightSupport::Net::LB
 
 end
 
+require 'right_support/net/lb/base'
 require 'right_support/net/lb/health_check'
 require 'right_support/net/lb/round_robin'
 require 'right_support/net/lb/sticky'