openc3 6.2.1 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2295b17b1ccf8843872f9bc809c460eee9a5e1c8ddf193f7169afaed5e4e561
-  data.tar.gz: 1f2fbbdeb1d81708df2ba9046ac1958ba3d254b7bb7560b5142dd2404e954e05
+  metadata.gz: 80ec07f72b5f3b98e988b0e8b4bee1b1ccf94e734f738ff33dc209249966a7e3
+  data.tar.gz: 9367191aab4bae678ef63b0db5f22bfa8a91a5518ec9e056c49c76e099744fd0
 SHA512:
-  metadata.gz: 8004c092a51faa75b6a3336affc5939fe0f45da6fb4827ef3fb729249f96cb95a8bcb54cfff606b6952dd25d2404a6f97758e3429f279b3536324408c13c06f5
-  data.tar.gz: cb6d29d2bfde3f76d4963d0b86d96aaada4d0814f71a968e05e2e59aa469e04c6ba8ab6544ad03c7eab2972267f689af17a8f03a84d889d6f38dec234d8fb437
+  metadata.gz: 7a90b63db9e9e3e085249fb2bc8ae00e0733b26c040f30a9dd23b430255228a928ffe13b2b59e8219a7c908f5e94f1f6c44932569c3b1aadf12d297b2d920a7b
+  data.tar.gz: 2b8e39ae3eee3028faf0a06719ae98c5a958c71afc989fb4da981e53dc8aa22cdcd4cb89f9d07cdbcc6e671360a9cfaab6f0b33854718aa21e731a8c01b80efc

data/Gemfile

@@ -2,12 +2,11 @@
 
 source ENV['RUBYGEMS_URL'] || "https://rubygems.org"
 
-gem 'ruby-termios', '>= 0.9' if RbConfig::CONFIG['target_os'] !~ /mswin|mingw|cygwin/i and RUBY_ENGINE == 'ruby'
-
 gemspec :name => 'openc3'
 
 # Include the rails gems for the convenience of custom microservice plugins
 gem 'bootsnap', '>= 1.9.3', require: false
 gem 'rack-cors', '~> 2.0'
-gem 'rails', '~> 7.1.0'
+gem 'rails', '~> 7.2.0'
 gem 'tzinfo-data'
+gem 'ruby-termios', '>= 1.0'

data/bin/openc3cli

@@ -50,7 +50,7 @@ $redis_url = "redis://#{ENV['OPENC3_REDIS_HOSTNAME']}:#{ENV['OPENC3_REDIS_PORT']
 
 ERROR_CODE = 1
 
-CLI_SCRIPT_ACTIONS = %w(help list run spawn)
+CLI_SCRIPT_ACTIONS = %w(help list run spawn init)
 $script_interrupt_text = ''
 trap('INT') do
   abort("Interrupted at console; exiting.#{$script_interrupt_text}")
@@ -66,6 +66,7 @@ def print_usage
   puts "  cli script spawn NAME SCOPE  variable1=value1 variable2=value2  # Starts named script remotely"
   puts "  cli script run NAME SCOPE variable1=value1 variable2=value2  # Starts named script, monitoring status on console,\
   by default until error or exit"
+  puts "  cli script init                   # initialize running scripts (Enterprise Only)"
   puts "    PARAMETERS name-value pairs to form the script's runtime environment"
   puts "    OPTIONS: --wait 0 seconds to monitor status before detaching from the running script; ie --wait 100"
   puts "             --disconnect run the script in disconnect mode"
@@ -79,7 +80,7 @@ def print_usage
   puts "  cli bridgesetup CONFIG_FILENAME   # Create a default config file"
   puts "  cli pkginstall PKGFILENAME SCOPE  # Install loaded package (Ruby gem or python package)"
   puts "  cli pkguninstall PKGFILENAME SCOPE  # Uninstall loaded package (Ruby gem or python package)"
-  puts "  cli rubysloc                      # Counts Ruby SLOC recursively. Run with --help for more info."
+  puts "  cli rubysloc                      # DEPRECATED: Please use scc (https://github.com/boyter/scc)"
   puts "  cli xtce_converter                # Convert to and from the XTCE format. Run with --help for more info."
   puts "  cli cstol_converter               # Converts CSTOL files (.prc) to COSMOS. Run with --help for more info."
   puts ""
@@ -699,6 +700,12 @@ def cli_script_spawn(disconnect=false, environment={}, args=[])
   return ret_code
 end
 
+def cli_script_init
+  require 'openc3/script'
+  initialize_offline_access()
+  return 0
+end
+
 ## cli_script(args) turns an ARGV of [spawn|run] <--wait 123...> <--disconnect> SCRIPT <scope> <ENV_A=1 ENV_B=2 ...>
 #                   into function calls and tidied parameters to remote-control a script via RunningScriptWebSocketApi
 def cli_script(args=[])
@@ -739,6 +746,8 @@ def cli_script(args=[])
     ret_code = cli_script_spawn(discon, environ, args)
   when 'run'
     ret_code = cli_script_run(discon, environ, args)
+  when 'init'
+    ret_code = cli_script_init()
   else
     abort 'openc3cli internal error: parsing arguments'
   end
@@ -756,7 +765,7 @@ if not ARGV[0].nil? # argument(s) given
 
   when 'script'
     case ARGV[1]
-    when 'list', 'run', 'spawn'
+    when 'list', 'run', 'spawn', 'init'
       cli_script(ARGV[1..-1])
     else
       # invalid actions, misplaced and malformed leading options and 'help' come here

data/data/config/widgets.yaml

@@ -34,6 +34,7 @@ Layout Widgets:
           values: .*
       example: |
         VERTICALBOX Info
+          SUBSETTING 1 RAW border "1px dashed green"
           LABEL "TEST"
           LABEL "SCREEN"
         END
@@ -64,6 +65,8 @@ Layout Widgets:
           values: .*
       example: |
         HORIZONTALBOX Info 10
+          SUBSETTING 0 RAW text-align CENTER
+          SUBSETTING 1 RAW border "1px solid blue"
           LABEL "TEST"
           LABEL "SCREEN"
         END

data/lib/openc3/api/cmd_api.rb

@@ -19,6 +19,9 @@
 #
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
+#
+# A portion of this file was funded by Blue Origin Enterprises, L.P.
+# See https://github.com/OpenC3/cosmos/pull/1963
 
 require 'openc3/api/interface_api'
 require 'openc3/models/target_model'
@@ -387,7 +390,7 @@ module OpenC3
       target_name, command_name = _extract_target_command_names('get_cmd_cnt', *args)
       authorize(permission: 'system', target_name: target_name, packet_name: command_name, manual: manual, scope: scope, token: token)
       TargetModel.packet(target_name, command_name, type: :CMD, scope: scope)
-      Topic.get_cnt("#{scope}__COMMAND__{#{target_name}}__#{command_name}")
+      return TargetModel.get_command_count(target_name, command_name, scope: scope)
     end
 
     # Get the transmit counts for command packets
@@ -399,13 +402,7 @@ module OpenC3
       unless target_commands.is_a?(Array) and target_commands[0].is_a?(Array)
         raise "get_cmd_cnts takes an array of arrays containing target, packet_name, e.g. [['INST', 'COLLECT'], ['INST', 'ABORT']]"
       end
-      counts = []
-      target_commands.each do |target_name, command_name|
-        target_name = target_name.upcase
-        command_name = command_name.upcase
-        counts << Topic.get_cnt("#{scope}__COMMAND__{#{target_name}}__#{command_name}")
-      end
-      counts
+      return TargetModel.get_command_counts(target_commands, scope: scope)
     end
 
     ###########################################################################

data/lib/openc3/api/interface_api.rb

@@ -111,15 +111,19 @@ module OpenC3
     # Get information about all interfaces
     #
     # @return [Array<Array<String, Numeric, Numeric, Numeric, Numeric, Numeric,
-    #   Numeric, Numeric>>] Array of Arrays containing \[name, state, num clients,
+    #   Numeric, Numeric, Boolean>>] Array of Arrays containing \[name, state, num clients,
     #   TX queue size, RX queue size, TX bytes, RX bytes, Command count,
-    #   Telemetry count] for all interfaces
+    #   Telemetry count, disable_disconnect] for all interfaces
     def get_all_interface_info(manual: false, scope: $openc3_scope, token: $openc3_token)
       authorize(permission: 'system', manual: manual, scope: scope, token: token)
       info = []
-      InterfaceStatusModel.all(scope: scope).each do |_int_name, int|
+      InterfaceStatusModel.all(scope: scope).each do |int_name, int|
+        # Get the interface configuration to access disable_disconnect
+        interface_model = InterfaceModel.get(name: int_name, scope: scope)
+        disable_disconnect = interface_model && interface_model['disable_disconnect'] ? true : false
+
         info << [int['name'], int['state'], int['clients'], int['txsize'], int['rxsize'],
-                 int['txbytes'], int['rxbytes'], int['txcnt'], int['rxcnt']]
+                 int['txbytes'], int['rxbytes'], int['txcnt'], int['rxcnt'], disable_disconnect]
       end
       info.sort! { |a, b| a[0] <=> b[0] }
       info

data/lib/openc3/api/tlm_api.rb

@@ -19,6 +19,12 @@
 #
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
+#
+# A portion of this file was funded by Blue Origin Enterprises, L.P.
+# See https://github.com/OpenC3/cosmos/pull/1963
+
+# A portion of this file was funded by Blue Origin Enterprises, L.P.
+# See https://github.com/OpenC3/cosmos/pull/1957
 
 require 'openc3/models/target_model'
 require 'openc3/models/cvt_model'
@@ -48,6 +54,7 @@ module OpenC3
                        'get_all_telemetry', # DEPRECATED
                        'get_all_tlm_names',
                        'get_all_telemetry_names', # DEPRECATED
+                       'get_all_tlm_item_names',
                        'get_tlm',
                        'get_telemetry', # DEPRECATED
                        'get_item',
@@ -314,6 +321,20 @@ module OpenC3
     end
     alias get_all_telemetry_names get_all_tlm_names
 
+    # Returns an array of all the item names for every packet in a target
+    #
+    # @param target_name [String] Name of the taret
+    # @return [Array<String>] Array of all telemetry item names
+    def get_all_tlm_item_names(target_name, manual: false, scope: $openc3_scope, token: $openc3_token)
+      authorize(permission: 'tlm', target_name: target_name, manual: manual, scope: scope, token: token)
+      begin
+        items = TargetModel.all_item_names(target_name, scope: scope)
+      rescue RuntimeError
+        items = []
+      end
+      return items
+    end
+
     # Returns a telemetry packet hash
     #
     # @since 5.0.0
@@ -400,7 +421,7 @@ module OpenC3
       target_name, packet_name = _extract_target_packet_names('get_tlm_cnt', *args)
       authorize(permission: 'system', target_name: target_name, packet_name: packet_name, manual: manual, scope: scope, token: token)
       TargetModel.packet(target_name, packet_name, scope: scope)
-      Topic.get_cnt("#{scope}__TELEMETRY__{#{target_name}}__#{packet_name}")
+      return TargetModel.get_telemetry_count(target_name, packet_name, scope: scope)
     end
 
     # Get the transmit counts for telemetry packets
@@ -409,13 +430,7 @@ module OpenC3
     # @return [Array<Numeric>] Receive count for the telemetry packets
     def get_tlm_cnts(target_packets, manual: false, scope: $openc3_scope, token: $openc3_token)
       authorize(permission: 'system', manual: manual, scope: scope, token: token)
-      counts = []
-      target_packets.each do |target_name, packet_name|
-        target_name = target_name.upcase
-        packet_name = packet_name.upcase
-        counts << Topic.get_cnt("#{scope}__TELEMETRY__{#{target_name}}__#{packet_name}")
-      end
-      counts
+      return TargetModel.get_telemetry_counts(target_packets, scope: scope)
     end
 
     # Get the list of derived telemetry items for a packet

data/lib/openc3/io/json_api_object.rb

@@ -57,7 +57,7 @@ module OpenC3
     # @param url [String] The url of openc3-cosmos-cmd-tlm-api http://openc3-cosmos-cmd-tlm-api:2901
     # @param timeout [Float] The time to wait before disconnecting 1.0
     # @param authentication [OpenC3Authentication] The authentication object if nill initialize will generate
-    def initialize(url: ENV['OPENC3_API_URL'], timeout: 1.0, authentication: nil)
+    def initialize(url:, timeout: 1.0, authentication: nil)
       @http = nil
       @mutex = Mutex.new
       @request_data = ""

data/lib/openc3/io/json_drb_object.rb

@@ -43,7 +43,7 @@ module OpenC3
     # @param url [String] The url of openc3-cosmos-cmd-tlm-api http://openc3-cosmos-cmd-tlm-api:2901
     # @param timeout [Float] The time to wait before disconnecting 1.0
     # @param authentication [OpenC3Authentication] The authentication object if nill initialize will generate
-    def initialize(url: ENV['OPENC3_API_URL'], timeout: 1.0, authentication: nil)
+    def initialize(url:, timeout: 1.0, authentication: nil)
       super(url: url, timeout: timeout, authentication: authentication)
       @uri = URI("#{url}/openc3-api/api")
     end

data/lib/openc3/microservices/interface_decom_common.rb

@@ -15,6 +15,9 @@
 #
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
+#
+# A portion of this file was funded by Blue Origin Enterprises, L.P.
+# See https://github.com/OpenC3/cosmos/pull/1963
 
 require 'openc3/topics/telemetry_topic'
 require 'openc3/system/system'
@@ -33,8 +36,8 @@ module OpenC3
           packet.write(name.to_s, value, type)
         end
       end
-      packet.received_count += 1
       packet.received_time = Time.now.sys
+      packet.received_count = TargetModel.increment_telemetry_count(packet.target_name, packet.packet_name, 1, scope: @scope)
       TelemetryTopic.write_packet(packet, scope: @scope)
     # If the inject_tlm parameters are bad we rescue so
     # interface_microservice and decom_microservice can continue

data/lib/openc3/microservices/interface_microservice.rb

@@ -19,6 +19,9 @@
 #
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
+#
+# A portion of this file was funded by Blue Origin Enterprises, L.P.
+# See https://github.com/OpenC3/cosmos/pull/1963
 
 require 'openc3/microservices/microservice'
 require 'openc3/microservices/interface_decom_common'
@@ -128,7 +131,7 @@ module OpenC3
                 @logger.info "#{@interface.name}: Write raw"
                 # A raw interface write results in an UNKNOWN packet
                 command = System.commands.packet('UNKNOWN', 'UNKNOWN')
-                command.received_count += 1
+                command.received_count = TargetModel.increment_command_count('UNKNOWN', 'UNKNOWN', 1, scope: @scope)
                 command = command.clone
                 command.buffer = msg_hash['raw']
                 command.received_time = Time.now
@@ -215,14 +218,15 @@ module OpenC3
                   command = System.commands.identify(cmd_buffer, @interface.cmd_target_names)
                 end
                 unless command
-                  command = System.commands.packet('UNKNOWN', 'UNKNOWN')
-                  command.received_count += 1
-                  command = command.clone
+                  command = System.commands.packet('UNKNOWN', 'UNKNOWN').clone
                   command.buffer = cmd_buffer
                 end
               else
                 raise "Invalid command received:\n #{msg_hash}"
               end
+              orig_command = System.commands.packet(command.target_name, command.packet_name)
+              orig_command.received_count = TargetModel.increment_command_count(command.target_name, command.packet_name, 1, scope: @scope)
+              command.received_count = orig_command.received_count
               command.received_time = Time.now
             rescue => e
               @logger.error "#{@interface.name}: #{msg_hash}"
@@ -504,6 +508,9 @@ module OpenC3
       end
 
       @queued = false
+      @sync_packet_count_data = {}
+      @sync_packet_count_time = nil
+      @sync_packet_count_delay_seconds = 1.0 # Sync packet counts every second
       @interface.options.each do |option_name, option_values|
         if option_name.upcase == 'OPTIMIZE_THROUGHPUT'
           @queued = true
@@ -511,6 +518,9 @@ module OpenC3
           EphemeralStoreQueued.instance.set_update_interval(update_interval)
           StoreQueued.instance.set_update_interval(update_interval)
         end
+        if option_name.upcase == 'SYNC_PACKET_COUNT_DELAY_SECONDS'
+          @sync_packet_count_delay_seconds = option_values[0].to_f
+        end
       end
 
       @interface_thread_sleeper = Sleeper.new
@@ -678,7 +688,7 @@ module OpenC3
       end
 
       # Write to stream
-      packet.received_count += 1
+      sync_tlm_packet_counts(packet)
       TelemetryTopic.write_packet(packet, queued: @queued, scope: @scope)
     end
 
@@ -812,6 +822,59 @@ module OpenC3
     def graceful_kill
       # Just to avoid warning
     end
+
+    def sync_tlm_packet_counts(packet)
+      if @sync_packet_count_delay_seconds <= 0
+        # Perfect but slow method
+        packet.received_count = TargetModel.increment_telemetry_count(packet.target_name, packet.packet_name, 1, scope: @scope)
+      else
+        # Eventually consistent method
+        # Only sync every period (default 1 second) to avoid hammering Redis
+        # This is a trade off between speed and accuracy
+        # The packet count is eventually consistent
+        @sync_packet_count_data[packet.target_name] ||= {}
+        @sync_packet_count_data[packet.target_name][packet.packet_name] ||= 0
+        @sync_packet_count_data[packet.target_name][packet.packet_name] += 1
+
+        # Ensures counters change between syncs
+        packet.received_count += 1
+
+        # Check if we need to sync the packet counts
+        if @sync_packet_count_time.nil? or (Time.now - @sync_packet_count_time) > @sync_packet_count_delay_seconds
+          @sync_packet_count_time = Time.now
+
+          inc_count = 0
+          # Use pipeline to make this one transaction
+          result = Store.redis_pool.pipelined do
+            # Increment global counters for packets received
+            @sync_packet_count_data.each do |target_name, packet_data|
+              packet_data.each do |packet_name, count|
+                TargetModel.increment_telemetry_count(target_name, packet_name, count, scope: @scope)
+                inc_count += 1
+              end
+            end
+            @sync_packet_count_data = {}
+
+            # Get all the packet counts with the global counters
+            @interface.tlm_target_names.each do |target_name|
+              TargetModel.get_all_telemetry_counts(target_name, scope: @scope)
+            end
+            TargetModel.get_all_telemetry_counts('UNKNOWN', scope: @scope)
+          end
+          @interface.tlm_target_names.each do |target_name|
+            result[inc_count].each do |packet_name, count|
+              update_packet = System.telemetry.packet(target_name, packet_name)
+              update_packet.received_count = count.to_i
+            end
+            inc_count += 1
+          end
+          result[inc_count].each do |packet_name, count|
+            update_packet = System.telemetry.packet('UNKNOWN', packet_name)
+            update_packet.received_count = count.to_i
+          end
+        end
+      end
+    end
   end
 end
 

data/lib/openc3/microservices/microservice.rb

@@ -64,6 +64,7 @@ module OpenC3
             microservice.state = 'DIED_ERROR'
             Logger.fatal("Microservice #{name} dying from exception\n#{e.formatted}")
           end
+          microservice.shutdown # Dying in crash so should try to shutdown
         ensure
           MicroserviceStatusModel.set(microservice.as_json(:allow_nan => true), scope: microservice.scope)
         end

data/lib/openc3/microservices/multi_microservice.rb

@@ -25,7 +25,7 @@ module OpenC3
     def run
       ARGV.each do |microservice_name|
         microservice_model = MicroserviceModel.get_model(name: microservice_name, scope: @scope)
-        if microservice_model.enabled
+        if microservice_model and microservice_model.enabled
           thread = Thread.new do
             cmd_line = microservice_model.cmd.join(' ')
             split_cmd_line = cmd_line.split(' ')

data/lib/openc3/migrations/20250402000000_periodic_only_default.rb

@@ -0,0 +1,24 @@
+require 'openc3/utilities/migration'
+require 'openc3/models/scope_model'
+require 'openc3/models/microservice_model'
+
+module OpenC3
+  class PeriodicOnlyDefault < Migration
+    def self.run
+      ScopeModel.get_all_models(scope: nil).each do |scope, scope_model|
+        next if scope == 'DEFAULT'
+        model = MicroserviceModel.get_model(name: "#{scope}__SCOPEMULTI__#{scope}", scope: scope)
+        if model
+          model.cmd.delete("#{scope}__PERIODIC__#{scope}")
+          model.update
+        end
+        model = MicroserviceModel.get_model(name: "#{scope}__PERIODIC__#{scope}", scope: scope)
+        model.destroy if model
+      end
+    end
+  end
+end
+
+unless ENV['OPENC3_NO_MIGRATE']
+  OpenC3::PeriodicOnlyDefault.run
+end

data/lib/openc3/models/offline_access_model.rb

@@ -19,28 +19,29 @@
 require 'openc3/models/model'
 
 module OpenC3
+  # Note: This model is locked to the DEFAULT scope
   class OfflineAccessModel < Model
-    PRIMARY_KEY = 'openc3__offline_access'
+    PRIMARY_KEY = 'DEFAULT__openc3__offline_access'
 
     attr_accessor :offline_access_token
 
     # NOTE: The following three class methods are used by the ModelController
     # and are reimplemented to enable various Model class methods to work
     def self.get(name:, scope:)
-      super("#{scope}__#{PRIMARY_KEY}", name: name)
+      super(PRIMARY_KEY, name: name)
     end
 
     def self.names(scope:)
-      super("#{scope}__#{PRIMARY_KEY}")
+      super(PRIMARY_KEY)
     end
 
     def self.all(scope:)
-      super("#{scope}__#{PRIMARY_KEY}")
+      super(PRIMARY_KEY)
     end
     # END NOTE
 
-    def initialize(name:, offline_access_token: nil, updated_at: nil, scope:)
-      super("#{scope}__#{PRIMARY_KEY}", name: name, scope: scope)
+    def initialize(name:, offline_access_token: nil, updated_at: nil, scope: 'DEFAULT')
+      super(PRIMARY_KEY, name: name, updated_at: updated_at, scope: 'DEFAULT')
       @offline_access_token = offline_access_token
     end
 

data/lib/openc3/models/scope_model.rb

@@ -350,8 +350,11 @@ module OpenC3
       # UNKNOWN PacketLog Microservice
       deploy_unknown_packetlog_microservice(gem_path, variables, @parent)
 
-      # Periodic Microservice
-      deploy_periodic_microservice(gem_path, variables, @parent)
+      # Only DEFAULT scope
+      if @scope == 'DEFAULT'
+        # Periodic Microservice
+        deploy_periodic_microservice(gem_path, variables, @parent)
+      end
 
       # Scope Cleanup Microservice
       deploy_scopecleanup_microservice(gem_path, variables, @parent)