sidekiq-killswitch 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 16a6f2e7ff8e7ad601d13c63b6572a6609b39344
-  data.tar.gz: d7857259bdadd1b46545977bae4a313966990218
+SHA256:
+  metadata.gz: d2c1e5555f67df5c51420ca3946edcf8786c622f7ee6d7c2ef238a3c2e42f639
+  data.tar.gz: 5607f5785571de88fae01a9abca4637bbeb35a2418db9cda87a29f0c6f5a1bcf
 SHA512:
-  metadata.gz: f05064da2b923e14c65119dd6507060a462014dc8d6a52de31d1ef39794358912d6a91fe5d2028aa7974f50ee84ad5940a1ca3a6d7b4a303cc8de9bbe445c1c7
-  data.tar.gz: e6fe7320e902ff8e884e26d0e21861cfa27c9b3a3882cde4b58d28514663a4a437af5dc95e96f597a75c8adfc0e746717e85424b18cf2b6274d2c3ded4e7e5b4
+  metadata.gz: 21e69f7d202a0c5f186d4f317bcb05ec8031522bd24c05bc7720be745e12f11280a5fd1f0902cf431dce750a63c9167409b36c5d4e92b9957fe916031f3a9699
+  data.tar.gz: 4399541da941edfef9a83eb555e80c1c5e98ffcb76160eaf487a06bc5415af4bcb4b5c4d0dcd299ad68d292509538f2b387b80a230fac56389b0431f0e3f1b31

data/CHANGES.md

@@ -1,3 +1,12 @@
+### 1.1.1 / 2024-08-27
+* Support for `redis-client` client (used by Sidekiq 7)
+* Remove `Sidekiq::DeadSet#kill` extension.
+* `module Sidekiq::Killswitch; end` replaced with `module Sidekiq; module Killswitch; ...`.
+* We're now using `warn` instead of `info` to log worker blackholed/dead_queued messaged. 
+
+### 1.1.0 / 2024-07-01
+* Add in warning banner to Sidekiq UI so users are linked to docs and informed of the difference of sending jobs to blackhole vs. dead queue
+
 ### 1.0.0 / 2018-02-20
 * `1.0.0.pre2` released as `1.0.0`.
 

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing
+
+We welcome contributions. For small changes, open a pull request. If you'd like to discuss an improvement or fix before writing the code, please open a Github issue.
+
+## Reporting Issues
+
+Please report issues in Github issues.
+
+# Table of Contents
+
+- [Contributing](#contributing)
+    - [Reporting Issues](#reporting-issues)
+- [Table of Contents](#table-of-contents)
+    - [Technical Details](#technical-details)
+        - [Local Development](#local-development)
+
+
+## Technical Details
+### Local Development
+Clone the repo and open in your IDE of choice.
+
+### Releasing a new version
+Tag the branch with the appropriate version number (ex v1.2.0) with `git tag v1.2.0`.
+
+Push to the remote repo with `git push origin --tags`

data/Gemfile

@@ -2,3 +2,5 @@
 source 'http://rubygems.org'
 
 gemspec
+
+gem 'pry-byebug'

data/lib/sidekiq/killswitch/config.rb

@@ -1,36 +1,38 @@
 # frozen_string_literal: true
 
-module Sidekiq::Killswitch
-  class Config
-    attr_accessor :web_ui_worker_validator
-    attr_writer :logger
+module Sidekiq
+  module Killswitch
+    class Config
+      attr_accessor :web_ui_worker_validator
+      attr_writer :logger
 
-    def initialize
-      self.web_ui_worker_validator = ->(worker_name) { !worker_name.nil? && worker_name != '' }
-    end
+      def initialize
+        self.web_ui_worker_validator = ->(worker_name) { !worker_name.nil? && worker_name != '' }
+      end
 
-    def logger
-      @logger ||= Sidekiq.logger
-    end
+      def logger
+        @logger ||= Sidekiq.logger
+      end
 
-    def validate_worker_class_in_web
-      self.web_ui_worker_validator = proc do |worker_name|
-        begin
-          constantize(worker_name).include?(Sidekiq::Worker)
-        rescue NameError
-          false
+      def validate_worker_class_in_web
+        self.web_ui_worker_validator = proc do |worker_name|
+          begin
+            constantize(worker_name).include?(Sidekiq::Worker)
+          rescue NameError
+            false
+          end
         end
       end
-    end
 
-    private
+      private
 
-    def constantize(str)
-      names = str.split('::')
-      names.shift if names.empty? || names.first.empty?
+      def constantize(str)
+        names = str.split('::')
+        names.shift if names.empty? || names.first.empty?
 
-      names.inject(Object) do |constant, name|
-        constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+        names.inject(Object) do |constant, name|
+          constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+        end
       end
     end
   end

data/lib/sidekiq/killswitch/middleware/client.rb

@@ -8,7 +8,7 @@ module Sidekiq
           worker_name = Sidekiq::Killswitch.class_to_str(worker_class)
 
           if Killswitch.blackhole_worker?(worker_name)
-            Killswitch.logger.info "#{worker_name} is currently disabled. Job #{job} was not executed."
+            Killswitch.logger.warn "#{worker_name} is currently disabled. Job #{job} was not executed."
             false
           else
             yield

data/lib/sidekiq/killswitch/middleware/server.rb

@@ -4,14 +4,16 @@ module Sidekiq
   module Killswitch
     module Middleware
       class Server
+        include Sidekiq::ServerMiddleware
+
         def call(worker, job, _queue)
           serialized_job = Sidekiq.dump_json(job)
 
           if Killswitch.dead_queue_worker?(worker.class)
             DeadSet.new.kill(serialized_job)
-            Killswitch.logger.info "#{worker.class.name} marked as dead queue worker. Job #{serialized_job} was killed."
+            Killswitch.logger.warn "#{worker.class.name} marked as dead queue worker. Job #{serialized_job} was killed."
           elsif Killswitch.blackhole_worker?(worker.class)
-            Killswitch.logger.info "#{worker.class.name} is currently disabled. Job #{serialized_job} was not executed."
+            Killswitch.logger.warn "#{worker.class.name} is currently disabled. Job #{serialized_job} was not executed."
           else
             yield
           end

data/lib/sidekiq/killswitch/version.rb

@@ -2,6 +2,6 @@
 
 module Sidekiq
   module Killswitch
-    VERSION = '1.0.0'
+    VERSION = '1.1.1'
   end
 end

data/lib/sidekiq/killswitch.rb

@@ -1,92 +1,100 @@
 # frozen_string_literal: true
-require 'sidekiq/extensions/dead_set'
 require 'sidekiq/killswitch/config'
 require 'sidekiq/killswitch/middleware/server'
 require 'sidekiq/killswitch/middleware/client'
 
-module Sidekiq::Killswitch
-  BLACKHOLE_WORKERS_KEY_NAME = 'sidekiq.disabled-workers'
-  DEAD_QUEUE_WORKERS_KEY_NAME = 'sidekiq.dead-queue-workers'
+module Sidekiq
+  module Killswitch
+    BLACKHOLE_WORKERS_KEY_NAME = 'sidekiq.disabled-workers'
+    DEAD_QUEUE_WORKERS_KEY_NAME = 'sidekiq.dead-queue-workers'
 
-  class << self
-    def config
-      @config ||= Config.new
-    end
+    class << self
+      def config
+        @config ||= Config.new
+      end
 
-    def configure(&block)
-      yield config
-    end
+      def configure(&block)
+        yield config
+      end
 
-    def logger
-      config.logger
-    end
+      def logger
+        config.logger
+      end
 
-    def redis_pool(&block)
-      Sidekiq.redis(&block)
-    end
+      def redis_pool(&block)
+        Sidekiq.redis(&block)
+      end
 
-    def blackhole_add_worker(worker_name)
-      worker_name = class_to_str(worker_name)
+      def blackhole_add_worker(worker_name)
+        worker_name = class_to_str(worker_name)
 
-      redis_pool do |redis|
-        redis.hset(BLACKHOLE_WORKERS_KEY_NAME, worker_name, Time.now)
+        redis_pool do |redis|
+          redis.hset(BLACKHOLE_WORKERS_KEY_NAME, worker_name, Time.now.to_s)
+        end
+        logger.warn "#{worker_name} added to blackhole workers"
       end
-      logger.warn "#{worker_name} added to blackhole workers"
-    end
 
-    def blackhole_remove_worker(worker_name)
-      worker_name = class_to_str(worker_name)
+      def blackhole_remove_worker(worker_name)
+        worker_name = class_to_str(worker_name)
 
-      redis_pool do |redis|
-        redis.hdel(BLACKHOLE_WORKERS_KEY_NAME, worker_name)
+        redis_pool do |redis|
+          redis.hdel(BLACKHOLE_WORKERS_KEY_NAME, worker_name)
+        end
+        logger.warn "#{worker_name} removed from blackhole workers"
       end
-      logger.warn "#{worker_name} removed from blackhole workers"
-    end
 
-    def blackhole_worker?(worker_name)
-      redis_pool do |redis|
-        redis.hexists(BLACKHOLE_WORKERS_KEY_NAME, class_to_str(worker_name))
+      def blackhole_worker?(worker_name)
+        redis_pool do |redis|
+          is_true_compat(redis.hexists(BLACKHOLE_WORKERS_KEY_NAME, class_to_str(worker_name)))
+        end
       end
-    end
 
-    def blackhole_workers
-      redis_pool do |redis|
-        redis.hgetall(BLACKHOLE_WORKERS_KEY_NAME)
+      def blackhole_workers
+        redis_pool do |redis|
+          redis.hgetall(BLACKHOLE_WORKERS_KEY_NAME)
+        end
       end
-    end
 
-    def dead_queue_add_worker(worker_name)
-      worker_name = class_to_str(worker_name)
+      def dead_queue_add_worker(worker_name)
+        worker_name = class_to_str(worker_name)
 
-      redis_pool do |redis|
-        redis.hset(DEAD_QUEUE_WORKERS_KEY_NAME, worker_name, Time.now)
+        redis_pool do |redis|
+          redis.hset(DEAD_QUEUE_WORKERS_KEY_NAME, worker_name, Time.now.to_s)
+        end
+        logger.warn "#{worker_name} added to dead queue workers"
       end
-      logger.warn "#{worker_name} added to dead queue workers"
-    end
 
-    def dead_queue_remove_worker(worker_name)
-      worker_name = class_to_str(worker_name)
+      def dead_queue_remove_worker(worker_name)
+        worker_name = class_to_str(worker_name)
 
-      redis_pool do |redis|
-        redis.hdel(DEAD_QUEUE_WORKERS_KEY_NAME, worker_name)
+        redis_pool do |redis|
+          redis.hdel(DEAD_QUEUE_WORKERS_KEY_NAME, worker_name)
+        end
+        logger.warn "#{worker_name} removed from dead queue workers"
       end
-      logger.warn "#{worker_name} removed from dead queue workers"
-    end
 
-    def dead_queue_worker?(worker_name)
-      redis_pool do |redis|
-        redis.hexists(DEAD_QUEUE_WORKERS_KEY_NAME, class_to_str(worker_name))
+      def dead_queue_worker?(worker_name)
+        redis_pool do |redis|
+          is_true_compat(redis.hexists(DEAD_QUEUE_WORKERS_KEY_NAME, class_to_str(worker_name)))
+        end
       end
-    end
 
-    def dead_queue_workers
-      redis_pool do |redis|
-        redis.hgetall(DEAD_QUEUE_WORKERS_KEY_NAME)
+      def dead_queue_workers
+        redis_pool do |redis|
+          redis.hgetall(DEAD_QUEUE_WORKERS_KEY_NAME)
+        end
+      end
+
+      def class_to_str(class_or_string)
+        class_or_string.is_a?(String) ? class_or_string : class_or_string.name
       end
-    end
 
-    def class_to_str(class_or_string)
-      class_or_string.is_a?(String) ? class_or_string : class_or_string.name
+      private
+
+      def is_true_compat(redis_result_value)
+        # Compatibility method for `redis` and `redis-client`.
+        redis_result_value == 1 || redis_result_value == true
+      end
     end
   end
 end

data/spec/killswitch_spec.rb

@@ -65,7 +65,7 @@ RSpec.describe Sidekiq::Killswitch do
       Sidekiq::Killswitch.blackhole_remove_worker(worker_name)
 
       Sidekiq::Killswitch.redis_pool do |redis|
-        expect(redis.hexists(Sidekiq::Killswitch::BLACKHOLE_WORKERS_KEY_NAME, worker_name)).to be_falsey
+        expect(redis.hexists(Sidekiq::Killswitch::BLACKHOLE_WORKERS_KEY_NAME, worker_name)).to eq(0)
       end
     end
   end
@@ -113,7 +113,7 @@ RSpec.describe Sidekiq::Killswitch do
       Sidekiq::Killswitch.dead_queue_remove_worker(worker_name)
 
       Sidekiq::Killswitch.redis_pool do |redis|
-        expect(redis.hexists(Sidekiq::Killswitch::DEAD_QUEUE_WORKERS_KEY_NAME, worker_name)).to be_falsey
+        expect(redis.hexists(Sidekiq::Killswitch::DEAD_QUEUE_WORKERS_KEY_NAME, worker_name)).to eq(0)
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 require 'rspec'
 require 'logger'
+require 'rack/test'
 require 'sidekiq/testing'
 require 'sidekiq/killswitch'
 
 ENV['RACK_ENV'] = 'test' # Disable CSRF protection for Sidekiq Web app
+$TESTING = true
 
 Sidekiq::Killswitch.configure do |config|
   config.logger = Logger.new('/dev/null')

data/spec/web_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require 'spec_helper'
-require 'rack/test'
 require 'rspec-html-matchers'
 require 'sidekiq/killswitch/web'
 
@@ -10,6 +9,12 @@ RSpec.describe Sidekiq::Killswitch::Web do
 
   let(:app) { Sidekiq::Web }
 
+  before do
+    # Hash is not a real session, but it seems to provide a session-compatible interface,
+    # and we're only using #[] and #delete methods.
+    env "rack.session", {}
+  end
+
   def expect_redirect_to_root_page(response)
     expect(response.status).to be(302)
     expect(response.headers['Location']).to eq("http://#{rack_mock_session.default_host}/kill-switches")

data/web/views/kill_switches.html.erb

@@ -4,6 +4,16 @@
 
 <h3><%= t('blackholed_workers')%></h3>
 
+<div class="alert alert-danger" role="alert">
+  <p>Blackholing workers drops instances of these workers when these instances are pushed to the Sidekiq queue or processed (<a
+    href="https://github.com/square/sidekiq-killswitch?tab=readme-ov-file#how-does-it-work" class="alert-link">docs</a>).</p>
+
+  <p>Only blackhole workers that you don't want to retry later! (e.g. cron jobs or jobs you don't care about) You should be able to reach a state
+    of correctness without retrying these workers.</p>
+
+  <p>Use <%= t('dead_queue_workers') %> if you want to retry these jobs later from the dead queue.</p>
+</div>
+
 <form action="<%= root_path %>kill-switches/blackhole_add" method="post" style="margin-bottom: 4px;">
   <%= csrf_tag %>
   <input name="worker_name" />

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-killswitch
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Yuriy Naidyon
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-02-20 00:00:00.000000000 Z
+date: 2024-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.49.1
-description: 
+description:
 email: yurokle@gmail.com
 executables: []
 extensions: []
@@ -89,13 +89,13 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - CHANGES.md
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - examples/killswitch-web-ui.png
 - examples/square-logo.png
-- lib/sidekiq/extensions/dead_set.rb
 - lib/sidekiq/killswitch.rb
 - lib/sidekiq/killswitch/config.rb
 - lib/sidekiq/killswitch/middleware/client.rb
@@ -105,7 +105,6 @@ files:
 - lib/sidekiq/killswitch/web.rb
 - sidekiq-killswitch.gemspec
 - spec/config_spec.rb
-- spec/dead_set_spec.rb
 - spec/killswitch_spec.rb
 - spec/middleware/client_spec.rb
 - spec/middleware/server_spec.rb
@@ -118,7 +117,7 @@ licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -133,14 +132,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Cross-host Sidekiq worker killswitches
 test_files:
 - spec/config_spec.rb
-- spec/dead_set_spec.rb
 - spec/killswitch_spec.rb
 - spec/middleware/client_spec.rb
 - spec/middleware/server_spec.rb

data/lib/sidekiq/extensions/dead_set.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-require 'sidekiq/api'
-
-# this is a monkey-patch!
-# TODO: delete this patch after we explicitly depend on Sidekiq version that
-# includes this PR: https://github.com/mperham/sidekiq/pull/3573
-
-module Sidekiq
-  module DeadSetKill
-    def kill(message)
-      now = Time.now.to_f
-      Sidekiq.redis do |conn|
-        conn.multi do
-          conn.zadd(name, now.to_f.to_s, message)
-          conn.zremrangebyscore(name, '-inf', now - self.class.timeout)
-          conn.zremrangebyrank(name, 0, - self.class.max_jobs)
-        end
-      end
-    end
-  end
-end
-
-Sidekiq::DeadSet.include(Sidekiq::DeadSetKill) unless Sidekiq::DeadSet.method_defined?(:kill)

data/spec/dead_set_spec.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-require 'spec_helper'
-
-RSpec.describe Sidekiq::DeadSet do
-  let(:dead_set) { Sidekiq::DeadSet.new }
-
-  describe '#kill' do
-    it 'should put passed serialized job to the "dead" sorted set' do
-      serialized_job = Sidekiq.dump_json(jid: '123123', class: 'SomeWorker', args: [])
-      dead_set.kill(serialized_job)
-
-      expect(dead_set.find_job('123123').value).to eq(serialized_job)
-    end
-
-    it 'should remove dead jobs older than Sidekiq::DeadSet.timeout' do
-      allow(Sidekiq::DeadSet).to receive(:timeout).and_return(10)
-      time_now = Time.now
-
-      stub_time_now(time_now - 11)
-      dead_set.kill(Sidekiq.dump_json({jid: '000103', class: 'MyWorker3', args: []})) # the oldest
-
-      stub_time_now(time_now - 9)
-      dead_set.kill(Sidekiq.dump_json({jid: '000102', class: 'MyWorker2', args: []}))
-
-      stub_time_now(time_now)
-      dead_set.kill(Sidekiq.dump_json({jid: '000101', class: 'MyWorker1', args: []}))
-
-      stub_time_now(time_now)
-
-      expect(dead_set.find_job('000103')).to be_falsey
-      expect(dead_set.find_job('000102')).to be_truthy
-      expect(dead_set.find_job('000101')).to be_truthy
-    end
-
-    it 'should remove all but last Sidekiq::DeadSet.max_jobs-1 jobs' do
-      allow(Sidekiq::DeadSet).to receive(:max_jobs).and_return(3)
-
-      dead_set.kill(Sidekiq.dump_json({jid: '000101', class: 'MyWorker1', args: []}))
-      dead_set.kill(Sidekiq.dump_json({jid: '000102', class: 'MyWorker2', args: []}))
-      dead_set.kill(Sidekiq.dump_json({jid: '000103', class: 'MyWorker3', args: []}))
-
-      expect(dead_set.find_job('000101')).to be_falsey
-      expect(dead_set.find_job('000102')).to be_truthy
-      expect(dead_set.find_job('000103')).to be_truthy
-    end
-  end
-end