resque-durable 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 29b76c4ad5376048fd49658063b16f73acd87d54
-  data.tar.gz: 30820b659c590e531c89ba844bec65e1eab92065
+SHA256:
+  metadata.gz: a514c11d6f3655311d22c6d055a243f5cc22a8ec26d7ade6880dd1a6c05ca000
+  data.tar.gz: 5d005e32eeb791e0a4bae2a275f146eac208e6848f0cb013ce5bbd020168ad0e
 SHA512:
-  metadata.gz: 0cff225b7f9ac693baf965e14d52177d5a7ad9d2b67e04e11656ba4295c91519bbc84e26bd425a92730bc16a27903096e50830efd9c3095564ba6e658fc76424
-  data.tar.gz: 1b1fc8e0d1d2713e39b43a26ed86ccd6a368ab13508df6dfe895013d74a1938d210c24154513d1239bdf99adf59578ecb1cc0afec1f30900f2f480a7ebeceb36
+  metadata.gz: 62aeda110d3e195e18285692a57b4519be97ce777e8b2d8144b3ec21e356ec75173e55b9570961669c818791521af92b1117f93791915cbdb181465cee3eedae
+  data.tar.gz: dbb59ca8dc5e86a31059625930028df2e6cd81535e715c39078c6599b2d5ee8c2cd3747cd7c82eac3c2ef60fdfb825119d8920ac9bc29a4aad024f1fac4b6e42

data/lib/resque/durable.rb

@@ -3,11 +3,20 @@ module Resque
     autoload :GUID,       'resque/durable/guid'
     autoload :Monitor,    'resque/durable/monitor'
     autoload :QueueAudit, 'resque/durable/queue_audit'
+    autoload :BackgroundHeartbeat, 'resque/durable/background_heartbeat'
 
     def self.extended(base)
+      # The duration since the last heartbeat that the monitor will wait before
+      # re-enqueing the job.
       base.cattr_accessor :job_timeout
       base.job_timeout = 10.minutes
 
+      # How frequently a background thread will optimistically heartbeat the
+      # QueueAudit. Value must be smaller than job_timeout. Currently opt-in.
+      #
+      # Recommended value: `15.seconds`
+      base.cattr_accessor :background_heartbeat_interval
+
       base.cattr_accessor :auditor
       base.auditor = QueueAudit
     end
@@ -46,9 +55,17 @@ module Resque
 
     def around_perform_manage_audit(*args)
       if a = audit(args)
-        a.heartbeat!
         return if a.complete?
-        yield
+        if background_heartbeat_interval
+          raise "background_heartbeat_interval (#{background_heartbeat_interval.inspect}) be smaller than job_timeout (#{job_timeout.inspect})" if background_heartbeat_interval >= job_timeout
+          BackgroundHeartbeat.new(audit(args), background_heartbeat_interval).with_heartbeat do
+            yield
+          end
+        else
+          a.heartbeat!
+          yield
+        end
+
         a.complete!
       else
         yield

data/lib/resque/durable/background_heartbeat.rb

@@ -0,0 +1,82 @@
+require 'thread'
+
+module Resque
+  module Durable
+
+    # Creates a background thread to regularly heartbeat the queue audit.
+    class BackgroundHeartbeat
+
+      def initialize(queue_audit, interval)
+        @queue_audit  = queue_audit
+        @last_timeout = nil
+        @interval     = interval
+        @mutex        = Mutex.new
+        @stop         = false
+        @thread       = nil
+      end
+
+      class << self
+        # only a separate method for easy stubbing
+        def exit_now!
+          abort
+        end
+      end
+
+      def with_heartbeat
+        start!
+        yield
+      ensure
+        stop_and_wait!
+      end
+
+      def heartbeat!
+        @last_timeout ||= @queue_audit.timeout_at
+        @last_timeout = @queue_audit.optimistic_heartbeat!(@last_timeout)
+      rescue StandardError => e
+        @queue_audit.logger.error("Exception in BackgroundHeartbeat thread: #{e.class.name}: #{e.message}")
+        self.class.exit_now!
+      ensure
+        ActiveRecord::Base.clear_active_connections!
+      end
+
+      def start!
+        raise "Thread is already running!" if @thread
+        @stop = false
+
+        # Perform immediately to reduce heartbeat race condition opportunities
+        heartbeat!
+
+        @thread = Thread.new do
+          while !@stop
+            heartbeat!
+
+            @mutex.synchronize do
+              @mutex.sleep(@interval)
+            end
+          end
+        end
+      end
+
+      def stop_and_wait!
+        return unless @thread
+        # Prevent deadlock if called by the `heartbeat` thread, which can't wait for itself to die.
+        return signal_stop! if @thread == Thread.current
+        while @thread.alive?
+          signal_stop!
+          sleep 0.01
+        end
+        @thread.join
+        @thread = nil
+      end
+
+      # Signal the `heartbeat` thread to stop looping immediately. Safe to be call from any thread.
+      def signal_stop!
+        return unless @thread
+        @mutex.synchronize do
+          @stop = true
+          @thread.wakeup
+        end
+      end
+    end
+  end
+end

data/lib/resque/durable/queue_audit.rb

@@ -1,9 +1,11 @@
 require 'active_record'
-require 'active_support/core_ext/class'
+require 'active_support/core_ext'
 
 module Resque
   module Durable
     class QueueAudit < ActiveRecord::Base
+      JobCollision = Class.new(StandardError)
+
       self.table_name = :durable_queue_audits
       # id
       # enqueued_id
@@ -19,19 +21,18 @@ module Resque
 
       validates_length_of    :payload_before_type_cast, :in => 1..5000
 
-      validates_inclusion_of :duration, :in => 1.minute..3.hours
+      validates_inclusion_of :duration, :in => 1.minute.to_i..3.hours.to_i
 
-      scope :older_than, lambda { |date|
-        { :conditions => [ 'created_at < ?', date ] }
-      }
+      scope :older_than, ->(date) { where('created_at < ?', date) }
 
-      scope :failed, lambda {
-        { :conditions => [ 'completed_at is null AND timeout_at < ?', Time.now.utc ], :order => 'timeout_at asc', :limit => 500 }
+      scope :failed, -> {
+        where(completed_at: nil)
+          .where('timeout_at < ?', Time.now.utc)
+          .order('timeout_at asc')
+          .limit(500)
       }
 
-      scope :complete, lambda {
-        { :conditions => 'completed_at is not null' }
-      }
+      scope :complete, -> { where('completed_at is not null') }
 
       module Recovery
 
@@ -89,6 +90,18 @@ module Resque
         update_attribute(:timeout_at, Time.now.utc + duration)
       end
 
+      # Bumps the `timeout_at` column, but raises a `JobCollision` exception if
+      # another process has changed the value, indicating we may have multiple
+      # workers processing the same job.
+      def optimistic_heartbeat!(last_timeout_at)
+        next_timeout_at = Time.now.utc + duration
+        nrows = self.class.
+          where(id: id, timeout_at: last_timeout_at).
+          update_all(timeout_at: next_timeout_at)
+        raise JobCollision.new unless nrows == 1
+        next_timeout_at
+      end
+
       def fail!
         update_attribute(:timeout_at, Time.now.utc)
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resque-durable
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Eric Chapweske
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-09 00:00:00.000000000 Z
+date: 2020-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.2'
 description: 
 email: 
 executables: []
@@ -32,6 +32,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/resque/durable.rb
+- lib/resque/durable/background_heartbeat.rb
 - lib/resque/durable/guid.rb
 - lib/resque/durable/monitor.rb
 - lib/resque/durable/queue_audit.rb
@@ -47,15 +48,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Resque queue backed by database audits, with automatic retry