resqued 0.12.1 → 0.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13f45787a92226688e4b30d34f1f6a5390277c34423b94786511d6bf6a4b5d71
-  data.tar.gz: 0d6af78fd2ced8e9fff8703456052333ddb20e75c32d7c1ffab0466dbab6b9cb
+  metadata.gz: a05ff83ea7efb498899c8e366977f9b59e854c5c999ae9b8edcdb66e36ec8551
+  data.tar.gz: af4beac8bbd7b030527dc23b60587672126227a022560962f4d31f62efef5d5d
 SHA512:
-  metadata.gz: 782cb7f9c4d7ceeb3e7de4d8612eb2df0363105f447fe110404dc779e73cffa9a433e3d08f6021cd6fd6f7f17b34c305c4ac623c28536b140c72ca8a451f3030
-  data.tar.gz: 766db53a09ffab45db9288b9ed165bdb0c679ff394edcb2f40dd1e626c12e1735cb32a4dc39e2fbbb248d8d596826ff1bb01ff568bd944ad9ff0483c836947d4
+  metadata.gz: 55b640e571730cdaa8155c8296c21923eb54d9cb4fe93ec5245ee739e78201ff45736653544c070c0c6d012a0d83678d1158fe0243b1cf665d7292c29af10de6
+  data.tar.gz: b086650c78f7710ec143ac6e787a2cfd7809bae17c10fc9583259a37ae258ef65df3252052d6c5d35309e5c2ae15a90180fa856803bae40f356c277f6628d3fb

data/CHANGES.md

@@ -1,5 +1,13 @@
 Starting with version 0.6.1, resqued uses semantic versioning to indicate incompatibilities between the master process, listener process, and configuration.
 
+v0.12.3
+-------
+* Add `after_exit` that provides a `WorkerSummary` about each exited worker.
+
+v0.12.2
+-------
+* Added lifecycle hook for container runtimes. (#67)
+
 v0.12.1
 -------
 * Fixed Resqued::TestCase. v0.12.0 introduced a regression that stopped

data/README.md

@@ -152,6 +152,11 @@ You can configure the Resque worker in the `after_fork` block
       worker.term_timeout = 1.minute
     end
 
+    after_exit do |worker_summary|
+        puts "Worker was alive for #{worker_summary.alive_time_sec}"
+        puts "Process::Status of exited worker: #{worker_summary.process_status.inspect}"
+    end
+
 In this example, a Rails application is being set up with 7 workers:
 * high
 * low (interval = 30)

data/exe/resqued

@@ -1,9 +1,14 @@
 #!/usr/bin/env ruby
 
-if ARGV[0] == "listener"
+case ARGV[0]
+when "listener"
   require "resqued/listener"
   Resqued::Listener.exec!
   exit 0
+when "quit-and-wait"
+  require "resqued/quit-and-wait"
+  Resqued::QuitAndWait.exec!(ARGV.drop(1))
+  exit 0
 end
 
 require "optparse"

data/lib/resqued/config/after_exit.rb

@@ -0,0 +1,22 @@
+require "resqued/config/base"
+
+module Resqued
+  module Config
+    # A config handler that executes the `after_exit` block.
+    #
+    #     after_exit do |worker_summary|
+    #       # Runs in each listener.
+    #     end
+    class AfterExit < Base
+      # Public.
+      def initialize(options = {})
+        @worker_summary = options.fetch(:worker_summary)
+      end
+
+      # DSL: execute the `after_exit` block.
+      def after_exit
+        yield @worker_summary
+      end
+    end
+  end
+end

data/lib/resqued/config/dsl.rb

@@ -12,6 +12,10 @@ module Resqued
       def after_fork(&block)
       end
 
+      # Public: Define a block to be run once after each worker exits.
+      def after_exit(&block)
+      end
+
       # Public: Define a worker that will work on a queue.
       def worker(*queues)
       end

data/lib/resqued/config.rb

@@ -1,5 +1,6 @@
 require "resqued/config/after_fork"
 require "resqued/config/before_fork"
+require "resqued/config/after_exit"
 require "resqued/config/worker"
 
 module Resqued
@@ -27,6 +28,11 @@ module Resqued
         Resqued::Config::AfterFork.new(worker: worker).apply_all(@config_data)
       end
 
+      # Public: Perform the `after_exit` action from the config.
+      def after_exit(worker_summary)
+        Resqued::Config::AfterExit.new(worker_summary: worker_summary).apply_all(@config_data)
+      end
+
       # Public: Builds the workers specified in the config.
       def build_workers
         Resqued::Config::Worker.new(config: self).apply_all(@config_data)

data/lib/resqued/quit-and-wait.rb

@@ -0,0 +1,84 @@
+require "optparse"
+
+module Resqued
+  class QuitAndWait
+    def self.exec!(argv)
+      options = { grace_seconds: 30 }
+
+      opts = OptionParser.new do |opts| # rubocop: disable Lint/ShadowingOuterLocalVariable
+        opts.banner = <<~USAGE
+          Usage: resqued quit-and-wait PIDFILE [--grace-period SECONDS]
+
+          Use this as a preStop script in kubernetes. This script will send a SIGQUIT to
+          resqued immediately, and then sleep until either resqued exits or until the
+          grace period is nearing expiration. This script exits 0 if resqued exited and
+          99 otherwise.
+        USAGE
+
+        opts.on "-h", "--help", "Show this message" do
+          puts opts
+          exit
+        end
+
+        opts.on "-v", "--version", "Show the version" do
+          require "resqued/version"
+          puts Resqued::VERSION
+          exit
+        end
+
+        opts.on "--grace-period SECONDS", Numeric, "Grace period provided to container runtime (default 30)" do |v|
+          options[:grace_seconds] = v
+        end
+
+        opts.on "--quiet" do
+          options[:quiet] = true
+        end
+      end
+
+      argv = opts.parse(argv)
+      if argv.size != 1
+        puts opts
+        exit 1
+      end
+      options[:pidfile] = argv.shift
+
+      new(**options).exec!
+    end
+
+    def initialize(grace_seconds:, pidfile:, quiet: false)
+      @grace_seconds = grace_seconds
+      @pidfile = pidfile
+      @quiet = quiet
+    end
+
+    attr_reader :grace_seconds, :pidfile, :quiet
+
+    def exec!
+      start = Time.now
+      stop_at = start + grace_seconds - 5
+      pid = File.read(pidfile).to_i
+
+      log "kill -QUIT #{pid} (resqued-master)"
+      Process.kill(:QUIT, pid)
+
+      while Time.now < stop_at
+        begin
+          # check if pid is still alive.
+          Process.kill(0, pid)
+        rescue Errno::ESRCH # no such process, it exited!
+          log "ok: resqued-master with pid #{pid} exited"
+          exit 0
+        end
+      end
+
+      log "giving up, resqued-master with pid #{pid} is still running."
+      exit 99
+    end
+
+    def log(message)
+      return if quiet
+
+      puts "#{Time.now.strftime('%H:%M:%S.%L')} #{message}"
+    end
+  end
+end

data/lib/resqued/test_case.rb

@@ -18,6 +18,7 @@ module Resqued
         config.before_fork(RuntimeInfo.new)
         config.build_workers
         config.after_fork(FakeWorker.new)
+        config.after_exit(Resqued::WorkerSummary.new(alive_time_sec: 1.0, process_status: Process::Status.allocate))
       end
     end
 

data/lib/resqued/version.rb

@@ -1,3 +1,3 @@
 module Resqued
-  VERSION = "0.12.1".freeze
+  VERSION = "0.12.3".freeze
 end

data/lib/resqued/worker.rb

@@ -64,6 +64,9 @@ module Resqued
         @pid = nil
         @backoff.died unless @killed
       elsif !process_status.nil? && @self_started
+        alive_time_sec = Process.clock_gettime(Process::CLOCK_MONOTONIC) - @start_time
+        @config.after_exit(WorkerSummary.new(alive_time_sec: alive_time_sec, process_status: process_status))
+
         log :debug, "#{summary} I exited: #{process_status}"
         @pid = nil
         @backoff.died unless @killed
@@ -84,6 +87,8 @@ module Resqued
       @backoff.started
       @self_started = true
       @killed = false
+      @start_time = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+
       if @pid = fork
         @pids << @pid
         # still in the listener
@@ -112,4 +117,14 @@ module Resqued
       log "Can't kill #{pid}: #{e}"
     end
   end
+
+  # Metadata for an exited listener worker.
+  class WorkerSummary
+    attr_reader :alive_time_sec, :process_status
+
+    def initialize(alive_time_sec:, process_status:)
+      @alive_time_sec = alive_time_sec
+      @process_status = process_status
+    end
+  end
 end

data/spec/fixtures/test_case_after_exit_raises.rb

@@ -0,0 +1,5 @@
+after_exit do
+  raise "boom"
+end
+
+worker "test"

data/spec/integration/quit_and_wait_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper"
+require "timeout"
+
+describe "quit-and-wait gracefully stops resqued" do
+  include ResquedIntegrationHelpers
+
+  it do
+    pidfile = File.join(SPEC_TEMPDIR, "graceful.pid")
+
+    start_resqued(pidfile: pidfile)
+    expect_running listener: "listener #1"
+
+    # Make sure the process gets cleaned up.
+    Thread.new do
+      begin
+        loop do
+          Process.wait(@pid)
+        end
+      rescue Errno::ECHILD
+        # ok!
+      end
+    end
+
+    Timeout.timeout(15) do
+      expect(system(resqued_path, "quit-and-wait", pidfile, "--grace-period", "10")).to be true
+    end
+
+    expect_not_running
+  end
+
+  after do
+    begin
+      Process.kill(:QUIT, @pid) if @pid
+    rescue Errno::ESRCH
+    end
+  end
+end

data/spec/resqued/config/exit_event_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+require "resqued/worker"
+require "resqued/config/after_exit"
+
+describe do
+  before { evaluator.apply(config) }
+
+  context "after_exit" do
+    # Run the after_exit block.
+    #
+    #    after_exit do |worker_summary|
+    #      puts "#{worker_summary.alive_time_sec}"
+    #    end
+    #
+    # ignore calls to any other top-level method.
+
+    let(:config) { <<-END_CONFIG }
+      worker('one')
+      worker_pool(1)
+      queue('*')
+
+      after_exit do |worker_summary|
+        $after_exit_called = true
+        $worker_alive_time_sec = worker_summary.alive_time_sec
+        $exit_status = worker_summary.process_status.exitstatus
+      end
+    END_CONFIG
+
+    let(:evaluator) {
+      # In ruby versions < 3, Process::Status evaluates $? regardless of what status is returned by
+      # exitcode for a status created with Process::Status.allocate
+      fork do
+        exit!
+      end
+      _, status = Process.waitpid2
+      Resqued::Config::AfterExit.new(worker_summary: Resqued::WorkerSummary.new(alive_time_sec: 1, process_status: status))
+    }
+
+    it { expect($after_exit_called).to eq(true) }
+    it { expect($worker_alive_time_sec > 0).to eq(true) }
+    it { expect($exit_status).to eq(0) }
+  end
+end
+
+class FakeResqueWorker
+  attr_accessor :token
+end

data/spec/resqued/test_case_spec.rb

@@ -9,6 +9,7 @@ describe Resqued::TestCase do
     it { expect { test_case.assert_resqued "spec/fixtures/test_case_environment.rb", "spec/fixtures/test_case_clean.rb"              }.not_to raise_error }
     it { expect { test_case.assert_resqued "spec/fixtures/test_case_environment.rb", "spec/fixtures/test_case_before_fork_raises.rb" }.to     raise_error(RuntimeError) }
     it { expect { test_case.assert_resqued "spec/fixtures/test_case_environment.rb", "spec/fixtures/test_case_after_fork_raises.rb"  }.to     raise_error(RuntimeError) }
+    it { expect { test_case.assert_resqued "spec/fixtures/test_case_environment.rb", "spec/fixtures/test_case_after_exit_raises.rb"  }.to     raise_error(RuntimeError) }
     it { expect { test_case.assert_resqued "spec/fixtures/test_case_environment.rb", "spec/fixtures/test_case_no_workers.rb"         }.not_to raise_error }
   end
 end

data/spec/support/resqued_integration_helpers.rb

@@ -1,20 +1,25 @@
 module ResquedIntegrationHelpers
   include ResquedPath
 
-  def start_resqued(config: "", debug: false)
-    # Don't configure any workers. That way, we don't need to have redis running.
+  def start_resqued(config: "", debug: false, pidfile: nil)
+    # Don't configure any workers by default. That way, we don't need to have
+    # redis running.
     config_path = File.join(SPEC_TEMPDIR, "config.rb")
     File.write(config_path, config)
 
-    @pid =
-      if debug
-        spawn resqued_path, config_path
-      else
-        logfile = File.join(SPEC_TEMPDIR, "resqued.log")
-        File.write(logfile, "") # truncate it
+    cmd = [resqued_path]
+    if pidfile
+      cmd += ["--pidfile", pidfile]
+    end
+    unless debug
+      logfile = File.join(SPEC_TEMPDIR, "resqued.log")
+      File.write(logfile, "") # truncate it
+      cmd += ["--logfile", logfile]
+    end
+    cmd += [config_path]
+
+    @pid = spawn(*cmd)
 
-        spawn resqued_path, "--logfile", logfile, config_path
-      end
     sleep 1.0
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resqued
 version: !ruby/object:Gem::Version
-  version: 0.12.1
+  version: 0.12.3
 platform: ruby
 authors:
 - Matt Burke
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-23 00:00:00.000000000 Z
+date: 2022-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kgio
@@ -111,6 +111,7 @@ files:
 - lib/resqued.rb
 - lib/resqued/backoff.rb
 - lib/resqued/config.rb
+- lib/resqued/config/after_exit.rb
 - lib/resqued/config/after_fork.rb
 - lib/resqued/config/base.rb
 - lib/resqued/config/before_fork.rb
@@ -127,11 +128,13 @@ files:
 - lib/resqued/master_state.rb
 - lib/resqued/pidfile.rb
 - lib/resqued/procline_version.rb
+- lib/resqued/quit-and-wait.rb
 - lib/resqued/runtime_info.rb
 - lib/resqued/sleepy.rb
 - lib/resqued/test_case.rb
 - lib/resqued/version.rb
 - lib/resqued/worker.rb
+- spec/fixtures/test_case_after_exit_raises.rb
 - spec/fixtures/test_case_after_fork_raises.rb
 - spec/fixtures/test_case_before_fork_raises.rb
 - spec/fixtures/test_case_clean.rb
@@ -139,8 +142,10 @@ files:
 - spec/fixtures/test_case_no_workers.rb
 - spec/integration/listener_still_starting_spec.rb
 - spec/integration/master_inherits_child_spec.rb
+- spec/integration/quit_and_wait_spec.rb
 - spec/integration/restart_spec.rb
 - spec/resqued/backoff_spec.rb
+- spec/resqued/config/exit_event_spec.rb
 - spec/resqued/config/fork_event_spec.rb
 - spec/resqued/config/worker_spec.rb
 - spec/resqued/config_spec.rb
@@ -156,7 +161,7 @@ homepage: https://github.com/spraints/resqued
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -171,28 +176,31 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: Daemon of resque workers
 test_files:
-- spec/fixtures/test_case_after_fork_raises.rb
-- spec/fixtures/test_case_before_fork_raises.rb
+- spec/spec_helper.rb
+- spec/integration/restart_spec.rb
+- spec/integration/quit_and_wait_spec.rb
+- spec/integration/listener_still_starting_spec.rb
+- spec/integration/master_inherits_child_spec.rb
+- spec/support/resqued_integration_helpers.rb
+- spec/support/custom_matchers.rb
+- spec/support/resqued_path.rb
+- spec/support/extra-child-shim
 - spec/fixtures/test_case_clean.rb
+- spec/fixtures/test_case_before_fork_raises.rb
 - spec/fixtures/test_case_environment.rb
 - spec/fixtures/test_case_no_workers.rb
-- spec/integration/listener_still_starting_spec.rb
-- spec/integration/master_inherits_child_spec.rb
-- spec/integration/restart_spec.rb
-- spec/resqued/backoff_spec.rb
+- spec/fixtures/test_case_after_fork_raises.rb
+- spec/fixtures/test_case_after_exit_raises.rb
+- spec/resqued/config_spec.rb
 - spec/resqued/config/fork_event_spec.rb
 - spec/resqued/config/worker_spec.rb
-- spec/resqued/config_spec.rb
+- spec/resqued/config/exit_event_spec.rb
 - spec/resqued/sleepy_spec.rb
-- spec/resqued/start_ctx_spec.rb
 - spec/resqued/test_case_spec.rb
-- spec/spec_helper.rb
-- spec/support/custom_matchers.rb
-- spec/support/extra-child-shim
-- spec/support/resqued_integration_helpers.rb
-- spec/support/resqued_path.rb
+- spec/resqued/start_ctx_spec.rb
+- spec/resqued/backoff_spec.rb