workhorse 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6cda82b0f03df2130e38841bff942ab7f3d559a1c6233121c6060a7c06d50d0
-  data.tar.gz: 64b0c6ba8e659ff3dcc4009b5c13ba91139e7f82a6043f42c0d3eed6c0368107
+  metadata.gz: 41fdd839e9d646bc4cff92ec6eda63da5ad24f4d683e9bc42ce167547247fb29
+  data.tar.gz: 317c5da4cbd865d36d4361920f906456f4205ce3f5f09376af15aa7798347175
 SHA512:
-  metadata.gz: '0998ffd89b16233c8fa97fa00b8db4de490f9dccdebc7a6002a5d44a0ac859a050a41e339c545f6ec5ebfaa9888671b693cf389a779975c214b54cd9328385d4'
-  data.tar.gz: 9b2d2d1fc6e3d2667286c9a5f48a247596612a9b0162b4cc202b536f43745a55894d35f45e2efd5badf431cbaea0a47f9108262d1d24252bf4410222d7eb58e5
+  metadata.gz: 6e1138796a7bfae97429073564862ecd3619576ef88e28a3a043550cd054b82fac2ac79f67931080604c91e73b4356c56798d7b2801e2a9e6e8e448ea8ed31e0
+  data.tar.gz: 5f08e73f3a4b816b59c32c902103b39e8d53d42bb8528eed02af0e73fbea576a788e24687cabb482cc652bb259fe40ee35d216f1010b48f4439aa1b52715d0dd

data/.travis.yml

@@ -1,6 +1,7 @@
 language: ruby
 rvm:
  - 2.3.0
+ - 2.5.0
 services:
  - mysql
 before_install:

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Workhorse Change log
 
+## 0.3.5 - unreleased
+
+* Adds global callback `on_exception` that allows custom exception handling /
+  exception notification.
+
 ## 0.3.4 - 2018-09-24
 
 * *Fixes #14

data/README.md

@@ -240,6 +240,23 @@ Workhorse::Daemon::ShellHandler.run count: 5 do
 end
 ```
 
+## Exception handling
+
+Per default, exceptions occurring in a worker thread will only be visible in the
+respective log file, usually `production.log`. If you'd like to perform specific
+actions when an exception arises, set the global option `on_exception` to a
+callback of your linking, e.g.:
+
+```ruby
+# config/initializers/workhorse.rb
+Workhorse.setup do |config|
+  config.on_exception = proc do |e|
+    # Use gem 'exception_notification' for notifying about exceptions
+    ExceptionNotifier.notify_exception(exception)
+  end
+end
+```
+
 ## Frequently asked questions
 
 Please consult the [FAQ](FAQ.md).

data/VERSION

@@ -1 +1 @@
-0.3.4
+0.3.5

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

@@ -11,4 +11,12 @@ Workhorse.setup do |config|
   # config.tx_callback = proc do |&block|
   #   ActiveRecord::Base.transaction&(&block)
   # end
+
+  # Enable and configure this to specify a callback for handling worker
+  # exceptions:
+  #
+  # config.on_exception = proc do |exception|
+  #   # Do something with exception, i.e.
+  #   # ExceptionNotifier.notify_exception(exception)
+  # end
 end

data/lib/workhorse.rb

@@ -25,6 +25,12 @@ module Workhorse
     ActiveRecord::Base.transaction(&block)
   end
 
+  mattr_accessor :on_exception
+  self.on_exception = proc do |exception|
+    # Do something with this exception, i.e.
+    # ExceptionNotifier.notify_exception(exception)
+  end
+
   mattr_accessor :perform_jobs_in_tx
   self.perform_jobs_in_tx = true
 

data/lib/workhorse/performer.rb

@@ -12,6 +12,8 @@ module Workhorse
       fail 'Performer can only run once.' if @started
       @started = true
       perform!
+    rescue => e
+      Workhorse.on_exception.call(e)
     end
 
     private
@@ -38,6 +40,8 @@ module Workhorse
         log 'Mark failed', :debug
         @db_job.mark_failed!(e)
       end
+
+      fail e
     ensure
       Thread.current[:workhorse_current_performer] = nil
     end

data/lib/workhorse/worker.rb

@@ -134,6 +134,8 @@ module Workhorse
           end
         end
       end
+    rescue => e
+      Workhorse.on_exception.call(e)
     end
 
     private

data/test/lib/jobs.rb

@@ -22,6 +22,14 @@ class DbConnectionTestJob
   end
 end
 
+class FailingTestJob
+  MESSAGE = 'I fail all the time'.freeze
+
+  def perform
+    fail MESSAGE
+  end
+end
+
 class DummyRailsOpsOp
   class_attribute :results
   self.results = Concurrent::Array.new

data/test/workhorse/performer_test.rb

@@ -13,4 +13,20 @@ class Workhorse::WorkerTest < WorkhorseTest
     assert_equal 2, DbConnectionTestJob.db_connections.count
     assert_equal 2, DbConnectionTestJob.db_connections.uniq.count
   end
+
+  def test_on_exception
+    old_callback = Workhorse.on_exception
+    exception = nil
+
+    Workhorse.on_exception = proc do |e|
+      exception = e
+    end
+
+    Workhorse.enqueue FailingTestJob.new
+    work 0.2, polling_interval: 0.2
+
+    assert_equal exception.message, FailingTestJob::MESSAGE
+  ensure
+    Workhorse.on_exception = old_callback
+  end
 end

data/workhorse.gemspec

@@ -1,16 +1,16 @@
 # -*- encoding: utf-8 -*-
-# stub: workhorse 0.3.4 ruby lib
+# stub: workhorse 0.3.5 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "workhorse".freeze
-  s.version = "0.3.4"
+  s.version = "0.3.5"
 
   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 = "2018-09-24"
+  s.date = "2018-10-22"
   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/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/run_rails_op.rb".freeze, "lib/workhorse/performer.rb".freeze, "lib/workhorse/poller.rb".freeze, "lib/workhorse/pool.rb".freeze, "lib/workhorse/worker.rb".freeze, "test/lib/db_schema.rb".freeze, "test/lib/jobs.rb".freeze, "test/lib/test_helper.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 = "2.5.2.3".freeze
+  s.rubygems_version = "2.7.6".freeze
   s.summary = "Multi-threaded job backend with database queuing for ruby.".freeze
   s.test_files = ["test/lib/db_schema.rb".freeze, "test/lib/jobs.rb".freeze, "test/lib/test_helper.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: 0.3.4
+  version: 0.3.5
 platform: ruby
 authors:
 - Sitrox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-24 00:00:00.000000000 Z
+date: 2018-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler