openc3 5.1.1 → 5.2.0

data/lib/openc3/interfaces/protocols/fixed_protocol.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, 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 'openc3/config/config_parser'
@@ -77,7 +77,13 @@ module OpenC3
       packet_data = nil
       identified_packet = nil
 
-      @interface.target_names.each do |target_name|
+      if @telemetry
+        target_names = @interface.tlm_target_names
+      else
+        target_names = @interface.cmd_target_names
+      end
+
+      target_names.each do |target_name|
         target_packets = nil
         unique_id_mode = false
         begin

data/lib/openc3/interfaces/protocols/ignore_packet_protocol.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, 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 'openc3/config/config_parser'
@@ -40,7 +40,7 @@ module OpenC3
     def read_packet(packet)
       # Need to make sure packet is identified and defined
       target_names = nil
-      target_names = @interface.target_names if @interface
+      target_names = @interface.tlm_target_names if @interface
       identified_packet = System.telemetry.identify_and_define_packet(packet, target_names)
       if identified_packet
         if identified_packet.target_name == @target_name && identified_packet.packet_name == @packet_name

data/lib/openc3/interfaces/protocols/override_protocol.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, 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 'openc3/interfaces/protocols/protocol'
@@ -41,7 +41,7 @@ module OpenC3
       if @interface.override_tlm && !@interface.override_tlm.empty?
         # Need to make sure packet is identified and defined
         target_names = nil
-        target_names = @interface.target_names if @interface
+        target_names = @interface.tlm_target_names if @interface
         identified_packet = System.telemetry.identify_and_define_packet(packet, target_names)
         if identified_packet
           packet = identified_packet

data/lib/openc3/interfaces/tcpip_server_interface.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, 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 'socket'
@@ -398,6 +398,8 @@ module OpenC3
 
       interface = StreamInterface.new
       interface.target_names = @target_names
+      interface.cmd_target_names = @cmd_target_names
+      interface.tlm_target_names = @tlm_target_names
       if @raw_logger_pair
         interface.raw_logger_pair = @raw_logger_pair.clone
         interface.raw_logger_pair.start if @raw_logging_enabled

data/lib/openc3/io/json_api_object.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, 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 'openc3'
@@ -48,7 +48,7 @@ module OpenC3
   #   server = JsonApiObject('http://openc3-cosmos-cmd-tlm-api:2901', 1.0)
   #   server.cmd(*args)
   #
-  class JsonApiObject 
+  class JsonApiObject
     attr_reader :request_data
     attr_reader :response_data
 
@@ -64,16 +64,29 @@ module OpenC3
       @response_data = ""
       @url = url
       @log = [nil, nil, nil]
-      @authentication = authentication.nil? ? OpenC3Authentication.new() : authentication
+      @authentication = authentication.nil? ? generate_auth() : authentication
       @timeout = timeout
       @shutdown = false
     end
 
+    # generate the auth object
+    def generate_auth
+      if ENV['OPENC3_API_TOKEN'].nil? and ENV['OPENC3_API_USER'].nil?
+        if ENV['OPENC3_API_PASSWORD'] || ENV['OPENC3_SERVICE_PASSWORD']
+          return OpenC3Authentication.new()
+        else
+          return nil
+        end
+      else
+        return OpenC3KeycloakAuthentication.new(ENV['OPENC3_KEYCLOAK_URL'])
+      end
+    end
+
     # Forwards all method calls to the remote service.
     #
     # @param method_params [Array] Array of parameters to pass to the method
     # @param keyword_params [Hash<Symbol, Variable>] Hash of keyword parameters
-    # @return The result of the method call. 
+    # @return The result of the method call.
     def request(*method_params, **keyword_params)
       raise JsonApiError, "Shutdown" if @shutdown
       method = method_params[0]
@@ -142,12 +155,20 @@ module OpenC3
       elsif headers.is_a?(Hash) == false
         raise JsonApiError, "incorrect type for keyword 'headers' MUST be Hash: #{headers}"
       end
-      
+
       headers['Content-Type'] = 'application/json' if kwargs[:json]
-      return headers.update({
-        'User-Agent' => USER_AGENT,
-        'Authorization' => @authentication.token(),
-      })
+      token = kwargs[:token]
+      token = @authentication.token if @authentication and not token
+      if token
+        return headers.update({
+          'User-Agent' => USER_AGENT,
+          'Authorization' => token,
+        })
+      else
+        return headers.update({
+          'User-Agent' => USER_AGENT,
+        })
+      end
     end
 
     # NOTE: This is a helper method and should not be called directly

data/lib/openc3/io/json_drb.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, 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 'thread'
@@ -298,6 +298,11 @@ module OpenC3
                 response = JsonRpcErrorResponse.new(
                   JsonRpcError.new(error_code, error.message, error), request.id
                 )
+              elsif HazardousError === error
+                error_code = JsonRpcError::ErrorCode::HAZARDOUS_ERROR
+                response = JsonRpcErrorResponse.new(
+                  JsonRpcError.new(error_code, error.message, error), request.id
+                )
               else
                 error_code = JsonRpcError::ErrorCode::OTHER_ERROR
                 response = JsonRpcErrorResponse.new(

data/lib/openc3/io/json_drb_object.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, 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 'openc3'
@@ -65,7 +65,8 @@ module OpenC3
         connect() if !@http
         json_rpc_request = JsonRpcRequest.new(method_name, method_params, keyword_params, @id)
         data = json_rpc_request.to_json(:allow_nan => true)
-        response_body = make_request(data: data)
+        token = keyword_params[:token]
+        response_body = make_request(data: data, token: token)
         if !response_body or response_body.to_s.length < 1
           disconnect()
         else
@@ -79,13 +80,21 @@ module OpenC3
 
     private
 
-    # 
-    def make_request(data:)
-      headers = {
-        'User-Agent' => USER_AGENT,
-        'Content-Type' => 'application/json-rpc',
-        'Authorization' => @authentication.token(),
-      }
+    #
+    def make_request(data:, token: nil)
+      token = @authentication.token if @authentication and not token
+      if token
+        headers = {
+          'User-Agent' => USER_AGENT,
+          'Content-Type' => 'application/json-rpc',
+          'Authorization' => token,
+        }
+      else
+        headers = {
+          'User-Agent' => USER_AGENT,
+          'Content-Type' => 'application/json-rpc',
+        }
+      end
       begin
         @log[0] = "Request: #{@uri.to_s} #{USER_AGENT} #{data.to_s}"
         STDOUT.puts @log[0] if JsonDRb.debug?

data/lib/openc3/io/json_rpc.rb

@@ -119,19 +119,19 @@ end
 
 class Time
   def as_json(options = nil) #:nodoc:
-    to_json(options).remove_quotes
+    self.to_s
   end
 end
 
 class Date
   def as_json(options = nil) #:nodoc:
-    to_json(options).remove_quotes
+    self.to_s
   end
 end
 
 class DateTime
   def as_json(options = nil) #:nodoc:
-    to_json(options).remove_quotes
+    self.to_s
   end
 end
 
@@ -381,6 +381,8 @@ module OpenC3
       INTERNAL_ERROR   = -32603
       AUTH_ERROR       = -32500
       FORBIDDEN_ERROR  = -32501
+      HAZARDOUS_ERROR  = -32502
+      # Server error reserved: -32000 to -32099
       OTHER_ERROR      = -1
     end
 

data/lib/openc3/logs/buffered_packet_log_writer.rb

@@ -46,7 +46,7 @@ module OpenC3
       cycle_hour = nil,
       cycle_minute = nil,
       enforce_time_order = true,
-      buffer_depth = 10
+      buffer_depth = 60 # Default assumes 1 minute of 1Hz data
     )
       super(
         remote_log_directory,

data/lib/openc3/logs/log_writer.rb

@@ -116,6 +116,7 @@ module OpenC3
       @cycle_minute = ConfigParser.handle_nil(cycle_minute)
       @cycle_minute = Integer(@cycle_minute) if @cycle_minute
       @enforce_time_order = ConfigParser.handle_true_false(enforce_time_order)
+      @out_of_order = false
       @mutex = Mutex.new
       @file = nil
       @file_size = 0
@@ -266,6 +267,7 @@ module OpenC3
       @file_size = 0
 
       @start_time = Time.now.utc
+      @out_of_order = false
       @first_time = nil
       @last_time = nil
       @previous_time_nsec_since_epoch = nil
@@ -287,8 +289,12 @@ module OpenC3
           Logger.debug("Log writer start new file due to cycle size #{@cycle_size}")
           start_new_file()
         elsif @enforce_time_order and @previous_time_nsec_since_epoch and (@previous_time_nsec_since_epoch > time_nsec_since_epoch)
-          Logger.debug("Log writer start new file due to out of order time: #{Time.from_nsec_from_epoch(@previous_time_nsec_since_epoch)} #{Time.from_nsec_from_epoch(time_nsec_since_epoch)}")
-          start_new_file()
+          # Warning: Creating new files here can cause lots of files to be created if packets make it through out of order
+          # Changed to just a error to prevent file thrashing
+          unless @out_of_order
+            Logger.error("Log writer out of order time detected (increase buffer depth?): #{Time.from_nsec_from_epoch(@previous_time_nsec_since_epoch)} #{Time.from_nsec_from_epoch(time_nsec_since_epoch)}")
+            @out_of_order = true
+          end
         end
       end
       @last_offsets[redis_topic] = redis_offset if redis_topic and redis_offset # This is needed for the redis offset marker entry at the end of the log file

data/lib/openc3/microservices/cleanup_microservice.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, 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 'openc3/models/target_model'
@@ -49,12 +49,12 @@ module OpenC3
         ].each do |prefix, retain_time|
           next unless retain_time
           time = start_time - retain_time
-          oldest_list = BucketUtilities.list_files_before_time(ENV['OPENC3_LOGS_BUCKET'], prefix, time)
+          oldest_list = BucketUtilities.files_between_time(ENV['OPENC3_LOGS_BUCKET'], prefix, nil, time)
           if oldest_list.length > 0
             @state = 'DELETING_OBJECTS'
             oldest_list.each_slice(1000) do |slice|
               bucket.delete_objects(bucket: ENV['OPENC3_LOGS_BUCKET'], keys: slice)
-              Logger.info("Deleted #{slice.length} #{target_name} log files")
+              @logger.info("Deleted #{slice.length} #{target_name} log files")
             end
           end
         end

data/lib/openc3/microservices/decom_microservice.rb

@@ -55,7 +55,7 @@ module OpenC3
           LimitsEventTopic.sync_system_thread_body(scope: @scope)
         rescue => e
           @error = e
-          Logger.error("Decom error: #{e.formatted}")
+          @logger.error("Decom error: #{e.formatted}")
         end
       end
     end
@@ -68,7 +68,7 @@ module OpenC3
 
         packet = System.telemetry.packet(target_name, packet_name)
         packet.stored = ConfigParser.handle_true_false(msg_hash["stored"])
-        packet.received_time = Time.from_nsec_from_epoch(msg_hash["time"].to_i)
+        packet.received_time = Time.from_nsec_from_epoch(msg_hash["received_time"].to_i)
         packet.received_count = msg_hash["received_count"].to_i
         packet.buffer = msg_hash["buffer"]
         packet.check_limits(System.limits_set) # Process all the limits and call the limits_change_callback (as necessary)
@@ -99,9 +99,9 @@ module OpenC3
       if log_change
         case item.limits.state
         when :BLUE, :GREEN, :GREEN_LOW, :GREEN_HIGH
-          Logger.info message
+          @logger.info message
         when :YELLOW, :YELLOW_LOW, :YELLOW_HIGH
-          Logger.warn message
+          @logger.warn message
         when :RED, :RED_LOW, :RED_HIGH
           notification = NotificationModel.new(
             time: time_nsec,
@@ -111,7 +111,7 @@ module OpenC3
             body: "Item went into #{item.limits.state} limit status."
           )
           NotificationsTopic.write_notification(notification.as_json(:allow_nan => true), scope: @scope)
-          Logger.error message
+          @logger.error message
         end
       end
 
@@ -126,9 +126,9 @@ module OpenC3
           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 "#{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
         end
       end