rsmp 0.4.6 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c975252bdf622f3e6bd545e2eca8f4fcf2c9c5a5f04acf159cd162882bf4f491
-  data.tar.gz: ec26cc377c14611389a8f0c9b82cf2137a76523cca3ce445513bc7e2ea5466d6
+  metadata.gz: b6d24a7240bcac60427bcbbe4743142db412338e847c08e35803401092dd162b
+  data.tar.gz: 264711c071e36998292d2fad4ece08bb79938ec3a7fc997016c7ca46f7f14ad1
 SHA512:
-  metadata.gz: 243e70433cafb8573fc9e4ffcd6a55ece6d369df6201041e6481f88810ffdf907830197854330a28c91cfc2075b767cf379590bd7f80214189a94d4a0b3c03e9
-  data.tar.gz: ac86a77b8685491c0f08fb14bd4e15552eabf73d177b7f5415b809628bab2684a71e4df3aad451fc2822c808b44d036d4c4910998b369cb373f0a4b8b2294ece
+  metadata.gz: a5cd2cd0d6afacb699c5c2e1da799356e33b0bfaa207ff7496221039c83143c572b2d5088a225cf9bec92036f890ad54bc099511d2344961a26742f69dec332d
+  data.tar.gz: 47d1c8569e07a5603cb8622f19f042d9bf637da0c30e08e8dd706c1b2b61efbba9d2f74f4de91e93ea969f89048dbb890ca5cc1718870708c6811a4ee6c3bd52

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.4.6)
+    rsmp (0.5.3)
       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

@@ -102,6 +102,5 @@ module RSMP
       end
       @proxy.log "#{@title.capitalize} collect reached #{summary}", level: :debug
     end
-
   end
 end

data/lib/rsmp/collect/notifier.rb

@@ -12,6 +12,26 @@ module RSMP
 
     def initialize_distributor
       @listeners = []
+      @defer_notify = false
+      @notify_queue = []
+    end
+
+    def clear_deferred_notify &block
+      @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
@@ -25,7 +45,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/component.rb

@@ -1,4 +1,9 @@
 module RSMP
+
+  # Class that represents an RMSP component.
+  # Currently this class is used by both SiteProxy and SupervisorProxy, and can
+  # therefore represent either a local or remote (proxy) component.
+
   class Component
     include Inspect
 
@@ -19,6 +24,7 @@ module RSMP
       @grouped = grouped
       @alarms = {}
       @statuses = {}
+      @subscribes = {}
       clear_aggregated_status
     end
 
@@ -83,5 +89,74 @@ module RSMP
         @alarms[code] = message
       end
     end
+
+    # Handle an incoming status respone, by storing the values
+    def handle_status_response message
+      store_status message, check_repeated: false
+    end
+
+    # Handle an incoming status update, by storing the values
+    def handle_status_update message
+      store_status message, check_repeated: true
+    end
+
+    # Our proxy subscribed to status updates
+    # Store update rates, so we can check for repeated alarm if we asked for updates only
+    # when there's a change, not on a regular interval.
+    # After subscribing, an update status us send regarless of whether values changes,
+    # and we store that.
+    def handle_status_subscribe status_list
+      status_list.each do |item|
+        sCI, n, uRt = item['sCI'], item['n'], item['uRt']
+
+        # record the update rate, so we can check for repeated status values if rate is zero
+        @subscribes[sCI] ||= {}
+        @subscribes[sCI][n] = {'uRt'=>uRt}
+
+        # record that we expect an upeate, even though the value might not change
+        @statuses[sCI] ||= {}
+        @statuses[sCI][n] ||= {}
+        @statuses[sCI][n][:initial] = true
+      end
+      #pp @subscribes
+    end
+
+    # Our proxy unsubscribed to status updates.
+    # Update our list of update rates.
+    def handle_status_unsubscribe status_list
+      status_list.each do |item|
+        sCI, n = item['sCI'], item['n']
+        if @subscribes[sCI]
+          @subscribes[sCI].delete n
+        end
+        if @subscribes[sCI].empty?
+          @subscribes.delete sCI
+        end
+
+        # remove any mark that would allow the next update to be a repeat
+        item = @statuses.dig sCI, n
+        item.delete(:initial) if item
+      end
+    end
+
+    # Store the latest status update values, optionally
+    # checking that we're not receiving unchanged values if we're subscribed
+    # wit updates only on change
+    def store_status message, check_repeated:
+      message.attribute('sS').each do |item|
+        sCI, n, s, q = item['sCI'], item['n'], item['s'], item['q']
+        uRt = @subscribes.dig(sCI,n,'uRt')
+        new_values = {'s'=>s,'q'=>q}
+        old_values = @statuses.dig(sCI,n)
+        if check_repeated && uRt.to_i == 0
+          if new_values == old_values
+            raise RSMP::RepeatedStatusError.new "no change for #{sCI} '#{n}'"
+          end
+        end
+        @statuses[sCI] ||= {}
+        @statuses[sCI][n] = new_values
+      end
+    end
+
   end
 end

data/lib/rsmp/error.rb

@@ -32,6 +32,9 @@ module RSMP
 	class FatalError < Error
 	end
 
+	class HandshakeError < FatalError
+	end
+
 	class NotReady < Error
 	end
 
@@ -55,4 +58,7 @@ module RSMP
 
 	class RepeatedAlarmError < Error
 	end
+
+	class RepeatedStatusError < Error
+	end
 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/node.rb

@@ -38,6 +38,10 @@ module RSMP
     def do_deferred item
     end
 
+    def clear_deferred
+      @deferred.clear
+    end    
+
     def do_start task
       task.annotate self.class.to_s
       @task = task

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
@@ -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,20 +350,23 @@ 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
+    ensure
+      clear_deferred_notify
+      node.clear_deferred
     end
 
     def process_message message
@@ -402,7 +417,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 +561,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 +593,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 +602,5 @@ module RSMP
         false
       end
     end
-
   end
 end

data/lib/rsmp/site_proxy.rb

@@ -68,6 +68,10 @@ module RSMP
         else
           super message
       end
+    rescue RSMP::RepeatedAlarmError, RSMP::RepeatedStatusError => e
+      str = "Rejected #{message.type} message,"
+      dont_acknowledge message, str, "#{e}"
+      notify_error e.exception("#{str}#{e.message} #{message.json}")
     end
 
     def process_command_response message
@@ -75,10 +79,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
@@ -149,10 +149,6 @@ module RSMP
       asp = message.attribute("aSp")
       log "Received #{message.type}, #{alarm_code} #{asp} [#{status}]", message: message, level: :log
       acknowledge message
-    rescue RSMP::RepeatedAlarmError => e
-      str = "Rejected #{message.type} message, "
-      dont_acknowledge message, str, "#{e}"
-      notify_error e.exception("#{str}#{e.message} #{message.json}")
     end
 
     def version_acknowledged
@@ -191,6 +187,8 @@ module RSMP
     end
 
     def process_status_response message
+      component = find_component message.attribute("cId")
+      component.handle_status_response message
       log "Received #{message.type}", message: message, level: :log
       acknowledge message
     end
@@ -202,7 +200,7 @@ module RSMP
       message
     end
 
-    def subscribe_to_status component, status_list, options={}
+    def subscribe_to_status component_id, status_list, options={}
       validate_ready 'subscribe to status'
       m_id = options[:m_id] || RSMP::Message.make_m_id
       
@@ -210,10 +208,13 @@ module RSMP
       # but must to remove from the subscribe message
       subscribe_list = status_list.map { |item| item.slice('sCI','n','uRt') }
 
+      component = find_component component_id
+      component.handle_status_subscribe subscribe_list
+
       message = RSMP::StatusSubscribe.new({
           "ntsOId" => '',
           "xNId" => '',
-          "cId" => component,
+          "cId" => component_id,
           "sS" => subscribe_list,
           'mId' => m_id
       })
@@ -222,12 +223,15 @@ module RSMP
       end
     end
 
-    def unsubscribe_to_status component, status_list, options={}
+    def unsubscribe_to_status component_id, status_list, options={}
+      component = find_component component_id
+      component.handle_status_subscribe status_list
+
       validate_ready 'unsubscribe to status'
       message = RSMP::StatusUnsubscribe.new({
           "ntsOId" => '',
           "xNId" => '',
-          "cId" => component,
+          "cId" => component_id,
           "sS" => status_list
       })
       send_message message, validate: options[:validate]
@@ -235,6 +239,8 @@ module RSMP
     end
 
     def process_status_update message
+      component = find_component message.attribute("cId")
+      component.handle_status_update message
       log "Received #{message.type}", message: message, level: :log
       acknowledge message
     end
@@ -333,6 +339,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

@@ -172,7 +172,11 @@ module RSMP
       id = peek_version_message protocol
       proxy = find_site id
       if proxy
-        proxy.revive settings
+        if proxy.connected?
+          raise ConnectionError.new("Site #{id} alredy connected from port #{proxy.port}")
+        else
+          proxy.revive settings
+        end
       else
         check_max_sites
         proxy = build_proxy settings.merge(site_id:id)    # keep the id learned by peeking above
@@ -246,7 +250,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 +260,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
@@ -229,7 +225,6 @@ module RSMP
     def process_status_subcribe message
       log "Received #{message.type}", message: message, level: :log
 
-
       # @status_subscriptions is organized by component/code/name, for example:
       #
       # {"AA+BBCCC=DDDEE002"=>{"S001"=>["number"]}}
@@ -238,21 +233,14 @@ module RSMP
       # for each component, containing all the requested statuses
 
       update_list = {}
-
       component = message.attributes["cId"]
-      
       @status_subscriptions[component] ||= {}
       update_list[component] ||= {} 
-
-      subs = @status_subscriptions[component]
       now = Time.now  # internal timestamp
 
       message.attributes["sS"].each do |arg|
         sCI = arg["sCI"]
         subcription = {interval: arg["uRt"].to_i, last_sent_at: now}
-        subs[sCI] ||= {}
-        subs[sCI][arg["n"]] = subcription
-
         update_list[component][sCI] ||= []
         update_list[component][sCI] << arg["n"]
       end
@@ -291,11 +279,15 @@ module RSMP
       end
     end
 
-    def store_last_sent_status component, code, name, value
+    def store_last_sent_status message
+      component_id = message.attribute('cId')
       @last_status_sent ||= {}
-      @last_status_sent[component] ||= {}
-      @last_status_sent[component][code] ||= {}
-      @last_status_sent[component][code][name] = value
+      @last_status_sent[component_id] ||= {}
+      message.attribute('sS').each do |item|
+        sCI, n, s = item['sCI'], item['n'], item['s']
+        @last_status_sent[component_id][sCI] ||= {}
+        @last_status_sent[component_id][sCI][n] = s
+      end
     end
 
     def status_update_timer now
@@ -316,7 +308,6 @@ module RSMP
               last_sent = fetch_last_sent_status component, code, name
               if current != last_sent
                 should_send = true
-                store_last_sent_status component, code, name, current
               end
             else
               # send at regular intervals
@@ -360,6 +351,7 @@ module RSMP
           "sS"=>sS
         })
         send_message update
+        store_last_sent_status update
       end
     end
 

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = "0.4.6"
+  VERSION = "0.5.3"
 end

metadata

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