sidekiq-superworker 0.0.4 → 0.0.5

data/app/models/sidekiq/superworker/subjob.rb

@@ -26,6 +26,10 @@ module Sidekiq
       def next
         relatives.where(subjob_id: next_id).first
       end
+
+      def to_info
+        "Subjob ##{id} (#{superworker_class} > #{subworker_class})"
+      end
     end
   end
 end

data/lib/sidekiq/superworker.rb

@@ -7,6 +7,14 @@ Dir.glob("#{directory}/../../app/models/sidekiq/superworker/*.rb") { |file| requ
 
 module Sidekiq
   module Superworker
+    def self.logger
+      Logging.logger
+    end
+
+    def self.debug(message)
+      logger.debug(message)
+    end
+
     def self.table_name_prefix
       'sidekiq_superworker_'
     end

data/lib/sidekiq/superworker/logging.rb

@@ -0,0 +1,30 @@
+module Sidekiq
+  module Superworker
+    class Logging
+      class Pretty < Logger::Formatter
+        def call(severity, time, program_name, message)
+          "#{Time.now.utc.iso8601} Superworker #{severity}: #{message}\n"
+        end
+      end
+
+      def self.initialize_logger(log_target = STDOUT)
+        @logger = Logger.new(log_target)
+        @logger.level = Logger::INFO
+        @logger.formatter = Pretty.new
+        @logger
+      end
+
+      def self.logger
+        @logger || initialize_logger
+      end
+
+      def self.logger=(log)
+        @logger = (log ? log : Logger.new('/dev/null'))
+      end
+
+      def logger
+        Sidekiq::Superworker::Logging.logger
+      end
+    end
+  end
+end

data/lib/sidekiq/superworker/processor.rb

@@ -2,6 +2,7 @@ module Sidekiq
   module Superworker
     class Processor
       def complete(item, new_thread=true)
+        Superworker.debug "JID ##{item['jid']}: Sidekiq job complete"
         if new_thread
           # Run this in a new thread so that its execution isn't considered to be part of the
           # completed job's execution.
@@ -16,6 +17,7 @@ module Sidekiq
       def error(worker, item, queue, exception)
         raise "Job has nil jid: #{item}" if item['jid'].nil?
 
+        Superworker.debug "JID ##{item['jid']}: Error thrown"
         subjob = find_subjob_by_jid(item['jid'])
         SuperjobProcessor.error(subjob.superjob_id, worker, item, exception) if subjob
       end
@@ -25,21 +27,26 @@ module Sidekiq
       def complete_item(item)
         raise "Job has nil jid: #{item}" if item['jid'].nil?
 
+        Superworker.debug "JID ##{item['jid']}: Passing job from Sidekiq to Superworker"
         subjob = find_subjob_by_jid(item['jid'])
         SubjobProcessor.complete(subjob) if subjob
       end
 
-      # The job may've been created outside of sidekiq-superworker, so a nil return value for
-      # this method isn't necessarily problematic
+      # Note: The job may've been created outside of sidekiq-superworker, so a nil return value
+      # for this method isn't necessarily problematic
       def find_subjob_by_jid(jid)
+        Superworker.debug "JID ##{jid}: Trying to find Subjob"
         # The job may complete before the Subjob record is created; in case that happens,
         # we need to sleep briefly and requery.
-        max_tries = 5
-        try = 0
-        while !(subjob = Subjob.find_by_jid(jid)) && try < max_tries
-          sleep 2 ** try
-          try += 1
+        tries = 5
+        subjob = nil
+        (1..tries).each do |try|
+          subjob = Subjob.find_by_jid(jid)
+          break if subjob
+          Superworker.debug "JID ##{jid}: Sleeping before trying to find Subjob again"
+          sleep (2 ** try)
         end
+        Superworker.debug "JID ##{jid}: Subjob found: #{subjob ? subjob.to_info : 'nil'}"
         subjob
       end
     end

data/lib/sidekiq/superworker/subjob_processor.rb

@@ -2,12 +2,16 @@ module Sidekiq
   module Superworker
     class SubjobProcessor
       def self.enqueue(subjob)
+        Superworker.debug "#{subjob.to_info}: Trying to enqueue"
         # Only enqueue subjobs that aren't running, complete, etc
         return unless subjob.status == 'initialized'
         
+        Superworker.debug "#{subjob.to_info}: Enqueueing"
         # If this is a parallel subjob, enqueue all of its children
         if subjob.subworker_class == 'parallel'
           subjob.update_attribute(:status, 'running')
+
+          Superworker.debug "#{subjob.to_info}: Enqueueing parallel children"
           jids = subjob.children.collect do |child|
             enqueue(child)
           end
@@ -31,6 +35,8 @@ module Sidekiq
       end
 
       def self.enqueue_in_sidekiq(subjob, klass)
+        Superworker.debug "#{subjob.to_info}: Enqueueing in Sidekiq"
+
         # If sidekiq-unique-jobs is being used for this worker, a number of issues arise if the subjob isn't
         # queued, so we'll bypass the unique functionality of the worker while running the subjob.
         is_unique = klass.respond_to?(:sidekiq_options_hash) && !!klass.sidekiq_options_hash['unique']
@@ -52,11 +58,13 @@ module Sidekiq
       end
 
       def self.complete(subjob)
+        Superworker.debug "#{subjob.to_info}: Complete"
         subjob.update_attribute(:status, 'complete')
 
         # If children are present, enqueue the first one
         children = subjob.children
         if children.present?
+          Superworker.debug "#{subjob.to_info}: Enqueueing children"
           enqueue(children.first)
           return
         # Otherwise, set this as having its descendants complete
@@ -66,6 +74,7 @@ module Sidekiq
       end
 
       def self.descendants_are_complete(subjob)
+        Superworker.debug "#{subjob.to_info}: Descendants are complete"
         subjob.update_attribute(:descendants_are_complete, true)
 
         parent = subjob.parent
@@ -76,6 +85,7 @@ module Sidekiq
         if parent
           siblings_descendants_are_complete = parent.children.all? { |child| child.descendants_are_complete }
           if siblings_descendants_are_complete
+            Superworker.debug "#{subjob.to_info}: Parent (#{parent.to_info}) is complete"
             descendants_are_complete(parent)
             parent.update_attribute(:status, 'complete') if is_child_of_parallel
           end
@@ -94,6 +104,7 @@ module Sidekiq
             descendants_are_complete(parent)
           # Otherwise, this is the final subjob of the superjob
           else
+            Superworker.debug "#{subjob.to_info}: Superjob is complete"
             SuperjobProcessor.complete(subjob.superjob_id)
           end
         end

data/lib/sidekiq/superworker/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Superworker
-    VERSION = '0.0.4'
+    VERSION = '0.0.5'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-superworker
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-11 00:00:00.000000000 Z
+date: 2013-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -103,6 +103,7 @@ files:
 - lib/generators/sidekiq/superworker/install/templates/create_sidekiq_superworker_subjobs.rb
 - lib/sidekiq/superworker/dsl_evaluator.rb
 - lib/sidekiq/superworker/dsl_parser.rb
+- lib/sidekiq/superworker/logging.rb
 - lib/sidekiq/superworker/processor.rb
 - lib/sidekiq/superworker/server/middleware.rb
 - lib/sidekiq/superworker/subjob_processor.rb