sidekiq-antidote 1.0.0.alpha.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 052bc50b4ce029ead4b2a4e6253625cf9a82a9c4071be61945e76336d9d13f18
-  data.tar.gz: a12ac47db5f3edee4fba2e600b1da4029db87657a8bde540a7b3f2fb2c07911b
+  metadata.gz: 9f5bdf47fd299dc626c6fc0afb94896301c66e5b1f9f33875383375d0d5ac483
+  data.tar.gz: bb9966c063f7ca0325d31229c6f4d0cf445d53392bb89a201dba92891759ece3
 SHA512:
-  metadata.gz: d9cf2a9e0db287b0b6c7d40a4fe99c7927dbb9aee9fdfd8efc06bdb81c91396f6b169271973746d2b543ac34673694c7894338d8c43d9f947f5f17659bafb4b8
-  data.tar.gz: 57d9306f0b40cbccd67a1cf9f5d7260ddb59098cf1078fca7aca4ae88df58b669e38e2a2dd6059cb4d1c48ecdbf35e2eb56ff55bcdf957f4955dca33f0dee102
+  metadata.gz: 87e30e47eb2e37cea51f9037469a4395651d49da8664558d893a71e83d7af275c32ea5ce2e6e8c6b6d464e979af684498972dd2a21c5ddedaf9fe73a2e4a1e62
+  data.tar.gz: ffea8f3beef24555534621992e60d18c3c3ec0ab3855e07a65e5a274a434a0285f8442efe851ef8c1377df8f9f72920d290c545b42eb56566c3ee0d53a124362

data/README.adoc

@@ -1,5 +1,12 @@
 = Sidekiq::Antidote
 
+:ci-url: https://github.com/ixti/sidekiq-antidote/actions/workflows/ci.yml?query=branch%3Amain
+:ci-img: https://github.com/ixti/sidekiq-antidote/actions/workflows/ci.yml/badge.svg?branch=main
+:codecov-url: https://codecov.io/gh/ixti/sidekiq-antidote/tree/main
+:codecov-img: https://codecov.io/gh/ixti/sidekiq-antidote/graph/badge.svg?token=F5AAMPN35A
+
+{ci-url}[image:{ci-img}[CI]]
+{codecov-url}[image:{codecov-img}[codecov]]
 
 == Installation
 
@@ -20,10 +27,6 @@ require "sidekiq"
 require "sidekiq/antidote"
 
 Sidekiq::Antidote.configure do |config|
-  # Set redis key prefix.
-  # Default: nil
-  config.key_prefix = "my-app:"
-
   # Set inhibitors cache refresh rate in seconds.
   # Default: 5.0
   config.refresh_rate = 10.0
@@ -49,36 +52,109 @@ require "sidekiq/web"
 require "sidekiq/antidote/web"
 ----
 
+=== Middleware(s)
 
-== Supported Ruby Versions
+`Sidekiq::Antidote` relies on following bundled middlewares:
 
-This library aims to support and is tested against the following Ruby versions:
+* `Sidekiq::Antidote::Middlewares::Client`
+* `Sidekiq::Antidote::Middlewares::Server`
 
-* Ruby 3.0.x
-* Ruby 3.1.x
-* Ruby 3.2.x
+The middleware is automatically injected when you require `sidekiq/antidote`.
+In rare cases, when this causes an issue, you can change middleware order manually:
 
-If something doesn't work on one of these versions, it's a bug.
+[source,ruby]
+----
+Sidekiq.configure_client do |config|
+  # ...
 
-This library may inadvertently work (or seem to work) on other Ruby versions,
-however support will only be provided for the versions listed above.
+  config.client_middleware do |chain|
+    chain.prepend(Sidekiq::Antidote::Middlewares::Client)
+  end
+end
 
-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.
+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
+
+=== Treatments
 
+When adding antidote you must pick on of the treatments:
 
-== Supported Sidekiq Versions
+skip::
+  Skip the job (don't enqueue and/or perform)
+kill::
+  Kill the job (send to the dead set instead of enqueueing and/or performing)
 
-This library aims to support and work with following Sidekiq versions:
 
-* Sidekiq 7.0.x
-* Sidekiq 7.1.x
-* Sidekiq 7.2.x
+=== Class Qualifiers
+
+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`
+* `UserMailer#welcome`
+
+You can also use pattern matching:
+
+*::
+  Matches any number of alpha-numeric characters and underscores:
+  * `*Job` matches: `ExampleJob`, but not `Namespaced::ExampleJob`, or `UserMailer#welcome`
+  * `UserMailer#*` matches any method of `UserMailer`
+**::
+  Matches any number of components:
+  * `**` mathes any job or mailer method
+  * `A::**::Job` matches `A::B::Job`, `A::B::C::D::CJob`, etc.
+  * `A**::Job` matches `A::Job`, `Abc::Job`, `A::B::Job`, etc.
+{}::
+  Matches any of the given literal:
+  * `{A,B,C}Job` matches `AJob`, `BJob`, and `CJob`
+
+
+== Compatibility
+
+This library aims to support and is tested against:
+
+* https://www.ruby-lang.org[Ruby]
+** MRI 3.0.x
+** MRI 3.1.x
+** MRI 3.2.x
+** MRI 3.3.x
+* https://github.com/sidekiq/sidekiq[Sidekiq]
+** 7.2.x
+** 7.3.x
+* https://redis.io[Redis]
+** 6.2.x
+** 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, 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, 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.
 
 
 == Development

data/lib/sidekiq/antidote/config.rb

@@ -3,53 +3,16 @@
 module Sidekiq
   module Antidote
     class Config
-      REDIS_KEY = "sidekiq-antidote"
-      private_constant :REDIS_KEY
-
       # Default refresh rate
       REFRESH_RATE = 5.0
 
-      # @return [String?]
-      attr_reader :key_prefix
-
       # @return [Float]
       attr_reader :refresh_rate
 
-      # Fully qualified Redis key
-      #
-      # @example Without key prefix (default)
-      #   config.redis_key # => "sidekiq-antidote"
-      #
-      # @example With key prefix
-      #   config.key_prefix = "foobar:"
-      #   config.redis_key # => "foobar:sidekiq-antidote"
-      #
-      # @see #key_prefix
-      # @return [String]
-      attr_reader :redis_key
-
       def initialize
-        @key_prefix   = nil
-        @redis_key    = REDIS_KEY
         @refresh_rate = REFRESH_RATE
       end
 
-      # Redis key prefix.
-      #
-      # @example
-      #   config.key_prefix = "foobar:"
-      #   config.redis_key # => "foobar:sidekiq-antidote"
-      #
-      # @see #redis_key
-      # @param value [String, nil] String that should be prepended to redis key
-      # @return [void]
-      def key_prefix=(value)
-        raise ArgumentError, "expected String, or nil; got #{value.class}" unless value.nil? || value.is_a?(String)
-
-        @redis_key  = [value, REDIS_KEY].compact.join.freeze
-        @key_prefix = value&.then(&:-@) # Don't freeze original String value if it was unfrozen
-      end
-
       # Inhibitors cache refresh rate in seconds.
       #
       # @param value [Float] refresh interval in seconds

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

@@ -4,6 +4,7 @@ require "concurrent"
 
 module Sidekiq
   module Antidote
+    # @api internal
     # Eventually consistent list of inhibitors. Used by middlewares to avoid
     # hitting Redis on every lookup.
     class Remedy
@@ -12,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
 
@@ -29,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/repository.rb

@@ -8,12 +8,7 @@ module Sidekiq
     class Repository
       include Enumerable
 
-      # @param redis_key [#to_s]
-      def initialize(redis_key)
-        @redis_key = -redis_key.to_s
-
-        freeze
-      end
+      REDIS_KEY = "sidekiq-antidote"
 
       # @overload each
       #   @return [Enumerator<Inhibitor>]
@@ -27,7 +22,7 @@ module Sidekiq
 
         broken_ids = []
 
-        redis("HGETALL", @redis_key).each do |id, payload|
+        redis("HGETALL", REDIS_KEY).each do |id, payload|
           inhibitor = deserialize(id, payload)
           next yield inhibitor if inhibitor
 
@@ -50,7 +45,7 @@ module Sidekiq
             class_qualifier: class_qualifier
           )
 
-          return inhibitor if redis("HSETNX", @redis_key, *serialize(inhibitor)).to_i.positive?
+          return inhibitor if redis("HSETNX", REDIS_KEY, *serialize(inhibitor)).to_i.positive?
         end
 
         raise "can't generate available ID"
@@ -59,7 +54,7 @@ module Sidekiq
       # @param ids [Array<String>]
       # @return [nil]
       def delete(*ids)
-        redis("HDEL", @redis_key, *ids) unless ids.empty?
+        redis("HDEL", REDIS_KEY, *ids) unless ids.empty?
         nil
       end
 

data/lib/sidekiq/antidote/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Antidote
-    VERSION = "1.0.0.alpha.1"
+    VERSION = "1.1.0"
   end
 end

data/lib/sidekiq/antidote.rb

@@ -14,9 +14,10 @@ require_relative "./antidote/version"
 module Sidekiq
   module Antidote
     MUTEX = Mutex.new
+    private_constant :MUTEX
 
     @config     = Config.new.freeze
-    @repository = Repository.new(@config.redis_key)
+    @repository = Repository.new
     @remedy     = Remedy.new(@config.refresh_rate, repository: @repository)
 
     class << self
@@ -32,10 +33,6 @@ module Sidekiq
       #   @return (see Repository#delete)
       def_delegators :@repository, :delete
 
-      # @!attribute [r] redis_key
-      #   @return [String]
-      def_delegators :@config, :redis_key
-
       # @return [Array<Inhibitor>] Live list of inhibitors
       def inhibitors
         @repository.to_a
@@ -62,8 +59,7 @@ module Sidekiq
 
           yield config
 
-          @config     = config.freeze
-          @repository = Repository.new(@config.redis_key)
+          @config = config.freeze
 
           self
         ensure

data/web/locales/en.yml

@@ -1,8 +1,10 @@
 ---
 en:
   antidote.treatment: Treatment
-  antidote.qualifier: Job Class Pattern
+  antidote.class_qualifier: Class Qualifier
   antidote.actions: Actions
   antidote.add: Add Inhibitor
-  antidote.submit: Submit
+  antidote.add.submit: Submit
+  antidote.add.confirm: Are you sure you want to add the inhibitor?
   antidote.no_inhibitors: No inhibitors found
+  antidote.delete.confirm: Are you sure you want to delete inhibitor of ‹%{qualifier}› with ‹%{treatment}› treatment?

data/web/views/add.html.erb

@@ -6,26 +6,51 @@
   <div class="alert alert-danger"><%= @error %></div>
 <% end %>
 
-<form id="antidote-inhibitor" action="<%=root_path %>antidote/add" method="post">
-  <%= csrf_tag %>
-  <div class="form-row">
-    <div class="form-group col-md-2">
-      <label for="antidote-inhibitor-treatment"><%= t("antidote.treatment") %></label>
-      <select id="antidote-inhibitor-treatment" name="treatment" class="form-control">
-        <% Sidekiq::Antidote::Inhibitor::TREATMENTS.each do |treatment| %>
-          <option <%= "selected" if treatment == @treatment %>><%= treatment %></option>
+<div class="col-sm-12">
+  <form id="antidote-inhibitor" class="form-horizontal" action="<%=root_path %>antidote/add" method="post">
+    <%= csrf_tag %>
+    <div class="form-group">
+      <label class="col-sm-2 control-label"><%= t("antidote.treatment") %></label>
+      <div class="radio col-sm-10">
+        <label>
+          <input id="antidote-inhibitor-treatment-skip" type="radio" name="treatment" value="skip" <%= "checked" if "skip" == @treatment %>>
+          skip <em class="text-muted">(don't enqueue and/or perform)</em>
+        </label>
+      </div>
+      <div class="radio col-sm-offset-2 col-sm-10">
+        <label>
+          <input id="antidote-inhibitor-treatment-kill" type="radio" name="treatment" value="kill" <%= "checked" if "kill" == @treatment %>>
+          kill <em class="text-muted">(send to the dead set instead of enqueueing and/or performing)</em>
+        </label>
+      </div>
+    </div>
+    <div class="form-group <%= "has-error" if @class_qualifier_error %>">
+      <label class="col-sm-2 control-label"><%= t("antidote.class_qualifier") %></label>
+      <div class="col-sm-10">
+        <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-class-qualifier-error" class="help-block">
+            <strong>ERROR:</strong> <%= @class_qualifier_error %>
+          </div>
         <% end %>
-      </select>
+        <div class="help-block">
+          <strong>Examples:</strong>
+          <ul class="list-unstyled">
+            <li><kbd>ExampleJob</kbd> to match <var>ExampleJob</var> exactly</li>
+            <li><kbd>Namespaced::ExampleJob</kbd> to match <var>Namespaced::ExampleJob</var> exactly</li>
+            <li><kbd>UserMailer#welcome</kbd> to match <var>welcome</var> method of <var>UserMailer</var></li>
+            <li><kbd>*Job</kbd> to match <var>ExampleJob</var>, but not <var>Namespaced::ExampleJob</var></li>
+            <li><kbd>UserMailer#*</kbd> to match any method of <var>UserMailer</var></li>
+            <li><kbd>**Job</kbd> to match <var>ExampleJob</var>, <var>Namespaced::ExampleJob</var>, etc.</li>
+            <li><kbd>{A,B,C}Job</kbd> to match <var>AJob</var>, <var>BJob</var>, or <var>CJob</var></li>
+          </ul>
+        </div>
+      </div>
     </div>
-    <div class="form-group col-md-10">
-      <label for="antidote-inhibitor-class-qualifier"><%= t("antidote.qualifier") %></label>
-      <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-class-qualifier-error" class="invalid-feedback"><%= @class_qualifier_error %></div>
-      <% end %>
+    <div class="form-group">
+      <div class="radio col-sm-offset-2 col-sm-10">
+        <input class="btn btn-danger" type="submit" name="add" value="<%= t("antidote.add.submit") %>" data-confirm="<%= t("antidote.add.confirm") %>" />
+      </div>
     </div>
-  </div>
-  <div class="form-row text-right">
-    <button id="antidote-inhibitor-submit" type="submit" class="btn"><%= t("antidote.submit") %></button>
-  </div>
-</form>
+  </form>
+</div>

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>
@@ -23,7 +23,7 @@
             <td class="delete-confirm">
               <form action="<%=root_path %>antidote/<%= CGI.escape(inhibitor.id) %>/delete" method="post">
                 <%= csrf_tag %>
-                <input class="btn btn-danger" type="submit" name="delete" value="<%= t("Delete") %>" data-confirm="<%= t("AreYouSureDeleteQueue") %>" />
+                <input class="btn btn-danger" type="submit" name="delete" value="<%= t("Delete") %>" data-confirm="<%= t("antidote.delete.confirm", treatment: inhibitor.treatment, qualifier: inhibitor.class_qualifier) %>" />
               </form>
             </td>
           </tr>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-antidote
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Alexey Zapparov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-02 00:00:00.000000000 Z
+date: 2024-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.2'
 description:
 email:
 - alexey@zapparov.com
@@ -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.alpha.1
+  source_code_uri: https://github.com/ixti/sidekiq-antidote/tree/v1.1.0
   bug_tracker_uri: https://github.com/ixti/sidekiq-antidote/issues
-  changelog_uri: https://github.com/ixti/sidekiq-antidote/blob/v1.0.0.alpha.1/CHANGES.md
+  changelog_uri: https://github.com/ixti/sidekiq-antidote/blob/v1.1.0/CHANGES.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -81,11 +81,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Sidekiq poison-pill instant remedy