dat-worker-pool 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
-SHA512: 
-  data.tar.gz: c0a52d7d5c533e9d71623775137e77131dcc4eceae71e4e55085f0248983442518e394fbca0aeaf02be04f6bf7484dd139ad84f4c7e165c194057d662d7689f2
-  metadata.gz: 8c5250174e3f695c2ad78ab377e1c29973dd37295abe65cd94d3b2a266ce0171087ab1262316004591882de23497a0e24649f8c1b0c7d75ec3cbb31fdc589938
 SHA1: 
-  data.tar.gz: 4a978550e606a83e897ca45f4eaf5e8c8e945622
-  metadata.gz: 43f2dd81c2d52ce758a87a403381536899526c58
+  metadata.gz: e1cc8332e3e05d65d1e9de7795dd3df9d2bcda89
+  data.tar.gz: 10cc848b2f52d31f1403b7305571db181ce7661d
+SHA512: 
+  metadata.gz: d2ca49a8165cef28bd1881a36266316fa33d6216a779c5fdcc1d57584869a72375dde8f07ba20224de377f4cee707b60b6e31965b732377e8c471faee9545ba4
+  data.tar.gz: 6329a3d27d84eb7da54066a86064aacc0cc0f67c2125eb99fbd0a4462f4fa3d9bc088fbdf11ba7d5f04aaca21a075ae19ea111c6c6b1bbb5db4bfb8575e8853d

data/lib/dat-worker-pool/version.rb

@@ -1,3 +1,3 @@
 class DatWorkerPool
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

data/lib/dat-worker-pool/worker.rb

@@ -1,10 +1,18 @@
 require 'thread'
+require 'timeout'
 require 'dat-worker-pool/runner'
 
 class DatWorkerPool
 
   module Worker
 
+    # these are standard error classes that we rescue, handle and don't reraise
+    # in the work loop, this keeps the worker thread from shutting down
+    # unexpectedly; `Timeout::Error` is a common non `StandardError` exception
+    # that should be treated like a `StandardError`, we don't want an uncaught
+    # `Timeout::Error` to shutdown a worker thread
+    STANDARD_ERROR_CLASSES = [StandardError, Timeout::Error].freeze
+
     def self.included(klass)
       klass.class_eval do
         extend ClassMethods
@@ -109,13 +117,13 @@ class DatWorkerPool
               rescue ShutdownError => exception
                 dwp_handle_exception(exception, work_item)
                 Thread.current.raise exception
-              rescue StandardError => exception
+              rescue *STANDARD_ERROR_CLASSES => exception
                 dwp_handle_exception(exception, work_item)
               ensure
                 dwp_make_available
               end
             end
-          rescue StandardError => exception
+          rescue *STANDARD_ERROR_CLASSES => exception
             dwp_handle_exception(exception, work_item)
           end
         end
@@ -128,7 +136,7 @@ class DatWorkerPool
         begin
           dwp_run_callback 'on_start'
           dwp_make_available
-        rescue StandardError => exception
+        rescue *STANDARD_ERROR_CLASSES => exception
           dwp_handle_exception(exception)
           Thread.current.raise exception
         end
@@ -160,7 +168,7 @@ class DatWorkerPool
         begin
           dwp_make_unavailable
           dwp_run_callback 'on_shutdown'
-        rescue StandardError => exception
+        rescue *STANDARD_ERROR_CLASSES => exception
           dwp_handle_exception(exception)
         end
         dwp_log{ "Shutdown" }
@@ -172,7 +180,7 @@ class DatWorkerPool
         begin
           dwp_log_exception(exception)
           dwp_run_callback('on_error', exception, work_item)
-        rescue StandardError => on_error_exception
+        rescue *STANDARD_ERROR_CLASSES => on_error_exception
           # errors while running on-error callbacks are logged but otherwise
           # ignored to keep the worker from crashing, ideally these should be
           # caught by the on-error callbacks themselves and never get here

data/test/system/dat-worker-pool_tests.rb

@@ -143,7 +143,9 @@ class DatWorkerPool
         def work!(work_item)
           params[:finished].push(work_item)
           signal_test_suite_thread
-          raise if work_item == 'error'
+          if work_item == 'error'
+            raise Factory.exception(STANDARD_ERROR_CLASSES.sample)
+          end
         end
       end
       # use one worker to simplify; we only need to see that one worker runs its

data/test/unit/worker_tests.rb

@@ -30,6 +30,11 @@ module DatWorkerPool::Worker
     should have_imeths :prepend_on_error
     should have_imeths :prepend_before_work, :prepend_after_work
 
+    should "know its standard error classes" do
+      exp = [StandardError, Timeout::Error]
+      assert_equal exp, DatWorkerPool::Worker::STANDARD_ERROR_CLASSES
+    end
+
     should "not have any callbacks by default" do
       assert_equal [], subject.on_start_callbacks
       assert_equal [], subject.on_shutdown_callbacks
@@ -255,7 +260,7 @@ module DatWorkerPool::Worker
     should "make itself available/unavailable and run callbacks if it errors" do
       # these are the only errors that could interfere with it
       error_method = [:on_unavailable_error, :work_error].sample
-      exception = Factory.exception
+      exception = Factory.exception(STANDARD_ERROR_CLASSES.sample)
       subject.send("#{error_method}=", exception)
 
       subject.dwp_start
@@ -303,7 +308,7 @@ module DatWorkerPool::Worker
     end
 
     should "run its on-error callbacks if it errors while starting" do
-      exception = Factory.exception
+      exception = Factory.exception(STANDARD_ERROR_CLASSES.sample)
       error_method = [:on_start_error, :on_available_error].sample
       subject.send("#{error_method}=", exception)
 
@@ -315,7 +320,7 @@ module DatWorkerPool::Worker
     end
 
     should "stop its thread if it errors while starting" do
-      exception = Factory.exception
+      exception = Factory.exception(STANDARD_ERROR_CLASSES.sample)
       error_method = [:on_start_error, :on_available_error].sample
       subject.send("#{error_method}=", exception)
 
@@ -327,7 +332,7 @@ module DatWorkerPool::Worker
     end
 
     should "run its on-error callbacks if it errors while shutting down" do
-      exception = Factory.exception
+      exception = Factory.exception(STANDARD_ERROR_CLASSES.sample)
       error_method = [:on_shutdown_error, :on_unavailable_error].sample
       subject.send("#{error_method}=", exception)
 
@@ -343,7 +348,7 @@ module DatWorkerPool::Worker
       subject.dwp_start
       wait_for_worker_to_be_available
 
-      exception = Factory.exception
+      exception = Factory.exception(STANDARD_ERROR_CLASSES.sample)
       setup_work_loop_to_raise_exception(exception)
 
       @queue.dwp_push(Factory.string)
@@ -353,7 +358,7 @@ module DatWorkerPool::Worker
     end
 
     should "run its on-error callbacks if an error occurs while running" do
-      exception = Factory.exception
+      exception = Factory.exception(STANDARD_ERROR_CLASSES.sample)
       subject.dwp_start
       wait_for_worker_to_be_available
 
@@ -367,7 +372,7 @@ module DatWorkerPool::Worker
     end
 
     should "not stop its thread if an error occurs in an on-error callback" do
-      exception = Factory.exception
+      exception = Factory.exception(STANDARD_ERROR_CLASSES.sample)
       subject.dwp_start
       wait_for_worker_to_be_available
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dat-worker-pool
 version: !ruby/object:Gem::Version 
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors: 
 - Collin Redding
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2016-06-09 00:00:00 Z
+date: 2016-06-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: assert
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A simple thread pool for processing generic 'work'