openwferu 0.9.11 → 0.9.12

data/lib/openwfe/expool/expstorage.rb

@@ -48,7 +48,7 @@ require 'openwfe/util/lru'
 require 'openwfe/flowexpressionid'
 
 module OpenWFE
-    
+
     #
     # This cache uses a LruHash (Least Recently Used) to store expressions.
     # If an expression is not cached, the 'real storage' is consulted.
@@ -102,7 +102,7 @@ module OpenWFE
             #ldebug { "[] size is #{@cache.size}" }
             #ldebug { "[] (sz #{@cache.size}) for #{fei.to_debug_s}" }
 
-            fe = @cache[fei]
+            fe = @cache[fei.hash]
             return fe if fe
 
             ldebug { "[] (reload) for #{fei.to_debug_s}" }
@@ -114,17 +114,17 @@ module OpenWFE
                 return nil 
             end
 
-            @cache[fei] = fe
+            @cache[fei.hash] = fe
 
             return fe
         end
 
         def []= (fei, fe)
-            @cache[fei] = fe
+            @cache[fei.hash] = fe
         end
 
         def delete (fei)
-            @cache.delete(fei)
+            @cache.delete fei.hash
         end
 
         def length
@@ -148,27 +148,36 @@ module OpenWFE
             get_real_storage.each_of_kind(kind, &block)
         end
 
-        def each (&block)
-            #@cache.each do |k, v|
-            #    block.call(k, v)
-            #end
-            @cache.each(&block)
+        #
+        # Passes a block to the expressions currently in the cache.
+        #
+        def each (wfid_prefix=nil, &block)
+
+            #@cache.each(&block)
+
+            if wfid_prefix
+                @cache.each do |fei, fexp|
+                    next unless fei.wfid.match "^#{wfid_prefix}"
+                    block.call fei, fexp
+                end
+            else
+                @cache.each(&block)
+            end
         end
 
         #
         # This each() just delegates to the real storage each() method.
         #
-        def real_each (&block)
-            #@cache.each do |k, v|
-            #    block.call(k, v)
-            #end
-            get_real_storage.each(&block)
+        def real_each (wfid_prefix=nil, &block)
+
+            get_real_storage.each(wfid_prefix, &block)
         end
 
         #
         # Displays a human-friendly view on this storage
         #
         def to_s
+
             expstorage_to_s(self)
         end
 
@@ -209,18 +218,45 @@ module OpenWFE
             end
             get_expression_pool.add_observer(:remove) do |channel, fei|
                 #ldebug { ":delete  for #{fei}" }
-                self.delete(fei)
+                self.delete fei
             end
         end
 
+        #def []= (fei, fe)
+        #    super fei.hash, fe
+        #end
+        #def [] (fei)
+        #    super fei.hash
+        #end
+        #def delete (fei)
+        #    super fei.hash
+        #end
+
         alias :purge :clear
 
+        #
+        # Allows to pass a block to each expressions of a given kind (type).
+        #
         def each_of_kind (kind, &block)
 
             return unless block
 
             self.each_value do |fexp|
-                block.call(fexp) if fexp.kind_of? kind
+                block.call(fexp) if fexp.kind_of?(kind)
+            end
+        end
+
+        def each (wfid_prefix=nil, &block)
+
+            if wfid_prefix
+
+                super() do |fei, fexp|
+                    next unless fei.wfid.match "^#{wfid_prefix}"
+                    block.call fei, fexp
+                end
+            else
+
+                super(&block)
             end
         end
 
@@ -229,7 +265,7 @@ module OpenWFE
         end
 
         alias :real_each :each
-        
+
     end
 
     #

data/lib/openwfe/expool/journal.rb

@@ -105,21 +105,24 @@ module OpenWFE
             # flushed.
             #
             def queue_event (event, *args)
-                synchronize do
 
-                    #ldebug { "queue_event() :#{event}" }
+                #ldebug { "queue_event() :#{event}" }
 
-                    return if event == :stop
-                    return if event == :launch
-                    return if event == :reschedule
+                return if event == :stop
+                return if event == :launch
+                return if event == :reschedule
 
-                    wfid = extract_fei(args[0]).parent_wfid
-                        #
-                        # maybe args[0] could be a FlowExpression instead
-                        # of a FlowExpressionId instance
-                    #puts "___#{event}__wfid : #{wfid}"
+                wfid = extract_fei(args[0]).parent_wfid
+                    #
+                    # maybe args[0] could be a FlowExpression instead
+                    # of a FlowExpressionId instance
+                #puts "___#{event}__wfid : #{wfid}"
+
+                e = serialize_event(event, *args)
 
-                    e = serialize_event(event, *args)
+                bucket = nil
+
+                synchronize do
 
                     bucket = get_bucket(wfid) 
                     bucket << e
@@ -130,19 +133,25 @@ module OpenWFE
 
                         bucket.flush
                         @buckets.delete(wfid)
-
-                        if @application_context[:keep_journals] == true
-                            #
-                            # 'move' journal to the done/ subdir of journal/
-                            #
-                            FileUtils.cp(
-                                bucket.path,
-                                @donedir + "/" + File.basename(bucket.path))
-                        end
-
-                        FileUtils.rm bucket.path
                     end
                 end
+                    #
+                    # minimizing the sync block
+
+                # TODO : spin that off this thread, to the
+                # flush thread...
+                #
+                if event == :terminate
+                    if @application_context[:keep_journals] == true
+                        #
+                        # 'move' journal to the done/ subdir of journal/
+                        #
+                        FileUtils.cp(
+                            bucket.path,
+                            @donedir + "/" + File.basename(bucket.path))
+                    end
+                    FileUtils.rm bucket.path
+                end
             end
 
             #

data/lib/openwfe/expool/yamlexpstorage.rb

@@ -64,12 +64,6 @@ module OpenWFE
         
         def initialize (service_name, application_context)
 
-            #path = if (@application_context) 
-            #    @application_context[:work_directory]
-            #else 
-            #    DEFAULT_WORK_DIRECTORY
-            #end
-            #path = path + '/expool'
             path = OpenWFE::get_work_directory + '/expool'
 
             super(service_name, application_context, path)
@@ -86,8 +80,6 @@ module OpenWFE
             return unless block
 
             exp_names = get_expression_map.get_expression_names(kind)
-            #require 'pp'
-            #pp exp_names
 
             each_object_path do |path|
 
@@ -102,9 +94,24 @@ module OpenWFE
             end
         end
 
-        def each (&block)
-            each_object do |flow_expression|
-                block.call(flow_expression.fei, flow_expression)
+        #
+        # "each flow expression" : this method awaits a block then, for
+        # each flow_expression in this storage, calls that block.
+        #
+        # If wfid_prefix is set, only expressions whose wfid (workflow instance
+        # id (process instance id)) will be taken into account.
+        #
+        def each (wfid_prefix=nil, &block)
+
+            each_object_path do |path|
+
+                a = self.class.split_file_path path
+                next unless a
+                wfid = a[0]
+                next if wfid_prefix and ( ! wfid.match "^#{wfid_prefix}")
+                flow_expression = load_object path
+
+                block.call flow_expression.fei, flow_expression
             end
         end
 
@@ -119,7 +126,20 @@ module OpenWFE
                 s << "\n"
             end
             s << "==== . ====\n"
-            return s
+            s
+        end
+
+        #
+        # Returns nil (if the path doesn't match an stored expression path)
+        # or an array [ workflow_instance_id, expression_id, expression_name ].
+        #
+        # This is a class method (not an instance one).
+        #
+        def self.split_file_path (path)
+
+            md = path.match %r{.*/(.*)__([\d.]*)_(.*).yaml}
+            return nil unless md
+            [ md[1], md[2], md[3] ]
         end
 
         protected
@@ -149,7 +169,6 @@ module OpenWFE
                     
                 wfid = fei.parent_workflow_instance_id
 
-                #a_wfid = OpenWFE::split_wfid(wfid)
                 a_wfid = get_wfid_generator.split_wfid(wfid)
                 
                 @basepath +
@@ -160,6 +179,10 @@ module OpenWFE
                 fei.expression_name + ".yaml"
             end        
 
+            #
+            # Returns true if the path points to a file containing an 
+            # expression whose name is in exp_names.
+            #
             def matches (path, exp_names)
 
                 exp_names.each do |exp_name|
@@ -167,7 +190,7 @@ module OpenWFE
                         if OpenWFE::ends_with(path, "_#{exp_name}.yaml")
                 end
 
-                return false
+                false
             end
     end
 
@@ -181,6 +204,9 @@ module OpenWFE
             #
             # the frequency at which the event queue should be processed
 
+        #
+        # TODO : make this configurable (param in the apcontext ?)
+
         def initialize (service_name, application_context)
 
             super
@@ -221,7 +247,7 @@ module OpenWFE
         # calls process_queue() before the call the super class each()
         # method
         #
-        def each (&block)
+        def each (wfid_prefix=nil, &block)
 
             process_queue()
             super
@@ -229,6 +255,9 @@ module OpenWFE
 
         protected
 
+            #
+            # starts the thread that does the actual persistence.
+            #
             def start_processing_thread
 
                 @thread_id = get_scheduler.schedule_every(FREQ) do
@@ -236,6 +265,9 @@ module OpenWFE
                 end
             end
 
+            #
+            # queues an event for later (well within a second) persistence
+            #
             def queue (event, fei, fe=nil)
                 synchronize do
 
@@ -251,7 +283,10 @@ module OpenWFE
                 end
             end
 
-            def process_queue ()
+            #
+            # the actual "do persist" order
+            #
+            def process_queue
 
                 return unless @events.size > 0
                     #
@@ -296,6 +331,12 @@ module OpenWFE
                 end
             end
 
+            #
+            # Adds the queue() method as an observer to the update and remove
+            # events of the expression pool.
+            # :update and :remove mean changes to expressions in the persistence
+            # that's why they are observed.
+            #
             def observe_expool
 
                 get_expression_pool.add_observer(:update) do |event, fei, fe|

data/lib/openwfe/expressions/fe_sequence.rb

@@ -109,7 +109,7 @@ module OpenWFE
                     @current_child_id += 1
                 end
 
-                return nil 
+                nil 
                     #
                     # did not find any child expression
             end

data/lib/openwfe/expressions/flowexpression.rb

@@ -135,7 +135,7 @@ module OpenWFE
                 next if child.kind_of? String
 
                 i = get_expression_pool().cancel(child)
-                inflowitem = i if not inflowitem
+                inflowitem = i unless inflowitem
             end
 
             inflowitem
@@ -463,6 +463,18 @@ module OpenWFE
             end
         end
 
+        #
+        # Removes a child from the expression children list.
+        #
+        def remove_child (child_fei)
+
+            fei = @children.delete child_fei
+
+            store_itself if fei
+                #
+                # store_itself if the child was really removed.
+        end
+
         #
         # Currently only used by dollar.rb and its ${r:some_ruby_code},
         # returns the binding in this flow expression.

data/lib/openwfe/expressions/{fe_raw.rb → raw.rb}

@@ -81,7 +81,6 @@ module OpenWFE
 
             attributes = extract_attributes() unless attributes
 
-
             expression = exp_class.new(
                 @fei, 
                 @parent_id, 
@@ -145,7 +144,11 @@ module OpenWFE
             expression = instantiate_real_expression(
                 workitem, exp_class, attributes)
 
-            expression.apply_time = OpenWFE::now()
+            #expression.apply_time = OpenWFE::now()
+                #
+                # This method is extremely costly, now avoiding it
+
+            expression.apply_time = Time.now
 
             expression.apply workitem
         end

data/lib/openwfe/expressions/raw_prog.rb

@@ -42,7 +42,7 @@
 require 'rexml/document'
 
 require 'openwfe/utils'
-require 'openwfe/expressions/fe_raw'
+require 'openwfe/expressions/raw'
 require 'openwfe/expressions/simplerep'
 
 

data/lib/openwfe/expressions/raw_xml.rb

@@ -41,7 +41,7 @@
 
 require 'rexml/document'
 
-require 'openwfe/expressions/fe_raw'
+require 'openwfe/expressions/raw'
 
 
 module OpenWFE

data/lib/openwfe/expressions/time.rb

@@ -71,6 +71,8 @@ module OpenWFE
                 unschedule()
 
                 super()
+
+                @applied_workitem
             end
         end
 

data/lib/openwfe/flowexpressionid.rb

@@ -74,6 +74,8 @@ module OpenWFE
         #
         alias :wfid :workflow_instance_id
         alias :wfid= :workflow_instance_id=
+        alias :expid :expression_id
+        alias :expid= :expression_id=
 
         #
         # Overrides the classical to_s()
@@ -107,15 +109,21 @@ module OpenWFE
         def == (other)
             return false if not other.kind_of?(FlowExpressionId)
 
-            @owfe_version == other.owfe_version and 
-            @engine_id == other.engine_id and 
-            @initial_engine_id == other.initial_engine_id and
+            #return self.to_s == other.to_s
+                # no perf gain
+
+            @workflow_instance_id == other.workflow_instance_id and
+            @expression_id == other.expression_id and
             @workflow_definition_url == other.workflow_definition_url and
-            @workflow_definition_name == other.workflow_definition_name and
             @workflow_definition_revision == other.workflow_definition_revision and
-            @workflow_instance_id == other.workflow_instance_id and
+            @workflow_definition_name == other.workflow_definition_name and
             @expression_name == other.expression_name and
-            @expression_id == other.expression_id
+            @owfe_version == other.owfe_version and 
+            @engine_id == other.engine_id and 
+            @initial_engine_id == other.initial_engine_id
+                #
+                # Make sure to put on top of the 'and' the things that
+                # change the most...
         end
 
         #
@@ -230,6 +238,13 @@ module OpenWFE
 
             fei
         end
+
+        #
+        # An alias for to_fei(string)
+        #
+        def FlowExpressionId.from_s (string)
+            FlowExpressionId.to_fei(string)
+        end
     end
 
 end

data/lib/openwfe/omixins.rb

@@ -49,21 +49,44 @@ module OpenWFE
     #
     module FeiMixin
 
-        #
-        # Makes sure to return a FlowExpressionId instance.
-        #
-        def extract_fei (object)
-
-            if object.kind_of?(FlowExpressionId)
-                object
-            elsif object.kind_of?(FlowExpression) or object.kind_of?(InFlowItem)
-                object.fei
-            elsif object.kind_of?(String)
-                FlowExpressionId.to_fei object
-            else
-                raise "cannot extract FlowExpressionId out of #{object.inspect}"
+        protected
+
+            #
+            # Makes sure to return a FlowExpressionId instance.
+            #
+            def extract_fei (object)
+
+                if object.kind_of?(FlowExpressionId)
+
+                    object
+
+                elsif object.kind_of?(FlowExpression) or 
+                    object.kind_of?(InFlowItem)
+
+                    object.fei
+
+                elsif object.kind_of?(String)
+
+                    FlowExpressionId.to_fei object
+
+                else
+
+                    raise \
+                        "cannot extract FlowExpressionId "+
+                        "out of #{object.inspect}"
+                end
             end
-        end
+
+            #
+            # A small method for ensuring we have a workflow instance id.
+            #
+            def to_wfid (fei_or_wfid)
+                wfid = fei_or_wfid
+                wfid = wfid.parent_wfid if wfid.kind_of?(FlowExpressionId)
+                wfid.to_s
+            end
+
+            alias :extract_wfid :to_wfid
     end
     
 end

data/lib/openwfe/participants/atomparticipants.rb

@@ -137,9 +137,9 @@ module OpenWFE
             @feed = @feed[0, @max_item_count] \
                 if @feed.length > @max_item_count
 
-            publish(workitem)
+            publish workitem
 
-            reply_to_engine(workitem)
+            reply_to_engine workitem
         end
 
         protected
@@ -149,7 +149,8 @@ module OpenWFE
                 fe = get_flow_expression(workitem)
 
                 template = if @block_template
-                    @block_template.call(fe, self, workitem)
+                    #@block_template.call(fe, self, workitem)
+                    call_block @block_template, workitem
                 elsif @template
                     if @template.kind_of? File
                         @template.readlines
@@ -160,7 +161,7 @@ module OpenWFE
                     "(no template given)"
                 end
 
-                return OpenWFE::dosub(template, fe, workitem)
+                OpenWFE::dosub(template, fe, workitem)
             end
 
             #
@@ -168,7 +169,7 @@ module OpenWFE
             #
             def publish (workitem)
                 synchronize do
-                    filename = "atom_#{workitem.participant_name}.xml"
+                    filename = "work/atom_#{workitem.participant_name}.xml"
                     f = File.open(filename, "w")
                     f << @feed.to_s
                     f.close()

data/lib/openwfe/participants/participantmap.rb

@@ -134,6 +134,8 @@ module OpenWFE
 
             #ldebug { "lookup_participant() '#{participant_name}'" }
 
+            participant_name = participant_name.to_s
+
             @participants.each do |tuple|
                 return tuple[1] if tuple[0].match(participant_name)
             end

data/lib/openwfe/rest/controlclient.rb

@@ -77,6 +77,7 @@ module OpenWFE
             r = self.get('getflowposition', nil, params)
             decode(r)
         end
+        alias :get_flow_stack :get_flow_position
 
         #
         # Cancels a given expression (and potentially its whole subtree)

data/lib/openwfe/rudefinitions.rb

@@ -57,6 +57,7 @@ module OpenWFE
     S_EXPRESSION_STORAGE = 'expressionStorage'
     S_PARTICIPANT_MAP = 'participantMap'
     S_SCHEDULER = 'scheduler'
+    S_ERROR_JOURNAL = 'errorJournal'
 
     #
     # some special expression names
@@ -110,6 +111,9 @@ module OpenWFE
         def get_participant_map
             @application_context[S_PARTICIPANT_MAP]
         end
+        def get_error_journal
+            @application_context[S_ERROR_JOURNAL]
+        end
 
         #
         # Returns the 'journal' service (or nil if there is no
@@ -129,7 +133,7 @@ module OpenWFE
                 result << v \
                     if OpenWFE::starts_with(k.to_s, S_EXPRESSION_STORAGE)
             end
-            return result
+            result
         end
     end