active_job_resque_solo 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f6e6f9c6d697e4099b2c8f301c6be99352942def
-  data.tar.gz: de97bbe74f0173a9893ccb391f249ad39a3ff035
+  metadata.gz: f760861754e12e2de29870716638d38d93ceaa09
+  data.tar.gz: 553f61b9c2b9653afc9217dc45f8439273311a06
 SHA512:
-  metadata.gz: 57fca794bd86021a0478302cd1887b200c640b3ed964dadea99973130497cd06ff5a57e8d0d029a7e539b8fe0030e19c33915170ca00513c51d36f620598b5aa
-  data.tar.gz: 8bdf98dd0cf360097cad44cda342140b3afc990a44e96df81d78d41925517f51235ee594eea3aec78382cbbcd0c3637543daf3b40b60907057a2a0ede2c7cd99
+  metadata.gz: e558f3fef406f0bf9b39740b697c05e889dda701a6aecc24684c6dd5106ce9b28ffd163da394ede37bcd972d9f9590033f1ed51ff786dc7f0ae4fe7c965fe7ab
+  data.tar.gz: f671a673aa14aacece35e289639331fd3dee4b5a723c7fa4efdce1ec10c806d71e194f2b0820aa6f8dc11e457e4c668bfb8cf998fad43c3c0c7829c05c15b1f2

data/README.md

@@ -38,8 +38,8 @@ Solo will prevent a new instance of the job from being enqueued.
 
 You can control which named arguments are used to determine uniqueness in the queue:
 
-`solo_only_args`
-`solo_except_args`
+* `solo_only_args`
+* `solo_except_args`
 
 ```ruby
 class MyJob < ActiveJob::Base
@@ -79,9 +79,9 @@ While this plugin will greatly reduce duplicate instances of a job from being
 enqueued, there are two scenarios where duplicates may still be enqueued,
 so be sure to check out other gems for locking if your job is not idempotent.
 
-1. When multiple processes simultaneously attempt to enqueue the same job two or
-more may be enqueued.
-2. If your queue has many jobs, and workers remove a job during while Solo scans
+1. When multiple processes simultaneously attempt to enqueue the same job, two or
+more instances may be enqueued.
+2. If your queue has many jobs, and workers remove a job while Solo scans
 the queue, it's possible for the original enqueued job to be missed. Solo will allow
 the new instance of the job to be enqueued.
 

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

@@ -1,115 +1,30 @@
+require_relative 'solo/inspector'
+
 module ActiveJob
   module Plugins
     module Resque
       module Solo
-
         def self.included(base_class)
           base_class.extend(ClassMethods)
 
           base_class.around_enqueue do |job, block|
-            base_class.solo_around_enqueue(job, block)
+            base_class.solo_inspector.around_enqueue(job, block)
           end
         end
 
         module ClassMethods
-          def resque_present?
-            ActiveJob::Base.queue_adapter == ActiveJob::QueueAdapters::ResqueAdapter
-          end
-
-          def solo_around_enqueue(job, block)
-            if resque_present?
-              # always ignore the ActiveJob symbol hash key.
-              @solo_except_args ||= []
-              @solo_except_args << "_aj_symbol_keys" unless @solo_except_args.include?("_aj_symbol_keys")
-
-              if !solo_job_enqueued?(job) && !solo_job_executing?(job)
-                block.call
-              end
-            else
-              # if resque is not present, always enqueue
-              block.call
-            end
-          end
-
           def solo_only_args(*args)
             @solo_only_args = args.compact.map(&:to_s).uniq
-            raise "Missing arguments for solo_only_args" if @solo_only_args.empty?
+            raise ArgumentError, "solo_only_args requires one or more field names" if @solo_only_args.empty?
           end
 
           def solo_except_args(*args)
             @solo_except_args = args.compact.map(&:to_s).uniq
-            raise "Missing arguments for solo_except_args" if @solo_except_args.empty?
-          end
-
-          def solo_job_enqueued?(job)
-            size = ::Resque.size(job.queue_name)
-            return false if size.zero?
-
-            page_size = 250
-            pages = (size/page_size).to_i + 1
-            jobs = []
-
-            # It's possible for this loop to skip jobs if they
-            # are dequeued while the loop is in progress.
-            (0..pages).each do |i|
-              page_start = i * page_size
-              page = ::Resque.peek(job.queue_name, page_start, page_size)
-              break if page.empty?
-              jobs += page
-            end
-
-            job_class, job_arguments = solo_job(job)
-
-            (jobs.size-1).downto(0) do |i|
-              scheduled_job = jobs[i]
-              return true if solo_job_enqueued_with_args?(job_class, job_arguments, scheduled_job)
-            end
-            false
-          end
-
-          def solo_job_executing?(job)
-            job_class, job_arguments = solo_job(job)
-
-            ::Resque.workers.any? do |worker|
-              processing = worker.processing
-              next false if processing.blank?
-              args = processing["payload"]["args"][0]
-              solo_job_with_args_eq?(job_class, job_arguments, args)
-            end
-          end
-
-          def solo_job_enqueued_with_args?(job_class, job_arguments, scheduled_job)
-            args = scheduled_job["args"][0]
-            solo_job_with_args_eq?(job_class, job_arguments, args)
+            raise ArgumentError, "solo_except_args requires one or more field names" if @solo_except_args.empty?
           end
 
-          def solo_job_with_args_eq?(job_class, job_arguments, wrapper_args)
-            return false if wrapper_args['job_class'] != job_class
-            encoded_arguments = wrapper_args['arguments']
-            encoded_arguments = solo_job_args(encoded_arguments)
-            encoded_arguments == job_arguments
-          end
-
-          def solo_job(job)
-            job_arguments = ActiveJob::Arguments.serialize(job.arguments)
-            job_arguments = solo_job_args(job_arguments)
-            job_class = job.class.name
-            [ job_class, job_arguments ]
-          end
-
-          def solo_job_args(args)
-            if args.present?
-              args.map do |arg|
-                if arg.is_a? Hash
-                  arg.keep_if { |k,v| @solo_only_args.include?(k.to_s) } if @solo_only_args.present?
-                  arg.keep_if { |k,v| !@solo_except_args.include?(k.to_s) } if @solo_except_args.present?
-                end
-
-                arg
-              end
-            end
-
-           args
+          def solo_inspector
+            @solo_inspector ||= Inspector.new(@solo_only_args, @solo_except_args)
           end
         end
       end

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

@@ -0,0 +1,104 @@
+module ActiveJob
+  module Plugins
+    module Resque
+      module Solo
+        class Inspector
+
+          def initialize(only_args, except_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")
+          end
+
+          def self.resque_present?
+            ActiveJob::Base.queue_adapter == ActiveJob::QueueAdapters::ResqueAdapter
+          end
+
+          def around_enqueue(job, block)
+            if Inspector::resque_present?
+
+              if !job_enqueued?(job) && !job_executing?(job)
+                block.call
+              end
+            else
+              # if resque is not present, always enqueue
+              block.call
+            end
+          end
+
+          def job_enqueued?(job)
+            size = ::Resque.size(job.queue_name)
+            return false if size.zero?
+
+            page_size = 250
+            pages = (size/page_size).to_i + 1
+            jobs = []
+
+            # It's possible for this loop to skip jobs if they
+            # are dequeued while the loop is in progress.
+            (0..pages).each do |i|
+              page_start = i * page_size
+              page = ::Resque.peek(job.queue_name, page_start, page_size)
+              break if page.empty?
+              jobs += page
+            end
+
+            job_class, job_arguments = job(job)
+
+            (jobs.size-1).downto(0) do |i|
+              scheduled_job = jobs[i]
+              return true if job_enqueued_with_args?(job_class, job_arguments, scheduled_job)
+            end
+            false
+          end
+
+          def job_executing?(job)
+            job_class, job_arguments = job(job)
+
+            ::Resque.workers.any? do |worker|
+              processing = worker.processing
+              next false if processing.blank?
+              args = processing["payload"]["args"][0]
+              job_with_args_eq?(job_class, job_arguments, args)
+            end
+          end
+
+          def job_enqueued_with_args?(job_class, job_arguments, scheduled_job)
+            args = scheduled_job["args"][0]
+            job_with_args_eq?(job_class, job_arguments, args)
+          end
+
+          def job_with_args_eq?(job_class, job_arguments, wrapper_args)
+            return false if wrapper_args['job_class'] != job_class
+            encoded_arguments = wrapper_args['arguments']
+            encoded_arguments = job_args(encoded_arguments)
+            encoded_arguments == job_arguments
+          end
+
+          def job(job)
+            job_arguments = ActiveJob::Arguments.serialize(job.arguments)
+            job_arguments = job_args(job_arguments)
+            job_class = job.class.name
+            [ job_class, job_arguments ]
+          end
+
+          def job_args(args)
+            if args.present?
+              args.map do |arg|
+                if arg.is_a? Hash
+                  arg.keep_if { |k,v| @only_args.include?(k.to_s) } if @only_args.present?
+                  arg.keep_if { |k,v| !@except_args.include?(k.to_s) } if @except_args.present?
+                end
+
+                arg
+              end
+            end
+
+            args
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_job_resque_solo/version.rb

@@ -1,3 +1,3 @@
 module ActiveJobResqueSolo
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_job_resque_solo
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Phillip Kinkade
@@ -106,6 +106,7 @@ files:
 - bin/console
 - bin/setup
 - lib/active_job/plugins/resque/solo.rb
+- lib/active_job/plugins/resque/solo/inspector.rb
 - lib/active_job_resque_solo.rb
 - lib/active_job_resque_solo/version.rb
 homepage: