rsmp 0.4.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 499cc4c58205e41108099bd05cd2c3bc792f962abf4bdbe3082345a2e3953094
-  data.tar.gz: 7cca20987f24697c9def7d638ebd89b99ecbc006f6d7bb8f8445d5b50d5cad23
+  metadata.gz: 7290ac834b3609265b8e74ecc1d03a10c08b7e0f81411516ffa7dca1c3101bfb
+  data.tar.gz: 8a81e821c60fd148da62222724cd038eb85a69251e0e52603403edcb5a1256bf
 SHA512:
-  metadata.gz: f585bdc07e8ca52f1d809779894dab0a6e61c85f6fcfdd61bac593808e5e04ec0a006af662f47f16d2bd9f720096809d9412caff46ff3532a4fc687f99ede730
-  data.tar.gz: 88c2c437f41c22e5e9d3a8a281ec01a02379b70b9e46cdecb9f36d97753eb77d075c79a859d71fa6cd8ae1ce0ed310936891124dec9984b699979378510e6006
+  metadata.gz: f2989f8d80113ebfdbde28c669d5255787b353949e3dc75c704ccfae54f2e579424426b1fa1144a616f087238c0f76350bdf009665b25514eacc115ed1ef1247
+  data.tar.gz: fc674e02fed369f00c56c3152494dee25d7da66733971345550c8846df191b732d6cc3a60df7502ab7168b7ad2b66ba01d4195eb654e2d45c04b987ea932b9be

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.4.3)
+    rsmp (0.5.0)
       async (~> 1.29.1)
       async-io (~> 1.32.1)
       colorize (~> 0.8.1)

data/config/supervisor.yaml

@@ -19,6 +19,7 @@ log:
   text: true
   direction: true
   level: false
+  debug: true
   json: true
   acknowledgements: false
   watchdogs: false

data/config/tlc.yaml

@@ -38,6 +38,7 @@ log:
   ip: false
   site_id: true
   level: false
+  debug: true
   text: true
   direction: true
   json: true

data/lib/rsmp/collect/collector.rb

@@ -7,7 +7,12 @@ module RSMP
 
     def initialize proxy, options={}
       super proxy, options
-      @options = options.clone
+      @options = {
+        cancel: {
+          schema_error: true,
+          disconnect: false,
+        }
+      }.deep_merge options
       @ingoing = options[:ingoing] == nil ? true  : options[:ingoing]
       @outgoing = options[:outgoing] == nil ? false : options[:outgoing]
       @condition = Async::Notification.new
@@ -82,7 +87,7 @@ module RSMP
       if message.is_a?(MessageNotAck)
         if message.attribute('oMId') == @options[:m_id]
           m_id_short = RSMP::Message.shorten_m_id @options[:m_id], 8
-          @error = RSMP::MessageRejected.new("#{@title} #{m_id_short} was rejected: #{message.attribute('rea')}")
+          @error = RSMP::MessageRejected.new("#{@title} #{m_id_short} was rejected with '#{message.attribute('rea')}'")
           complete
         end
         false
@@ -123,6 +128,43 @@ module RSMP
       @condition.signal
     end
 
+    # The proxy experienced some error.
+    # Check if this should cause us to cancel.
+    def notify_error error, options={}
+      case error
+      when RSMP::SchemaError
+        notify_schema_error error, options
+      when RSMP::ConnectionError
+        notify_disconnect error, options
+      end
+    end
+
+    # Cancel if we received e schema error for a message type we're collecting
+    def notify_schema_error error, options
+      return unless @options.dig(:cancel,:schema_error)
+      message = options[:message]
+      return unless message
+      klass = message.class.name.split('::').last
+      return unless [@options[:type]].flatten.include? klass
+      @proxy.log "Collect cancelled due to schema error in #{klass} #{message.m_id_short}", level: :debug
+      cancel error
+    end
+
+    # Cancel if we received e notificaiton about a disconnect
+    def notify_disconnect error, options
+      return unless @options.dig(:cancel,:disconnect)
+      @proxy.log "Collect cancelled due to a connection error: #{error.to_s}", level: :debug
+      cancel error
+    end
+
+    # Abort collection
+    def cancel error
+      @error = error if error
+      @done = false
+      @proxy.remove_listener self
+      @condition.signal
+    end
+
     # Store a message in the result array
     def keep message
       @messages << message

data/lib/rsmp/collect/listener.rb

@@ -12,6 +12,9 @@ module RSMP
     def notify message
     end
 
+    def notify_error error, options={}
+    end
+
     def listen &block
       @proxy.add_listener self
       yield

data/lib/rsmp/collect/matcher.rb

@@ -87,21 +87,20 @@ module RSMP
     end
 
     # Check if a messages matches our criteria.
-    # We iterate through each of the status items or return values in the message
-    # Breaks as soon as where done matching all queries
+    # Match each query against each item in the message
     def check_match message
       return unless match?(message)
       @queries.each do |query|       # look through queries
-        get_items(message).each do |item|  # look through status items in message
+        get_items(message).each do |item|  # look through items in message
           matched = query.check_match(item,message)
           if matched != nil
             type = {true=>'match',false=>'mismatch'}[matched]
             @proxy.log "#{@title.capitalize} #{message.m_id_short} collect #{type} #{query.want}, item #{item}", level: :debug
+            break
           end
         end
       end
       @proxy.log "#{@title.capitalize} collect reached #{summary}", level: :debug
     end
-
   end
 end

data/lib/rsmp/collect/notifier.rb

@@ -2,6 +2,8 @@
 
 module RSMP
   module Notifier
+    attr_reader :listeners
+
     include Inspect
 
     def inspect
@@ -10,6 +12,22 @@ module RSMP
 
     def initialize_distributor
       @listeners = []
+      @defer_notify = false
+      @notify_queue = []
+    end
+
+    def deferred_notify &block
+      was, @defer_notify = @defer_notify, true
+      yield
+      dequeue_notify
+    ensure
+      @defer_notify = was
+    end
+
+    def dequeue_notify
+      @notify_queue.each { |message| notify_without_defer message }
+    ensure
+      @notify_queue = []
     end
 
     def add_listener listener
@@ -23,7 +41,20 @@ module RSMP
     end
 
     def notify message
+      raise ArgumentError unless message
+      if @defer_notify
+        @notify_queue << message
+      else
+        notify_without_defer message
+      end
+    end
+
+    def notify_without_defer message
       @listeners.each { |listener| listener.notify message }
     end
+
+    def distribute_error error, options={}
+      @listeners.each { |listener| listener.notify_error error, options }
+    end
   end
 end

data/lib/rsmp/collect/query.rb

@@ -17,12 +17,14 @@ module RSMP
     end
 
     # Check an item and set @done to true if it matches
-    # Always store the item and corresponding message.
+    # Store the item and corresponding message if there's a positive or negative match
     def check_match item, message
-      @message = message
-      @got = item
       matched = match? item
-      @done = matched if matched != nil
+      if matched != nil
+        @message = message
+        @got = item
+        @done = matched
+      end
       matched
     end
 

data/lib/rsmp/error.rb

@@ -32,6 +32,9 @@ module RSMP
 	class FatalError < Error
 	end
 
+	class HandshakeError < FatalError
+	end
+
 	class NotReady < Error
 	end
 

data/lib/rsmp/logger.rb

@@ -5,6 +5,7 @@ module RSMP
     
     def initialize settings={}
       defaults = {
+        'prefix'=>nil,
         'active'=>false,
         'path'=>nil,
         'stream'=>nil,
@@ -20,7 +21,8 @@ module RSMP
         'json'=>false,
         'debug'=>false,
         'statistics'=>false,
-        'hide_ip_and_port' => false
+        'hide_ip_and_port' => false,
+        'acknowledgements' => false
       }
       if settings
         @settings = defaults.merge settings
@@ -139,6 +141,7 @@ module RSMP
   
     def build_output item
       parts = []
+      parts << "#{@settings['prefix']} " if @settings['prefix']
       parts << item[:index].to_s.ljust(7) if @settings["index"] == true
       parts << item[:author].to_s.ljust(13) if @settings["author"] == true
       parts << Clock.to_s(item[:timestamp]).ljust(24) unless @settings["timestamp"] == false

data/lib/rsmp/message.rb

@@ -142,7 +142,7 @@ module RSMP
     def validate schemas
       errors = RSMP::Schemer.validate attributes, schemas
       if errors
-        error_string = errors.compact.join(', ').strip
+        error_string = errors.map {|item| item.reject {|e| e=='' } }.compact.join(', ').strip
         raise SchemaError.new error_string
       end
     end

data/lib/rsmp/proxy.rb

@@ -86,6 +86,7 @@ module RSMP
       return if @state == :stopped
       set_state :stopping
       stop_tasks
+      notify_error ConnectionError.new("Connection was closed")
     ensure
       close_socket
       clear
@@ -237,6 +238,7 @@ module RSMP
         if now > latest
           log "No acknowledgements for #{message.type} #{message.m_id_short} within #{timeout} seconds", level: :error
           stop
+          notify_error MissingAcknowledgment.new('No ack')
         end
       end
     end
@@ -266,7 +268,7 @@ module RSMP
       # TODO
       # what schema should we use to validate the intial Version and MessageAck messages?
       schemas = { core: '3.1.5' }
-      schemas[sxl] = RSMP::Schemer.sanitize_version(sxl_version) if sxl
+      schemas[sxl] = RSMP::Schemer.sanitize_version(sxl_version) if sxl && sxl_version
       schemas
     end
 
@@ -315,13 +317,23 @@ module RSMP
       !skip.include?(klass)
     end
 
+    def process_deferred
+      node.process_deferred
+    end
+
+    def verify_sequence message
+      expect_version_message(message) unless @version_determined
+    end
+
     def process_packet json
       attributes = Message.parse_attributes json
       message = Message.build attributes, json
       message.validate(get_schemas) if should_validate_ingoing_message?(message)
-      notify message
-      expect_version_message(message) unless @version_determined
-      process_message message
+      verify_sequence message
+      deferred_notify do
+        notify message
+        process_message message
+      end
       process_deferred
       message
     rescue InvalidPacket => e
@@ -338,17 +350,17 @@ module RSMP
     rescue SchemaError, RSMP::Schemer::Error => e
       str = "Received invalid #{message.type}, schema errors: #{e.message}"
       log str, message: message, level: :warning
-      notify_error e.exception("#{str} #{message.json}")
+      notify_error e.exception("#{str} #{message.json}"), message: message
       dont_acknowledge message, str
       message
     rescue InvalidMessage => e
       str = "Received", "invalid #{message.type}, #{e.message}"
-      notify_error e.exception("#{str} #{message.json}")
+      notify_error e.exception("#{str} #{message.json}"), message: message
       dont_acknowledge message, str
       message
     rescue FatalError => e
       str = "Rejected #{message.type},"
-      notify_error e.exception("#{str} #{message.json}")
+      notify_error e.exception("#{str} #{message.json}"), message: message
       dont_acknowledge message, str, "#{e.message}"
       stop
       message
@@ -402,7 +414,7 @@ module RSMP
       if candidates.any?
         @rsmp_version = candidates.sort_by { |v| Gem::Version.new(v) }.last  # pick latest version
       else
-        raise FatalError.new "RSMP versions [#{message.versions.join(',')}] requested, but only [#{versions.join(',')}] supported."
+        raise HandshakeError.new "RSMP versions [#{message.versions.join(',')}] requested, but only [#{versions.join(',')}] supported."
       end
     end
 
@@ -546,7 +558,7 @@ module RSMP
 
     def expect_version_message message
       unless message.is_a?(Version) || message.is_a?(MessageAck) || message.is_a?(MessageNotAck)
-        raise FatalError.new "Version must be received first"
+        raise HandshakeError.new "Version must be received first"
       end
     end
 
@@ -578,7 +590,7 @@ module RSMP
             # will be raised in the parent task, and caught by rspec.
             # rspec will then show the error and record the test as failed
             m_id_short = RSMP::Message.shorten_m_id m_id, 8
-            result = RSMP::MessageRejected.new "Aggregated status request #{m_id_short} was rejected: #{message.attribute('rea')}"
+            result = RSMP::MessageRejected.new "Aggregated status request #{m_id_short} was rejected with '#{message.attribute('rea')}'"
             next true   # done, no more messages wanted
           end
         elsif message.is_a?(MessageAck)
@@ -587,6 +599,5 @@ module RSMP
         false
       end
     end
-
   end
 end

data/lib/rsmp/site_proxy.rb

@@ -75,10 +75,6 @@ module RSMP
       acknowledge message
     end
 
-    def process_deferred
-      supervisor.process_deferred
-    end
-
     def version_accepted message
       log "Received Version message for site #{@site_id}", message: message, level: :log
       start_timer
@@ -333,6 +329,7 @@ module RSMP
 
     def notify_error e, options={}
       @supervisor.notify_error e, options if @supervisor
+      distribute_error e, options
     end
 
     def collect_alarms parent_task, options={}

data/lib/rsmp/supervisor.rb

@@ -7,7 +7,7 @@ module RSMP
     attr_reader :rsmp_versions, :site_id, :supervisor_settings, :proxies, :logger
 
     def initialize options={}
-      handle_supervisor_settings options
+      handle_supervisor_settings( options[:supervisor_settings] || {} )
       super options
       @proxies = []
       @site_id_condition = Async::Notification.new
@@ -17,7 +17,7 @@ module RSMP
       @supervisor_settings['site_id']
     end
 
-    def handle_supervisor_settings options={}
+    def handle_supervisor_settings supervisor_settings
       defaults = {
         'port' => 12111,
         'ips' => 'all',
@@ -36,8 +36,8 @@ module RSMP
       }
 
       # merge options into defaults
-      @supervisor_settings = defaults.deep_merge(options[:supervisor_settings] || {})
-      @rsmp_versions = @supervisor_settings["rsmp_versions"]
+      @supervisor_settings = defaults.deep_merge(supervisor_settings)
+      @rsmp_versions = @supervisor_settings["guest"]["rsmp_versions"]
       check_site_sxl_types
     end
 
@@ -246,7 +246,7 @@ module RSMP
 
     def check_site_already_connected site_id
       site = find_site(site_id)
-      raise FatalError.new "Site '#{site_id}' already connected" if site != nil && site != self
+      raise HandshakeError.new "Site '#{site_id}' already connected" if site != nil && site != self
     end
 
     def site_id_to_site_setting site_id
@@ -256,7 +256,7 @@ module RSMP
           return settings
         end
       end
-      raise FatalError.new "site id #{site_id} unknown"
+      raise HandshakeError.new "site id #{site_id} unknown"
     end
 
     def ip_to_site_settings ip

data/lib/rsmp/supervisor_proxy.rb

@@ -86,10 +86,6 @@ module RSMP
       dont_acknowledge message, '', e.to_s
     end
 
-    def process_deferred
-      site.process_deferred
-    end
-
     def acknowledged_first_ingoing message
       # TODO
       # aggregateds status should only be send for later version of rsmp

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
 platform: ruby
 authors:
 - Emil Tin
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-29 00:00:00.000000000 Z
+date: 2021-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async