workhorse 1.2.7 → 1.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36904c2ff67ab30f876e47515dfd81ccb97715a6e3d563ba93bd59422374d660
-  data.tar.gz: 0c9c66eb75727e78fc842e1a30de12876da67a571aa255855e3ae1e63c27f847
+  metadata.gz: 2e55e6209a84d648692e6aa3a883ff1536282525b2d5dd779c77614809459fb8
+  data.tar.gz: '05593223d445e9999f605464974a487611c6e6883f290b492038076e33ef86f3'
 SHA512:
-  metadata.gz: 0d57c98c31ad7c25f4ad267fe3caa21ae831e986579fef5f2f848c21a7977c0790b461e3372d4cff5e8e89efdb7a0774f06a90542bf0fb4c87baabe8c472ad06
-  data.tar.gz: c99c9d68c24dcccf1bdd164c066466a9c68fa94c7f66dbdc14986dc841e99c0361e32d53a0e2a85226de9c3580ea295254e2c4cb49cd53e974fc28150d3c6e0b
+  metadata.gz: c3a3eea6bfcbff533c9c98c2b9f0750eb1088ec2b616d801ac90c12c3a6afd5010fa7f4eac64df9a728b5fb92d5d43c4bb983708e32f0b6fa01bba1cf0ced5e9
+  data.tar.gz: 0b357f5d1abe994f46b9ea2736d9cf613ea26c137f5814c7268bb33794f665cd63c90e1e8ed3a52c868582cb8b5117cd2f524299ab693a151deb4ccb0ef34015

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Workhorse Changelog
 
+## 1.2.9 - 2022-12-08
+
+* Properly detach forked worker processes from parent process to prevent zombie
+  processes
+
+* Reopen STDIN, STDOUT and STDERR pipes to `/dev/null` after forking
+  (daemonizing) worker processes. This detaches from the current TTY which
+  prevents the issue that SSH connections sometimes could not be closed when
+  having daemonized new worker processes.
+
+  Sitrox reference: #107576.
+
+## 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

data/VERSION

@@ -1 +1 @@
-1.2.7
+1.2.9

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
 

data/lib/workhorse/daemon.rb

@@ -147,9 +147,17 @@ module Workhorse
     def start_worker(worker)
       pid = fork do
         $0 = process_name(worker)
+
+        # Reopen pipes to prevent #107576
+        STDIN.reopen File.open('/dev/null', 'r')
+        null_out = File.open '/dev/null', 'w'
+        STDOUT.reopen null_out
+        STDERR.reopen null_out
+
         worker.block.call
       end
       IO.write(pid_file_for(worker), pid)
+      Process.detach(pid)
     end
 
     def stop_worker(pid_file, pid, kill = false)

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/workhorse.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: workhorse 1.2.7 ruby lib
+# stub: workhorse 1.2.9 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "workhorse".freeze
-  s.version = "1.2.7"
+  s.version = "1.2.9"
 
   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-04-07"
+  s.date = "2022-12-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/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.7
+  version: 1.2.9
 platform: ruby
 authors:
 - Sitrox
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-07 00:00:00.000000000 Z
+date: 2022-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -178,8 +178,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -227,10 +227,10 @@ files:
 - test/workhorse/pool_test.rb
 - test/workhorse/worker_test.rb
 - workhorse.gemspec
-homepage: 
+homepage:
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -245,8 +245,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.3.11
+signing_key:
 specification_version: 4
 summary: Multi-threaded job backend with database queuing for ruby.
 test_files: