workhorse 1.4.4 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 02c3e3163a1b21b8a983c756e9be5e916b2cc7017401ab3484905c04fe56293f
-  data.tar.gz: 52ffb9742bf24ea226e3aa3f7edf2f0a5deecdefa57310c3176a40bec00f227f
+  metadata.gz: d1159cb21bdb8fcb4a31ae5857ad5dcc16191879ac6f8025830b97cb6627df8c
+  data.tar.gz: c963ee57e992cf754cde1e91df6a93d7d207aff663b3bbdae443050605918e63
 SHA512:
-  metadata.gz: ce5cd0d30660a0bb9829c84957e76589d5e65e9c47795c7ff414101df2b57f8661fbf01cd4b73bb4a69b7901f4fc43796a3a43e6f400c31b5c1a5b6b1eff8e56
-  data.tar.gz: 3594464e0fd00d036c9fe163daeea5a17d78d2fcd79095be05dac95753fbce43530812881529052af28917240920f70f706b708f7902d38636caa4e5c6995d3a
+  metadata.gz: 05b57e6750c6bdf4d693d503f0d0659f7dcb23c49c6a3f11d47ed31ba665cf5b5bae1f1aa6c6ea925fa35125260da37e9b31aeccd644e9cbefce26c50284104b
+  data.tar.gz: f9832222d5b3bd0edb56089c06a6eb1ba36ef4d496580aab83d75a75760c583dd2b74647a0d196be58b3e4f5b91096228bee0cbb7df7cfe9b6efbb7bc92bb32e

data/.releaser_config

@@ -1,3 +1,3 @@
 version_file: VERSION
-always_from_master: false
+always_from_master: true
 gem_style: github

data/CHANGELOG.md

@@ -1,5 +1,44 @@
 # Workhorse Changelog
 
+## 1.5.0 - 2026-07-01
+
+* Change `DetectStaleJobsJob` to accept `locked_to_started_threshold` and
+  `run_time_threshold` as keyword arguments instead of reading from global
+  configuration. The config options `Workhorse.stale_detection_locked_to_started_threshold`
+  and `Workhorse.stale_detection_run_time_threshold` have been removed.
+
+  If you were previously configuring thresholds globally:
+
+  ```ruby
+  # Before
+  Workhorse.setup do |config|
+    config.stale_detection_locked_to_started_threshold = 300
+    config.stale_detection_run_time_threshold = 3600
+  end
+  Workhorse.enqueue(DetectStaleJobsJob.new)
+
+  # After
+  Workhorse.enqueue(DetectStaleJobsJob.new(locked_to_started_threshold: 300, run_time_threshold: 3600))
+  ```
+
+* Add `queues` keyword argument to `DetectStaleJobsJob` to restrict stale job
+  detection to specific queues. When omitted, all queues are checked (existing
+  behavior).
+
+  Sitrox reference: #132256.
+
+## 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.

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.4
+1.5.0

data/lib/workhorse/daemon/shell_handler.rb

@@ -88,6 +88,7 @@ module Workhorse
         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
@@ -145,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

@@ -310,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/jobs/detect_stale_jobs_job.rb

@@ -5,24 +5,27 @@ module Workhorse::Jobs
   # exception is thrown (which may cause a notification if you configured
   # {Workhorse.on_exception} accordingly).
   #
-  # The thresholds are obtained from the configuration options
-  # {Workhorse.stale_detection_locked_to_started_threshold} and
-  # {Workhorse.stale_detection_run_time_threshold}.
-  #
-  # @example Schedule stale job detection
+  # @example Schedule stale job detection with default thresholds
   #   Workhorse.enqueue(DetectStaleJobsJob.new)
   #
-  # @example Configure thresholds
-  #   Workhorse.setup do |config|
-  #     config.stale_detection_locked_to_started_threshold = 300  # 5 minutes
-  #     config.stale_detection_run_time_threshold = 3600         # 1 hour
-  #   end
+  # @example Schedule with custom thresholds
+  #   Workhorse.enqueue(DetectStaleJobsJob.new(locked_to_started_threshold: 300, run_time_threshold: 3600))
+  #
+  # @example Only check specific queues
+  #   Workhorse.enqueue(DetectStaleJobsJob.new(queues: ['mailer', 'reports']))
   class DetectStaleJobsJob
     # Creates a new stale job detection job.
-    # Reads configuration thresholds at initialization time.
-    def initialize
-      @locked_to_started_threshold = Workhorse.stale_detection_locked_to_started_threshold
-      @run_time_threshold          = Workhorse.stale_detection_run_time_threshold
+    #
+    # @param locked_to_started_threshold [Integer] Maximum number of seconds a job is
+    #   allowed to stay 'locked' before an exception is raised. Set to 0 to skip this check.
+    # @param run_time_threshold [Integer] Maximum number of seconds a job is allowed to
+    #   run before an exception is raised. Set to 0 to skip this check.
+    # @param queues [Array<String>, nil] If given, only check jobs in these queues.
+    #   If `nil` (default), all queues are checked.
+    def initialize(locked_to_started_threshold: 3 * 60, run_time_threshold: 12 * 60, queues: nil)
+      @locked_to_started_threshold = locked_to_started_threshold
+      @run_time_threshold          = run_time_threshold
+      @queues                      = queues
     end
 
     # Executes the stale job detection.
@@ -38,6 +41,7 @@ module Workhorse::Jobs
       if @locked_to_started_threshold != 0
         rel = Workhorse::DbJob.locked
         rel = rel.where('locked_at < ?', @locked_to_started_threshold.seconds.ago)
+        rel = rel.where(queue: @queues) if @queues
         ids = rel.pluck(:id)
 
         unless ids.empty?
@@ -50,6 +54,7 @@ module Workhorse::Jobs
       if @run_time_threshold != 0
         rel = Workhorse::DbJob.started
         rel = rel.where('started_at < ?', @run_time_threshold.seconds.ago)
+        rel = rel.where(queue: @queues) if @queues
         ids = rel.pluck(:id)
 
         unless ids.empty?

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
@@ -88,18 +98,6 @@ module Workhorse
   mattr_accessor :clean_stuck_jobs
   self.clean_stuck_jobs = false
 
-  # This setting is for {Workhorse::Jobs::DetectStaleJobsJob} and specifies the
-  # maximum number of seconds a job is allowed to stay 'locked' before this job
-  # throws an exception. Set this to 0 to skip this check.
-  mattr_accessor :stale_detection_locked_to_started_threshold
-  self.stale_detection_locked_to_started_threshold = 3 * 60
-
-  # This setting is for {Workhorse::Jobs::DetectStaleJobsJob} and specifies the
-  # maximum number of seconds a job is allowed to run before this job throws an
-  # exception. Set this to 0 to skip this check.
-  mattr_accessor :stale_detection_run_time_threshold
-  self.stale_detection_run_time_threshold = 12 * 60
-
   # Maximum memory usage per {Workhorse::Worker} process in MB.
   # When exceeded, the watch command will restart the worker. Set to 0 to disable.
   #

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.4 ruby lib
+# stub: workhorse 1.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "workhorse".freeze
-  s.version = "1.4.4"
+  s.version = "1.5.0".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-04-28"
-  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-07-01"
+  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.4
+  version: 1.5.0
 platform: ruby
 authors:
 - Sitrox
 bindir: bin
 cert_chain: []
-date: 2026-04-28 00:00:00.000000000 Z
+date: 2026-07-01 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:
@@ -118,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.2
+rubygems_version: 4.0.11
 specification_version: 4
 summary: Multi-threaded job backend with database queuing for ruby.
 test_files:
@@ -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