rsmp 0.51.3 → 0.51.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 883735d537c281828ffe79225cf667fef84b88e2055e39820cc4213168f715ec
-  data.tar.gz: 7c577e4ee8998cf1dbcb7308aa486122ba430d967375e4827030dd89c075f408
+  metadata.gz: 653475280335ad2b867657cada46ef95d9cb61808cb12f3302762b0e2bcda790
+  data.tar.gz: 2d8b6cfe3c5b46623329cb1dbcb1a01544dd293ab93f5398b650fea8121d31fd
 SHA512:
-  metadata.gz: ae9f566fd7a1f2bc9c16f59507abfd1becacb0326489fa5308363daaee89122cb32863cbabf187f033fa34d18dfb6648a6e9f1150678e1c32d60aaa2f898be55
-  data.tar.gz: 6c2348ed50374b5d9f1b1b99313420d3190c588ac70bb562815c0b418e46ebd697fcdf8f8809915392ad8f42f70f5637b7154eb33df40d9d6695ce52b25c131a
+  metadata.gz: 82018c56d70a3cfa59db7d60b30c172f324765a01be8d650906d64c92109d68c52d80f75efdf388fd8332a9fa5028bc0ee1bed51e4293a1ffa6c5f441bfec8db
+  data.tar.gz: a1b83604f3b516da1dc0e8a3071cddd71cd4cadbc78f22406fe5ea0f73d21c06663ef1739de1666818d88ea85445cc6cc045ee024987fe2120a4ddc6e179b539

data/CHANGELOG.md

@@ -719,3 +719,13 @@ Initial release.
 
 ## 0.51.1
 - cleanup semantic versioning handling of version strings and use canonical schema versions internally
+
+## 0.51.2
+- bumb patch version for test purposes, no changes othewise
+
+## 0.51.3
+- ensure socket shutdown when stopping node
+
+## 0.51.4
+- don't update subscription list until unsubscribe is acknowledged
+

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rsmp (0.51.3)
+    rsmp (0.51.4)
       async (~> 2.45)
       colorize (~> 1.1)
       io-endpoint (~> 0.17)

data/documentation/configuration.md

@@ -16,6 +16,18 @@ RSMP uses option classes to handle configuration for sites and supervisors. Thes
 
 Each class applies defaults and validates the configuration against a JSON Schema located in `lib/rsmp/options/schemas/`.
 
+Field types and unknown keys are checked before defaults are applied. The `required_settings.json`
+and `required_supervisor_settings.json` schemas then check required settings after defaults and
+supervisor site inheritance are resolved:
+
+- Every configured signal plan must have a `cycle_time`.
+- Configured components must include exactly one `main` component. Sites supply a default main
+  component when omitted; supervisor site settings can inherit it from `default`.
+- A site in `server` role must have a `port`, either explicitly or from its first supervisor endpoint.
+  With `supervisors: []`, the port must be explicit.
+
+`inputs.programming: {}` is allowed and means no programmed input actions.
+
 ## Version strings
 
 Core 3.3.0 and later use exact `MAJOR.MINOR.PATCH` version strings for both Core and SXL negotiation.

data/lib/rsmp/options/options.rb

@@ -34,7 +34,9 @@ module RSMP
       validate_log_settings! if validate
       config = normalize_config(options || {})
       validate!(config) if validate
-      @data = normalize(apply_defaults(config))
+      config = apply_defaults(config)
+      validate_effective!(config) if validate
+      @data = normalize(config)
     end
 
     def defaults = {}
@@ -56,10 +58,10 @@ module RSMP
       raise RSMP::ConfigurationError, "Invalid log configuration#{source_suffix}:\n#{message}"
     end
 
-    def validate!(data = @data)
-      return unless schema_path && File.exist?(schema_path)
+    def validate!(data = @data, path: schema_path)
+      return unless path && File.exist?(path)
 
-      schemer = JSONSchemer.schema(Pathname.new(schema_path))
+      schemer = JSONSchemer.schema(Pathname.new(path))
       errors = schemer.validate(data).to_a
       return if errors.empty?
 
@@ -86,6 +88,8 @@ module RSMP
 
     private
 
+    def validate_effective!(_config); end
+
     def apply_defaults(options)
       defaults.deep_merge(options)
     end

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

@@ -0,0 +1,30 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$comment": "Validate after applying defaults and inherited site settings; structural validation uses the other config schemas.",
+  "type": "object",
+  "properties": {
+    "components": {
+      "type": "object",
+      "required": ["main"],
+      "properties": {
+        "main": {
+          "type": "object",
+          "minProperties": 1,
+          "maxProperties": 1
+        }
+      }
+    },
+    "signal_plans": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "object",
+        "required": ["cycle_time"]
+      }
+    }
+  },
+  "if": {
+    "required": ["connection_role"],
+    "properties": { "connection_role": { "const": "server" } }
+  },
+  "then": { "required": ["port"] }
+}

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

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$comment": "Validate each site after merging supervisor defaults, without changing the stored overrides.",
+  "type": "object",
+  "properties": {
+    "default": { "$ref": "required_settings.json" },
+    "sites": {
+      "type": "object",
+      "additionalProperties": { "$ref": "required_settings.json" }
+    }
+  }
+}

data/lib/rsmp/options/site_options.rb

@@ -23,6 +23,10 @@ module RSMP
 
       private
 
+      def validate_effective!(config)
+        validate!(config, path: File.join(SCHEMAS_PATH, 'required_settings.json'))
+      end
+
       def default_message_buffer
         {
           'max_messages' => 10_000,
@@ -54,7 +58,8 @@ module RSMP
         defaults = defaults()
         defaults['components']['main'] = options['components']['main'] if options.dig('components', 'main')
         data = defaults.deep_merge(options)
-        data['port'] ||= data.dig('supervisors', 0, 'port')
+        port = data.dig('supervisors', 0, 'port')
+        data['port'] ||= port if port
         data
       end
     end

data/lib/rsmp/options/supervisor_options.rb

@@ -28,6 +28,15 @@ module RSMP
       def schema_file
         'supervisor.json'
       end
+
+      private
+
+      def validate_effective!(config)
+        base = config['default'] || {}
+        sites = (config['sites'] || {}).transform_values { |settings| base.deep_merge(settings) }
+        effective = config.merge('sites' => sites)
+        validate!(effective, path: File.join(SCHEMAS_PATH, 'required_supervisor_settings.json'))
+      end
     end
   end
 end

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

@@ -103,6 +103,8 @@ module RSMP
               component_list_acknowledged
             when 'StatusSubscribe'
               status_subscribe_acknowledged original
+            when 'StatusUnsubscribe'
+              status_unsubscribe_acknowledged original
             end
 
             check_outgoing_acknowledged original

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

@@ -3,6 +3,16 @@ module RSMP
     module Modules
       # Handles status requests, responses, subscriptions and updates
       module Status
+        def clear
+          super
+          @pending_status_unsubscriptions = {}
+        end
+
+        def process_not_ack(message)
+          @pending_status_unsubscriptions.delete(message.attribute('oMId'))
+          super
+        end
+
         # Build and send a StatusRequest. Returns Result<StatusRequest>.
         def request_status(status_list, component: nil, m_id: nil, validate: true)
           readiness = validate_ready 'request status'
@@ -75,9 +85,9 @@ module RSMP
           subscribe_list.each do |item|
             code = item['sCI']
             name = item['n']
-            sub = ensure_subscription_path(component_id, code, name)
-            sub['uRt'] = item['uRt']
-            sub['sOc'] = item['sOc']
+            ensure_subscription_path(component_id, code, name)
+            # Replace the record so an older unsubscribe ACK cannot remove it.
+            @status_subscriptions[component_id][code][name] = item.slice('uRt', 'sOc')
           end
         end
 
@@ -147,20 +157,46 @@ module RSMP
         def unsubscribe_to_status(status_list, component: nil, validate: nil)
           component ||= main.c_id
 
-          status_list.each do |item|
-            remove_subscription_item(component, item['sCI'], item['n'])
-          end
-
           # Local subscription state must be cleaned up even when the peer has
           # already disconnected. In that case there is nothing left to send.
-          return Result.success(nil) unless ready?
+          unless ready?
+            status_list.each do |item|
+              remove_subscription_item(component, item['sCI'], item['n'])
+            end
+            return Result.success(nil)
+          end
 
           message = RSMP::StatusUnsubscribe.new({
                                                   'cId' => component,
                                                   'sS' => status_list
                                                 })
           apply_nts_message_attributes message
-          send_message(message, validate: validate).map(&:message)
+          track_status_unsubscribe(message)
+          delivery = send_message(message, validate: validate)
+          delivery.map(&:message)
+        ensure
+          @pending_status_unsubscriptions.delete(message.m_id) if message && !delivery&.success?
+        end
+
+        def track_status_unsubscribe(message)
+          component = message.attribute('cId')
+          @pending_status_unsubscriptions[message.m_id] = message.attribute('sS').map do |item|
+            code = item['sCI']
+            name = item['n']
+            [code, name, @status_subscriptions.dig(component, code, name)]
+          end
+        end
+
+        def status_unsubscribe_acknowledged(original)
+          component = original.attribute('cId')
+          subscriptions = @pending_status_unsubscriptions.delete(original.m_id)
+          return unless subscriptions
+
+          subscriptions.each do |code, name, subscription|
+            next unless @status_subscriptions.dig(component, code, name).equal?(subscription)
+
+            remove_subscription_item(component, code, name)
+          end
         end
 
         def unsubscribe_to_status!(...)

data/lib/rsmp/tlc/modules/inputs.rb

@@ -190,6 +190,8 @@ module RSMP
         end
 
         def programming_hash_to_array(normalized)
+          return [] if normalized.empty?
+
           max_key = normalized.keys.max
           program_array = Array.new(max_key + 1)
           normalized.each do |index, value|

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = '0.51.3'.freeze
+  VERSION = '0.51.4'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.51.3
+  version: 0.51.4
 platform: ruby
 authors:
 - Emil Tin
@@ -218,6 +218,8 @@ files:
 - lib/rsmp/options/options.rb
 - lib/rsmp/options/schemas/config_common.json
 - lib/rsmp/options/schemas/log.json
+- lib/rsmp/options/schemas/required_settings.json
+- lib/rsmp/options/schemas/required_supervisor_settings.json
 - lib/rsmp/options/schemas/site.json
 - lib/rsmp/options/schemas/supervisor.json
 - lib/rsmp/options/schemas/supervisor_site.json