active_job_resque_solo 0.3.7 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 72502b86b6c49cfeb92e359f9340a3737dba7981
-  data.tar.gz: e03691514ce1c21284e3387046cec327b6231ccd
+SHA256:
+  metadata.gz: 126eccd94fe2707054d3f71df759356195a2a35384d1e23f4e41e372e9018689
+  data.tar.gz: 9057a3920c53718249521315d5fa14768c449a4ee3fe2515528330f94ff7badb
 SHA512:
-  metadata.gz: 33698ec7e0d40e624378bd4d46d90b2becb2ec92a731a0752b9f1accd709135f33ce4fe523e1b0afbeabc0ddd96a2319758d1ff8b0164f0442e8233b492818ad
-  data.tar.gz: 58dfa53e53233c4eeda6359ad2e07bf31bc6a14643c2647da9e932c35824a3dc01b01d4780e33718440dc5acbf7fe75cac4872953e9e40264d848e45101f34bc
+  metadata.gz: 202daaa606d4210ffbec4cfd40f8205a31f2bfc3eb9117da4aad29cb78f7edb7f9a22a39fd2b272c2ea9f8ddcd58df7afbad63751fcbb0b2618b7ad9fe070d8b
+  data.tar.gz: af1ae2f42cfb0ea09ad8b501bada453c5e1d58216cc8cbf79aaa4cb9b12dfdcabea1b9ee4108a99367eceef3ce4a27ea87285e9d69cbf3faf24745c88b0fa0ff

data/.travis.yml

@@ -1,8 +1,9 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.2.0
-  - 2.3.0
-  - 2.4.0
+  - 2.5.7
+  - 2.6.0
+  - 2.7.0
+  - 3.0.1
   - ruby-head
-before_install: gem install bundler -v 1.15.4
+before_install: gem install bundler -v "$(grep -A 1 "BUNDLED WITH" Gemfile.lock | tail -n 1)"

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+# 1.0.2
+* If a worker is processing a job that does not have ActiveJob arguments, allow it to be enqueued rather than failing with an error. This happens if a job has been queued by Resque directly without ActiveJob.
+
+# 1.0.1
+
+* Allow Rails 6.
+
+# 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.
+
+# 0.3.8
+
+* Fix bug that caused ActiveJobResqueSolo to fail to realize that the Rails app was configured for Resque.
+
 # 0.3.7
 
 * Fix bug that would prevent resque-scheduler from enqueuing jobs with no arguments.

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/active_job_resque_solo.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.2.0"
 
-  spec.add_dependency "rails", ">= 4.2.0", "< 6"
+  spec.add_dependency "rails", ">= 4.2.0"
 
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "bundler"

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,17 +8,18 @@ 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?
-            ActiveJob::Base.queue_adapter == ActiveJob::QueueAdapters::ResqueAdapter
+            ActiveJob::Base.queue_adapter.is_a? ActiveJob::QueueAdapters::ResqueAdapter
           end
 
           def around_enqueue(job, block)
@@ -63,7 +64,11 @@ 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 args.blank?
+              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.7"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_job_resque_solo
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 1.0.2
 platform: ruby
 authors:
 - Phillip Kinkade
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-05 00:00:00.000000000 Z
+date: 2021-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -131,8 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Prevents duplicate ActiveJob+Resque jobs from being enqueued.