rsmp 0.45.2 → 0.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ceec0bb561c61873341a4af09334ed0c6e0eb7bb1909b6fb38f2a350aaae8ca9
-  data.tar.gz: 41f8df99b563e086770f502e69ff8bc8a8dc91b075aa9e50c2f0dd451b8bc0ad
+  metadata.gz: a5a5d66114ac44b96bc823b0366eddc9225abeb1686ec75cdd60d25373c8e53b
+  data.tar.gz: 49387a2b58f4aa7cfd0e36226240cbb1e93d2f49e5fd5636eb9cf3cabd0e3b53
 SHA512:
-  metadata.gz: 46ee01791490e180283de79f9568b4d37ad8bef6bd228f2cee5c6eca7d95f568fad715f5f48314c1ebfec8610185bd027b7cc5e65701af248d2253d3569ff491
-  data.tar.gz: 26b27b919cc42a3fdf337720bfb31c3168e8a2a95a0361b642efe27973352eaffbcb4e4c07ea3d55a6f0d4e59d57650c226ed603edcf6a9c45747bb1b3439c98
+  metadata.gz: f0cf699c114f7c61b03e42e199ecddee74270bb6a3fabe980c95f89951e7edc557cebc9b7c3eb1668614dc73a2c69a6c849be3010c6cdcb3210459a506ca04ef
+  data.tar.gz: 7b53bd11a26ad80c150862fbd28fe98b6a9fb0be238a613e2500ac0ffb439c34188b10f962f120c54fa491a371db05688a98d0f9ca27549eb9658a498f1d2d2a

data/CHANGELOG.md

@@ -670,3 +670,18 @@ Initial release.
 - fix issues with config normalization
 - make collector cancellation raise pending errors
 - replace Cucumber/Aruba CLI tests with sus tests that call the Thor CLI directly
+
+## 0.45.1
+- fix CLI execution by using relative requires
+- update schema generation and generated schemas
+- support patterns in list item types
+- resolve SXL schema core definitions dynamically
+- add CLI tests and split message tests
+
+## 0.45.2
+- update gems
+- add AGENTS.md
+- replace em dashes to avoid UTF issues
+
+## 0.46.0
+- add outgoing message buffering for sites

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.45.2)
+    rsmp (0.46.0)
       async (~> 2.39)
       colorize (~> 1.1)
       io-endpoint (~> 0.17)

data/lib/rsmp/node/site/site.rb

@@ -96,10 +96,9 @@ module RSMP
 
     def run
       log_site_starting
-      @proxies.each do |proxy|
-        proxy.start
-        proxy.wait
-      end
+      start_status_timer
+      @proxies.each(&:start)
+      @proxies.each(&:wait)
     end
 
     def build_proxies
@@ -119,7 +118,7 @@ module RSMP
 
     def aggregated_status_changed(component, _options = {})
       @proxies.each do |proxy|
-        proxy.send_aggregated_status component if proxy.ready?
+        proxy.send_aggregated_status component
       end
     end
 
@@ -137,10 +136,50 @@ module RSMP
 
     def send_alarm(alarm)
       @proxies.each do |proxy|
-        proxy.send_message alarm if proxy.ready? && proxy.receive_alarms?
+        proxy.send_message alarm if proxy.receive_alarms?
+      end
+    end
+
+    def start_status_timer
+      return if @status_timer
+
+      interval = @site_settings['intervals']['timer'] || 1
+      log "Starting site status timer with interval #{interval} seconds", level: :debug
+      @status_timer = @task.async do |task|
+        task.annotate 'site status timer'
+        run_status_timer task, interval
+      end
+    end
+
+    def run_status_timer(task, interval)
+      next_time = Time.now.to_f
+      loop do
+        now = Clock.now
+        tick_status_subscriptions now
+      rescue StandardError => e
+        distribute_error e, level: :internal
+      ensure
+        next_time += interval
+        duration = next_time - Time.now.to_f
+        task.sleep duration
       end
     end
 
+    def tick_status_subscriptions(now)
+      @proxies.each { |proxy| proxy.status_update_timer now }
+    end
+
+    def stop_status_timer
+      @status_timer&.stop
+    ensure
+      @status_timer = nil
+    end
+
+    def stop_subtasks
+      stop_status_timer
+      super
+    end
+
     def connect_to_supervisor(_task, supervisor_settings)
       proxy = build_proxy({
                             site: self,

data/lib/rsmp/options/schemas/site.json

@@ -41,6 +41,32 @@
       "additionalProperties": true
     },
     "send_after_connect": { "type": "boolean" },
+    "message_buffer": {
+      "type": "object",
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "max_messages": { "type": "integer", "minimum": 1 },
+        "statuses": {
+          "oneOf": [
+            { "type": "boolean" },
+            {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "cId": { "type": "string" },
+                  "sCI": { "type": "string" },
+                  "n": { "type": "string" }
+                },
+                "required": ["sCI"],
+                "additionalProperties": false
+              }
+            }
+          ]
+        }
+      },
+      "additionalProperties": false
+    },
     "components": { "type": "object" },
     "security_codes": { "type": "object" },
     "startup_sequence": { "type": "string" },

data/lib/rsmp/options/site_options.rb

@@ -21,6 +21,7 @@ module RSMP
             'acknowledgement' => 2
           },
           'send_after_connect' => true,
+          'message_buffer' => default_message_buffer,
           'components' => {
             'main' => {
               'C1' => {}
@@ -35,6 +36,14 @@ module RSMP
 
       private
 
+      def default_message_buffer
+        {
+          'enabled' => true,
+          'max_messages' => 10_000,
+          'statuses' => []
+        }
+      end
+
       def apply_defaults(options)
         defaults = defaults()
         defaults['components']['main'] = options['components']['main'] if options.dig('components', 'main')

data/lib/rsmp/proxy/modules/send.rb

@@ -11,8 +11,13 @@ module RSMP
           distribute_error error.exception("#{str} #{message.json}")
         end
 
-        def send_message(message, reason = nil, validate: true, force: false)
-          raise NotReady if !force && !connected?
+        def send_message(message, reason = nil, validate: true, force: false, buffer: true)
+          unless force || connected?
+            error = NotReady.new
+            raise error unless buffer
+
+            return buffer_message(message, error)
+          end
           raise IOError unless @protocol
 
           message.direction = :out
@@ -22,15 +27,18 @@ module RSMP
           expect_acknowledgement message
           distribute message
           log_send message, reason
-        rescue IOError
-          buffer_message message
+        rescue NotReady, IOError => e
+          raise e unless buffer
+
+          buffer_message message, e
         rescue SchemaError, RSMP::Schema::Error => e
           handle_send_schema_error(message, e)
         end
 
-        def buffer_message(message)
-          # TODO
-          # log "Cannot send #{message.type} because the connection is closed.", message: message, level: :error
+        def buffer_message(message, error = nil)
+          str = "Cannot send #{message.type} because the connection is closed."
+          log str, message: message, level: :error
+          raise error if error
         end
 
         def log_send(message, reason = nil)

data/lib/rsmp/proxy/site/modules/status.rb

@@ -125,13 +125,14 @@ module RSMP
         end
 
         def unsubscribe_to_status(status_list, component: nil, validate: nil)
-          validate_ready 'unsubscribe to status'
           component ||= main.c_id
 
           status_list.each do |item|
             remove_subscription_item(component, item['sCI'], item['n'])
           end
 
+          return unless ready? # if the connection is don't we skip sending
+
           message = RSMP::StatusUnsubscribe.new({
                                                   'cId' => component,
                                                   'sS' => status_list

data/lib/rsmp/proxy/supervisor/modules/aggregated_status.rb

@@ -13,7 +13,7 @@ module RSMP
         def send_aggregated_status(component, m_id: nil)
           m_id ||= RSMP::Message.make_m_id
 
-          se = if Proxy.version_meets_requirement?(core_version, '<=3.1.2')
+          se = if core_version && Proxy.version_meets_requirement?(core_version, '<=3.1.2')
                  component.aggregated_status_bools.map { |bool| bool ? 'true' : 'false' }
                else
                  component.aggregated_status_bools

data/lib/rsmp/proxy/supervisor/modules/message_buffer.rb

@@ -0,0 +1,144 @@
+module RSMP
+  class SupervisorProxy < Proxy
+    module Modules
+      # In-memory outgoing communication buffer for site-originated messages.
+      module MessageBuffer
+        def message_buffer_settings
+          @site_settings['message_buffer'] || {}
+        end
+
+        def message_buffer_enabled?
+          message_buffer_settings['enabled'] != false
+        end
+
+        def message_buffer_max_messages
+          message_buffer_settings['max_messages'] || 10_000
+        end
+
+        def status_buffer_selectors
+          return message_buffer_settings['statuses'] if message_buffer_settings.key? 'statuses'
+
+          []
+        end
+
+        def status_buffer_selector?(component_id, status)
+          selectors = status_buffer_selectors
+          return true if selectors == true
+          return false unless selectors.is_a?(Array)
+
+          selectors.any? { |selector| status_buffer_selector_matches?(selector, component_id, status) }
+        end
+
+        def status_buffer_selector_matches?(selector, component_id, status)
+          selector = selector.transform_keys(&:to_s)
+          component_matches = !selector['cId'] || selector['cId'] == component_id
+          code_matches = !selector['sCI'] || selector['sCI'] == status['sCI']
+          name_matches = !selector['n'] || selector['n'] == status['n']
+          component_matches && code_matches && name_matches
+        end
+
+        def clone_message(message, attributes = message.attributes)
+          message.class.new(JSON.parse(JSON.generate(attributes)))
+        end
+
+        def site_originated_buffer_candidate?(message)
+          message.is_a?(RSMP::AggregatedStatus) ||
+            message.is_a?(RSMP::AlarmIssue) ||
+            message.is_a?(RSMP::AlarmSuspended) ||
+            message.is_a?(RSMP::AlarmResumed) ||
+            message.is_a?(RSMP::AlarmAcknowledged) ||
+            message.is_a?(RSMP::StatusUpdate)
+        end
+
+        def prepare_status_update_for_buffer(message, core_version:, for_send:)
+          attributes = JSON.parse(JSON.generate(message.attributes))
+          component_id = attributes['cId']
+          attributes['sS'] = attributes['sS'].select { |status| status_buffer_selector?(component_id, status) }
+          return if attributes['sS'].empty?
+
+          if for_send && core_version && version_meets_requirement?(core_version, '>=3.2.0')
+            attributes['sS'].each { |status| status['q'] = 'old' }
+          end
+          clone_message message, attributes
+        end
+
+        def normalize_aggregated_status_buffer(states, core_version)
+          if version_meets_requirement?(core_version, '<=3.1.2')
+            states.map { |item| item == true || item.to_s == 'true' ? 'true' : 'false' }
+          else
+            states.map { |item| item == true || item.to_s == 'true' }
+          end
+        end
+
+        def prepare_aggregated_status_for_buffer(message, core_version:, for_send:)
+          attributes = JSON.parse(JSON.generate(message.attributes))
+          if for_send && core_version && attributes['se']
+            attributes['se'] = normalize_aggregated_status_buffer(attributes['se'], core_version)
+          end
+          clone_message message, attributes
+        end
+
+        def prepare_message_for_buffer(message, core_version: @core_version, for_send: false)
+          return unless message_buffer_enabled?
+          return unless site_originated_buffer_candidate? message
+          return false if message.is_a?(RSMP::StatusUpdate) && status_buffer_selectors == false
+          return false if message.is_a?(RSMP::Alarm) && !receive_alarms?
+
+          if message.is_a? RSMP::AggregatedStatus
+            prepare_aggregated_status_for_buffer message, core_version: core_version, for_send: for_send
+          elsif message.is_a? RSMP::StatusUpdate
+            prepare_status_update_for_buffer message, core_version: core_version, for_send: for_send
+          else
+            clone_message message
+          end
+        end
+
+        def buffer_message(message, error = nil)
+          prepared = prepare_message_for_buffer message, core_version: @core_version
+          if prepared
+            enqueue_buffered_message prepared
+          elsif site_originated_buffer_candidate? message
+            log "Discarded #{message.type}; it is not configured for buffering", message: message, level: :warning
+          else
+            super
+          end
+        rescue NotReady, IOError
+          raise error if error
+        end
+
+        def enqueue_buffered_message(message)
+          while @message_buffer.size >= message_buffer_max_messages
+            dropped = @message_buffer.shift
+            log "Dropped buffered #{dropped.type}; message buffer is full", message: dropped, level: :warning
+          end
+          @message_buffer << message
+          log "Buffered #{message.type}; #{message_buffer.size} message(s) queued", message: message, level: :warning
+          message
+        end
+
+        def flush_message_buffer
+          return if @message_buffer.empty?
+
+          queued = @message_buffer
+          @message_buffer = []
+          log "Sending #{queued.size} buffered message(s)", level: :info
+          queued.each_with_index do |message, index|
+            break unless flush_buffered_message(message, queued, index)
+          end
+        end
+
+        def flush_buffered_message(message, queued, index)
+          prepared = prepare_message_for_buffer message, core_version: @core_version, for_send: true
+          return true unless prepared
+
+          send_message prepared, 'from buffer', buffer: false
+          true
+        rescue NotReady, IOError
+          @message_buffer = queued[index..] + @message_buffer
+          log "Stopped sending buffered messages; #{message_buffer.size} message(s) remain queued", level: :warning
+          false
+        end
+      end
+    end
+  end
+end

data/lib/rsmp/proxy/supervisor/modules/status.rb

@@ -101,6 +101,21 @@ module RSMP
           acknowledge message
         end
 
+        def prune_unbuffered_status_subscriptions
+          @status_subscriptions.each_key.to_a.each do |component_id|
+            by_code = @status_subscriptions[component_id]
+            by_code.each_key.to_a.each do |code|
+              by_name = by_code[code]
+              by_name.delete_if do |name, _subscription|
+                status = { 'sCI' => code, 'n' => name }
+                !status_buffer_selector?(component_id, status)
+              end
+              by_code.delete(code) if by_name.empty?
+            end
+            @status_subscriptions.delete(component_id) if by_code.empty?
+          end
+        end
+
         def fetch_last_sent_status(component, code, name)
           @last_status_sent&.dig component, code, name
         end

data/lib/rsmp/proxy/supervisor/supervisor_proxy.rb

@@ -7,8 +7,9 @@ module RSMP
     include Modules::Commands
     include Modules::Alarms
     include Modules::AggregatedStatus
+    include Modules::MessageBuffer
 
-    attr_reader :supervisor_id, :site
+    attr_reader :supervisor_id, :site, :message_buffer
 
     def initialize(options)
       super(options.merge(node: options[:site]))
@@ -21,6 +22,7 @@ module RSMP
       @accepted_sxls = @sxls.dup
       @rejected_sxls = []
       @synthetic_id = Supervisor.build_id_from_ip_port @ip, @port
+      @message_buffer = []
     end
 
     # handle communication
@@ -51,6 +53,11 @@ module RSMP
       send_version_request @site_settings['site_id'], core_versions
     end
 
+    def close
+      prune_unbuffered_status_subscriptions
+      super
+    end
+
     # connect to the supervisor and initiate handshake supervisor
     def connect
       log "Connecting to supervisor at #{@ip}:#{@port}", level: :info
@@ -98,6 +105,7 @@ module RSMP
         send_all_aggregated_status
         send_active_alarms if receive_alarms?
       end
+      flush_message_buffer
       super
     end
 
@@ -170,11 +178,6 @@ module RSMP
       send_watchdog
     end
 
-    def timer(now)
-      super
-      status_update_timer now if ready?
-    end
-
     def process_version(message)
       return extraneous_version message if @version_determined
 

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = '0.45.2'.freeze
+  VERSION = '0.46.0'.freeze
 end

data/lib/rsmp.rb

@@ -77,6 +77,7 @@ require_relative 'rsmp/proxy/supervisor/modules/status'
 require_relative 'rsmp/proxy/supervisor/modules/commands'
 require_relative 'rsmp/proxy/supervisor/modules/alarms'
 require_relative 'rsmp/proxy/supervisor/modules/aggregated_status'
+require_relative 'rsmp/proxy/supervisor/modules/message_buffer'
 require_relative 'rsmp/proxy/supervisor/supervisor_proxy'
 require_relative 'rsmp/proxy/site/modules/status'
 require_relative 'rsmp/proxy/site/modules/aggregated_status'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.45.2
+  version: 0.46.0
 platform: ruby
 authors:
 - Emil Tin
@@ -228,6 +228,7 @@ files:
 - lib/rsmp/proxy/supervisor/modules/aggregated_status.rb
 - lib/rsmp/proxy/supervisor/modules/alarms.rb
 - lib/rsmp/proxy/supervisor/modules/commands.rb
+- lib/rsmp/proxy/supervisor/modules/message_buffer.rb
 - lib/rsmp/proxy/supervisor/modules/status.rb
 - lib/rsmp/proxy/supervisor/supervisor_proxy.rb
 - lib/rsmp/schema.rb