flor 0.18.0 → 1.2.0

data/lib/flor/unit/hook.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Flor
 
@@ -14,6 +15,8 @@ module Flor
 
     def to_hook
 
+      @unit.loader.require(@h)
+
       if @h['class']
         class_to_hook
       elsif @h['instance']

data/lib/flor/unit/hooker.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Flor
 
@@ -5,6 +6,22 @@ module Flor
 
     # NB: logger configuration entries start with "hok_"
 
+    attr_reader :hooks
+
+    KEYS = {
+      consumed:   [:consumed, :c].freeze,
+      point:      [:point, :p].freeze,
+      nid:        [:nid].freeze,
+      exid:       [:exid].freeze,
+      domain:     [:domain, :d].freeze,
+      subdomain:  [:subdomain, :sd].freeze,
+      tag:        [:tag, :t].freeze,
+      name:       [:name, :n].freeze,
+      subnid:     [:subnid].freeze,
+      heap:       [:heap, :hp].freeze,
+      heat:       [:heat, :ht].freeze
+    }.freeze
+
     def initialize(unit)
 
       @unit = unit
@@ -54,7 +71,11 @@ module Flor
         end
       end
 
-      hook = Flor::Hook.instantiate(@unit, hook) if hook.is_a?(Class)
+      hook = Flor::Hook.instantiate(@unit, hook) \
+        if hook.is_a?(Class)
+
+      name ||= hook.name \
+        if hook.respond_to?(:name) && hook.method(:name).arity < 1
 
       @hooks << [ name, opts, hook, block ]
     end
@@ -81,13 +102,10 @@ module Flor
 
     protected
 
-    def o(opts, *keys)
-
-      array = false
-      array = keys.pop if keys.last == []
+    def o(opts, key, array: false)
 
       r = nil
-      keys.each { |k| break r = opts[k] if opts.has_key?(k) }
+      KEYS[key].each { |k| break r = opts[k] if opts.has_key?(k) }
 
       return nil if r == nil
       array ? Array(r) : r
@@ -103,7 +121,7 @@ module Flor
 
       opts = hook.opts if hook.respond_to?(:opts) && opts.empty?
 
-      c = o(opts, :consumed, :c)
+      c = o(opts, :consumed)
       return false if c == true && ! message['consumed']
       return false if c == false && message['consumed']
 
@@ -112,7 +130,7 @@ module Flor
         return false if hook.within_itself?(executor, message)
       end
 
-      ps = o(opts, :point, :p, [])
+      ps = o(opts, :point, array: true)
       return false if ps && ! ps.include?(message['point'])
 
       if nid = o(opts, :nid)
@@ -127,24 +145,24 @@ module Flor
 
       dm = Flor.domain(message['exid'])
 
-      if dm && ds = o(opts, :domain, :d, [])
+      if dm && ds = o(opts, :domain, array: true)
         return false \
           unless ds.find { |d| d.is_a?(Regexp) ? (!! d.match(dm)) : (d == dm) }
       end
 
-      if dm && sds = o(opts, :subdomain, :sd, [])
+      if dm && sds = o(opts, :subdomain, array: true)
         return false \
           unless sds.find do |sd|
             dm[0, sd.length] == sd
           end
       end
 
-      if ts = o(opts, :tag, :t, [])
+      if ts = o(opts, :tag, array: true)
         return false unless %w[ entered left ].include?(message['point'])
         return false unless includes?(ts, message['tags'])
       end
 
-      if ns = o(opts, :name, :n)
+      if ns = o(opts, :name)
         name = message['name']
         return false \
           unless ns.find { |n|
@@ -166,12 +184,12 @@ module Flor
         end
       end
 
-      if hps = o(opts, :heap, :hp, [])
+      if hps = o(opts, :heap, array: true)
         return false unless node ||= executor.node(message['nid'])
         return false unless includes?(hps, node['heap'])
       end
 
-      if hts = o(opts, :heat, :ht, [])
+      if hts = o(opts, :heat, array: true)
         return false unless node ||= executor.node(message['nid'])
         return false unless includes?(hts, node['heat0'])
       end
@@ -180,4 +198,3 @@ module Flor
     end
   end
 end
-

data/lib/flor/unit/journal.rb

@@ -1,13 +1,24 @@
+# frozen_string_literal: true
 
 module Flor
 
+  # A Journal hook, receives only "consumed" messages and
+  # keeps a copy of all of them.
+  #
+  # Used in specs, do not uses as-is in production, since it simply
+  # grows in memory...
+  #
   class Journal
 
     attr_reader :messages
 
     def initialize(unit)
 
+      # Add a #journal method to the flor unit so that
+      # `unit.journal` yields the message list.
+      #
       unit.singleton_class.instance_eval do
+
         define_method(:journal) do
           @hooker['journal'].messages
         end
@@ -16,11 +27,23 @@ module Flor
       @messages = []
     end
 
+    # Tells the hooker that this hook is only interested in message that
+    # have been "consumed", remember, the hooker passes messages to
+    # hooks before consumption and after consumption. In this case only
+    # consumed messages are passed.
+    #
+    # Other hooks may declare they are only interested in messages
+    # belonging to a certain domain or having a certain tag.
+    # See spec/unit/unit_hooks_spec.rb for more filtering examples.
+    #
     def opts; { consumed: true }; end
 
+    # The method used by the hooker to give consumed messages to this journal
+    #
     def notify(executor, message)
 
       @messages << Flor.dup(message)
+        # stores a deep clone of each consumed message
 
       [] # no new messages
     end

data/lib/flor/unit/loader.rb

@@ -1,7 +1,30 @@
+# frozen_string_literal: true
 
 module Flor
 
-  class Loader
+  class CoreLoader
+
+    def shutdown
+    end
+
+    # Called to interpret require: confs from hooks and friends
+    #
+    def require(conf)
+
+      re = conf['require']
+
+      return unless re
+
+      ::Kernel.require(
+        if path = conf['_path']
+          File.join(File.dirname(path), re)
+        else
+          re
+        end)
+    end
+  end
+
+  class Loader < CoreLoader
 
     # NB: tasker configuration entries start with "loa_"
 
@@ -12,10 +35,8 @@ module Flor
       @cache = {}
       @mutex = Mutex.new
 
-      @root = File.absolute_path(@unit.conf['lod_path'] || @unit.conf['root'])
-    end
-
-    def shutdown
+      @root = File.absolute_path(
+        @unit.conf['lod_path'] || @unit.conf['root'] || '.')
     end
 
     def variables(domain)
@@ -25,7 +46,7 @@ module Flor
         .collect { |pa| [ pa, expose_d(pa, {}) ] }
         .select { |pa, d| Flor.sub_domain?(d, domain) }
         .sort_by { |pa, d| d.count('.') }
-        .inject({}) { |vars, (pa, _)| vars.merge!(eval(pa, {})) }
+        .inject({}) { |vars, (pa, _)| vars.merge!(eval_variables(pa, {})) }
     end
 
     #def procedures(path)
@@ -66,25 +87,28 @@ module Flor
         .select { |pa| pa.index('/lib/taskers/') }
         .collect { |pa| [ pa, *expose_dn(pa, {}) ] }
         .select { |pa, d, n|
-          Flor.sub_domain?([ d, n ].join('.'), domain) ||
+          Flor.sub_domain?([ d, n ], domain) ||
           (n == name && Flor.sub_domain?(d, domain)) }
         .sort_by { |pa, d, n| d.count('.') }
         .last
 
       return nil unless pat
 
-      conf = eval(pat, message)
+      conf = eval_tasker_conf(pat, message)
 
       return conf if nam == name
 
-      conf = conf[name]
+      cnf = conf[name]
+
+      return nil unless cnf
 
-      return nil unless conf
+      extras = conf.select { |_, v| ! v.is_a?(Hash) }
+      extras['_path'] = pat
 
-      (conf.is_a?(Array) ? conf : [ conf ])
-        .each { |h| h['_path'] = pat }
+      (cnf.is_a?(Array) ? cnf : [ cnf ])
+        .each { |h| h.merge!(extras) }
 
-      conf
+      cnf
     end
 
     def hooks(domain)
@@ -98,8 +122,8 @@ module Flor
         .select { |pa, d| Flor.sub_domain?(d, domain) }
         .sort_by { |pa, d| d.count('.') }
         .collect { |pa, d|
-          eval(pa, {}).each_with_index { |h, i|
-            h['_path'] = pa + ":#{i}" } }
+          eval_hook_conf(pa, {})
+            .each_with_index { |h, i| h['_path'] = "#{pa}:#{i}" } }
         .flatten(1)
     end
 
@@ -109,8 +133,82 @@ module Flor
         .collect { |h| Flor::Hook.new(@unit, exid, h) }
     end
 
+    def domains(start=nil)
+
+      start ||= ''
+
+      Dir[File.join(@root, '**/*.{json,flo,flor,rb}')]
+        .collect { |pa| pa[@root.length..-1] }
+        .sort
+        .collect { |pa|
+          pa = pa[4..-1] if pa.match(/^\/usr\//)
+          case pa
+          when /\.flor?$/ then extract_flow_domain(pa)
+          when /\/lib\/hooks\// then extract_hook_domain(pa)
+          when /\/lib\/taskers\// then extract_tasker_domain(pa)
+          when /\/etc\/variables\// then extract_variable_domain(pa)
+          else nil
+          end }
+        .compact
+        .select { |pa| pa.length > 1 }
+        .collect { |pa|
+          pa = pa[1..-1] if pa[0, 1] == '/'
+          pa = pa[0..-2] if pa.match(/\/$/)
+          pa.gsub('/', '.') }
+        .sort
+        .uniq
+        .select { |dm| Flor.sub_domain?(start, dm) }
+    end
+
+    def definitions(start=nil)
+
+      start ||= ''
+
+      Dir[File.join(@root, '**/*.{flo,flor}')]
+        .collect { |pa| pa[@root.length..-1] }
+        .collect { |pa| pa.gsub(/\A\/usr\//, '/') }
+        .collect { |pa| pa.gsub(/\/lib\/(sub)?flows\//, '/') }
+        .collect { |pa| pa.gsub(/\.flor?\z/, '') }
+        .collect { |pa| pa.gsub(/\//, '.') }
+        .collect { |pa| pa.gsub(/\A\./, '') }
+        .sort
+        .select { |pa| Flor.sub_domain?(start, pa) }
+    end
+
     protected
 
+    def extract_flow_domain(pa)
+#o = pa
+      pa
+        .gsub(/\/lib\/(sub)?flows\//, '/')
+        .split('/')[0..-2].join('/')
+#.tap { |x| p 'flow:' + o + ':' + x }
+    end
+    def extract_hook_domain(pa)
+#o = pa
+      pa
+        .gsub(/\/lib\/hooks\//, '/')
+        .gsub(/\/(dot|hooks)\.(json|rb)$/, '/')
+        .gsub(/\.(json|rb)$/, '')
+#.tap { |x| p 'hook:' + o + ':' + x }
+    end
+    def extract_tasker_domain(pa)
+#o = pa
+      pa
+        .gsub(/\/lib\/taskers\//, '/')
+        .gsub(/\/[^\/]+\/(dot|flor|tasker)\.(json|rb)$/, '/')
+        .gsub(/\.(json|rb)$/, '')
+#.tap { |x| p 'tasker: ' + o + ': ' + x }
+    end
+    def extract_variable_domain(pa)
+#o = pa
+      pa
+        .gsub(/\/etc\/variables\//, '/')
+        .gsub(/\/(dot|flor)\.(json|rb)$/, '/')
+        .gsub(/\.(json|rb)$/, '')
+#.tap { |x| p 'variable: ' + o + ': ' + x }
+    end
+
     def split_dn(domain, name)
 
       if name
@@ -152,6 +250,35 @@ module Flor
       end
     end
 
+    def eval_variables(path, context)
+      eval(path, context)
+    end
+    def eval_tasker_conf(path, context)
+      eval(path, context)
+    end
+# TODO like in eval_hook_conf, reject fautly tasker confs...
+# TODO like in eval_hook_conf, reject fautly variables...
+
+    def eval_hook_conf(path, context)
+
+      a = eval(path, context)
+
+      fail ArgumentError.new(
+        "hook conf at #{path} must be an array of hashes"
+      ) unless a.is_a?(Array)
+
+      a.each do |e|
+        fail ArgumentError.new(
+          "hook conf at #{path} has non-hash entry #{e.inspect}"
+        ) unless e.is_a?(Hash)
+        fail ArgumentError.new(
+          "hook conf at #{path} has incorrect point #{e['point'].inspect}"
+        ) unless e['point'].is_a?(String)
+      end
+
+      a
+    end
+
     def eval(path, context)
 
       ext =

data/lib/flor/unit/logger.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Flor
 
@@ -62,17 +63,25 @@ module Flor
       n = Time.now.utc
       stp = Flor.tstamp(n)
 
+      dbi =
+        case @unit.storage.db.to_s
+        when /SQLite/ then @unit.storage.db.uri
+        else ''
+        end
+      dbi = ' ' + dbi if dbi.length > 0
+
       txt = elts.collect(&:to_s).join(' ')
-      err = elts.find { |e| e.is_a?(Exception) }
 
-      line = "#{stp} #{@uni} #{lvl} #{txt}"
+      err = find_err(elts)
+
+      head = "#{stp} #{@uni}#{dbi} #{lvl} "
 
       if err
-        dig = lvl[0, 1] + Digest::MD5.hexdigest(line)[0, 4]
-        @out.puts("#{stp} #{@uni} #{lvl} #{dig} #{txt}")
+        dig = lvl[0, 1] + Digest::MD5.hexdigest(head + txt)[0, 4]
+        @out.puts(head + dig + ' ' + txt)
         err.backtrace.each { |lin| @out.puts("  #{dig} #{@uni} #{lin}") }
       else
-        @out.puts(line)
+        @out.puts(head + txt)
       end
     end
 
@@ -113,7 +122,18 @@ module Flor
         #
       msg = summarize_blob(msg)
 
-      @out.puts "#{_c.blg}sto#{_c.rs} t#{Thread.current.object_id} #{level.upcase} #{msg}"
+      msg = "#{_c.dg}#{msg}"
+      msg = msg.gsub(/\b(INSERT|UPDATE)\b/) { |m| "#{_c.rs}#{m}#{_c.dg}" }
+
+      tim = Time.now.utc.strftime('%T.%L') # HH:MM:SS.123
+      dbi = @unit.storage.db.object_id.to_s(16)
+      tid = Thread.current.object_id.to_s(16)
+      lvl = level.upcase
+
+      @out.puts(
+        "#{_c.blg}sto#{_c.rs} " +
+        "#{tim} #{_c.dg}db#{dbi} th#{tid} " +
+        "#{_c.rs}#{lvl}#{_c.rs} #{msg}#{_c.rs}")
     end
 
     def size_to_s(s)
@@ -179,7 +199,8 @@ module Flor
 
       return unless @unit.conf['log_err']
 
-      @out.puts(Flor.msg_to_detail_s(executor, message, opts.merge(flag: true)))
+      s = Flor.msg_to_detail_s(executor, message, opts.merge(flag: true))
+      @out.puts(s) if s
     end
 
     def log_src(source, opts, log_opts={})
@@ -226,6 +247,13 @@ module Flor
       message[0..k + 2 + 4] + "(...len#{i - (k + 2 + 1)})" + message[i..-1]
     end
 
+    def find_err(elts)
+
+      elts.find { |e| e.is_a?(Exception) } ||
+      (defined?(Java) &&
+       elts.find { |e| e.class.ancestors.include?(Java::JavaLang::Error) })
+    end
+
     class Out
 
       attr_reader :unit