openc3 5.14.2 → 5.15.1

data/lib/openc3/top_level.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
@@ -22,7 +22,6 @@
 
 # This file contains top level functions in the OpenC3 namespace
 
-require 'thread'
 require 'digest'
 require 'open3'
 require 'openc3/core_ext'
@@ -50,6 +49,16 @@ class HazardousError < StandardError
   end
 end
 
+# If a disabled command is sent through the {OpenC3::Api} this error is raised.
+class DisabledError < StandardError
+  attr_accessor :target_name
+  attr_accessor :cmd_name
+
+  def to_s
+    "#{target_name} #{cmd_name} is Disabled"
+  end
+end
+
 # OpenC3 is almost
 # wholly contained within the OpenC3 module. OpenC3 also extends some of the
 # core Ruby classes to add additional functionality.
@@ -102,18 +111,18 @@ module OpenC3
       file.write(OPENC3_MARSHAL_HEADER)
       file.write(Marshal.dump(obj))
     end
-  rescue Exception => exception
+  rescue Exception => e
     begin
       File.delete(marshal_filename)
     rescue Exception
       # Oh well - we tried
     end
-    if exception.class == TypeError and exception.message =~ /Thread::Mutex/
-      original_backtrace = exception.backtrace
-      exception = exception.exception("Mutex exists in a packet.  Note: Packets must not be read during class initializers for Conversions, Limits Responses, etc.: #{exception}")
-      exception.set_backtrace(original_backtrace)
+    if e.class == TypeError and e.message =~ /Thread::Mutex/
+      original_backtrace = e.backtrace
+      e = e.exception("Mutex exists in a packet.  Note: Packets must not be read during class initializers for Conversions, Limits Responses, etc.: #{e}")
+      e.set_backtrace(original_backtrace)
     end
-    self.handle_fatal_exception(exception)
+    self.handle_fatal_exception(e)
   end
 
   # Loads the marshal file back into a Ruby object
@@ -132,9 +141,9 @@ module OpenC3
       Logger.warn "Marshal load failed with invalid marshal file: #{marshal_filename}"
       return nil
     end
-  rescue Exception => exception
+  rescue Exception => e
     if File.exist?(marshal_filename)
-      Logger.error "Marshal load failed with exception: #{marshal_filename}\n#{exception.formatted}"
+      Logger.error "Marshal load failed with exception: #{marshal_filename}\n#{e.formatted}"
     else
       Logger.info "Marshal file does not exist: #{marshal_filename}"
     end
@@ -145,7 +154,7 @@ module OpenC3
     rescue Exception
       # Oh well - we tried
     end
-    self.handle_fatal_exception(exception) if File.exist?(marshal_filename)
+    self.handle_fatal_exception(e) if File.exist?(marshal_filename)
     return nil
   end
 
@@ -354,7 +363,7 @@ module OpenC3
   #
   # @param error [Exception] The exception to handle
   # @param try_gui [Boolean] Whether to try and create a GUI exception popup
-  def self.handle_fatal_exception(error, try_gui = true)
+  def self.handle_fatal_exception(error, _try_gui = true)
     unless SystemExit === error or SignalException === error
       $openc3_fatal_exception = error
       self.write_exception_file(error)
@@ -380,7 +389,7 @@ module OpenC3
   #
   # @param error [Exception] The exception to handle
   # @param try_gui [Boolean] Whether to try and create a GUI exception popup
-  def self.handle_critical_exception(error, try_gui = true)
+  def self.handle_critical_exception(error, _try_gui = true)
     Logger.error "Critical Exception! #{error.formatted}"
     self.write_exception_file(error)
   end
@@ -397,15 +406,15 @@ module OpenC3
       retry_count = 0
       begin
         yield
-      rescue => error
+      rescue => e
         Logger.error "#{name} thread unexpectedly died. Retries: #{retry_count} of #{retry_attempts}"
-        Logger.error error.formatted
+        Logger.error e.formatted
         retry_count += 1
         if retry_count <= retry_attempts
-          self.write_exception_file(error)
+          self.write_exception_file(e)
           retry
         end
-        handle_fatal_exception(error)
+        handle_fatal_exception(e)
       end
     end
   end
@@ -440,15 +449,15 @@ module OpenC3
   # @param log_error [Boolean] Whether to log an error if we can't require the class
   def self.require_file(filename, log_error = true)
     require filename
-  rescue Exception => err
-    msg = "Unable to require #{filename} due to #{err.message}. "\
+  rescue Exception => e
+    msg = "Unable to require #{filename} due to #{e.message}. "\
           "Ensure #{filename} is in the OpenC3 lib directory."
     Logger.error msg if log_error
     raise $!, msg, $!.backtrace
   end
 
   # @param filename [String] Name of the file to open in the web browser
-  def self.open_in_web_browser(filename)
+  def self.open_in_web_browser(_filename)
     puts "open_in_web_browser is DEPRECATED"
   end
 
@@ -456,12 +465,12 @@ module OpenC3
   # Working directory is global, so this can make other threads wait
   # Ruby Dir.chdir with block always throws an error if multiple threads
   # call Dir.chdir
-  def self.set_working_dir(working_dir, &block)
+  def self.set_working_dir(working_dir, &)
     if $openc3_chdir_mutex.owned?
-      set_working_dir_internal(working_dir, &block)
+      set_working_dir_internal(working_dir, &)
     else
       $openc3_chdir_mutex.synchronize do
-        set_working_dir_internal(working_dir, &block)
+        set_working_dir_internal(working_dir, &)
       end
     end
   end

data/lib/openc3/topics/command_decom_topic.rb

@@ -21,6 +21,7 @@
 # if purchased from OpenC3, Inc.
 
 require 'openc3/topics/topic'
+require 'openc3/utilities/store_queued'
 
 module OpenC3
   class CommandDecomTopic < Topic
@@ -39,7 +40,7 @@ module OpenC3
         json_hash[item.name + "__U"] = packet.read_item(item, :WITH_UNITS) if item.units
       end
       msg_hash['json_data'] = JSON.generate(json_hash.as_json(:allow_nan => true))
-      Topic.write_topic(topic, msg_hash)
+      EphemeralStoreQueued.write_topic(topic, msg_hash)
     end
 
     def self.get_cmd_item(target_name, packet_name, param_name, type: :WITH_UNITS, scope: $openc3_scope)

data/lib/openc3/topics/command_topic.rb

@@ -21,6 +21,7 @@
 # if purchased from OpenC3, Inc.
 
 require 'openc3/topics/topic'
+require 'openc3/utilities/store_queued'
 require 'openc3/utilities/open_telemetry'
 
 module OpenC3
@@ -36,7 +37,7 @@ module OpenC3
                    received_count: packet.received_count,
                    stored: packet.stored.to_s,
                    buffer: packet.buffer(false) }
-      Topic.write_topic(topic, msg_hash)
+      EphemeralStoreQueued.write_topic(topic, msg_hash)
     end
 
     # @param command [Hash] Command hash structure read to be written to a topic

data/lib/openc3/topics/telemetry_topic.rb

@@ -21,10 +21,11 @@
 # if purchased from OpenC3, Inc.
 
 require 'openc3/topics/topic'
+require 'openc3/utilities/store_queued'
 
 module OpenC3
   class TelemetryTopic < Topic
-    def self.write_packet(packet, scope:)
+    def self.write_packet(packet, queued: false, scope:)
       msg_hash = {
         :time => packet.packet_time.to_nsec_from_epoch,
         :received_time => packet.received_time.to_nsec_from_epoch,
@@ -35,7 +36,11 @@ module OpenC3
         :buffer => packet.buffer(false)
       }
       msg_hash[:extra] = JSON.generate(packet.extra.as_json, allow_nan: true) if packet.extra
-      Topic.write_topic("#{scope}__TELEMETRY__{#{packet.target_name}}__#{packet.packet_name}", msg_hash)
+      if queued
+        EphemeralStoreQueued.write_topic("#{scope}__TELEMETRY__{#{packet.target_name}}__#{packet.packet_name}", msg_hash)
+      else
+        Topic.write_topic("#{scope}__TELEMETRY__{#{packet.target_name}}__#{packet.packet_name}", msg_hash)
+      end
     end
   end
 end

data/lib/openc3/utilities/authorization.rb

@@ -42,7 +42,7 @@ rescue LoadError
 
         if $openc3_authorize
           raise AuthError.new("Token is required") unless token
-          unless OpenC3::AuthModel.verify(token, permission: permission)
+          unless OpenC3::AuthModel.verify(token)
             raise AuthError.new("Password is invalid for '#{permission}' permission")
           end
         end

data/lib/openc3/utilities/aws_bucket.rb

@@ -26,7 +26,9 @@ module OpenC3
     CREATE_CHECK_COUNT = 100 # 10 seconds
 
     def initialize
+      super()
       @client = Aws::S3::Client.new
+      @aws_arn = ENV['OPENC3_AWS_ARN_PREFIX'] || 'arn:aws'
     end
 
     def create(bucket)
@@ -59,7 +61,7 @@ module OpenC3
                 ]
               },
               "Resource": [
-                "arn:aws:s3:::#{bucket}"
+                "#{@aws_arn}:s3:::#{bucket}"
               ],
               "Sid": ""
             },
@@ -74,7 +76,7 @@ module OpenC3
                 ]
               },
               "Resource": [
-                "arn:aws:s3:::#{bucket}/*"
+                "#{@aws_arn}:s3:::#{bucket}/*"
               ],
               "Sid": ""
             }
@@ -198,19 +200,23 @@ module OpenC3
     end
 
     # @returns [Boolean] Whether the file exists
-    def check_object(bucket:, key:)
-      @client.wait_until(:object_exists,
-        {
-          bucket: bucket,
-          key: key
-        },
-        {
-          max_attempts: 30,
-          delay: 0.1, # seconds
-        }
-      )
-      true
-    rescue Aws::Waiters::Errors::TooManyAttemptsError
+    def check_object(bucket:, key:, retries: true)
+      if retries
+        @client.wait_until(:object_exists,
+          {
+            bucket: bucket,
+            key: key
+          },
+          {
+            max_attempts: 30,
+            delay: 0.1, # seconds
+          }
+        )
+        true
+      else
+        head_object(bucket: bucket, key: key)
+      end
+    rescue NotFound, Aws::Waiters::Errors::TooManyAttemptsError
       false
     end
 

data/lib/openc3/utilities/bucket.rb

@@ -69,7 +69,7 @@ module OpenC3
       raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
     end
 
-    def check_object(bucket:, key:)
+    def check_object(bucket:, key:, retries: true)
       raise NotImplementedError, "#{self.class} has not implemented method '#{__method__}'"
     end
 

data/lib/openc3/utilities/logger.rb

@@ -22,7 +22,7 @@
 
 require 'openc3/core_ext/class'
 require 'openc3/core_ext/time'
-require 'openc3/topics/topic'
+require 'openc3/utilities/store_queued'
 require 'socket'
 require 'logger'
 require 'time'
@@ -206,9 +206,9 @@ module OpenC3
         end
         unless @no_store
           if scope
-            Topic.write_topic("#{scope}__openc3_log_messages", data)
+            EphemeralStoreQueued.write_topic("#{scope}__openc3_log_messages", data)
           else
-            Topic.write_topic("NOSCOPE__openc3_log_messages", data)
+            EphemeralStoreQueued.write_topic("NOSCOPE__openc3_log_messages", data)
           end
         end
       end

data/lib/openc3/utilities/process_manager.rb

@@ -68,9 +68,9 @@ module OpenC3
       @monitor_thread = Thread.new do
         begin
           monitor()
-        rescue => err
-          Logger.error("ProcessManager unexpectedly died\n#{err.formatted}", scope: 'DEFAULT')
-          raise "ProcessManager unexpectedly died\n#{err.formatted}"
+        rescue => e
+          Logger.error("ProcessManager unexpectedly died\n#{e.formatted}", scope: 'DEFAULT')
+          raise "ProcessManager unexpectedly died\n#{e.formatted}"
         end
       end
     end
@@ -96,7 +96,9 @@ module OpenC3
             process.status.output = output
             if process.exit_code != 0
               process.status.state = "Crashed"
-            elsif output.include?('"level":"ERROR"') || output.include?('"level":"WARN"')
+            elsif output.include?('"level":"ERROR"')
+              process.status.state = "Error"
+            elsif output.include?('"level":"WARN"')
               process.status.state = "Warning"
             else
               process.status.state = "Complete"
@@ -115,11 +117,15 @@ module OpenC3
           process.status.update
         end
         processes_to_delete.each do |process|
-          if process.status.state == "Complete"
-            Logger.info("Process #{process.status.name}:#{process.process_type}:#{process.detail} completed with state #{process.status.state}", scope: process.scope)
+          message = "Process #{process.status.name}:#{process.process_type}:#{process.detail} completed with state #{process.status.state}\nProcess Output:\n#{process.status.output}"
+          if process.status.state != "Complete"
+            if process.status.state == "Warning"
+              Logger.warn(message, scope: process.scope)
+            else
+              Logger.error(message, scope: process.scope)
+            end
           else
-            Logger.error("Process #{process.status.name}:#{process.process_type}:#{process.detail} completed with state #{process.status.state}", scope: process.scope)
-            Logger.error("Process Output:\n#{process.status.output}", scope: process.scope)
+            Logger.info(message, scope: process.scope)
           end
 
           @processes.delete(process)
@@ -131,7 +137,7 @@ module OpenC3
           scopes = ScopeModel.names
           scopes.each do |scope|
             statuses = ProcessStatusModel.get_all_models(scope: scope)
-            statuses.each do |status_name, status|
+            statuses.each do |_status_name, status|
               if (current_time - Time.from_nsec_from_epoch(status.updated_at)) > CLEANUP_CYCLE_SECONDS
                 status.destroy
               end

data/lib/openc3/utilities/store_autoload.rb

@@ -21,6 +21,7 @@
 # if purchased from OpenC3, Inc.
 
 require 'redis'
+require "hiredis-client"
 require 'json'
 require 'connection_pool'
 
@@ -32,6 +33,36 @@ else
 end
 
 module OpenC3
+  class StoreConnectionPool < ConnectionPool
+    NO_OPTIONS = {}
+
+    def pipelined
+      if $openc3_redis_cluster
+        yield # TODO: Update keys to support pipelining in cluster
+      else
+        with(NO_OPTIONS) do |redis|
+          redis.pipelined do |pipeline|
+            Thread.current[:pipeline] = pipeline
+            begin
+              yield
+            ensure
+              Thread.current[:pipeline] = nil
+            end
+          end
+        end
+      end
+    end
+
+    def with(options = NO_OPTIONS, &block)
+      pipeline = Thread.current[:pipeline]
+      if pipeline
+        yield pipeline
+      else
+        super(options, &block)
+      end
+    end
+  end
+
   class Store
     # Variable that holds the singleton instance
     @instance = nil
@@ -67,7 +98,7 @@ module OpenC3
       @redis_username = ENV['OPENC3_REDIS_USERNAME']
       @redis_key = ENV['OPENC3_REDIS_PASSWORD']
       @redis_url = "redis://#{ENV['OPENC3_REDIS_HOSTNAME']}:#{ENV['OPENC3_REDIS_PORT']}"
-      @redis_pool = ConnectionPool.new(size: pool_size) { build_redis() }
+      @redis_pool = StoreConnectionPool.new(size: pool_size) { build_redis() }
     end
 
     unless $openc3_redis_cluster
@@ -212,7 +243,7 @@ module OpenC3
     def initialize(pool_size = 10)
       super(pool_size)
       @redis_url = "redis://#{ENV['OPENC3_REDIS_EPHEMERAL_HOSTNAME']}:#{ENV['OPENC3_REDIS_EPHEMERAL_PORT']}"
-      @redis_pool = ConnectionPool.new(size: pool_size) { build_redis() }
+      @redis_pool = StoreConnectionPool.new(size: pool_size) { build_redis() }
     end
   end
 end

data/lib/openc3/utilities/store_queued.rb

@@ -60,19 +60,29 @@ module OpenC3
       end
     end
 
+    def set_update_interval(interval)
+      if interval < @update_interval and interval > 0.0
+        @update_interval = interval
+      end
+    end
+
+    def process_queue
+      unless @store_queue.empty?
+        # Pipeline the requests to redis to improve performance
+        @store.redis_pool.pipelined do
+          while !@store_queue.empty?
+            action = @store_queue.pop()
+            @store.public_send(action.message, *action.args, **action.kwargs, &action.block)
+          end
+        end
+      end
+    end
+
     def store_thread_body
       while true
         start_time = Time.now
 
-        unless @store_queue.empty?
-          # Pipeline the requests to redis to improve performance
-          @store.pipelined do
-            while !@store_queue.empty?
-              action = @store_queue.pop()
-              @store.method_missing(action.message, *action.args, **action.kwargs, &action.block)
-            end
-          end
-        end
+        process_queue()
 
         # Only check whether to update at a set interval
         run_time = Time.now - start_time
@@ -87,25 +97,14 @@ module OpenC3
       OpenC3.kill_thread(self, @update_thread) if @update_thread
       @update_thread = nil
       # Drain the queue before shutdown
-      unless @store_queue.empty?
-        # Pipeline the requests to redis to improve performance
-        @store.pipelined do
-          while !@store_queue.empty?
-            action = @store_queue.pop()
-            @store.method_missing(action.message, *action.args, **action.kwargs, &action.block)
-          end
-        end
-      end
+      process_queue()
     end
 
+    MessageStruct = Struct.new(:message, :args, :kwargs, :block)
+
     # Record the message for pipelining by the thread
     def method_missing(message, *args, **kwargs, &block)
-      o = OpenStruct.new
-      o.message = message
-      o.args = args
-      o.kwargs = kwargs
-      o.block = block
-      @store_queue.push(o)
+      @store_queue.push(MessageStruct.new(message, args, kwargs, block))
     end
 
     # Returns the store we're working with

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '5.14.2'
+OPENC3_VERSION = '5.15.1'
 module OpenC3
   module Version
     MAJOR = '5'
-    MINOR = '14'
-    PATCH = '2'
+    MINOR = '15'
+    PATCH = '1'
     OTHER = ''
-    BUILD = 'e5d9da06d95d4404fba6f9fd5a74a130ef176bd4'
+    BUILD = 'e825c03f698ac51170218e43cec3c3cecefe58fa'
   end
-  VERSION = '5.14.2'
-  GEM_VERSION = '5.14.2'
+  VERSION = '5.15.1'
+  GEM_VERSION = '5.15.1'
 end

data/templates/tool_angular/package.json

@@ -1,6 +1,6 @@
 {
   "name": "<%= tool_name %>",
-  "version": "5.14.2",
+  "version": "5.15.1",
   "scripts": {
     "ng": "ng",
     "start": "ng serve",
@@ -12,7 +12,7 @@
   },
   "private": true,
   "dependencies": {
-    "@openc3/tool-common": "5.14.2",
+    "@openc3/tool-common": "5.15.1",
     "@angular/animations": "^17.0.8",
     "@angular/cdk": "^17.0.4",
     "@angular/common": "^17.0.8",

data/templates/tool_svelte/package.json

@@ -11,7 +11,7 @@
     "smui-theme": "smui-theme compile build/smui.css -i src/theme"
   },
   "dependencies": {
-    "@openc3/tool-common": "5.14.2",
+    "@openc3/tool-common": "5.15.1",
     "@astrouxds/astro-web-components": "7.20.0",
     "@smui/button": "^7.0.0-beta.16",
     "@smui/card": "^7.0.0-beta.16",

data/templates/tool_vue/package.json

@@ -1,6 +1,6 @@
 {
   "name": "<%= tool_name %>",
-  "version": "5.14.2",
+  "version": "5.15.1",
   "private": true,
   "scripts": {
     "serve": "vue-cli-service serve",
@@ -11,7 +11,7 @@
     "test:components": "vue-cli-service test:components"
   },
   "dependencies": {
-    "@openc3/tool-common": "5.14.2",
+    "@openc3/tool-common": "5.15.1",
     "@astrouxds/astro-web-components": "7.20.0",
     "axios": "1.6.5",
     "date-fns": "2.30.0",

data/templates/widget/package.json

@@ -1,12 +1,12 @@
 {
   "name": "widget",
-  "version": "5.14.2",
+  "version": "5.15.1",
   "private": true,
   "scripts": {
     "build": "vue-cli-service build --target lib --dest tools/widgets/<%= widget_name %> --formats umd-min <%= widget_path %> --name <%= widget_name %>"
   },
   "dependencies": {
-    "@openc3/tool-common": "5.14.2",
+    "@openc3/tool-common": "5.15.1",
     "@astrouxds/astro-web-components": "7.20.0",
     "vue": "2.7.16",
     "vuetify": "2.7.1"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openc3
 version: !ruby/object:Gem::Version
-  version: 5.14.2
+  version: 5.15.1
 platform: ruby
 authors:
 - Ryan Melton
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-10 00:00:00.000000000 Z
+date: 2024-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -179,6 +179,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: hiredis-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -1167,7 +1181,6 @@ files:
 - templates/tool_angular/tsconfig.app.json
 - templates/tool_angular/tsconfig.json
 - templates/tool_angular/tsconfig.spec.json
-- templates/tool_angular/yarn.lock
 - templates/tool_react/.eslintrc
 - templates/tool_react/.gitignore
 - templates/tool_react/.prettierignore
@@ -1178,7 +1191,6 @@ files:
 - templates/tool_react/src/root.component.js
 - templates/tool_react/src/root.component.test.js
 - templates/tool_react/webpack.config.js
-- templates/tool_react/yarn.lock
 - templates/tool_svelte/.gitignore
 - templates/tool_svelte/.prettierignore
 - templates/tool_svelte/.prettierrc.js
@@ -1196,7 +1208,6 @@ files:
 - templates/tool_svelte/src/services/openc3-api.js
 - templates/tool_svelte/src/theme/_smui-theme.scss
 - templates/tool_svelte/src/tool_name.js
-- templates/tool_svelte/yarn.lock
 - templates/tool_vue/.browserslistrc
 - templates/tool_vue/.env.standalone
 - templates/tool_vue/.eslintrc.js
@@ -1211,7 +1222,6 @@ files:
 - templates/tool_vue/src/router.js
 - templates/tool_vue/src/tools/tool_name/tool_name.vue
 - templates/tool_vue/vue.config.js
-- templates/tool_vue/yarn.lock
 - templates/widget/.browserslistrc
 - templates/widget/.eslintrc.js
 - templates/widget/.nycrc
@@ -1222,7 +1232,6 @@ files:
 - templates/widget/package.json
 - templates/widget/src/Widget.vue
 - templates/widget/vue.config.js
-- templates/widget/yarn.lock
 homepage: https://github.com/OpenC3/cosmos
 licenses:
 - AGPL-3.0-only