openc3 7.2.1 → 7.4.0

data/lib/openc3/models/scope_model.rb

@@ -17,11 +17,13 @@
 
 require "openc3/version"
 require "openc3/models/model"
+require "openc3/models/bridge_model"
 require "openc3/models/plugin_model"
 require "openc3/models/microservice_model"
 require "openc3/models/setting_model"
 require "openc3/models/trigger_group_model"
 require "openc3/topics/system_events_topic"
+require "openc3/utilities/rubygems_url"
 
 begin
   require "openc3-enterprise/models/cmd_authority_model"
@@ -43,6 +45,38 @@ module OpenC3
   class ScopeModel < Model
     PRIMARY_KEY = "openc3_scopes"
 
+    # Default thresholds used by the System Health tool and the metrics
+    # microservices. Stored in the 'system_health' setting as a JSON string.
+    SYSTEM_HEALTH_DEFAULTS = {
+      "cpu" => {
+        "redThreshold" => 90.0,
+        "yellowThreshold" => 80.0,
+        "snoozeMinutes" => 15,
+        "lastTriggerTimeRed" => nil,  # timestamp or nil
+        "lastTriggerTimeYellow" => nil,  # timestamp or nil
+        "sustainedSeconds" => 15
+      },
+      "memory" => {
+        "redThreshold" => 90.0,
+        "yellowThreshold" => 80.0,
+        "snoozeMinutes" => 15,
+        "lastTriggerTimeRed" => nil,  # timestamp or nil
+        "lastTriggerTimeYellow" => nil,  # timestamp or nil
+        "sustainedSeconds" => 15
+      },
+      "disk" => {
+        "redThreshold" => 90.0,
+        "yellowThreshold" => 80.0,
+        "snoozeMinutes" => 720,  # 12 hours
+        "lastTriggerTimeRed" => nil,  # timestamp or nil
+        "lastTriggerTimeYellow" => nil,  # timestamp or nil
+        "sustainedSeconds" => 60
+      },
+      "global" => {
+        "enableAlerts" => true
+      }
+    }
+
     attr_accessor :children
     attr_accessor :text_log_cycle_time
     attr_accessor :text_log_cycle_size
@@ -58,25 +92,25 @@ module OpenC3
     #
     # The scope keyword is given to support the ModelController method signature
     # even though it is not used
-    def self.get(name:, scope: nil)
+    def self.get(name:, scope: nil) # NOSONAR - scope: is part of the caller-facing signature
       super(PRIMARY_KEY, name: name)
     end
 
-    def self.names(scope: nil)
+    def self.names(scope: nil) # NOSONAR - scope: is part of the caller-facing signature
       super(PRIMARY_KEY)
     end
 
-    def self.all(scope: nil)
+    def self.all(scope: nil) # NOSONAR - scope: is part of the caller-facing signature
       super(PRIMARY_KEY)
     end
 
-    def self.from_json(json, scope: nil)
+    def self.from_json(json, scope: nil) # NOSONAR - scope: is part of the caller-facing signature
       json = JSON.parse(json, allow_nan: true, create_additions: true) if String === json
       raise "json data is nil" if json.nil?
       new(**json.transform_keys(&:to_sym))
     end
 
-    def self.get_model(name:, scope: nil)
+    def self.get_model(name:, scope: nil) # NOSONAR - scope: is part of the caller-facing signature
       json = get(name: name)
       if json
         from_json(json)
@@ -111,7 +145,7 @@ module OpenC3
       @command_authority = command_authority
       @critical_commanding = critical_commanding.to_s.upcase
       @critical_commanding = "OFF" if @critical_commanding.length == 0
-      if !["OFF", "NORMAL", "ALL"].include?(@critical_commanding)
+      unless ["OFF", "NORMAL", "ALL"].include?(@critical_commanding)
         raise "Invalid value for critical_commanding: #{@critical_commanding}"
       end
       @shard = shard.to_i # to_i to handle nil
@@ -121,6 +155,8 @@ module OpenC3
     def create(update: false, force: false, queued: false)
       # Ensure there are no "." in the scope name - prevents gems accidentally becoming scope names
       raise "Invalid scope name: #{@name}" if !/^[a-zA-Z0-9_-]+$/.match?(@name)
+      # Double underscore is the COSMOS separator used to build microservice and topic names
+      raise "Invalid scope name: #{@name} (double underscore not allowed)" if @name.include?("__")
       @name = @name.upcase
       @scope = @name # Ensure @scope matches @name
       # Ensure the various cycle and retain times are integers
@@ -180,6 +216,24 @@ module OpenC3
        "shard" => @shard}
     end
 
+    # Every scope gets a DEFAULT bridge_microservice: the Iroh hub that lets
+    # openc3-app run COSMOS interfaces on the host. It idles (no data streams,
+    # no enrolled app) until an interface is bridged / openc3-app enrolls.
+    #
+    # It is a top-level microservice (spawned directly by the operator), NOT a
+    # child of SCOPEMULTI: that runs its Ruby children in-process, and the bridge
+    # is Python.
+    def deploy_bridge_microservice(gem_path, variables)
+      microservice = BridgeModel.build_microservice(
+        bridge_name: "DEFAULT",
+        scope: @scope,
+        shard: @shard
+      )
+      microservice.create
+      microservice.deploy(gem_path, variables)
+      Logger.info "Configured microservice #{microservice.name}"
+    end
+
     def deploy_openc3_log_messages_microservice(gem_path, variables, parent)
       microservice_name = "#{@scope}__OPENC3__LOG"
       topics = ["#{@scope}__openc3_log_messages"]
@@ -357,6 +411,9 @@ module OpenC3
         deploy_critical_cmd_microservice(gem_path, variables, @parent)
       end
 
+      # DEFAULT bridge_microservice (Iroh hub for host interfaces)
+      deploy_bridge_microservice(gem_path, variables)
+
       # Multi Microservice to parent other scope microservices
       deploy_scopemulti_microservice(gem_path, variables)
     end
@@ -366,24 +423,20 @@ module OpenC3
       target = TargetModel.get_model(name: "UNKNOWN", scope: @scope)
       target.destroy
 
-      model = MicroserviceModel.get_model(name: "#{@scope}__SCOPEMULTI__#{@scope}", scope: @scope)
-      model.destroy if model
-      model = MicroserviceModel.get_model(name: "#{@scope}__SCOPECLEANUP__#{@scope}", scope: @scope)
-      model.destroy if model
-      model = MicroserviceModel.get_model(name: "#{@scope}__OPENC3__LOG", scope: @scope)
-      model.destroy if model
-      model = MicroserviceModel.get_model(name: "#{@scope}__COMMANDLOG__UNKNOWN", scope: @scope)
-      model.destroy if model
-      model = MicroserviceModel.get_model(name: "#{@scope}__PACKETLOG__UNKNOWN", scope: @scope)
-      model.destroy if model
-      model = MicroserviceModel.get_model(name: "#{@scope}__PERIODIC__#{@scope}", scope: @scope)
-      model.destroy if model
-      if ENTERPRISE
-        model = MicroserviceModel.get_model(name: "#{@scope}__TRIGGER_GROUP__DEFAULT", scope: @scope)
-        model.destroy if model
-        model = MicroserviceModel.get_model(name: "#{@scope}__CRITICALCMD__#{@scope}", scope: @scope)
-        model.destroy if model
+      # Destroy all microservices in this scope
+      microservices = MicroserviceModel.get_all_models(scope: @name)
+      microservices.each do |_microservice_name, microservice|
+        microservice.destroy
+      end
 
+      # Destroy all bridges in this scope
+      bridges = BridgeModel.get_all_models(scope: @name)
+      bridges.each do |_bridge_name, bridge|
+        bridge.destroy
+      end
+
+      # Cleanup Topics
+      if ENTERPRISE
         Topic.del("#{@scope}__openc3_autonomic")
         Topic.del("#{@scope}__TRIGGER__GROUP")
       end
@@ -400,43 +453,19 @@ module OpenC3
       setting = SettingModel.get(name: "source_url")
       SettingModel.set({name: "source_url", data: "https://github.com/OpenC3/cosmos"}, scope: @scope) unless setting
       setting = SettingModel.get(name: "rubygems_url")
-      SettingModel.set({name: "rubygems_url", data: ENV["RUBYGEMS_URL"] || "https://rubygems.org"}, scope: @scope) unless setting
+      SettingModel.set({name: "rubygems_url", data: ENV["RUBYGEMS_URL"] || RubygemsUrl::DEFAULT}, scope: @scope) unless setting
       setting = SettingModel.get(name: "pypi_url")
       SettingModel.set({name: "pypi_url", data: ENV["PYPI_URL"] || "https://pypi.org"}, scope: @scope) unless setting
-      # Set the news feed to true by default, don't bother checking if it's already set
-      SettingModel.set({name: "news_feed", data: true}, scope: @scope)
+      # Default the news feed on, but only if nothing has set it yet. `openc3cli
+      # initsettings` runs before the first plugin load creates this scope, so an
+      # unconditional set here would discard OPENC3_SETTING_NEWS_FEED=false and
+      # leave the seeded provenance record disagreeing with Redis forever.
+      setting = SettingModel.get(name: "news_feed")
+      SettingModel.set({name: "news_feed", data: true}, scope: @scope) unless setting
 
       setting = SettingModel.get(name: "system_health")
-      system_health_data = {
-        "cpu" => {
-          "redThreshold" => 90.0,
-          "yellowThreshold" => 80.0,
-          "snoozeMinutes" => 15,
-          "lastTriggerTimeRed" => nil,  # timestamp or nil
-          "lastTriggerTimeYellow" => nil,  # timestamp or nil
-          "sustainedSeconds" => 15
-        },
-        "memory" => {
-          "redThreshold" => 90.0,
-          "yellowThreshold" => 80.0,
-          "snoozeMinutes" => 15,
-          "lastTriggerTimeRed" => nil,  # timestamp or nil
-          "lastTriggerTimeYellow" => nil,  # timestamp or nil
-          "sustainedSeconds" => 15
-        },
-        "disk" => {
-          "redThreshold" => 90.0,
-          "yellowThreshold" => 80.0,
-          "snoozeMinutes" => 720,  # 12 hours
-          "lastTriggerTimeRed" => nil,  # timestamp or nil
-          "lastTriggerTimeYellow" => nil,  # timestamp or nil
-          "sustainedSeconds" => 60
-        },
-        "global" => {
-          "enableAlerts" => true
-        }
-      }
-      SettingModel.set({name: "system_health", data: system_health_data}, scope: "DEFAULT") unless setting
+      # Settings are stored as JSON strings
+      SettingModel.set({name: "system_health", data: JSON.generate(SYSTEM_HEALTH_DEFAULTS)}, scope: "DEFAULT") unless setting
     end
   end
 end