resque-multi-step 1.0.1 → 1.1.0

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/lib/resque/plugins/multi_step_task.rb

@@ -11,6 +11,11 @@ module Resque
       class NoSuchMultiStepTask < StandardError; end
       class NotReadyForFinalization < StandardError; end
       class FinalizationAlreadyBegun < StandardError; end
+      class StdOutLogger
+        def warn(*args); puts args; end
+        def info(*args); puts args; end
+        def debug(*args); puts args; end
+      end
 
       class << self
         include Constantization
@@ -34,7 +39,7 @@ module Resque
           redis.sismember("active-tasks", task_id)
         end
         
-        # Create a brand new parallel job group.
+        # Create a brand new multi-step-task.
         #
         # @param [#to_s] slug The descriptive slug of the new job.  Default: a
         #   random UUID
@@ -52,16 +57,16 @@ module Resque
                     end
           task_id << "~" << nonce
           
-          pjg = new(task_id)
-          pjg.nuke
+          mst = new(task_id)
+          mst.nuke
           redis.sadd("active-tasks", task_id)
           redis.sismember("active-tasks", task_id)
           if block_given?
             yield pjg
-            pjg.finalizable!
+            mst.finalizable!
           end
           
-          pjg
+          mst
         end
 
         # Prevent calling MultiStepTask.new
@@ -71,13 +76,13 @@ module Resque
         #
         # @param [#to_s] task_id The unique key for the job group of interest.
         #
-        # @return [ParallelJobGroup] The group of interest
+        # @return [MultiStepTask] The group of interest
         #
         # @raise [NoSuchMultiStepTask] If there is not a group with the specified key.
         def find(task_id)
           raise NoSuchMultiStepTask unless active?(task_id)
           
-          pjg = new(task_id)
+          mst = new(task_id)
         end
 
         # Handle job invocation
@@ -89,8 +94,16 @@ module Resque
         def perform_without_maybe_finalize(task_id, job_module_name, *args)
           task = MultiStepTask.find(task_id)
           begin
+            job_start_key = "#{task_id}_#{job_module_name}_#{args}-start-time-#{nonce}"
+            task.redis.set(job_start_key, Time.now.to_i)
+            logger.debug("[Resque Multi-Step-Task] Executing #{job_module_name} job for #{task_id} at #{Time.now} (args: #{args})")
+
+            # perform the task
             constantize(job_module_name).perform(*args)
+
+            logger.debug("[Resque Multi-Step-Task] Finished executing #{job_module_name} job for #{task_id} at #{Time.now}, taking #{(Time.now - task.redis.get(job_start_key).to_i).to_i} seconds.")
           rescue Exception => e
+            logger.error("[Resque Multi-Step-Task] #{job_module_name} job failed for #{task_id} at #{Time.now} (args: #{args})")
             task.increment_failed_count
             raise
           end
@@ -102,6 +115,14 @@ module Resque
           perform_without_maybe_finalize(task_id, job_module_name, *args)
         end
 
+        def logger=(logger)
+          @@logger = logger
+        end
+
+        def logger
+          @@logger ||= RAILS_DEFAULT_LOGGER || StdOutLogger.new
+        end
+
         # Normally jobs that are part of a multi-step task are run
         # asynchronously by putting them on a queue.  However, it is
         # often more convenient to just run the jobs synchronously as
@@ -128,6 +149,7 @@ module Resque
       include Constantization
 
       attr_reader :task_id
+      attr_accessor :logger
 
       extend AtomicCounters
 
@@ -143,6 +165,11 @@ module Resque
       # @param [String] task_id The UUID of the group of interest.
       def initialize(task_id)
         @task_id = task_id
+        redis.set 'start-time', Time.now.to_i
+      end
+
+      def logger
+        self.class.logger
       end
 
       def redis
@@ -171,6 +198,7 @@ module Resque
       # @param [Class,Module] job_type The type of the job to be performed.
       def add_job(job_type, *args)
         increment_normal_job_count
+        logger.debug("[Resque Multi-Step-Task] Adding #{job_type} job for #{task_id} (args: #{args})")
 
         if synchronous?
           self.class.perform(task_id, job_type.to_s, *args)
@@ -186,6 +214,7 @@ module Resque
       # @param [Class,Module] job_type The type of job to be performed.
       def add_finalization_job(job_type, *args)
         increment_finalize_job_count
+        logger.debug("[Resque Multi-Step-Task] Adding #{job_type} finalization job for #{task_id} (args: #{args})")
 
         redis.rpush 'finalize_jobs', Yajl::Encoder.encode([job_type.to_s, *args])
       end
@@ -217,6 +246,7 @@ module Resque
       # @raise [FinalizationAlreadyBegun] If some other process has
       #   already started (and/or finished) the finalization process.
       def finalize!
+        logger.debug("[Resque Multi-Step-Task] Attempting to finalize #{task_id}")
         raise FinalizationAlreadyBegun unless MultiStepTask.active?(task_id)
         raise NotReadyForFinalization if !ready_for_finalization? || incomplete_because_of_errors?
 
@@ -233,6 +263,7 @@ module Resque
             Resque::Job.create(queue_name, FinalizationJob, self.task_id, *fin_job_info)
           else
             # There is nothing left to do so cleanup.
+            logger.debug "[Resque Multi-Step-Task] \"#{task_id}\" finalized successfully at #{Time.now}, taking #{(Time.now - redis.get('start-time').to_i).to_i} seconds."
             nuke
           end
         end
@@ -243,6 +274,8 @@ module Resque
           job_class_name, *args = Yajl::Parser.parse(fin_job_info)
           self.class.perform_finalization(task_id, job_class_name, *args)
         end
+
+        logger.debug "[Resque Multi-Step-Task] \"#{task_id}\" finalized successfully at #{Time.now}, taking #{(Time.now - redis.get('start-time').to_i).to_i} seconds."
         nuke
       end
 

data/resque-multi-step.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{resque-multi-step}
-  s.version = "1.0.1"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Williams", "Morgan Whitney"]
-  s.date = %q{2011-01-31}
+  s.date = %q{2011-02-18}
   s.description = %q{Provides multi-step tasks with finalization and progress tracking}
   s.email = %q{pezra@barelyenough.org}
   s.extra_rdoc_files = [

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: resque-multi-step
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 1
-  - 0
   - 1
-  version: 1.0.1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Peter Williams
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-31 00:00:00 -07:00
+date: 2011-02-18 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency