circuit_breakage 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 264f3254581c4bdf631cfb997e2a66a177a19d92
-  data.tar.gz: 59a4cca4490e79cd3195c9a04b5f1a07a85c5e9a
+  metadata.gz: 9026fcf0d50eb38007dd97047ae181393d29a68b
+  data.tar.gz: ab1c9b2050bb6e6293e3347ce40fe5588ccbe179
 SHA512:
-  metadata.gz: 64348b4b18f1f35e66a1c1b45993093b36cb31ea6ddd5b2e814f32898dfe1de1e869c976a777bea536e7efea2a9051734676821b85221b5c014c1e266f01ad72
-  data.tar.gz: ae0ecdcedc18b541b266b6cf800a6710c487c24549f8bbbb56f8a75e8e2b56d4a9ce42e8591392ed43991b15df2e8b9b9faa6b0a6bb1935d16ba292508f2db68
+  metadata.gz: 7627acaac4f74fd5988531384648f43a35d27a3029e1342ea1b140a57a22f7dd31322162b918d8c5339d9ef655118c62020eed1f9c476dd2ed4f9aedbb759c02
+  data.tar.gz: c27a067b42074c300fbd4fc94e8f3d77d4f0a9ef7dc5bf2b4a4df5e66e646eea108a27920f9e8d18891f9c9b89f84df81de095f81a41b89ea2f24c261cf09c23

data/README.md

@@ -33,7 +33,12 @@ end
 The unique feature of this particular Circuit Breaker gem is that it also
 supports shared state via Redis, using the SETNX and GETSET commands.  This
 allows a number of circuit breakers running in separate processes to trip and
-un-trip in unison.
+un-trip in unison. To be specific, when the circuit is closed, all processes
+proceed as normal. When the circuit is open, all processes will raise
+`CircuitBreakage::CircuitOpen`. When the circuit is open, but the retry
+duration has expired (this is sometimes referred to as a "half open" state),
+exactly *one* process will retry, and then either close the circuit or reset
+the retry timer as appropriate.
 
 ```ruby
 connection = some_redis_connection
@@ -42,7 +47,3 @@ key = 'my_app/some_operation'
 breaker = CircuitBreakage::RedisBackedBreaker.new(connection, key, block)
 # Everything else is the same as above.
 ```
-
-So, if you have the same piece of code running on 27 instances across 3
-different servers, as soon as one trips, they all trip, and as soon as one
-resets, they all reset.

data/lib/circuit_breakage/redis_backed_breaker.rb

@@ -6,13 +6,14 @@ module CircuitBreakage
   class RedisBackedBreaker < Breaker
 
     # How long before we decide a lock-holder has crashed, in seconds.
-    LOCK_TIMEOUT = DEFAULT_TIMEOUT + 10
+    DEFAULT_LOCK_TIMEOUT = DEFAULT_TIMEOUT + 10
 
-    attr_reader :connection, :key
+    attr_reader :connection, :key, :lock_timeout
 
     def initialize(connection, key, block)
       @connection = connection
       @key = key
+      @lock_timeout = DEFAULT_LOCK_TIMEOUT
       super(block)
     end
 
@@ -38,22 +39,30 @@ module CircuitBreakage
 
     def try_with_mutex(lock, &block)
       mutex_key = "#{@key}/locks/#{lock}"
+      lock_timestamp = Time.now.to_i
 
-      acquired = @connection.setnx(mutex_key, Time.now.to_i)
-      if acquired == 0   # mutex is already acquired
-        locked_at = @connection.get(mutex_key)
-        raise CircuitBreakage::CircuitOpen if locked_at + LOCK_TIMEOUT < Time.now.to_i
-        locked_at_second_check = @connection.getset(mutex_key, Time.now.to_i)
+      # See http://redis.io/commands/setnx for a walkthrough of this logic.
+      acquired = @connection.setnx(mutex_key, lock_timestamp)
+      if !acquired
+        locked_at = @connection.get(mutex_key).to_i
+        raise CircuitBreakage::CircuitOpen if !lock_expired(locked_at)
+        locked_at_second_check = @connection.getset(mutex_key, Time.now.to_i).to_i
         raise CircuitBreakage::CircuitOpen if locked_at_second_check != locked_at
-        # If we get here, then the lock is expired, and we're the first to re-acquire it.
       end
 
       begin
         block.call
       ensure
-        @connection.del(mutex_key)
+        if !lock_expired(lock_timestamp)
+          # There's a tiny unavoidable race condition here.
+          @connection.del(mutex_key)
+        end
       end
     end
 
+    def lock_expired(timestamp)
+      timestamp + @lock_timeout < Time.now.to_i
+    end
+
   end
 end

data/lib/circuit_breakage/version.rb

@@ -1,3 +1,3 @@
 module CircuitBreakage
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circuit_breakage
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - John Hyland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-11 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler