sidekiq-throttled 0.18.0 → 1.1.0

data/.yardopts

@@ -1 +0,0 @@
---no-private - LICENSE.md

data/Appraisals

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-appraise "sidekiq-6.4" do
-  gem "sidekiq", "~> 6.4.0"
-end
-
-appraise "sidekiq-6.5" do
-  gem "sidekiq", "~> 6.5.0"
-end

data/CHANGES.md

@@ -1,318 +0,0 @@
-## 0.18.0 (2023-04-10)
-
-* Fix redis-prescription dependency usage
-
-## 0.17.0 (2022-09-14)
-
-* [#13](https://github.com/ixti/sidekiq-throttled/pull/13)
-  Fix redis-4.8+ deprecation warnings
-
-* [#8](https://github.com/ixti/sidekiq-throttled/pull/8)
-  Drop Sidekiq < 6.4 support
-
-## 0.16.2 (2022-07-19)
-
-* [#5](https://github.com/ixti/sidekiq-throttled/issues/5)
-  [#6](https://github.com/ixti/sidekiq-throttled/pull/6)
-  Add Sidekiq 6.5+ support
-
-## 0.16.1 (2022-06-14)
-
-* [#2](https://github.com/ixti/sidekiq-throttled/pull/2)
-  Support custom ActiveJob adapters.
-  ([@longkt90])
-
-* [#107](https://github.com/sensortower/sidekiq-throttled/pull/107)
-  Log error when key sufix extraction fails.
-  ([@pjungwir])
-
-## 0.16.0 (2022-06-13)
-
-* Drop Ruby 2.6 support.
-
-* Drop Sidekiq 5.X support.
-
-* [#121](https://github.com/sensortower/sidekiq-throttled/pull/121)
-  Sidekiq 6.5 compatibility.
-  ([@hieuk09])
-
-* [#116](https://github.com/sensortower/sidekiq-throttled/pull/116)
-  Unwrap ActiveJob JobWrapper
-  ([@holstvoogd])
-
-* [#115](https://github.com/sensortower/sidekiq-throttled/pull/115)
-  Fix Redis 4.6 deprecation warnings.
-  ([@dbackeus])
-
-* [#113](https://github.com/sensortower/sidekiq-throttled/pull/113)
-  Add Ruby 3.1 to CI.
-  ([@petergoldstein])
-
-* [#103](https://github.com/sensortower/sidekiq-throttled/pull/103)
-  Rename Sidekiq::Throttled::Worker to Sidekiq::Throttled::Job, and alias it
-  as Sidekiq::Throttled::Worker.
-  ([@CHTJonas])
-
-## 0.15.0 (2021-12-16)
-
-* [#102](https://github.com/sensortower/sidekiq-throttled/pull/102)
-  Support Ruby 3.0 and Sidekiq 6.2+.
-  ([@ybiquitous])
-
-* [#97](https://github.com/sensortower/sidekiq-throttled/pull/97)
-  Fix kwargs usage in strategy collection.
-  ([@baptistejub])
-
-## 0.14.0 (2021-09-21)
-
-* [#98](https://github.com/sensortower/sidekiq-throttled/pull/98)
-  Remove warning for strategy override.
-  ([@mattiagiuffrida-st])
-
-* [#65](https://github.com/sensortower/sidekiq-throttled/pull/65)
-  Support composite (multi-key) strategies.
-  ([@holyketzer])
-
-* [#89](https://github.com/sensortower/sidekiq-throttled/pull/89),
-  [#96](https://github.com/sensortower/sidekiq-throttled/pull/96), and
-  [#93](https://github.com/sensortower/sidekiq-throttled/pull/93)
-  Improve documentation.
-  ([@hubertjakubiak], [@khaile], and [@kylerippey])
-
-## 0.13.0 (2020-07-28)
-
-* [#85](https://github.com/sensortower/sidekiq-throttled/pull/85)
-  Add Sidekiq 6.1+ support.
-  ([@hmaack])
-
-## 0.12.0 (2020-06-22)
-
-* [#80](https://github.com/sensortower/sidekiq-throttled/pull/80)
-  Allow override cooldown timeout of queues with throttled jobs.
-  ([@vaot])
-
-* [#76](https://github.com/sensortower/sidekiq-throttled/pull/76)
-  Fix warnings on Ruby 2.7
-  ([@lenon])
-
-
-## 0.11.0 (2019-08-24)
-
-* [#59](https://github.com/sensortower/sidekiq-throttled/pull/59)
-  Add throttling observer.
-  ([@ogins57])
-
-
-## 0.10.0 (2019-06-22)
-
-* [#60](https://github.com/sensortower/sidekiq-throttled/pull/60)
-  Skip throttling check in redis if limit is 0.
-  ([@mstruve])
-
-* [#58](https://github.com/sensortower/sidekiq-throttled/pull/58)
-  Improve documentation bout TTL.
-  ([@ziaulrehman40])
-
-* Improve reliability of paused queues, by resyncing list of paused queues
-  on schedule.
-  ([@ixti])
-
-
-## 0.9.0 (2018-09-11)
-
-* Add support of Sidekiq 5.2.x
-  ([@ixti])
-
-* Drop support of Sidekiq 4.x
-  ([@ixti])
-
-* Add concurrent-ruby as dependency which is no longer a dependency of
-  Sidekiq as 5.2+ version.
-  ([@ixti])
-
-
-## 0.8.2 (2018-02-14)
-
-* Extract redis LUA scripts stored procedures runner to redis-prescription gem.
-  ([@ixti])
-
-* Switch to Concurrent.monotonic_time to expire elements of ExpirableList.
-  ([@ixti])
-
-
-## 0.8.1 (2017-11-02)
-
-* Preload job class constant prior trying to get it's throttling strategy.
-  ([@ixti])
-
-
-## 0.8.0 (2017-10-11)
-
-* Refactor concurrency throttling internals to use sorted sets in order to avoid
-  starvation in case when finalize! was not called (OOM / redis issues).
-  ([@ixti])
-
-
-## 0.7.3 (2017-06-26)
-
-* [#34](https://github.com/sensortower/sidekiq-throttled/issues/34)
-  Fix reset button for sidekiq `>= 4.2`.
-  ([@ixti])
-
-
-## 0.7.2 (2017-04-02)
-
-* Fix summary bar fixer on sidekiq 4.2+.
-  ([@ixti])
-
-* Fix regexp used to fix summay bar queues link when ui was enhanced.
-  ([@ixti])
-
-
-## 0.7.1 (2017-03-30)
-
-* Fix summary bar queues link when queue ui was enhanced.
-  ([@ixti])
-
-* [#31](https://github.com/sensortower/sidekiq-throttled/pull/31)
-  [#30](https://github.com/sensortower/sidekiq-throttled/issues/30)
-  Do not throttle if limit is `nil`.
-  ([@ixti])
-
-
-## 0.7.0 (2017-03-22)
-
-* Expose pause/resume queues hidden feature to UI. This was available via API
-  since v0.6.0 and today it's finally got it's UI.
-  ([@ixti])
-
-
-## 0.6.7 (2017-03-21)
-
-* Fix fetcher causing workers starvation upon low concurrency thresholds.
-  ([@ixti])
-
-
-## 0.6.6 (2016-10-16)
-
-* [#24](https://github.com/sensortower/sidekiq-throttled/pull/24)
-  Fix dynamic `:key_suffix` issue.
-  ([@iporsut])
-
-
-## 0.6.5 (2016-09-04)
-
-* Fix concurrency throttling when redis-namespace is used.
-  ([@ixti])
-
-
-## 0.6.4 (2016-09-02)
-
-* Rename UnitOfWork throttled requeue to `#requeue_throttled`.
-  ([@ixti])
-
-
-## 0.6.3 (2016-09-02)
-
-* Enrich internal API to allow better extensibility.
-  ([@ixti])
-
-
-## 0.6.2 (2016-09-01)
-
-* Add `Fetch.bulk_requeue` used by Sidekiq upon termination.
-  ([@ixti])
-
-
-## 0.6.1 (2016-08-30)
-
-* Trivial internal API change: extracted queues list builder of `Fetch` into
-  dedicated internal method, allowing to enhance it with extra custom filters.
-  ([@ixti])
-
-
-## 0.6.0 (2016-08-27)
-
-* [#21](https://github.com/sensortower/sidekiq-throttled/pull/21)
-  Allow pause/unpause queues.
-  ([@ixti])
-
-
-## 0.5.0 (2016-08-18)
-
-* Drop Sidekiq 3.x support.
-  ([@ixti])
-
-
-## 0.4.1 (2016-08-18)
-
-* [#15](https://github.com/sensortower/sidekiq-throttled/pull/15)
-  Fix throttled web UI on older versions of sidekiq.
-  ([@palanglung])
-
-
-## 0.4.0 (2016-05-17)
-
-* [#14](https://github.com/sensortower/sidekiq-throttled/pull/14)
-  Support dynamic configuration of limits and periods.
-  ([@azach], [@ixti])
-
-
-## 0.3.2 (2016-05-16)
-
-* [#13](https://github.com/sensortower/sidekiq-throttled/issues/13)
-  Fix throttled BasicFetch with strictly ordered queues on sidekiq 4.
-  ([@palanglung], [@ixti])
-
-
-## 0.3.1 (2016-05-15)
-
-* Precalculate LUA script digests to reduce bandwidth upon nodes reload
-  _(which might (and might not) happen if you run thousands of nodes)_.
-  ([@ixti])
-
-
-## 0.3.0 (2016-05-02)
-
-* [#1](https://github.com/sensortower/sidekiq-throttled/issues/1):
-  Add Sidekiq 4.0 support.
-  ([@ixti])
-
-
-## 0.2.0 (2016-02-29)
-
-* [#6](https://github.com/sensortower/sidekiq-throttled/pull/6):
-  Add dynamic key suffix functionality.
-  ([@fhwang])
-
-
-## 0.1.0 (2015-11-03)
-
-* Initial release.
-
-
-[@ixti]: https://github.com/ixti
-[@fhwang]: https://github.com/fhwang
-[@palanglung]: https://github.com/palanglung
-[@azach]: https://github.com/azach
-[@iporsut]: https://github.com/iporsut
-[@mstruve]: https://github.com/mstruve
-[@ziaulrehman40]: https://github.com/ziaulrehman40
-[@ogins57]: https://github.com/ogins57
-[@lenon]: https://github.com/lenon
-[@vaot]: https://github.com/vaot
-[@hmaack]: https://github.com/hmaack
-[@holyketzer]: https://github.com/holyketzer
-[@hubertjakubiak]: https://github.com/hubertjakubiak
-[@kylerippey]: https://github.com/kylerippey
-[@khaile]: https://github.com/khaile
-[@mattiagiuffrida-st]: https://github.com/mattiagiuffrida-st
-[@baptistejub]: https://github.com/baptistejub
-[@ybiquitous]: https://github.com/ybiquitous
-[@hieuk09]: https://github.com/hieuk09
-[@petergoldstein]: https://github.com/petergoldstein
-[@dbackeus]: https://github.com/dbackeus
-[@holstvoogd]: https://github.com/holstvoogd
-[@CHTJonas]: https://github.com/CHTJonas
-[@pjungwir]: https://github.com/pjungwir
-[@longkt90]: https://github.com/longkt90

data/Gemfile

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-gem "appraisal"
-gem "rake"
-gem "rspec"
-gem "sidekiq"
-
-group :development do
-  gem "byebug"
-  gem "guard",         :require => false
-  gem "guard-rspec",   :require => false
-  gem "guard-rubocop", :require => false
-end
-
-group :test do
-  gem "apparition"
-  gem "capybara"
-  gem "puma"
-  gem "rack-test"
-  gem "sinatra"
-  gem "timecop"
-end
-
-group :lint do
-  gem "rubocop",              :require => false
-  gem "rubocop-performance",  :require => false
-  gem "rubocop-rake",         :require => false
-  gem "rubocop-rspec",        :require => false
-end
-
-# Specify your gem's dependencies in sidekiq-throttled.gemspec
-gemspec

data/Guardfile

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-group :red_green_refactor, :halt_on_fail => true do
-  guard :rspec, :cmd => "bundle exec rspec --no-profile" do
-    require "guard/rspec/dsl"
-    dsl = Guard::RSpec::Dsl.new(self)
-
-    # Feel free to open issues for suggestions and improvements
-
-    # RSpec files
-    rspec = dsl.rspec
-    watch(rspec.spec_helper) { rspec.spec_dir }
-    watch(rspec.spec_support) { rspec.spec_dir }
-    watch(rspec.spec_files)
-
-    # Ruby files
-    ruby = dsl.ruby
-    dsl.watch_spec_files_for(ruby.lib_files)
-  end
-
-  guard :rubocop, :all_on_start => false do
-    watch(%r{.+\.rb$})
-    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
-  end
-end

data/README.md

@@ -1,297 +0,0 @@
-# Sidekiq::Throttled
-
-[![CI Status](https://github.com/ixti/sidekiq-throttled/actions/workflows/ci.yml/badge.svg)](https://github.com/ixti/sidekiq-throttled/actions/workflows/ci.yml)
-[![Latest Version](https://badge.fury.io/rb/sidekiq-throttled.svg)](http://rubygems.org/gems/sidekiq-throttled)
-[![API Docs](https://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/gems/sidekiq-throttled)
-
-Concurrency and threshold throttling for [Sidekiq][sidekiq].
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-``` ruby
-gem "sidekiq-throttled"
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install sidekiq-throttled
-
-
-## Usage
-
-Add somewhere in your app's bootstrap (e.g. `config/initializers/sidekiq.rb` if
-you are using Rails):
-
-``` ruby
-require "sidekiq/throttled"
-Sidekiq::Throttled.setup!
-```
-
-Load order can be an issue if you are using other Sidekiq plugins and/or middleware.
-To prevent any problems, add the `.setup!` call to the bottom of your init file.
-
-Once you've done that you can include `Sidekiq::Throttled::Job` to your
-job classes and configure throttling:
-
-``` ruby
-class MyJob
-  include Sidekiq::Job
-  include Sidekiq::Throttled::Job
-
-  sidekiq_options :queue => :my_queue
-
-  sidekiq_throttle(
-    # Allow maximum 10 concurrent jobs of this class at a time.
-    :concurrency => { :limit => 10 },
-    # Allow maximum 1K jobs being processed within one hour window.
-    :threshold => { :limit => 1_000, :period => 1.hour }
-  )
-
-  def perform
-    # ...
-  end
-end
-```
-
-**NOTE:** `Sidekiq::Throttled::Job` is aliased as `Sidekiq::Throttled::Worker`,
-thus if you're using Sidekiq prior 6.3.0 version, or you using `Sidekiq::Worker`
-naming convention, you can use the alias for consistency:
-
-``` ruby
-class MyWorker
-  include Sidekiq::Worker
-  include Sidekiq::Throttled::Worker
-
-  # ...
-end
-```
-
-
-### Observer
-
-You can specify an observer that will be called on throttling. To do so pass an
-`:observer` option with callable object:
-
-``` ruby
-class MyJob
-  include Sidekiq::Job
-  include Sidekiq::Throttled::Job
-
-  MY_OBSERVER = lambda do |strategy, *args|
-    # do something
-  end
-
-  sidekiq_options :queue => :my_queue
-
-  sidekiq_throttle(
-    :concurrency => { :limit => 10 },
-    :threshold   => { :limit => 100, :period => 1.hour }
-    :observer    => MY_OBSERVER
-  )
-
-  def perform(*args)
-    # ...
-  end
-end
-```
-
-Observer will receive `strategy, *args` arguments, where `strategy` is a Symbol
-`:concurrency` or `:threshold`, and `*args` are the arguments that were passed
-to the job.
-
-
-### Dynamic throttling
-
-You can throttle jobs dynamically with `:key_suffix` option:
-
-``` ruby
-class MyJob
-  include Sidekiq::Job
-  include Sidekiq::Throttled::Job
-
-  sidekiq_options :queue => :my_queue
-
-  sidekiq_throttle(
-    # Allow maximum 10 concurrent jobs per user at a time.
-    :concurrency => { :limit => 10, :key_suffix => -> (user_id) { user_id } }
-  )
-
-  def perform(user_id)
-    # ...
-  end
-end
-```
-
-You can also supply dynamic values for limits and periods by supplying a proc
-for these values. The proc will be evaluated at the time the job is fetched
-and will receive the same arguments that are passed to the job.
-
-``` ruby
-class MyJob
-  include Sidekiq::Job
-  include Sidekiq::Throttled::Job
-
-  sidekiq_options :queue => :my_queue
-
-  sidekiq_throttle(
-    # Allow maximum 1000 concurrent jobs of this class at a time for VIPs and 10 for all other users.
-    :concurrency => {
-      :limit      => ->(user_id) { User.vip?(user_id) ? 1_000 : 10 },
-      :key_suffix => ->(user_id) { User.vip?(user_id) ? "vip" : "std" }
-    },
-    # Allow 1000 jobs/hour to be processed for VIPs and 10/day for all others
-    :threshold   => {
-      :limit      => ->(user_id) { User.vip?(user_id) ? 1_000 : 10 },
-      :period     => ->(user_id) { User.vip?(user_id) ? 1.hour : 1.day },
-      :key_suffix => ->(user_id) { User.vip?(user_id) ? "vip" : "std" }
-  )
-
-  def perform(user_id)
-    # ...
-  end
-end
-```
-
-You also can use several different keys to throttle one worker.
-
-``` ruby
-class MyJob
-  include Sidekiq::Job
-  include Sidekiq::Throttled::Job
-
-  sidekiq_options :queue => :my_queue
-
-  sidekiq_throttle(
-    # Allow maximum 10 concurrent jobs per project at a time and maximum 2 jobs per user
-    :concurrency => [
-      { :limit => 10, :key_suffix => -> (project_id, user_id) { project_id } },
-      { :limit => 2, :key_suffix => -> (project_id, user_id) { user_id } }
-    ]
-    # For :threshold it works the same
-  )
-
-  def perform(project_id, user_id)
-    # ...
-  end
-end
-```
-
-**NB** Don't forget to specify `:key_suffix` and make it return different values
-if you are using dynamic limit/period options. Otherwise you risk getting into
-some trouble.
-
-
-### Concurrency throttling fine-tuning
-
-Concurrency throttling is based on distributed locks. Those locks have default
-time to live (TTL) set to 15 minutes. If your job takes more than 15 minutes
-to finish, lock will be released and you might end up with more jobs running
-concurrently than you expect.
-
-This is done to avoid deadlocks - when by any reason (e.g. Sidekiq process was
-OOM-killed) cleanup middleware wasn't executed and locks were not released.
-
-If your job takes more than 15 minutes to complete, you can tune concurrency
-lock TTL to fit your needs:
-
-``` ruby
-# Set concurrency strategy lock TTL to 1 hour.
-sidekiq_throttle(:concurrency => { :limit => 20, :ttl => 1.hour.to_i })
-```
-
-
-## Enhanced Queues list
-
-This gem provides ability to pause/resume queues from processing by workers.
-So you may simply pause particular queue without need to stop and reconfigure
-workers by simply pushing a button on sidekiq web UI.
-
-By default we add *Enhanced Queues* tab with this functionality. But if you
-want you can override default *Queues* tab completely (notice that page will
-still be available using it's URL, but tab will be pointing enhanced version).
-To do so, just call `Sidekiq::Throttled::Web.enhance_queues_tab!` somewhere
-in your initializer/bootstrap code. If you are using rails, you might want to
-add it right into your `config/routes.rb` file:
-
-``` ruby
-# file config/routes.rb
-
-require "sidekiq/web"
-require "sidekiq/throttled/web"
-
-Rails.application.routes.draw do
-  # ...
-
-  # Replace Sidekiq Queues with enhanced version!
-  Sidekiq::Throttled::Web.enhance_queues_tab!
-
-  # Mount Sidekiq Web UI to `/sidekiq` endpoint
-  mount Sidekiq::Web => "/sidekiq"
-
-  # ...
-end
-```
-
-
-## Supported Ruby Versions
-
-This library aims to support and is [tested against][ci] the following Ruby
-versions:
-
-* Ruby 2.7.x
-* Ruby 3.0.x
-* Ruby 3.1.x
-
-If something doesn't work on one of these versions, it's a bug.
-
-This library may inadvertently work (or seem to work) on other Ruby versions,
-however support will only be provided for the versions listed above.
-
-If you would like this library to support another Ruby version or
-implementation, you may volunteer to be a maintainer. Being a maintainer
-entails making sure all tests run and pass on that implementation. When
-something breaks on your implementation, you will be responsible for providing
-patches in a timely fashion. If critical issues for a particular implementation
-exist at the time of a major release, support for that Ruby version may be
-dropped.
-
-
-## Supported Sidekiq Versions
-
-This library aims to support work with following [Sidekiq][sidekiq] versions:
-
-* Sidekiq 6.4.x
-* Sidekiq 6.5.x
-
-
-## Contributing
-
-* Fork sidekiq-throttled on GitHub
-* Make your changes
-* Ensure all tests pass (`bundle exec rake`)
-* Send a pull request
-* If we like them we'll merge them
-* If we've accepted a patch, feel free to ask for commit access!
-
-
-## Development
-
-```
-bundle update
-bundle exec appraisal install   # install dependencies for all gemfiles
-bundle exec appraisal update    # update dependencies for all gemfiles
-bundle exec appraisal rspec     # run rspec against each gemfile
-bundle exec rubocop             # run static code analysis
-```
-
-Don't forget to run `appraisal update` after any changes to `Gemfile`.
-
-
-[ci]: https://github.com/ixti/sidekiq-throttled/actions/workflows/ci.yml
-[sidekiq]: https://github.com/mperham/sidekiq

data/Rakefile

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-
-require "rspec/core/rake_task"
-RSpec::Core::RakeTask.new(:spec)
-
-desc "Run RuboCop"
-task :rubocop do
-  require "rubocop"
-  result = RuboCop::CLI.new.run([])
-  abort("RuboCop failed!") if result.nonzero?
-end
-
-namespace :rubocop do
-  desc "Auto-correct RuboCop offenses"
-  task :autocorrect do
-    require "rubocop"
-    result = RuboCop::CLI.new.run(["--auto-correct"])
-    abort("RuboCop failed!") if result.nonzero?
-  end
-end
-
-default_suite = ENV["CI"] ? :spec : %i[spec rubocop]
-named_suites  = { "rubocop" => :rubocop, "rspec" => :spec }
-
-task :default => named_suites.fetch(ENV.fetch("SUITE", nil), default_suite)