sidekiq-worker-killer 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2b88a4d00042d82a27ebd81fa27832f01873618
-  data.tar.gz: 010d2676048b457204d403509774c4e013cd39d4
+  metadata.gz: bfc7e3a75eba6f95fd48ee2c0fa604cddad8328f
+  data.tar.gz: 367eb4d8380b612dad3300829962cdcad40509fd
 SHA512:
-  metadata.gz: 9aef7ae408f33ed04a2cbe81ba673887d877762c803482da841a25c0878b2c91e96e6eb8b4eabfddcbcfb42b8bf7ce56e218463df867af44fadad7afb4a6a0c9
-  data.tar.gz: 4c9cfa47bdb45445f6647ca0297e3118f4f37cc675759a3e292a96e701577c385c6f7bcce832cd8c5082f59acce4449aefad7e92160e59f8049eefa5499d95c7
+  metadata.gz: e26eae8384c0a43e2f57b792f094abb12b419ef58a47cfda9d2e42285ebfacf4ade437148cd20e742c5a6aaea9c1dc392e5272749aff2c1ad607e860325724a1
+  data.tar.gz: c347ad5878953ff5383508f0871d1beb12c1442970b2c2f6b4ff8b86a869002f75b928221506c176b395cf69b2419376e002340d70ecdfe82fb33f25c90c2d17

data/README.md

@@ -36,10 +36,25 @@ The following options can be overrided.
 | Option | Defaults | Description |
 | ------- | ------- | ----------- |
 | max_rss | 0 MB (disabled) | max RSS in megabytes. Above this, shutdown will be triggered. |
-| grace_time | 900 seconds | when shutdown is triggered, the Sidekiq process will not accept new job and wait at most 15 minutes for running jobs to finish. If Float::INFINITY specified, will wait forever  |
+| grace_time | 900 seconds | when shutdown is triggered, the Sidekiq process will not accept new job and wait at most 15 minutes for running jobs to finish. If Float::INFINITY specified, will wait forever.  |
 | shutdown_wait | 30 seconds | when the grace time expires, still running jobs get 30 seconds to terminate. After that, kill signal is triggered.  |
 | kill_signal | SIGKILL | Signal to use kill Sidekiq process if it doesn't terminate.  |
-| gc | true | Try to run garbage collection before Sidekiq process terminate in case of max_rss exceeded  |
+| gc | true | Try to run garbage collection before Sidekiq process terminate in case of max_rss exceeded.  |
+| skip_shutdown_if | Proc.new {false} | Executes a block of code after max_rss exceeds but before requesting shutdown. |
+
+*skip_shutdown_if* is expected to return anything other than `false` or `nil` to skip shutdown.
+
+```ruby
+require 'sidekiq/worker_killer'
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::WorkerKiller, max_rss: 480, skip_shutdown_if: ->(worker, job, queue) do
+      worker.to_s == 'LongWorker'
+    end
+  end
+end
+```
 
 ## Development
 

data/lib/sidekiq/worker_killer.rb

@@ -15,16 +15,21 @@ class Sidekiq::WorkerKiller
     @shutdown_wait   = options.fetch(:shutdown_wait, 30)
     @kill_signal     = options.fetch(:kill_signal, "SIGKILL")
     @gc              = options.fetch(:gc, true)
+    @skip_shutdown   = options.fetch(:skip_shutdown_if, Proc.new { false })
   end
 
-  def call(_worker, _job, _queue)
+  def call(worker, job, queue)
     yield
     # Skip if the max RSS is not exceeded
     return unless @max_rss > 0
     return unless current_rss > @max_rss
     GC.start(full_mark: true, immediate_sweep: true) if @gc
     return unless current_rss > @max_rss
-    # Launch the shutdown process
+    if @skip_shutdown.respond_to?(:call) && @skip_shutdown.call(worker, job, queue)
+      warn "current RSS #{current_rss} exceeds maximum RSS #{@max_rss}, however shutdown will be ignored"
+      return
+    end
+
     warn "current RSS #{current_rss} of #{identity} exceeds " \
          "maximum RSS #{@max_rss}"
     request_shutdown
@@ -45,6 +50,8 @@ class Sidekiq::WorkerKiller
     warn "sending #{quiet_signal} to #{identity}"
     signal(quiet_signal, pid)
 
+    sleep(5) # gives Sidekiq API 5 seconds to update ProcessSet
+
     warn "shutting down #{identity} in #{@grace_time} seconds"
     wait_job_finish_in_grace_time
 

data/lib/sidekiq/worker_killer/version.rb

@@ -1,7 +1,7 @@
 # rubocop:disable Style/ClassAndModuleChildren
 module Sidekiq
   class WorkerKiller
-    VERSION = "0.4.0".freeze
+    VERSION = "0.5.0".freeze
   end
 end
 # rubocop:enable Style/ClassAndModuleChildren

data/spec/sidekiq/worker_killer_spec.rb

@@ -4,6 +4,7 @@ describe Sidekiq::WorkerKiller do
 
   before do
     allow(subject).to receive(:warn) # silence "warn" logs
+    allow(subject).to receive(:sleep) # reduces tests running time
   end
 
   describe "#call" do
@@ -29,6 +30,43 @@ describe Sidekiq::WorkerKiller do
         expect(GC).to receive(:start).with(full_mark: true, immediate_sweep: true)
         subject.call(worker, job, queue){}
       end
+
+      context "and skip_shutdown_if is given" do
+        subject{ described_class.new(max_rss: 2, skip_shutdown_if: skip_shutdown_proc) }
+
+        context "and skip_shutdown_if is a proc" do
+          let(:skip_shutdown_proc) { proc { |worker| true } }
+          it "should NOT request shutdown" do
+            expect(subject).not_to receive(:request_shutdown)
+            subject.call(worker, job, queue){}
+          end
+        end
+
+        context "and skip_shutdown_if is a lambda" do
+          let(:skip_shutdown_proc) { ->(worker, job, queue) { true } }
+          it "should NOT request shutdown" do
+            expect(subject).not_to receive(:request_shutdown)
+            subject.call(worker, job, queue){}
+          end
+        end
+
+        context "and skip_shutdown_if returns false" do
+          let(:skip_shutdown_proc) { proc { |worker, job, queue| false } }
+          it "should still request shutdown" do
+            expect(subject).to receive(:request_shutdown)
+            subject.call(worker, job, queue){}
+          end
+        end
+
+        context "and skip_shutdown_if returns nil" do
+          let(:skip_shutdown_proc) { proc { |worker, job, queue| nil } }
+          it "should still request shutdown" do
+            expect(subject).to receive(:request_shutdown)
+            subject.call(worker, job, queue){}
+          end
+        end
+      end
+
       context "when gc is false" do
         subject{ described_class.new(max_rss: 2, gc: false) }
         it "should not call garbage collect" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-worker-killer
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Cyrille Courtiere
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-26 00:00:00.000000000 Z
+date: 2019-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: get_process_mem