openc3 5.15.0 → 5.15.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0228b27d56d6fce2f445eb5842ec223be1351aaf09767da803e735ffb80875ec'
-  data.tar.gz: 7f78a835eb8d3d1c678afa7f93490821cac67dcbf3d854ec1973c452b139a647
+  metadata.gz: a39dab08bb9810376520e75a7bf3a6c63d30ad54b93566b82a849d780693a366
+  data.tar.gz: 65d282829dba0706cbe0e32603e51ad8ab3dfc0fdaf37d9bd400787bb7a1cb03
 SHA512:
-  metadata.gz: 545775f6dd330af7e6e4f566a07ea44f5f5b2e533d2dadb9704e5e1dba142377f4b63dacc89157b0c4b996e20c78851fba4d397d830619fa51ff0a313850935f
-  data.tar.gz: 9eb87fbc7b5410327f0142f1e2bf08ae8070169057a34fbef6eb0f7c9bd846c07aae7e49b70d9b8f4ff5647fe1258155eeb879d0ace4cbe782b1e7b5ca2c8019
+  metadata.gz: 12bffefe104e90e159c16bcc54ab53745e86a97bfb762c7e0e25141d6bd3c91ad6bb8827017d915dfb459b2fc69ea7365c97e7fa22236abb16ff0d73d8d485d7
+  data.tar.gz: b2efa2780f97e2aa3392cc483534d949be4fb27032dbc3e52015ebfa89da08d234e5777c50dbfa09e477357d3b5ca67aba847f8f5d723676d2331da84e880f7f

data/data/config/widgets.yaml

@@ -1302,7 +1302,7 @@ Interactive Widgets:
 
         Button code can get rather complex so remember to use string concatenation
         to make things more readable. If you use `+` newlines are inserted automatically
-        during string concatenation. If you use `\` you'll need to separate lines with a
+        during string concatenation. If you use `\\` you'll need to separate lines with a
         single semicolon `;`. COSMOS uses double semicolon `;;` to indicate lines should
         be evaluated separately. Note that all OpenC3 commands (using api.cmd) must be
         separated by `;;`.

data/lib/openc3/accessors/json_accessor.rb

@@ -18,8 +18,16 @@
 
 require 'json'
 require 'jsonpath'
+require 'openc3/io/json_rpc'
 require 'openc3/accessors/accessor'
 
+# Monkey patch JsonPath to enable create_additions and allow_nan to support binary strings, and NaN, Infinity, -Infinity
+class JsonPath
+  def self.process_object(obj_or_str, opts = {})
+    obj_or_str.is_a?(String) ? MultiJson.decode(obj_or_str, max_nesting: opts[:max_nesting], create_additions: true, allow_nan: true) : obj_or_str
+  end
+end
+
 module OpenC3
   class JsonAccessor < Accessor
     def self.read_item(item, buffer)
@@ -33,7 +41,7 @@ module OpenC3
 
       # Convert to ruby objects
       if String === buffer
-        decoded = JSON.parse(buffer, :allow_nan => true)
+        decoded = JSON.parse(buffer, :allow_nan => true, :create_additions => true)
       else
         decoded = buffer
       end
@@ -43,7 +51,7 @@ module OpenC3
 
       # Update buffer
       if String === buffer
-        buffer.replace(JSON.generate(decoded, :allow_nan => true))
+        buffer.replace(JSON.generate(decoded.as_json, :allow_nan => true))
       end
 
       return value
@@ -52,7 +60,7 @@ module OpenC3
     def self.read_items(items, buffer)
       # Prevent JsonPath from decoding every call
       if String === buffer
-        decoded = JSON.parse(buffer, :allow_nan => true)
+        decoded = JSON.parse(buffer, :allow_nan => true, :create_additions => true)
       else
         decoded = buffer
       end

data/lib/openc3/api/cmd_api.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
@@ -41,6 +41,8 @@ module OpenC3
                        'cmd_raw_no_checks',
                        'build_cmd',
                        'build_command', # DEPRECATED
+                       'enable_cmd',
+                       'disable_cmd',
                        'send_raw',
                        'get_all_cmds',
                        'get_all_commands', # DEPRECATED
@@ -131,6 +133,30 @@ module OpenC3
     # build_command is DEPRECATED
     alias build_command build_cmd
 
+    # Helper method for disable_cmd / enable_cmd
+    def _get_and_set_cmd(method, *args, scope: $openc3_scope, token: $openc3_token)
+      target_name, command_name = _extract_target_command_names(method, *args)
+      authorize(permission: 'admin', target_name: target_name, packet_name: command_name, scope: scope, token: token)
+      command = yield TargetModel.packet(target_name, command_name, type: :CMD, scope: scope)
+      TargetModel.set_packet(target_name, command_name, command, type: :CMD, scope: scope)
+    end
+
+    # @since 5.15.1
+    def enable_cmd(*args, scope: $openc3_scope, token: $openc3_token)
+      _get_and_set_cmd('enable_cmd', *args, scope: scope, token: token) do |command|
+        command['disabled'] = false
+        command
+      end
+    end
+
+    # @since 5.15.1
+    def disable_cmd(*args, scope: $openc3_scope, token: $openc3_token)
+      _get_and_set_cmd('disable_cmd', *args, scope: scope, token: token) do |command|
+        command['disabled'] = true
+        command
+      end
+    end
+
     # Send a raw binary string to the specified interface.
     #
     # @param interface_name [String] The interface to send the raw binary
@@ -456,6 +482,12 @@ module OpenC3
       cmd_params = cmd_params.transform_keys(&:upcase)
       authorize(permission: 'cmd', target_name: target_name, packet_name: cmd_name, scope: scope, token: token)
       packet = TargetModel.packet(target_name, cmd_name, type: :CMD, scope: scope)
+      if packet['disabled']
+        error = DisabledError.new
+        error.target_name = target_name
+        error.cmd_name = cmd_name
+        raise error
+      end
 
       command = {
         'target_name' => target_name,

data/lib/openc3/io/posix_serial_driver.rb

@@ -14,10 +14,10 @@
 # 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 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'fcntl'
@@ -82,12 +82,17 @@ module OpenC3
       tio.ospeed = baud_rate
       @handle.tcflush(Termios::TCIOFLUSH)
       @handle.tcsetattr(Termios::TCSANOW, tio)
+
+      @pipe_reader, @pipe_writer = IO.pipe
+      @readers = [@handle, @pipe_reader]
     end
 
     # (see SerialDriver#close)
     def close
       if @handle
         # Close the serial Port
+        @pipe_writer.write('.')
+        @pipe_writer.close
         @handle.close
         @handle = nil
       end
@@ -132,9 +137,19 @@ module OpenC3
       begin
         data = @handle.read_nonblock(65535)
       rescue Errno::EAGAIN, Errno::EWOULDBLOCK
-        result = IO.fast_select([@handle], nil, nil, @read_timeout)
-        if result
-          retry
+        begin
+          read_ready, _ = IO.fast_select(@readers, nil, nil, @read_timeout)
+        rescue IOError
+          @pipe_reader.close unless @pipe_reader.closed?
+          return ""
+        end
+        if read_ready
+          if read_ready.include?(@pipe_reader)
+            @pipe_reader.close unless @pipe_reader.closed?
+            return ""
+          else
+            retry
+          end
         else
           raise Timeout::Error, "Read Timeout"
         end

data/lib/openc3/logs/packet_log_reader.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
@@ -96,9 +96,9 @@ module OpenC3
       @max_read_size = @file.size
       @max_read_size = MAX_READ_SIZE if @max_read_size > MAX_READ_SIZE
       return read_file_header()
-    rescue => err
+    rescue => e
       close()
-      raise err
+      raise e
     end
 
     # Closes the current log file
@@ -134,9 +134,8 @@ module OpenC3
 
       if flags & OPENC3_ENTRY_TYPE_MASK == OPENC3_JSON_PACKET_ENTRY_TYPE_MASK
         packet_index, time_nsec_since_epoch = entry[2..11].unpack('nQ>')
-        next_offset = 12
         received_time_nsec_since_epoch, extra, json_data = handle_received_time_extra_and_data(entry, time_nsec_since_epoch, includes_received_time, includes_extra, cbor)
-        lookup_cmd_or_tlm, target_name, packet_name, id, key_map = @packets[packet_index]
+        lookup_cmd_or_tlm, target_name, packet_name, _id, key_map = @packets[packet_index]
         if cmd_or_tlm != lookup_cmd_or_tlm
           raise "Packet type mismatch, packet:#{cmd_or_tlm}, lookup:#{lookup_cmd_or_tlm}"
         end
@@ -148,8 +147,8 @@ module OpenC3
         end
       elsif flags & OPENC3_ENTRY_TYPE_MASK == OPENC3_RAW_PACKET_ENTRY_TYPE_MASK
         packet_index, time_nsec_since_epoch = entry[2..11].unpack('nQ>')
-        received_time_nsec_since_epoch, extra, packet_data = handle_received_time_extra_and_data(entry, time_nsec_since_epoch, includes_received_time, includes_extra, cbor)
-        lookup_cmd_or_tlm, target_name, packet_name, id = @packets[packet_index]
+        received_time_nsec_since_epoch, _extra, packet_data = handle_received_time_extra_and_data(entry, time_nsec_since_epoch, includes_received_time, includes_extra, cbor)
+        lookup_cmd_or_tlm, target_name, packet_name, _id = @packets[packet_index]
         if cmd_or_tlm != lookup_cmd_or_tlm
           raise "Packet type mismatch, packet:#{cmd_or_tlm}, lookup:#{lookup_cmd_or_tlm}"
         end
@@ -220,9 +219,9 @@ module OpenC3
       else
         raise "Invalid Entry Flags: #{flags}"
       end
-    rescue => err
+    rescue => e
       close()
-      raise err
+      raise e
     end
 
     # @return [Integer] The size of the log file being processed

data/lib/openc3/microservices/trigger_group_microservice.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
@@ -418,7 +418,7 @@ module OpenC3
         when 'OR'
           return left || right ? 1 : 0
         end
-      rescue ArgumentError => error
+      rescue ArgumentError
         message = "invalid evaluate: (#{left} #{operator} #{right})"
         notify(name: name, severity: 'error', message: message)
         return -1
@@ -447,7 +447,7 @@ module OpenC3
       if visited["#{head.name}__P"][trigger.name]
         # Not sure if this is posible as on create it validates that the dependents are already created
         message = "loop detected from #{head.name} -> #{trigger.name} path: #{visited["#{head.name}__P"]}"
-        notify(name: trigger.name, severity: 'error', message: error.message)
+        notify(name: trigger.name, severity: 'error', message: message)
         return visited["#{trigger.name}__R"] = -1
       end
       trigger.roots.each do | root_trigger_name |
@@ -455,7 +455,7 @@ module OpenC3
         root_trigger = triggers[root_trigger_name]
         if head.name == root_trigger.name
           message = "loop detected from #{head.name} -> #{root_trigger_name} path: #{visited["#{head.name}__P"]}"
-          notify(name: trigger.name, severity: 'error', message: error.message)
+          notify(name: trigger.name, severity: 'error', message: message)
           return visited["#{trigger.name}__R"] = -1
         end
         result = evaluate_trigger(
@@ -474,9 +474,9 @@ module OpenC3
         else
           right = operand_value(operand: trigger.right, other: trigger.left, visited: visited)
         end
-      rescue => error
+      rescue => e
         # This will primarily happen when the user inputs a bad Regexp
-        notify(name: trigger.name, severity: 'error', message: error.message)
+        notify(name: trigger.name, severity: 'error', message: e.message)
         return visited["#{trigger.name}__R"] = -1
       end
       # Convert the standard '==' and '!=' into Ruby Regexp operators
@@ -560,7 +560,7 @@ module OpenC3
       while @read_topic
         begin
           Topic.read_topics(@topics) do |topic, _msg_id, msg_hash, _redis|
-            @logger.debug "TriggerGroupManager block_for_updates: #{topic} #{msg_hash.to_s}"
+            @logger.debug "TriggerGroupManager block_for_updates: #{topic} #{msg_hash}"
             if topic != @share.trigger_base.autonomic_topic
               packet = JsonPacket.new(:TLM, msg_hash['target_name'], msg_hash['packet_name'], msg_hash['time'].to_i, false, msg_hash["json_data"])
               @share.packet_base.add(topic: topic, packet: packet)
@@ -580,7 +580,7 @@ module OpenC3
     def shutdown
       @read_topic = false
       @cancel_thread = true
-      @worker_count.times do | i |
+      @worker_count.times do | _i |
         @queue << nil
       end
     end
@@ -635,7 +635,7 @@ module OpenC3
         begin
           AutonomicTopic.read_topics(@topics) do |_topic, _msg_id, msg_hash, _redis|
             break if @cancel_thread
-            @logger.debug "TriggerGroupMicroservice block_for_updates: #{msg_hash.to_s}"
+            @logger.debug "TriggerGroupMicroservice block_for_updates: #{msg_hash}"
             # Process trigger notifications created by TriggerModel notify
             if msg_hash['type'] == 'trigger'
               data = JSON.parse(msg_hash['data'], :allow_nan => true, :create_additions => true)

data/lib/openc3/models/auth_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
@@ -31,11 +31,11 @@ module OpenC3
     @@token_cache = nil
     @@token_cache_time = nil
 
-    def self.is_set?(key = PRIMARY_KEY)
+    def self.set?(key = PRIMARY_KEY)
       Store.exists(key) == 1
     end
 
-    def self.verify(token, permission: nil)
+    def self.verify(token)
       return false if token.nil? or token.empty?
 
       token_hash = hash(token)
@@ -47,7 +47,7 @@ module OpenC3
 
       # Handle a service password - Generally only used by ScriptRunner
       service_password = ENV['OPENC3_SERVICE_PASSWORD']
-      return true if service_password and service_password == token and permission != 'admin'
+      return true if service_password and service_password == token
 
       return false
     end
@@ -55,15 +55,13 @@ module OpenC3
     def self.set(token, old_token, key = PRIMARY_KEY)
       raise "token must not be nil or empty" if token.nil? or token.empty?
 
-      if is_set?(key)
+      if set?(key)
         raise "old_token must not be nil or empty" if old_token.nil? or old_token.empty?
         raise "old_token incorrect" unless verify(old_token)
       end
       Store.set(key, hash(token))
     end
 
-    private
-
     def self.hash(token)
       Digest::SHA2.hexdigest token
     end

data/lib/openc3/script/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
@@ -96,7 +96,7 @@ module OpenC3
 
       # Get the command and validate the parameters
       command = $api_server.get_cmd(target_name, cmd_name, scope: scope)
-      cmd_params.each do |param_name, param_value|
+      cmd_params.each do |param_name, _param_value|
         param = command['items'].find { |item| item['name'] == param_name }
         unless param
           raise "Packet item '#{target_name} #{cmd_name} #{param_name}' does not exist"

data/lib/openc3/script/storage.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
@@ -43,8 +43,8 @@ module OpenC3
         if response.nil? || response.status != 200
           raise "Failed to delete #{delete_path}"
         end
-      rescue => error
-        raise "Failed deleting #{path} due to #{error.message}"
+      rescue => e
+        raise "Failed deleting #{path} due to #{e.message}"
       end
       nil
     end
@@ -84,8 +84,8 @@ module OpenC3
             end
           end
         end
-      rescue => error
-        raise "Failed to write #{upload_path} due to #{error.message}"
+      rescue => e
+        raise "Failed to write #{upload_path} due to #{e.message}"
       end
       nil
     end
@@ -115,19 +115,33 @@ module OpenC3
           end
 
           return _get_storage_file("#{part}/#{path}", scope: scope)
-        rescue => error
+        rescue => e
           if part == "targets_modified"
             part = "targets"
             redo
           else
-            raise error
+            raise e
           end
         end
         break
       end
     end
 
-    # download_file(path_or_file) is implemented by running_script to download a file
+    def get_download_url(path, scope: $openc3_scope)
+      targets = "targets_modified" # First try targets_modified
+      response = $api_server.request('get', "/openc3-api/storage/exists/#{scope}/#{targets}/#{path}", query: { bucket: 'OPENC3_CONFIG_BUCKET' }, scope: scope)
+      if response.status != 200
+        targets = "targets" # Next try targets
+        response = $api_server.request('get', "/openc3-api/storage/exists/#{scope}/#{targets}/#{path}", query: { bucket: 'OPENC3_CONFIG_BUCKET' }, scope: scope)
+        if response.status != 200
+          raise "File not found: #{path} in scope: #{scope}"
+        end
+      end
+      endpoint = "/openc3-api/storage/download/#{scope}/#{targets}/#{path}"
+      # external must be true because we're using this URL from the frontend
+      result = _get_presigned_request(endpoint, external: true, scope: scope)
+      return result['url']
+    end
 
     # These are helper methods ... should not be used directly
 
@@ -161,7 +175,8 @@ module OpenC3
       if $openc3_in_cluster
         case ENV['OPENC3_CLOUD']
         when 'local'
-          URI.parse("http://openc3-minio:9000" + url)
+          bucket_url = ENV["OPENC3_BUCKET_URL"] || "http://openc3-minio:9000"
+          URI.parse("#{bucket_url}#{url}")
         when 'aws'
           URI.parse("https://s3.#{ENV['AWS_REGION']}.amazonaws.com" + url)
         when 'gcp'
@@ -175,11 +190,11 @@ module OpenC3
       end
     end
 
-    def _get_presigned_request(endpoint, scope: $openc3_scope)
-      if $openc3_in_cluster
-        response = $api_server.request('get', endpoint, query: { bucket: 'OPENC3_CONFIG_BUCKET', internal: true }, scope: scope)
-      else
+    def _get_presigned_request(endpoint, external: nil, scope: $openc3_scope)
+      if external or !$openc3_in_cluster
         response = $api_server.request('get', endpoint, query: { bucket: 'OPENC3_CONFIG_BUCKET' }, scope: scope)
+      else
+        response = $api_server.request('get', endpoint, query: { bucket: 'OPENC3_CONFIG_BUCKET', internal: true }, scope: scope)
       end
       if response.nil? || response.status != 201
         raise "Failed to get presigned URL for #{endpoint}"

data/lib/openc3/script/web_socket_api.rb

@@ -215,6 +215,16 @@ module OpenC3
     end
   end
 
+  # All Scripts WebSocket
+  class AllScriptsWebSocketApi < ScriptWebSocketApi
+    def initialize(url: nil, write_timeout: 10.0, read_timeout: 10.0, connect_timeout: 5.0, authentication: nil, scope: $openc3_scope)
+      @identifier = {
+        channel: "AllScriptsChannel",
+      }
+      super(url: url, write_timeout: write_timeout, read_timeout: read_timeout, connect_timeout: connect_timeout, authentication: authentication, scope: scope)
+    end
+  end
+
   # Log Messages WebSocket
   class MessagesWebSocketApi < CmdTlmWebSocketApi
     def initialize(history_count: 0, start_time: nil, end_time: nil, level: nil, types: nil, url: nil, write_timeout: 10.0, read_timeout: 10.0, connect_timeout: 5.0, authentication: nil, scope: $openc3_scope)

data/lib/openc3/system/system.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
@@ -31,7 +31,6 @@ require 'openc3/system/target'
 require 'openc3/utilities/bucket'
 require 'openc3/utilities/zip'
 require 'openc3/topics/limits_event_topic'
-require 'thread'
 require 'fileutils'
 
 module OpenC3
@@ -109,7 +108,7 @@ module OpenC3
           # target.txt must be configured to either use all files in cmd_tlm folder (default)
           # or have a predetermined empty file like dynamic_tlm.txt
           bucket_path = "#{scope}/targets_modified/#{target_name}/cmd_tlm"
-          dirs, files = bucket.list_files(bucket: ENV['OPENC3_CONFIG_BUCKET'], path: bucket_path)
+          _, files = bucket.list_files(bucket: ENV['OPENC3_CONFIG_BUCKET'], path: bucket_path)
           files.each do |file|
             bucket_key = File.join(bucket_path, file['name'])
             local_path = "#{base_dir}/targets/#{target_name}/cmd_tlm/#{file['name']}"
@@ -180,8 +179,8 @@ module OpenC3
       errors = [] # Store all errors processing the cmd_tlm files
       target.cmd_tlm_files.each do |cmd_tlm_file|
         @packet_config.process_file(cmd_tlm_file, target.name, target.language)
-      rescue Exception => error
-        errors << "Error processing #{cmd_tlm_file}:\n#{error.message}"
+      rescue Exception => e
+        errors << "Error processing #{cmd_tlm_file}:\n#{e.message}"
       end
       unless errors.empty?
         raise errors.join("\n")

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/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/store_autoload.rb

@@ -37,13 +37,17 @@ module OpenC3
     NO_OPTIONS = {}
 
     def pipelined
-      with(NO_OPTIONS) do |redis|
-        redis.pipelined do |pipeline|
-          Thread.current[:pipeline] = pipeline
-          begin
-            yield
-          ensure
-            Thread.current[:pipeline] = nil
+      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

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '5.15.0'
+OPENC3_VERSION = '5.15.2'
 module OpenC3
   module Version
     MAJOR = '5'
     MINOR = '15'
-    PATCH = '0'
+    PATCH = '2'
     OTHER = ''
-    BUILD = 'a7dd92ddb0ba4d378da1b611cafc5ad7e89a9223'
+    BUILD = '460e13eadf313640ad089597bee233ecdafd2ffa'
   end
-  VERSION = '5.15.0'
-  GEM_VERSION = '5.15.0'
+  VERSION = '5.15.2'
+  GEM_VERSION = '5.15.2'
 end

data/templates/target/targets/TARGET/lib/target.py

@@ -4,6 +4,8 @@
 #   <%= target_object %>.utility()
 # For more information see the OpenC3 scripting guide
 
+from openc3.script import *
+
 class <%= target_class %>:
     def utility(self):
         pass

data/templates/tool_angular/package.json

@@ -1,6 +1,6 @@
 {
   "name": "<%= tool_name %>",
-  "version": "5.15.0",
+  "version": "5.15.2",
   "scripts": {
     "ng": "ng",
     "start": "ng serve",
@@ -12,7 +12,7 @@
   },
   "private": true,
   "dependencies": {
-    "@openc3/tool-common": "5.15.0",
+    "@openc3/tool-common": "5.15.2",
     "@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.15.0",
+    "@openc3/tool-common": "5.15.2",
     "@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.15.0",
+  "version": "5.15.2",
   "private": true,
   "scripts": {
     "serve": "vue-cli-service serve",
@@ -11,7 +11,7 @@
     "test:components": "vue-cli-service test:components"
   },
   "dependencies": {
-    "@openc3/tool-common": "5.15.0",
+    "@openc3/tool-common": "5.15.2",
     "@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.15.0",
+  "version": "5.15.2",
   "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.15.0",
+    "@openc3/tool-common": "5.15.2",
     "@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.15.0
+  version: 5.15.2
 platform: ruby
 authors:
 - Ryan Melton
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-10 00:00:00.000000000 Z
+date: 2024-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler