sidekiq-congestion 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aa39832645b56750973469661ef9d904fe684edf
-  data.tar.gz: e85779be4e776e654db4a44ddfcc8f6dcd114f7b
+SHA256:
+  metadata.gz: 95b0f4fc3bcc9fdd6dfe8d063528ed1fce9fa7813070a25b654006501615a6a9
+  data.tar.gz: 709724df22352370b559eced7db0417c0205454c21ac6594b7faf73456057f9e
 SHA512:
-  metadata.gz: 618d7512f650c99938b29232e827a4be9cc31ea81b18aa49364b701cf0a038f377b9b205cbc027ff9c5750aa388ac358aca9776ca08f63ef512e85825f04d1b9
-  data.tar.gz: b7dea32db308cc935806b76dd9a38b93ff6e960a14690a551464aafad4fe7943377e68e8d6b1ac2e04db08a515149905d7d17a55671e864ebc08ac24c763dad0
+  metadata.gz: 260ce82e14a221f77541d0f3542a39dbc2f0de4da29c2c06b3e2a99c3e831bf6dd3d8a2ee2278801151c7224b42894051e93b976c77b6dba8d94ec7b447b1968
+  data.tar.gz: cdc3386329f39df3c37c3aa6367cc6aad46e5896c6d462e449237aef4b2210ae800c0926daa6c01544a504028730f5f30aa905ecfbed81ceb2a0b9940fccbff3

data/.travis.yml

@@ -2,10 +2,9 @@ language: ruby
 sudo: false
 cache: bundler
 rvm:
-  - 1.9.3
   - 2.2.0
   - jruby-19mode
 services:
   - redis-server
-jruby_before_script: &jruby_before_script
+jruby_before_script:
   - bundle exec jbundle install

data/README.md

@@ -3,6 +3,7 @@
 [![Build Status](https://travis-ci.org/parrish/Sidekiq-Congestion.svg?branch=master)](https://travis-ci.org/parrish/Sidekiq-Congestion)
 [![Test Coverage](https://codeclimate.com/github/parrish/Sidekiq-Congestion/badges/coverage.svg)](https://codeclimate.com/github/parrish/Sidekiq-Congestion)
 [![Code Climate](https://codeclimate.com/github/parrish/Sidekiq-Congestion/badges/gpa.svg)](https://codeclimate.com/github/parrish/Sidekiq-Congestion)
+[![Gem Version](https://badge.fury.io/rb/sidekiq-congestion.svg)](http://badge.fury.io/rb/sidekiq-congestion)
 
 Sidekiq middleware for [Congestion](https://github.com/parrish/Congestion)
 
@@ -26,7 +27,56 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+[Documentation of Congestion configuration can be found here](https://github.com/parrish/Congestion#user-content-configuration)
+
+However, `Sidekiq::Congestion` disables rejection tracking by default.
+
+Rejection tracking would cause attempted calls to your workers (even if they don't trigger a run) to count towards the worker limits -- which is probably undesirable.  If your worker is high throughput, you may want to enable it just so the request tracking is [atomic](http://en.wikipedia.org/wiki/Linearizability).
+
+In an initializer:
+
+```ruby
+# Set whatever default options you'd like
+# Congestion.default_options[:track_rejected] = false
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Congestion::Limiter
+  end
+end
+```
+
+In a worker:
+
+```ruby
+class YourWorker
+  include Sidekiq::Worker
+
+  # Allow 5 calls/hour, with at least 5 minutes between calls
+  # When the request is not allowed, it is rescheduled
+  sidekiq_options congestion: {
+    interval: 1.hour,
+    max_in_interval: 5,
+    min_delay: 5.minutes,
+    reject_with: :reschedule, # (or :cancel)
+    track_rejected: false, # false by default, see above
+    # Restrict the scope of the limit via job params
+    # `key` is called with the same arguments as perform
+    key: ->(user) {
+      "user_#{ user.id }_unique_job_identifier"
+    },
+    # Conditionally enable/disable the limit
+    # returning false will bypass the limit
+    enabled: ->(user) {
+      !user.admin?
+    }
+  }
+
+  def perform(user_id)
+    # ...
+  end
+end
+```
 
 ## Development
 

data/lib/sidekiq/congestion.rb

@@ -1,6 +1,14 @@
+require 'congestion'
+require 'sidekiq'
 require 'sidekiq/congestion/version'
 
 module Sidekiq
   module Congestion
+    require 'sidekiq/congestion/request'
+    require 'sidekiq/congestion/limiter'
+    ::Congestion.default_options[:track_rejected] = false
+    ::Congestion.redis = ->{
+      ::Sidekiq.redis{ |redis| redis }
+    }
   end
 end

data/lib/sidekiq/congestion/limiter.rb

@@ -0,0 +1,20 @@
+module Sidekiq
+  module Congestion
+    class Limiter
+      def call(worker, job, queue, &block)
+        request = Sidekiq::Congestion::Request.new worker, job, queue
+        request.enabled? ? handle(request, block) : yield
+      end
+
+      def handle(request, block)
+        if request.allowed?
+          block.call
+        elsif request.reschedule?
+          request.reschedule!
+        else
+          # cancel request
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/congestion/request.rb

@@ -0,0 +1,65 @@
+require 'forwardable'
+
+module Sidekiq
+  module Congestion
+    class Request
+      extend Forwardable
+      attr_accessor :worker, :args, :options
+
+      def_delegators :congestion,
+        :allowed?, :backoff, :first_request, :last_request,
+        :rejected?, :too_frequent?, :too_many?, :total_requests
+
+      def initialize(worker, job, queue)
+        self.worker = worker
+        self.args = job['args']
+        opts = worker.sidekiq_options_hash || { }
+        self.options = opts['congestion']
+      end
+
+      def enabled?
+        !!options && _enabled?
+      end
+
+      def reschedule?
+        rejection_method == :reschedule
+      end
+
+      def reschedule!
+        worker.class.perform_in backoff, *args
+      end
+
+      def key
+        @key ||= case options[:key]
+        when Proc
+          options[:key].call *args
+        when String, Symbol
+          options[:key].to_s
+        else
+          worker.class.name
+        end
+      end
+
+      def congestion
+        @congestion ||= ::Congestion.request key, options
+      end
+
+      protected
+
+      def _enabled?
+        case options[:enabled]
+        when Proc
+          options[:enabled].call *args
+        when nil
+          true
+        else
+          !!options[:enabled]
+        end
+      end
+
+      def rejection_method
+        options.fetch(:reject_with, :reschedule).to_sym
+      end
+    end
+  end
+end

data/lib/sidekiq/congestion/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Congestion
-    VERSION = '0.0.1'
+    VERSION = '0.1.1'
   end
 end

data/sidekiq-congestion.gemspec

@@ -19,10 +19,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency     'congestion', '~> 0.0.3'
+  spec.add_runtime_dependency     'congestion', '~> 0.1'
   spec.add_runtime_dependency     'sidekiq', '>= 3.0'
   spec.add_development_dependency 'bundler', '>= 1.5'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 1.13.3'
   spec.add_development_dependency 'rspec', '~> 3.2'
   spec.add_development_dependency 'rspec-its', '~> 1.2'
   spec.add_development_dependency 'guard-rspec', '~> 4.5'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-congestion
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Michael Parrish
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-14 00:00:00.000000000 Z
+date: 2020-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: congestion
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 1.13.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 1.13.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -170,6 +170,8 @@ files:
 - bin/console
 - bin/setup
 - lib/sidekiq/congestion.rb
+- lib/sidekiq/congestion/limiter.rb
+- lib/sidekiq/congestion/request.rb
 - lib/sidekiq/congestion/version.rb
 - sidekiq-congestion.gemspec
 homepage: https://github.com/parrish/sidekiq-congestion
@@ -191,8 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Redis rate limiter Sidekiq middleware