rsmp 0.51.4 → 0.53.0

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

@@ -60,7 +60,8 @@ module RSMP
         def add_status_subscription(component_id, subs, update_list, arg, now)
           sci = arg['sCI']
           name = arg['n']
-          subcription = { interval: arg['uRt'].to_i, last_sent_at: now }
+          subcription = { interval: arg['uRt'].to_f, last_sent_at: now }
+          subcription[:on_change] = arg['sOc'] if core_3_3_0_or_newer?
           subs[sci] ||= {}
           subs[sci][name] = subcription
           update_list[component_id][sci] ||= []
@@ -70,6 +71,8 @@ module RSMP
         def process_status_subcribe(message)
           log "Received #{message.type}", message: message, level: :log
 
+          return process_core_3_3_subscription(message) if core_3_3_0_or_newer?
+
           update_list = {}
           component_id = message.attributes['cId']
           @status_subscriptions[component_id] ||= {}
@@ -84,6 +87,48 @@ module RSMP
           send_status_updates update_list
         end
 
+        def process_core_3_3_subscription(message)
+          validate_core_3_3_subscription!(message)
+          id = message.attributes['cId']
+          args = message.attributes['sS']
+          component = @site.find_component(id, build: false)
+          values = component ? fetch_status_values(component, args) : build_undefined_statuses(args)
+          subs = (@status_subscriptions[id] ||= {})
+          update_core_3_3_subscriptions(id, args, values, subs)
+          @status_subscriptions.delete(id) if subs.empty?
+          acknowledge message
+          update = core_3_3_subscription_update(id, values)
+          send_generated_message update
+          store_last_sent_status update
+        end
+
+        def core_3_3_subscription_update(id, values)
+          values = values.map { |value| value.except('uRt', 'sOc') }
+          StatusUpdate.new('cId' => id, 'sTs' => clock.to_s, 'sS' => values)
+        end
+
+        def update_core_3_3_subscriptions(id, args, values, subs)
+          updates = { id => {} }
+          values.each_with_index do |value, index|
+            arg = args[index]
+            if %w[unknown undefined].include?(value['q'])
+              remove_status_subscription(subs, arg)
+            else
+              add_status_subscription(id, subs, updates, arg, Time.now)
+            end
+          end
+        end
+
+        def validate_core_3_3_subscription!(message)
+          invalid = message.attributes['sS'].any? do |arg|
+            interval = arg['uRt'].to_f
+            interval.negative? || (interval.zero? && !arg['sOc'])
+          end
+          return unless invalid
+
+          raise MessageRejected, 'Subscription interval must be nonnegative and enable interval or sendOnChange'
+        end
+
         def get_status_subscribe_interval(component_id, sci, name)
           @status_subscriptions.dig component_id, sci, name
         end

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

@@ -22,7 +22,8 @@ module RSMP
         end
 
         def check_on_change_update(subscription, component, code, name)
-          return [nil, false] unless subscription[:interval].zero?
+          enabled = core_3_3_0_or_newer? ? subscription[:on_change] : subscription[:interval].zero?
+          return [nil, false] unless enabled
 
           current = current_status_value(component, code, name)
           last_sent = fetch_last_sent_status component.c_id, code, name
@@ -34,6 +35,10 @@ module RSMP
 
           value, quality = *(component.get_status code, name)
           rsmpify_value(value, quality)
+        rescue UnknownStatus
+          raise unless core_3_3_0_or_newer?
+
+          nil
         end
 
         def encode_status_value(code, name, value)
@@ -59,6 +64,8 @@ module RSMP
         end
 
         def status_update_timer(now)
+          return if core_3_3_0_or_newer? && connected? && !ready?
+
           send_status_updates status_updates_due(now)
         end
 
@@ -71,8 +78,15 @@ module RSMP
         end
 
         def collect_component_status_updates(update_list, component_id, by_code, now)
+          if core_3_3_0_or_newer? && !@site.components.key?(component_id)
+            @status_subscriptions.delete(component_id)
+            return
+          end
           component = @site.find_component component_id
           by_code.each_pair do |code, by_name|
+            probe = StatusUpdate.new('sS' => [{ 'sCI' => code }])
+            next if core_3_3_0_or_newer? && !sxl_message_allowed?(probe)
+
             by_name.each_pair do |name, subscription|
               current, should_send = check_status_subscription(subscription, component, code, name, now)
               next unless should_send
@@ -90,6 +104,8 @@ module RSMP
         end
 
         def precomputed_status_value(subscription, current)
+          return if core_3_3_0_or_newer? # Fetch value and quality together; do not replace quality with recent.
+
           PrecomputedStatusValue.new(current) if subscription[:interval].zero?
         end
 

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

@@ -127,11 +127,14 @@ module RSMP
           level: :info
       self.state = :ready
       start_watchdog
-      if @site_settings['send_after_connect']
-        send_all_aggregated_status
-        send_active_alarms if receive_alarms?
+      @initial_alarm_events = [] if core_3_3_0_or_newer?
+      if core_3_3_0_or_newer? || @site_settings['send_after_connect']
+        send_all_aggregated_status unless core_3_3_0_or_newer?
+        send_active_alarms if use_alarms?
       end
       flush_message_buffer
+      @initial_alarm_events = nil
+      synchronize_site_state if core_3_3_0_or_newer?
       super
     end
 
@@ -175,7 +178,7 @@ module RSMP
     def acknowledged_first_ingoing(message)
       case message.type
       when 'Watchdog'
-        if core_3_3?
+        if core_3_3_0_or_newer?
           send_component_list
         else
           handshake_complete
@@ -205,16 +208,17 @@ module RSMP
       return extraneous_version message if @version_determined
 
       check_core_version message
+      validate_version! message, step: 'Response'
       check_sxl_version message
       @site_id = Supervisor.build_id_from_ip_port @ip, @port
       version_accepted message
     end
 
     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)
+      if core_3_3_0_or_newer?
+        validate_sxl_response! message.sxls
+        @accepted_sxls, @rejected_sxls = message.sxls.partition { |item| item['status'] == 'ok' }
+        @use_alarms = message.attributes.fetch('useAlarms', true)
       else
         primary = primary_configured_sxl
         raise HandshakeError, 'Legacy Version response received, but no SXL is configured' unless primary
@@ -225,14 +229,6 @@ module RSMP
       build_sxl_interfaces
     end
 
-    def send_component_list
-      send_generated_message ComponentList.new('components' => @site.component_list)
-    end
-
-    def component_list_acknowledged
-      handshake_complete
-    end
-
     def main
       @site.main
     end

data/lib/rsmp/schema/validation.rb

@@ -24,7 +24,8 @@ module RSMP
 
     def self.validate_sxls(message, schemas, options)
       sxl_schemas = schemas.reject { |type, _version| type.to_sym == :core }
-      return [] if sxl_schemas.empty? || core_message_type?(message)
+      return [] if core_message_type?(message)
+      return [] if sxl_schemas.empty? && schema_core_version(schemas) != '3.3.0'
 
       resolved = resolve_sxl(message, schemas: schemas, **options)
       return validate_resolved_sxl(message, resolved, schemas, options) if resolved

data/lib/rsmp/version.rb

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

data/schemas/core/3.1.2/definitions.json

@@ -17,6 +17,11 @@
     "$comment" : "Example: 123 or -123",
     "pattern": "^\\-?[0-9]+$"
   },
+  "number_as_string": {
+    "description" : "Integer or decimal number as string",
+    "type": "string",
+    "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$"
+  },
   "version": {
     "description" : "Version",
     "type": "string",

data/schemas/core/3.1.2/status_subscribe.json

@@ -14,7 +14,7 @@
           "sCI" : { "$ref": "definitions.json#/status_code" },
           "n" : { "description" : "Unique reference of the value", "type" : "string" },
           "uRt" : {
-            "$ref": "definitions.json#/integer",
+            "$ref": "definitions.json#/number_as_string",
             "description" : "Update interval in seconds, 0 means send when value changes"
           }
         },

data/schemas/core/3.1.3/definitions.json

@@ -17,6 +17,11 @@
     "$comment" : "Example: 123 or -123",
     "pattern": "^\\-?[0-9]+$"
   },
+  "number_as_string": {
+    "description" : "Integer or decimal number as string",
+    "type": "string",
+    "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$"
+  },
   "version": {
     "description" : "Version",
     "type": "string",

data/schemas/core/3.1.3/status_subscribe.json

@@ -14,7 +14,7 @@
           "sCI" : { "$ref": "definitions.json#/status_code" },
           "n" : { "description" : "Unique reference of the value", "type" : "string" },
           "uRt" : {
-            "$ref": "definitions.json#/integer",
+            "$ref": "definitions.json#/number_as_string",
             "description" : "Update interval in seconds, 0 means send when value changes"
           }
         },

data/schemas/core/3.1.4/definitions.json

@@ -17,6 +17,11 @@
     "$comment" : "Example: 123 or -123",
     "pattern": "^\\-?[0-9]+$"
   },
+  "number_as_string": {
+    "description" : "Integer or decimal number as string",
+    "type": "string",
+    "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$"
+  },
   "version": {
     "description" : "Version",
     "type": "string",

data/schemas/core/3.1.4/status_subscribe.json

@@ -14,7 +14,7 @@
           "sCI" : { "$ref": "definitions.json#/status_code" },
           "n" : { "description" : "Unique reference of the value", "type" : "string" },
           "uRt" : {
-            "$ref": "definitions.json#/integer",
+            "$ref": "definitions.json#/number_as_string",
             "description" : "Update interval in seconds, 0 means send when value changes"
           }
         },

data/schemas/core/3.1.5/definitions.json

@@ -17,6 +17,11 @@
     "$comment" : "Example: 123 or -123",
     "pattern": "^\\-?[0-9]+$"
   },
+  "number_as_string": {
+    "description" : "Integer or decimal number as string",
+    "type": "string",
+    "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$"
+  },
   "version": {
     "description" : "Version",
     "type": "string",

data/schemas/core/3.1.5/status_subscribe.json

@@ -14,7 +14,7 @@
           "sCI" : { "$ref": "definitions.json#/status_code" },
           "n" : { "description" : "Unique reference of the value", "type" : "string" },
           "uRt" : {
-            "$ref": "definitions.json#/integer",
+            "$ref": "definitions.json#/number_as_string",
             "description" : "Update interval in seconds, 0 means send when value changes"
           },
           "sOc" : {

data/schemas/core/3.2.0/definitions.json

@@ -17,6 +17,11 @@
     "$comment" : "Example: 123 or -123",
     "pattern": "^\\-?[0-9]+$"
   },
+  "number_as_string": {
+    "description" : "Integer or decimal number as string",
+    "type": "string",
+    "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$"
+  },
   "version": {
     "description" : "Version",
     "type": "string",

data/schemas/core/3.2.0/status_subscribe.json

@@ -14,7 +14,7 @@
           "sCI" : { "$ref": "definitions.json#/status_code" },
           "n" : { "description" : "Unique reference of the value", "type" : "string" },
           "uRt" : {
-            "$ref": "definitions.json#/integer",
+            "$ref": "definitions.json#/number_as_string",
             "description" : "Update interval in seconds, 0 means send when value changes"
           },
           "sOc" : {

data/schemas/core/3.2.1/definitions.json

@@ -17,6 +17,11 @@
     "$comment" : "Example: 123 or -123",
     "pattern": "^\\-?[0-9]+$"
   },
+  "number_as_string": {
+    "description" : "Integer or decimal number as string",
+    "type": "string",
+    "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$"
+  },
   "version": {
     "description" : "Version",
     "type": "string",

data/schemas/core/3.2.1/status_subscribe.json

@@ -14,7 +14,7 @@
           "sCI" : { "$ref": "definitions.json#/status_code" },
           "n" : { "description" : "Unique reference of the value", "type" : "string" },
           "uRt" : {
-            "$ref": "definitions.json#/integer",
+            "$ref": "definitions.json#/number_as_string",
             "description" : "Update interval in seconds, 0 means send when value changes"
           },
           "sOc" : {

data/schemas/core/3.2.2/definitions.json

@@ -17,6 +17,11 @@
     "$comment" : "Example: 123 or -123",
     "pattern": "^\\-?[0-9]+$"
   },
+  "number_as_string": {
+    "description" : "Integer or decimal number as string",
+    "type": "string",
+    "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$"
+  },
   "version": {
     "description" : "Version",
     "type": "string",

data/schemas/core/3.2.2/status_subscribe.json

@@ -14,7 +14,7 @@
           "sCI" : { "$ref": "definitions.json#/status_code" },
           "n" : { "description" : "Unique reference of the value", "type" : "string" },
           "uRt" : {
-            "$ref": "definitions.json#/integer",
+            "$ref": "definitions.json#/number_as_string",
             "description" : "Update interval in seconds, 0 means send when value changes"
           },
           "sOc" : {

data/schemas/core/3.3.0/aggregated_status.json

@@ -1,25 +1,31 @@
 {
   "title" :  "Aggregated Status",
-  "description" :  "Aggregated status message",
+  "description" :  "Aggregated status of the site",
   "properties" : {
     "mId" : { "$ref": "definitions.json#/message_id" },
     "aSTS" : { "$ref": "definitions.json#/timestamp" },
-    "fP" : {
-      "description" : "Functional position",
-      "type" : ["string", "null"]
-    },
-    "fS" : {
-      "description" : "Functional position",
-      "type" : ["string", "null"]
-    },
+    "cId" : false,
+    "fP" : false,
+    "fS" : false,
     "se" : {
+      "description" : "State bits 1 through 8. Bits 2, 6 and 8 must be cleared in messages sent by sites.",
       "type" : "array",
       "minItems": 8,
       "maxItems": 8,
+      "prefixItems" : [
+        { "type" : "boolean" },
+        { "const" : false },
+        { "type" : "boolean" },
+        { "type" : "boolean" },
+        { "type" : "boolean" },
+        { "const" : false },
+        { "type" : "boolean" },
+        { "const" : false }
+      ],
       "items" : {
         "type" : "boolean"
       }
     }
   },
-  "required" : [ "mId", "aSTS", "fP", "fS", "se" ]
-}
+  "required" : [ "mId", "aSTS", "se" ]
+}

data/schemas/core/3.3.0/aggregated_status_request.json

@@ -1,9 +1,9 @@
 {
   "title" :  "Aggregated Status Request",
-  "description" :  "Aggregated status request message",
+  "description" :  "Request for the aggregated status of the site",
   "properties" : {
     "mId" : { "$ref": "definitions.json#/message_id" },
-    "cId" : { "$ref": "definitions.json#/component_id" }
+    "cId" : false
   },
-  "required" : [ "mId", "cId" ]
-}
+  "required" : [ "mId" ]
+}

data/schemas/core/3.3.0/component_list.json

@@ -14,7 +14,7 @@
           "type" : { "$ref": "definitions.json#/component_type" },
           "name" : { "$ref": "definitions.json#/component_name" }
         },
-        "required" : [ "id", "type", "name" ],
+        "required" : [ "id", "type" ],
         "additionalProperties" : false
       },
       "uniqueItems" : true

data/schemas/core/3.3.0/definitions.json

@@ -31,6 +31,13 @@
       { "pattern": "^\\-?[0-9]+$" }
     ]
   },
+  "number_as_string": {
+    "description" : "Integer or decimal number as string",
+    "allOf" : [
+      { "$ref" : "#/rsmp_string" },
+      { "pattern": "^-?(?:0|[1-9][0-9]*)(?:\\.[0-9]+)?$" }
+    ]
+  },
   "version": {
     "description" : "Version",
     "$comment" : "Example: 1.2.3 or 1.2",
@@ -61,9 +68,23 @@
     ]
   },
   "component_id": {
-    "description" : "Compoment id",
+    "description" : "Component ID",
     "allOf" : [
-      { "$ref" : "#/rsmp_string" }
+      { "$ref" : "#/rsmp_string" },
+      { "pattern" : "^[A-Za-z0-9_+=-]+(?:/[A-Za-z0-9_+=-]+)*$" }
+    ]
+  },
+  "component_id_selector": {
+    "description" : "Component selector",
+    "anyOf" : [
+      { "$ref" : "#/component_id" },
+      {
+        "allOf" : [
+          { "$ref" : "#/rsmp_string" },
+          { "pattern" : "^[A-Za-z0-9_+=-]+(?:/[A-Za-z0-9_+=-]+)*/$" }
+        ]
+      },
+      { "enum" : [ "/", "", null ] }
     ]
   },
   "component_type": {

data/schemas/core/3.3.0/status_subscribe.json

@@ -14,8 +14,11 @@
           "sCI" : { "$ref": "definitions.json#/status_code" },
           "n" : { "description" : "Unique reference of the value", "type" : "string" },
           "uRt" : {
-            "$ref": "definitions.json#/integer",
-            "description" : "Update interval in seconds, 0 means send when value changes"
+            "allOf" : [
+              { "$ref": "definitions.json#/number_as_string" },
+              { "not": { "pattern": "^-" } }
+            ],
+            "description" : "Nonnegative update interval in seconds; zero disables periodic updates and requires sOc to be true"
           },
           "sOc" : {
             "type": "boolean",
@@ -23,9 +26,16 @@
           }
         },
         "required" : [ "sCI", "n", "uRt", "sOc" ],
-        "additionalProperties": false
+        "additionalProperties": false,
+        "if": {
+          "properties": { "uRt": { "pattern": "^0(?:\\.0+)?$" } },
+          "required": [ "uRt" ]
+        },
+        "then": {
+          "properties": { "sOc": { "const": true } }
+        }
       }
     }
   },
   "required" : [ "mId", "cId", "sS"]
-}
+}

data/schemas/core/3.3.0/version.json

@@ -15,7 +15,10 @@
           "description" : "Supported RSMP versions"
         },
         "SXL" : {
-          "$ref": "definitions.json#/version",
+          "anyOf" : [
+            { "$ref": "definitions.json#/version" },
+            { "const": "" }
+          ],
           "description" : "Primary SXL version, for backward compatibility"
         },
         "SXLS" : {
@@ -34,7 +37,15 @@
           "uniqueItems" : true
         }
       },
-      "required" : [ "mId", "RSMP", "SXLS", "siteId" ]
+      "required" : [ "mId", "step", "RSMP", "SXLS", "siteId" ],
+      "if" : {
+        "properties" : { "SXLS" : { "maxItems" : 0 } },
+        "required" : [ "SXLS" ]
+      },
+      "then" : {
+        "properties" : { "SXL" : { "const" : "" } },
+        "required" : [ "SXL" ]
+      }
     },
     {
       "description" : "Version response",
@@ -66,9 +77,10 @@
           "minItems" : 0,
           "uniqueItems" : true
         },
-        "receiveAlarms" : {
-          "description" : "Whether the supervisor wants to receive alarms",
-          "type" : "boolean"
+        "useAlarms" : {
+          "description" : "Whether Alarm messages may be exchanged on the connection",
+          "type" : "boolean",
+          "default" : true
         }
       },
       "required" : [ "mId", "step", "RSMP", "supervisorId", "SXLS" ]
@@ -85,8 +97,7 @@
             "description" : "RSMP version"
           }
         },
-        "required" : [ "vers" ],
-        "additionalProperties" : false
+        "required" : [ "vers" ]
       },
       "minItems" : 1,
       "uniqueItems" : true
@@ -99,8 +110,7 @@
           "minLength": 1
         }
       },
-      "required" : [ "sId" ],
-      "additionalProperties" : false
+      "required" : [ "sId" ]
     },
     "sxl_request" : {
       "type" : "object",
@@ -109,34 +119,44 @@
         "version" : { "$ref" : "definitions.json#/version" },
         "prefix" : { "$ref" : "definitions.json#/sxl_prefix" }
       },
-      "required" : [ "name", "version" ],
-      "additionalProperties" : false
+      "required" : [ "name", "version" ]
     },
     "sxl_response" : {
       "type" : "object",
+      "properties" : {
+        "name" : { "$ref" : "definitions.json#/sxl_name" },
+        "status" : {
+          "type" : "string",
+          "enum" : [ "ok", "unsupported", "mismatch", "expected" ]
+        },
+        "version" : { "$ref" : "definitions.json#/version" },
+        "supported" : {
+          "type" : "array",
+          "items" : { "$ref" : "definitions.json#/version" }
+        }
+      },
+      "required" : [ "name", "status" ],
       "oneOf" : [
         {
           "properties" : {
-            "name" : { "$ref" : "definitions.json#/sxl_name" },
-            "version" : { "$ref" : "definitions.json#/version" }
+            "status" : { "const" : "ok" },
+            "supported" : false
           },
-          "required" : [ "name", "version" ],
-          "additionalProperties" : false
+          "required" : [ "version" ]
         },
         {
           "properties" : {
-            "name" : { "$ref" : "definitions.json#/sxl_name" },
-            "version" : { "$ref" : "definitions.json#/version" },
-            "rejected" : {
-              "type" : "integer",
-              "enum" : [ 1, 2, 3 ]
-            },
-            "reason" : {
-              "type" : "string"
-            }
+            "status" : { "const" : "mismatch" },
+            "version" : false
           },
-          "required" : [ "name", "rejected" ],
-          "additionalProperties" : false
+          "required" : [ "supported" ]
+        },
+        {
+          "properties" : {
+            "status" : { "enum" : [ "unsupported", "expected" ] },
+            "version" : false,
+            "supported" : false
+          }
         }
       ]
     }

data/schemas/tlc/1.0.10/defs/definitions.json

@@ -17,6 +17,11 @@
     "$comment" : "Example: 123 or -123",
     "pattern": "^\\-?[0-9]+$"
   },
+  "number_as_string": {
+    "description" : "Integer or decimal number as string",
+    "type": "string",
+    "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$"
+  },
   "version": {
     "description" : "Version",
     "type": "string",

data/schemas/tlc/1.0.13/defs/definitions.json

@@ -17,6 +17,11 @@
     "$comment" : "Example: 123 or -123",
     "pattern": "^\\-?[0-9]+$"
   },
+  "number_as_string": {
+    "description" : "Integer or decimal number as string",
+    "type": "string",
+    "pattern": "^-?[0-9]+(?:\\.[0-9]+)?$"
+  },
   "version": {
     "description" : "Version",
     "type": "string",