bumbleworks 0.0.32 → 0.0.33

data/lib/bumbleworks/ruote.rb

@@ -43,6 +43,27 @@ module Bumbleworks
         dashboard.launch(dashboard.variables[name], *args)
       end
 
+      def cancel_process!(wfid, options = {})
+        options[:timeout] ||= 5
+        unless options[:method] == :kill
+          options[:method] = :cancel
+        end
+
+        dashboard.send(options[:method], wfid)
+        start_time = Time.now
+        while dashboard.process(wfid)
+          if (Time.now - start_time) > options[:timeout]
+            error_type = options[:method] == :cancel ? CancelTimeout : KillTimeout
+            raise error_type, "Process #{options[:method]} taking too long - #{dashboard.processes.count} processes remain.  Errors: #{dashboard.errors}"
+          end
+          sleep 0.1
+        end
+      end
+
+      def kill_process!(wfid, options = {})
+        cancel_process!(wfid, options.merge(:method => :kill))
+      end
+
       def cancel_all_processes!(options = {})
         options[:timeout] ||= 5
         unless options[:method] == :kill

data/lib/bumbleworks/ruote/exp/wait_for_event_expression.rb

@@ -5,6 +5,11 @@ module Ruote::Exp
   class WaitForEventExpression < AwaitExpression
     names :wait_for_event
 
+    # This does the same as the base AwaitExpression#apply, except that this
+    # will always be a global listener, listening for a 'left_tag' event, and
+    # the event's workitem will be discarded after the reply is complete.  The
+    # event's workitem is only used for comparisons in the where clause (see
+    # #reply).
     def apply
       update_tree
       h.updated_tree[1]['global'] = true
@@ -13,14 +18,29 @@ module Ruote::Exp
       super
     end
 
+    # On apply, the workitem for this FlowExpression was replaced by the workitem
+    # from the event.  So when we refer to "f:" in this #reply method, we're
+    # looking at the event's workitem, which will be discarded at the end of this
+    # reply (and replaced with the applied workitem).  In order to compare the
+    # event's workitem with the applied workitem (so we can determine whether or
+    # not the event was intended for us), we assign the applied_workitem's fields
+    # to a hash on the event's workitem fields, available at "f:receiver.*".
     def reply(workitem)
       update_tree
+      # If we have a where clause at all...
       if translated_where = attribute(:where, nil, :escape => true)
         if translated_where.to_s == 'entities_match'
+          # Check to see that the event's entity is equal to the current workitem's
+          # entity.  If so, this message is intended for us.
           translated_where = '${f:entity_id} == ${f:receiver.entity_id} && ${f:entity_type} == ${f:receiver.entity_type}'
         else
-          translated_where.gsub!('${event:', '${f:')
-          translated_where.gsub!('${this:', '${f:receiver.')
+          # This just gives us a shortcut so the process definition reads more
+          # clearly.  You could always use "${f:" and "${f:receiver." in your
+          # where clauses, but you have to remember that the former refers to the
+          # incoming event's workitem, and the latter is the workitem of the
+          # listening process.
+          translated_where.gsub!('${event:', '${f:') # event workitem
+          translated_where.gsub!('${this:', '${f:receiver.') # listening workitem
         end
         h.updated_tree[1]['where'] = translated_where
       end

data/lib/bumbleworks/version.rb

@@ -1,3 +1,3 @@
 module Bumbleworks
-  VERSION = "0.0.32"
+  VERSION = "0.0.33"
 end

data/spec/lib/bumbleworks/ruote_spec.rb

@@ -4,6 +4,70 @@ describe Bumbleworks::Ruote do
     Bumbleworks.storage = {}
   end
 
+  describe ".cancel_process!" do
+    before :each do
+      Bumbleworks.start_worker!
+    end
+
+    it 'cancels given process' do
+      Bumbleworks.define_process 'do_nothing' do
+        lazy_guy :task => 'absolutely_nothing'
+      end
+      wfid = Bumbleworks.launch!('do_nothing')
+      Bumbleworks.dashboard.wait_for(:lazy_guy)
+      Bumbleworks.dashboard.process(wfid).should_not be_nil
+      described_class.cancel_process!(wfid)
+      Bumbleworks.dashboard.process(wfid).should be_nil
+    end
+
+    it 'times out if process is not cancelled in time' do
+      Bumbleworks.define_process "time_hog" do
+        sequence :on_cancel => 'ignore_parents' do
+          pigheaded :task => 'whatever'
+        end
+        define 'ignore_parents' do
+          wait '1s'
+        end
+      end
+      wfid = Bumbleworks.launch!('time_hog')
+      Bumbleworks.dashboard.wait_for(:pigheaded)
+      Bumbleworks.dashboard.process(wfid).should_not be_nil
+      expect {
+        described_class.cancel_process!(wfid, :timeout => 0.5)
+      }.to raise_error(Bumbleworks::Ruote::CancelTimeout)
+    end
+  end
+
+  describe ".kill_process!" do
+    before :each do
+      Bumbleworks.start_worker!
+    end
+
+    it 'kills given process without running on_cancel' do
+      Bumbleworks.define_process "do_nothing" do
+        sequence :on_cancel => 'rethink_life' do
+          lazy_guy :task => 'absolutely_nothing'
+        end
+        define 'rethink_life' do
+          wait '10s'
+        end
+      end
+      wfid = Bumbleworks.launch!('do_nothing')
+      Bumbleworks.dashboard.wait_for(:lazy_guy)
+      Bumbleworks.dashboard.process(wfid).should_not be_nil
+      described_class.kill_process!(wfid)
+      Bumbleworks.dashboard.process(wfid).should be_nil
+    end
+
+    it 'times out if process is not killed in time' do
+      Bumbleworks.dashboard.stub(:kill)
+      Bumbleworks.dashboard.stub(:process).with('woot').and_return(:i_exist)
+      expect {
+        described_class.kill_process!('woot', :timeout => 0.5)
+      }.to raise_error(Bumbleworks::Ruote::KillTimeout)
+    end
+  end
+
   describe ".cancel_all_processes!" do
     before :each do
       Bumbleworks::Ruote.register_participants

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bumbleworks
 version: !ruby/object:Gem::Version
-  version: 0.0.32
+  version: 0.0.33
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-13 00:00:00.000000000 Z
+date: 2013-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruote