sidekiq-throttled 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90f1a4d340b3475746da902b0a469af8269e39fc6953b8bb08e759c0600caf1e
-  data.tar.gz: d03565985b3a0cca9d350a1b86c97530fc3b02bfef3773ecebe5ee7654ee8286
+  metadata.gz: 6a187d7a0ab7f55794f909da549082fb32ec06acca0e75928fa970fd2312a63e
+  data.tar.gz: c6acd8c1ebe40741e0285e6de82c0384b60a7a03ccee602b8de29309cb8bc313
 SHA512:
-  metadata.gz: 88770ec54943f0f455432de0e9455ef19877f5ddbf58821c3e8ee997afc0c0f3b7468010aa2fe4297c3f9069758e8e903e1a3243271afa454aff5575afcea071
-  data.tar.gz: d1345ef48cb90f9174f71a9bc2625f5d1c2d218e5d1eb7d00f98c3014efbb0e83e3682ca8742baa960e17433da80267a8b716cad4a04b78716e96f9089fb01f3
+  metadata.gz: 6f777dff16dc389b43a089c4e392228afc695830bea0bedb4a4aa4b04d49b44a0ae5b60d643a255548947f90eeb198aaf91219f9f282de29b8c7c009626e6e4f
+  data.tar.gz: 86b28f4fa073f7930254269e766576da4bf3412a262d9e0329285221b1376437dc6f072e9aa93be1402da7e06f3f5501ce416b241d134c666546ae3abb7397fe

data/README.adoc

@@ -12,11 +12,7 @@
 {doc-link}[image:{doc-badge}[API Documentation]]
 ****
 
-NOTE: This is the 1.x *development* branch. For the 0.x *stable* branch, please
-  see: https://github.com/ixti/sidekiq-throttled/tree/0-x-stable[0-x-stable]
-
-Concurrency and threshold throttling for https://github.com/mperham/sidekiq[Sidekiq].
-
+Concurrency and threshold throttling for https://github.com/sidekiq/sidekiq[Sidekiq].
 
 == Installation
 
@@ -44,12 +40,8 @@ you are using Rails):
 [source,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:
 
@@ -108,6 +100,30 @@ end
 ----
 
 
+==== Middleware(s)
+
+`Sidekiq::Throttled` relies on following bundled middlewares:
+
+* `Sidekiq::Throttled::Middlewares::Server`
+
+The middleware is automatically injected when you require `sidekiq/throttled`.
+In rare cases this might be an issue. You can change to order manually:
+
+[source,ruby]
+----
+Sidekiq.configure_server do |config|
+  # ...
+
+  config.server_middleware do |chain|
+    chain.remove(Sidekiq::Throttled::Middlewares::Server)
+    chain.add(Sidekiq::Throttled::Middlewares::Server)
+  end
+end
+----
+
+See: https://github.com/sidekiq/sidekiq/blob/main/lib/sidekiq/middleware/chain.rb
+
+
 === Observer
 
 You can specify an observer that will be called on throttling. To do so pass an
@@ -251,6 +267,7 @@ sidekiq_throttle(concurrency: { limit: 20, ttl: 1.hour.to_i })
 
 This library aims to support and is tested against the following Ruby versions:
 
+* Ruby 2.7.x
 * Ruby 3.0.x
 * Ruby 3.1.x
 * Ruby 3.2.x
@@ -295,3 +312,11 @@ This library aims to support and work with following Sidekiq versions:
 * 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!
+
+
+== Endorsement
+
+https://github.com/sensortower[image:sensortower.svg[SensorTower]]
+
+The initial work on the project was initiated to address the needs of
+https://github.com/sensortower[SensorTower].

data/lib/sidekiq/throttled/middlewares/server.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# internal
+require_relative "../registry"
+
+module Sidekiq
+  module Throttled
+    module Middlewares
+      # Server middleware required for Sidekiq::Throttled functioning.
+      class Server
+        include Sidekiq::ServerMiddleware
+
+        def call(_worker, msg, _queue)
+          yield
+        ensure
+          job = msg.fetch("wrapped") { msg["class"] }
+          jid = msg["jid"]
+
+          if job && jid
+            Registry.get job do |strategy|
+              strategy.finalize!(jid, *msg["args"])
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -15,7 +15,7 @@ module Sidekiq
           return key unless @key_suffix
 
           key << ":#{@key_suffix.call(*job_args)}"
-        rescue => e
+        rescue StandardError => e
           Sidekiq.logger.error "Failed to get key suffix: #{e}"
           raise e
         end

data/lib/sidekiq/throttled/version.rb

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

data/lib/sidekiq/throttled.rb

@@ -5,7 +5,7 @@ require "sidekiq"
 require_relative "./throttled/config"
 require_relative "./throttled/cooldown"
 require_relative "./throttled/job"
-require_relative "./throttled/middleware"
+require_relative "./throttled/middlewares/server"
 require_relative "./throttled/patches/basic_fetch"
 require_relative "./throttled/registry"
 require_relative "./throttled/version"
@@ -18,7 +18,6 @@ module Sidekiq
   # Just add somewhere in your bootstrap:
   #
   #     require "sidekiq/throttled"
-  #     Sidekiq::Throttled.setup!
   #
   # Once you've done that you can include {Sidekiq::Throttled::Job} to your
   # job classes and configure throttling:
@@ -70,14 +69,6 @@ module Sidekiq
         end
       end
 
-      def setup!
-        Sidekiq.configure_server do |config|
-          config.server_middleware do |chain|
-            chain.add Sidekiq::Throttled::Middleware
-          end
-        end
-      end
-
       # Tells whenever job is throttled or not.
       #
       # @param [String] message Job's JSON payload
@@ -94,9 +85,27 @@ module Sidekiq
         end
 
         false
-      rescue
+      rescue StandardError
         false
       end
+
+      # @deprecated Will be removed in 2.0.0
+      def setup!
+        warn "Sidekiq::Throttled.setup! was deprecated"
+
+        Sidekiq.configure_server do |config|
+          config.server_middleware do |chain|
+            chain.remove(Sidekiq::Throttled::Middlewares::Server)
+            chain.add(Sidekiq::Throttled::Middlewares::Server)
+          end
+        end
+      end
+    end
+  end
+
+  configure_server do |config|
+    config.server_middleware do |chain|
+      chain.add(Sidekiq::Throttled::Middlewares::Server)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-throttled
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Alexey Zapparov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-20 00:00:00.000000000 Z
+date: 2023-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -59,7 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
+- LICENSE.txt
 - README.adoc
 - lib/sidekiq/throttled.rb
 - lib/sidekiq/throttled/config.rb
@@ -67,7 +67,7 @@ files:
 - lib/sidekiq/throttled/errors.rb
 - lib/sidekiq/throttled/expirable_set.rb
 - lib/sidekiq/throttled/job.rb
-- lib/sidekiq/throttled/middleware.rb
+- lib/sidekiq/throttled/middlewares/server.rb
 - lib/sidekiq/throttled/patches/basic_fetch.rb
 - lib/sidekiq/throttled/registry.rb
 - lib/sidekiq/throttled/strategy.rb
@@ -87,9 +87,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/ixti/sidekiq-throttled
-  source_code_uri: https://github.com/ixti/sidekiq-throttled/tree/v1.0.1
+  source_code_uri: https://github.com/ixti/sidekiq-throttled/tree/v1.2.0
   bug_tracker_uri: https://github.com/ixti/sidekiq-throttled/issues
-  changelog_uri: https://github.com/ixti/sidekiq-throttled/blob/v1.0.1/CHANGES.md
+  changelog_uri: https://github.com/ixti/sidekiq-throttled/blob/v1.2.0/CHANGES.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -99,14 +99,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Concurrency and rate-limit throttling for Sidekiq

data/lib/sidekiq/throttled/middleware.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-# internal
-require_relative "./registry"
-
-module Sidekiq
-  module Throttled
-    # Server middleware that notifies strategy that job was finished.
-    #
-    # @private
-    class Middleware
-      include Sidekiq::ServerMiddleware
-
-      # Called within Sidekiq job processing
-      def call(_worker, msg, _queue)
-        yield
-      ensure
-        job = msg.fetch("wrapped") { msg["class"] }
-        jid = msg["jid"]
-
-        if job && jid
-          Registry.get job do |strategy|
-            strategy.finalize!(jid, *msg["args"])
-          end
-        end
-      end
-    end
-  end
-end