workhorse 1.4.2 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0facaea70a5e826980ea41034914a0609a22fb3ed93c9fbe4a7607eb5a3854c9
-  data.tar.gz: 35cc28b0a31206fa5f38df60858c5c2054c28fd7c47a4bf0b4983c9cbbcc02d0
+  metadata.gz: ef9cd623d06cab42a5c5a849f9a5c334c0bb8f4dd517f2c84e5ba3c4df611b24
+  data.tar.gz: 9681900417bc660a347afeeaebf6cf57fa342268afc38c24b4e5ce11479ce1e3
 SHA512:
-  metadata.gz: 551453702ecb4b89060a7e5fdba4639eccbb60c09c85ebd2fd561eec91787c1b8166be81e81b2bd2da46f250ba70c8426198bca404d1cf1e5fbf1c6c9b5096ee
-  data.tar.gz: e1ee8b9ae1267271f8be2befd5455d90614e02c8708b2413bc90f957b8d5fb852b2f805ea4d42b6362844c2e7ed774e2a0a727e83687d570d0c430174e264227
+  metadata.gz: 86a5b9f9db82efbd890dc77fa763dcc1052027df45d922358428e721bfe3e900670e28b1e55af06e04972fef7c6408fe8a445239443f0707063281d4baf344fe
+  data.tar.gz: 74f47b979b3589b5530947638c7ec7a6acbb9f85599c88bd9eccaf25fcecf5a92addecb58fa9357bc07eb840bf16b31e5a7fe7fe2f9a6e11fa697b31d9aaf526

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Workhorse Changelog
 
+## 1.4.5 - 2026-05-09
+
+* Close the lockfile after releasing the lock in the ShellHandler.
+
+  Sitrox reference: #120574.
+
+* Prevent YJIT from being enabled when `RUBY_YJIT_ENABLE=0` is set. This allows
+  running workhorse commands in systemd services that set
+  `MemoryDenyWriteExecute=yes`.
+
+  Sitrox reference: #120574.
+
+## 1.4.4 - 2026-04-28
+
+* Make debug logging (enabled if `config.debug_log_path` is set) more verbose.
+
+  Sitrox reference: #120574.
+
+## 1.4.3 - 2026-04-28
+
+* Yanked from RubyGems. Do not use this release.
+
 ## 1.4.2 - 2026-02-20
 
 * Detach forked worker processes into their own session using `Process.setsid`.
@@ -62,7 +84,7 @@
 
 ## 1.3.0.rc4 - 2025-08-27
 
-* Fix race-condition in polling mechanism which could result in workers 
+* Fix race-condition in polling mechanism which could result in workers
   trying to run a job that is not yet locked.
 
   Sitrox reference: #128333.

data/README.md

@@ -529,6 +529,17 @@ ActiveSupport.on_load :workhorse_db_job do
 end
 ```
 
+## Running in systemd services
+
+When running workhorse commands inside a systemd service that sets
+`MemoryDenyWriteExecute=yes`, Ruby's YJIT cannot allocate executable memory and
+will crash. To prevent this, set `RUBY_YJIT_ENABLE=0` before invoking the
+workhorse command:
+
+```bash
+RUBY_YJIT_ENABLE=0 ./bin/workhorse restart-logging
+```
+
 ## Debug logging
 
 Workhorse includes an optional debug log for diagnosing issues with signal

data/RUBY_VERSION

@@ -1 +1 @@
-ruby-3.2.1-p31
+ruby-3.3.5

data/VERSION

@@ -1 +1 @@
-1.4.2
+1.4.5

data/lib/workhorse/daemon/shell_handler.rb

@@ -81,13 +81,16 @@ module Workhorse
           status = 99
         end
       rescue StandardError => e
+        Workhorse.debug_log("ShellHandler: #{ARGV.first} failed with #{e.class}: #{e.message}")
         warn "#{e.message}\n#{e.backtrace.join("\n")}"
         status = 99
       ensure
         if lockfile
           Workhorse.debug_log("ShellHandler: releasing lock for #{ARGV.first}")
           lockfile.flock(File::LOCK_UN)
+          lockfile.close
         end
+        Workhorse.debug_log("ShellHandler: exiting with status #{status}")
         exit! status
       end
     end
@@ -143,7 +146,7 @@ module Workhorse
 
     def self.acquire_lock(lockfile_path, flags)
       if Workhorse.lock_shell_commands
-        lockfile = File.open(lockfile_path, 'a')
+        lockfile = File.open(lockfile_path, 'a') # rubocop:disable Style/FileOpen
         result = lockfile.flock(flags)
 
         if result == false

data/lib/workhorse/daemon.rb

@@ -82,6 +82,8 @@ module Workhorse
     def start(quiet: false)
       code = 0
 
+      Workhorse.debug_log("Daemon: starting #{@workers.count} worker(s)")
+
       # Holds messages in format [[<message>, <severity>]]
       messages = []
 
@@ -89,9 +91,11 @@ module Workhorse
         pid_file, pid, active = read_pid(worker)
 
         if pid_file && pid && active
+          Workhorse.debug_log("Daemon start: worker ##{worker.id} (#{worker.name}) already running (PID #{pid})")
           messages << ["Worker ##{worker.id} (#{worker.name}): Already started (PID #{pid})", 2] unless quiet
           code = 2
         elsif pid_file
+          Workhorse.debug_log("Daemon start: worker ##{worker.id} (#{worker.name}) has stale pid file (PID #{pid.inspect}), starting")
           File.delete pid_file
 
           shutdown_file = pid ? Workhorse::Worker.shutdown_file_for(pid) : nil
@@ -101,6 +105,7 @@ module Workhorse
           start_worker worker
           FileUtils.rm(shutdown_file) if shutdown_file
         else
+          Workhorse.debug_log("Daemon start: worker ##{worker.id} (#{worker.name}) not running, starting")
           messages << ["Worker ##{worker.id} (#{worker.name}): Starting", 1] unless quiet
           start_worker worker
         end
@@ -115,6 +120,7 @@ module Workhorse
         end
       end
 
+      Workhorse.debug_log("Daemon: start complete, exit code=#{code}")
       return code
     end
 
@@ -126,21 +132,27 @@ module Workhorse
     def stop(kill = false, quiet: false)
       code = 0
 
+      Workhorse.debug_log("Daemon: stopping #{@workers.count} worker(s) (kill=#{kill})")
+
       for_each_worker do |worker|
         pid_file, pid, active = read_pid(worker)
 
         if pid_file && pid && active
+          Workhorse.debug_log("Daemon stop: worker ##{worker.id} (#{worker.name}) running (PID #{pid}), stopping")
           puts "Worker (#{worker.name}) ##{worker.id}: Stopping" unless quiet
           stop_worker pid_file, pid, kill: kill
         elsif pid_file
+          Workhorse.debug_log("Daemon stop: worker ##{worker.id} (#{worker.name}) stale pid file (PID #{pid.inspect})")
           File.delete pid_file
           puts "Worker (#{worker.name}) ##{worker.id}: Already stopped (stale PID file)" unless quiet
         else
+          Workhorse.debug_log("Daemon stop: worker ##{worker.id} (#{worker.name}) already stopped")
           warn "Worker (#{worker.name}) ##{worker.id}: Already stopped" unless quiet
           code = 2
         end
       end
 
+      Workhorse.debug_log("Daemon: stop complete, exit code=#{code}")
       return code
     end
 
@@ -155,16 +167,20 @@ module Workhorse
         pid_file, pid, active = read_pid(worker)
 
         if pid_file && pid && active
+          Workhorse.debug_log("Daemon status: worker ##{worker.id} (#{worker.name}) running (PID #{pid})")
           puts "Worker ##{worker.id} (#{worker.name}): Running" unless quiet
         elsif pid_file
+          Workhorse.debug_log("Daemon status: worker ##{worker.id} (#{worker.name}) not running (stale PID file, PID #{pid.inspect})")
           warn "Worker ##{worker.id} (#{worker.name}): Not running (stale PID file)" unless quiet
           code = 2
         else
+          Workhorse.debug_log("Daemon status: worker ##{worker.id} (#{worker.name}) not running (no pid file)")
           warn "Worker ##{worker.id} (#{worker.name}): Not running" unless quiet
           code = 2
         end
       end
 
+      Workhorse.debug_log("Daemon: status complete, exit code=#{code}")
       return code
     end
 
@@ -179,9 +195,14 @@ module Workhorse
         should_be_running = true
       end
 
-      if should_be_running && status(quiet: true) != 0
+      status_code = status(quiet: true)
+      Workhorse.debug_log("Daemon watch: should_be_running=#{should_be_running}, status_code=#{status_code}")
+
+      if should_be_running && status_code != 0
+        Workhorse.debug_log('Daemon watch: starting workers')
         return start(quiet: Workhorse.silence_watcher)
       else
+        Workhorse.debug_log('Daemon watch: no action needed')
         return 0
       end
     end
@@ -289,7 +310,7 @@ module Workhorse
         @lockfile&.close
         # Reopen pipes to prevent #107576
         $stdin.reopen File.open(File::NULL, 'r')
-        null_out = File.open File::NULL, 'w'
+        null_out = File.open(File::NULL, 'w') # rubocop:disable Style/FileOpen
         $stdout.reopen null_out
         $stderr.reopen null_out
 

data/lib/workhorse/poller.rb

@@ -49,14 +49,18 @@ module Workhorse
       fail 'Poller is already running.' if running?
       @running = true
 
+      Workhorse.debug_log("[Job worker #{worker.id}] Poller starting")
+
       clean_stuck_jobs! if Workhorse.clean_stuck_jobs
 
       @thread = Thread.new do
+        Workhorse.debug_log("[Job worker #{worker.id}] Poller thread started")
         loop do
           break unless running?
 
           begin
             unless @before_poll.call
+              Workhorse.debug_log("[Job worker #{worker.id}] before_poll returned false, triggering worker shutdown")
               Thread.new { worker.shutdown }
               sleep
               next
@@ -65,6 +69,7 @@ module Workhorse
             poll
             sleep
           rescue Exception => e
+            Workhorse.debug_log("[Job worker #{worker.id}] Poller exception, shutting down: #{e.class}: #{e.message}")
             worker.log %(Poll encountered exception:\n#{e.message}\n#{e.backtrace.join("\n")})
             worker.log 'Worker shutting down...'
             Workhorse.on_exception.call(e) unless Workhorse.silence_poller_exceptions
@@ -73,6 +78,7 @@ module Workhorse
             break
           end
         end
+        Workhorse.debug_log("[Job worker #{worker.id}] Poller thread exiting")
       end
     end
 
@@ -82,8 +88,10 @@ module Workhorse
     # @raise [RuntimeError] If poller is not running
     def shutdown
       fail 'Poller is not running.' unless running?
+      Workhorse.debug_log("[Job worker #{worker.id}] Poller shutting down")
       @running = false
       wait
+      Workhorse.debug_log("[Job worker #{worker.id}] Poller shut down")
     end
 
     # Waits for the poller thread to complete.

data/lib/workhorse/worker.rb

@@ -302,18 +302,19 @@ module Workhorse
     def trap_log_reopen
       Signal.trap(LOG_REOPEN_SIGNAL) do
         Thread.new do
-          Workhorse.debug_log("[Job worker #{id}] HUP received, logger state before reopen: #{describe_logger(logger)}")
+          Workhorse.debug_log("[Job worker #{id}] #{LOG_REOPEN_SIGNAL} received, logger state before reopen: #{describe_logger(logger)}")
 
           logger&.reopen
           Workhorse.debug_log("[Job worker #{id}] Logger state after reopen: #{describe_logger(logger)}")
 
-          Workhorse.debug_log("[Job worker #{id}] HUP handling complete")
+          Workhorse.debug_log("[Job worker #{id}] #{LOG_REOPEN_SIGNAL} handling complete")
         rescue Exception => e
-          Workhorse.debug_log("[Job worker #{id}] Logger reopen failed: #{e.class}: #{e.message}")
+          Workhorse.debug_log("[Job worker #{id}] Logger reopen failed: #{e.class}: #{e.message}\n#{e.backtrace.join("\n")}")
           log %(Log reopen signal handler error: #{e.message}\n#{e.backtrace.join("\n")}), :error
           Workhorse.on_exception.call(e)
         end.join
       end
+      Workhorse.debug_log("[Job worker #{id}] Signal handler installed: #{LOG_REOPEN_SIGNAL}")
     end
 
     # Sets up signal handlers for graceful termination (TERM/INT signals).
@@ -334,6 +335,7 @@ module Workhorse
           end.join
         end
       end
+      Workhorse.debug_log("[Job worker #{id}] Signal handlers installed: #{SHUTDOWN_SIGNALS.join(', ')}")
     end
 
     # Initiates a soft restart of the worker.
@@ -385,6 +387,7 @@ module Workhorse
         # NOTE: Unlike trap_termination, we don't join here because soft_restart
         # is designed to be fire-and-forget (it spawns its own monitoring thread).
       end
+      Workhorse.debug_log("[Job worker #{id}] Signal handler installed: #{SOFT_RESTART_SIGNAL}")
     end
 
     # Returns a human-readable description of a logger's internal state.

data/lib/workhorse.rb

@@ -8,6 +8,16 @@ require 'workhorse/enqueuer'
 require 'workhorse/scoped_env'
 require 'workhorse/active_job_extension'
 
+# Prevent YJIT from being enabled when RUBY_YJIT_ENABLE is explicitly set to 0.
+# systemd's logrotate.service typically sets MemoryDenyWriteExecute=yes, which
+# prevents mprotect(PROT_EXEC). Rails unconditionally calls
+# RubyVM::YJIT.enable on boot, which triggers a fatal Ruby [BUG] in that
+# environment. Set RUBY_YJIT_ENABLE=0 in the logrotate postrotate script
+# to prevent this.
+if ENV['RUBY_YJIT_ENABLE'] == '0' && defined?(RubyVM::YJIT) && !RubyVM::YJIT.enabled?
+  RubyVM::YJIT.define_singleton_method(:enable) { |**| nil }
+end
+
 # Main Gem module.
 module Workhorse
   # Check if the available Arel version is greater or equal than 7.0.0

data/test/workhorse/yjit_test.rb

@@ -0,0 +1,37 @@
+require 'English'
+require 'test_helper'
+require 'bundler'
+
+class Workhorse::YjitTest < ActiveSupport::TestCase
+  YJIT_CHECK_SCRIPT = <<~RUBY.freeze
+    require 'bundler/setup'
+    require 'workhorse'
+    RubyVM::YJIT.enable
+    print RubyVM::YJIT.enabled?
+  RUBY
+
+  def test_yjit_not_enabled_when_ruby_yjit_enable_is_zero
+    skip 'RubyVM::YJIT.enable not available' unless defined?(RubyVM::YJIT) && RubyVM::YJIT.respond_to?(:enable)
+
+    # Sanity check: YJIT can actually be enabled in this environment
+    without_env = run_ruby_script(YJIT_CHECK_SCRIPT, 'RUBY_YJIT_ENABLE' => nil)
+    skip 'YJIT cannot be enabled in this environment' unless without_env == 'true'
+
+    # With RUBY_YJIT_ENABLE=0, RubyVM::YJIT.enable should be a no-op
+    with_env = run_ruby_script(YJIT_CHECK_SCRIPT, 'RUBY_YJIT_ENABLE' => '0')
+    assert_equal 'false', with_env, 'YJIT should not be enabled when RUBY_YJIT_ENABLE=0'
+  end
+
+  private
+
+  def run_ruby_script(script, env = {})
+    output = nil
+    Bundler.with_unbundled_env do
+      IO.popen(env, %w[bundle exec ruby -e] + [script], chdir: Rails.root.to_s, err: %i[child out]) do |io|
+        output = io.read.strip
+      end
+    end
+    assert $CHILD_STATUS.success?, "Ruby subprocess failed (exit #{$CHILD_STATUS.exitstatus}): #{output}"
+    output
+  end
+end

data/workhorse.gemspec

@@ -1,24 +1,24 @@
 # -*- encoding: utf-8 -*-
-# stub: workhorse 1.4.2 ruby lib
+# stub: workhorse 1.4.5 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "workhorse".freeze
-  s.version = "1.4.2"
+  s.version = "1.4.5".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Sitrox".freeze]
-  s.date = "2026-02-20"
-  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.date = "2026-05-09"
+  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, "test/workhorse/yjit_test.rb".freeze, "workhorse.gemspec".freeze]
   s.homepage = "https://github.com/sitrox/workhorse".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.4.6".freeze
+  s.rubygems_version = "3.5.18".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/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.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, "test/workhorse/yjit_test.rb".freeze]
 
   s.specification_version = 4
 
-  s.add_runtime_dependency(%q<activesupport>.freeze, [">= 7.0.0"])
-  s.add_runtime_dependency(%q<activerecord>.freeze, [">= 7.0.0"])
-  s.add_runtime_dependency(%q<concurrent-ruby>.freeze, [">= 0"])
+  s.add_runtime_dependency(%q<activesupport>.freeze, [">= 7.0.0".freeze])
+  s.add_runtime_dependency(%q<activerecord>.freeze, [">= 7.0.0".freeze])
+  s.add_runtime_dependency(%q<concurrent-ruby>.freeze, [">= 0".freeze])
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: workhorse
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.4.5
 platform: ruby
 authors:
 - Sitrox
 bindir: bin
 cert_chain: []
-date: 2026-02-20 00:00:00.000000000 Z
+date: 2026-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -99,6 +99,7 @@ files:
 - test/workhorse/poller_test.rb
 - test/workhorse/pool_test.rb
 - test/workhorse/worker_test.rb
+- test/workhorse/yjit_test.rb
 - workhorse.gemspec
 homepage: https://github.com/sitrox/workhorse
 licenses:
@@ -133,3 +134,4 @@ test_files:
 - test/workhorse/poller_test.rb
 - test/workhorse/pool_test.rb
 - test/workhorse/worker_test.rb
+- test/workhorse/yjit_test.rb