ruote 2.1.8 → 2.1.9

data/CHANGELOG.txt

@@ -2,6 +2,13 @@
 = ruote - CHANGELOG.txt
 
 
+== ruote - 2.1.9    released 2010/03/22
+
+- made participant.cancel occur asynchronously (as should be)
+- lookup_variable : making sure not to break when the parent exp is gone
+- workitem.fields['__dispatch_time__'] is now set
+
+
 == ruote - 2.1.8    released 2010/03/15
 
 - participant#schedule_timeout workaround for issue with JRuby 1.4.0 (1.8.7)

data/TODO.txt

@@ -317,3 +317,9 @@
     else-ref... list of participants...
     ref="alpha && bravo", ref="alpha||bravo" (|| parallel :( )
 
+[ ] LocalParticipant def consume; handle; reply; end
+
+[ ] lib/ruote/part/participant_list.rb l176 better error message !
+
+[ ] find better solution than "get all schedules"
+

data/lib/ruote/engine.rb

@@ -149,7 +149,7 @@ module Ruote
     def process (wfid)
 
       exps = @storage.get_many('expressions', /!#{wfid}$/)
-      errs = @storage.get_many('errors', /!#{wfid}$/)
+      errs = self.errors( wfid )
 
       return nil if exps.empty? && errs.empty?
 
@@ -163,7 +163,7 @@ module Ruote
     def processes
 
       exps = @storage.get_many('expressions')
-      errs = @storage.get_many('errors')
+      errs = self.errors
 
       by_wfid = {}
 
@@ -177,6 +177,14 @@ module Ruote
       by_wfid.values.collect { |xs, rs| ProcessStatus.new(@context, xs, rs) }
     end
 
+    # Returns an array of current errors (hashes)
+    #
+    def errors( wfid = nil )
+      wfid.nil? ?
+        @storage.get_many('errors') :
+        @storage.get_many('errors', /!#{wfid}$/)
+    end
+
     def shutdown
 
       @context.shutdown

data/lib/ruote/exp/fe_participant.rb

@@ -158,29 +158,29 @@ module Ruote::Exp
         'participant_name' => h.participant_name,
         'workitem' => h.applied_workitem,
         'for_engine_worker?' => participant_info.class != Array)
+          #
+          # NOTE : is this for_engine_worker? still necessary ?
     end
 
     def cancel (flavour)
 
-      participant = @context.plist.lookup(h.participant_name)
-
-      r = if flavour == 'kill'
-        begin
-          participant.cancel(fei, 'kill')
-        rescue Exception => e
-          # intercept anything
-          nil
-        end
-      else
-        participant.cancel(fei, flavour)
-      end
+      do_persist || return
+        #
+        # if do_persist returns false, it means we're operating on stale
+        # data and have thus to cease
 
-      reply_to_parent(h.applied_workitem) if r != false
+      @context.storage.put_msg(
+        'dispatch_cancel',
+        'fei' => h.fei,
+        'participant_name' => h.participant_name,
+        'flavour' => flavour,
+        'workitem' => h.applied_workitem)
     end
 
     def reply_to_parent (workitem)
 
       workitem['fields'].delete('params')
+      workitem['fields'].delete('dispatched_at')
       super(workitem)
     end
 

data/lib/ruote/exp/flowexpression.rb

@@ -344,13 +344,24 @@ module Ruote::Exp
     #
     def cancel (flavour)
 
-      return reply_to_parent(h.applied_workitem) \
-        unless h.children.find { |cfei| Ruote::Exp::FlowExpression.fetch(@context, cfei) }
+      return reply_to_parent(h.applied_workitem) if h.children.empty?
+        #
+        # there are no children, nothing to cancel, let's just reply to
+        # the parent expression
 
       do_persist || return
+        #
         # before firing the cancel message to the children
+        #
+        # if the do_persist returns false, it means it failed, implying this
+        # expression is stale, let's return, thus discarding this cancel message
 
-      h.children.each do |cfei|
+      children.each do |cfei|
+        #
+        # let's send a cancel message to each of the children
+        #
+        # maybe some of them are gone or have not yet been applied, anyway,
+        # the message are sent
 
         @context.storage.put_msg(
           'cancel',
@@ -358,6 +369,22 @@ module Ruote::Exp
           'parent_id' => h.fei, # indicating that this is a "cancel child"
           'flavour' => flavour)
       end
+
+      #if ! children.find { |i| Ruote::Exp::FlowExpression.fetch(@context, i) }
+      #  #
+      #  # since none of the children could be found in the storage right now,
+      #  # it could mean that all children are already done or it could mean
+      #  # that they are not yet applied...
+      #  #
+      #  # just to be sure let's send a new cancel message to this expression
+      #  #
+      #  # it's very important, since if there is no child to cancel the parent
+      #  # the flow might get stuck here
+      #  @context.storage.put_msg(
+      #    'cancel',
+      #    'fei' => h.fei,
+      #    'flavour' => flavour)
+      #end
     end
 
     def do_fail (msg)

data/lib/ruote/exp/ro_variables.rb

@@ -64,7 +64,6 @@ module Ruote::Exp
 
       if h.variables
 
-        #val = h.variables[var]
         val = Ruote.lookup(h.variables, var)
 
         return val if val != nil
@@ -74,7 +73,8 @@ module Ruote::Exp
         #
         # do not lookup variables in a remote engine ...
 
-        return parent.lookup_variable(var, prefix)
+        (return parent.lookup_variable(var, prefix)) rescue nil
+          # if the lookup fails (parent gone) then rescue and let go
       end
 
       @context.storage.get_engine_variable(var)

data/lib/ruote/log/test_logger.rb

@@ -242,13 +242,21 @@ module Ruote
       end
 
       action = msg['action'][0, 2]
-      action = 'rc' if msg['action'] == 'receive'
-      action = color('4;32', action) if action == 'la'
-      action = color('4;31', action) if action == 'te'
-      action = color('31', action) if action == 'ce'
-      action = color('31', action) if action == 'ca'
-      action = color('4;33', action) if action == 'rc'
-      action = color('4;33', action) if action == 'di'
+      action = case msg['action']
+        when 'receive' then 'rc'
+        when 'dispatch_cancel' then 'dc'
+        else action
+      end
+      action = case action
+        when 'la' then color('4;32', action)
+        when 'te' then color('4;31', action)
+        when 'ce' then color('31', action)
+        when 'ca' then color('31', action)
+        when 'rc' then color('4;33', action)
+        when 'dc' then color('4;31', action)
+        when 'di' then color('4;33', action)
+        else action
+      end
 
       color(
         @color,

data/lib/ruote/part/dispatch_pool.rb

@@ -39,6 +39,38 @@ module Ruote
       @context = context
     end
 
+    def handle (msg)
+
+      case msg['action']
+        when 'dispatch'
+          dispatch(msg)
+        when 'dispatch_cancel'
+          dispatch_cancel(msg)
+        else
+          # simply discard message
+      end
+    end
+
+    protected
+
+    def dispatch_cancel (msg)
+
+      flavour = msg['flavour']
+
+      participant = @context.plist.lookup(msg['participant_name'])
+
+      begin
+        participant.cancel(Ruote::FlowExpressionId.new(msg['fei']), flavour)
+      rescue Exception => e
+        raise(e) if flavour != 'kill'
+      end
+
+      @context.storage.put_msg(
+        'reply',
+        'fei' => msg['fei'],
+        'workitem' => msg['workitem'])
+    end
+
     def dispatch (msg)
 
       participant = @context.plist.lookup(msg['participant_name'])
@@ -50,12 +82,12 @@ module Ruote
       end
     end
 
-    protected
-
     def do_dispatch (participant, msg)
 
       workitem = Ruote::Workitem.new(msg['workitem'])
 
+      workitem.fields['dispatched_at'] = Ruote.now_to_utc_s
+
       participant.consume(workitem)
     end
 

data/lib/ruote/storage/base.rb

@@ -116,22 +116,19 @@ module Ruote
 
     def get_schedules (delta, now)
 
-      if delta < 1.0
-
-        at = now.strftime('%Y%m%d%H%M%S')
-        get_many('schedules', /-#{at}$/)
-
-      elsif delta < 60.0
-
-        at = now.strftime('%Y%m%d%H%M')
-        scheds = get_many('schedules', /-#{at}\d\d$/)
-        filter_schedules(scheds, now)
-
-      else # load all the schedules
-
-        scheds = get_many('schedules')
-        filter_schedules(scheds, now)
-      end
+      #if delta < 1.0
+      #  at = now.strftime('%Y%m%d%H%M%S')
+      #  get_many('schedules', /-#{at}$/)
+      #elsif delta < 60.0
+      #  at = now.strftime('%Y%m%d%H%M')
+      #  scheds = get_many('schedules', /-#{at}\d\d$/)
+      #  filter_schedules(scheds, now)
+      #else # load all the schedules
+
+      scheds = get_many('schedules')
+      filter_schedules(scheds, now)
+
+      #end
     end
 
     def put_schedule (flavour, owner_fei, s, msg)

data/lib/ruote/version.rb

@@ -23,6 +23,6 @@
 #++
 
 module Ruote
-  VERSION = '2.1.8'
+  VERSION = '2.1.9'
 end
 

data/lib/ruote/worker.rb

@@ -66,7 +66,7 @@ module Ruote
 
     def run_in_thread
 
-      Thread.abort_on_exception = true
+      #Thread.abort_on_exception = true
         # TODO : remove me at some point
 
       @running = true
@@ -228,10 +228,9 @@ module Ruote
 
           Ruote::Exp::FlowExpression.do_action(@context, msg)
 
-        elsif action == 'dispatch'
+        elsif action.match(/^dispatch/)
 
-          #dispatch(msg)
-          @context.dispatch_pool.dispatch(msg)
+          @context.dispatch_pool.handle(msg)
 
         elsif PROC_ACTIONS.include?(action)
 

data/lib/ruote/workitem.rb

@@ -108,6 +108,13 @@ module Ruote
       fields['__result__'] = r
     end
 
+    # When was this workitem dispatched ?
+    #
+    def dispatch_at
+
+      fields['dispatched_at']
+    end
+
     # Warning : equality is based on fei and not on payload !
     #
     def == (other)

data/ruote.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruote}
-  s.version = "2.1.8"
+  s.version = "2.1.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["John Mettraux", "Kenneth Kalmer", "Torsten Schoenebaum"]
-  s.date = %q{2010-03-15}
+  s.date = %q{2010-03-23}
   s.description = %q{
 ruote is an open source ruby workflow engine.
     }

data/test/functional/base.rb

@@ -34,6 +34,8 @@ module FunctionalBase
     @tracer = Tracer.new
 
     @engine.add_service('tracer', @tracer)
+
+    #noisy # uncommented, it makes all the tests noisy
   end
 
   def teardown

data/test/functional/eft_11_wait.rb

@@ -30,7 +30,11 @@ class EftWaitTest < Test::Unit::TestCase
     assert_trace 'done.', pdef
 
     #p [ ts[1].sec, ts[0].sec ]
-    assert [ 2, 3 ].include?((ts[1].sec - ts[0].sec) % 60)
+    d = (ts[1].sec - ts[0].sec) % 60
+
+    assert(
+      [ 2, 3 ].include?(d),
+      "delta is #{d}, which isn't 2 or 3")
   end
 
   def test_cancel_wait

data/test/functional/eft_18_concurrent_iterator.rb

@@ -252,7 +252,12 @@ class EftConcurrentIteratorTest < Test::Unit::TestCase
 
     #noisy
 
-    assert_trace *%w[ a b c ].permutation.to_a, pdef
+    #assert_trace(*%w[ a b c ].permutation.to_a, pdef)
+      # this is not ruby 1.8.7p72 friendly
+
+    perms = %w[ a b c ].permutation.to_a
+    perms << pdef
+    assert_trace(*perms)
   end
 
   def test_merge_type_isolate
@@ -309,7 +314,8 @@ class EftConcurrentIteratorTest < Test::Unit::TestCase
 
   def test_cancel
 
-    n = 77
+    #n = 77
+    n = 14
 
     pdef = Ruote.process_definition do
       concurrent_iterator :times => n do

data/test/functional/eft_4_set.rb

@@ -131,6 +131,7 @@ class EftSetTest < Test::Unit::TestCase
 
     @engine.register_participant :alpha do |workitem|
       workitem.fields.delete('params')
+      workitem.fields.delete('dispatched_at')
       @tracer << workitem.fields.inspect
     end
 

data/test/functional/eft_6_concurrence.rb

@@ -182,7 +182,10 @@ class EftConcurrenceTest < Test::Unit::TestCase
 
     wi = run_concurrence({ :merge_type => :isolate }, false)
 
-    assert_equal(%w[ 0 1 params ], wi.fields.keys.collect { |k| k.to_s }.sort)
+    assert_equal(
+      %w[ 0 1 dispatched_at params ],
+      wi.fields.keys.collect { |k| k.to_s }.sort)
+
     assert_equal({ 'ref' => 'alpha' }, wi.fields['params'])
     assert_equal(%w[ seen ], wi.fields['0'].keys)
     assert_equal(%w[ seen ], wi.fields['1'].keys)
@@ -193,7 +196,7 @@ class EftConcurrenceTest < Test::Unit::TestCase
     wi = run_concurrence({ :merge_type => :stack }, false)
 
     assert_equal(
-      %w[ params stack stack_attributes ],
+      %w[ dispatched_at params stack stack_attributes ],
       wi.fields.keys.collect { |k| k.to_s }.sort)
 
     assert_equal({ 'ref' => 'alpha' }, wi.fields['params'])
@@ -230,6 +233,8 @@ class EftConcurrenceTest < Test::Unit::TestCase
 
   def test_count
 
+    #noisy
+
     wfid = run_test_count('cancel', false)
 
     #puts
@@ -237,6 +242,8 @@ class EftConcurrenceTest < Test::Unit::TestCase
     #puts
     assert_equal 1, logger.log.select { |e| e['action'] == 'cancel' }.size
 
+    sleep 0.350 # since now dispatch_cancel occurs asynchronously...
+
     assert_equal 0, @alpha.size
     assert_equal 0, @bravo.size
   end

data/test/functional/ft_12_launchitem.rb

@@ -31,6 +31,8 @@ class FtLaunchitemTest < Test::Unit::TestCase
     wait_for(wfid)
 
     assert_equal('a', @tracer.to_s)
+
+    assert_not_nil(fields.delete('dispatched_at'))
     assert_equal({"a"=>0, "b"=>1, "params"=>{"ref"=>"alpha"}}, fields)
   end
 end

data/test/functional/ft_14_re_apply.rb

@@ -22,7 +22,6 @@ class FtReApplyTest < Test::Unit::TestCase
 
   def test_re_apply
 
-
     alpha = @engine.register_participant :alpha, Ruote::HashParticipant.new
 
     #noisy

data/test/functional/ft_15_timeout.rb

@@ -32,7 +32,7 @@ class FtTimeoutTest < Test::Unit::TestCase
 
     assert_equal 0, alpha.size
     assert_equal 1, bravo.size
-    assert_equal 1, logger.log.select { |e| e['flavour'] == 'timeout' }.size
+    assert_equal 2, logger.log.select { |e| e['flavour'] == 'timeout' }.size
     assert_equal 0, @engine.storage.get_many('schedules').size
 
     assert_not_nil bravo.first.fields['__timed_out__']
@@ -68,6 +68,16 @@ class FtTimeoutTest < Test::Unit::TestCase
 
   def test_on_timeout_redo
 
+    # with ruote-couch the 'cancel-process' operation gets overriden by
+    # the timeout cancel...
+    #
+    # 0 20 ca * 20100320-bipopimita {}
+    # 1 20   ca * 20100320-bipopimita  0 {"flavour"=>nil}
+    # 2 20     ca * 20100320-bipopimita  0_0 {"flavour"=>"timeout"}
+    # 3 20     ca * 20100320-bipopimita  0_0 {"flavour"=>nil, :pi=>"0!!20100320-bipopimita"}
+    #
+    # hence the multiple cancel at the end of the test
+
     pdef = Ruote.process_definition do
       alpha :timeout => '1.1', :on_timeout => 'redo'
     end
@@ -82,7 +92,10 @@ class FtTimeoutTest < Test::Unit::TestCase
     #logger.log.each { |e| p e['flavour'] }
     assert logger.log.select { |e| e['flavour'] == 'timeout' }.size >= 2
 
-    @engine.cancel_process(wfid)
+    3.times do
+      Thread.pass
+      @engine.cancel_process(wfid)
+    end
 
     wait_for(wfid)
 
@@ -195,7 +208,8 @@ class FtTimeoutTest < Test::Unit::TestCase
 
     wfid = @engine.launch(pdef)
 
-    wait_for(9)
+    #wait_for(9)
+    wait_for(wfid)
 
     assert_nil @engine.process(wfid)
     assert_equal 0, alpha.size

data/test/functional/ft_1_process_status.rb

@@ -84,6 +84,27 @@ class FtProcessStatusTest < Test::Unit::TestCase
       ps.variables)
   end
 
+  def test_errors
+
+    pdef = Ruote.process_definition 'my process' do
+      nada
+    end
+
+    wfid = @engine.launch( pdef )
+    wait_for( wfid )
+
+    errs = @engine.errors
+
+    assert_equal 1, errs.size
+
+    assert_equal wfid, errs.first['fei']['wfid']
+
+    err = @engine.errors( wfid )
+
+    assert_equal 1, err.size
+    assert_equal wfid, err.first['fei']['wfid']
+  end
+
   def test_tree
 
     pdef = Ruote.process_definition 'my process' do

data/test/functional/ft_26_participant_timeout.rb

@@ -34,13 +34,13 @@ class FtParticipantTimeoutTest < Test::Unit::TestCase
     #noisy
 
     wfid = @engine.launch(pdef)
-    wait_for(10)
+    wait_for(12)
 
     assert_equal 0, alpha.size
     assert_equal 1, bravo.size
 
     #logger.log.each { |l| p l }
-    assert_equal 1, logger.log.select { |e| e['flavour'] == 'timeout' }.size
+    assert_equal 2, logger.log.select { |e| e['flavour'] == 'timeout' }.size
     assert_equal 0, @engine.storage.get_many('schedules').size
 
     assert_not_nil bravo.first.fields['__timed_out__']

data/test/functional/ft_37_engine_participant.rb

@@ -164,6 +164,8 @@ class FtEngineParticipantTest < Test::Unit::TestCase
     @engine0.cancel_process(wfid)
     @engine0.wait_for(wfid)
 
+    sleep 0.350 # since dispatch_cancel is asyncrhonous now
+
     assert_equal 0, alpha.size
 
     assert_equal "a", @tracer0.to_s

data/test/functional/ft_8_participant_consumption.rb

@@ -71,5 +71,23 @@ class FtParticipantConsumptionTest < Test::Unit::TestCase
 
     assert_trace('alpha 0_0_0', pdef)
   end
+
+  def test_dispatch_time
+
+    wis = []
+
+    pdef = Ruote.process_definition { alpha; alpha }
+
+    @engine.register_participant 'alpha' do |workitem|
+      wis << workitem.to_h.dup
+    end
+
+    assert_trace('', pdef)
+
+    assert_equal(
+      String, wis.first['fields']['dispatched_at'].class)
+    assert_not_equal(
+      wis.first['fields']['dispathed_at'], wis.last['fields']['dispatched_at'])
+  end
 end
 

data/test/path_helper.rb

@@ -8,6 +8,7 @@
 # making sure the tests see ruote
 
 puts `ruby -v`
+puts Time.now.to_s
 
 ruotelib = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
 $:.unshift(ruotelib) unless $:.include?(ruotelib)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 2
   - 1
-  - 8
-  version: 2.1.8
+  - 9
+  version: 2.1.9
 platform: ruby
 authors: 
 - John Mettraux
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-15 00:00:00 +09:00
+date: 2010-03-23 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency