sidekiq-antidote 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3692f76b40f4cf3cf7c8231c3a882e09ab5f81dec49cc3711b268602cd9bb0a3
-  data.tar.gz: 2845af94e4a35930c1cd775a075774ee72a70af2c3a498f802f2cc56f99edf07
+  metadata.gz: dce4fd5b1e9e0062569e3cc9d2febc7a699f9cceaa2f738114f6555dfeea38bb
+  data.tar.gz: 3ed45d2c929f9749b2a6e9f5d7257f419de569ca0cb7bb306a9e21c98b2efc1a
 SHA512:
-  metadata.gz: 15c6e2fc733cae175d0e1d3b4b2f23ae666156c0b4386cf51287306d9601e3a09f4fccb2cac5adb6270f7e39e5937b99071e82804666a4fecc130ab2da020c04
-  data.tar.gz: a7307425321fd20db807a2e16419b6cad463288658cf78ce9063cacf828b83b84977075686882fb35c56e0c87cb8c060dc451bd6a788fe3b8af48f8d892ddc52
+  metadata.gz: b86b69872c145890c4656a4c4c84d15cc14002e10ea6300120ddb42400fc3e4d0979f177622b9785311d2ff86e78859d7bf37600d3135b93874611e79ab17037
+  data.tar.gz: c6f79bd8ac0d37c5a704d091b01bddc06f564553f441ae38198b12c50899cfceed4eda2cfc8d9045748182623484f07b0224336d9a6ea17d184f65f98461beba

data/README.adoc

@@ -52,6 +52,41 @@ require "sidekiq/web"
 require "sidekiq/antidote/web"
 ----
 
+=== Middleware(s)
+
+`Sidekiq::Antidote` relies on following bundled middlewares:
+
+* `Sidekiq::Antidote::Middlewares::Client`
+* `Sidekiq::Antidote::Middlewares::Server`
+
+The middleware is automatically injected when you require `sidekiq/antidote`.
+In rare cases, when this causes an issue, you can change middleware order manually:
+
+[source,ruby]
+----
+Sidekiq.configure_client do |config|
+  # ...
+
+  config.client_middleware do |chain|
+    chain.prepend(Sidekiq::Antidote::Middlewares::Client)
+  end
+end
+
+Sidekiq.configure_server do |config|
+  # ...
+
+  config.client_middleware do |chain|
+    chain.prepend(Sidekiq::Antidote::Middlewares::Client)
+  end
+
+  config.server_middleware do |chain|
+    chain.prepend(Sidekiq::Antidote::Middlewares::Server)
+  end
+end
+----
+
+See: https://github.com/sidekiq/sidekiq/blob/main/lib/sidekiq/middleware/chain.rb
+
 
 == Inhibitors
 
@@ -65,10 +100,10 @@ kill::
   Kill the job (send to the dead set instead of enqueueing and/or performing)
 
 
-=== Antidote Qualifiers
+=== Class Qualifiers
 
-Qualifier is the job class pattern. It may match the job class or the job class
-and method name (when used with ActionMailer delayed deliveries):
+Class qualifier is the job class pattern. It may match the job class or the job
+class and method name (when used with ActionMailer delayed deliveries):
 
 * `ExampleJob`
 * `Namespaced::ExampleJob`
@@ -90,35 +125,38 @@ You can also use pattern matching:
   * `{A,B,C}Job` matches `AJob`, `BJob`, and `CJob`
 
 
-== Supported Ruby Versions
+== Compatibility
 
-This library aims to support and is tested against the following Ruby versions:
+This library aims to support and is tested against:
 
-* Ruby 3.0.x
-* Ruby 3.1.x
-* Ruby 3.2.x
+* https://www.ruby-lang.org[Ruby]
+** MRI 3.0.x
+** MRI 3.1.x
+** MRI 3.2.x
+** MRI 3.3.x
+** MRI 3.4.x
+* https://github.com/sidekiq/sidekiq[Sidekiq]
+** 7.2.x
+** 7.3.x
+* https://redis.io[Redis]
+** 7.0.x
+** 7.2.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.
+This library may inadvertently work (or seem to work) on other Ruby, Redis, and
+Sidekiq 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
+If you would like this library to support another Ruby, Redis, or Sidekiq
+version, 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, Redis, and/or Sidekiq version may be
 dropped.
 
 
-== Supported Sidekiq Versions
-
-This library aims to support and work with following Sidekiq versions:
-
-* Sidekiq 7.2.x
-
-
 == Development
 
   bundle install

data/lib/sidekiq/antidote/class_qualifier.rb

@@ -36,11 +36,6 @@ module Sidekiq
       # @return [Regexp]
       attr_reader :regexp
 
-      # @!method match?(job_class)
-      #   @param job_class [String]
-      #   @return [Boolean]
-      def_delegator :regexp, :match?
-
       # @param pattern [#to_s]
       def initialize(pattern)
         @pattern = pattern.to_s.strip.freeze
@@ -51,6 +46,12 @@ module Sidekiq
         freeze
       end
 
+      # @param job_class [String, Class]
+      # @return [Boolean]
+      def match?(job_class)
+        regexp.match?(job_class.to_s)
+      end
+
       # @param other [Object]
       # @return [Boolean]
       def eql?(other)

data/lib/sidekiq/antidote/inhibitor.rb

@@ -33,10 +33,6 @@ module Sidekiq
         freeze
       end
 
-      def lethal?
-        "kill" == treatment
-      end
-
       def match?(job_record)
         class_qualifier.match?(job_record.display_class)
       end

data/lib/sidekiq/antidote/middlewares/client.rb

@@ -11,8 +11,8 @@ module Sidekiq
 
         # @see https://github.com/sidekiq/sidekiq/wiki/Middleware
         # @see https://github.com/sidekiq/sidekiq/wiki/Job-Format
-        def call(_, job_payload, _, _)
-          yield unless inhibit(job_payload)
+        def call(_, job_payload, queue_name, _)
+          yield unless inhibit(job_payload, queue_name)
         end
       end
     end

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

@@ -11,8 +11,8 @@ module Sidekiq
 
         # @see https://github.com/sidekiq/sidekiq/wiki/Middleware
         # @see https://github.com/sidekiq/sidekiq/wiki/Job-Format
-        def call(_, job_payload, _)
-          yield unless inhibit(job_payload)
+        def call(_, job_payload, queue_name)
+          yield unless inhibit(job_payload, queue_name)
         end
       end
     end

data/lib/sidekiq/antidote/middlewares/shared.rb

@@ -10,17 +10,27 @@ module Sidekiq
 
         # @return [true] if message was inhibited
         # @return [false] otherwise
-        def inhibit(message)
+        def inhibit(message, queue_name)
           job_record = Sidekiq::JobRecord.new(message)
           inhibitor  = Antidote.remedy_for(job_record)
           return false unless inhibitor
 
           Antidote.log(:warn) { "I've got a poison! -- #{job_record.display_class}" }
           Antidote.log(:warn) { "I've got a remedy! -- #{inhibitor}" }
-          DeadSet.new.kill(Sidekiq.dump_json(message)) if inhibitor.lethal?
+
+          apply_treatment(inhibitor, job_record, queue_name)
 
           true
         end
+
+        def apply_treatment(inhibitor, job_record, queue_name)
+          # Ensure message has queue name
+          message = Sidekiq.dump_json(job_record.item.merge({ "queue" => queue_name }))
+
+          case inhibitor.treatment
+          when "kill" then DeadSet.new.kill(message)
+          end
+        end
       end
     end
   end

data/lib/sidekiq/antidote/remedy.rb

@@ -13,9 +13,8 @@ module Sidekiq
       # @param refresh_rate [Float]
       # @param repository [Repository]
       def initialize(refresh_rate, repository:)
-        @inhibitors = [].freeze
-        @refresher  = Concurrent::TimerTask.new(execution_interval: refresh_rate, run_now: true) do
-          @inhibitors = repository.to_a.freeze
+        @refresher = Concurrent::TimerTask.new(execution_interval: refresh_rate, run_now: true) do
+          repository.to_a.freeze
         end
       end
 
@@ -30,7 +29,7 @@ module Sidekiq
         return to_enum __method__ unless block
 
         start_refresher unless refresher_running?
-        @inhibitors.each(&block)
+        @refresher.value&.each(&block)
 
         self
       end

data/lib/sidekiq/antidote/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Antidote
-    VERSION = "1.0.0"
+    VERSION = "1.2.0"
   end
 end

data/web/locales/en.yml

@@ -1,7 +1,7 @@
 ---
 en:
   antidote.treatment: Treatment
-  antidote.qualifier: Qualifier
+  antidote.class_qualifier: Class Qualifier
   antidote.actions: Actions
   antidote.add: Add Inhibitor
   antidote.add.submit: Submit

data/web/views/add.html.erb

@@ -25,11 +25,11 @@
       </div>
     </div>
     <div class="form-group <%= "has-error" if @class_qualifier_error %>">
-      <label class="col-sm-2 control-label"><%= t("antidote.qualifier") %></label>
+      <label class="col-sm-2 control-label"><%= t("antidote.class_qualifier") %></label>
       <div class="col-sm-10">
-        <input id="antidote-inhibitor-qualifier" type="text" class="form-control <%= "is-invalid" if @class_qualifier_error %>" name="class_qualifier" value="<%= @class_qualifier %>">
+        <input id="antidote-inhibitor-class-qualifier" type="text" class="form-control <%= "is-invalid" if @class_qualifier_error %>" name="class_qualifier" value="<%= @class_qualifier %>">
         <% if @class_qualifier_error %>
-          <div id="antidote-inhibitor-qualifier-error" class="help-block">
+          <div id="antidote-inhibitor-class-qualifier-error" class="help-block">
             <strong>ERROR:</strong> <%= @class_qualifier_error %>
           </div>
         <% end %>

data/web/views/index.html.erb

@@ -12,7 +12,7 @@
     <table class="antidote table table-hover table-bordered table-striped">
       <thead>
         <th><%= t("antidote.treatment") %></th>
-        <th><%= t("antidote.qualifier") %></th>
+        <th><%= t("antidote.class_qualifier") %></th>
         <th><%= t("antidote.actions") %></th>
       </thead>
       <tbody>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-antidote
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Alexey Zapparov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-11 00:00:00.000000000 Z
+date: 2025-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -66,9 +66,9 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/ixti/sidekiq-antidote
-  source_code_uri: https://github.com/ixti/sidekiq-antidote/tree/v1.0.0
+  source_code_uri: https://github.com/ixti/sidekiq-antidote/tree/v1.2.0
   bug_tracker_uri: https://github.com/ixti/sidekiq-antidote/issues
-  changelog_uri: https://github.com/ixti/sidekiq-antidote/blob/v1.0.0/CHANGES.md
+  changelog_uri: https://github.com/ixti/sidekiq-antidote/blob/v1.2.0/CHANGES.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -85,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Sidekiq poison-pill instant remedy