queue_dispatcher 2.3.0 → 2.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f35bcc5afab97bb7da1c28e6c33db73216e8b29e
-  data.tar.gz: cb909b73223caf2192d7f4a437cb2f49be17a97e
+  metadata.gz: 8b13a171b35ddf613aa446a4c918a1e994ec24e3
+  data.tar.gz: 0e831f41b6d5815e4418946cb7b6a924444a360b
 SHA512:
-  metadata.gz: 970e6acfbb9a957ad130615294e5783c60ff2735ca3f96c756a683f8f807a1ac478351df68b8f997459e5251b43afcf5d6d6268e0b454071f0ee47a5e32041df
-  data.tar.gz: 1eeec8fc00fa057ab6fb35856f04e0c578c0798a96832e40fcba76dd71ca65e5f08a4579e233e16fbb0a9778316874d0c262d51444ec05360780bf9f00b63c95
+  metadata.gz: 877e9ea6a9313f4b73c3d15f0cfdcfa07d7b6524f7b84df26b9765a986af0124852bdfcbe321301a4dc2dd8bd5ee1234bf314d8ac71111c8dac482ec49066615
+  data.tar.gz: 9319b0f7053f7a1e712d6e458ad12cbc55830a93edbe1442dabf5ea6224cdaadbb05ca7155796d20296b08de9b79b5fb853afef59b4f003379774273daa340d4

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 2.5.3 / 2015-08-19
+### Fixed
+* Fix frozen NilClass error when no @engine instance varaiable is set

data/lib/queue_dispatcher/acts_as_task.rb

@@ -40,6 +40,15 @@ module QueueDispatcher
           belongs_to :dependent_task, :class_name => '#{self.name}'
         }
       end
+
+
+      [:success, :error].each do |state|
+        define_method("on_#{state}") do |*method_names|
+          method_names.each do |method_name|
+            eval "(@#{state}_callback_chain ||= []) << method_name"
+          end
+        end
+      end
     end
 
 
@@ -47,6 +56,13 @@ module QueueDispatcher
       def acts_as_task_config
         @acts_as_task_config
       end
+
+
+      [:success, :error].each do |state|
+        define_method("#{state}_callback_chain") do
+          eval("@#{state}_callback_chain") || []
+        end
+      end
     end
 
 
@@ -74,7 +90,7 @@ module QueueDispatcher
 
 
       # This method updates the task state according to the return code of their corresponding command and removes it from the task_queue
-      def update_state(result, remove_from_queue = false)
+      def update_state_and_exec_callbacks(result, remove_from_queue = false, logger = nil)
         rc = output = error_msg = nil
 
         if result.methods.map(&:to_sym).include?(:rc) && result.methods.map(&:to_sym).include?(:output) && result.methods.map(&:to_sym).include?(:error_msg)
@@ -90,21 +106,25 @@ module QueueDispatcher
         end
 
         output ||= ''
+        successful = result.methods.map(&:to_sym).include?(:successful?) ? result.successful? : rc.nil? || rc == 0
 
-        if rc.nil? || rc == 0
+        if successful
           self.update_attributes :state         => 'successful',
                                  :perc_finished => 100,
                                  :message       => output.truncate(10256),
                                  :result        => result
+          success_callbacks(logger)
         else
           self.update_attributes :state     => 'error',
                                  :error_msg => error_msg,
                                  :message   => output.truncate(10256),
                                  :result    => result
+          error_callbacks(logger)
         end
 
         self.update_attributes :task_queue_id => nil if remove_from_queue
 
+
         rc
       end
 
@@ -216,6 +236,23 @@ module QueueDispatcher
         payload.send(method_name, *args)
       end
 
+    private
+
+      # Callbacks
+      [:success, :error].each do |state|
+        define_method("#{state}_callbacks") do |logger|
+          eval("self.class.#{state}_callback_chain").each do |method_name|
+            begin
+              send method_name
+            rescue => exception
+              backtrace = exception.backtrace.join("\n  ")
+              msg = "Fatal error in method '#{method_name}', while executing it in #{state}_callbacks: #{$!}\n  #{backtrace}"
+              logger.send(:error, msg) if logger
+            end
+          end
+        end
+      end
+
     end
   end
 end

data/lib/queue_dispatcher/acts_as_task_queue.rb

@@ -52,6 +52,26 @@ module QueueDispatcher
       end
 
 
+      # Check if a certain PID is still running and is a ruby process
+      def pid_running?(pid)
+        ps = pid ? Sys::ProcTable.ps(pid) : nil
+        if ps
+          # Asume, that if the command of the 'ps'-output is 'ruby', the process is still running
+          ps.comm == 'ruby'
+        else
+          false
+        end
+      end
+
+
+      # Check if QueueDispatcher is running.
+      def qd_running?
+        running = false
+        TaskQueue.where(state: 'heartbeat').each { |tq| running = true if tq.updated_at > 1.minute.ago }
+        running
+      end
+
+
       # Are there any running task_queues?
       def any_running?
         running = false
@@ -66,7 +86,7 @@ module QueueDispatcher
 
         transaction do
           # Find next task_queue which is not running and not in state error
-          order(:id).lock(true).all.each { |tq| task_queue = tq unless task_queue || tq.pid_running? || tq.state == 'error' }
+          order(:id).lock(true).all.each { |tq| task_queue = tq unless task_queue || tq.pid_running? || tq.state == 'error' || tq.state == 'heartbeat' }
 
           # Update pid inside the atomic transaction to be sure, the next call of this method will not give the same queue a second time
           task_queue.update_attribute :pid, $$ if task_queue
@@ -179,13 +199,7 @@ module QueueDispatcher
 
       # Return true, if the command of the process with pid 'self.pid' is 'ruby'
       def pid_running?
-        ps = self.pid ? Sys::ProcTable.ps(self.pid) : nil
-        if ps
-          # Asume, that if the command of the 'ps'-output is 'ruby', the process is still running
-          ps.comm == 'ruby'
-        else
-          false
-        end
+        self.class.pid_running?(self.pid)
       end
 
 
@@ -276,7 +290,7 @@ module QueueDispatcher
         task_queue.update_attribute :state, 'running'
 
         # Set logger in engine
-        @engine.logger = @logger if defined? @engine && @engine.methods.include?(:logger=)
+        @engine.logger = @logger if defined?(@engine) && @engine.methods.include?(:logger=)
         log :msg => "#{name}: Starting TaskQueue #{task_queue.id}...", :print_log => print_log
 
         # Init. Pop first task from queue, to show init_queue-state
@@ -328,7 +342,7 @@ module QueueDispatcher
               end
 
               # Change task state according to the return code and remove it from the queue
-              task.update_state result
+              task.update_state_and_exec_callbacks(result, false, logger)
               cleanup_locks_after_error_for task
               task.update_attribute :task_queue_id, nil unless acts_as_task_queue_config.leave_finished_tasks_in_queue
               log :msg => "#{name}: Task #{task.id} (#{task.payload.class.name}.#{task.method_name}) finished with state '#{task.state}'.", :print_log => print_log
@@ -378,7 +392,7 @@ module QueueDispatcher
         backtrace = exception.backtrace.join("\n  ")
         log :msg => "Fatal error in method 'run!': #{$!}\n  #{backtrace}", :sev => :error, :print_log => print_log
         puts "Fatal error in method 'run!': #{$!}\n#{backtrace}"
-        task.update_state QueueDispatcher::RcAndMsg.bad_rc("Fatal error: #{$!}") if task
+        task.update_state_and_exec_callbacks(QueueDispatcher::RcAndMsg.bad_rc("Fatal error: #{$!}"), false, logger) if task
         cleanup_locks_after_error_for task if task
         task.update_attributes state: 'error' if task && task.state != 'finished'
       ensure

data/lib/queue_dispatcher/version.rb

@@ -1,3 +1,3 @@
 module QueueDispatcher
-  VERSION = "2.3.0"
+  VERSION = "2.5.3"
 end

data/queue_dispatcher.gemspec

@@ -7,17 +7,18 @@ Gem::Specification.new do |s|
   s.version     = QueueDispatcher::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Philip Kurmann"]
-  s.email       = ["philip.kurmann@inwork.ch"]
-  s.homepage    = ""
+  s.email       = ["info@inwork.ch"]
+  s.license     = "MIT"
+  s.homepage    = "https://inwork.github.io/queue_dispatcher/"
   s.summary     = %q{This Gem installs a queue dispatcher for handling asynchronous tasks}
   s.description = %q{Queue_Dispatcher executes asynchronous tasks in the background.}
 
-  s.add_dependency 'sys-proctable', '>= 0.9.1'
-  s.add_dependency 'deadlock_retry'
-  s.add_dependency 'spawnling'
-  s.add_dependency 'haml'
-  s.add_dependency 'will_paginate'
-  s.add_dependency 'jquery-rails'
+  s.add_dependency 'sys-proctable', '~> 0.9'
+  s.add_dependency 'deadlock_retry', '~> 0'
+  s.add_dependency 'spawnling', '~> 0'
+  s.add_dependency 'haml', '~> 0'
+  s.add_dependency 'will_paginate', '~> 0'
+  s.add_dependency 'jquery-rails', '~> 0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/script/queue_worker_dispatcher

@@ -35,7 +35,8 @@ $daemon = {
   :background => false,                                                                # background mode
   :work => true,                                                                       # daemon work flag
   :logger_msg_prefix => nil,                                                           # Prefix for logging
-  :worker_pids => []                                                                   # Remember PIDs
+  :worker_pids => [],                                                                  # Remember PIDs
+  :heartbeat_task_queue_id => nil                                                      # Remember ID of the Heartbeat-TaskQueue
 }
 
 $worker = {
@@ -74,6 +75,7 @@ end
 
 # Clean up before a daemon terminates
 def daemon_clean_up
+  TaskQueue.where(id: $daemon[:heartbeat_task_queue_id]).destroy_all
   File.delete($daemon[:pid_file])
 end
 
@@ -137,14 +139,15 @@ def daemon_start
 
     # Asume, that if the command of the 'ps'-output is 'ruby', the process is still running
     if ps && (ps.comm == 'ruby')
-      daemon_log :msg => "Process already running!", :sev => :error
+      daemon_log :msg => 'Process already running!', :sev => :error
       exit
     else
       File.delete($daemon[:pid_file])
     end
   end
 
-  daemon_log :msg => "Starting process..."
+  # Start daemon
+  daemon_log :msg => 'Starting process...'
   if $daemon[:background]
     Spawnling.new { daemon_runner }
   else
@@ -153,11 +156,25 @@ def daemon_start
 end
 
 
+# update heartbeat
+def daemon_update_heartbeat
+  hb_tq = TaskQueue.find_by(id: $daemon[:heartbeat_task_queue_id])
+  if hb_tq
+    hb_tq.touch
+  else
+    hb_tq = TaskQueue.create(name: 'QD_HeartBeat', state: 'heartbeat', pid: Process.pid)
+    $daemon[:heartbeat_task_queue_id] = hb_tq.id
+  end
+end
+
+
 # Start an amount of workers
 def spawn_and_monitor_workers
   daemon_log :msg => "Spawning #{$daemon[:worker_count]} workers..."
 
   while $daemon[:work]
+    daemon_update_heartbeat
+
     # (Re)start workers
     while $daemon[:worker_pids].count < $daemon[:worker_count] do
       sp = Spawnling.new(:argv => $worker[:process_prefix]) do
@@ -197,7 +214,7 @@ def worker_runner
     if $worker[:task_queue]
       # Set Process Name and execute tasks
       $0 = "#{$worker[:process_prefix]}_#{$worker[:task_queue].id}"
-      $worker[:task_queue].run!(:print_log => ! $daemon[:background])
+      $worker[:task_queue].run!(:print_log => ! $daemon[:background], logger: @logger)
     else
       # Set Process Name and sleep
       $0 = "#{$worker[:process_prefix]}_idle"

metadata

@@ -1,107 +1,108 @@
 --- !ruby/object:Gem::Specification
 name: queue_dispatcher
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.5.3
 platform: ruby
 authors:
 - Philip Kurmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-26 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sys-proctable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: deadlock_retry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: spawnling
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: haml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: will_paginate
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: Queue_Dispatcher executes asynchronous tasks in the background.
 email:
-- philip.kurmann@inwork.ch
+- info@inwork.ch
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.rdoc
@@ -151,8 +152,9 @@ files:
 - lib/tasks/queue_dispatcher.rake
 - queue_dispatcher.gemspec
 - script/queue_worker_dispatcher
-homepage: ''
-licenses: []
+homepage: https://inwork.github.io/queue_dispatcher/
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -170,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: This Gem installs a queue dispatcher for handling asynchronous tasks