workhorse 1.2.24 → 1.3.0.rc0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97943ac72325488d753fce90321c093208e3503b3071a79dba1495bcb347a22c
-  data.tar.gz: b3d37af6f6f2910cf1fe96cf82bc445852fec78da2f5088dfdd665090b3f451e
+  metadata.gz: 85aa56534b17816d2256e85b1929397d7cab79c05bd25aa3efeef6ae538bb7ae
+  data.tar.gz: 9e7b16ff371b8113e2de2b475c71512d2fca292873bb7a66b9905107e86a5f4d
 SHA512:
-  metadata.gz: 5964079c67b84282e5b30cde7bc3af45554da948149bd41a8f0b8fbdffb0f60caa2ca6f7cd95652bd2a3df0dce10046b47bdf1104f2d85d69fcea16cc68d91a3
-  data.tar.gz: 72691ebfd441c0314fb4f3e75fafedbd70b0f036a129cb0e14a54e2919d337e637a1b1adc3e8c8af6d05eb8deb0853e43ca8b7239addf6ae3df63a6b01e575a2
+  metadata.gz: dbc294e830bc9a594844055de6c392401bf7e18871d078da60580b5b5d7c3c9cc72ca9cc5abd846aaa3a6f5b18c85b80b097b0a94ff68759fcb166f9ed33eff6
+  data.tar.gz: 7f1454dd8a7dd0ad2d491050b6b5e1fdbee429cfe99fcfdf5518590bcb1e9e372500c5a3f0c8b2c4faeaa6b277d0304c2547f0e995af9d53ce82cdbdfe24871e

data/.github/workflows/ruby.yml

@@ -13,9 +13,6 @@ jobs:
       fail-fast: false
       matrix:
         ruby-version:
-          - '2.5.1'
-          - '2.6.2'
-          - '2.7.1'
           - '3.0.1'
           - '3.1.2'
           - '3.2.1'

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Workhorse Changelog
 
+## 1.3.0.rc0 - 2025-06-10
+
+* Drop official support for Ruby < 3.0
+
+* Skip `at_exit` handlers again (as introduced in 1.2.22) when exiting in
+  ShellHandler but still release lock file to fix issue originally fixed in
+  1.2.23. This ensures compatibility with the `debug` gem, which would
+  otherwise hang when using the Workhorse shell handler.
+
+  Sitrox reference: #128333.
+
+* Improve reliability of worker shutdown
+
+* Improve reliability and efficiency of polling mechanism
+
+* Improve reliability of automated tests
+
 ## 1.2.24 - 2024-10-21
 
 * Fix compatibility with ActiveJob 7.2.x

data/README.md

@@ -33,7 +33,7 @@ What it does not do:
 
 ### Requirements
 
-* Ruby `>= 2.0.0`
+* Ruby `>= 3.0` (may work with earlier versions but is untested)
 * Rails `>= 3.2`
 * A database and table handler that properly supports row-level locking (such as
   MySQL with InnoDB, PostgreSQL, or Oracle).

data/Rakefile

@@ -16,7 +16,6 @@ task :gemspec do
     spec.add_development_dependency 'rubocop', '~> 1.28.0' # Latest version supported with Ruby 2.5
     spec.add_development_dependency 'minitest'
     spec.add_development_dependency 'mysql2'
-    spec.add_development_dependency 'colorize'
     spec.add_development_dependency 'benchmark-ips'
     spec.add_development_dependency 'activejob'
     spec.add_development_dependency 'pry'

data/VERSION

@@ -1 +1 @@
-1.2.24
+1.3.0.rc0

data/lib/workhorse/daemon/shell_handler.rb

@@ -19,32 +19,32 @@ module Workhorse
       begin
         case ARGV.first
         when 'start'
-          exit daemon.start
+          status = daemon.start
         when 'stop'
-          exit daemon.stop
+          status = daemon.stop
         when 'kill'
-          exit daemon.stop(true)
+          status = daemon.stop(true)
         when 'status'
-          exit daemon.status
+          status = daemon.status
         when 'watch'
-          exit daemon.watch
+          status = daemon.watch
         when 'restart'
-          exit daemon.restart
+          status = daemon.restart
         when 'restart-logging'
-          exit daemon.restart_logging
+          status = daemon.restart_logging
         when 'usage'
           usage
-          exit 99
+          status = 0
         else
           usage
+          status = 99
         end
-
-        exit 0
       rescue StandardError => e
         warn "#{e.message}\n#{e.backtrace.join("\n")}"
-        exit 99
+        status = 99
       ensure
         lockfile&.flock(File::LOCK_UN)
+        exit! status
       end
     end
 

data/lib/workhorse/poller.rb

@@ -206,9 +206,9 @@ module Workhorse
 
       timeout = [MIN_LOCK_TIMEOUT, [MAX_LOCK_TIMEOUT, worker.polling_interval].min].max
       with_global_lock timeout: timeout do
-        job_ids = []
-
         Workhorse.tx_callback.call do
+          job_ids = []
+
           # As we are the only thread posting into the worker pool, it is safe to
           # get the number of idle threads without mutex synchronization. The
           # actual number of idle workers at time of posting can only be larger
@@ -225,9 +225,14 @@ module Workhorse
               job_ids << job.id
             end
           end
-        end
 
-        job_ids.each { |job_id| worker.perform(job_id) }
+          unless running?
+            worker.log 'Rolling back transaction to unlock jobs, as worker has been shut down in the meantime'
+            fail ActiveRecord::Rollback
+          end
+
+          job_ids.each { |job_id| worker.perform(job_id) }
+        end
       end
     end
 
@@ -358,8 +363,10 @@ module Workhorse
       # Get the names of all valid queues. The extra project here allows
       # selecting the last value in each row of the resulting array and getting
       # the queue name.
+      select.projections = []
       queues = select.project(:queue)
-      return Workhorse::DbJob.find_by_sql(queues.to_sql).map(&:queue).uniq
+
+      return Workhorse::DbJob.connection.execute(queues.distinct.to_sql).to_a.flatten
     end
   end
 end

data/lib/workhorse/worker.rb

@@ -116,6 +116,9 @@ module Workhorse
       # final state this worker can be in.
       return if @state == :shutdown
 
+      # TODO: There is a race-condition with this shutdown:
+      #  - If the poller is currently locking a job, it may call
+      #    "worker.perform", which in turn tries to synchronize the same mutex.
       mutex.synchronize do
         assert_state! :running
 

data/test/lib/test_helper.rb

@@ -2,7 +2,6 @@ require 'minitest/autorun'
 require 'active_record'
 require 'active_job'
 require 'pry'
-require 'colorize'
 require 'mysql2'
 require 'benchmark'
 require 'concurrent'
@@ -35,6 +34,7 @@ end
 class WorkhorseTest < ActiveSupport::TestCase
   def setup
     remove_pids!
+    clear_locks_and_db_threads!
     Workhorse.silence_watcher = true
     Workhorse::DbJob.delete_all
   end
@@ -43,6 +43,22 @@ class WorkhorseTest < ActiveSupport::TestCase
 
   attr_reader :daemon
 
+  def clear_locks_and_db_threads!
+    Workhorse::DbJob.connection.execute('SELECT RELEASE_ALL_LOCKS()')
+
+    pids = Workhorse::DbJob.connection.execute(<<~SQL.squish).to_a.flatten
+      SELECT ID FROM INFORMATION_SCHEMA.PROCESSLIST WHERE ID != CONNECTION_ID()
+    SQL
+
+    begin
+      pids.each { |pid| Workhorse::DbJob.connection.execute("KILL QUERY #{pid}") }
+    rescue ActiveRecord::StatementInvalid
+      # Ignore
+    end
+
+    Workhorse::DbJob.connection.execute('SELECT RELEASE_ALL_LOCKS()')
+  end
+
   def remove_pids!
     Dir[Rails.root.join('tmp', 'pids', '*')].each do |file|
       FileUtils.rm file
@@ -74,6 +90,7 @@ class WorkhorseTest < ActiveSupport::TestCase
   def work(time = 2, options = {})
     options[:pool_size] ||= 5
     options[:polling_interval] ||= 1
+    options[:auto_terminate] = options.fetch(:auto_terminate, false)
 
     with_worker(options) do
       sleep time
@@ -81,6 +98,8 @@ class WorkhorseTest < ActiveSupport::TestCase
   end
 
   def work_until(max: 50, interval: 0.1, **options, &block)
+    options[:auto_terminate] = options.fetch(:auto_terminate, false)
+
     w = Workhorse::Worker.new(**options)
     w.start
     return with_retries(max, interval: interval, &block)
@@ -143,6 +162,7 @@ ActiveRecord::Base.establish_connection(
   username: ENV.fetch('DB_USERNAME', nil) || 'root',
   password: ENV.fetch('DB_PASSWORD', nil) || '',
   host:     ENV.fetch('DB_HOST', nil) || '127.0.0.1',
+  port:     ENV.fetch('DB_PORT', nil) || 3306,
   pool:     10
 )
 

data/test/workhorse/db_job_test.rb

@@ -3,17 +3,13 @@ require 'test_helper'
 class Workhorse::DbJobTest < WorkhorseTest
   def test_reset_succeeded
     job = Workhorse.enqueue(BasicJob.new(sleep_time: 0))
-    work 0.5
-    job.reload
-    assert_equal 'succeeded', job.state
-
+    work_until { assert_equal 'succeeded', job.reload.state }
     job.reset!
-
-    assert_clean job
+    assert_clean job.reload
   end
 
   def test_reset_failed
-    job = Workhorse.enqueue FailingTestJob
+    job = Workhorse.enqueue FailingTestJob.new
     work 0.5
     job.reload
     assert_equal 'failed', job.state

data/test/workhorse/performer_test.rb

@@ -21,7 +21,7 @@ class Workhorse::PerformerTest < WorkhorseTest
   end
 
   def test_exception
-    Workhorse.enqueue FailingTestJob
+    Workhorse.enqueue FailingTestJob.new
     work 0.2, polling_interval: 0.2
     assert_equal 'failed', Workhorse::DbJob.first.state
   end

data/test/workhorse/poller_test.rb

@@ -219,26 +219,27 @@ class Workhorse::PollerTest < WorkhorseTest
     [true, false].each do |clean|
       Workhorse::DbJob.delete_all
 
-      Workhorse.clean_stuck_jobs = true
+      Workhorse.clean_stuck_jobs = clean
       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
+        with_retries do
+          assert_equal 'started', Workhorse::DbJob.first.state
+        end
 
-        work 0.1 if clean
+        kill_deamon_workers
 
-        assert_equal 1, Workhorse::DbJob.count
+        assert_equal 'started', Workhorse::DbJob.first.state
 
-        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
+        work_until do
+          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
       end

data/workhorse.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: workhorse 1.2.24 ruby lib
+# stub: workhorse 1.3.0.rc0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "workhorse".freeze
-  s.version = "1.2.24"
+  s.version = "1.3.0.rc0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  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-10-21"
+  s.date = "2025-06-10"
   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
@@ -21,7 +21,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency(%q<rubocop>.freeze, ["~> 1.28.0"])
   s.add_development_dependency(%q<minitest>.freeze, [">= 0"])
   s.add_development_dependency(%q<mysql2>.freeze, [">= 0"])
-  s.add_development_dependency(%q<colorize>.freeze, [">= 0"])
   s.add_development_dependency(%q<benchmark-ips>.freeze, [">= 0"])
   s.add_development_dependency(%q<activejob>.freeze, [">= 0"])
   s.add_development_dependency(%q<pry>.freeze, [">= 0"])

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: workhorse
 version: !ruby/object:Gem::Version
-  version: 1.2.24
+  version: 1.3.0.rc0
 platform: ruby
 authors:
 - Sitrox
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-21 00:00:00.000000000 Z
+date: 2025-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,20 +79,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: colorize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -178,8 +163,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -229,10 +212,8 @@ files:
 - test/workhorse/pool_test.rb
 - test/workhorse/worker_test.rb
 - workhorse.gemspec
-homepage:
 licenses: []
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -243,12 +224,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.5.4
-signing_key:
+rubygems_version: 3.6.8
 specification_version: 4
 summary: Multi-threaded job backend with database queuing for ruby.
 test_files: