berater 0.6.0 → 0.8.0

data/spec/matchers_spec.rb

@@ -1,118 +1,80 @@
 describe Berater::Matchers::Overloaded do
 
   context 'Berater::Unlimiter' do
-    let(:limiter) { Berater.new(:key, :unlimited) }
+    let(:limiter) { Berater::Unlimiter.new }
 
     it { expect(limiter).not_to be_overloaded }
-    it { expect(limiter).not_to be_inhibited }
-    it { expect(limiter).not_to be_overrated }
-    it { expect(limiter).not_to be_incapacitated }
-
     it { expect { limiter }.not_to be_overloaded }
-    it { expect { limiter }.not_to be_inhibited }
-    it { expect { limiter }.not_to be_overrated }
-    it { expect { limiter }.not_to be_incapacitated }
-
     it { expect { limiter.limit }.not_to be_overloaded }
-    it { expect { limiter.limit }.not_to be_inhibited }
-    it { expect { limiter.limit }.not_to be_overrated }
-    it { expect { limiter.limit }.not_to be_incapacitated }
   end
 
   context 'Berater::Inhibitor' do
-    let(:limiter) { Berater.new(:key, :inhibited) }
+    let(:limiter) { Berater::Inhibitor.new }
 
     it { expect(limiter).to be_overloaded }
-    it { expect(limiter).to be_inhibited }
-
     it { expect { limiter }.to be_overloaded }
-    it { expect { limiter }.to be_inhibited }
-
     it { expect { limiter.limit }.to be_overloaded }
-    it { expect { limiter.limit }.to be_inhibited }
   end
 
   context 'Berater::RateLimiter' do
-    let(:limiter) { Berater.new(:key, 1, :second) }
+    let(:limiter) { Berater::RateLimiter.new(:key, 1, :second) }
 
     it { expect(limiter).not_to be_overloaded }
-    it { expect(limiter).not_to be_inhibited }
-    it { expect(limiter).not_to be_overrated }
-    it { expect(limiter).not_to be_incapacitated }
-
     it { expect { limiter }.not_to be_overloaded }
-    it { expect { limiter }.not_to be_inhibited }
-    it { expect { limiter }.not_to be_overrated }
-    it { expect { limiter }.not_to be_incapacitated }
-
     it { expect { limiter.limit }.not_to be_overloaded }
-    it { expect { limiter.limit }.not_to be_inhibited }
-    it { expect { limiter.limit }.not_to be_overrated }
-    it { expect { limiter.limit }.not_to be_incapacitated }
 
     context 'once limit is used up' do
       before { limiter.limit }
 
-      it 'should be_overrated' do
-        expect(limiter).to be_overrated
+      it 'should be_overloaded' do
+        expect(limiter).to be_overloaded
       end
 
-      it 'should be_overrated' do
-        expect { limiter }.to be_overrated
+      it 'should be_overloaded' do
+        expect { limiter }.to be_overloaded
       end
 
-      it 'should be_overrated' do
-        expect { limiter.limit }.to be_overrated
+      it 'should be_overloaded' do
+        expect { limiter.limit }.to be_overloaded
       end
     end
   end
 
   context 'Berater::ConcurrencyLimiter' do
-    let(:limiter) { Berater.new(:key, 1) }
+    let(:limiter) { Berater::ConcurrencyLimiter.new(:key, 1) }
 
     it { expect(limiter).not_to be_overloaded }
-    it { expect(limiter).not_to be_inhibited }
-    it { expect(limiter).not_to be_overrated }
-    it { expect(limiter).not_to be_incapacitated }
-
     it { expect { limiter }.not_to be_overloaded }
-    it { expect { limiter }.not_to be_inhibited }
-    it { expect { limiter }.not_to be_overrated }
-    it { expect { limiter }.not_to be_incapacitated }
-
     it { expect { limiter.limit }.not_to be_overloaded }
-    it { expect { limiter.limit }.not_to be_inhibited }
-    it { expect { limiter.limit }.not_to be_overrated }
-    it { expect { limiter.limit }.not_to be_incapacitated }
 
     context 'when lock is released' do
-      it 'should be_incapacitated' do
+      it 'should be_overloaded' do
         3.times do
-          expect(limiter).not_to be_incapacitated
+          expect(limiter).not_to be_overloaded
         end
       end
 
-      it 'should be_incapacitated' do
+      it 'should be_overloaded' do
         3.times do
-          expect { limiter }.not_to be_incapacitated
+          expect { limiter }.not_to be_overloaded
         end
       end
 
-      it 'should be_incapacitated' do
+      it 'should be_overloaded' do
         3.times do
-          expect { limiter.limit {} }.not_to be_incapacitated
+          expect { limiter.limit {} }.not_to be_overloaded
         end
       end
     end
 
     context 'when lock is *not* released' do
-      it 'should be_incapacitated' do
-        expect { limiter.limit }.not_to be_incapacitated
-        expect { limiter.limit }.to be_incapacitated
+      it 'should be_overloaded' do
+        expect { limiter.limit }.not_to be_overloaded
+        expect { limiter.limit }.to be_overloaded
       end
 
-      it 'should be_incapacitated' do
-        expect { 3.times { limiter.limit } }.to be_incapacitated
+      it 'should be_overloaded' do
+        expect { 3.times { limiter.limit } }.to be_overloaded
       end
     end
   end
@@ -156,31 +118,5 @@ describe Berater::Matchers::Overloaded do
         expect { raise Berater::Overloaded }.not_to be_overloaded
       }.to fail_including("did not expect #{Berater::Overloaded} to be raised")
     end
-
-    it 'supports different verbs' do
-      expect {
-        expect { unlimiter }.to be_overrated
-      }.to fail_including('expected to be overrated')
-
-      expect {
-        expect { unlimiter }.to be_incapacitated
-      }.to fail_including('expected to be incapacitated')
-    end
-
-    it 'supports different exceptions' do
-      expect {
-        expect { 123 }.to be_overrated
-      }.to fail_including(
-        "expected #{Berater::RateLimiter::Overrated} to be raised"
-      )
-
-      expect {
-        expect {
-          raise Berater::ConcurrencyLimiter::Incapacitated
-        }.not_to be_incapacitated
-      }.to fail_including(
-        "did not expect #{Berater::ConcurrencyLimiter::Incapacitated} to be raised"
-      )
-    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