rsmp 0.51.0 → 0.51.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 363ee5c8eb68f060a0f464939cc6a4444265568821fab38186992b189de29dd0
-  data.tar.gz: f53b952f5877fd3c17b8d90ee82b7e1412432ad34a68cdcac3736320674cce8f
+  metadata.gz: b41aa5a1cbba1d8803f5c579b06b91472e0f9aed82db0c5ed70b14881f1faef4
+  data.tar.gz: 7d487e564d6626c0fc306e328d45dcff7576cbac442f31971784de1b0be7bdd6
 SHA512:
-  metadata.gz: ed82fd73d09b5bcbd83c5c675a9e8ff9ed8d925e23f7cd059dd8efd9ca413e672f53ca0f3f76717114686d541c88b2a84f6dcd204a57338688b4c5db11dec1c9
-  data.tar.gz: 2598d67cfd2d5a66bf466b6c8901d2013689160b18cf4fead369111c41dd0cc2ee760874551fc0b86d70f284b21a38b68aa5810c534a0a3563b79ef028f972a9
+  metadata.gz: 37b1f43e03c6ef6c4b41c95d8b3f2b0c394f656c7285bde99b14d4d4c8bfabdd6c0230fccd0861115d02eb6a4d04a97ecc012a2824efd3b8fdf5f48b6a0a53fb
+  data.tar.gz: fae75a302258af53de4308eba92dc39d3eb4ee3d00cdceead6c12e7ccc9773a03085bb2df9df21e6c2dcb658532044caa1f83a5fcd564e74c0e31560b53abf38

data/CHANGELOG.md

@@ -711,3 +711,11 @@ Initial release.
 - publish typed events for expected peer and connection failures
 - preserve unexpected exceptions and backtraces through structured Async task trees
 - add explicit bang variants for callers that prefer exception-based handling
+
+## 0.51.0
+- fix Async listener and reconnect lifecycle cleanup
+- prevent teardown races when acknowledgement and proxy tasks stop concurrently
+- fix RuboCop violations
+
+## 0.51.1
+- cleanup semantic versioning handling of version strings and use canonical schema versions internally

data/Gemfile.lock

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

data/documentation/configuration.md

@@ -16,6 +16,14 @@ 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/`.
 
+## Version strings
+
+Core 3.3.0 and later use exact `MAJOR.MINOR.PATCH` version strings for both Core and SXL negotiation.
+
+Earlier Core versions retain their historical wire formats for compatibility. In particular, the Core 3.2 release may be written as either `3.2` or `3.2.0`. The library resolves both to the `3.2.0` schema internally, but a supervisor responding to a legacy Version message uses the exact Core and SXL strings sent by the site. Ambiguous versions such as `3.1` are rejected because they do not identify one of the supported 3.1.x releases.
+
+Legacy SXL strings such as `1.1` and `1.2` remain supported for connections using a Core version before 3.3.0. Their three-part equivalents are used only for internal schema lookup.
+
 ## Loading a configuration file
 
 Use the option classes to load a YAML configuration file:

data/lib/rsmp/convert/export/json_schema/index.rb

@@ -4,13 +4,12 @@ module RSMP
       # Converts SXL definitions to JSON Schema files.
       module JSONSchema
         def self.output_sxl_index(out, sxl)
+          legacy_types = legacy_types?(sxl)
           out['sxl_index.json'] = output_json({
                                                 'meta' => sxl[:meta],
-                                                'statuses' => index_items(sxl[:statuses],
-                                                                          legacy_types: legacy_types?(sxl)),
-                                                'commands' => index_items(sxl[:commands],
-                                                                          legacy_types: legacy_types?(sxl)),
-                                                'alarms' => index_items(sxl[:alarms], legacy_types: legacy_types?(sxl))
+                                                'statuses' => index_items(sxl[:statuses], legacy_types: legacy_types),
+                                                'commands' => index_items(sxl[:commands], legacy_types: legacy_types),
+                                                'alarms' => index_items(sxl[:alarms], legacy_types: legacy_types)
                                               })
         end
 

data/lib/rsmp/message.rb

@@ -202,10 +202,9 @@ module RSMP
 
   # Represents a malformed message with invalid attributes.
   class Malformed < Message
-    # rubocop:disable-next Lint/MissingSuper
     def initialize(attributes = {})
-      # don't call super, just copy (potentially invalid) attributes
-      @attributes = {}
+      super({})
+      @attributes.clear
       @invalid_attributes = attributes
     end
   end

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

@@ -81,8 +81,9 @@ module RSMP
     def check_core_versions
       version = @site_settings['core_version']
       return unless version
+      return if %w[all latest].include? version
 
-      return if RSMP::Schema.core_versions.include? version
+      return if RSMP::Schema.normalize_core_version version
 
       error_str = "Unknown core version: #{version}"
       raise RSMP::ConfigurationError, error_str

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

@@ -35,23 +35,36 @@ module RSMP
           sites.each do |site_id, settings|
             raise RSMP::ConfigurationError, "Configuration for site '#{site_id}' is empty" unless settings
 
-            sxls = settings['sxls']
-            raise RSMP::ConfigurationError, "Configuration error for site '#{site_id}': No SXLs specified" unless sxls
+            check_configured_sxls site_id, settings['sxls']
+            check_configured_core_version site_id, settings['core_version']
+          rescue RSMP::Schema::UnknownSchemaError => e
+            raise RSMP::ConfigurationError, "Configuration error for site '#{site_id}': #{e}"
+          end
+        end
 
-            sxls.each do |sxl|
-              name = sxl['name']
-              if name.to_s == 'core'
-                raise RSMP::ConfigurationError,
-                      "Configuration error for site '#{site_id}': SXL name cannot be core"
-              end
+        def check_configured_sxls(site_id, sxls)
+          raise RSMP::ConfigurationError, "Configuration error for site '#{site_id}': No SXLs specified" unless sxls
 
-              RSMP::Schema.find_schema! name, sxl['version'], lenient: true
+          sxls.each do |sxl|
+            name = sxl['name']
+            if name.to_s == 'core'
+              raise RSMP::ConfigurationError,
+                    "Configuration error for site '#{site_id}': SXL name cannot be core"
             end
-          rescue RSMP::Schema::UnknownSchemaError => e
-            raise RSMP::ConfigurationError, "Configuration error for site '#{site_id}': #{e}"
+
+            RSMP::Schema.find_schema! name, sxl['version'], lenient: true
           end
         end
 
+        def check_configured_core_version(site_id, core_version)
+          return unless core_version
+          return if %w[all latest].include? core_version
+          return if RSMP::Schema.normalize_core_version core_version
+
+          raise RSMP::ConfigurationError,
+                "Configuration error for site '#{site_id}': Unknown core version: #{core_version}"
+        end
+
         def site_id_to_site_setting(site_id)
           base = @supervisor_settings['default'] || {}
 

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

@@ -8,13 +8,23 @@ module RSMP
           version = @site_settings['core_version']
           if version == 'latest'
             [RSMP::Schema.latest_core_version]
-          elsif version
-            [version]
-          else
+          elsif version.nil? || version == 'all'
             RSMP::Schema.core_versions
+          else
+            [RSMP::Schema.normalize_core_version(version)].compact
           end
         end
 
+        # Version strings to advertise before a Core version has been selected.
+        # Include known legacy spellings so peers using exact string matching
+        # can find a common pre-3.3 version.
+        def advertised_core_versions
+          versions = core_versions.flat_map { |version| wire_core_version_aliases(version) }
+          configured = @site_settings['core_version']
+          versions.unshift configured if RSMP::Schema.normalize_core_version(configured)
+          versions.uniq
+        end
+
         def core_3_3?
           core_version && version_meets_requirement?(core_version, '>=3.3.0')
         end
@@ -29,8 +39,9 @@ module RSMP
 
         def sxl_request_items
           configured_sxls.map do |sxl|
-            item = { 'name' => sxl['name'], 'version' => sxl['version'].to_s }
-            prefix = RSMP::Schema.sxl_prefix(sxl['name'], sxl['version'], lenient: true)
+            version = RSMP::Schema.sanitize_version(sxl['version'].to_s)
+            item = { 'name' => sxl['name'], 'version' => version }
+            prefix = RSMP::Schema.sxl_prefix(sxl['name'], version)
             item['prefix'] = prefix if prefix
             item
           end
@@ -38,10 +49,14 @@ module RSMP
 
         def check_core_version(message)
           versions = core_versions
-          # find versions that both we and the client support
-          candidates = message.versions & versions
+          candidates = message.versions.filter_map do |wire_version|
+            normalized = RSMP::Schema.normalize_core_version(wire_version)
+            [wire_version, normalized] if normalized && versions.include?(normalized)
+          end
           if candidates.any?
-            @core_version = candidates.max_by { |v| Gem::Version.new(v) } # pick latest version
+            @core_version_string, @core_version = candidates.max_by do |_wire_version, normalized|
+              Gem::Version.new(normalized)
+            end
           else
             reason = "RSMP versions [#{message.versions.join(', ')}] requested, " \
                      "but only [#{versions.join(', ')}] supported."
@@ -74,10 +89,21 @@ module RSMP
                                                  'receiveAlarms' => @site_settings['receive_alarms'] != false
                                                }), validate: false
           else
-            send_version_message(site_id, core_versions, step: nil)
+            send_legacy_version_response(site_id, core_versions)
           end
         end
 
+        def send_legacy_version_response(site_id, core_versions)
+          response_versions = normalized_core_versions(core_versions).map do |version|
+            normalized = RSMP::Schema.normalize_core_version(version)
+            normalized == core_version ? core_version_string : version
+          end.uniq
+          attributes = version_message_attributes(site_id, response_versions)
+          primary = accepted_sxls.first
+          attributes['SXL'] = primary['version'].to_s if primary
+          send_message Version.new(attributes), validate: false
+        end
+
         def send_version_message(site_id, core_versions, step:)
           attributes = version_message_attributes(site_id, core_versions)
           attributes.merge!(version_request_attributes) if step == 'Request'
@@ -109,6 +135,15 @@ module RSMP
           end
         end
 
+        def wire_core_version_aliases(version)
+          normalized = RSMP::Schema.normalize_core_version(version)
+          return [version] unless normalized
+          return [normalized] if Gem::Version.new(normalized) >= Gem::Version.new('3.3.0')
+          return [normalized] unless normalized.end_with?('.0')
+
+          [normalized, normalized.delete_suffix('.0')]
+        end
+
         def site_id_items(site_id)
           [site_id].flatten.map { |id| { 'sId' => id } }
         end
@@ -124,13 +159,28 @@ module RSMP
           accepted_sxls + rejected_sxls
         end
 
+        def validate_sxl_response!(sxls)
+          invalid = sxls.find { |accepted| !valid_sxl_response?(accepted) }
+          return unless invalid
+
+          raise HandshakeError,
+                "Invalid SXL version #{invalid['name']} #{invalid['version']}; " \
+                'Core 3.3 requires an exact MAJOR.MINOR.PATCH match'
+        end
+
+        def valid_sxl_response?(accepted)
+          requested = sxl_request_items.find { |item| item['name'] == accepted['name'] }
+          RSMP::Schema.strict_version?(accepted['version']) && requested &&
+            requested['version'] == accepted['version']
+        end
+
         def version_acknowledged; end
 
         def component_list_acknowledged; end
 
         # Use Gem class to check version requirement
-        # Requirement must be a string like '1.1', '>=1.0.3' or '<2.1.4',
-        # or list of strings, like ['<=1.4','<1.5']
+        # Requirement must be a string like '1.1.0', '>=1.0.3' or '<2.1.4',
+        # or list of strings, like ['<=1.4.0','<1.5.0']
         def self.version_meets_requirement?(version, requirement)
           Gem::Requirement.new(requirement).satisfied_by?(Gem::Version.new(version))
         end

data/lib/rsmp/proxy/proxy.rb

@@ -19,7 +19,7 @@ module RSMP
     include Modules::Lifecycle
 
     attr_reader :state, :archive, :connection_info, :sxls, :accepted_sxls, :rejected_sxls,
-                :collector, :ip, :port, :node, :core_version, :sxl_interfaces,
+                :collector, :ip, :port, :node, :core_version, :core_version_string, :sxl_interfaces,
                 :site_settings, :session_id
 
     def initialize(options)
@@ -190,8 +190,8 @@ module RSMP
     end
 
     # Use Gem class to check version requirement
-    # Requirement must be a string like '1.1', '>=1.0.3' or '<2.1.4',
-    # or list of strings, like ['<=1.4','<1.5']
+    # Requirement must be a string like '1.1.0', '>=1.0.3' or '<2.1.4',
+    # or list of strings, like ['<=1.4.0','<1.5.0']
     def self.version_meets_requirement?(version, requirement)
       Modules::Versions.version_meets_requirement?(version, requirement)
     end

data/lib/rsmp/proxy/site/sxl_selection.rb

@@ -34,8 +34,13 @@ module RSMP
       configured = configured_sxls.find { |item| item['name'] == requested['name'] }
       return rejected_sxl(requested, 1, 'SXL not supported') unless configured
 
-      if configured['version'].to_s == requested['version'].to_s
-        RSMP::Schema.find_schema! requested['name'], requested['version'], lenient: true
+      unless RSMP::Schema.strict_version?(requested['version'])
+        return rejected_sxl(requested, 2, 'Core 3.3 requires SXL versions to use MAJOR.MINOR.PATCH')
+      end
+
+      configured_version = RSMP::Schema.sanitize_version(configured['version'].to_s)
+      if configured_version == requested['version']
+        RSMP::Schema.find_schema! requested['name'], requested['version']
         requested.slice('name', 'version', 'prefix')
       else
         rejected_sxl(requested, 2, "Supervisor only supports #{configured['version']}")

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

@@ -63,7 +63,7 @@ module RSMP
     end
 
     def start_handshake
-      send_version_request @site_settings['site_id'], core_versions
+      send_version_request @site_settings['site_id'], advertised_core_versions
     end
 
     def close(...)
@@ -213,6 +213,7 @@ module RSMP
     def check_sxl_version(message)
       if core_3_3?
         @rejected_sxls, @accepted_sxls = message.sxls.partition { |item| item['rejected'] }
+        validate_sxl_response! @accepted_sxls
         @receive_alarms = message.attributes.fetch('receiveAlarms', true)
       else
         primary = primary_configured_sxl

data/lib/rsmp/schema/version.rb

@@ -0,0 +1,27 @@
+module RSMP
+  # Provides JSON Schema validation for RSMP messages across core and SXL versions.
+  module Schema
+    STRICT_VERSION_PATTERN = /\A(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\z/
+    LEGACY_SHORT_VERSION_PATTERN = /\A(?:0|[1-9]\d*)\.(?:0|[1-9]\d*)\z/
+
+    # Return the schema version for a supported Core version string.
+    # Before Core 3.3, some releases used a two-part version on the wire.
+    # Only accept such a version when adding .0 identifies a known legacy
+    # schema unambiguously. Core 3.3 and later require all three parts.
+    def self.normalize_core_version(version)
+      return unless version.is_a?(String)
+      return version if core_versions.include? version
+      return unless LEGACY_SHORT_VERSION_PATTERN.match? version
+
+      normalized = "#{version}.0"
+      return unless core_versions.include? normalized
+      return unless Gem::Version.new(normalized) < Gem::Version.new('3.3.0')
+
+      normalized
+    end
+
+    def self.strict_version?(version)
+      version.is_a?(String) && STRICT_VERSION_PATTERN.match?(version)
+    end
+  end
+end

data/lib/rsmp/schema.rb

@@ -299,4 +299,5 @@ end
 
 require_relative 'schema/core_sxl_resolution'
 require_relative 'schema/message_resolution'
+require_relative 'schema/version'
 require_relative 'schema/validation'

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

@@ -64,7 +64,7 @@ module RSMP
 
         # S0091 - Operator logged in/out OP-panel
         def handle_s0091(_status_code, status_name = nil, options = {})
-          if RSMP::Proxy.version_meets_requirement?(options[:sxl_version], '>=1.1')
+          if RSMP::Proxy.version_meets_requirement?(options[:sxl_version], '>=1.1.0')
             case status_name
             when 'user'
               TrafficControllerSite.make_status 0
@@ -81,7 +81,7 @@ module RSMP
 
         # S0092 - Operator logged in/out web-interface
         def handle_s0092(_status_code, status_name = nil, options = {})
-          if RSMP::Proxy.version_meets_requirement?(options[:sxl_version], '>=1.1')
+          if RSMP::Proxy.version_meets_requirement?(options[:sxl_version], '>=1.1.0')
             case status_name
             when 'user'
               TrafficControllerSite.make_status 0

data/lib/rsmp/version.rb

@@ -1,3 +1,3 @@
 module RSMP
-  VERSION = '0.51.0'.freeze
+  VERSION = '0.51.1'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rsmp
 version: !ruby/object:Gem::Version
-  version: 0.51.0
+  version: 0.51.1
 platform: ruby
 authors:
 - Emil Tin
@@ -253,6 +253,7 @@ files:
 - lib/rsmp/schema/core_sxl_resolution.rb
 - lib/rsmp/schema/message_resolution.rb
 - lib/rsmp/schema/validation.rb
+- lib/rsmp/schema/version.rb
 - lib/rsmp/schema_error.rb
 - lib/rsmp/status_list.rb
 - lib/rsmp/sxl/interface.rb