openc3 5.20.0 → 6.0.0

data/lib/openc3/models/scope_model.rb

@@ -31,17 +31,15 @@ require 'openc3/topics/system_events_topic'
 begin
   require 'openc3-enterprise/models/cmd_authority_model'
   require 'openc3-enterprise/models/critical_cmd_model'
-rescue LoadError
   module OpenC3
-    class CmdAuthorityModel
-      def self.names(scope:)
-        []
-      end
+    class ScopeModel < Model
+      ENTERPRISE = true
     end
-    class CriticalCmdModel
-      def self.names(scope:)
-        []
-      end
+  end
+rescue LoadError
+  module OpenC3
+    class ScopeModel < Model
+      ENTERPRISE = false
     end
   end
 end
@@ -58,6 +56,7 @@ module OpenC3
     attr_accessor :cleanup_poll_time
     attr_accessor :command_authority
     attr_accessor :critical_commanding
+    attr_accessor :shard
 
     # NOTE: The following three class methods are used by the ModelController
     # and are reimplemented to enable various Model class methods to work
@@ -76,13 +75,13 @@ module OpenC3
       super(PRIMARY_KEY)
     end
 
-    def self.from_json(json)
+    def self.from_json(json, scope: nil)
       json = JSON.parse(json, :allow_nan => true, :create_additions => true) if String === json
       raise "json data is nil" if json.nil?
       self.new(**json.transform_keys(&:to_sym))
     end
 
-    def self.get_model(name:)
+    def self.get_model(name:, scope: nil)
       json = get(name: name)
       if json
         return from_json(json)
@@ -99,6 +98,7 @@ module OpenC3
       cleanup_poll_time: 900,
       command_authority: false,
       critical_commanding: "OFF",
+      shard: 0,
       updated_at: nil
     )
       super(
@@ -120,6 +120,7 @@ module OpenC3
       if not ["OFF", "NORMAL", "ALL"].include?(@critical_commanding)
         raise "Invalid value for critical_commanding: #{@critical_commanding}"
       end
+      @shard = shard.to_i # to_i to handle nil
       @children = []
     end
 
@@ -130,21 +131,23 @@ module OpenC3
       @scope = @name # Ensure @scope matches @name
       super(update: update, force: force, queued: queued)
 
-      # If we're updating the scope and disabling command_authority
-      # then we clear out all the existing values so it comes up fresh
-      if update and @command_authority == false
-        CmdAuthorityModel.names(scope: @name).each do |auth_name|
-          model = CmdAuthorityModel.get_model(name: auth_name, scope: @name)
-          model.destroy if model
+      if ENTERPRISE
+        # If we're updating the scope and disabling command_authority
+        # then we clear out all the existing values so it comes up fresh
+        if update and @command_authority == false
+          CmdAuthorityModel.names(scope: @name).each do |auth_name|
+            model = CmdAuthorityModel.get_model(name: auth_name, scope: @name)
+            model.destroy if model
+          end
         end
-      end
 
-      # If we're updating the scope and disabling critical_commanding
-      # then we clear out all the pending critical commands
-      if update and @critical_commanding == "OFF"
-        CriticalCmdModel.names(scope: @name).each do |name|
-          model = CriticalCmdModel.get_model(name: name, scope: @name)
-          model.destroy if model
+        # If we're updating the scope and disabling critical_commanding
+        # then we clear out all the pending critical commands
+        if update and @critical_commanding == "OFF"
+          CriticalCmdModel.names(scope: @name).each do |name|
+            model = CriticalCmdModel.get_model(name: name, scope: @name)
+            model.destroy if model
+          end
         end
       end
 
@@ -174,6 +177,7 @@ module OpenC3
         'cleanup_poll_time' => @cleanup_poll_time,
         'command_authority' => @command_authority,
         'critical_commanding' => @critical_commanding,
+        'shard' => @shard,
        }
     end
 
@@ -194,6 +198,7 @@ module OpenC3
         ],
         topics: topics,
         parent: parent,
+        shard: @shard,
         scope: @scope
       )
       microservice.create
@@ -216,6 +221,7 @@ module OpenC3
         topics: ["#{@scope}__COMMAND__{UNKNOWN}__UNKNOWN"],
         target_names: [],
         parent: parent,
+        shard: @shard,
         scope: @scope
       )
       microservice.create
@@ -238,6 +244,7 @@ module OpenC3
         topics: ["#{@scope}__TELEMETRY__{UNKNOWN}__UNKNOWN"],
         target_names: [],
         parent: parent,
+        shard: @shard,
         scope: @scope
       )
       microservice.create
@@ -253,6 +260,7 @@ module OpenC3
         cmd: ["ruby", "periodic_microservice.rb", microservice_name],
         work_dir: '/openc3/lib/openc3/microservices',
         parent: parent,
+        shard: @shard,
         scope: @scope
       )
       microservice.create
@@ -268,6 +276,7 @@ module OpenC3
         cmd: ["ruby", "scope_cleanup_microservice.rb", microservice_name],
         work_dir: '/openc3/lib/openc3/microservices',
         parent: parent,
+        shard: @shard,
         scope: @scope
       )
       microservice.create
@@ -281,8 +290,9 @@ module OpenC3
       microservice = MicroserviceModel.new(
         name: microservice_name,
         cmd: ["ruby", "critical_cmd_microservice.rb", microservice_name],
-        work_dir: '/openc3/lib/openc3/microservices',
+        work_dir: '/openc3-enterprise/lib/openc3-enterprise/microservices',
         parent: parent,
+        shard: @shard,
         scope: @scope
       )
       microservice.create
@@ -298,6 +308,7 @@ module OpenC3
         cmd: ["ruby", "multi_microservice.rb", *@children],
         work_dir: '/openc3/lib/openc3/microservices',
         target_names: [],
+        shard: @shard,
         scope: @scope
       )
       microservice.create
@@ -308,16 +319,18 @@ module OpenC3
     def deploy(gem_path, variables)
       seed_database()
 
-      # Create DEFAULT trigger group model
-      model = TriggerGroupModel.get(name: 'DEFAULT', scope: @scope)
-      unless model
-        model = TriggerGroupModel.new(name: 'DEFAULT', scope: @scope)
-        model.create()
-        model.deploy()
+      if ENTERPRISE
+        # Create DEFAULT trigger group model
+        model = TriggerGroupModel.get(name: 'DEFAULT', scope: @scope)
+        unless model
+          model = TriggerGroupModel.new(name: 'DEFAULT', shard: @shard, scope: @scope)
+          model.create()
+          model.deploy()
+        end
       end
 
       # Create UNKNOWN target for display of unknown data
-      model = TargetModel.new(name: "UNKNOWN", scope: @scope)
+      model = TargetModel.new(name: "UNKNOWN", shard: @shard, scope: @scope)
       model.create
 
       @parent = "#{@scope}__SCOPEMULTI__#{@scope}"
@@ -337,8 +350,10 @@ module OpenC3
       # Scope Cleanup Microservice
       deploy_scopecleanup_microservice(gem_path, variables, @parent)
 
-      # Critical Cmd Microservice
-      deploy_critical_cmd_microservice(gem_path, variables, @parent)
+      if ENTERPRISE
+        # Critical Cmd Microservice
+        deploy_critical_cmd_microservice(gem_path, variables, @parent)
+      end
 
       # Multi Microservice to parent other scope microservices
       deploy_scopemulti_microservice(gem_path, variables)
@@ -361,27 +376,30 @@ module OpenC3
       model.destroy if model
       model = MicroserviceModel.get_model(name: "#{@scope}__PERIODIC__#{@scope}", scope: @scope)
       model.destroy if model
-      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
+      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
+
+        Topic.del("#{@scope}__openc3_autonomic")
+        Topic.del("#{@scope}__TRIGGER__GROUP")
+      end
 
       # Delete the topics we created for the scope
       Topic.del("#{@scope}__COMMAND__{UNKNOWN}__UNKNOWN")
       Topic.del("#{@scope}__TELEMETRY__{UNKNOWN}__UNKNOWN")
       Topic.del("#{@scope}__openc3_targets")
       Topic.del("#{@scope}__CONFIG")
-      Topic.del("#{@scope}__openc3_autonomic")
-      Topic.del("#{@scope}__TRIGGER__GROUP")
     end
 
     def seed_database
       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: 'https://rubygems.org' }, scope: @scope) unless setting
+      SettingModel.set({ name: 'rubygems_url', data: ENV['RUBYGEMS_URL'] || 'https://rubygems.org' }, scope: @scope) unless setting
       setting = SettingModel.get(name: 'pypi_url')
-      SettingModel.set({ name: 'pypi_url', data: 'https://pypi.org' }, scope: @scope) unless setting
+      SettingModel.set({ name: 'pypi_url', data: ENV['PYPI_URL'] || 'https://pypi.org' }, scope: @scope) unless setting
     end
   end
 end

data/lib/openc3/models/target_model.rb

@@ -80,6 +80,7 @@ module OpenC3
     attr_accessor :target_microservices
     attr_accessor :children
     attr_accessor :disable_erb
+    attr_accessor :shard
 
     # NOTE: The following three class methods are used by the ModelController
     # and are reimplemented to enable various Model class methods to work
@@ -345,6 +346,7 @@ module OpenC3
       reducer_disable: false,
       reducer_max_cpu_utilization: 30.0,
       disable_erb: nil,
+      shard: 0,
       scope:
     )
       super("#{scope}__#{PRIMARY_KEY}", name: name, plugin: plugin, updated_at: updated_at,
@@ -393,6 +395,7 @@ module OpenC3
       @reducer_disable = reducer_disable
       @reducer_max_cpu_utilization = reducer_max_cpu_utilization
       @disable_erb = disable_erb
+      @shard = shard.to_i # to_i to handle nil
       @bucket = Bucket.getClient()
       @children = []
     end
@@ -433,7 +436,8 @@ module OpenC3
         'target_microservices' => @target_microservices.as_json(:allow_nan => true),
         'reducer_disable' => @reducer_disable,
         'reducer_max_cpu_utilization' => @reducer_max_cpu_utilization,
-        'disable_erb' => @disable_erb
+        'disable_erb' => @disable_erb,
+        'shard' => @shard,
       }
     end
 
@@ -548,6 +552,10 @@ module OpenC3
         if parameters
           @disable_erb.concat(parameters)
         end
+      when 'SHARD'
+        parser.verify_num_parameters(1, 1, "#{keyword} <Shard Number Starting from 0>")
+        @shard = Integer(parameters[0])
+
       else
         raise ConfigParser::Error.new(parser, "Unknown keyword and parameters for Target: #{keyword} #{parameters.join(" ")}")
       end
@@ -922,6 +930,7 @@ module OpenC3
         plugin: @plugin,
         parent: parent,
         needs_dependencies: @needs_dependencies,
+        shard: @shard,
         scope: @scope
       )
       microservice.create
@@ -948,6 +957,7 @@ module OpenC3
         plugin: @plugin,
         parent: parent,
         needs_dependencies: @needs_dependencies,
+        shard: @shard,
         scope: @scope
       )
       microservice.create
@@ -974,6 +984,7 @@ module OpenC3
         plugin: @plugin,
         parent: parent,
         needs_dependencies: @needs_dependencies,
+        shard: @shard,
         scope: @scope
       )
       microservice.create
@@ -1000,6 +1011,7 @@ module OpenC3
         plugin: @plugin,
         parent: parent,
         needs_dependencies: @needs_dependencies,
+        shard: @shard,
         scope: @scope
       )
       microservice.create
@@ -1028,6 +1040,7 @@ module OpenC3
         plugin: @plugin,
         parent: parent,
         needs_dependencies: @needs_dependencies,
+        shard: @shard,
         scope: @scope
       )
       microservice.create
@@ -1051,6 +1064,7 @@ module OpenC3
         plugin: @plugin,
         parent: parent,
         needs_dependencies: @needs_dependencies,
+        shard: @shard,
         scope: @scope
       )
       microservice.create
@@ -1067,6 +1081,7 @@ module OpenC3
         work_dir: '/openc3/lib/openc3/microservices',
         plugin: @plugin,
         parent: parent,
+        shard: @shard,
         scope: @scope
       )
       microservice.create
@@ -1084,6 +1099,7 @@ module OpenC3
           work_dir: '/openc3/lib/openc3/microservices',
           plugin: @plugin,
           needs_dependencies: @needs_dependencies,
+          shard: @shard,
           scope: @scope
         )
         microservice.create

data/lib/openc3/models/timeline_model.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -24,6 +24,7 @@ require 'openc3/models/model'
 require 'openc3/models/activity_model'
 require 'openc3/models/microservice_model'
 require 'openc3/topics/timeline_topic'
+require 'openc3/config/config_parser'
 
 module OpenC3
   class TimelineError < StandardError; end
@@ -31,6 +32,8 @@ module OpenC3
   class TimelineInputError < TimelineError; end
 
   class TimelineModel < Model
+    attr_reader :execute
+
     PRIMARY_KEY = 'openc3_timelines'.freeze # MUST be equal to ActivityModel::PRIMARY_KEY without leading __
     KEY = '__TIMELINE__'.freeze
 
@@ -74,7 +77,7 @@ module OpenC3
       self.new(**json.transform_keys(&:to_sym), name: name, scope: scope)
     end
 
-    def initialize(name:, scope:, updated_at: nil, color: nil)
+    def initialize(name:, scope:, updated_at: nil, color: nil, shard: 0, execute: true)
       if name.nil? || scope.nil?
         raise TimelineInputError.new "name or scope must not be nil"
       end
@@ -82,10 +85,12 @@ module OpenC3
       super(PRIMARY_KEY, name: "#{scope}#{KEY}#{name}", scope: scope)
       @updated_at = updated_at
       @timeline_name = name
-      update_color(color: color)
+      @shard = shard.to_i # to_i to handle nil
+      self.color = color
+      self.execute = execute
     end
 
-    def update_color(color: nil)
+    def color=(color)
       if color.nil?
         color = '#%06x' % (rand * 0xffffff)
       end
@@ -99,11 +104,17 @@ module OpenC3
       @color = color
     end
 
+    def execute=(value)
+      @execute = ConfigParser.handle_true_false(value)
+    end
+
     # @return [Hash] generated from the TimelineModel
     def as_json(*a)
       {
         'name' => @timeline_name,
         'color' => @color,
+        'execute' => @execute,
+        'shard' => @shard,
         'scope' => @scope,
         'updated_at' => @updated_at
       }
@@ -131,11 +142,12 @@ module OpenC3
         name: @name,
         folder_name: nil,
         cmd: ['ruby', 'timeline_microservice.rb', @name],
-        work_dir: '/openc3/lib/openc3/microservices',
+        work_dir: '/openc3-enterprise/lib/openc3-enterprise/microservices',
         options: [],
         topics: topics,
         target_names: [],
         plugin: nil,
+        shard: @shard,
         scope: @scope
       )
       microservice.create

data/lib/openc3/models/tool_model.rb

@@ -40,6 +40,7 @@ module OpenC3
     attr_accessor :position
     attr_accessor :needs_dependencies
     attr_accessor :disable_erb
+    attr_accessor :import_map_items
 
     # NOTE: The following three class methods are used by the ModelController
     # and are reimplemented to enable various Model class methods to work
@@ -126,7 +127,7 @@ module OpenC3
     def initialize(
       name:,
       folder_name: nil,
-      icon: '$astro-caution',
+      icon: 'astro:warning',
       url: nil,
       inline_url: nil,
       window: 'INLINE',
@@ -137,6 +138,7 @@ module OpenC3
       plugin: nil,
       needs_dependencies: false,
       disable_erb: nil,
+      import_map_items: nil,
       scope:
     )
       super("#{scope}__#{PRIMARY_KEY}", name: name, plugin: plugin, updated_at: updated_at, scope: scope)
@@ -150,11 +152,12 @@ module OpenC3
       @position = position
 
       if @shown and @window == 'INLINE'
-        @inline_url = 'js/app.js' unless @inline_url
+        @inline_url = 'main.js' unless @inline_url
         @url = "/tools/#{folder_name}" unless @url
       end
       @needs_dependencies = needs_dependencies
       @disable_erb = disable_erb
+      @import_map_items = import_map_items
     end
 
     def create(update: false, force: false, queued: false)
@@ -181,6 +184,10 @@ module OpenC3
         end
       end
 
+      if @url and !@url.start_with?('/') and !@url.start_with?('http')
+        raise "URL must be a full URL (http://domain.com/path) or a relative path (/path)"
+      end
+
       super(update: update, force: force, queued: queued)
     end
 
@@ -198,7 +205,8 @@ module OpenC3
         'updated_at' => @updated_at,
         'plugin' => @plugin,
         'needs_dependencies' => @needs_dependencies,
-        'disable_erb' => @disable_erb
+        'disable_erb' => @disable_erb,
+        'import_map_items' => @import_map_items,
       }
     end
 
@@ -232,6 +240,10 @@ module OpenC3
         if parameters
           @disable_erb.concat(parameters)
         end
+      when 'IMPORT_MAP_ITEM'
+        parser.verify_num_parameters(2, 2, "IMPORT_MAP_ITEM <key> <value>")
+        @import_map_items ||= []
+        @import_map_items << [parameters[0], parameters[1]]
       else
         raise ConfigParser::Error.new(parser, "Unknown keyword and parameters for Tool: #{keyword} #{parameters.join(" ")}")
       end

data/lib/openc3/models/trigger_group_model.rb

@@ -64,9 +64,9 @@ module OpenC3
       end
     end
 
-    attr_reader :name, :scope, :updated_at
+    attr_reader :name, :scope, :shard, :updated_at
 
-    def initialize(name:, scope:, updated_at: nil)
+    def initialize(name:, scope:, shard: 0, updated_at: nil)
       unless name.is_a?(String)
         raise TriggerGroupInputError.new "invalid group name: '#{name}'"
       end
@@ -75,6 +75,7 @@ module OpenC3
       end
       super("#{scope}#{PRIMARY_KEY}", name: name, scope: scope)
       @microservice_name = "#{scope}__TRIGGER_GROUP__#{name}"
+      @shard = shard.to_i # to_i to handle nil
       @updated_at = updated_at
     end
 
@@ -93,6 +94,7 @@ module OpenC3
       return {
         'name' => @name,
         'scope' => @scope,
+        'shard' => @shard,
         'updated_at' => @updated_at,
       }
     end
@@ -122,11 +124,12 @@ module OpenC3
         name: @microservice_name,
         folder_name: nil,
         cmd: ['ruby', "trigger_group_microservice.rb", @microservice_name],
-        work_dir: '/openc3/lib/openc3/microservices',
+        work_dir: '/openc3-enterprise/lib/openc3-enterprise/microservices',
         options: [],
         topics: topics,
         target_names: [],
         plugin: nil,
+        shard: @shard,
         scope: @scope
       )
       microservice.create

data/lib/openc3/operators/microservice_operator.rb

@@ -42,6 +42,8 @@ module OpenC3
       @new_microservices = {}
       @changed_microservices = {}
       @removed_microservices = {}
+      @shard = ENV['OPENC3_SHARD'] || 0
+      @shard = @shard.to_i
     end
 
     def convert_microservice_to_process_definition(microservice_name, microservice_config)
@@ -87,6 +89,12 @@ module OpenC3
       # Get all the microservice configuration
       @microservices = MicroserviceModel.all
 
+      # Filter to just this shard
+      @microservices = @microservices.select do |microservice_name, microservice_config|
+        microservice_shard = microservice_config['shard'] || 0
+        microservice_shard == @shard
+      end
+
       # Detect new and changed microservices
       @new_microservices = {}
       @changed_microservices = {}

data/lib/openc3/packets/commands.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -308,12 +308,23 @@ module OpenC3
         item = command.get_item(item_upcase)
         range_check_value = value
 
-        # Convert from state to value if possible
-        if item.states and item.states[value.to_s.upcase]
-          range_check_value = item.states[value.to_s.upcase]
-        end
-
         if range_checking
+          if item.states
+            if item.states[value.to_s.upcase]
+              range_check_value = item.states[value.to_s.upcase]
+            else
+              unless item.states.values.include?(value)
+                if command.raw
+                  # Raw commands report missing value maps
+                  raise "Command parameter '#{command.target_name} #{command.packet_name} #{item_upcase}' = #{value.to_s.upcase} not one of #{item.states.values.join(', ')}"
+                else
+                  # Normal commands report missing state maps
+                  raise "Command parameter '#{command.target_name} #{command.packet_name} #{item_upcase}' = #{value.to_s.upcase} not one of #{item.states.keys.join(', ')}"
+                end
+              end
+            end
+          end
+
           range = item.range
           if range
             # Perform Range Check on command parameter

data/lib/openc3/packets/limits.rb

@@ -50,18 +50,6 @@ module OpenC3
       return @config.limits_sets
     end
 
-    # (see OpenC3::Packet#out_of_limits)
-    def out_of_limits
-      items = []
-      @config.telemetry.each do |target_name, target_packets|
-        target_packets.each do |packet_name, packet|
-          new_items = packet.out_of_limits
-          items.concat(new_items)
-        end
-      end
-      return items
-    end
-
     # @return [Hash(String, Array)] The defined limits groups
     def groups
       return @config.limits_groups

data/lib/openc3/packets/packet.rb

@@ -756,7 +756,7 @@ module OpenC3
           super(item, value, :RAW, buffer)
         rescue ArgumentError => e
           if item.states and String === value and e.message =~ /invalid value for/
-            raise "Unknown state #{value} for #{item.name}"
+            raise "Unknown state #{value} for #{item.name}, must be one of #{item.states.keys.join(', ')}"
           else
             raise e
           end