workhorse 1.2.13 → 1.2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c528399ac973ce36bd6bdb993ac2d234eddf8836b8fc997031dd4009487ed252
-  data.tar.gz: 8482be9f53a1c8b5eb238784a6f350f79a0bf7b5c2c42a3921667ef2a82340d6
+  metadata.gz: 0a1665e70227e5e6fad1115523a94c7457a9b9b7216e10d2092c0326817bfd44
+  data.tar.gz: f6a1d79bf0f55a8f2756934bb58ab3aefb83ef6369ffec7c783ef8cd6dfa50b0
 SHA512:
-  metadata.gz: 83b44c60c1789755e2d09a2f32ea71728287d54ab1904bf5a6f9e88f225d02da0280d784e56d3352c336efb292aa864f841b85d1c085df7425878551bdec27ed
-  data.tar.gz: a554b93bc1c0c18bd1472981e2a84e80f79dfc0561f03c89839cc9e4f32d6480cb4fa327cd046cc8d9582a142af1092a4ffb1c5c492cb79fbb5af2fb3ebef725
+  metadata.gz: 8dde03d8f2a8f5c05307787433ef308c99c34ad2ab59d7c2edcc352c0428241a48ee5d0356f4a9a35a0de7dac876d60e1c09cd3c016915929f786a387a9e75e6
+  data.tar.gz: b380dff403c8c10df7c2472422e462d66d40bff3796cbee09e81c63c11eafe4ba4a0d0dd361828f5a984f738fe30744b6fcea3616b6a54a9d1f7df016b21219f

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Workhorse Changelog
 
+## 1.2.14 - 2023-08-23
+
+* Add documentation for transaction handling.
+
+* Add support for skipping transactions on a per-job basis
+
 ## 1.2.13 - 2023-02-20
 
 * Add the `config.max_global_lock_fails` setting (defaults to 10). If a

data/README.md

@@ -278,6 +278,57 @@ polling interval.
 This setting is recommended for all setups and may eventually be enabled by
 default.
 
+## Transactions
+
+By default, each job is run in an individual database transaction. An exception
+to this is when performing ActiveJob jobs using `perform_now`, where no
+transaction is created.
+
+### Transaction callback
+
+By default, transactions are created using `ActiveRecord::Base.transaction { ...
+}`. You can customize this using the setting `config.tx_callback` in your
+`config/initializers/workhorse.rb` (see commented out section in the generated
+configuration file).
+
+### Turning off transactions
+
+You can turn off transaction wrapping in the following ways:
+
+- Globally using the setting `config.perform_jobs_in_tx = false` in your
+  `config/initializers/workhorse.rb`. This is not recommended as running jobs
+  without transactions can potentially be harmful.
+
+- On a per-job basis. This is the recommended approach for jobs that either open
+  up their own transaction(s) or jobs that explicitly do not need a transaction
+  for whatever reason.
+
+  Usage of this feature depends on whether you are dealing with an ActiveJob job
+  or a plain Workhorse job class.
+
+  For ActiveJob:
+
+  1. Add the following mixin to your job class (usually `ApplicationJob`):
+
+     ```ruby
+     class ApplicationJob
+       include Workhorse::ActiveJobExtension
+     end
+     ```
+
+  2. Use the DSL-method `skip_tx` inside the job classes where you want to
+     disable transaction wrapping, e.g.:
+
+     ```ruby
+     class MyJob < ApplicationJob
+       skip_tx
+
+       def perform
+         # Something without transaction
+       end
+     end
+     ```
+
 ## Exception handling
 
 Per default, exceptions occurring in a worker thread will only be visible in the

data/VERSION

@@ -1 +1 @@
-1.2.13
+1.2.14

data/lib/workhorse/active_job_extension.rb

@@ -0,0 +1,20 @@
+module Workhorse
+  module ActiveJobExtension
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_skip_tx
+      self._skip_tx = false
+    end
+
+    module ClassMethods
+      def skip_tx
+        self._skip_tx = true
+      end
+
+      def skip_tx?
+        _skip_tx
+      end
+    end
+  end
+end

data/lib/workhorse/jobs/run_active_job.rb

@@ -1,9 +1,15 @@
 module Workhorse::Jobs
   class RunActiveJob
+    attr_reader :job_data
+
     def initialize(job_data)
       @job_data = job_data
     end
 
+    def job_class
+      @job_data['job_class'].safe_constantize
+    end
+
     def perform
       ActiveJob::Base.execute(@job_data)
     end

data/lib/workhorse/performer.rb

@@ -61,7 +61,11 @@ module Workhorse
       log 'Performing', :info
       log "Description: #{@db_job.description}", :info unless @db_job.description.blank?
 
-      if Workhorse.perform_jobs_in_tx
+      inner_job_class = deserialized_job.try(:job_class) || deserialized_job.class
+      skip_tx = inner_job_class.try(:skip_tx?)
+      log "SKIP TX: #{skip_tx.inspect}".red, :error
+
+      if Workhorse.perform_jobs_in_tx && !skip_tx
         Workhorse.tx_callback.call do
           deserialized_job.perform
         end

data/lib/workhorse.rb

@@ -6,6 +6,7 @@ require 'uri'
 
 require 'workhorse/enqueuer'
 require 'workhorse/scoped_env'
+require 'workhorse/active_job_extension'
 
 module Workhorse
   # Check if the available Arel version is greater or equal than 7.0.0

data/workhorse.gemspec

@@ -1,15 +1,15 @@
 # -*- encoding: utf-8 -*-
-# stub: workhorse 1.2.13 ruby lib
+# stub: workhorse 1.2.14 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "workhorse".freeze
-  s.version = "1.2.13"
+  s.version = "1.2.14"
 
   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 = "2023-02-20"
-  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.date = "2023-08-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/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/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.13
+  version: 1.2.14
 platform: ruby
 authors:
 - Sitrox
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-20 00:00:00.000000000 Z
+date: 2023-08-23 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: []
@@ -203,6 +203,7 @@ files:
 - lib/generators/workhorse/templates/config/initializers/workhorse.rb
 - lib/generators/workhorse/templates/create_table_jobs.rb
 - lib/workhorse.rb
+- lib/workhorse/active_job_extension.rb
 - lib/workhorse/daemon.rb
 - lib/workhorse/daemon/shell_handler.rb
 - lib/workhorse/db_job.rb
@@ -227,10 +228,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 +246,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.4.10
+signing_key:
 specification_version: 4
 summary: Multi-threaded job backend with database queuing for ruby.
 test_files: