workhorse 1.2.17.rc1 → 1.2.17.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2bcfdbfa710579ee64f436236ed5c4214404a82211ae7471513ba141e7e03eaf
-  data.tar.gz: 680b91c6bbdbc8473fdc454175bdf6a2f4b14a0831162ab02e92208914f69f7a
+  metadata.gz: ce2281ae514ba5f269328c38dd0a2e9bf0f76e2c26be09f4be467b1f818f5dec
+  data.tar.gz: 3315c9047af3bf707d23d5309b65a602474342f6c0081f329cd0582d18b7720f
 SHA512:
-  metadata.gz: 29fe50d7eb989a0d51cdcbd23adb7d42ce56fccf553448c7baf112bae2dd678a81613d593637fe6f168ff3620d9b31048abcdd0f8674b4db2244a59a82865779
-  data.tar.gz: '094cb3bb85f2be4bd2575f6441e2abc6ef17d522796c586dca69f864031fde2b0095bc8ce2c3d8bee6507ab799297fd8e79c86fbbadd28467495a39cc7031694'
+  metadata.gz: 2047809f4fe65fca5f5eaee641b5868846098e381a18d5d1d07a4a9fe3e0d94a709185b13e7cf79c3094eaed5f908aac7399abcb4488a13b288379f414a8fdf7
+  data.tar.gz: fdca924627efb8ab50938b43ac76873d5bc0a5e794484a8a1e1b7fa4afba4fe86aa4003c2ccba6ff63b9a977503f9a63f818e536bc07bc34c987be52b3580793

data/CHANGELOG.md

@@ -1,6 +1,14 @@
 # Workhorse Changelog
 
-## 1.2.17.rc1 - 2024-02-05
+## 1.2.17.rc2 - 2024-02-08
+
+* Remove unnecessary output from `watch` command in certain cases.
+
+  Sitrox reference: #121312.
+
+* Fix, improve and extend automated tests.
+
+## 1.2.17.rc1 - 2024-02-08
 
 * Revamp memory handling:
 

data/VERSION

@@ -1 +1 @@
-1.2.17.rc1
+1.2.17.rc2

data/lib/workhorse/daemon.rb

@@ -45,11 +45,14 @@ module Workhorse
     def start(quiet: false)
       code = 0
 
+      # Holds messages in format [[<message>, <severity>]]
+      messages = []
+
       for_each_worker do |worker|
         pid_file, pid, active = read_pid(worker)
 
         if pid_file && pid && active
-          warn "Worker ##{worker.id} (#{worker.name}): Already started (PID #{pid})" unless quiet
+          messages << ["Worker ##{worker.id} (#{worker.name}): Already started (PID #{pid})", 2] unless quiet
           code = 2
         elsif pid_file
           File.delete pid_file
@@ -57,32 +60,41 @@ module Workhorse
           shutdown_file = pid ? Workhorse::Worker.shutdown_file_for(pid) : nil
           shutdown_file = nil if shutdown_file && !File.exist?(shutdown_file)
 
-          puts "Worker ##{worker.id} (#{worker.name}): Starting (stale pid file)" unless quiet || shutdown_file
+          messages << ["Worker ##{worker.id} (#{worker.name}): Starting (stale pid file)", 1] unless quiet || shutdown_file
           start_worker worker
           FileUtils.rm(shutdown_file) if shutdown_file
         else
-          warn "Worker ##{worker.id} (#{worker.name}): Starting" unless quiet
+          messages << ["Worker ##{worker.id} (#{worker.name}): Starting", 1] unless quiet
           start_worker worker
         end
       end
 
+      if messages.any?
+        min = messages.min_by(&:last)[1]
+
+        # Only print messages if there is at least one message with severity 1
+        if min == 1
+          messages.each { |(message, _severity)| warn message }
+        end
+      end
+
       return code
     end
 
-    def stop(kill = false)
+    def stop(kill = false, quiet: false)
       code = 0
 
       for_each_worker do |worker|
         pid_file, pid, active = read_pid(worker)
 
         if pid_file && pid && active
-          puts "Worker (#{worker.name}) ##{worker.id}: Stopping"
+          puts "Worker (#{worker.name}) ##{worker.id}: Stopping" unless quiet
           stop_worker pid_file, pid, kill: kill
         elsif pid_file
           File.delete pid_file
-          puts "Worker (#{worker.name}) ##{worker.id}: Already stopped (stale PID file)"
+          puts "Worker (#{worker.name}) ##{worker.id}: Already stopped (stale PID file)" unless quiet
         else
-          warn "Worker (#{worker.name}) ##{worker.id}: Already stopped"
+          warn "Worker (#{worker.name}) ##{worker.id}: Already stopped" unless quiet
           code = 2
         end
       end

data/test/lib/test_helper.rb

@@ -34,11 +34,35 @@ end
 
 class WorkhorseTest < ActiveSupport::TestCase
   def setup
+    remove_pids!
+    Workhorse.silence_watcher = true
     Workhorse::DbJob.delete_all
   end
 
   protected
 
+  attr_reader :daemon
+
+  def remove_pids!
+    Dir[Rails.root.join('tmp', 'pids', '*')].each do |file|
+      FileUtils.rm file
+    end
+  end
+
+  def kill(pid)
+    signals = %w[TERM INT]
+
+    loop do
+      begin
+        signals.each { |signal| Process.kill(signal, pid) }
+      rescue Errno::ESRCH
+        break
+      end
+
+      sleep 0.5
+    end
+  end
+
   def capture_log(level: :debug)
     io = StringIO.new
     logger = Logger.new(io, level: level)
@@ -74,17 +98,44 @@ class WorkhorseTest < ActiveSupport::TestCase
     end
   end
 
+  def with_daemon(workers = 1, &_block)
+    @daemon = Workhorse::Daemon.new(pidfile: 'tmp/pids/test%s.pid') do |d|
+      workers.times do |i|
+        d.worker "Test Worker #{i}" do
+          begin
+            Workhorse::Worker.start_and_wait(
+              pool_size:        1,
+              polling_interval: 0.1
+            )
+          end
+        end
+      end
+    end
+    daemon.start(quiet: true)
+    yield @daemon
+  ensure
+    daemon.stop(quiet: true)
+  end
+
   def with_retries(max = 50, interval: 0.1, &_block)
     runs = 0
 
     loop do
       return yield
-    rescue Minitest::Assertion => e
+    rescue Minitest::Assertion
       fail if runs > max
       sleep interval
       runs += 1
     end
   end
+
+  def capture_stderr
+    old, $stderr = $stderr, StringIO.new
+    yield
+    $stderr.string
+  ensure
+    $stderr = old
+  end
 end
 
 ActiveRecord::Base.establish_connection(

data/test/workhorse/daemon_test.rb

@@ -0,0 +1,92 @@
+require 'test_helper'
+
+class Workhorse::DaemonTest < WorkhorseTest
+  def setup
+    remove_pids!
+  end
+
+  def test_watch_all_ok
+    with_daemon 2 do
+      assert_watch_output
+    end
+  end
+
+  def test_watch_starting_stale_pid
+    with_daemon 2 do
+      # Kill first worker
+      Process.kill 'KILL', daemon.workers.first.pid
+
+      # Watch
+      assert_watch_output(
+        'Worker #1 (Test Worker 0): Starting (stale pid file)',
+        "Worker #2 (Test Worker 1): Already started (PID #{daemon.workers.second.pid})"
+      )
+    end
+  end
+
+  def test_watch_starting_missing_pid
+    with_daemon 2 do
+      # Kill first worker
+      kill daemon.workers.first.pid
+      FileUtils.rm "tmp/pids/test1.pid"
+
+      # Watch
+      assert_watch_output(
+        'Worker #1 (Test Worker 0): Starting',
+        "Worker #2 (Test Worker 1): Already started (PID #{daemon.workers.second.pid})"
+      )
+    end
+  end
+
+  def test_watch_controlled_shutdown
+    with_daemon 2 do
+      # Kill first worker
+      kill daemon.workers.first.pid
+      FileUtils.touch "tmp/pids/workhorse.#{daemon.workers.first.pid}.shutdown"
+
+      # Watch
+      assert_watch_output
+    end
+
+    assert_not File.exist?("tmp/pids/workhorse.#{daemon.workers.first.pid}.shutdown")
+  end
+
+  def test_watch_mixed
+    # Worker 0: Kill, remove PID
+    # Worker 1: Kill, keep PID
+    # Worker 2: Keep
+    # Worker 3: Controlled shutdown
+    with_daemon 4 do
+      # Worker 0: Kill, remove PID
+      kill daemon.workers[0].pid
+      FileUtils.rm "tmp/pids/test1.pid"
+
+      # Worker 1: Kill, keep PID
+      kill daemon.workers[1].pid
+
+      # Worker 3: Controlled shutdown
+      kill daemon.workers[3].pid
+      FileUtils.touch "tmp/pids/workhorse.#{daemon.workers.first.pid}.shutdown"
+
+      # Watch
+      assert_watch_output(
+        'Worker #1 (Test Worker 0): Starting',
+        'Worker #2 (Test Worker 1): Starting (stale pid file)',
+        "Worker #3 (Test Worker 2): Already started (PID #{daemon.workers[2].pid})",
+        'Worker #4 (Test Worker 3): Starting (stale pid file)'
+      )
+    end
+
+    assert_not File.exist?("tmp/pids/workhorse.#{daemon.workers.first.pid}.shutdown")
+  end
+
+  private
+
+  def assert_watch_output(*expected_lines)
+    silence_watcher_was = Workhorse.silence_watcher
+    Workhorse.silence_watcher = false
+    assert_equal expected_lines, capture_stderr { daemon.watch }.lines.map(&:chomp)
+  ensure
+    Workhorse.silence_watcher = silence_watcher_was
+  end
+end

data/test/workhorse/poller_test.rb

@@ -182,31 +182,32 @@ class Workhorse::PollerTest < WorkhorseTest
       Workhorse::DbJob.delete_all
 
       Workhorse.clean_stuck_jobs = clean
-      start_deamon
-      Workhorse.enqueue BasicJob.new(sleep_time: 5)
-      sleep 0.2
-      kill_deamon_workers
-
-      assert_equal 1, Workhorse::DbJob.count
-
-      Workhorse::DbJob.first.update(
-        state:      'locked',
-        started_at: nil
-      )
-
-      Workhorse::Worker.new.poller.send(:clean_stuck_jobs!) if clean
-
-      assert_equal 1, Workhorse::DbJob.count
-
-      Workhorse::DbJob.first.tap do |job|
-        if clean
-          assert_equal 'waiting', job.state
-          assert_nil job.locked_at
-          assert_nil job.locked_by
-          assert_nil job.started_at
-          assert_nil job.last_error
-        else
-          assert_equal 'locked', job.state
+      with_daemon do
+        Workhorse.enqueue BasicJob.new(sleep_time: 5)
+        sleep 0.2
+        kill_deamon_workers
+
+        assert_equal 1, Workhorse::DbJob.count
+
+        Workhorse::DbJob.first.update(
+          state:      'locked',
+          started_at: nil
+        )
+
+        Workhorse::Worker.new.poller.send(:clean_stuck_jobs!) if clean
+
+        assert_equal 1, Workhorse::DbJob.count
+
+        Workhorse::DbJob.first.tap do |job|
+          if clean
+            assert_equal 'waiting', job.state
+            assert_nil job.locked_at
+            assert_nil job.locked_by
+            assert_nil job.started_at
+            assert_nil job.last_error
+          else
+            assert_equal 'locked', job.state
+          end
         end
       end
     ensure
@@ -219,25 +220,26 @@ class Workhorse::PollerTest < WorkhorseTest
       Workhorse::DbJob.delete_all
 
       Workhorse.clean_stuck_jobs = true
-      start_deamon
-      Workhorse.enqueue BasicJob.new(sleep_time: 5)
-      sleep 0.2
-      kill_deamon_workers
-
-      assert_equal 1, Workhorse::DbJob.count
-      assert_equal 'started', Workhorse::DbJob.first.state
-
-      work 0.1 if clean
-
-      assert_equal 1, Workhorse::DbJob.count
-
-      Workhorse::DbJob.first.tap do |job|
-        if clean
-          assert_equal 'failed', job.state
-          assert_match(/started by PID #{@daemon.workers.first.pid}/, job.last_error)
-          assert_match(/on host #{Socket.gethostname}/, job.last_error)
-        else
-          assert_equal 'started', job.state
+      with_daemon do
+        Workhorse.enqueue BasicJob.new(sleep_time: 5)
+        sleep 0.2
+        kill_deamon_workers
+
+        assert_equal 1, Workhorse::DbJob.count
+        assert_equal 'started', Workhorse::DbJob.first.state
+
+        work 0.1 if clean
+
+        assert_equal 1, Workhorse::DbJob.count
+
+        Workhorse::DbJob.first.tap do |job|
+          if clean
+            assert_equal 'failed', job.state
+            assert_match(/started by PID #{daemon.workers.first.pid}/, job.last_error)
+            assert_match(/on host #{Socket.gethostname}/, job.last_error)
+          else
+            assert_equal 'started', job.state
+          end
         end
       end
     ensure
@@ -248,23 +250,11 @@ class Workhorse::PollerTest < WorkhorseTest
   private
 
   def kill_deamon_workers
-    @daemon.workers.each do |worker|
+    daemon.workers.each do |worker|
       Process.kill 'KILL', worker.pid
     end
   end
 
-  def start_deamon
-    @daemon = Workhorse::Daemon.new(pidfile: 'tmp/pids/test%s.pid') do |d|
-      d.worker 'Test Worker' do
-        Workhorse::Worker.start_and_wait(
-          pool_size:        1,
-          polling_interval: 0.1
-        )
-      end
-    end
-    @daemon.start
-  end
-
   def setup
     Workhorse::DbJob.delete_all
   end

data/test/workhorse/worker_test.rb

@@ -181,70 +181,44 @@ class Workhorse::WorkerTest < WorkhorseTest
   end
 
   def test_controlled_shutdown
-    remove_pids!
-
     Workhorse.max_worker_memory_mb = 50
+    with_daemon do
+      pid = with_retries do
+        pid = daemon.workers.first.pid
+        assert_process(pid)
+        pid
+      end
 
-    daemon = start_daemon
+      10.times do
+        Workhorse.enqueue BasicJob.new(sleep_time: 0.1)
 
-    pid = with_retries do
-      pid = daemon.workers.first.pid
-      assert_process(pid)
-      pid
-    end
+        with_retries do
+          assert_equal 'succeeded', Workhorse::DbJob.first.state
+          Workhorse::DbJob.delete_all
+        end
+      end
 
-    10.times do
-      Workhorse.enqueue BasicJob.new(sleep_time: 0.1)
+      Workhorse.enqueue MemHungryJob.new
 
       with_retries do
         assert_equal 'succeeded', Workhorse::DbJob.first.state
-        Workhorse::DbJob.delete_all
-      end
-    end
-
-    Workhorse.enqueue MemHungryJob.new
 
-    with_retries do
-      assert_equal 'succeeded', Workhorse::DbJob.first.state
-
-      assert File.exist?("tmp/pids/workhorse.#{pid}.shutdown")
-      assert_not_process pid
-    end
+        assert File.exist?("tmp/pids/workhorse.#{pid}.shutdown")
+        assert_not_process pid
+      end
 
-    daemon.watch
+      capture_stderr { daemon.watch }
 
-    with_retries do
-      assert_not File.exist?("tmp/pids/workhorse.#{pid}.shutdown")
+      with_retries do
+        assert_not File.exist?("tmp/pids/workhorse.#{pid}.shutdown")
+      end
     end
   ensure
-    daemon.stop
     Workhorse.max_worker_memory_mb = 0
   end
 
   private
 
-  def remove_pids!
-    Dir[Rails.root.join('tmp', 'pids', '*')].each do |file|
-      FileUtils.rm file
-    end
-  end
-
-  def start_daemon
-    daemon = Workhorse::Daemon.new(pidfile: 'tmp/pids/test%s.pid') do |d|
-      d.worker 'Test Worker' do
-        begin
-          Workhorse::Worker.start_and_wait(
-            pool_size:        1,
-            polling_interval: 0.1,
-            logger:           ActiveSupport::Logger.new('tmp/log.log')
-          )
-        end
-      end
-    end
-    daemon.start
-    return daemon
-  end
-
   def assert_process(pid)
     assert process?(pid), "Process #{pid} expected to be running"
   end

data/workhorse.gemspec

@@ -1,18 +1,18 @@
 # -*- encoding: utf-8 -*-
-# stub: workhorse 1.2.17.rc1 ruby lib
+# stub: workhorse 1.2.17.rc2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "workhorse".freeze
-  s.version = "1.2.17.rc1"
+  s.version = "1.2.17.rc2"
 
   s.required_rubygems_version = Gem::Requirement.new("> 1.3.1".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Sitrox".freeze]
   s.date = "2024-02-08"
-  s.files = [".github/workflows/ruby.yml".freeze, ".gitignore".freeze, ".releaser_config".freeze, ".rubocop.yml".freeze, "CHANGELOG.md".freeze, "FAQ.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "RUBY_VERSION".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/rubocop".freeze, "lib/active_job/queue_adapters/workhorse_adapter.rb".freeze, "lib/generators/workhorse/install_generator.rb".freeze, "lib/generators/workhorse/templates/bin/workhorse.rb".freeze, "lib/generators/workhorse/templates/config/initializers/workhorse.rb".freeze, "lib/generators/workhorse/templates/create_table_jobs.rb".freeze, "lib/workhorse.rb".freeze, "lib/workhorse/active_job_extension.rb".freeze, "lib/workhorse/daemon.rb".freeze, "lib/workhorse/daemon/shell_handler.rb".freeze, "lib/workhorse/db_job.rb".freeze, "lib/workhorse/enqueuer.rb".freeze, "lib/workhorse/jobs/cleanup_succeeded_jobs.rb".freeze, "lib/workhorse/jobs/detect_stale_jobs_job.rb".freeze, "lib/workhorse/jobs/run_active_job.rb".freeze, "lib/workhorse/jobs/run_rails_op.rb".freeze, "lib/workhorse/performer.rb".freeze, "lib/workhorse/poller.rb".freeze, "lib/workhorse/pool.rb".freeze, "lib/workhorse/scoped_env.rb".freeze, "lib/workhorse/worker.rb".freeze, "test/active_job/queue_adapters/workhorse_adapter_test.rb".freeze, "test/lib/db_schema.rb".freeze, "test/lib/jobs.rb".freeze, "test/lib/test_helper.rb".freeze, "test/workhorse/db_job_test.rb".freeze, "test/workhorse/enqueuer_test.rb".freeze, "test/workhorse/performer_test.rb".freeze, "test/workhorse/poller_test.rb".freeze, "test/workhorse/pool_test.rb".freeze, "test/workhorse/worker_test.rb".freeze, "workhorse.gemspec".freeze]
+  s.files = [".github/workflows/ruby.yml".freeze, ".gitignore".freeze, ".releaser_config".freeze, ".rubocop.yml".freeze, "CHANGELOG.md".freeze, "FAQ.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "RUBY_VERSION".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/rubocop".freeze, "lib/active_job/queue_adapters/workhorse_adapter.rb".freeze, "lib/generators/workhorse/install_generator.rb".freeze, "lib/generators/workhorse/templates/bin/workhorse.rb".freeze, "lib/generators/workhorse/templates/config/initializers/workhorse.rb".freeze, "lib/generators/workhorse/templates/create_table_jobs.rb".freeze, "lib/workhorse.rb".freeze, "lib/workhorse/active_job_extension.rb".freeze, "lib/workhorse/daemon.rb".freeze, "lib/workhorse/daemon/shell_handler.rb".freeze, "lib/workhorse/db_job.rb".freeze, "lib/workhorse/enqueuer.rb".freeze, "lib/workhorse/jobs/cleanup_succeeded_jobs.rb".freeze, "lib/workhorse/jobs/detect_stale_jobs_job.rb".freeze, "lib/workhorse/jobs/run_active_job.rb".freeze, "lib/workhorse/jobs/run_rails_op.rb".freeze, "lib/workhorse/performer.rb".freeze, "lib/workhorse/poller.rb".freeze, "lib/workhorse/pool.rb".freeze, "lib/workhorse/scoped_env.rb".freeze, "lib/workhorse/worker.rb".freeze, "test/active_job/queue_adapters/workhorse_adapter_test.rb".freeze, "test/lib/db_schema.rb".freeze, "test/lib/jobs.rb".freeze, "test/lib/test_helper.rb".freeze, "test/workhorse/daemon_test.rb".freeze, "test/workhorse/db_job_test.rb".freeze, "test/workhorse/enqueuer_test.rb".freeze, "test/workhorse/performer_test.rb".freeze, "test/workhorse/poller_test.rb".freeze, "test/workhorse/pool_test.rb".freeze, "test/workhorse/worker_test.rb".freeze, "workhorse.gemspec".freeze]
   s.rubygems_version = "3.4.6".freeze
   s.summary = "Multi-threaded job backend with database queuing for ruby.".freeze
-  s.test_files = ["test/active_job/queue_adapters/workhorse_adapter_test.rb".freeze, "test/lib/db_schema.rb".freeze, "test/lib/jobs.rb".freeze, "test/lib/test_helper.rb".freeze, "test/workhorse/db_job_test.rb".freeze, "test/workhorse/enqueuer_test.rb".freeze, "test/workhorse/performer_test.rb".freeze, "test/workhorse/poller_test.rb".freeze, "test/workhorse/pool_test.rb".freeze, "test/workhorse/worker_test.rb".freeze]
+  s.test_files = ["test/active_job/queue_adapters/workhorse_adapter_test.rb".freeze, "test/lib/db_schema.rb".freeze, "test/lib/jobs.rb".freeze, "test/lib/test_helper.rb".freeze, "test/workhorse/daemon_test.rb".freeze, "test/workhorse/db_job_test.rb".freeze, "test/workhorse/enqueuer_test.rb".freeze, "test/workhorse/performer_test.rb".freeze, "test/workhorse/poller_test.rb".freeze, "test/workhorse/pool_test.rb".freeze, "test/workhorse/worker_test.rb".freeze]
 
   s.specification_version = 4
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: workhorse
 version: !ruby/object:Gem::Version
-  version: 1.2.17.rc1
+  version: 1.2.17.rc2
 platform: ruby
 authors:
 - Sitrox
@@ -221,6 +221,7 @@ files:
 - test/lib/db_schema.rb
 - test/lib/jobs.rb
 - test/lib/test_helper.rb
+- test/workhorse/daemon_test.rb
 - test/workhorse/db_job_test.rb
 - test/workhorse/enqueuer_test.rb
 - test/workhorse/performer_test.rb
@@ -255,6 +256,7 @@ test_files:
 - test/lib/db_schema.rb
 - test/lib/jobs.rb
 - test/lib/test_helper.rb
+- test/workhorse/daemon_test.rb
 - test/workhorse/db_job_test.rb
 - test/workhorse/enqueuer_test.rb
 - test/workhorse/performer_test.rb