workhorse 1.2.4 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e00bf821fc0315533d96961d5688b12f6ce20aa70ea84ddb336bbd2a5dac3991
-  data.tar.gz: 28e9bd8f95d29eb080746ecfa7b9021a4488af1edf9b2023a68f0e98950d9d98
+  metadata.gz: 36904c2ff67ab30f876e47515dfd81ccb97715a6e3d563ba93bd59422374d660
+  data.tar.gz: 0c9c66eb75727e78fc842e1a30de12876da67a571aa255855e3ae1e63c27f847
 SHA512:
-  metadata.gz: c1d9ce641718690cafd39d79e795d487e90aba85c46c46d1a3fbffde99527041160d02831c7da36fbfebca1feff38873e9f6ab31491e6e35aaba9fea5ba06363
-  data.tar.gz: 92174a5e2ee2882a2ed5f0f46530d773c029e60eb9632cb189e6b7b6bbe3684b3f5e52f35a710aaf013ed6e698ee63962f5b6d9f220cb0fe42ab7305253bec95
+  metadata.gz: 0d57c98c31ad7c25f4ad267fe3caa21ae831e986579fef5f2f848c21a7977c0790b461e3372d4cff5e8e89efdb7a0774f06a90542bf0fb4c87baabe8c472ad06
+  data.tar.gz: c99c9d68c24dcccf1bdd164c066466a9c68fa94c7f66dbdc14986dc841e99c0361e32d53a0e2a85226de9c3580ea295254e2c4cb49cd53e974fc28150d3c6e0b

data/.github/workflows/ruby.yml

@@ -0,0 +1,36 @@
+name: Build
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['2.5.1', '2.6.2', '2.7.1', '3.0.1']
+    env:
+      DB_DATABASE: workhorse
+      DB_USER: root
+      DB_PASSWORD: 'root'
+      DB_HOST: localhost
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Startup database
+      run: |
+        sudo /etc/init.d/mysql start
+        mysql -u${{ env.DB_USER }} -p${{ env.DB_PASSWORD }} -e 'CREATE DATABASE ${{ env.DB_DATABASE }};'
+    - name: Run rake tests
+      run: bundle exec rake test TESTOPTS='--verbose'
+    - name: Run rubocop
+      run: bundle exec rubocop

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # Workhorse Changelog
 
+## 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
+  Workhorse processes which in turn reopen the log files. This is particularly
+  useful to call after log files have been rotated, e.g. using `logrotate`.
+
+  Sitrox reference: #64690.
+
+## 1.2.5 - 2021-11-01
+
+* Add config settings for configuring {Workhorse::Jobs::DetectStaleJobsJob}:
+
+  * `config.stale_detection_locked_to_started_threshold`
+  * `config.stale_detection_run_time_threshold`
+
 ## 1.2.4 - 2021-06-08
 
 * Add `workhorse_db_job` load hook

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Sitrox
+Copyright (c) 2017 - 2022 Sitrox
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/sitrox/workhorse.svg?branch=master)](https://travis-ci.org/sitrox/workhorse)
+[![Build](https://github.com/sitrox/workhorse/actions/workflows/ruby.yml/badge.svg)](https://github.com/sitrox/workhorse/actions/workflows/ruby.yml)
 [![Gem Version](https://badge.fury.io/rb/workhorse.svg)](https://badge.fury.io/rb/workhorse)
 
 # Workhorse
@@ -107,10 +107,15 @@ method `Workhorse.enqueue_op`:
 Workhorse.enqueue_op Operations::Jobs::CleanUpDatabase, { queue: :maintenance, priority: 2 }, quiet: true
 ```
 
-Params passed using the second argument will be used for operation instantiation
-at job execution.
+The first argument of the method is the Operation you want to run. Params passed in
+using the second argument will be used by Workhorse and params passed using the
+third argument will be used for operation instantiation at job execution, i.e.:
 
-If you do not want to pass any params to the operation, just omit the second hash:
+```ruby
+Workhorse.enqueue_op <Operation Class Name>, { <Workhorse Options> }, { <RailsOps Options> }
+```
+
+If you do not want to pass any params to the operation, just omit the third hash:
 
 ```ruby
 Workhorse.enqueue_op Operations::Jobs::CleanUpDatabase, queue: :maintenance, priority: 2
@@ -436,4 +441,4 @@ Please consult the [FAQ](FAQ.md).
 
 ## Copyright
 
-Copyright © 2021 Sitrox. See `LICENSE` for further details.
+Copyright © 2017 - 2022 Sitrox. See `LICENSE` for further details.

data/VERSION

@@ -1 +1 @@
-1.2.4
+1.2.7

data/lib/workhorse/daemon/shell_handler.rb

@@ -26,6 +26,8 @@ module Workhorse
           exit daemon.watch
         when 'restart'
           exit daemon.restart
+        when 'restart-logging'
+          exit daemon.restart_logging
         when 'usage'
           usage
           exit 99
@@ -68,12 +70,17 @@ Options:
   restart
     Shortcut for consecutive 'stop' and 'start'.
 
+  restart-logging
+    Re-opens log files, useful e.g. after the log files have been moved or
+    removed by log rotation.
+
   usage
     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
 
@@ -120,6 +120,24 @@ module Workhorse
       return start
     end
 
+    def restart_logging
+      code = 0
+
+      for_each_worker do |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 = 2
+        end
+      end
+
+      return code
+    end
+
     private
 
     def for_each_worker(&block)
@@ -150,6 +168,10 @@ module Workhorse
       File.delete(pid_file)
     end
 
+    def hup_worker(pid)
+      Process.kill('HUP', pid)
+    end
+
     def process_name(worker)
       if defined?(Rails)
         path = Rails.root

data/lib/workhorse/jobs/detect_stale_jobs_job.rb

@@ -1,18 +1,22 @@
 module Workhorse::Jobs
+  # This job picks up jobs that remained `locked` or `started` (running) for
+  # more than a certain amount of time. If any of these jobs are found, an
+  # exception is thrown (which may cause a notification if you configured
+  # `on_exception` accordingly).
+  #
+  # The thresholds are obtained from the configuration options
+  # {Workhorse.stale_detection_locked_to_started_threshold
+  # config.stale_detection_locked_to_started_threshold} and
+  # {Workhorse.stale_detection_run_time_threshold
+  # config.stale_detection_run_time_threshold}.
   class DetectStaleJobsJob
-    # Instantiates a new stale detection job.
-    #
-    # @param locked_to_started_threshold [Integer] 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.
-    # @param run_time_threshold [Integer] 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.
-    def initialize(locked_to_started_threshold: 3 * 60, run_time_threshold: 12 * 60)
-      @locked_to_started_threshold = locked_to_started_threshold
-      @run_time_threshold = run_time_threshold
+    # @private
+    def initialize
+      @locked_to_started_threshold = Workhorse.stale_detection_locked_to_started_threshold
+      @run_time_threshold          = Workhorse.stale_detection_run_time_threshold
     end
 
+    # @private
     def perform
       messages = []
 

data/lib/workhorse/worker.rb

@@ -2,6 +2,7 @@ module Workhorse
   class Worker
     LOG_LEVELS = %i[fatal error warn info debug].freeze
     SHUTDOWN_SIGNALS = %w[TERM INT].freeze
+    LOG_REOPEN_SIGNAL = 'HUP'.freeze
 
     attr_reader :queues
     attr_reader :state
@@ -87,6 +88,7 @@ module Workhorse
         log 'Started up'
 
         trap_termination if @auto_terminate
+        trap_log_reopen
       end
     end
 
@@ -152,6 +154,18 @@ module Workhorse
       end
     end
 
+    def trap_log_reopen
+      Signal.trap(LOG_REOPEN_SIGNAL) do
+        Thread.new do
+          logger.reopen
+
+          if defined?(ActiveRecord::Base) && ActiveRecord::Base.logger && ActiveRecord::Base.logger != logger
+            ActiveRecord::Base.logger.reopen
+          end
+        end.join
+      end
+    end
+
     def trap_termination
       SHUTDOWN_SIGNALS.each do |signal|
         Signal.trap(signal) do

data/lib/workhorse.rb

@@ -45,6 +45,18 @@ module Workhorse
   mattr_accessor :perform_jobs_in_tx
   self.perform_jobs_in_tx = true
 
+  # 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
+
   def self.setup
     yield self
   end

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/lib/test_helper.rb

@@ -32,7 +32,7 @@ class WorkhorseTest < ActiveSupport::TestCase
   end
 
   def with_worker(options = {})
-    w = Workhorse::Worker.new(options)
+    w = Workhorse::Worker.new(**options)
     w.start
     begin
       yield(w)

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,15 +1,15 @@
 # -*- encoding: utf-8 -*-
-# stub: workhorse 1.2.4 ruby lib
+# stub: workhorse 1.2.7 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "workhorse".freeze
-  s.version = "1.2.4"
+  s.version = "1.2.7"
 
   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 = "2021-06-08"
-  s.files = [".gitignore".freeze, ".releaser_config".freeze, ".rubocop.yml".freeze, ".travis.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.date = "2022-04-07"
+  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
   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/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]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workhorse
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 1.2.7
 platform: ruby
 authors:
 - Sitrox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-08 00:00:00.000000000 Z
+date: 2022-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -184,10 +184,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".releaser_config"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - FAQ.md
 - Gemfile
@@ -245,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: Multi-threaded job backend with database queuing for ruby.

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-rvm:
- - 2.5.0
- - 2.6.0
-services:
- - mysql
-before_install:
-  - mysql -e 'CREATE DATABASE workhorse;'
-script:
- - bundle install
- - bundle exec rake test TESTOPTS='--verbose'
- - bundle exec rubocop