circuit_breakage 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b30cd904f63ca99c1f7b95a89bfef2a5c29237d
-  data.tar.gz: c55ce5e3e2bf0463175dcd2c25ace63543ef2e1e
+  metadata.gz: 264f3254581c4bdf631cfb997e2a66a177a19d92
+  data.tar.gz: 59a4cca4490e79cd3195c9a04b5f1a07a85c5e9a
 SHA512:
-  metadata.gz: 7dfae02fe9c5876c2a1caa6454231dd33f325e9ddd6814b8a9fbc107e302fb15e44afb8cb6d55a0f09991caf6d6194ad1fc28af26387b9afc0db0d89687b6db7
-  data.tar.gz: 4fa1879643290ddc117d4ff8a3aac6cd0137230dba40953b11f6ab468fdcab9a7e69e407e121e40ab56dc8a74e4ea697484bdaf761ebd8ae4c0c5c26a64af5cf
+  metadata.gz: 64348b4b18f1f35e66a1c1b45993093b36cb31ea6ddd5b2e814f32898dfe1de1e869c976a777bea536e7efea2a9051734676821b85221b5c014c1e266f01ad72
+  data.tar.gz: ae0ecdcedc18b541b266b6cf800a6710c487c24549f8bbbb56f8a75e8e2b56d4a9ce42e8591392ed43991b15df2e8b9b9faa6b0a6bb1935d16ba292508f2db68

data/lib/circuit_breakage/redis_backed_breaker.rb

@@ -11,13 +11,23 @@ module CircuitBreakage
     attr_reader :connection, :key
 
     def initialize(connection, key, block)
-      raise NotImplementedError.new("Still working on it!")
-
       @connection = connection
       @key = key
       super(block)
     end
 
+    [:state, :failure_count, :last_failed].each do |attr|
+      attr_key = "#{@key}/attrs/#{attr}"
+
+      define_method(attr) do
+        @connection.get(attr_key)
+      end
+
+      define_method("#{attr}=") do |value|
+        @connection.set(attr_key, value)
+      end
+    end
+
     private
 
     def do_retry(*args)
@@ -30,13 +40,13 @@ module CircuitBreakage
       mutex_key = "#{@key}/locks/#{lock}"
 
       acquired = @connection.setnx(mutex_key, Time.now.to_i)
-      if acquired = 0   # mutex is already acquired
+      if acquired == 0   # mutex is already acquired
         locked_at = @connection.get(mutex_key)
-        return if locked_at + LOCK_TIMEOUT < Time.now.to_i  # unexpired lock
+        raise CircuitBreakage::CircuitOpen if locked_at + LOCK_TIMEOUT < Time.now.to_i
         locked_at_second_check = @connection.getset(mutex_key, Time.now.to_i)
-        return if locked_at_second_check != locked_at       # expired lock, but somebody beat us to it
+        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
-      # If we get this far, we have successfully acquired the mutex.
 
       begin
         block.call
@@ -45,17 +55,5 @@ module CircuitBreakage
       end
     end
 
-    [:state, :failure_count, :last_failed].each do |attr|
-      attr_key = "#{@key}/attrs/#{attr}"
-
-      define_method(attr) do
-        @connection.get(attr_key)
-      end
-
-      define_method("#{attr}=") do |value|
-        @connection.set(attr_key, value)
-      end
-    end
-
   end
 end

data/lib/circuit_breakage/version.rb

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

data/spec/breaker_spec.rb

@@ -14,7 +14,7 @@ module CircuitBreakage
       let(:arg) { 'This is an argument.' }
 
       context 'when the circuit is closed' do
-        before { breaker.closed! }
+        before { breaker.state = 'closed' }
 
         it 'calls the block' do
           # The default block just returns the arg.
@@ -37,7 +37,7 @@ module CircuitBreakage
           context 'and the failure count exceeds the failure threshold' do
             before { breaker.failure_count = breaker.failure_threshold }
 
-            it { is_expected.to change { breaker.open? }.to(true) }
+            it { is_expected.to change { breaker.state }.to('open') }
           end
         end
 
@@ -52,7 +52,7 @@ module CircuitBreakage
       end
 
       context 'when the circuit is open' do
-        before { breaker.open! }
+        before { breaker.state = 'open' }
 
         context 'before the retry_time' do
           before { breaker.last_failed = Time.now - breaker.duration + 30 }
@@ -64,62 +64,10 @@ module CircuitBreakage
           before { breaker.last_failed = Time.now - breaker.duration - 30 }
 
           it 'calls the block' do
-            # This is the same as being half open, see below for further tests.
             expect(breaker.call(arg)).to eq arg
           end
         end
       end
-
-      context 'when the circuit is half open' do
-        before do
-          # For the circuit to be tripped in the first place, the failure count
-          # must have reached the failure threshold.
-          breaker.failure_count = breaker.failure_threshold
-          breaker.half_open!
-        end
-
-        it 'calls the block' do
-          expect(breaker.call(arg)).to eq arg
-        end
-
-        context 'and the call succeeds' do
-          before { breaker.failure_count = 3 }
-
-          it { is_expected.to change { breaker.closed? }.to(true) }
-          it { is_expected.to change { breaker.failure_count }.to(0) }
-        end
-
-        context 'and the call fails' do
-          let(:block) { -> { raise 'some error' } }
-
-          it { is_expected.to change { breaker.open? }.to(true) }
-          it { is_expected.to change { breaker.last_failed } }
-        end
-      end
-    end
-
-    # #half_open?, #half_open!, #closed?, and #closed! are all exactly the same
-    # as #open? and #open!, so we're just going to test the open methods.
-
-    describe '#open!' do
-      it 'opens the circuit' do
-        breaker.open!
-        expect(breaker).to be_open
-      end
-    end
-
-    describe '#open?' do
-      subject { breaker.open? }
-
-      context 'when open' do
-        before { breaker.open! }
-        it { is_expected.to be_truthy }
-      end
-
-      context 'when not open' do
-        before { breaker.closed! }
-        it { is_expected.to be_falsey }
-      end
     end
   end
 end

data/spec/redis_backed_breaker_spec.rb

@@ -4,7 +4,7 @@
 module CircuitBreakage
   describe RedisBackedBreaker do
     let(:breaker)    { RedisBackedBreaker.new(connection, key, block) }
-    let(:connection) { MockCache.new }
+    let(:connection) { MockRedis.new }
     let(:key)        { 'test/data' }
     let(:block)      { ->(x) { return x } }
 
@@ -13,7 +13,7 @@ module CircuitBreakage
       let(:arg) { 'This is an argument.' }
 
       context 'when the circuit is closed' do
-        before { breaker.closed! }
+        before { breaker.state = 'closed' }
 
         it 'calls the block' do
           # The default block just returns the arg.
@@ -36,7 +36,7 @@ module CircuitBreakage
           context 'and the failure count exceeds the failure threshold' do
             before { breaker.failure_count = breaker.failure_threshold }
 
-            it { is_expected.to change { breaker.open? }.to(true) }
+            it { is_expected.to change { breaker.state }.to('open') }
           end
         end
 
@@ -51,7 +51,7 @@ module CircuitBreakage
       end
 
       context 'when the circuit is open' do
-        before { breaker.open! }
+        before { breaker.state = 'open' }
 
         context 'before the retry_time' do
           before { breaker.last_failed = Time.now - breaker.duration + 30 }
@@ -60,81 +60,50 @@ module CircuitBreakage
         end
 
         context 'after the retry time' do
-          before { breaker.last_failed = Time.now - breaker.duration - 30 }
-
           it 'calls the block' do
-            # This is the same as being half open, see below for further tests.
+            breaker.last_failed = Time.at(0)
             expect(breaker.call(arg)).to eq arg
           end
-        end
-      end
-
-      context 'when the circuit is half open' do
-        before do
-          # For the circuit to be tripped in the first place, the failure count
-          # must have reached the failure threshold.
-          breaker.failure_count = breaker.failure_threshold
-          breaker.half_open!
-        end
 
-        it 'calls the block' do
-          expect(breaker.call(arg)).to eq arg
-        end
-
-        context 'and the call succeeds' do
-          before { breaker.failure_count = 3 }
-
-          it { is_expected.to change { breaker.closed? }.to(true) }
-          it { is_expected.to change { breaker.failure_count }.to(0) }
-        end
-
-        context 'and the call fails' do
-          let(:block) { -> { raise 'some error' } }
-
-          it { is_expected.to change { breaker.open? }.to(true) }
-          it { is_expected.to change { breaker.last_failed } }
+          # TODO: It would be nice to test some of the concurrency scenarios,
+          # but that's pretty tricky to do politely in a test suite.
         end
       end
     end
-
-    # #half_open?, #half_open!, #closed?, and #closed! are all exactly the same
-    # as #open? and #open!, so we're just going to test the open methods.
-
-    describe '#open!' do
-      it 'opens the circuit' do
-        breaker.open!
-        expect(breaker).to be_open
-      end
-    end
-
-    describe '#open?' do
-      subject { breaker.open? }
-
-      context 'when open' do
-        before { breaker.open! }
-        it { is_expected.to be_truthy }
-      end
-
-      context 'when not open' do
-        before { breaker.closed! }
-        it { is_expected.to be_falsey }
-      end
-    end
   end
 end
 
-class MockCache
+class MockRedis
   attr_accessor :stored_data
 
   def initialize
     @stored_data = {}
   end
 
-  def write(key, val)
+  def get(key)
+    @stored_data[key]
+  end
+
+  def set(key, val)
     @stored_data[key] = val
   end
 
-  def fetch(key)
-    @stored_data[key]
+  def setnx(key, val)
+    if @stored_data[key].nil?
+      @stored_data[key] = val
+      return 1
+    else
+      return 0
+    end
+  end
+
+  def getset(key, val)
+    old_val = @stored_data[key]
+    @stored_data[key] = val
+    return old_val
+  end
+
+  def del(key)
+    @stored_data.delete(key)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: circuit_breakage
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - John Hyland