sidekiq-throttled 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a204bc340965b64fe16f9b896815c9b3fbf383418b0774871d90c35d4c8fb061
-  data.tar.gz: bb2b9681a7caf33d3418ab2f475bc0ab2f6141ed9e6609d55d680815da71c4e6
+  metadata.gz: '05945dcd1de433dd74010e8fa402c6fb2e6100fb6306aef386536da24cd2e08b'
+  data.tar.gz: fe07b3c6409e7749f2af3b85d36e27dcda5d53b92c771e050a951f6175cec407
 SHA512:
-  metadata.gz: '0801102f967a02d3a023b9d8bfe04b8d44280c5f2986182ef4a5cc6e971091afcb3fb1b6c845f382829de071e11d6a3111cb04a21b040b022b61ecac76d5a422'
-  data.tar.gz: 243ceeb9a791417edc07a7f697660035e52a61f3db4aefbe93508be5037d1af1932d2b3ad81886ee1b9ef8408e97f1bef8cac03b9a78d8e4c29a2197f9f927f6
+  metadata.gz: 2965642d0564eaf45c033b6c6d6ddfe5b80804eebfbfef7908c4f81bbc450baec4e71d1b70fe21bf6515336d173b3a95e74c4b97aa26d35a3947b7b24ba02c1e
+  data.tar.gz: 149ba3f6d29c9963c52f96d7ea1b6be23424726a7791afe7c3fad4ab95bf82b2db0df274ee3a26842e7726e1f403afff2d99c997f1033f2ddb63a95f9790d698

data/CHANGES.md

@@ -1,3 +1,10 @@
+## 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)
@@ -193,3 +200,4 @@
 [@iporsut]: https://github.com/iporsut
 [@mstruve]: https://github.com/mstruve
 [@ziaulrehman40]: https://github.com/ziaulrehman40
+[@ogins57]: https://github.com/ogins57

data/README.md

@@ -59,6 +59,38 @@ class MyWorker
 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 MyWorker
+  include Sidekiq::Worker
+  include Sidekiq::Throttled::Worker
+
+  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 arguements that were passed
+to the job.
+
 
 ### Dynamic throttling
 

data/lib/sidekiq/throttled/strategy.rb

@@ -19,26 +19,24 @@ module Sidekiq
       #   @return [Strategy::Threshold, nil]
       attr_reader :threshold
 
+      # @!attribute [r] observer
+      #   @return [Proc, nil]
+      attr_reader :observer
+
       # @param [#to_s] name
       # @param [Hash] concurrency Concurrency options.
       #   See keyword args of {Strategy::Concurrency#initialize} for details.
       # @param [Hash] threshold Threshold options.
       #   See keyword args of {Strategy::Threshold#initialize} for details.
       # @param [#call] key_suffix Dynamic key suffix generator.
-      def initialize(name, concurrency: nil, threshold: nil, key_suffix: nil)
-        key = "throttled:#{name}"
-
-        @concurrency =
-          if concurrency
-            concurrency[:key_suffix] ||= key_suffix
-            Concurrency.new(key, **concurrency)
-          end
-
-        @threshold =
-          if threshold
-            threshold[:key_suffix] ||= key_suffix
-            Threshold.new(key, **threshold)
-          end
+      # @param [#call] observer Process called after throttled.
+      def initialize(
+        name,
+        concurrency: nil, threshold: nil, key_suffix: nil, observer: nil
+      )
+        @observer    = observer
+        @concurrency = make_strategy(Concurrency, name, key_suffix, concurrency)
+        @threshold   = make_strategy(Threshold, name, key_suffix, threshold)
 
         return if @concurrency || @threshold
 
@@ -55,9 +53,13 @@ module Sidekiq
 
       # @return [Boolean] whenever job is throttled or not.
       def throttled?(jid, *job_args)
-        return true if @concurrency&.throttled?(jid, *job_args)
+        if @concurrency&.throttled?(jid, *job_args)
+          @observer&.call(:concurrency, *job_args)
+          return true
+        end
 
         if @threshold&.throttled?(*job_args)
+          @observer&.call(:threshold, *job_args)
           finalize!(jid, *job_args)
           return true
         end
@@ -77,6 +79,18 @@ module Sidekiq
         @concurrency&.reset!
         @threshold&.reset!
       end
+
+      private
+
+      # @return [Base, nil]
+      def make_strategy(strategy, name, key_suffix, options)
+        return unless options
+
+        strategy.new("throttled:#{name}", {
+          :key_suffix => key_suffix,
+          **options
+        })
+      end
     end
   end
 end

data/lib/sidekiq/throttled/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-throttled
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Alexey V Zapparov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-24 00:00:00.000000000 Z
+date: 2019-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby