berater 0.13.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1270edae5d2c019ae92b623ff4c26e588cf8d5413c8f7b6c549d3d3ec4e16766
-  data.tar.gz: a9a659acde5a04263b1ca516a2fb1ecdd760d9133f3603b4fa7ec336c06f59df
+  metadata.gz: 81f3c362a1360d2b3f3b4a2829b374dd38f0f9de6809737efe7d9bb44ffbd88c
+  data.tar.gz: cbad555e49e5ac86d63f99486139e6df13b9da4289832b2d8cf5034bd7140018
 SHA512:
-  metadata.gz: 07fc3784c2e6d41648f97878e3a0c62e3a089c1ef69315e88141642350180634c65a89deda082ed5933a90666c620111329756d0699d3fde5238b97d0ad37e82
-  data.tar.gz: 6f8dc42b5b694a45c286b1d66a0b8efbf17371b3fd6bfd8936098b4155b85ae6523146fecfc6b7c46e3b0a8df1ddb03158f1fd181c9e6a1e13042232089e1a41
+  metadata.gz: ed26b29a67a30db075ec18ab64698b6ae76dbe7d4d8aee64c290dc449a6867566ea3c8155eb6ec6c5fe440208c19345bfc02c30adcddb4356b591f784678df99
+  data.tar.gz: 56143daeb1069e5d1162bea25c9892f146009168f8ef42c23cdc78774e6148602ef40364423c94e5248d2cff99793e6e5ef6a676e918ec4cf23d2686a35b5927

data/lib/berater/limiter.rb

@@ -62,12 +62,12 @@ module Berater
       lock = limit(cost: 0)
 
       if lock.capacity == 0
-        1.0
+        100.0
       else
-        lock.contention.to_f / lock.capacity
+        lock.contention.to_f / lock.capacity * 100
       end
     rescue Berater::Overloaded
-      1.0
+      100.0
     end
 
     def ==(other)
@@ -124,12 +124,7 @@ module Berater
         # can only call via subclass
         raise NoMethodError if self == Berater::Limiter
 
-        if RUBY_VERSION < '3' && kwargs.empty?
-          # avoid ruby 2 problems with empty hashes
-          super(*args)
-        else
-          super
-        end
+        super
       end
 
       def cache_key(key)

data/lib/berater/middleware/trace.rb

@@ -6,7 +6,9 @@ module Berater
       end
 
       def call(limiter, **)
-        tracer&.trace('Berater') do |span|
+        return yield unless tracer
+
+        tracer.trace('Berater') do |span|
           begin
             lock = yield
           rescue Exception => error
@@ -32,7 +34,7 @@ module Berater
       private
 
       def tracer
-        @tracer || (defined?(Datadog::Tracing) && Datadog::Tracing) || (defined?(Datadog) && Datadog.tracer)
+        @tracer || (defined?(Datadog) && Datadog::Tracing)
       end
     end
   end

data/lib/berater/mutex.rb

@@ -0,0 +1,28 @@
+module Berater
+  module Mutex
+    def self.included(base)
+      # add class methods
+      base.instance_eval do
+        def synchronize(subkey = nil, **opts, &block)
+          key = [ 'Mutex', name&.delete(':') || object_id, subkey ].compact.join(':')
+
+          Berater::ConcurrencyLimiter(key, 1, **mutex_options.merge(opts)) do
+            yield if block_given?
+          end
+        end
+
+        def mutex_options(**kwargs)
+          (@mutex_options ||= {}).update(kwargs)
+        end
+      end
+    end
+
+    def synchronize(...)
+      self.class.synchronize(...)
+    end
+
+    def self.extend_object(base)
+      included(base)
+    end
+  end
+end

data/lib/berater/rspec/matchers.rb

@@ -14,7 +14,7 @@ module Berater
           if res.is_a? Berater::Limiter
             # eg. expect { Berater.new(...) }.to be_overloaded
             @limiter = res
-            @limiter.utilization >= 1
+            @limiter.utilization >= 100
           else
             # eg. expect { Berater(...)  }.to be_overloaded
             # eg. expect { limiter.limit }.to be_overloaded
@@ -23,7 +23,7 @@ module Berater
         when Berater::Limiter
           # eg. expect(Berater.new(...)).to be_overloaded
           @limiter = obj
-          @limiter.utilization >= 1
+          @limiter.utilization >= 100
         end
       rescue Berater::Overloaded
         true

data/lib/berater/version.rb

@@ -1,3 +1,3 @@
 module Berater
-  VERSION = "0.13.1"
+  VERSION = "0.15.0"
 end

data/lib/berater.rb

@@ -3,11 +3,13 @@ require 'berater/limiter_set'
 require 'berater/lock'
 require 'berater/lua_script'
 require 'berater/middleware'
+require 'berater/mutex'
 require 'berater/utils'
 require 'berater/version'
 require 'meddleware'
 
 module Berater
+  include Meddleware
   extend self
 
   class Overloaded < StandardError; end
@@ -22,12 +24,6 @@ module Berater
     @limiters ||= LimiterSet.new
   end
 
-  def middleware(&block)
-    (@middleware ||= Meddleware.new).tap do
-      @middleware.instance_eval(&block) if block_given?
-    end
-  end
-
   def new(key, capacity, **opts)
     args = []
 

data/spec/concurrency_limiter_spec.rb

@@ -255,19 +255,19 @@ describe Berater::ConcurrencyLimiter do
     let(:limiter) { described_class.new(:key, 10, timeout: 30) }
 
     it 'works' do
-      expect(limiter.utilization).to be 0.0
+      expect(limiter.utilization).to eq 0
 
       2.times { limiter.limit }
-      expect(limiter.utilization).to be 0.2
+      expect(limiter.utilization).to eq 20
 
       Timecop.freeze(15)
 
       8.times { limiter.limit }
-      expect(limiter.utilization).to be 1.0
+      expect(limiter.utilization).to eq 100
 
       Timecop.freeze(15)
 
-      expect(limiter.utilization).to be 0.8
+      expect(limiter.utilization).to eq 80
     end
   end
 

data/spec/middleware/trace_spec.rb

@@ -65,6 +65,16 @@ describe Berater::Middleware::Trace do
         }.to raise_error(IOError)
       end
     end
+
+    context 'when tracer is not defined' do
+      before do
+        allow(instance).to receive(:tracer).and_return(nil)
+      end
+
+      it 'still yields' do
+        expect {|b| instance.call(limiter, &b) }.to yield_control
+      end
+    end
   end
 
   context 'when used as middleware' do

data/spec/mutex_spec.rb

@@ -0,0 +1,145 @@
+describe Berater::Mutex do
+  let(:klass) do
+    Class.new do
+      include Berater::Mutex
+    end
+  end
+
+  describe 'synchronize' do
+    it { expect(klass).to respond_to(:synchronize) }
+    it { expect(klass.new).to respond_to(:synchronize) }
+
+    it { expect { |block| klass.synchronize(&block) }.to yield_control }
+
+    it 'returns the blocks value' do
+      res = klass.synchronize { 123 }
+      expect(res).to be 123
+    end
+
+    it 'still works and returns nil without a block' do
+      expect(klass.synchronize).to be nil
+    end
+
+    it 'does not allow simultaneous calls' do
+      expect {
+        klass.synchronize do
+          klass.synchronize
+        end
+      }.to be_overloaded
+    end
+
+    it 'allows simultaneous calls with different sub-keys' do
+      expect {
+        klass.synchronize(:a) do
+          klass.synchronize(:b)
+        end
+      }.not_to raise_error
+    end
+
+    it 'allows consecutive calls' do
+      expect {
+        3.times { klass.synchronize }
+      }.not_to raise_error
+    end
+
+    describe 'the instance method' do
+      it 'is a pass through to the class method' do
+        expect(klass).to receive(:synchronize)
+        klass.new.synchronize
+      end
+
+      it 'works with arguments' do
+        key = 'key'
+        opts = { timeout: 1 }
+        block = ->{}
+
+        expect(klass).to receive(:synchronize) do |this_key, **these_opts, &this_block|
+          expect(this_key).to be key
+          expect(these_opts).to eq opts
+          expect(this_block).to be block
+        end
+
+        klass.new.synchronize(key, **opts, &block)
+      end
+    end
+  end
+
+  describe '.mutex_options' do
+    subject { klass.mutex_options }
+
+    it { expect(klass).to respond_to(:mutex_options) }
+    it { is_expected.to be_a Hash }
+    it { is_expected.to be_empty }
+    it { expect(klass.new).not_to respond_to(:mutex_options) }
+
+    context 'when mutex_options are set' do
+      let(:klass) do
+        Class.new do
+          include Berater::Mutex
+
+          mutex_options timeout: 1
+        end
+      end
+
+      it { is_expected.to eq(timeout: 1) }
+
+      it 'uses mutex_options during synchronize' do
+        expect(Berater::ConcurrencyLimiter).to receive(:new).and_wrap_original do |original, *args, **kwargs|
+          expect(kwargs).to eq(subject)
+          original.call(*args, **kwargs)
+        end
+
+        klass.synchronize
+      end
+    end
+  end
+
+  describe 'when extended rather than included' do
+    let(:klass) do
+      Class.new do
+        extend Berater::Mutex
+      end
+    end
+
+    it { expect(klass).to respond_to(:synchronize) }
+    it { expect(klass).to respond_to(:mutex_options) }
+
+    it { expect(klass.new).not_to respond_to(:synchronize) }
+    it { expect(klass.new).not_to respond_to(:mutex_options) }
+  end
+
+  describe 'when used in a counter' do
+    subject(:counter) { klass.new }
+
+    let(:klass) do
+      class Counter
+        include Berater::Mutex
+
+        @@count = 0
+        @@counts = {}
+
+        def incr
+          synchronize { @@count += 1 }
+        end
+
+        def incr_key(key)
+          synchronize(key) do
+            @@counts[key] ||= 0
+            @@counts[key] += 1
+          end
+        end
+      end
+      Counter
+    end
+
+    it { expect(counter.incr).to eq 1 }
+    it { expect(counter.incr_key(:a)).to eq 1 }
+
+    it 'separates keys' do
+      res = 3.times.map { counter.incr_key(:a) }
+      expect(res).to eq [ 1, 2, 3 ]
+
+      expect(counter.incr_key(:b)).to eq 1
+    end
+  end
+end

data/spec/rate_limiter_spec.rb

@@ -237,17 +237,17 @@ describe Berater::RateLimiter do
     let(:limiter) { described_class.new(:key, 10, :minute) }
 
     it do
-      expect(limiter.utilization).to be 0.0
+      expect(limiter.utilization).to eq 0
 
       2.times { limiter.limit }
-      expect(limiter.utilization).to be 0.2
+      expect(limiter.utilization).to eq 20
 
       8.times { limiter.limit }
-      expect(limiter.utilization).to be 1.0
+      expect(limiter.utilization).to eq 100
 
       Timecop.freeze(30)
 
-      expect(limiter.utilization).to be 0.5
+      expect(limiter.utilization).to eq 50
     end
   end
 

data/spec/static_limiter_spec.rb

@@ -60,13 +60,13 @@ describe Berater::StaticLimiter do
     let(:limiter) { described_class.new(:key, 10) }
 
     it do
-      expect(limiter.utilization).to be 0.0
+      expect(limiter.utilization).to eq 0
 
       2.times { limiter.limit }
-      expect(limiter.utilization).to be 0.2
+      expect(limiter.utilization).to eq 20
 
       8.times { limiter.limit }
-      expect(limiter.utilization).to be 1.0
+      expect(limiter.utilization).to eq 100
     end
   end
 

data/spec/test_mode_spec.rb

@@ -171,4 +171,13 @@ describe Berater::TestMode do
     it_behaves_like 'it supports test_mode'
   end
 
+  describe 'Mutex' do
+    let(:klass) { Class.new { include Berater::Mutex } }
+
+    context 'when test_mode = :fail' do
+      before { Berater.test_mode = :fail }
+
+      it { expect { klass.synchronize }.to be_overloaded }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: berater
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Daniel Pepper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-13 00:00:00.000000000 Z
+date: 2023-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: meddleware
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
@@ -66,34 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: codecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: ddtrace
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: dogstatsd-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -108,20 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.3'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -183,6 +155,7 @@ files:
 - lib/berater/middleware/load_shedder.rb
 - lib/berater/middleware/statsd.rb
 - lib/berater/middleware/trace.rb
+- lib/berater/mutex.rb
 - lib/berater/rate_limiter.rb
 - lib/berater/rspec.rb
 - lib/berater/rspec/matchers.rb
@@ -205,6 +178,7 @@ files:
 - spec/middleware/statsd_spec.rb
 - spec/middleware/trace_spec.rb
 - spec/middleware_spec.rb
+- spec/mutex_spec.rb
 - spec/rate_limiter_spec.rb
 - spec/riddle_spec.rb
 - spec/static_limiter_spec.rb
@@ -223,35 +197,36 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Berater
 test_files:
-- spec/rate_limiter_spec.rb
+- spec/berater_spec.rb
+- spec/concurrency_limiter_spec.rb
+- spec/dsl_refinement_spec.rb
+- spec/dsl_spec.rb
+- spec/inhibitor_spec.rb
+- spec/limiter_set_spec.rb
+- spec/limiter_spec.rb
+- spec/lua_script_spec.rb
+- spec/matchers_spec.rb
+- spec/middleware/fail_open_spec.rb
 - spec/middleware/load_shedder_spec.rb
 - spec/middleware/statsd_spec.rb
 - spec/middleware/trace_spec.rb
-- spec/middleware/fail_open_spec.rb
-- spec/matchers_spec.rb
-- spec/dsl_refinement_spec.rb
-- spec/test_mode_spec.rb
 - spec/middleware_spec.rb
-- spec/dsl_spec.rb
-- spec/lua_script_spec.rb
-- spec/concurrency_limiter_spec.rb
+- spec/mutex_spec.rb
+- spec/rate_limiter_spec.rb
 - spec/riddle_spec.rb
-- spec/limiter_set_spec.rb
-- spec/utils_spec.rb
-- spec/berater_spec.rb
-- spec/limiter_spec.rb
 - spec/static_limiter_spec.rb
-- spec/inhibitor_spec.rb
+- spec/test_mode_spec.rb
 - spec/unlimiter_spec.rb
+- spec/utils_spec.rb