rsmp 0.45.2 → 0.47.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ceec0bb561c61873341a4af09334ed0c6e0eb7bb1909b6fb38f2a350aaae8ca9
-  data.tar.gz: 41f8df99b563e086770f502e69ff8bc8a8dc91b075aa9e50c2f0dd451b8bc0ad
+  metadata.gz: c206e0c53de4f523b03832b8821b698ea0f0440c11cdb51f5685382f4bdaebf5
+  data.tar.gz: 2b35690dbe819d58cf76fe82faf1baec3392e6ecf54fbcd71b0e15c4fd7b7887
 SHA512:
-  metadata.gz: 46ee01791490e180283de79f9568b4d37ad8bef6bd228f2cee5c6eca7d95f568fad715f5f48314c1ebfec8610185bd027b7cc5e65701af248d2253d3569ff491
-  data.tar.gz: 26b27b919cc42a3fdf337720bfb31c3168e8a2a95a0361b642efe27973352eaffbcb4e4c07ea3d55a6f0d4e59d57650c226ed603edcf6a9c45747bb1b3439c98
+  metadata.gz: 4e7c84bc1a7c35f5f58108db5803cc8f0a9abe58ab9edc83a09d778d62479bcc1e0310eb2af9c0e9fe1cad75bf187303ba0d8759ff8b793dd15ae1abe118bcfe
+  data.tar.gz: 562f88737283e91ab232c68c70344c9f668e5d08b0aa488b24ac21af57d07c30936b297c647aa00bedc7dae585faf8ed6be3593849c3f63721b1974b809b1696

data/CHANGELOG.md

@@ -670,3 +670,22 @@ 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
+
+## 0.47.0
+- add cli command for checking configs
+- tighten config schemas

data/Gemfile.lock

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

data/documentation/configuration.md

@@ -46,10 +46,36 @@ sxls:
 components:
   main:
     TC:
+message_buffer:
+  max_messages: 10000
+  statuses: true
 log:
   json: true
 ```
 
+## Message Buffer
+
+Sites buffer outgoing alarm and aggregated status messages while a supervisor connection is down. Status updates are buffered according to `message_buffer.statuses`, which defaults to `true`.
+
+```yaml
+message_buffer:
+  max_messages: 10000
+  statuses: true
+```
+
+`statuses: true` buffers all subscribed status updates during communication disruption. To buffer only selected statuses, provide selectors:
+
+```yaml
+message_buffer:
+  statuses:
+    - sCI: S0001
+      n: signalgroupstatus
+```
+
+Use `statuses: false` or an empty list to avoid buffering status updates. Subscriptions for statuses that are not buffered are removed when the connection is lost.
+
+The current implementation uses an in-memory buffer per supervisor connection. Buffered messages survive reconnects while the process keeps running, but are lost if the process exits, crashes, or the host loses power. The RSMP core specification requires the outgoing communication buffer to survive communication failure and power outage, so this is not yet a complete persistent buffer implementation.
+
 ## Example: supervisor YAML
 
 ```yaml

data/lib/rsmp/cli.rb

@@ -20,6 +20,32 @@ module RSMP
     end
   end
 
+  # CLI subcommands for RSMP configuration validation.
+  class ConfigCLI < Thor
+    namespace :config
+    desc 'check PATH...', 'Validate RSMP site or supervisor config files'
+    method_option :type, type: :string, aliases: '-t', default: 'auto',
+                         enum: ['auto'] + RSMP::Config.types,
+                         banner: 'Config type: auto, site, tlc or supervisor'
+    def check(*paths)
+      if paths.empty?
+        puts 'Error: config check requires at least one path'
+        exit 1
+      end
+
+      valid = true
+      paths.each do |path|
+        RSMP::Config.load_file(path, type: options[:type])
+        puts 'OK'
+      rescue RSMP::ConfigurationError => e
+        valid = false
+        puts "Error: #{e.message}"
+      end
+
+      exit 1 unless valid
+    end
+  end
+
   # CLI commands for running RSMP site and supervisor.
   class CLI < Thor
     desc 'version', 'Show version'
@@ -69,6 +95,7 @@ module RSMP
     end
 
     register SchemaCLI, 'schema', 'schema COMMAND', 'SXL schema commands'
+    register ConfigCLI, 'config', 'config COMMAND', 'Configuration commands'
 
     no_commands do
       def load_site_configuration

data/lib/rsmp/config.rb

@@ -0,0 +1,63 @@
+module RSMP
+  # Validation helpers for RSMP runtime configuration hashes and files.
+  module Config
+    class << self
+      def validate(settings = {}, type:, source: nil, log_settings: nil)
+        options_class_for(type).new(settings, source: source, log_settings: log_settings)
+      end
+
+      def load_file(path, type:)
+        raise RSMP::ConfigurationError, 'not found' unless File.exist?(path)
+        raise RSMP::ConfigurationError, 'is not a file' unless File.file?(path)
+        raise RSMP::ConfigurationError, 'must be a YAML file (.yml or .yaml)' unless yaml_file?(path)
+
+        raw = YAML.load_file(path)
+        raise RSMP::ConfigurationError, "Config #{path} must be a hash" unless raw.is_a?(Hash) || raw.nil?
+
+        raw ||= {}
+        settings = raw.dup
+        log_settings = settings.delete('log') || {}
+        validate(settings, type: resolve_type(type, settings), log_settings: log_settings)
+      rescue Psych::SyntaxError => e
+        raise RSMP::ConfigurationError, "Cannot read config file #{path}: #{e}"
+      end
+
+      def types
+        %w[site supervisor tlc]
+      end
+
+      private
+
+      def yaml_file?(path)
+        %w[.yml .yaml].include?(File.extname(path).downcase)
+      end
+
+      def resolve_type(type, settings)
+        type = type.to_s
+        return infer_type(settings) if type == 'auto'
+
+        type
+      end
+
+      def infer_type(settings)
+        return 'supervisor' if settings.key?('sites')
+        return 'site' if settings.key?('supervisors')
+
+        raise RSMP::ConfigurationError, 'Cannot infer config type; use --type site, --type tlc or --type supervisor'
+      end
+
+      def options_class_for(type)
+        case type.to_s
+        when 'site'
+          RSMP::Site::Options
+        when 'supervisor'
+          RSMP::Supervisor::Options
+        when 'tlc'
+          RSMP::TLC::TrafficControllerSite::Options
+        else
+          raise RSMP::ConfigurationError, "Unknown config type #{type.inspect}, expected one of #{types.join(', ')}"
+        end
+      end
+    end
+  end
+end

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/options.rb

@@ -10,6 +10,8 @@ module RSMP
 
     def self.load_file(path, validate: true)
       raise RSMP::ConfigurationError, "Config #{path} not found" unless File.exist?(path)
+      raise RSMP::ConfigurationError, "Config #{path} is not a file" unless File.file?(path)
+      raise RSMP::ConfigurationError, "Config #{path} must be a YAML file (.yml or .yaml)" unless yaml_file?(path)
 
       raw = YAML.load_file(path)
       raise RSMP::ConfigurationError, "Config #{path} must be a hash" unless raw.is_a?(Hash) || raw.nil?
@@ -21,27 +23,37 @@ module RSMP
       raise RSMP::ConfigurationError, "Cannot read config file #{path}: #{e}"
     end
 
+    def self.yaml_file?(path)
+      %w[.yml .yaml].include?(File.extname(path).downcase)
+    end
+
     def initialize(options = nil, source: nil, log_settings: nil, validate: true, **extra)
       options = extra if options.nil? && extra.any?
       @source = source
       @log_settings = normalize(log_settings || {})
+      validate_log_settings! if validate
       config = normalize_config(options || {})
       validate!(config) if validate
       @data = normalize(apply_defaults(config))
     end
 
-    def defaults
-      {}
-    end
+    def defaults = {}
 
-    def schema_file
-      nil
-    end
+    def schema_file = nil
+
+    def schema_path = schema_file && File.join(SCHEMAS_PATH, schema_file)
 
-    def schema_path
-      return unless schema_file
+    def log_schema_path = File.join(SCHEMAS_PATH, 'log.json')
 
-      File.join(SCHEMAS_PATH, schema_file)
+    def validate_log_settings!
+      return unless File.exist?(log_schema_path)
+
+      schemer = JSONSchemer.schema(Pathname.new(log_schema_path))
+      errors = schemer.validate(@log_settings).to_a
+      return if errors.empty?
+
+      message = errors.map { |error| format_error(error) }.join("\n")
+      raise RSMP::ConfigurationError, "Invalid log configuration#{source_suffix}:\n#{message}"
     end
 
     def validate!(data = @data)

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

@@ -0,0 +1,129 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "config_common.json",
+  "$defs": {
+    "endpoint": {
+      "type": "object",
+      "properties": {
+        "ip": { "type": "string" },
+        "port": { "type": ["integer", "string"] }
+      },
+      "required": ["ip", "port"],
+      "additionalProperties": false
+    },
+    "intervals": {
+      "type": "object",
+      "properties": {
+        "timer": { "type": "number" },
+        "watchdog": { "type": "number" },
+        "reconnect": { "type": "number" },
+        "after_connect": { "type": "number" }
+      },
+      "additionalProperties": false
+    },
+    "timeouts": {
+      "type": "object",
+      "properties": {
+        "connect": { "type": "number" },
+        "ready": { "type": "number" },
+        "watchdog": { "type": "number" },
+        "acknowledgement": { "type": "number" },
+        "command": { "type": "number" },
+        "command_timeout": { "type": "number" },
+        "status_response": { "type": "number" }
+      },
+      "additionalProperties": false
+    },
+    "component_settings": {
+      "type": ["object", "null"],
+      "properties": {
+        "name": { "type": "string" },
+        "ntsOId": { "type": "string" },
+        "xNId": { "type": "string" },
+        "type": { "type": "string" }
+      },
+      "additionalProperties": false
+    },
+    "components": {
+      "type": "object",
+      "additionalProperties": {
+        "type": ["object", "null"],
+        "additionalProperties": { "$ref": "#/$defs/component_settings" }
+      }
+    },
+    "security_codes": {
+      "type": "object",
+      "additionalProperties": { "type": "string" }
+    },
+    "signal_plans": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "object",
+        "properties": {
+          "cycle_time": { "type": "number" },
+          "states": {
+            "type": "object",
+            "additionalProperties": { "type": "string" }
+          },
+          "dynamic_bands": {
+            "type": "object",
+            "additionalProperties": { "type": "integer" }
+          }
+        },
+        "additionalProperties": false
+      }
+    },
+    "input_programming_action": {
+      "type": ["object", "null"],
+      "properties": {
+        "raise_alarm": { "type": "string" },
+        "component": { "type": "string" }
+      },
+      "additionalProperties": false
+    },
+    "inputs": {
+      "type": "object",
+      "properties": {
+        "total": { "type": "integer", "minimum": 1 },
+        "programming": {
+          "oneOf": [
+            {
+              "type": "object",
+              "additionalProperties": { "$ref": "#/$defs/input_programming_action" }
+            },
+            {
+              "type": "array",
+              "items": { "$ref": "#/$defs/input_programming_action" }
+            }
+          ]
+        }
+      },
+      "additionalProperties": false
+    },
+    "message_buffer": {
+      "type": "object",
+      "properties": {
+        "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
+    }
+  }
+}

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

@@ -0,0 +1,71 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "log.json",
+  "$defs": {
+    "display_field": {
+      "oneOf": [
+        { "type": "boolean" },
+        { "type": "integer", "minimum": 0 },
+        { "type": "string" }
+      ]
+    },
+    "message_filter": { "type": "boolean" },
+    "style_item": {
+      "oneOf": [
+        { "type": "string" },
+        {
+          "type": "object",
+          "properties": {
+            "color": { "type": "string" },
+            "mode": { "type": "string" }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "style": {
+      "oneOf": [
+        { "type": "boolean" },
+        { "type": "string" },
+        {
+          "type": "object",
+          "additionalProperties": { "$ref": "#/$defs/style_item" }
+        }
+      ]
+    }
+  },
+  "type": "object",
+  "properties": {
+    "active": { "type": "boolean" },
+    "path": { "type": ["string", "null"] },
+    "stream": {},
+    "style": { "$ref": "#/$defs/style" },
+    "debug": { "type": "boolean" },
+    "info": { "type": "boolean" },
+    "statistics": { "type": "boolean" },
+    "hide_ip_and_port": { "type": "boolean" },
+    "acknowledgements": { "type": "boolean" },
+    "watchdogs": { "$ref": "#/$defs/message_filter" },
+    "alarms": { "$ref": "#/$defs/message_filter" },
+    "versions": { "$ref": "#/$defs/message_filter" },
+    "statuses": { "$ref": "#/$defs/message_filter" },
+    "commands": { "$ref": "#/$defs/message_filter" },
+    "aggregated_status": { "$ref": "#/$defs/message_filter" },
+    "tabs": { "type": ["string", "boolean", "null"] },
+    "prefix": { "$ref": "#/$defs/display_field" },
+    "index": { "$ref": "#/$defs/display_field" },
+    "author": { "$ref": "#/$defs/display_field" },
+    "timestamp": { "$ref": "#/$defs/display_field" },
+    "ip": { "$ref": "#/$defs/display_field" },
+    "port": { "$ref": "#/$defs/display_field" },
+    "site_id": { "$ref": "#/$defs/display_field" },
+    "component": { "$ref": "#/$defs/display_field" },
+    "direction": { "$ref": "#/$defs/display_field" },
+    "level": { "$ref": "#/$defs/display_field" },
+    "id": { "$ref": "#/$defs/display_field" },
+    "text": { "$ref": "#/$defs/display_field" },
+    "json": { "$ref": "#/$defs/display_field" },
+    "exception": { "$ref": "#/$defs/display_field" }
+  },
+  "additionalProperties": false
+}

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

@@ -7,15 +7,7 @@
     "type": { "type": "string" },
     "supervisors": {
       "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "ip": { "type": "string" },
-          "port": { "type": ["integer", "string"] }
-        },
-        "required": ["ip", "port"],
-        "additionalProperties": true
-      }
+      "items": { "$ref": "config_common.json#/$defs/endpoint" }
     },
     "sxls": {
       "type": "object",
@@ -23,30 +15,16 @@
       "additionalProperties": { "type": "string" }
     },
     "core_version": { "type": "string" },
-    "intervals": {
-      "type": "object",
-      "properties": {
-        "timer": { "type": "number" },
-        "watchdog": { "type": "number" },
-        "reconnect": { "type": "number" }
-      },
-      "additionalProperties": true
-    },
-    "timeouts": {
-      "type": "object",
-      "properties": {
-        "watchdog": { "type": "number" },
-        "acknowledgement": { "type": "number" }
-      },
-      "additionalProperties": true
-    },
+    "intervals": { "$ref": "config_common.json#/$defs/intervals" },
+    "timeouts": { "$ref": "config_common.json#/$defs/timeouts" },
     "send_after_connect": { "type": "boolean" },
-    "components": { "type": "object" },
-    "security_codes": { "type": "object" },
+    "message_buffer": { "$ref": "config_common.json#/$defs/message_buffer" },
+    "components": { "$ref": "config_common.json#/$defs/components" },
+    "security_codes": { "$ref": "config_common.json#/$defs/security_codes" },
     "startup_sequence": { "type": "string" },
-    "signal_plans": { "type": "object" },
-    "inputs": { "type": "object" },
+    "signal_plans": { "$ref": "config_common.json#/$defs/signal_plans" },
+    "inputs": { "$ref": "config_common.json#/$defs/inputs" },
     "live_output": { "type": ["string", "null"] }
   },
-  "additionalProperties": true
+  "additionalProperties": false
 }

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

@@ -4,6 +4,7 @@
   "properties": {
     "port": { "type": ["integer", "string"] },
     "ip": { "type": "string" },
+    "proxy_type": { "type": "string" },
     "ips": {
       "oneOf": [
         { "type": "string" },
@@ -12,38 +13,11 @@
     },
     "site_id": { "type": "string" },
     "max_sites": { "type": "integer" },
-    "default": {
-      "type": "object",
-      "properties": {
-        "sxls": {
-          "type": "object",
-          "propertyNames": { "not": { "const": "core" } },
-          "additionalProperties": { "type": "string" }
-        },
-        "core_version": { "type": "string" },
-        "intervals": {
-          "type": "object",
-          "properties": {
-            "timer": { "type": "number" },
-            "watchdog": { "type": "number" }
-          },
-          "additionalProperties": true
-        },
-        "timeouts": {
-          "type": "object",
-          "properties": {
-            "watchdog": { "type": "number" },
-            "acknowledgement": { "type": "number" }
-          },
-          "additionalProperties": true
-        }
-      },
-      "additionalProperties": true
-    },
+    "default": { "$ref": "supervisor_site.json" },
     "sites": {
       "type": "object",
       "additionalProperties": { "$ref": "supervisor_site.json" }
     }
   },
-  "additionalProperties": true
+  "additionalProperties": false
 }

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

@@ -8,42 +8,30 @@
       "propertyNames": { "not": { "const": "core" } },
       "additionalProperties": { "type": "string" }
     },
+    "core_version": { "type": "string" },
+    "rsmp_versions": {
+      "oneOf": [
+        { "type": "string" },
+        { "type": "array", "items": { "type": "string" } }
+      ]
+    },
     "type": { "type": "string" },
-    "components": { "type": "object" },
+    "components": { "$ref": "config_common.json#/$defs/components" },
     "supervisors": {
       "type": "array",
-      "items": {
-        "type": "object",
-        "properties": {
-          "ip": { "type": "string" },
-          "port": { "type": ["integer", "string"] }
-        },
-        "required": ["ip", "port"],
-        "additionalProperties": true
-      }
-    },
-    "intervals": {
-      "type": "object",
-      "properties": {
-        "timer": { "type": "number" },
-        "watchdog": { "type": "number" },
-        "reconnect": { "type": "number" },
-        "after_connect": { "type": "number" }
-      },
-      "additionalProperties": true
-    },
-    "timeouts": {
-      "type": "object",
-      "properties": {
-        "connect": { "type": "number" },
-        "watchdog": { "type": "number" },
-        "acknowledgement": { "type": "number" }
-      },
-      "additionalProperties": true
+      "items": { "$ref": "config_common.json#/$defs/endpoint" }
     },
+    "intervals": { "$ref": "config_common.json#/$defs/intervals" },
+    "timeouts": { "$ref": "config_common.json#/$defs/timeouts" },
     "send_after_connect": { "type": "boolean" },
+    "receive_alarms": { "type": "boolean" },
+    "message_buffer": { "$ref": "config_common.json#/$defs/message_buffer" },
     "skip_validation": { "type": "array", "items": { "type": "string" } },
-    "security_codes": { "type": "object" }
+    "security_codes": { "$ref": "config_common.json#/$defs/security_codes" },
+    "startup_sequence": { "type": "string" },
+    "signal_plans": { "$ref": "config_common.json#/$defs/signal_plans" },
+    "inputs": { "$ref": "config_common.json#/$defs/inputs" },
+    "live_output": { "type": ["string", "null"] }
   },
-  "additionalProperties": true
+  "additionalProperties": false
 }

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

@@ -12,8 +12,7 @@
         "inputs": { "type": "object" },
         "live_output": { "type": ["string", "null"] },
         "type": { "type": "string" }
-      },
-      "additionalProperties": true
+      }
     }
   ]
 }

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,13 @@ module RSMP
 
       private
 
+      def default_message_buffer
+        {
+          'max_messages' => 10_000,
+          'statuses' => true
+        }
+      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,139 @@
+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_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 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.47.0'.freeze
 end

data/lib/rsmp.rb

@@ -61,6 +61,7 @@ require_relative 'rsmp/options/options'
 require_relative 'rsmp/options/site_options'
 require_relative 'rsmp/options/supervisor_options'
 require_relative 'rsmp/options/traffic_controller_site_options'
+require_relative 'rsmp/config'
 require_relative 'rsmp/proxy/modules/state'
 require_relative 'rsmp/proxy/modules/watchdogs'
 require_relative 'rsmp/proxy/modules/acknowledgements'
@@ -77,6 +78,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.47.0
 platform: ruby
 authors:
 - Emil Tin
@@ -181,6 +181,7 @@ files:
 - lib/rsmp/component/component_base.rb
 - lib/rsmp/component/component_proxy.rb
 - lib/rsmp/component/components.rb
+- lib/rsmp/config.rb
 - lib/rsmp/convert/export/json_schema.rb
 - lib/rsmp/convert/export/json_schema/items.rb
 - lib/rsmp/convert/export/json_schema/outputs.rb
@@ -204,6 +205,8 @@ files:
 - lib/rsmp/node/supervisor/supervisor.rb
 - lib/rsmp/node/task.rb
 - lib/rsmp/options/options.rb
+- lib/rsmp/options/schemas/config_common.json
+- lib/rsmp/options/schemas/log.json
 - lib/rsmp/options/schemas/site.json
 - lib/rsmp/options/schemas/supervisor.json
 - lib/rsmp/options/schemas/supervisor_site.json
@@ -228,6 +231,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