rsmp 0.46.0 → 0.48.0

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

@@ -0,0 +1,80 @@
+module RSMP
+  # Connection handling for site instances.
+  module SiteConnections
+    def build_proxies
+      return if server_role?
+
+      @site_settings['supervisors'].each do |supervisor_settings|
+        @proxies << SupervisorProxy.new(supervisor_proxy_options(supervisor_settings))
+      end
+    end
+
+    def listen_for_supervisors
+      ip = @site_settings['ip'] || '0.0.0.0'
+      port = @site_settings['port']
+      log "Starting #{site_type_name} listener on #{ip}:#{port}", level: :info, timestamp: @clock.now
+      @endpoint = IO::Endpoint.tcp(ip, port)
+      @accept_task = Async::Task.current.async do |task|
+        task.annotate 'site accept loop'
+        accept_supervisor_connections
+      end
+
+      @ready_condition.signal
+      @accept_task.wait
+    end
+
+    def accept_supervisor_connections
+      @endpoint.accept do |socket|
+        accept_supervisor_connection socket
+      rescue StandardError => e
+        distribute_error e, level: :internal
+      end
+    rescue Async::Stop
+      # Expected during shutdown - no action needed
+    rescue StandardError => e
+      distribute_error e, level: :internal
+    end
+
+    def accept_supervisor_connection(socket)
+      remote_port = socket.remote_address.ip_port
+      remote_ip = socket.remote_address.ip_address
+      proxy = SupervisorProxy.new(accepted_supervisor_options(socket, remote_ip, remote_port))
+      @proxies << proxy
+      @proxies_condition.signal
+      proxy.start
+      proxy.wait
+    end
+
+    def connect_to_supervisor(_task, supervisor_settings)
+      proxy = build_proxy(supervisor_proxy_options(supervisor_settings))
+      @proxies << proxy
+      proxy.start
+      @proxies_condition.signal
+    end
+
+    private
+
+    def supervisor_proxy_options(supervisor_settings)
+      {
+        site: self,
+        task: @task,
+        settings: @site_settings,
+        ip: supervisor_settings['ip'],
+        port: supervisor_settings['port'],
+        logger: @logger,
+        archive: @archive,
+        collect: @collect
+      }
+    end
+
+    def accepted_supervisor_options(socket, remote_ip, remote_port)
+      stream = IO::Stream::Buffered.new(socket)
+      supervisor_proxy_options('ip' => remote_ip, 'port' => remote_port).merge(
+        socket: socket,
+        stream: stream,
+        protocol: RSMP::Protocol.new(stream),
+        info: { ip: remote_ip, port: remote_port, hostname: remote_ip, now: Clock.now }
+      )
+    end
+  end
+end

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

@@ -2,8 +2,9 @@ module RSMP
   # RSMP site implementation that manages proxies and components.
   class Site < Node
     include Components
+    include SiteConnections
 
-    attr_reader :core_version, :site_settings, :logger, :proxies
+    attr_reader :core_version, :site_settings, :logger, :proxies, :ready_condition
 
     def self.options_class
       RSMP::Site::Options
@@ -16,6 +17,7 @@ module RSMP
       @proxies = []
       @sleep_condition = Async::Notification.new
       @proxies_condition = Async::Notification.new
+      @ready_condition = Async::Notification.new
       build_proxies
     end
 
@@ -35,6 +37,14 @@ module RSMP
       @site_settings['site_id']
     end
 
+    def client_role?
+      @site_settings['connection_role'] != 'server'
+    end
+
+    def server_role?
+      @site_settings['connection_role'] == 'server'
+    end
+
     def handle_site_settings(options = {})
       options_class = self.class.options_class
       settings = options[:site_settings] || {}
@@ -97,22 +107,11 @@ module RSMP
     def run
       log_site_starting
       start_status_timer
-      @proxies.each(&:start)
-      @proxies.each(&:wait)
-    end
-
-    def build_proxies
-      @site_settings['supervisors'].each do |supervisor_settings|
-        @proxies << SupervisorProxy.new({
-                                          site: self,
-                                          task: @task,
-                                          settings: @site_settings,
-                                          ip: supervisor_settings['ip'],
-                                          port: supervisor_settings['port'],
-                                          logger: @logger,
-                                          archive: @archive,
-                                          collect: @collect
-                                        })
+      if server_role?
+        listen_for_supervisors
+      else
+        @proxies.each(&:start)
+        @proxies.each(&:wait)
       end
     end
 
@@ -177,36 +176,23 @@ module RSMP
 
     def stop_subtasks
       stop_status_timer
+      @accept_task&.stop
+      @accept_task = nil
+      @endpoint = nil
       super
     end
 
-    def connect_to_supervisor(_task, supervisor_settings)
-      proxy = build_proxy({
-                            site: self,
-                            task: @task,
-                            settings: @site_settings,
-                            ip: supervisor_settings['ip'],
-                            port: supervisor_settings['port'],
-                            logger: @logger,
-                            archive: @archive,
-                            collect: @collect
-                          })
-      @proxies << proxy
-      proxy.start
-      @proxies_condition.signal
-    end
-
     # stop
     def stop
       log "Stopping site #{@site_settings['site_id']}", level: :info
       super
     end
 
-    def wait_for_supervisor(ip, timeout)
+    def wait_for_supervisor(ip, timeout:)
       supervisor = find_supervisor ip
       return supervisor if supervisor
 
-      wait_for_condition(@proxy_condition, timeout: timeout) { find_supervisor ip }
+      wait_for_condition(@proxies_condition, timeout: timeout) { find_supervisor ip }
     rescue Async::TimeoutError
       raise RSMP::TimeoutError, "Supervisor '#{ip}' did not connect within #{timeout}s"
     end

data/lib/rsmp/node/supervisor/supervisor.rb

@@ -21,8 +21,18 @@ module RSMP
       @supervisor_settings['site_id']
     end
 
+    def client_role?
+      @supervisor_settings['connection_role'] == 'client'
+    end
+
+    def server_role?
+      !client_role?
+    end
+
     # listen for connections
     def run
+      return connect_to_sites if client_role?
+
       log "Starting supervisor on port #{@supervisor_settings['port']}",
           level: :info,
           timestamp: @clock.now
@@ -47,6 +57,38 @@ module RSMP
       distribute_error e, level: :internal
     end
 
+    def connect_to_sites
+      log 'Starting supervisor in client connection role',
+          level: :info,
+          timestamp: @clock.now
+      build_outbound_proxies
+      @ready_condition.signal
+      @proxies.each(&:start)
+      @proxies.each(&:wait)
+    end
+
+    def build_outbound_proxies
+      site_entries = (@supervisor_settings['sites'] || {}).except('default')
+      site_entries.each_pair do |site_id, site_settings|
+        endpoints = site_settings['supervisors'] || []
+        merged_settings = site_id_to_site_setting site_id
+        endpoints.each do |endpoint|
+          @proxies << SiteProxy.new({
+                                      supervisor: self,
+                                      task: @task,
+                                      settings: @supervisor_settings,
+                                      site_id: site_id,
+                                      site_settings: merged_settings,
+                                      ip: endpoint['ip'],
+                                      port: endpoint['port'],
+                                      logger: @logger,
+                                      archive: @archive,
+                                      collect: @collect
+                                    })
+        end
+      end
+    end
+
     # stop
     def stop
       log "Stopping supervisor #{@supervisor_settings['site_id']}", level: :info

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

@@ -5,17 +5,12 @@
   "properties": {
     "site_id": { "type": "string" },
     "type": { "type": "string" },
+    "connection_role": { "enum": ["client", "server"] },
+    "ip": { "type": "string" },
+    "port": { "type": ["integer", "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,56 +18,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" },
-    "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" },
+    "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,8 @@
   "properties": {
     "port": { "type": ["integer", "string"] },
     "ip": { "type": "string" },
+    "connection_role": { "enum": ["client", "server"] },
+    "proxy_type": { "type": "string" },
     "ips": {
       "oneOf": [
         { "type": "string" },
@@ -12,38 +14,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
 }