resqued 0.10.2 → 0.11.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc14cf354d4cd292119aa6e6f06f0c59dd09faf982fe10707e69c5bbb3ef56e4
-  data.tar.gz: 7bad129217778e76f14c1dc6a732025d5cc0bba17baaee9d81ee5a1648768edc
+  metadata.gz: aa7e64a4c6a3e61fd60ad02aad37062a408ad34515e0218fa4526c7c23bbb296
+  data.tar.gz: 540332007ba6fd7581c795f8114db0638e80390ef18c64d6336eb65ed0afbf92
 SHA512:
-  metadata.gz: e8b5e943ec7612022b8a937c6a380b1d396be6cd2c5ebad13239961232c992dcce54d42e807c1d52f036f102defe4492f4fd498f0299c33e40e5095dc26ab48f
-  data.tar.gz: a26e43be4a408d59d8db061c00b112e45a6fec8b6ba318e145cbac1e53b4087b12f9b2ba3510fa118714aeb8b0117673c90b6f7fb987ca028a8962c85f594e5f
+  metadata.gz: 402d4c507e5809832e8e05ff3f0e3e243fdb8c3a9378d84e6589147b649b80426b5a934644e10cebc9d467948073e0db8f3771f803ac4befb80d4176233050dc
+  data.tar.gz: 9a51246b791079456dd26faafa988aa9e2994c76bcd7a554b6a4f1c45539d2921604e17ee7be389b089cfd77cbeab60094f1da03c5ef85a19e9fa9de6acd32f9

data/CHANGES.md

@@ -1,5 +1,22 @@
 Starting with version 0.6.1, resqued uses semantic versioning to indicate incompatibilities between the master process, listener process, and configuration.
 
+v0.11.2
+-------
+* Add compatibility with Ruby 3.1. (#63)
+* Switch to GitHub Actions for CI. (#64)
+
+v0.11.1
+-------
+* Fix a crash during shutdown. (#62)
+
+v0.11.0
+-------
+* Ignore SIGHUP in Listener and Worker processes. (#61)
+
+v0.10.3
+-------
+* Fix a timing related crash during reload. (#60)
+
 v0.10.2
 -------
 * Shut down cleanly even if there are other stray child processes of the master. (#59)

data/docs/signals.md

@@ -34,6 +34,8 @@ The Listener process forwards `SIGCONT` to all of its workers.
 
 The Listener process handles `SIGINT`, `SIGTERM`, and `SIGQUIT`. When it receives one of these signals, it goes into shutdown mode. It sends the received signal to all of its workers. When all workers have exited, the Listener process exits.
 
+The Listener process handles `SIGHUP` and does nothing. This makes it easier to reload resqued in a docker container, since many container platforms will send a requested signal to all processes in the container.
+
 ## Worker
 
 The Worker process uses resque's signal handling. Resque 1.23.0 handles the following signals:
@@ -44,3 +46,5 @@ The Worker process uses resque's signal handling. Resque 1.23.0 handles the foll
 * `USR1`: Kill the forked child immediately, continue processing jobs.
 * `USR2`: Don't process any new jobs
 * `CONT`: Start processing jobs again after a USR2
+
+Resqued leaves a handler for `HUP` in place that does nothing. This makes it easier to reload resqued in a docker container, since many container platforms will send a requested signal to all processes in the container.

data/lib/resqued/exec_on_hup.rb

@@ -34,7 +34,7 @@ module Resqued
 
     # Internal: Restore the master's state, and remove the state file.
     def self.restore_state(state, path)
-      data = YAML.safe_load(File.read(path), [Symbol], [], true)
+      data = YAML.safe_load(File.read(path), permitted_classes: [Symbol], aliases: true)
       Resqued::START_CTX.replace(data[:start_ctx] || {})
       state.restore(data[:state])
       File.unlink(path) rescue nil

data/lib/resqued/listener.rb

@@ -63,12 +63,13 @@ module Resqued
     end
 
     SIGNALS = [:CONT, :QUIT, :INT, :TERM].freeze
-    ALL_SIGNALS = SIGNALS + [:CHLD]
+    ALL_SIGNALS = SIGNALS + [:CHLD, :HUP]
 
     SIGNAL_QUEUE = [] # rubocop: disable Style/MutableConstant
 
     # Public: Run the main loop.
     def run
+      trap(:HUP) {} # ignore this, in case it trickles in from the master.
       trap(:CHLD) { awake }
       SIGNALS.each { |signal| trap(signal) { SIGNAL_QUEUE << signal; awake } }
       @socket.close_on_exec = true
@@ -85,7 +86,7 @@ module Resqued
 
       write_procline("shutdown")
       burn_down_workers(exit_signal || :QUIT)
-      @socket.close
+      @socket&.close
       @socket = nil
     end
 

data/lib/resqued/master.rb

@@ -200,7 +200,7 @@ module Resqued
           end
 
           if @listeners.last_good_pid == lpid
-            @state.clear_last_good!
+            @listeners.clear_last_good!
           end
 
           if dead_listener = @listeners.delete(lpid)

data/lib/resqued/version.rb

@@ -1,3 +1,3 @@
 module Resqued
-  VERSION = '0.10.2'
+  VERSION = "0.11.2".freeze
 end

data/lib/resqued/worker.rb

@@ -91,7 +91,11 @@ module Resqued
       else
         # In case we get a signal before resque is ready for it.
         Resqued::Listener::ALL_SIGNALS.each { |signal| trap(signal, "DEFAULT") }
-        trap(:QUIT) { exit! 0 } # If we get a QUIT during boot, just spin back down.
+        # Continue ignoring SIGHUP, though.
+        trap(:HUP) {}
+        # If we get a QUIT during boot, just spin back down.
+        trap(:QUIT) { exit! 0 }
+
         $0 = "STARTING RESQUE FOR #{queues.join(',')}"
         resque_worker = @worker_factory.call(queues)
         @config.after_fork(resque_worker)

data/spec/integration/listener_still_starting_spec.rb

@@ -0,0 +1,24 @@
+require "spec_helper"
+
+describe "Listener still starting on SIGHUP" do
+  include ResquedIntegrationHelpers
+
+  it "expect master not to crash" do
+    start_resqued config: <<-CONFIG
+      before_fork do
+        sleep 1
+      end
+    CONFIG
+    expect_running listener: "listener #1"
+    restart_resqued
+    sleep 2
+    expect_running listener: "listener #2"
+  end
+
+  after do
+    begin
+      Process.kill(:QUIT, @pid) if @pid
+    rescue Errno::ESRCH
+    end
+  end
+end

data/spec/integration/master_inherits_child_spec.rb

@@ -22,7 +22,7 @@ describe "Resqued master with an extra child process" do
     }
 
     pid = spawn(env, shim_path, resqued_path, "--logfile", logfile, config_path)
-    sleep 1.0
+    sleep 2.0
     pid
   end
 

data/spec/integration/restart_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe "Resqued can restart" do
-  include ResquedPath
+  include ResquedIntegrationHelpers
 
   it "expect to be able to restart" do
     start_resqued
@@ -18,46 +18,4 @@ describe "Resqued can restart" do
     rescue Errno::ESRCH
     end
   end
-
-  def expect_running(listener:)
-    processes = list_processes
-    expect(processes).to include(is_resqued_master)
-    listeners = processes.select { |p| p[:ppid] == @pid }.map { |p| p[:args] }
-    expect(listeners).to all(match(/#{listener}/)).and(satisfy { |l| l.size == 1 })
-  end
-
-  def expect_not_running
-    processes = list_processes
-    expect(processes).not_to include(is_resqued_master)
-  end
-
-  def start_resqued
-    # Don't configure any workers. That way, we don't need to have redis running.
-    config_path = File.join(SPEC_TEMPDIR, "config.rb")
-    File.write(config_path, "")
-
-    logfile = File.join(SPEC_TEMPDIR, "resqued.log")
-    File.write(logfile, "") # truncate it
-
-    @pid = spawn resqued_path, "--logfile", logfile, config_path
-    sleep 1.0
-  end
-
-  def restart_resqued
-    Process.kill(:HUP, @pid)
-    sleep 1.0
-  end
-
-  def stop_resqued
-    Process.kill(:TERM, @pid)
-    sleep 1.0
-  end
-
-  def list_processes
-    `ps axo pid,ppid,args`.lines.map { |line| pid, ppid, args = line.strip.split(/\s+/, 3); { pid: pid.to_i, ppid: ppid.to_i, args: args } }
-  end
-
-  def is_resqued_master
-    satisfy { |p| p[:pid] == @pid && p[:args] =~ /resqued-/ }
-  end
 end

data/spec/resqued/config/worker_spec.rb

@@ -125,17 +125,17 @@ describe Resqued::Config::Worker do
 
   context "pool, with shuffled queues" do
     let(:config) { <<-END_CONFIG }
-      worker_pool 20, :shuffle_queues => true
-      queue 'a', :count => 10
-      queue 'b', :count => 15
+      worker_pool 200, :shuffle_queues => true
+      queue 'a', :count => 100
+      queue 'b', :count => 150
     END_CONFIG
-    it { expect(result.size).to eq(20) }
-    it { (0..9).each { |i| expect(result[i][:queues].sort).to eq(["a", "b"]) } }
-    it { (10..14).each { |i| expect(result[i][:queues]).to eq(["b"]) } }
-    it { (15..19).each { |i| expect(result[i][:queues]).to eq(["*"]) } }
+    it { expect(result.size).to eq(200) }
+    it { (0..99).each { |i| expect(result[i][:queues].sort).to eq(["a", "b"]) } }
+    it { (100..149).each { |i| expect(result[i][:queues]).to eq(["b"]) } }
+    it { (150..199).each { |i| expect(result[i][:queues]).to eq(["*"]) } }
     it { result.each { |x| expect(x).not_to have_key(:shuffle_queues) } }
     it do
-      shuffled_queues = result.take(10).map { |x| x[:queues] }
+      shuffled_queues = result.take(100).map { |x| x[:queues] }
       expect(shuffled_queues.sort.uniq).to eq([["a", "b"], ["b", "a"]]) # Some of the queues should be shuffled
     end
   end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 require "support/custom_matchers"
 require "support/resqued_path"
+require "support/resqued_integration_helpers"
+require "fileutils"
 
 SPEC_TEMPDIR = File.expand_path("../tmp/spec", File.dirname(__FILE__))
 FileUtils.mkpath(SPEC_TEMPDIR)

data/spec/support/resqued_integration_helpers.rb

@@ -0,0 +1,50 @@
+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.
+    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
+
+        spawn resqued_path, "--logfile", logfile, config_path
+      end
+    sleep 1.0
+  end
+
+  def restart_resqued
+    Process.kill(:HUP, @pid)
+    sleep 1.0
+  end
+
+  def expect_running(listener:)
+    processes = list_processes
+    expect(processes).to include(is_resqued_master)
+    listeners = processes.select { |p| p[:ppid] == @pid }.map { |p| p[:args] }
+    expect(listeners).to all(match(/#{listener}/)).and(satisfy { |l| l.size == 1 })
+  end
+
+  def expect_not_running
+    processes = list_processes
+    expect(processes).not_to include(is_resqued_master)
+  end
+
+  def stop_resqued
+    Process.kill(:TERM, @pid)
+    sleep 1.0
+  end
+
+  def list_processes
+    `ps axo pid,ppid,args`.lines.map { |line| pid, ppid, args = line.strip.split(/\s+/, 3); { pid: pid.to_i, ppid: ppid.to_i, args: args } }
+  end
+
+  def is_resqued_master
+    satisfy { |p| p[:pid] == @pid && p[:args] =~ /resqued-/ }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resqued
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.2
 platform: ruby
 authors:
 - Matt Burke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-30 00:00:00.000000000 Z
+date: 2021-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kgio
@@ -137,6 +137,7 @@ files:
 - spec/fixtures/test_case_clean.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
@@ -149,6 +150,7 @@ files:
 - 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
 homepage: https://github.com/spraints/resqued
 licenses:
@@ -169,14 +171,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Daemon of resque workers
 test_files:
 - spec/spec_helper.rb
 - spec/integration/restart_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