resqued 0.12.2 → 0.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 87a69574c5ec392def740d29a5274248e815e96f02304f59e27c0faa805153a4
-  data.tar.gz: 6809178bc9ad88a6c8da0be070521aa9273ecf4eac6b99e5219d0870af813efe
+  metadata.gz: a05ff83ea7efb498899c8e366977f9b59e854c5c999ae9b8edcdb66e36ec8551
+  data.tar.gz: af4beac8bbd7b030527dc23b60587672126227a022560962f4d31f62efef5d5d
 SHA512:
-  metadata.gz: 94c143e2563fe9b42f6e3e73361b0a0949219e690188b822aa91da8247bef42f3e223844a9f7348fe03cc340a1b6fd70c6ef802bca8413d07d6c1eb4eb398ad7
-  data.tar.gz: 01acb7c8e6a9036696e53a4c97e09b78c812ab8cb0211e686ba79391cbab1663d54979c91e2405f8bb42c980534abb2505e459a5fd7d81aa8cd581c53cf8db4b
+  metadata.gz: 55b640e571730cdaa8155c8296c21923eb54d9cb4fe93ec5245ee739e78201ff45736653544c070c0c6d012a0d83678d1158fe0243b1cf665d7292c29af10de6
+  data.tar.gz: b086650c78f7710ec143ac6e787a2cfd7809bae17c10fc9583259a37ae258ef65df3252052d6c5d35309e5c2ae15a90180fa856803bae40f356c277f6628d3fb

data/CHANGES.md

@@ -1,5 +1,9 @@
 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)

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/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/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.2".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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resqued
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.12.3
 platform: ruby
 authors:
 - Matt Burke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-19 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
@@ -133,6 +134,7 @@ files:
 - 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
@@ -143,6 +145,7 @@ files:
 - 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
@@ -192,9 +195,11 @@ test_files:
 - spec/fixtures/test_case_environment.rb
 - spec/fixtures/test_case_no_workers.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/exit_event_spec.rb
 - spec/resqued/sleepy_spec.rb
 - spec/resqued/test_case_spec.rb
 - spec/resqued/start_ctx_spec.rb