openc3 5.18.0 → 5.19.0

data/lib/openc3/logs/buffered_packet_log_writer.rb

@@ -19,7 +19,7 @@
 require 'openc3/logs/packet_log_writer'
 
 module OpenC3
-  # Creates a packet log. Can automatically cycle the log based on an elasped
+  # Creates a packet log. Can automatically cycle the log based on an elapsed
   # time period or when the log file reaches a predefined size.
   class BufferedPacketLogWriter < PacketLogWriter
     # @param remote_log_directory [String] The path to store the log files
@@ -123,8 +123,8 @@ module OpenC3
         @buffer.each do |entry|
           write(*entry[0..-3], allow_new_file: false, take_mutex: false, received_time_nsec_since_epoch: entry[-2], extra: entry[-1])
         end
-      rescue => err
-        Logger.instance.error "Error writing out buffer : #{err.formatted}"
+      rescue => e
+        Logger.instance.error "Error writing out buffer : #{e.formatted}"
       end
       @buffer = []
     end

data/lib/openc3/logs/log_writer.rb

@@ -20,13 +20,12 @@
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
-require 'thread'
 require 'openc3/config/config_parser'
 require 'openc3/topics/topic'
 require 'openc3/utilities/bucket_utilities'
 
 module OpenC3
-  # Creates a log. Can automatically cycle the log based on an elasped
+  # Creates a log. Can automatically cycle the log based on an elapsed
   # time period or when the log file reaches a predefined size.
   class LogWriter
     # @return [String] The filename of the packet log
@@ -275,10 +274,10 @@ module OpenC3
       @last_time = nil
       @previous_time_nsec_since_epoch = nil
       Logger.debug "Log File Opened : #{@filename}"
-    rescue => err
-      Logger.error "Error starting new log file: #{err.formatted}"
+    rescue => e
+      Logger.error "Error starting new log file: #{e.formatted}"
       @logging_enabled = false
-      OpenC3.handle_critical_exception(err)
+      OpenC3.handle_critical_exception(e)
     end
 
     # @enforce_time_order requires the timestamps on each write to be greater than the previous
@@ -328,10 +327,10 @@ module OpenC3
             @last_offsets.each do |redis_topic, last_offset|
               @cleanup_offsets[-1][redis_topic] = last_offset
             end
-            @cleanup_times << Time.now + CLEANUP_DELAY
+            @cleanup_times << (Time.now + CLEANUP_DELAY)
             @last_offsets.clear
-          rescue Exception => err
-            Logger.error "Error closing #{@filename} : #{err.formatted}"
+          rescue Exception => e
+            Logger.error "Error closing #{@filename} : #{e.formatted}"
           end
 
           @file = nil

data/lib/openc3/logs/packet_log_writer.rb

@@ -26,7 +26,7 @@ require 'openc3/models/target_model'
 require 'cbor'
 
 module OpenC3
-  # Creates a packet log. Can automatically cycle the log based on an elasped
+  # Creates a packet log. Can automatically cycle the log based on an elapsed
   # time period or when the log file reaches a predefined size.
   class PacketLogWriter < LogWriter
     include PacketLogConstants
@@ -112,9 +112,9 @@ module OpenC3
       ensure
         @mutex.unlock if take_mutex
       end
-    rescue => err
-      Logger.instance.error "Error writing #{@filename} : #{err.formatted}"
-      OpenC3.handle_critical_exception(err)
+    rescue => e
+      Logger.instance.error "Error writing #{@filename} : #{e.formatted}"
+      OpenC3.handle_critical_exception(e)
     end
 
     # Starting a new file is a critical operation so the entire method is
@@ -133,10 +133,10 @@ module OpenC3
       @next_target_index = 0
       @target_dec_entries = []
       @packet_dec_entries = []
-    rescue => err
-      Logger.error "Error starting new log file: #{err.formatted}"
+    rescue => e
+      Logger.error "Error starting new log file: #{e.formatted}"
       @logging_enabled = false
-      OpenC3.handle_critical_exception(err)
+      OpenC3.handle_critical_exception(e)
     end
 
     # Closing a log file isn't critical so we just log an error

data/lib/openc3/logs/text_log_writer.rb

@@ -24,7 +24,7 @@ require 'openc3/logs/log_writer'
 require 'socket'
 
 module OpenC3
-  # Creates a text log. Can automatically cycle the log based on an elasped
+  # Creates a text log. Can automatically cycle the log based on an elapsed
   # time period or when the log file reaches a predefined size.
   class TextLogWriter < LogWriter
     NEWLINE = "\n".freeze
@@ -48,9 +48,9 @@ module OpenC3
         prepare_write(time_nsec_since_epoch, data.length, redis_topic, redis_offset)
         write_entry(time_nsec_since_epoch, data) if @file
       end
-    rescue => err
-      Logger.instance.error "Error writing #{@filename} : #{err.formatted}"
-      OpenC3.handle_critical_exception(err)
+    rescue => e
+      Logger.instance.error "Error writing #{@filename} : #{e.formatted}"
+      OpenC3.handle_critical_exception(e)
     end
 
     def write_entry(time_nsec_since_epoch, data)

data/lib/openc3/microservices/decom_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
@@ -102,9 +102,22 @@ module OpenC3
           packet.extra = extra
         end
         packet.buffer = msg_hash["buffer"]
-        packet.process # Run processors
-        packet.check_limits(System.limits_set) # Process all the limits and call the limits_change_callback (as necessary)
+        # Processors are user code points which must be rescued
+        # so the TelemetryDecomTopic can write the packet
+        begin
+          packet.process # Run processors
+        rescue Exception => e
+          @error_count += 1
+          @metric.set(name: 'decom_error_total', value: @error_count, type: 'counter')
+          @error = e
+          @logger.error e.message
+        end
+        # Process all the limits and call the limits_change_callback (as necessary)
+        # check_limits also can call user code in the limits response
+        # but that is rescued separately in the limits_change_callback
+        packet.check_limits(System.limits_set)
 
+        # This is what updates the CVT
         TelemetryDecomTopic.write_packet(packet, scope: @scope)
         diff = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start # seconds as a float
         @metric.set(name: 'decom_duration_seconds', value: diff, type: 'gauge', unit: 'seconds')
@@ -150,12 +163,14 @@ module OpenC3
 
       if item.limits.response
         begin
+          # TODO: The limits response is user code and should be run as a separate thread / process
+          # If this code blocks it will delay TelemetryDecomTopic.write_packet
           item.limits.response.call(packet, item, old_limits_state)
         rescue Exception => e
           @error = e
           @logger.error "#{packet.target_name} #{packet.packet_name} #{item.name} Limits Response Exception!"
           @logger.error "Called with old_state = #{old_limits_state}, new_state = #{item.limits.state}"
-          @logger.error e.formatted
+          @logger.error e.filtered
         end
       end
     end

data/lib/openc3/microservices/interface_microservice.rb

@@ -31,6 +31,7 @@ require 'openc3/topics/command_topic'
 require 'openc3/topics/command_decom_topic'
 require 'openc3/topics/interface_topic'
 require 'openc3/topics/router_topic'
+require 'openc3/interfaces/interface'
 
 module OpenC3
   class InterfaceCmdHandlerThread
@@ -191,22 +192,59 @@ module OpenC3
               next e.message
             end
 
+            command.extra ||= {}
+            command.extra['cmd_string'] = msg_hash['cmd_string']
+            command.extra['username'] = msg_hash['username']
             if hazardous_check
               hazardous, hazardous_description = System.commands.cmd_pkt_hazardous?(command)
               # Return back the error, description, and the formatted command
               # This allows the error handler to simply re-send the command
-              next "HazardousError\n#{hazardous_description}\n#{System.commands.format(command)}" if hazardous
+              next "HazardousError\n#{hazardous_description}\n#{msg_hash['cmd_string']}" if hazardous
             end
 
+            validate = ConfigParser.handle_true_false(msg_hash['validate'])
             begin
               if @interface.connected?
+                result = true
+                reason = nil
+                if command.validator and validate
+                  begin
+                    result, reason = command.validator.pre_check(command)
+                  rescue => e
+                    result = false
+                    reason = e.message
+                  end
+                  # Explicitly check for false to allow nil to represent unknown
+                  if result == false
+                    message = "pre_check returned false for #{msg_hash['cmd_string']} due to #{reason}"
+                    raise WriteRejectError.new(message)
+                  end
+                end
+
                 @count += 1
                 @metric.set(name: 'interface_cmd_total', value: @count, type: 'counter') if @metric
-
                 @interface.write(command)
-                CommandTopic.write_packet(command, scope: @scope)
+
+                if command.validator and validate
+                  begin
+                    result, reason = command.validator.post_check(command)
+                  rescue => e
+                    result = false
+                    reason = e.message
+                  end
+                  command.extra['cmd_success'] = result
+                  command.extra['cmd_reason'] = reason if reason
+                end
+
                 CommandDecomTopic.write_packet(command, scope: @scope)
+                CommandTopic.write_packet(command, scope: @scope)
                 InterfaceStatusModel.set(@interface.as_json(:allow_nan => true), queued: true, scope: @scope)
+
+                # Explicitly check for false to allow nil to represent unknown
+                if result == false
+                  message = "post_check returned false for #{msg_hash['cmd_string']} due to #{reason}"
+                  raise WriteRejectError.new(message)
+                end
                 next 'SUCCESS'
               else
                 next "Interface not connected: #{@interface.name}"

data/lib/openc3/microservices/reaction_microservice.rb

@@ -368,7 +368,7 @@ module OpenC3
   end
 
   # The reaction snooze manager starts a thread pool and keeps track of when a
-  # reaction is activated and to evalute triggers when the snooze is complete.
+  # reaction is activated and to evaluate triggers when the snooze is complete.
   class ReactionSnoozeManager
     attr_reader :name, :scope, :share, :thread_pool
 
@@ -432,7 +432,7 @@ module OpenC3
 
     def shutdown
       @cancel_thread = true
-      @worker_count.times do |i|
+      @worker_count.times do |_i|
         @share.queue_base.enqueue(kind: nil, data: nil)
       end
     end

data/lib/openc3/microservices/trigger_group_microservice.rb

@@ -445,7 +445,7 @@ module OpenC3
         visited["#{trigger.name}__P"] = Hash.new
       end
       if visited["#{head.name}__P"][trigger.name]
-        # Not sure if this is posible as on create it validates that the dependents are already created
+        # Not sure if this is possible 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: message)
         return visited["#{trigger.name}__R"] = -1
@@ -494,7 +494,7 @@ module OpenC3
   end
 
   # The trigger manager starts a thread pool and subscribes
-  # to the telemtry decom topic. It adds the "packet" to the thread pool queue
+  # to the telemetry decom topic. It adds the "packet" to the thread pool queue
   # and the thread will evaluate the "trigger".
   class TriggerGroupManager
     attr_reader :name, :scope, :share, :group, :topics, :thread_pool
@@ -621,7 +621,7 @@ module OpenC3
       loop do
         triggers = TriggerModel.all(scope: @scope, group: @group)
         @share.trigger_base.rebuild(triggers: triggers)
-        @manager.refresh() # Everytime we do a full base update we refesh the manager
+        @manager.refresh() # Every time we do a full base update we refresh the manager
         break if @cancel_thread
         block_for_updates()
         break if @cancel_thread

data/lib/openc3/migrations/20240915000000_activity_uuid.rb

@@ -0,0 +1,28 @@
+require 'openc3/utilities/migration'
+require 'openc3/models/scope_model'
+require 'openc3/models/timeline_model'
+
+module OpenC3
+  class ActivityUuid < Migration
+    def self.run
+      ScopeModel.names.each do |scope|
+        TimelineModel.names.each do |key|
+          name = key.split('__').last
+          json = Store.zrange("#{scope}#{ActivityModel::PRIMARY_KEY}__#{name}", 0, -1)
+          parsed = json.map { |value| JSON.parse(value, :allow_nan => true, :create_additions => true) }
+          parsed.each_with_index do |activity, index|
+            if activity['uuid'].nil?
+              activity['uuid'] = SecureRandom.uuid
+              Store.zrem("#{scope}#{ActivityModel::PRIMARY_KEY}__#{name}", json[index])
+              Store.zadd("#{scope}#{ActivityModel::PRIMARY_KEY}__#{name}", activity['start'], JSON.generate(activity))
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+unless ENV['OPENC3_NO_MIGRATE']
+  OpenC3::ActivityUuid.run
+end