delayed-threaded 0.17.1 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce6a3948e6a0ceea302b0645c284c392dae15b19
-  data.tar.gz: 6fe497718a6c6cc06b010e13e8a1c477ded4b228
+  metadata.gz: d13a30f15238ded42f550c3dc05217c02c06d675
+  data.tar.gz: 52577b78b63953c53e387c464cab2710b0c3cacc
 SHA512:
-  metadata.gz: 1dd596551baf39bb987209f5b136c5d34a55a6deec73206c441175a2d8034e9c5b44a80bb44b1d1d3649a808223596a3e460c0f4c3b0a64e92026223aaa5ae8b
-  data.tar.gz: 18dc0ba741a33056f789f03b79c7b972647ae4945bbf00c94e671ddcece7196aa56f1ade89b3c0341b24a8b425b50fbb55b66b26c72ac415c958750e114a5ed6
+  metadata.gz: fa250193345448aebe7e5b075095a6c0f50bdb9ded1ea07e00d4796df454eb43e1c913c4053bba8490d23d811c2dfd2d0034a599aa81963d69f460568e60065b
+  data.tar.gz: 227b9f9b1960c8c3e51218018dd1de96cdaec2b1ed06a35f8661aecdb1d7edd9be7d1c93b5a72fba1c71e7f1e40e00ff68f4945cef8561c8e53e0dd69d7944af

data/README.md

@@ -55,6 +55,17 @@ the connections after work (as the worker sleeps), setup as a plugin using :
 require 'delayed/active_record/release_connection_plugin.rb'
 ````
 
+and a somehow fail-"safer" lock clearing mechanism in case of backend errors
+
+```ruby
+# Replace DJ's default ClearLocks plugin with a fail-safe version 
+# e.g. when a connection goes down in the middle of job processing, 
+# `Delayed::Job.clear_locks!` causes a double fault to propagate.
+require 'delayed/fail_safe/clear_locks_plugin.rb'
+```
+
+NOTE: **delayed_job** might not be the right tool for a fail-safe worker job.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.

data/lib/delayed/fail_safe/clear_locks.rb

@@ -0,0 +1,38 @@
+module Delayed
+  module FailSafe
+    class ClearLocks < Plugin
+
+      @@exception_handler = lambda do |ex, worker| # fail-safe by default
+        worker.say "Error running clear_locks! callback: #{ex.inspect}", 'error'
+      end
+
+      # Allow user customizations of error handling.
+      #
+      # To get the same behavior as `Delayed::Plugins::ClearLocks` :
+      #
+      #   Delayed::FailSafe::ClearLocks.exception_handler { |ex| raise(ex) }
+      #
+      def self.exception_handler(&block)
+        return @@exception_handler unless block_given?
+        @@exception_handler = block
+      end
+
+      def self.call(worker)
+        Delayed::Job.clear_locks!(worker.name)
+      rescue => ex
+        @@exception_handler.call(ex, worker)
+      end
+
+      callbacks do |lifecycle|
+        lifecycle.around(:execute) do |worker, &block|
+          begin
+            block.call(worker)
+          ensure
+            ClearLocks.call(worker)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/delayed/fail_safe/clear_locks_plugin.rb

@@ -0,0 +1,7 @@
+require 'delayed/worker'
+
+require 'delayed/fail_safe/clear_locks'
+if defined? Delayed::Plugins::ClearLocks
+  i = Delayed::Worker.plugins.index(Delayed::Plugins::ClearLocks) || 0
+  Delayed::Worker.plugins[i] = Delayed::FailSafe::ClearLocks
+end

data/lib/delayed/threaded/version.rb

@@ -1,5 +1,5 @@
 module Delayed
   module Threaded
-    VERSION = '0.17.1'
+    VERSION = '0.18.0'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: delayed-threaded
 version: !ruby/object:Gem::Version
-  version: 0.17.1
+  version: 0.18.0
 platform: ruby
 authors:
 - Karol Bucek
@@ -118,6 +118,8 @@ files:
 - delayed-threaded.gemspec
 - lib/delayed/active_record/release_connection_plugin.rb
 - lib/delayed/backend/active_record/release_connection.rb
+- lib/delayed/fail_safe/clear_locks.rb
+- lib/delayed/fail_safe/clear_locks_plugin.rb
 - lib/delayed/threaded.rb
 - lib/delayed/threaded/sleep_calculator.rb
 - lib/delayed/threaded/sync_lifecycle.rb