hystrix-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NDZmNzZiMzUwMWYzNjk3NzY1M2Y0MWFjZjMwOGY2ODI0YmYzNDI0Zg==
+  data.tar.gz: !binary |-
+    YjhjZjM4MzY1NjA1ZmUwYzlkMTExZjBjMWZhYmM3ZTk1MDk0NjY4Mw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZTVhMjlhOWQzNzA3ZjA2ZWQ5ZDg0YzFiODRlNGY1MDRmMTJlOTY5MzJmZDRj
+    MGZkZDE3ZDhjZjA1YzA1Yjg0YzBkZmI5Njg1ZDAyNGRmNThlY2UzZDg4YmNh
+    ZDVhYTcxYTk5ZWQwZjliMjZiNzAwZGQzNDhjMDRkMzJiNTA3NDk=
+  data.tar.gz: !binary |-
+    ZTYwYTMwY2MyNTBlNzA3NmE3MTZiZjNkZGRhNjE0ZDBjNDI4MDIwNzM3NDYx
+    ZmYyYzgzMjY3ZGRkMDBhMWNiYjE0NzA4MWZiNWM3ODU5NTY2NzZjMjY1ZTY1
+    YjkzNTljMWEyZDU2M2Q2ZjBjY2JkNTg3NGQ4NjBmNGE4MDU2MmI=

data/lib/hystrix.rb

@@ -0,0 +1,16 @@
+require 'celluloid'
+
+require 'hystrix/command'
+require 'hystrix/configuration'
+require 'hystrix/circuit'
+require 'hystrix/dsl'
+require 'hystrix/executor_pool'
+require 'hystrix/inline'
+
+module Hystrix
+	extend DSL
+
+	def self.reset
+		CommandExecutorPools.instance.shutdown
+	end
+end

data/lib/hystrix/circuit.rb

@@ -0,0 +1,42 @@
+# Circuit-breaker to track and disable commands based on previous attempts
+module Hystrix
+	class Circuit
+		include Celluloid
+
+		attr_accessor :lock, :health, :recent_latency_errors, :last_health_check_time
+
+		def initialize
+			self.lock = Mutex.new
+			self.recent_latency_errors = []
+			self.health = 0
+			self.last_health_check_time = nil
+		end
+
+		def is_closed?
+			async.calculate_health if self.last_health_check_time == nil or self.last_health_check_time < Time.now.to_f - 10.0
+
+			return false unless self.is_healthy?
+			return true
+		end
+
+		def add_latency_error(duration)
+			self.lock.synchronize do
+				self.recent_latency_errors << {duration: duration, timestamp: Time.now.to_i}
+			end
+			async.calculate_health
+		end
+
+		def calculate_health
+			now = Time.now.to_i
+			self.lock.synchronize do
+				self.recent_latency_errors = self.recent_latency_errors.reject{|error| error[:timestamp] < now - 10}
+				self.health = self.recent_latency_errors.size * 0.2
+				self.last_health_check_time = now.to_f
+			end
+		end
+
+		def is_healthy?
+			self.health < 1
+		end
+	end
+end

data/lib/hystrix/command.rb

@@ -0,0 +1,79 @@
+# TODO: implement pluggable metrics collection. implement separate statsd impl
+
+module Hystrix
+	class ExecutorPoolFullError < StandardError; end
+	class CircuitClosedError < StandardError; end
+
+	class Command
+		include Celluloid
+
+		attr_accessor :executor_pool, :circuit
+
+		@default_pool_size = 10
+		def self.default_pool_size
+			@default_pool_size
+		end
+
+		def initialize(*args)
+			self.executor_pool = CommandExecutorPools.instance.get_pool(executor_pool_name, self.class.default_pool_size)
+			self.circuit = self.executor_pool.circuit_supervisor.actors.first
+		end
+
+		# Run the command synchronously
+		def execute
+			raise 'No executor pool found! Did you forget to call super in your initialize method?' unless executor_pool
+
+			executor = nil
+			start_time = Time.now
+
+			begin
+				raise CircuitClosedError unless self.circuit.is_closed?
+
+				executor = executor_pool.take
+				
+				result = executor.run(self)
+				duration = Time.now - start_time
+
+				Configuration.notify_success(executor_pool_name, duration)
+			rescue Exception => main_error
+				duration = Time.now - start_time
+
+				begin
+					if main_error.respond_to?(:cause)
+						result = fallback(main_error.cause)
+						Configuration.notify_fallback(executor_pool_name, duration, main_error.cause)
+					else
+						result = fallback(main_error)
+						Configuration.notify_fallback(executor_pool_name, duration, main_error)
+					end
+				rescue NotImplementedError => fallback_error
+					Configuration.notify_failure(executor_pool_name, duration, main_error)
+					raise main_error
+				end
+			ensure
+				executor.unlock if executor
+				self.terminate
+			end
+
+			return result
+		end
+
+		# Commands which share the value of executor_pool_name will use the same pool
+		def executor_pool_name
+			@executor_pool_name || self.class.name
+		end
+
+		# Run the command asynchronously
+		def queue
+			future.execute
+		end
+
+		def fallback(error)
+			raise NotImplementedError
+		end
+
+		def self.pool_size(size)
+			@default_pool_size = size
+		end
+	end
+end

data/lib/hystrix/configuration.rb

@@ -0,0 +1,36 @@
+module Hystrix
+	class Configuration
+		def self.on_success(&block)
+			@on_success = block
+		end
+		def self.notify_success(command_name, duration)
+			if @on_success
+				@on_success.call(command_name, duration)
+			end
+		end
+
+		def self.on_fallback(&block)
+			@on_fallback = block
+		end
+		def self.notify_fallback(command_name, duration, error)
+			if @on_fallback
+				@on_fallback.call(command_name, duration, error)
+			end
+		end
+
+		def self.on_failure(&block)
+			@on_failure = block
+		end
+		def self.notify_failure(command_name, duration, error)
+			if @on_failure
+				@on_failure.call(command_name, duration, error)
+			end
+		end
+
+		def self.reset
+			@on_success = nil
+			@on_fallback = nil
+			@on_failure = nil
+		end
+	end
+end

data/lib/hystrix/dsl.rb

@@ -0,0 +1,13 @@
+module Hystrix
+	module DSL
+		def configure(&block)
+			Configuration.class_eval(&block)
+		end
+
+		def inline(executor_pool_name = nil, &block)
+			inline = InlineDSL.new(executor_pool_name)
+			inline.instance_eval(&block)
+			inline.run
+		end
+	end
+end

data/lib/hystrix/executor_pool.rb

@@ -0,0 +1,96 @@
+require 'singleton'
+
+module Hystrix
+	class CommandExecutorPools
+		include Singleton
+
+		attr_accessor :pools, :lock
+
+		def initialize
+			self.lock = Mutex.new
+			self.pools = {}
+		end
+
+		def get_pool(pool_name, size = nil)
+			lock.synchronize do
+				pools[pool_name] ||= CommandExecutorPool.new(pool_name, size || 10)
+			end
+		end
+
+		def shutdown
+			lock.synchronize do
+				for pool_name, pool in pools
+					pool.shutdown
+				end
+			end
+		end
+	end
+
+	class CommandExecutorPool
+		attr_accessor :name, :size
+		attr_accessor :executors, :lock
+		attr_accessor :circuit_supervisor
+
+		def initialize(name, size)
+			self.name = name
+			self.size = size
+			self.executors = []
+			self.lock = Mutex.new
+			self.circuit_supervisor = Circuit.supervise
+			size.times do
+				self.executors << CommandExecutor.new
+			end
+		end
+
+		def take
+			lock.synchronize do
+				for executor in self.executors
+					unless executor.locked?
+						executor.lock
+						return executor
+					end
+				end
+			end
+
+			raise ExecutorPoolFullError.new("Unable to get executor from #{self.name} pool.")
+		end
+
+		def shutdown
+			lock.synchronize do
+				until executors.size == 0 do
+					for i in (0...executors.size)
+						unless executors[i].locked?
+							executors[i] = nil
+						end
+					end
+					executors.compact!
+					sleep 0.1
+				end
+			end
+		end
+	end
+
+	class CommandExecutor
+		attr_accessor :owner
+
+		def initialize
+			self.owner = nil
+		end
+
+		def lock
+			self.owner = Thread.current
+		end
+
+		def unlock
+			self.owner = nil
+		end
+		
+		def locked?
+			!self.owner.nil?
+		end
+
+		def run(command)
+			command.run
+		end
+	end
+end

data/lib/hystrix/inline.rb

@@ -0,0 +1,48 @@
+module Hystrix
+	class InlineDSL
+		def initialize(executor_pool_name = nil)
+			@executor_pool_name = executor_pool_name
+			@mode = :execute
+		end
+
+		def execute(&block)
+			@mode = :execute
+			@run_block = block
+		end
+
+		def queue(&block)
+			@mode = :queue
+			@run_block = block
+		end
+
+		def fallback(&block)
+			@fallback_block = block
+		end
+
+		def run
+			cmd = InlineCommand.new(@executor_pool_name, @run_block, @fallback_block)
+			cmd.send(@mode)
+		end
+	end
+
+	class InlineCommand < Command
+		def initialize(executor_pool_name, run_block, fallback_block)
+			@run_block = run_block
+			@fallback_block = fallback_block
+			@executor_pool_name = executor_pool_name
+			super
+		end
+
+		def run
+			@run_block.yield
+		end
+
+		def fallback(error)
+			if @fallback_block
+				@fallback_block.yield(error)
+			else
+				raise NotImplementedError
+			end
+		end
+	end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: hystrix-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Keith Thornhill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  name: celluloid
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  name: simplecov-rcov
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  name: timecop
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Hystrix for Ruby
+email: keith.thornhill@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/hystrix/circuit.rb
+- lib/hystrix/command.rb
+- lib/hystrix/configuration.rb
+- lib/hystrix/dsl.rb
+- lib/hystrix/executor_pool.rb
+- lib/hystrix/inline.rb
+- lib/hystrix.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: Hystrix for Ruby
+test_files: []