workhorse 1.2.6 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b1cc4ec91d5c8cde5e214aff39f298f3fa9591b6693250158250fd8de87dd19
-  data.tar.gz: e333e77dc8bb0a24b809324a54d014f56b9373ccc0f16dc5f58052fa7bd1bbe3
+  metadata.gz: 9e82524a9a4ac0e41a41fe2a1947e3a9e1b58efc96f750f1dfa0ef5ebeeaad39
+  data.tar.gz: a31b41e50239da3e0b1bb416d2e5d1c649083ad7fc30b7b2747e4ec9bd877931
 SHA512:
-  metadata.gz: af21dcc9cf0672dc71ae1b5ec2d61e6245cf6a24fc4b599d1c21c36c06e20cbc46b59248ea0b6232589eced87305c408cbe7254e6817fdb5bb2ec294181e87a7
-  data.tar.gz: 368889c80a413ad8e0343a5227ba70081470931e427ca7ec7c1b1bad6cee59af2a2f9bffe31fb879f1d1a81f2233f506cb038d896dce08b2551733873c013f1f
+  metadata.gz: bcf8c18e959ecfe4ea1db71b3e1cc59a88325b5d70be33220cfe4931f92fb982548514a0f47576f792a33659011a7956f6c0075544681f0f312816428c1f5f20
+  data.tar.gz: 557a630d4681f635bfde37da63838a900f6938b6a38f7b188e94a1c4c293972020e91a183dc173fbe02be4d08ddee9a868074c70d219af65a4a7408050211247

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Workhorse Changelog
 
+## 1.2.8 - 2022-11-23
+
+* Add configuration option `lock_shell_commands`. This defaults to `true` to
+  retain backwards compatibility and allows turning off file locking for shell
+  commands (e.g. for cases where the locking is done outside of workhorse like
+  in a wrapper script).
+
+  Sitrox reference: #106900.
+
+## 1.2.7 - 2022-04-07
+
+* Adapt exit status of shell handler to return with exit code `2` when a worker
+  is in an unexpected status. Previously, this lead to exit code `1` and made it
+  hard to distinguish from fatal errors.
+
 ## 1.2.6 - 2022-01-11
 
 * Add daemon command `restart-logging`, which sends a `HUP` interrupt to all

data/VERSION

@@ -1 +1 @@
-1.2.6
+1.2.8

data/lib/generators/workhorse/templates/config/initializers/workhorse.rb

@@ -12,6 +12,10 @@ Workhorse.setup do |config|
   #   ActiveRecord::Base.transaction(*args, &block)
   # end
 
+  # Set this to false in order to disable file-based locking for the Workhorse
+  # shell handlers (all the commands such as 'start', 'stop', ...).
+  # config.lock_shell_commands = true
+
   # Enable and configure this to specify a callback for handling worker
   # exceptions:
   #

data/lib/workhorse/daemon/shell_handler.rb

@@ -6,9 +6,13 @@ module Workhorse
         exit 99
       end
 
-      lockfile_path = options.delete(:lockfile) || 'workhorse.lock'
-      lockfile = File.open(lockfile_path, 'a')
-      lockfile.flock(File::LOCK_EX || File::LOCK_NB)
+      if Workhorse.lock_shell_commands
+        lockfile_path = options.delete(:lockfile) || 'workhorse.lock'
+        lockfile = File.open(lockfile_path, 'a')
+        lockfile.flock(File::LOCK_EX || File::LOCK_NB)
+      else
+        lockfile = nil
+      end
 
       daemon = Workhorse::Daemon.new(**options, &block)
 
@@ -40,7 +44,7 @@ module Workhorse
         warn "#{e.message}\n#{e.backtrace.join("\n")}"
         exit 99
       ensure
-        lockfile.flock(File::LOCK_UN)
+        lockfile&.flock(File::LOCK_UN)
       end
     end
 
@@ -78,8 +82,9 @@ Options:
     Show this message
 
 Exit status:
- 0  if OK,
- 1  if at least one worker has an unexpected status,
+ 0 if OK,
+ 1 on fatal errors outside of workhorse,
+ 2 if at least one worker has an unexpected status,
  99 on all other errors.
 USAGE
     end

data/lib/workhorse/daemon.rb

@@ -46,7 +46,7 @@ module Workhorse
 
         if pid_file && pid
           warn "Worker ##{worker.id} (#{worker.name}): Already started (PID #{pid})" unless quiet
-          code = 1
+          code = 2
         elsif pid_file
           File.delete pid_file
           puts "Worker ##{worker.id} (#{worker.name}): Starting (stale pid file)" unless quiet
@@ -74,7 +74,7 @@ module Workhorse
           puts "Worker (#{worker.name}) ##{worker.id}: Already stopped (stale PID file)"
         else
           warn "Worker (#{worker.name}) ##{worker.id}: Already stopped"
-          code = 1
+          code = 2
         end
       end
 
@@ -91,10 +91,10 @@ module Workhorse
           puts "Worker ##{worker.id} (#{worker.name}): Running" unless quiet
         elsif pid_file
           warn "Worker ##{worker.id} (#{worker.name}): Not running (stale PID file)" unless quiet
-          code = 1
+          code = 2
         else
           warn "Worker ##{worker.id} (#{worker.name}): Not running" unless quiet
-          code = 1
+          code = 2
         end
       end
 
@@ -124,14 +124,14 @@ module Workhorse
       code = 0
 
       for_each_worker do |worker|
-        pid_file, pid = read_pid(worker)
+        _pid_file, pid = read_pid(worker)
 
         begin
           Process.kill 'HUP', pid
           puts "Worker (#{worker.name}) ##{worker.id}: Sent signal for restart-logging"
         rescue Errno::ESRCH
           warn "Worker (#{worker.name}) ##{worker.id}: Could not send signal for restart-logging, process not found"
-          code = 1
+          code = 2
         end
       end
 

data/lib/workhorse.rb

@@ -31,6 +31,12 @@ module Workhorse
     # ExceptionNotifier.notify_exception(exception)
   end
 
+  # If set to `false`, shell handler (CLI) won't lock commands using a lockfile.
+  # You should generally only disable this if you are performing the locking
+  # yourself (e.g. in a wrapper script).
+  mattr_accessor :lock_shell_commands
+  self.lock_shell_commands = true
+
   # If set to `true`, the defined `on_exception` will not be called when the
   # poller encounters an exception and the worker has to be shut down. The
   # exception will still be logged.

data/test/active_job/queue_adapters/workhorse_adapter_test.rb

@@ -73,7 +73,7 @@ class ActiveJob::QueueAdapters::WorkhorseAdapterTest < WorkhorseTest
     work 0.5, polling_interval: 0.1
     assert_equal 'waiting', Workhorse::DbJob.first.state
 
-    work 1.5, polling_interval: 0.1
+    work 3, polling_interval: 0.1
     assert_equal 'succeeded', Workhorse::DbJob.first.reload.state
   end
 

data/test/workhorse/pool_test.rb

@@ -61,16 +61,16 @@ class Workhorse::PoolTest < WorkhorseTest
 
       assert_equal 0, on_idle_calls.value
 
-      p.post { sleep 0.2 }
       p.post { sleep 0.4 }
+      p.post { sleep 0.8 }
 
       sleep 0.1
       assert_equal 0, on_idle_calls.value
 
-      sleep 0.2
+      sleep 0.6
       assert_equal 1, on_idle_calls.value
 
-      sleep 0.1
+      sleep 0.9
       assert_equal 2, on_idle_calls.value
     end
   end

data/workhorse.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: workhorse 1.2.6 ruby lib
+# stub: workhorse 1.2.8 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "workhorse".freeze
-  s.version = "1.2.6"
+  s.version = "1.2.8"
 
   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 = "2022-01-11"
+  s.date = "2022-11-23"
   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/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.rubygems_version = "3.0.3".freeze
   s.summary = "Multi-threaded job backend with database queuing for ruby.".freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workhorse
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.8
 platform: ruby
 authors:
 - Sitrox
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-11 00:00:00.000000000 Z
+date: 2022-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -245,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.11
 signing_key:
 specification_version: 4
 summary: Multi-threaded job backend with database queuing for ruby.