berater 0.6.1 → 0.9.0

data/spec/middleware_spec.rb

@@ -0,0 +1,110 @@
+class Meddler
+  def call(*)
+    yield
+  end
+end
+
+describe 'Berater.middleware' do
+  subject { Berater.middleware }
+
+  describe 'adding middleware' do
+    after { is_expected.to include Meddler }
+
+    it 'can be done inline' do
+      Berater.middleware.use Meddler
+    end
+
+    it 'can be done with a block' do
+      Berater.middleware do
+        use Meddler
+      end
+    end
+  end
+
+  it 'resets along with Berater' do
+    Berater.middleware.use Meddler
+    is_expected.to include Meddler
+
+    Berater.reset
+    is_expected.to be_empty
+  end
+
+  describe 'Berater::Limiter#limit' do
+    let(:middleware) { Meddler.new }
+    let(:limiter) { Berater::ConcurrencyLimiter.new(:key, 1) }
+
+    before do
+      expect(Meddler).to receive(:new).and_return(middleware).at_least(1)
+      Berater.middleware.use Meddler
+    end
+
+    it 'calls the middleware' do
+      expect(middleware).to receive(:call)
+      limiter.limit
+    end
+
+    it 'calls the middleware, passing the limiter and options' do
+      expect(middleware).to receive(:call).with(
+        limiter,
+        hash_including(:capacity, :cost)
+      )
+
+      limiter.limit
+    end
+
+    context 'when used per ususual' do
+      before do
+        expect(middleware).to receive(:call).and_call_original.at_least(1)
+      end
+
+      it 'still works inline' do
+        expect(limiter.limit).to be_a Berater::Lock
+      end
+
+      it 'still works in block mode' do
+        expect(limiter.limit { 123 }).to be 123
+      end
+
+      it 'still has limits' do
+        limiter.limit
+        expect(limiter).to be_overloaded
+      end
+    end
+
+    context 'when middleware meddles' do
+      it 'can change the capacity' do
+        expect(middleware).to receive(:call) do |limiter, opts, &block|
+          opts[:capacity] = 0
+          block.call
+        end
+
+        expect { limiter.limit }.to be_overloaded
+      end
+
+      it 'can change the cost' do
+        expect(middleware).to receive(:call) do |limiter, opts, &block|
+          opts[:cost] = 2
+          block.call
+        end
+
+        expect { limiter.limit }.to be_overloaded
+      end
+
+      it 'can change the limiter' do
+        other_limiter = Berater::Inhibitor.new
+
+        expect(middleware).to receive(:call) do |limiter, opts, &block|
+          block.call other_limiter, opts
+        end
+        expect(other_limiter).to receive(:acquire_lock).and_call_original
+
+        expect { limiter.limit }.to be_overloaded
+      end
+
+      it 'can abort by not yielding' do
+        expect(middleware).to receive(:call)
+        expect(limiter.limit).to be nil
+      end
+    end
+  end
+end

data/spec/rate_limiter_spec.rb

@@ -1,5 +1,6 @@
 describe Berater::RateLimiter do
-  it_behaves_like 'a limiter', Berater.new(:key, 3, :second)
+  it_behaves_like 'a limiter', described_class.new(:key, 3, :second)
+  it_behaves_like 'a limiter', described_class.new(:key, 3.5, :second)
 
   describe '.new' do
     let(:limiter) { described_class.new(:key, 1, :second) }
@@ -36,6 +37,7 @@ describe Berater::RateLimiter do
       it { expect_bad_capacity(-1) }
       it { expect_bad_capacity('1') }
       it { expect_bad_capacity(:one) }
+      it { expect_bad_capacity(Float::INFINITY) }
     end
   end
 
@@ -46,7 +48,7 @@ describe Berater::RateLimiter do
 
     it 'saves the interval in original and millisecond format' do
       expect(subject.interval).to be :second
-      expect(subject.instance_variable_get(:@interval_msec)).to be 10**3
+      expect(subject.instance_variable_get(:@interval)).to be 10**3
     end
 
     it 'must be > 0' do
@@ -75,42 +77,42 @@ describe Berater::RateLimiter do
     it 'limits excessive calls' do
       3.times { limiter.limit }
 
-      expect(limiter).to be_overrated
+      expect(limiter).to be_overloaded
     end
 
     it 'resets limit over time' do
       3.times { limiter.limit }
-      expect(limiter).to be_overrated
+      expect(limiter).to be_overloaded
 
       Timecop.freeze(1)
 
       3.times { limiter.limit }
-      expect(limiter).to be_overrated
+      expect(limiter).to be_overloaded
     end
 
     context 'with millisecond precision' do
       it 'resets limit over time' do
         3.times { limiter.limit }
-        expect(limiter).to be_overrated
+        expect(limiter).to be_overloaded
 
         # travel forward to just before the count decrements
         Timecop.freeze(0.333)
-        expect(limiter).to be_overrated
+        expect(limiter).to be_overloaded
 
         # traveling one more millisecond will decrement the count
         Timecop.freeze(0.001)
         limiter.limit
-        expect(limiter).to be_overrated
+        expect(limiter).to be_overloaded
       end
 
       it 'works when drip rate is < 1 per millisecond' do
         limiter = described_class.new(:key, 2_000, :second)
 
         limiter.capacity.times { limiter.limit }
-        expect(limiter).to be_overrated
+        expect(limiter).to be_overloaded
 
         Timecop.freeze(0.001)
-        expect(limiter).not_to be_overrated
+        expect(limiter).not_to be_overloaded
 
         2.times { limiter.limit }
       end
@@ -121,9 +123,9 @@ describe Berater::RateLimiter do
 
       it 'still works' do
         limiter.limit
-        expect(limiter).not_to be_overrated
+        expect(limiter).not_to be_overloaded
 
-        expect { limiter.limit }.to be_overrated
+        expect { limiter.limit }.to be_overloaded
 
         limiter.limit(cost: 0.5)
       end
@@ -132,30 +134,72 @@ describe Berater::RateLimiter do
     it 'accepts a dynamic capacity' do
       limiter = described_class.new(:key, 1, :second)
 
-      expect { limiter.limit(capacity: 0) }.to be_overrated
+      expect { limiter.limit(capacity: 0) }.to be_overloaded
       5.times { limiter.limit(capacity: 10) }
-      expect { limiter }.to be_overrated
+      expect { limiter }.to be_overloaded
     end
 
     context 'works with cost parameter' do
-      it { expect { limiter.limit(cost: 4) }.to be_overrated }
+      it { expect { limiter.limit(cost: 4) }.to be_overloaded }
 
       it 'works within limit' do
         limiter.limit(cost: 3)
-        expect { limiter.limit }.to be_overrated
+        expect { limiter.limit }.to be_overloaded
       end
 
       it 'resets over time' do
         limiter.limit(cost: 3)
-        expect(limiter).to be_overrated
+        expect(limiter).to be_overloaded
 
         Timecop.freeze(1)
-        expect(limiter).not_to be_overrated
+        expect(limiter).not_to be_overloaded
       end
 
-      it 'can be a Float' do
-        2.times { limiter.limit(cost: 1.5) }
-        expect(limiter).to be_overrated
+      context 'when cost is a Float' do
+        it 'still works' do
+          2.times { limiter.limit(cost: 1.5) }
+          expect(limiter).to be_overloaded
+        end
+
+        it 'calculates contention correctly' do
+          # note: Redis must return Floats as strings to maintain precision
+          lock = limiter.limit(cost: 1.5)
+          expect(lock.contention).to be 1.5
+        end
+      end
+    end
+
+    context 'with clock skew' do
+      let(:limiter) { described_class.new(:key, 10, :second) }
+
+      it 'works skewing backward' do
+        limiter.limit(cost: 9)
+
+        Timecop.freeze(-0.1) do
+          limiter.limit
+          expect(limiter).to be_overloaded
+        end
+
+        expect(limiter).to be_overloaded
+
+        Timecop.freeze(0.1)
+        limiter.limit
+        expect(limiter).to be_overloaded
+      end
+
+      it 'works skewing forward' do
+        limiter.limit
+
+        Timecop.freeze(0.1) do
+          # one drip later
+          limiter.limit(cost: 10)
+          expect(limiter).to be_overloaded
+        end
+
+        expect(limiter).to be_overloaded
+
+        Timecop.freeze(0.1)
+        expect(limiter).to be_overloaded
       end
     end
 
@@ -164,10 +208,10 @@ describe Berater::RateLimiter do
       let(:limiter_two) { described_class.new(:key, 1, :second) }
 
       it 'works as expected' do
-        expect(limiter_one.limit).not_to be_overrated
+        expect(limiter_one.limit).not_to be_overloaded
 
-        expect(limiter_one).to be_overrated
-        expect(limiter_two).to be_overrated
+        expect(limiter_one).to be_overloaded
+        expect(limiter_two).to be_overloaded
       end
     end
 
@@ -176,27 +220,33 @@ describe Berater::RateLimiter do
       let(:limiter_two) { described_class.new(:two, 2, :second) }
 
       it 'works as expected' do
-        expect(limiter_one.limit).not_to be_overrated
-        expect(limiter_two.limit).not_to be_overrated
+        expect(limiter_one.limit).not_to be_overloaded
+        expect(limiter_two.limit).not_to be_overloaded
 
-        expect(limiter_one).to be_overrated
-        expect(limiter_two.limit).not_to be_overrated
+        expect(limiter_one).to be_overloaded
+        expect(limiter_two.limit).not_to be_overloaded
 
-        expect(limiter_one).to be_overrated
-        expect(limiter_two).to be_overrated
+        expect(limiter_one).to be_overloaded
+        expect(limiter_two).to be_overloaded
       end
     end
   end
 
-  describe '#overloaded?' do
-    let(:limiter) { described_class.new(:key, 1, :second) }
+  describe '#utilization' do
+    let(:limiter) { described_class.new(:key, 10, :minute) }
 
-    it 'works' do
-      expect(limiter.overloaded?).to be false
-      limiter.limit
-      expect(limiter.overloaded?).to be true
-      Timecop.freeze(1)
-      expect(limiter.overloaded?).to be false
+    it do
+      expect(limiter.utilization).to be 0.0
+
+      2.times { limiter.limit }
+      expect(limiter.utilization).to be 0.2
+
+      8.times { limiter.limit }
+      expect(limiter.utilization).to be 1.0
+
+      Timecop.freeze(30)
+
+      expect(limiter.utilization).to be 0.5
     end
   end
 

data/spec/riddle_spec.rb

@@ -42,11 +42,15 @@ class ConcurrenyRiddler
     timeout ||= 1_000 # fake infinity
 
     limiter = Berater::RateLimiter.new(:key, capacity, timeout)
-    limiter.limit
+    lock = limiter.limit
     yield if block_given?
   ensure
     # decrement counter
-    limiter.redis.decr(limiter.send(:cache_key, :key))
+    if lock
+      key = limiter.send(:cache_key)
+      count, ts = limiter.redis.get(key).split ';'
+      limiter.redis.set(key, "#{count.to_f - 1};#{ts}")
+    end
   end
 end
 

data/spec/static_limiter_spec.rb

@@ -0,0 +1,79 @@
+describe Berater::StaticLimiter do
+  it_behaves_like 'a limiter', described_class.new(:key, 3)
+  it_behaves_like 'a limiter', described_class.new(:key, 3.5)
+
+  describe '#limit' do
+    let(:limiter) { described_class.new(:key, 3) }
+
+    it 'limits excessive calls' do
+      3.times { limiter.limit }
+
+      expect(limiter).to be_overloaded
+    end
+
+    context 'when capacity is a Float' do
+      let(:limiter) { described_class.new(:key, 1.5) }
+
+      it 'still works' do
+        limiter.limit
+        expect(limiter).not_to be_overloaded
+
+        expect { limiter.limit }.to be_overloaded
+
+        limiter.limit(cost: 0.5)
+      end
+    end
+
+    it 'accepts a dynamic capacity' do
+      limiter = described_class.new(:key, 1)
+
+      expect { limiter.limit(capacity: 0) }.to be_overloaded
+      5.times { limiter.limit(capacity: 10) }
+      expect { limiter }.to be_overloaded
+    end
+
+    context 'works with cost parameter' do
+      let(:limiter) { described_class.new(:key, 3) }
+
+      it { expect { limiter.limit(cost: 4) }.to be_overloaded }
+
+      it 'works within limit' do
+        limiter.limit(cost: 3)
+        expect { limiter.limit }.to be_overloaded
+      end
+
+      context 'when cost is a Float' do
+        it 'still works' do
+          2.times { limiter.limit(cost: 1.5) }
+          expect(limiter).to be_overloaded
+        end
+
+        it 'calculates contention correctly' do
+          lock = limiter.limit(cost: 1.5)
+          expect(lock.contention).to be 1.5
+        end
+      end
+    end
+  end
+
+  describe '#utilization' do
+    let(:limiter) { described_class.new(:key, 10) }
+
+    it do
+      expect(limiter.utilization).to be 0.0
+
+      2.times { limiter.limit }
+      expect(limiter.utilization).to be 0.2
+
+      8.times { limiter.limit }
+      expect(limiter.utilization).to be 1.0
+    end
+  end
+
+  describe '#to_s' do
+    let(:limiter) { described_class.new(:key, 3) }
+
+    it { expect(limiter.to_s).to include '3' }
+  end
+
+end

data/spec/test_mode_spec.rb

@@ -1,8 +1,4 @@
 describe Berater::TestMode do
-  after do
-    Berater.test_mode = nil
-  end
-
   context 'after test_mode.rb has been loaded' do
     it 'monkey patches Berater' do
       expect(Berater).to respond_to(:test_mode)
@@ -13,12 +9,12 @@ describe Berater::TestMode do
     end
 
     it 'prepends Limiter subclasses' do
-      expect(Berater::Unlimiter.ancestors).to include(described_class)
-      expect(Berater::Inhibitor.ancestors).to include(described_class)
+      expect(Berater::Unlimiter.ancestors).to include(Berater::Limiter::TestMode)
+      expect(Berater::Inhibitor.ancestors).to include(Berater::Limiter::TestMode)
     end
 
     it 'preserves the original functionality via super' do
-      expect { Berater::Limiter.new }.to raise_error(NotImplementedError)
+      expect { Berater::Limiter.new }.to raise_error(NoMethodError)
     end
   end
 
@@ -55,56 +51,50 @@ describe Berater::TestMode do
     end
   end
 
-  shared_examples 'it always works, without redis' do
-    before do
-      Berater.redis = nil
-      expect_any_instance_of(Berater::LuaScript).not_to receive(:eval)
-    end
-
-    it_behaves_like 'it is not overloaded'
+  describe '.reset' do
+    before { Berater.test_mode = :pass }
 
-    it 'always works' do
-      10.times { subject.limit }
+    it 'resets test_mode' do
+      expect(Berater.test_mode).to be :pass
+      Berater.reset
+      expect(Berater.test_mode).to be nil
     end
   end
 
-  shared_examples 'it never works, without redis' do
+  shared_examples 'it supports test_mode' do
     before do
+      # without hitting Redis
       Berater.redis = nil
       expect_any_instance_of(Berater::LuaScript).not_to receive(:eval)
     end
 
-    it_behaves_like 'it is overloaded'
-  end
-
-  describe 'Unlimiter' do
-    subject { Berater::Unlimiter.new }
+    context 'with test_mode = :pass' do
+      before { Berater.test_mode = :pass }
 
-    context 'when test_mode = nil' do
-      before { Berater.test_mode = nil }
+      it_behaves_like 'it is not overloaded'
 
-      it { is_expected.to be_a Berater::Unlimiter }
-      it_behaves_like 'it always works, without redis'
+      it 'always works' do
+        10.times { subject.limit }
+      end
     end
 
-    context 'when test_mode = :pass' do
-      before { Berater.test_mode = :pass }
+    context 'with test_mode = :fail' do
+      before { Berater.test_mode = :fail }
 
-      it { is_expected.to be_a Berater::Unlimiter }
-      it_behaves_like 'it always works, without redis'
+      it_behaves_like 'it is overloaded'
     end
+  end
 
-    context 'when test_mode = :fail' do
-      before { Berater.test_mode = :fail }
+  describe 'Unlimiter' do
+    subject { Berater::Unlimiter.new }
 
-      it { is_expected.to be_a Berater::Unlimiter }
-      it_behaves_like 'it never works, without redis'
+    context 'when test_mode = nil' do
+      before { Berater.test_mode = nil }
 
-      it 'supports class specific logic' do
-        expect(subject.overloaded?).to be true
-        expect { subject.limit }.to raise_error(Berater::Overloaded)
-      end
+      it_behaves_like 'it is not overloaded'
     end
+
+    it_behaves_like 'it supports test_mode'
   end
 
   describe 'Inhibitor' do
@@ -113,47 +103,18 @@ describe Berater::TestMode do
     context 'when test_mode = nil' do
       before { Berater.test_mode = nil }
 
-      it { is_expected.to be_a Berater::Inhibitor }
-      it_behaves_like 'it never works, without redis'
+      it_behaves_like 'it is overloaded'
     end
 
-    context 'when test_mode = :pass' do
-      before { Berater.test_mode = :pass }
-
-      it { is_expected.to be_a Berater::Inhibitor }
-      it_behaves_like 'it always works, without redis'
-    end
-
-    context 'when test_mode = :fail' do
-      before { Berater.test_mode = :fail }
-
-      it { is_expected.to be_a Berater::Inhibitor }
-      it_behaves_like 'it never works, without redis'
-
-      it 'supports class specific logic' do
-        expect(subject.inhibited?).to be true
-        expect { subject.limit }.to raise_error(Berater::Inhibitor::Inhibited)
-      end
-    end
+    it_behaves_like 'it supports test_mode'
   end
 
   describe 'RateLimiter' do
     subject { Berater::RateLimiter.new(:key, 1, :second) }
 
-    shared_examples 'a RateLimiter' do
-      it { is_expected.to be_a Berater::RateLimiter }
-
-      it 'checks arguments' do
-        expect {
-          Berater::RateLimiter.new(:key, 1)
-        }.to raise_error(ArgumentError)
-      end
-    end
-
     context 'when test_mode = nil' do
       before { Berater.test_mode = nil }
 
-      it_behaves_like 'a RateLimiter'
       it_behaves_like 'it is not overloaded'
 
       it 'works per usual' do
@@ -163,24 +124,7 @@ describe Berater::TestMode do
       end
     end
 
-    context 'when test_mode = :pass' do
-      before { Berater.test_mode = :pass }
-
-      it_behaves_like 'a RateLimiter'
-      it_behaves_like 'it always works, without redis'
-    end
-
-    context 'when test_mode = :fail' do
-      before { Berater.test_mode = :fail }
-
-      it_behaves_like 'a RateLimiter'
-      it_behaves_like 'it never works, without redis'
-
-      it 'supports class specific logic' do
-        expect(subject.overrated?).to be true
-        expect { subject.limit }.to raise_error(Berater::RateLimiter::Overrated)
-      end
-    end
+    it_behaves_like 'it supports test_mode'
   end
 
   describe 'ConcurrencyLimiter' do
@@ -189,8 +133,6 @@ describe Berater::TestMode do
     context 'when test_mode = nil' do
       before { Berater.test_mode = nil }
 
-      it { is_expected.to be_a Berater::ConcurrencyLimiter }
-
       it_behaves_like 'it is not overloaded'
 
       it 'works per usual' do
@@ -200,26 +142,7 @@ describe Berater::TestMode do
       end
     end
 
-    context 'when test_mode = :pass' do
-      before { Berater.test_mode = :pass }
-
-      it { is_expected.to be_a Berater::ConcurrencyLimiter }
-
-      it_behaves_like 'it always works, without redis'
-    end
-
-    context 'when test_mode = :fail' do
-      before { Berater.test_mode = :fail }
-
-      it { is_expected.to be_a Berater::ConcurrencyLimiter }
-
-      it_behaves_like 'it never works, without redis'
-
-      it 'supports class specific logic' do
-        expect(subject.incapacitated?).to be true
-        expect { subject.limit }.to raise_error(Berater::ConcurrencyLimiter::Incapacitated)
-      end
-    end
+    it_behaves_like 'it supports test_mode'
   end
 
 end