dalliance 0.8.2 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 287e36b49931e0fdf7ccf431d6d9358c6802d3020d7b9bbbf507600ef2eb21b3
-  data.tar.gz: 2fec96937b717e8feadc5a3ac946a5ef3907a23527ca1ecb2ba30ad89be067eb
+  metadata.gz: ceb1bcc758ad39970b608af9112dfb735f7408edc7d97caf818654d5fca558db
+  data.tar.gz: eed4e050d077b5cdf74b8d8997e917423229199904740a06028e2d3daca89c66
 SHA512:
-  metadata.gz: 9c04f97d5a480e7a5c49b9c6d0f9a52d81acd7643d2654a9b9934f62ebd7f6907545d0e2f71aa9f2a133d43bc4f49ef6c794eccd37f9b1dec5448ff7a458d59a
-  data.tar.gz: 3f4f2f7d6ab8721726b88232e6fa4d8282ba8ccb15544a4c765a062bb01d78a7d35b45e42a7e2bbd5d0a4efd1990cdf26ff1a894a28bc5ac7af77beabfe84566
+  metadata.gz: 9bbddd1d2685d64b7a2ccd0d5d610f5d7d44d249ef59d0c0d76198e4c0733340dc89dc506b9c084c1f667ec7370830560854575b1dc0079d63a16cc630ba0093
+  data.tar.gz: f60a961960220bfe1973d12a1c4440bd87d1ae6d2cbfd71c57e2308d66e58e0887a5aee8513bde25316bb50765d12dbb4d42105b04d3d8dedab4465e7a63634b

data/config/locales/en.yml

@@ -8,6 +8,8 @@ en:
           validation_error: Validation Error
           processing_error: Processing Error
           completed: Completed
+          cancel_requested: Cancellation Requested
+          cancelled: Cancelled
   attributes:
     dalliance_status: Status
     dalliance_error_hash: Errors

data/lib/dalliance.rb

@@ -91,6 +91,8 @@ module Dalliance
     scope :validation_error, -> { where(:dalliance_status => 'validation_error') }
     scope :processing_error, -> { where(:dalliance_status => 'processing_error') }
     scope :completed, -> { where(:dalliance_status => 'completed') }
+    scope :cancel_requested, -> { where(:dalliance_status => 'cancel_requested') }
+    scope :cancelled, -> { where(:dalliance_status => 'cancelled') }
 
     state_machine :dalliance_status, :initial => :pending do
       state :pending
@@ -98,6 +100,8 @@ module Dalliance
       state :validation_error
       state :processing_error
       state :completed
+      state :cancel_requested
+      state :cancelled
 
       #event :queue_dalliance do
       #  transition :processing_error => :pending
@@ -116,12 +120,23 @@ module Dalliance
       end
 
       event :finish_dalliance do
-        transition :processing => :completed
+        transition [:processing, :cancel_requested] => :completed
       end
 
       event :reprocess_dalliance do
         transition [:validation_error, :processing_error, :completed] => :pending
       end
+
+      # Requests the record to stop processing. This does NOT cause processing
+      # to stop!  Each model is required to handle cancellation on its own by
+      # periodically checking the dalliance status
+      event :request_cancel_dalliance do
+        transition [:pending, :processing] => :cancel_requested
+      end
+
+      event :cancelled_dalliance do
+        transition [:cancel_requested] => :cancelled
+      end
     end
     #END state_machine(s)
 
@@ -191,12 +206,34 @@ module Dalliance
   end
 
   def error_or_completed?
-    validation_error? || processing_error? || completed?
+    validation_error? || processing_error? || completed? || cancelled?
+  end
+
+  # Cancels the job and removes it from the queue if has not already been taken
+  # by a worker.  If the job is processing, it is up to the job implementation
+  # to stop and do any necessary cleanup.  If the job does not honor the
+  # cancellation request, it will finish processing as normal and finish with a
+  # dalliance_status of 'completed'.
+  #
+  # Jobs can currently only be removed from Resque queues.  DelayedJob jobs will
+  # not be dequeued, but will immediately exit once taken by a worker.
+  def cancel_and_dequeue_dalliance!
+    should_dequeue = pending?
+
+    request_cancel_dalliance!
+
+    if should_dequeue
+      self.dalliance_options[:worker_class].dequeue(self)
+      dalliance_log("[dalliance] #{self.class.name}(#{id}) - #{dalliance_status} - Removed from #{processing_queue} queue")
+      cancelled_dalliance!
+    end
+
+    true
   end
 
   def validate_dalliance_status
     unless error_or_completed?
-      errors.add(:dalliance_status, :invalid)
+      errors.add(:dalliance_status, "Processing must be finished or cancelled, but status is '#{dalliance_status}'")
       if defined?(Rails)
         throw(:abort)
       else
@@ -254,6 +291,11 @@ module Dalliance
   end
 
   def do_dalliance_process(perform_method:, background_processing: false)
+    # The job might have been cancelled after it was queued, but before
+    # processing started.  Check for that up front before doing any processing.
+    cancelled_dalliance! if cancel_requested?
+    return if cancelled? # method generated from AASM
+
     start_time = Time.now
 
     begin
@@ -265,7 +307,7 @@ module Dalliance
 
       self.send(perform_method)
 
-      finish_dalliance! unless validation_error?
+      finish_dalliance! unless validation_error? || cancelled?
     rescue StandardError => e
       #Save the error for future analysis...
       self.dalliance_error_hash = {:error => e.class.name, :message => e.message, :backtrace => e.backtrace}

data/lib/dalliance/version.rb

@@ -1,8 +1,8 @@
 module Dalliance
   module VERSION
     MAJOR = 0
-    MINOR = 8
-    TINY  = 2
+    MINOR = 9
+    TINY  = 0
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join('.')

data/lib/dalliance/workers/delayed_job.rb

@@ -10,6 +10,10 @@ module Dalliance
             .perform_later(instance.class.name, instance.id, perform_method.to_s)
         end
 
+        def self.dequeue(_instance)
+          # NOP
+        end
+
         def perform(instance_klass, instance_id, perform_method)
           instance_klass
             .constantize
@@ -31,6 +35,10 @@ module Dalliance
           )
         end
 
+        def self.dequeue(_instance)
+          # NOP
+        end
+
         def perform
           instance_klass
             .constantize

data/lib/dalliance/workers/resque.rb

@@ -10,6 +10,23 @@ module Dalliance
             .perform_later(instance.class.name, instance.id, perform_method.to_s)
         end
 
+        def self.dequeue(instance)
+          redis = ::Resque.redis
+          queue = instance.processing_queue
+
+          redis.everything_in_queue(queue).each do |string|
+            # Structure looks like, e.g.
+            # { 'class' => 'ActiveJob::...', 'args' => [{ 'arguments' => ['SomeClass', 123, 'dalliance_process'] }] }
+            data = ::Resque.decode(string)
+            dalliance_args = data['args'][0]['arguments']
+
+            if dalliance_args == [instance.class.name, instance.id, 'dalliance_process'] ||
+               dalliance_args == [instance.class.name, instance.id, 'dalliance_reprocess']
+              redis.remove_from_queue(queue, string)
+            end
+          end
+        end
+
         def perform(instance_klass, instance_id, perform_method)
           instance_klass
             .constantize
@@ -28,6 +45,23 @@ module Dalliance
           ::Resque.enqueue_to(queue, self, instance.class.name, instance.id, perform_method.to_s)
         end
 
+        def self.dequeue(instance)
+          redis = ::Resque.redis
+          queue = instance.processing_queue
+
+          redis.everything_in_queue(queue).each do |string|
+            # Structure looks like, e.g.
+            # { 'class' => 'ActiveJob::...', 'args' => [{ 'arguments' => ['SomeClass', 123, 'dalliance_process'] }] }
+            data = ::Resque.decode(string)
+            dalliance_args = data['args'][0]['arguments']
+
+            if dalliance_args == [instance.class.name, instance.id, 'dalliance_process'] ||
+               dalliance_args == [instance.class.name, instance.id, 'dalliance_reprocess']
+              redis.remove_from_queue(queue, string)
+            end
+          end
+        end
+
         def self.perform(instance_klass, instance_id, perform_method)
           instance_klass
             .constantize

data/spec/dalliance/asynchronous_resque_spec.rb

@@ -12,6 +12,7 @@ RSpec.describe DallianceModel do
 
   before do
     Resque.remove_queue(:dalliance)
+    Resque.remove_queue(:notaqueue)
   end
 
   context "no worker_class" do
@@ -168,6 +169,69 @@ RSpec.describe DallianceModel do
     end
   end
 
+  context 'cancelling' do
+    before(:all) do
+      DallianceModel.dalliance_options[:dalliance_method] = :dalliance_success_method
+      DallianceModel.dalliance_options[:worker_class] = Dalliance::Workers::Resque
+      DallianceModel.dalliance_options[:queue] = 'dalliance'
+    end
+
+    it 'can be cancelled after being queued' do
+      subject.dalliance_background_process
+      expect { subject.request_cancel_dalliance! and subject.cancelled_dalliance! }
+        .to change { subject.dalliance_status }
+        .from('pending')
+        .to('cancelled')
+    end
+
+    it 'dequeues the job' do
+      expect { subject.dalliance_background_process }
+        .to change { Resque.size('dalliance') }
+        .from(0)
+        .to(1)
+
+      expect { subject.cancel_and_dequeue_dalliance! }
+        .to change { Resque.size('dalliance') }
+        .from(1)
+        .to(0)
+        .and change { subject.dalliance_status }
+        .from('pending')
+        .to('cancelled')
+    end
+
+    it 'sets dalliance_status to "cancelled" if cancellation was requested' do
+      subject.dalliance_background_process
+      subject.request_cancel_dalliance!
+
+      Resque::Worker.new(:dalliance).process
+      subject.reload
+
+      expect(subject.dalliance_status).to eq 'cancelled'
+    end
+
+    it 'runs normally if the job does not honor the cancellation request' do
+      DallianceModel.dalliance_options[:dalliance_method] = :dalliance_ignore_cancellation_method
+
+      subject.dalliance_background_process
+
+      Resque::Worker.new(:dalliance).process
+      subject.reload
+
+      expect(subject.successful).to eq true
+      expect(subject.dalliance_status).to eq 'completed'
+    end
+
+    it 'does not process' do
+      subject.request_cancel_dalliance!
+      subject.dalliance_background_process
+
+      Resque::Worker.new(:dalliance).process
+      subject.reload
+
+      expect(subject.successful).to eq false
+    end
+  end
+
   context "raise error" do
     before(:all) do
       DallianceModel.dalliance_options[:dalliance_method] = :dalliance_error_method

data/spec/dalliance/dalliance_spec.rb

@@ -9,13 +9,15 @@ RSpec.describe 'Dalliance' do
 
   context "self#dalliance_status_in_load_select_array" do
     it "should return [state, human_name]" do
-      expect(DallianceModel.dalliance_status_in_load_select_array).to eq([
+      expect(DallianceModel.dalliance_status_in_load_select_array).to contain_exactly(
         ["Completed", "completed"],
         ["Pending", "pending"],
         ["Processing", "processing"],
         ["Processing Error", "processing_error"],
-        ["Validation Error", "validation_error"]
-      ])
+        ["Validation Error", "validation_error"],
+        ["Cancellation Requested", "cancel_requested"],
+        ['Cancelled', 'cancelled']
+      )
     end
   end
 

data/spec/dalliance/synchronous_spec.rb

@@ -180,13 +180,15 @@ RSpec.describe DallianceModel do
     it "should return false when pending?" do
       subject.update_column(:dalliance_status, 'pending')
       expect(subject.destroy).to be_falsey
-      expect(subject.errors[:dalliance_status]).to eq(['is invalid'])
+      expect(subject.errors[:dalliance_status])
+        .to eq(["Processing must be finished or cancelled, but status is 'pending'"])
     end
 
     it "should return false when processing?" do
       subject.update_column(:dalliance_status, 'processing')
       expect(subject.destroy).to be_falsey
-      expect(subject.errors[:dalliance_status]).to eq(['is invalid'])
+      expect(subject.errors[:dalliance_status])
+        .to eq(["Processing must be finished or cancelled, but status is 'processing'"])
     end
 
     it "should return true when validation_error?" do

data/spec/support/active_record.rb

@@ -59,6 +59,13 @@ class DallianceModel < ActiveRecord::Base
     update_attribute(:reprocessed_count, self.reprocessed_count + 1)
   end
 
+  # Pretends that an external action requested processing to be cancelled, but
+  # ignores the request and finishes anyway.
+  def dalliance_ignore_cancellation_method
+    request_cancel_dalliance!
+    update_attribute(:successful, true)
+  end
+
   def dalliance_error_method
     raise RuntimeError
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dalliance
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors:
 - Eric Sullivan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-12 00:00:00.000000000 Z
+date: 2021-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails