sidekiq-throttled 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8ef8cce2c35072fd109e89066e293074fb125828
-  data.tar.gz: 575ea548b4594445fd8b2532896bac87149e96ef
+SHA256:
+  metadata.gz: 719506019ae06cb2b89b220681ca460b6446965aefd2268c3546c667e5f50fb5
+  data.tar.gz: 4e4a2f78b9bb978a20d4971ee9c7a78386405639d3c2a8a194d47c5e55d9ce32
 SHA512:
-  metadata.gz: 4f5b3b2b3023f776b247e07db7959ad691990d6dbddf26c662e101b95868440dea2c3f2c81f9ed139b5b471bfdc259b6a52649957f5bd809ec508b2f53fc7488
-  data.tar.gz: 5a898501386292385f3399ce572ea47110766e72c38dbf9ab5f57f23bca155c66c2e32cdb0c4b9adf31155b48382e96ca4a071294325cec3fc3beaa66ae9178b
+  metadata.gz: a0d220ca8d744ff3e211877b3f726305ed66e93a9045c402b569162e2d9d324ba6f00cbddf1f271cd33bba8ab7602bcead13e61f980576de9ec8d801e8814d29
+  data.tar.gz: 87b134e30aef111a955df66e48fec23df2152bb90e61063ef9737daf858d5525b5c70648519048d143c4399c47111ade2e84d7212ada43bc203cf2430ae8ad60

data/.gitignore

@@ -1,6 +1,7 @@
 /.bundle/
 /.yardoc
 /Gemfile.lock
+/gemfiles/.bundle
 /gemfiles/*.gemfile.lock
 /_yardoc/
 /coverage/

data/.travis.yml

@@ -51,3 +51,4 @@ gemfile:
   - gemfiles/sidekiq_4.1.gemfile
   - gemfiles/sidekiq_4.2.gemfile
   - gemfiles/sidekiq_5.0.gemfile
+  - gemfiles/sidekiq_5.1.gemfile

data/Appraisals

@@ -15,3 +15,7 @@ end
 appraise "sidekiq-5.0" do
   gem "sidekiq", "~> 5.0.0"
 end
+
+appraise "sidekiq-5.1" do
+  gem "sidekiq", "~> 5.1.0"
+end

data/CHANGES.md

@@ -1,3 +1,12 @@
+## 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.

data/README.md

@@ -181,6 +181,7 @@ This library aims to support work with following [Sidekiq][sidekiq] versions:
 * Sidekiq 4.1.x
 * Sidekiq 4.2.x
 * Sidekiq 5.0.x
+* Sidekiq 5.1.x
 
 
 ## Contributing
@@ -197,10 +198,10 @@ This library aims to support work with following [Sidekiq][sidekiq] versions:
 
 ```
 bundle update
-appraisal install   # install dependencies for all gemfiles
-appraisal update    # update dependencies for all gemfiles
-appraisal rspec     # run rspec against each gemfile
-bundle exec rubocop # run static code analysis
+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`.

data/gemfiles/sidekiq_4.0.gemfile

@@ -4,21 +4,21 @@ source "https://rubygems.org"
 
 gem "appraisal"
 gem "rake"
-gem "redis-namespace", :require => false
+gem "redis-namespace", require: false
 gem "rspec"
-gem "rubocop", "~> 0.47.0", :require => false
+gem "rubocop", "~> 0.50.0", require: false
 gem "sidekiq", "~> 4.0.0"
 
 group :development do
   gem "byebug"
-  gem "guard", :require => false
-  gem "guard-rspec", :require => false
-  gem "guard-rubocop", :require => false
+  gem "guard", require: false
+  gem "guard-rspec", require: false
+  gem "guard-rubocop", require: false
 end
 
 group :test do
   gem "capybara"
-  gem "coveralls", :require => false
+  gem "coveralls", require: false
   gem "poltergeist"
   gem "rack-test"
   gem "simplecov", ">= 0.9"
@@ -26,4 +26,4 @@ group :test do
   gem "timecop"
 end
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/sidekiq_4.1.gemfile

@@ -4,21 +4,21 @@ source "https://rubygems.org"
 
 gem "appraisal"
 gem "rake"
-gem "redis-namespace", :require => false
+gem "redis-namespace", require: false
 gem "rspec"
-gem "rubocop", "~> 0.47.0", :require => false
+gem "rubocop", "~> 0.50.0", require: false
 gem "sidekiq", "~> 4.1.0"
 
 group :development do
   gem "byebug"
-  gem "guard", :require => false
-  gem "guard-rspec", :require => false
-  gem "guard-rubocop", :require => false
+  gem "guard", require: false
+  gem "guard-rspec", require: false
+  gem "guard-rubocop", require: false
 end
 
 group :test do
   gem "capybara"
-  gem "coveralls", :require => false
+  gem "coveralls", require: false
   gem "poltergeist"
   gem "rack-test"
   gem "simplecov", ">= 0.9"
@@ -26,4 +26,4 @@ group :test do
   gem "timecop"
 end
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/sidekiq_4.2.gemfile

@@ -4,21 +4,21 @@ source "https://rubygems.org"
 
 gem "appraisal"
 gem "rake"
-gem "redis-namespace", :require => false
+gem "redis-namespace", require: false
 gem "rspec"
-gem "rubocop", "~> 0.47.0", :require => false
+gem "rubocop", "~> 0.50.0", require: false
 gem "sidekiq", "~> 4.2.0"
 
 group :development do
   gem "byebug"
-  gem "guard", :require => false
-  gem "guard-rspec", :require => false
-  gem "guard-rubocop", :require => false
+  gem "guard", require: false
+  gem "guard-rspec", require: false
+  gem "guard-rubocop", require: false
 end
 
 group :test do
   gem "capybara"
-  gem "coveralls", :require => false
+  gem "coveralls", require: false
   gem "poltergeist"
   gem "rack-test"
   gem "simplecov", ">= 0.9"
@@ -26,4 +26,4 @@ group :test do
   gem "timecop"
 end
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/sidekiq_5.0.gemfile

@@ -4,21 +4,21 @@ source "https://rubygems.org"
 
 gem "appraisal"
 gem "rake"
-gem "redis-namespace", :require => false
+gem "redis-namespace", require: false
 gem "rspec"
-gem "rubocop", "~> 0.47.0", :require => false
+gem "rubocop", "~> 0.50.0", require: false
 gem "sidekiq", "~> 5.0.0"
 
 group :development do
   gem "byebug"
-  gem "guard", :require => false
-  gem "guard-rspec", :require => false
-  gem "guard-rubocop", :require => false
+  gem "guard", require: false
+  gem "guard-rspec", require: false
+  gem "guard-rubocop", require: false
 end
 
 group :test do
   gem "capybara"
-  gem "coveralls", :require => false
+  gem "coveralls", require: false
   gem "poltergeist"
   gem "rack-test"
   gem "simplecov", ">= 0.9"
@@ -26,4 +26,4 @@ group :test do
   gem "timecop"
 end
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/sidekiq_5.1.gemfile

@@ -0,0 +1,29 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "rake"
+gem "redis-namespace", require: false
+gem "rspec"
+gem "rubocop", "~> 0.50.0", require: false
+gem "sidekiq", "~> 5.1.0"
+
+group :development do
+  gem "byebug"
+  gem "guard", require: false
+  gem "guard-rspec", require: false
+  gem "guard-rubocop", require: false
+end
+
+group :test do
+  gem "capybara"
+  gem "coveralls", require: false
+  gem "poltergeist"
+  gem "rack-test"
+  gem "simplecov", ">= 0.9"
+  gem "sinatra", "~> 1.4", ">= 1.4.6"
+  gem "timecop"
+end
+
+gemspec path: "../"

data/lib/sidekiq/throttled/expirable_list.rb

@@ -2,6 +2,8 @@
 
 require "monitor"
 
+require "concurrent/utility/monotonic_time"
+
 module Sidekiq
   module Throttled
     # List that tracks when elements were added and enumerates over those not
@@ -10,18 +12,22 @@ module Sidekiq
     # ## Implementation
     #
     # Internally list holds an array of arrays. Thus ecah element is a tuple of
-    # timestamp (when element was added) and element itself:
+    # monotonic timestamp (when element was added) and element itself:
     #
     #     [
-    #       [ 1234567890.12345, "default" ],
-    #       [ 1234567890.34567, "urgent" ],
-    #       [ 1234579621.56789, "urgent" ],
+    #       [ 123456.7890, "default" ],
+    #       [ 123456.7891, "urgent" ],
+    #       [ 123457.9621, "urgent" ],
     #       ...
     #     ]
     #
     # It does not deduplicates elements. Eviction happens only upon elements
     # retrieval (see {#each}).
     #
+    # @see http://ruby-concurrency.github.io/concurrent-ruby/Concurrent.html#monotonic_time-class_method
+    # @see https://ruby-doc.org/core/Process.html#method-c-clock_gettime
+    # @see https://linux.die.net/man/3/clock_gettime
+    #
     # @private
     class ExpirableList
       include Enumerable
@@ -38,7 +44,7 @@ module Sidekiq
       # @params element [Object]
       # @return [ExpirableList] self
       def <<(element)
-        @mon.synchronize { @arr << [Time.now.to_f, element] }
+        @mon.synchronize { @arr << [Concurrent.monotonic_time, element] }
         self
       end
 
@@ -52,7 +58,7 @@ module Sidekiq
         return to_enum __method__ unless block_given?
 
         @mon.synchronize do
-          horizon = Time.now.to_f - @ttl
+          horizon = Concurrent.monotonic_time - @ttl
 
           # drop all elements older than horizon
           @arr.shift while @arr[0] && @arr[0][0] < horizon

data/lib/sidekiq/throttled/strategy/concurrency.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
+require "redis/prescription"
+
 require "sidekiq/throttled/strategy/base"
-require "sidekiq/throttled/strategy/script"
 
 module Sidekiq
   module Throttled
@@ -19,7 +20,7 @@ module Sidekiq
         #       PUSH(@key, @jid)
         #       return 0
         #     end
-        SCRIPT = Script.read "#{__dir__}/concurrency.lua"
+        SCRIPT = Redis::Prescription.read "#{__dir__}/concurrency.lua"
         private_constant :SCRIPT
 
         # @param [#to_s] strategy_key
@@ -43,10 +44,12 @@ module Sidekiq
         def throttled?(jid, *job_args)
           return false unless (job_limit = limit(job_args))
 
-          keys = [key(job_args)]
-          args = [jid.to_s, job_limit, @ttl, Time.now.to_f]
+          kwargs = {
+            :keys => [key(job_args)],
+            :argv => [jid.to_s, job_limit, @ttl, Time.now.to_f]
+          }
 
-          1 == SCRIPT.eval(keys, args)
+          Sidekiq.redis { |redis| 1 == SCRIPT.eval(redis, kwargs) }
         end
 
         # @return [Integer] Current count of jobs

data/lib/sidekiq/throttled/strategy/threshold.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
+require "redis/prescription"
+
 require "sidekiq/throttled/strategy/base"
-require "sidekiq/throttled/strategy/script"
 
 module Sidekiq
   module Throttled
@@ -29,7 +30,7 @@ module Sidekiq
         #
         #     increase!
         #     return 0
-        SCRIPT = Script.read "#{__dir__}/threshold.lua"
+        SCRIPT = Redis::Prescription.read "#{__dir__}/threshold.lua"
         private_constant :SCRIPT
 
         # @param [#to_s] strategy_key
@@ -59,10 +60,12 @@ module Sidekiq
         def throttled?(*job_args)
           return false unless (job_limit = limit(job_args))
 
-          keys = [key(job_args)]
-          args = [job_limit, period(job_args), Time.now.to_f]
+          kwargs = {
+            :keys => [key(job_args)],
+            :argv => [job_limit, period(job_args), Time.now.to_f]
+          }
 
-          1 == SCRIPT.eval(keys, args)
+          Sidekiq.redis { |redis| 1 == SCRIPT.eval(redis, kwargs) }
         end
 
         # @return [Integer] Current count of jobs

data/lib/sidekiq/throttled/version.rb

@@ -3,6 +3,6 @@
 module Sidekiq
   module Throttled
     # Gem version
-    VERSION = "0.8.1"
+    VERSION = "0.8.2"
   end
 end

data/sidekiq-throttled.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "sidekiq"
+  spec.add_runtime_dependency "redis-prescription"
 
   spec.add_development_dependency "bundler", "~> 1.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-throttled
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Alexey V Zapparov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-02 00:00:00.000000000 Z
+date: 2018-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis-prescription
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -63,6 +77,7 @@ files:
 - gemfiles/sidekiq_4.1.gemfile
 - gemfiles/sidekiq_4.2.gemfile
 - gemfiles/sidekiq_5.0.gemfile
+- gemfiles/sidekiq_5.1.gemfile
 - lib/sidekiq/throttled.rb
 - lib/sidekiq/throttled/communicator.rb
 - lib/sidekiq/throttled/communicator/callbacks.rb
@@ -80,7 +95,6 @@ files:
 - lib/sidekiq/throttled/strategy/base.rb
 - lib/sidekiq/throttled/strategy/concurrency.lua
 - lib/sidekiq/throttled/strategy/concurrency.rb
-- lib/sidekiq/throttled/strategy/script.rb
 - lib/sidekiq/throttled/strategy/threshold.lua
 - lib/sidekiq/throttled/strategy/threshold.rb
 - lib/sidekiq/throttled/testing.rb
@@ -113,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: Concurrency and threshold throttling for Sidekiq.

data/lib/sidekiq/throttled/strategy/script.rb

@@ -1,95 +0,0 @@
-# frozen_string_literal: true
-
-require "digest/sha1"
-
-require "sidekiq"
-
-module Sidekiq
-  module Throttled
-    class Strategy
-      # Lua script executor for redis.
-      #
-      # Instead of executing script with `EVAL` everytime - loads script once
-      # and then runs it with `EVALSHA`.
-      #
-      # @private
-      class Script
-        # Script load command
-        LOAD = "load"
-        private_constant :LOAD
-
-        # Redis error fired when script ID is unkown
-        NOSCRIPT = "NOSCRIPT"
-        private_constant :NOSCRIPT
-
-        # LUA script source.
-        # @return [String]
-        attr_reader :source
-
-        # LUA script SHA1 digest.
-        # @return [String]
-        attr_reader :digest
-
-        # @param [#to_s] source Lua script
-        # @param [Logger] logger
-        def initialize(source, logger: Sidekiq.logger)
-          @source = source.to_s.strip.freeze
-          @digest = Digest::SHA1.hexdigest(@source).freeze
-          @logger = logger
-        end
-
-        # Loads script to redis
-        # @return [void]
-        def bootstrap!
-          namespaceless_redis do |conn|
-            digest = conn.script(LOAD, @source)
-
-            # XXX: this may happen **ONLY** if script digesting will be
-            #   changed in redis, which is not likely gonna happen.
-            unless @digest == digest
-              if @logger
-                @logger.warn "Unexpected script SHA1 digest: " \
-                  "#{digest.inspect} (expected: #{@digest.inspect})"
-              end
-
-              @digest = digest.freeze
-            end
-          end
-        end
-
-        # Executes script and returns result of execution
-        # @return Result of script execution
-        def eval(*args)
-          Sidekiq.redis do |conn|
-            begin
-              conn.evalsha(@digest, *args)
-            rescue => e
-              raise unless e.message.include? NOSCRIPT
-              bootstrap!
-              conn.evalsha(@digest, *args)
-            end
-          end
-        end
-
-        # Reads given file and returns new {Script} with its contents.
-        # @return [Script]
-        def self.read(file)
-          new File.read file
-        end
-
-        private
-
-        # Yields real namespace-less redis client.
-        def namespaceless_redis
-          Sidekiq.redis do |conn|
-            if defined?(Redis::Namespace) && conn.is_a?(Redis::Namespace)
-              conn = conn.redis
-            end
-
-            yield conn
-          end
-        end
-      end
-    end
-  end
-end