workhorse 1.2.18 → 1.2.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec60662cb949157cad7c1c42704bff8299505f75ac993dc3fb4f95e0cb645e6a
-  data.tar.gz: 80d7fff31444778438ebc47c68e54d6a9291f4b7e68f2eaae30dc50d087d4fb2
+  metadata.gz: 5779f0370ad5f8c4c99389c7c089d45d68820e9f63703a7886b9b702ba3b9fd3
+  data.tar.gz: fd220b5a403be4a901446b9a1bc55d6acfaf8e6b5302a205d79a20f47951c6cf
 SHA512:
-  metadata.gz: c9e7940d6d0a38de896ca31a892a5fe4e9d08a607969ff998c916e1688353e4c8264267bc9f45725bfd0a00a5f2b8285748326151b343d24d54e18e20cba0021
-  data.tar.gz: b3c9d6a97f5d90811ea16fe1222b7608feeebefb78d777abd22c831a60fa3a3ec89aed4cbf374779dca959cb3e64a6030802bf909b82125f8db79f2f44d08c4c
+  metadata.gz: 66a64fc3dc59ed726cb7cdc4774c979bcfafb1246c67e52cac74ff87da9509369fababe6d294fb9943ad8c42a97a41d955277ae07b91e9491f07618a530d6dff
+  data.tar.gz: 1264727996bd00beb9d0f0968e82e34de174ee1529977f55ae87a5a47ec4a70d7c8caa93a3ed78e9816740fb894d748b022a1fe574303f63f9c497a2abf3454b

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Workhorse Changelog
 
+## 1.2.20 - 2024-06-17
+
+* Fix rails environment check
+
+  Sitrox reference: #125593.
+
+## 1.2.19 - 2024-05-07
+
+* Fix further compatibility issues with `ruby < 2.5`
+
+  Sitrox reference: #124538.
+
 ## 1.2.18 - 2024-05-07
 
 * Fix compatibility with `ruby < 2.5`

data/VERSION

@@ -1 +1 @@
-1.2.18
+1.2.20

data/lib/workhorse/daemon.rb

@@ -168,6 +168,8 @@ module Workhorse
     end
 
     def start_worker(worker)
+      check_rails_env if defined?(Rails)
+
       pid = fork do
         $0 = process_name(worker)
         # Reopen pipes to prevent #107576
@@ -244,5 +246,11 @@ module Workhorse
 
       return file, pid, active
     end
+
+    def check_rails_env
+      unless Rails.env.production?
+        warn 'WARNING: Always run workhorse workers in production environment. Other environments can lead to unexpected behavior.'
+      end
+    end
   end
 end

data/lib/workhorse/performer.rb

@@ -9,41 +9,45 @@ module Workhorse
     end
 
     def perform
-      fail 'Performer can only run once.' if @started
-      @started = true
-      perform!
-    rescue Exception => e
-      Workhorse.on_exception.call(e)
+      begin
+        fail 'Performer can only run once.' if @started
+        @started = true
+        perform!
+      rescue Exception => e
+        Workhorse.on_exception.call(e)
+      end
     end
 
     private
 
     def perform!
-      Thread.current[:workhorse_current_performer] = self
+      begin
+        Thread.current[:workhorse_current_performer] = self
 
-      ActiveRecord::Base.connection_pool.with_connection do
-        if defined?(Rails) && Rails.respond_to?(:application) && Rails.application && Rails.application.respond_to?(:executor)
-          Rails.application.executor.wrap do
+        ActiveRecord::Base.connection_pool.with_connection do
+          if defined?(Rails) && Rails.respond_to?(:application) && Rails.application && Rails.application.respond_to?(:executor)
+            Rails.application.executor.wrap do
+              perform_wrapped
+            end
+          else
             perform_wrapped
           end
-        else
-          perform_wrapped
         end
-      end
-    rescue Exception => e
-      # ---------------------------------------------------------------
-      # Mark job as failed
-      # ---------------------------------------------------------------
-      log %(#{e.message}\n#{e.backtrace.join("\n")}), :error
+      rescue Exception => e
+        # ---------------------------------------------------------------
+        # Mark job as failed
+        # ---------------------------------------------------------------
+        log %(#{e.message}\n#{e.backtrace.join("\n")}), :error
 
-      Workhorse.tx_callback.call do
-        log 'Mark failed', :debug
-        @db_job.mark_failed!(e)
-      end
+        Workhorse.tx_callback.call do
+          log 'Mark failed', :debug
+          @db_job.mark_failed!(e)
+        end
 
-      fail e
-    ensure
-      Thread.current[:workhorse_current_performer] = nil
+        fail e
+      ensure
+        Thread.current[:workhorse_current_performer] = nil
+      end
     end
 
     def perform_wrapped

data/lib/workhorse/poller.rb

@@ -141,60 +141,62 @@ module Workhorse
     end
 
     def with_global_lock(name: :workhorse, timeout: 2, &_block)
-      if @is_oracle
-        result = Workhorse::DbJob.connection.select_all(
-          "SELECT DBMS_LOCK.REQUEST(#{ORACLE_LOCK_HANDLE}, #{ORACLE_LOCK_MODE}, #{timeout}) FROM DUAL"
-        ).first.values.last
+      begin
+        if @is_oracle
+          result = Workhorse::DbJob.connection.select_all(
+            "SELECT DBMS_LOCK.REQUEST(#{ORACLE_LOCK_HANDLE}, #{ORACLE_LOCK_MODE}, #{timeout}) FROM DUAL"
+          ).first.values.last
 
-        success = result == 0
-      else
-        result = Workhorse::DbJob.connection.select_all(
-          "SELECT GET_LOCK(CONCAT(DATABASE(), '_#{name}'), #{timeout})"
-        ).first.values.last
-        success = result == 1
-      end
+          success = result == 0
+        else
+          result = Workhorse::DbJob.connection.select_all(
+            "SELECT GET_LOCK(CONCAT(DATABASE(), '_#{name}'), #{timeout})"
+          ).first.values.last
+          success = result == 1
+        end
 
-      if success
-        @global_lock_fails = 0
-        @max_global_lock_fails_reached = false
-      else
-        @global_lock_fails += 1
+        if success
+          @global_lock_fails = 0
+          @max_global_lock_fails_reached = false
+        else
+          @global_lock_fails += 1
 
-        unless @max_global_lock_fails_reached
-          worker.log 'Could not obtain global lock, retrying with next poll.', :warn
-        end
+          unless @max_global_lock_fails_reached
+            worker.log 'Could not obtain global lock, retrying with next poll.', :warn
+          end
 
-        if @global_lock_fails > Workhorse.max_global_lock_fails && !@max_global_lock_fails_reached
-          @max_global_lock_fails_reached = true
-
-          worker.log 'Could not obtain global lock, retrying with next poll. ' \
-                     'This will be the last such message for this worker until ' \
-                     'the issue is resolved.', :warn
-
-          message = "Worker reached maximum number of consecutive times (#{Workhorse.max_global_lock_fails}) " \
-                    "where the global lock could no be acquired within the specified timeout (#{timeout}). " \
-                    'A worker that obtained this lock may have crashed without ending the database ' \
-                    'connection properly. On MySQL, use "show processlist;" to see which connection(s) ' \
-                    'is / are holding the lock for a long period of time and consider killing them using ' \
-                    "MySQL's \"kill <Id>\" command. This message will be issued only once per worker " \
-                    'and may only be re-triggered if the error happens again *after* the lock has ' \
-                    'been solved in the meantime.'
-
-          worker.log message
-          exception = StandardError.new(message)
-          Workhorse.on_exception.call(exception)
+          if @global_lock_fails > Workhorse.max_global_lock_fails && !@max_global_lock_fails_reached
+            @max_global_lock_fails_reached = true
+
+            worker.log 'Could not obtain global lock, retrying with next poll. ' \
+              'This will be the last such message for this worker until ' \
+              'the issue is resolved.', :warn
+
+            message = "Worker reached maximum number of consecutive times (#{Workhorse.max_global_lock_fails}) " \
+              "where the global lock could no be acquired within the specified timeout (#{timeout}). " \
+              'A worker that obtained this lock may have crashed without ending the database ' \
+              'connection properly. On MySQL, use "show processlist;" to see which connection(s) ' \
+              'is / are holding the lock for a long period of time and consider killing them using ' \
+              "MySQL's \"kill <Id>\" command. This message will be issued only once per worker " \
+              'and may only be re-triggered if the error happens again *after* the lock has ' \
+              'been solved in the meantime.'
+
+            worker.log message
+            exception = StandardError.new(message)
+            Workhorse.on_exception.call(exception)
+          end
         end
-      end
 
-      return unless success
+        return unless success
 
-      yield
-    ensure
-      if success
-        if @is_oracle
-          Workhorse::DbJob.connection.execute("SELECT DBMS_LOCK.RELEASE(#{ORACLE_LOCK_HANDLE}) FROM DUAL")
-        else
-          Workhorse::DbJob.connection.execute("SELECT RELEASE_LOCK(CONCAT(DATABASE(), '_#{name}'))")
+        yield
+      ensure
+        if success
+          if @is_oracle
+            Workhorse::DbJob.connection.execute("SELECT DBMS_LOCK.RELEASE(#{ORACLE_LOCK_HANDLE}) FROM DUAL")
+          else
+            Workhorse::DbJob.connection.execute("SELECT RELEASE_LOCK(CONCAT(DATABASE(), '_#{name}'))")
+          end
         end
       end
     end

data/lib/workhorse/pool.rb

@@ -34,10 +34,12 @@ module Workhorse
         active_threads.increment
 
         @executor.post do
-          yield
-        ensure
-          active_threads.decrement
-          @on_idle.try(:call)
+          begin
+            yield
+          ensure
+            active_threads.decrement
+            @on_idle.try(:call)
+          end
         end
       end
     end

data/lib/workhorse/worker.rb

@@ -67,8 +67,6 @@ module Workhorse
       if instant_repolling
         @pool.on_idle { @poller.instant_repoll! }
       end
-
-      check_rails_env if defined?(Rails)
     end
 
     def log(text, level = :info)
@@ -144,19 +142,23 @@ module Workhorse
     end
 
     def perform(db_job_id)
-      mutex.synchronize do
-        assert_state! :running
-        log "Posting job #{db_job_id} to thread pool"
-
-        @pool.post do
-          Workhorse::Performer.new(db_job_id, self).perform
-        rescue Exception => e
-          log %(#{e.message}\n#{e.backtrace.join("\n")}), :error
-          Workhorse.on_exception.call(e)
+      begin
+        mutex.synchronize do
+          assert_state! :running
+          log "Posting job #{db_job_id} to thread pool"
+
+          @pool.post do
+            begin
+              Workhorse::Performer.new(db_job_id, self).perform
+            rescue Exception => e
+              log %(#{e.message}\n#{e.backtrace.join("\n")}), :error
+              Workhorse.on_exception.call(e)
+            end
+          end
         end
+      rescue Exception => e
+        Workhorse.on_exception.call(e)
       end
-    rescue Exception => e
-      Workhorse.on_exception.call(e)
     end
 
     private
@@ -192,12 +194,6 @@ module Workhorse
       return mem.to_i / 1024
     end
 
-    def check_rails_env
-      unless Rails.env.production?
-        warn 'WARNING: Always run workhorse workers in production environment. Other environments can lead to unexpected behavior.'
-      end
-    end
-
     def trap_log_reopen
       Signal.trap(LOG_REOPEN_SIGNAL) do
         Thread.new do

data/workhorse.gemspec

@@ -1,14 +1,14 @@
 # -*- encoding: utf-8 -*-
-# stub: workhorse 1.2.18 ruby lib
+# stub: workhorse 1.2.20 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "workhorse".freeze
-  s.version = "1.2.18"
+  s.version = "1.2.20"
 
   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 = "2024-05-07"
+  s.date = "2024-06-17"
   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.rubygems_version = "3.4.6".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.18
+  version: 1.2.20
 platform: ruby
 authors:
 - Sitrox
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-07 00:00:00.000000000 Z
+date: 2024-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler