active_job_resque_solo 0.3.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c61c12c5ebceb9742e0ac25a156b9be267a14e764ec012265a48dc5b9a28304
-  data.tar.gz: b1f1917b25f778c22d6454916e49fb890e86bf15aacda15d135d08f7de73d567
+  metadata.gz: 0c1808a193478339e05f2b63b8c31bf7c0b3721f6295a279c4e7add9490734ca
+  data.tar.gz: 2fa2b9e100de2ca2be8e63fc4f3ffdbaeee737c7c3794203cba27b875bb9c1ac
 SHA512:
-  metadata.gz: 6010a0562433d4d11f4b857178fe2380b2a661a2767c709dff1440e8ffaf0270be4e38cb6ceb1ba68d9a702d0e67785957639f3860dca1ee1643d2eeb540f801
-  data.tar.gz: '08d8a382c465cf5045c39be01119e78985bd07634679b0112414dea4568e51e97df6b0d5370e004e1a10d659d5403ecb7b367c91122355915842019171bbfedd'
+  metadata.gz: 603308fbd2832fe52d60d78a0fa4e70821a4bdd3b440532cc78d76558a42c31e55fa6ce51c7db9cf2fe1cf16d4cc0ca0cbeff073ea7fb7929b609dfeda8c1846
+  data.tar.gz: 71286eab4097f6aa6eb9ab92d5ae1a71f7c5d78023cb1f3ac63124cdd4d40877be8967f59cbba3a88b40a377dce831396b0b269e9f0ae6262b806498091fbdec

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.0.0
+
+* Breaking change: Allow a job to reschedule itself while it executing but not enqueued.
+* Adds `solo_self_enqueueing` as an option to control the re-enqueueing behavior. Use `solo_self_enqueueing :prevent` for the behavior prior to version 1.0.0.
+
 # 0.3.9
 
 * Add CI test for Ruby 2.5.0.

data/README.md

@@ -77,7 +77,7 @@ end
 ```
 
 Specify `solo_any_args` to allow only one instance of your job to be enqueued or executing at any given
-time regardless of the arugments used in each instance.
+time regardless of the arguments used in each instance.
 
 `solo_any_args` overrides `solo_only_args` and `solo_except_args`.
 
@@ -119,6 +119,29 @@ class MyJob < ActiveJob::Base
 end
 ```
 
+## Re-enqueueing from within the job
+
+The default behavior of this gem allows a Job to re-enqueue itself while it is
+executing. If you know that your job should not be re-enqueueing itself, you can
+prevent inadvertent re-enqueueing of the job by using `solo_self_enqueueing :prevent`.
+
+Jobs that `fail` or `raise` an error may be retried by the framework, and are not
+affected by this option.
+
+```ruby
+class MyJob < ActiveJob::Base
+
+  include ActiveJob::Plugins::Resque::Solo
+
+  solo_self_enqueueing :prevent
+
+  def perform(*args)
+     MyJob.perform_later # <== this will not enqueue a job because of :prevent, above.
+     raise MyError       # <== retries are still allowed
+  end
+end
+```
+
 ## Duplicate enqueues are possible
 
 While this plugin will greatly reduce duplicate instances of a job from being
@@ -126,6 +149,10 @@ enqueued, a job may be enqueued multiple times if the Redis response times are
 very slow. Slowness could be caused by extremely high load on Redis or networking
 issues.
 
+Since duplicate enqueueing of jobs is a possibility, make sure that that your code
+does not rely on this gem for sensitive, critical sections of code that must not
+be processed more than once.
+
 The locks are acquired for dynamic amounts of time, but expire quickly, typically
 in one second. Killed workers will not leave long-lived, orphaned locks to
 adversely block jobs from being enqueued.

data/lib/active_job/plugins/resque/solo.rb

@@ -29,7 +29,7 @@ module ActiveJob
           end
 
           def solo_inspector
-            @solo_inspector ||= Inspector.new(@solo_any_args, @solo_only_args, @solo_except_args, @solo_lock_key_prefix)
+            @solo_inspector ||= Inspector.new(@solo_any_args, @solo_only_args, @solo_except_args, @solo_lock_key_prefix, @solo_self_enqueueing)
           end
 
           def solo_lock_key_prefix(key_prefix)
@@ -37,6 +37,11 @@ module ActiveJob
             raise ArgumentError, "solo_lock_key_prefix cannot be blank or only spaces." if @solo_lock_key_prefix.blank?
 
           end
+
+          def solo_self_enqueueing(setting)
+            raise ArgumentError, "solo_self_enqueueing may only be set to :allow or :prevent." unless [:allow, :prevent].include?(setting)
+            @solo_self_enqueueing = (setting == :allow)
+          end
         end
       end
     end

data/lib/active_job/plugins/resque/solo/inspector.rb

@@ -8,13 +8,14 @@ module ActiveJob
       module Solo
         class Inspector
 
-          def initialize(any_args, only_args, except_args, lock_key_prefix)
+          def initialize(any_args, only_args, except_args, lock_key_prefix, self_enqueuing)
             @any_args = !!any_args
             @only_args = only_args
             @except_args = except_args || []
             # always ignore the ActiveJob symbol hash key.
             @except_args << "_aj_symbol_keys" unless @except_args.include?("_aj_symbol_keys")
             @lock_key_prefix = lock_key_prefix.present? ? lock_key_prefix : "ajr_solo"
+            @self_enqueueing = self_enqueuing
           end
 
           def self.resque_present?
@@ -63,7 +64,10 @@ module ActiveJob
             is_executing = ::Resque.workers.any? do |worker|
               processing = worker.processing
               next false if processing.blank?
+
               args = processing["payload"]["args"][0]
+              next false if (@self_enqueueing.nil? || @self_enqueueing) && args['job_id'] == job.job_id
+
               job_with_args_eq?(job_class, job_arguments, args)
             end
 

data/lib/active_job_resque_solo/version.rb

@@ -1,3 +1,3 @@
 module ActiveJobResqueSolo
-  VERSION = "0.3.9"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_job_resque_solo
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 1.0.0
 platform: ruby
 authors:
 - Phillip Kinkade
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-27 00:00:00.000000000 Z
+date: 2019-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Prevents duplicate ActiveJob+Resque jobs from being enqueued.