openc3 6.3.0 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80ec07f72b5f3b98e988b0e8b4bee1b1ccf94e734f738ff33dc209249966a7e3
-  data.tar.gz: 9367191aab4bae678ef63b0db5f22bfa8a91a5518ec9e056c49c76e099744fd0
+  metadata.gz: c408df49ec8cf1fbcf88e8c05207ac1c65274d56dbee94986c4f56308bc52b23
+  data.tar.gz: 8e8897d618e69898470fcd8a201ba968688fbe598c4ecb46d1a375da14282490
 SHA512:
-  metadata.gz: 7a90b63db9e9e3e085249fb2bc8ae00e0733b26c040f30a9dd23b430255228a928ffe13b2b59e8219a7c908f5e94f1f6c44932569c3b1aadf12d297b2d920a7b
-  data.tar.gz: 2b8e39ae3eee3028faf0a06719ae98c5a958c71afc989fb4da981e53dc8aa22cdcd4cb89f9d07cdbcc6e671360a9cfaab6f0b33854718aa21e731a8c01b80efc
+  metadata.gz: c37180a0814a4ceb79b6503d52a83e10cba964351f07841db692e44bdb5a619f95b7a955283982f73218dc5f6670bef113654b917fc92ed99a9c71ff8e000e36
+  data.tar.gz: fa11395f5c24e207e6e6eb6f74b2b8f53c882222572f39cf7d6a6e95668dd99c5ad24015e832df937fb5f12800c92e3c7f55319716a46fc6a07cdbb99abc2e52

data/bin/openc3cli

@@ -592,28 +592,18 @@ def cli_script_monitor(script_id)
     while (resp = api.read) do
       # see ScriptRunner.vue for types and states
       case resp['type']
-      when 'error', 'fatal'
-        $script_interrupt_text = ''
-        puts 'script failed'
-        break
       when 'file'
         puts "Filename #{resp['filename']} scope #{resp['scope']}"
       when 'line'
         fn = resp['filename'].nil? ? '<no file>' : resp['filename']
         puts "At [#{fn}:#{resp['line_no']}] state [#{resp['state']}]"
-        if resp['state'] == 'error'
+        if resp['state'] == 'error' or resp['state'] == 'crashed'
           $script_interrupt_text = ''
           puts 'script failed'
           break
         end
       when 'output'
         puts resp['line']
-      when 'paused'
-        if resp['state'] == 'fatal'
-          $script_interrupt_text = ''
-          puts 'script failed'
-          break
-        end
       when 'complete'
         $script_interrupt_text = ''
         puts 'script complete'

data/data/config/interface_modifiers.yaml

@@ -240,7 +240,7 @@ CMD:
   python_example: CMD python interface_microservice.py DEFAULT__INTERFACE__INT1
 CONTAINER:
   summary: Docker Container
-  description: Container to execute and run the microservice in. Only used in COSMOS Enterprise Edition.
+  description: Container to execute and run the microservice in. Only used in COSMOS Enterprise.
   since: 5.7.0
   parameters:
     - name: Args

data/data/config/microservice.yaml

@@ -107,7 +107,7 @@ MICROSERVICE:
           values: .+
     CONTAINER:
       summary: Docker Container
-      description: Container to execute and run the microservice in. Only used in COSMOS Enterprise Edition.
+      description: Container to execute and run the microservice in. Only used in COSMOS Enterprise.
       parameters:
         - name: Args
           required: false

data/data/config/plugins.yaml

@@ -16,7 +16,7 @@ VARIABLE:
 NEEDS_DEPENDENCIES:
   summary: Indicates the plugin needs dependencies and sets the GEM_HOME environment variable
   description: If the plugin has a top level lib folder or lists runtime dependencies in the gemspec,
-    NEEDS_DEPENDENCIES is effectively already set. Note that in Enterprise Edition, having
+    NEEDS_DEPENDENCIES is effectively already set. Note that in Enterprise, having
     NEEDS_DEPENDENCIES adds the NFS volume mount to the Kubernetes pod.
   since: 5.5.0
 INTERFACE:

data/data/config/tool.yaml

@@ -66,7 +66,7 @@ TOOL:
       description:
         Position of the tool starting at 2 (1 is reserved for Admin Console).
         Tools without a position are appended to the end as they are installed.
-        All COSMOS open source tools have consecutive integer values for position.
+        All COSMOS Core tools have consecutive integer values for position.
       since: 5.0.8
       parameters:
         - name: Position

data/ext/openc3/ext/burst_protocol/burst_protocol.c

@@ -81,7 +81,11 @@ static VALUE burst_protocol_read_data(int argc, VALUE *argv, VALUE self)
   };
 
   rb_str_concat(rb_ivar_get(self, id_ivar_data), data);
-  rb_ivar_set(self, id_ivar_extra, extra);
+
+  /* Maintain extra from last read read_data */
+  if (!((RSTRING_LEN(data) == 0) && (!(RTEST(extra))))) {
+    rb_ivar_set(self, id_ivar_extra, extra);
+  }
 
   while (1)
   {

data/lib/openc3/api/api.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2023, OpenC3, Inc.
+# All changes Copyright 2025, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -35,6 +35,12 @@ require 'openc3/api/target_api'
 require 'openc3/api/tlm_api'
 require 'openc3/utilities/authorization'
 require 'openc3/topics/topic'
+begin
+  require 'openc3-enterprise/api/cmd_authority_api'
+rescue LoadError
+  # LoadError expected for Open Source Edition
+end
+
 
 module OpenC3
   module Api

data/lib/openc3/interfaces/file_interface.rb

@@ -18,12 +18,16 @@
 
 require 'openc3/interfaces/interface'
 require 'openc3/config/config_parser'
+require 'openc3/utilities/logger'
 require 'thread'
 require 'listen'
 require 'fileutils'
+require 'zlib'
 
 module OpenC3
   class FileInterface < Interface
+    attr_reader :filename
+
     # @param command_write_folder [String] Folder to write command files to - Set to nil to disallow writes
     # @param telemetry_read_folder [String] Folder to read telemetry files from - Set to nil to disallow reads
     # @param telemetry_archive_folder [String] Folder to move read telemetry files to - Set to DELETE to delete files
@@ -62,6 +66,7 @@ module OpenC3
       @write_raw_allowed = false unless @command_write_folder
 
       @file = nil
+      @filename = ''
       @listener = nil
       @connected = false
       @extension = ".bin"
@@ -69,6 +74,9 @@ module OpenC3
       @queue = Queue.new
       @polling = false
       @recursive = false
+      @throttle = nil
+      @discard_file_header_bytes = nil
+      @sleeper = nil
     end
 
     def connect
@@ -90,6 +98,7 @@ module OpenC3
     def disconnect
       @file.close if @file and not @file.closed?
       @file = nil
+      @sleeper.cancel if @sleeper
       @listener.stop if @listener
       @listener = nil
       @queue << nil
@@ -102,6 +111,10 @@ module OpenC3
         if @file
           # Read more data from existing file
           data = @file.read(@file_read_size)
+          # Throttle after each read size
+          if @throttle and @sleeper.sleep(@throttle)
+            return nil, nil
+          end
           if data and data.length > 0
             read_interface_base(data, nil)
             return data, nil
@@ -111,9 +124,16 @@ module OpenC3
         end
 
         # Find the next file to read
-        file = get_next_telemetry_file()
-        if file
-          @file = File.open(file, 'rb')
+        @filename = get_next_telemetry_file()
+        if @filename
+          if File.extname(@filename) == ".gz"
+            @file = Zlib::GzipReader.open(@filename)
+          else
+            @file = File.open(@filename, "rb")
+          end
+          if @discard_file_header_bytes
+            @file.read(@discard_file_header_bytes)
+          end
           next
         end
 
@@ -135,8 +155,8 @@ module OpenC3
 
     def convert_data_to_packet(data, extra = nil)
       packet = super(data, extra)
-      if packet and @stored
-        packet.stored = true
+      if packet
+        packet.stored = @stored
       end
       return packet
     end
@@ -156,6 +176,11 @@ module OpenC3
         @polling = ConfigParser.handle_true_false(option_values[0])
       when 'RECURSIVE'
         @recursive = ConfigParser.handle_true_false(option_values[0])
+      when 'THROTTLE'
+        @throttle = Float(option_values[0])
+        @sleeper = Sleeper.new
+      when 'DISCARD_FILE_HEADER_BYTES'
+        @discard_file_header_bytes = Integer(option_values[0])
       end
     end
 
@@ -173,11 +198,15 @@ module OpenC3
     end
 
     def get_next_telemetry_file
+      files = []
       if @recursive
-        return Dir.glob("#{@telemetry_read_folder}/**/*").sort[0]
+        files = Dir.glob("#{@telemetry_read_folder}/**/*")
       else
-        return Dir.glob("#{@telemetry_read_folder}/*").sort[0]
+        files = Dir.glob("#{@telemetry_read_folder}/*")
       end
+      # Dir.glob includes directories, so filter them out
+      files = files.sort.select { |fn| File.file?(fn) }
+      return files[0]
     end
 
     def create_unique_filename

data/lib/openc3/interfaces/protocols/burst_protocol.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 2025, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -37,7 +37,7 @@ module OpenC3
     # @param fill_fields [Boolean] Fill any required fields when writing packets
     # @param allow_empty_data [true/false/nil] See Protocol#initialize
     def initialize(discard_leading_bytes = 0, sync_pattern = nil, fill_fields = false, allow_empty_data = nil)
-      super(allow_empty_data)
+      super(allow_empty_data) # Calls reset()
       @discard_leading_bytes = discard_leading_bytes.to_i
       @sync_pattern = ConfigParser.handle_nil(sync_pattern)
       @sync_pattern = @sync_pattern.hex_to_byte_string if @sync_pattern
@@ -65,7 +65,7 @@ module OpenC3
       # @return [String|nil] Data for a packet consisting of the bytes read
       def read_data(data, extra = nil)
         @data << data
-        @extra = extra
+        @extra = extra unless (data.length == 0 and extra.nil?) # Maintain extra from last read read_data
 
         while true
           control = handle_sync_pattern()

data/lib/openc3/interfaces/protocols/preidentified_protocol.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 2025, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -30,12 +30,12 @@ module OpenC3
 
     # @param sync_pattern (see BurstProtocol#initialize)
     # @param max_length [Integer] The maximum allowed value of the length field
+    # @param _unused [Integer] Legacy version number - unused
     # @param allow_empty_data [true/false/nil] See Protocol#initialize
-    def initialize(sync_pattern = nil, max_length = nil, mode = 4, allow_empty_data = nil)
+    def initialize(sync_pattern = nil, max_length = nil, _unused = nil, allow_empty_data = nil)
       super(0, sync_pattern, false, allow_empty_data)
       @max_length = ConfigParser.handle_nil(max_length)
       @max_length = Integer(@max_length) if @max_length
-      @mode = Integer(mode)
     end
 
     def reset
@@ -47,13 +47,11 @@ module OpenC3
       packet.received_time = @read_received_time
       packet.target_name = @read_target_name
       packet.packet_name = @read_packet_name
-      if @mode == 4 # COSMOS4.3+ Protocol
-        packet.stored = @read_stored
-        if packet.extra and @read_extra
-          packet.extra.merge(@read_extra)
-        else
-          packet.extra = @read_extra
-        end
+      packet.stored = @read_stored
+      if packet.extra and @read_extra
+        packet.extra.merge(@read_extra)
+      else
+        packet.extra = @read_extra
       end
       return packet
     end
@@ -67,14 +65,12 @@ module OpenC3
       @write_target_name = 'UNKNOWN' unless @write_target_name
       @write_packet_name = packet.packet_name
       @write_packet_name = 'UNKNOWN' unless @write_packet_name
-      if @mode == 4 # COSMOS4.3+ Protocol
-        @write_flags = 0
-        @write_flags |= COSMOS4_STORED_FLAG_MASK if packet.stored
-        @write_extra = nil
-        if packet.extra
-          @write_flags |= COSMOS4_EXTRA_FLAG_MASK
-          @write_extra = packet.extra.as_json(:allow_nan => true).to_json(:allow_nan => true)
-        end
+      @write_flags = 0
+      @write_flags |= COSMOS4_STORED_FLAG_MASK if packet.stored
+      @write_extra = nil
+      if packet.extra
+        @write_flags |= COSMOS4_EXTRA_FLAG_MASK
+        @write_extra = packet.extra.as_json(:allow_nan => true).to_json(:allow_nan => true)
       end
       return packet
     end
@@ -83,12 +79,10 @@ module OpenC3
       data_length = [data.length].pack('N') # UINT32
       data_to_send = ''
       data_to_send << @sync_pattern if @sync_pattern
-      if @mode == 4 # COSMOS4.3+ Protocol
-        data_to_send << @write_flags
-        if @write_extra
-          data_to_send << [@write_extra.length].pack('N')
-          data_to_send << @write_extra
-        end
+      data_to_send << @write_flags
+      if @write_extra
+        data_to_send << [@write_extra.length].pack('N')
+        data_to_send << @write_extra
       end
       data_to_send << @write_time_seconds
       data_to_send << @write_time_microseconds
@@ -146,7 +140,7 @@ module OpenC3
         @reduction_state = :SYNC_REMOVED
       end
 
-      if @reduction_state == :SYNC_REMOVED and @mode == 4
+      if @reduction_state == :SYNC_REMOVED
         # Read and remove flags
         return :STOP if @data.length < 1
 
@@ -171,7 +165,7 @@ module OpenC3
         @reduction_state = :FLAGS_REMOVED
       end
 
-      if @reduction_state == :FLAGS_REMOVED or (@reduction_state == :SYNC_REMOVED and @mode != 4)
+      if @reduction_state == :FLAGS_REMOVED
         # Read and remove packet received time
         return :STOP if @data.length < 8
 

data/lib/openc3/interfaces.rb

@@ -14,21 +14,22 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2024, OpenC3, Inc.
+# All changes Copyright 2025, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 module OpenC3
-  autoload(:Interface, 'openc3/interfaces/interface.rb')
+  autoload(:FileInterface, 'openc3/interfaces/file_interface.rb')
   autoload(:HttpClientInterface, 'openc3/interfaces/http_client_interface.rb')
   autoload(:HttpServerInterface, 'openc3/interfaces/http_server_interface.rb')
+  autoload(:Interface, 'openc3/interfaces/interface.rb')
   autoload(:MqttInterface, 'openc3/interfaces/mqtt_interface.rb')
   autoload(:MqttStreamInterface, 'openc3/interfaces/mqtt_stream_interface.rb')
-  autoload(:StreamInterface, 'openc3/interfaces/stream_interface.rb')
   autoload(:SerialInterface, 'openc3/interfaces/serial_interface.rb')
   autoload(:SimulatedTargetInterface, 'openc3/interfaces/simulated_target_interface.rb')
+  autoload(:StreamInterface, 'openc3/interfaces/stream_interface.rb')
   autoload(:TcpipClientInterface, 'openc3/interfaces/tcpip_client_interface.rb')
   autoload(:TcpipServerInterface, 'openc3/interfaces/tcpip_server_interface.rb')
   autoload(:UdpInterface, 'openc3/interfaces/udp_interface.rb')

data/lib/openc3/logs/log_writer.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 2025, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -100,7 +100,8 @@ module OpenC3
       cycle_size = 1_000_000_000,
       cycle_hour = nil,
       cycle_minute = nil,
-      enforce_time_order = true
+      enforce_time_order = true,
+      cycle_thread: true
     )
       @remote_log_directory = remote_log_directory
       @logging_enabled = ConfigParser.handle_true_false(logging_enabled)
@@ -135,13 +136,15 @@ module OpenC3
       # each time we create an entry which we do a LOT!
       @entry = String.new
 
-      # Always make sure there is a cycle thread - (because it does trimming)
-      @@mutex.synchronize do
-        @@instances << self
+      if cycle_thread
+        # Always make sure there is a cycle thread - (because it does trimming)
+        @@mutex.synchronize do
+          @@instances << self
 
-        unless @@cycle_thread
-          @@cycle_thread = OpenC3.safe_thread("Log cycle") do
-            cycle_thread_body()
+          unless @@cycle_thread
+            @@cycle_thread = OpenC3.safe_thread("Log cycle") do
+              cycle_thread_body()
+            end
           end
         end
       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 2024, OpenC3, Inc.
+# All changes Copyright 2025, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -309,7 +309,7 @@ module OpenC3
         if cbor
           extra = CBOR.decode(extra_encoded)
         else
-          extra = JSON.parse(extra_encode, allow_nan: true, create_additions: true)
+          extra = JSON.parse(extra_encoded, allow_nan: true, create_additions: true)
         end
       end
       data = entry[next_offset..-1]

data/lib/openc3/logs/packet_log_writer.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 2025, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license

data/lib/openc3/microservices/interface_microservice.rb

@@ -40,7 +40,7 @@ require 'openc3/interfaces/interface'
 begin
   require 'openc3-enterprise/models/critical_cmd_model'
 rescue LoadError
-  # Should never actual be used in Open Source
+  # LoadError expected in COSMOS Core
 end
 
 module OpenC3

data/lib/openc3/microservices/microservice.rb

@@ -208,9 +208,10 @@ module OpenC3
       shutdown()
     end
 
-    def shutdown
+    def shutdown(state = 'STOPPED')
       return if @shutdown_complete
       @logger.info("Shutting down microservice: #{@name}")
+      @state = state
       @cancel_thread = true
       @microservice_status_sleeper.cancel if @microservice_status_sleeper
       MicroserviceStatusModel.set(as_json(:allow_nan => true), scope: @scope)

data/lib/openc3/models/model.rb

@@ -139,7 +139,7 @@ module OpenC3
 
     # Update the Redis hash at primary_key and set the field "name"
     # to the JSON generated via calling as_json
-    def create(update: false, force: false, queued: false)
+    def create(update: false, force: false, queued: false, isoformat: false)
       unless force
         existing = self.class.store.hget(@primary_key, @name)
         if existing
@@ -148,7 +148,11 @@ module OpenC3
           raise "#{@primary_key}:#{@name} doesn't exist at update" if update
         end
       end
-      @updated_at = Time.now.to_nsec_from_epoch
+      if isoformat
+        @updated_at = Time.now.utc.iso8601
+      else
+        @updated_at = Time.now.utc.to_nsec_from_epoch
+      end
 
       if queued
         write_store = self.class.store_queued

data/lib/openc3/models/script_status_model.rb

@@ -0,0 +1,242 @@
+# encoding: ascii-8bit
+
+# Copyright 2025 OpenC3, Inc.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU Affero General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# This file may also be used under the terms of a commercial license
+# if purchased from OpenC3, Inc.
+
+require 'openc3/models/model'
+
+module OpenC3
+  class ScriptStatusModel < Model
+    # Note: ScriptRunner only has permissions for keys that start with running-script
+    RUNNING_PRIMARY_KEY = 'running-script'
+    COMPLETED_PRIMARY_KEY = 'running-script-completed'
+
+    def id
+      return @name
+    end
+    attr_reader :state # spawning, init, running, paused, waiting, breakpoint, error, crashed, stopped, completed, completed_errors, killed
+    attr_accessor :shard
+    attr_accessor :filename
+    attr_accessor :current_filename
+    attr_accessor :line_no
+    attr_accessor :start_line_no
+    attr_accessor :end_line_no
+    attr_accessor :username
+    attr_accessor :user_full_name
+    attr_accessor :start_time
+    attr_accessor :end_time
+    attr_accessor :disconnect
+    attr_accessor :environment
+    attr_accessor :suite_runner
+    attr_accessor :errors
+    attr_accessor :pid
+    attr_accessor :log
+    attr_accessor :report
+
+    # 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:, type: "auto")
+      if type == "auto" or type == "running"
+        # Check for running first
+        running = super("#{RUNNING_PRIMARY_KEY}__#{scope}", name: name)
+        return running if running
+      end
+      return super("#{COMPLETED_PRIMARY_KEY}__#{scope}", name: name)
+    end
+
+    def self.names(scope:, type: "running")
+      if type == "running"
+        return super("#{RUNNING_PRIMARY_KEY}__#{scope}")
+      else
+        return super("#{COMPLETED_PRIMARY_KEY}__#{scope}")
+      end
+    end
+
+    def self.all(scope:, offset: 0, limit: 10, type: "running")
+      if type == "running"
+        keys = self.store.zrevrange("#{RUNNING_PRIMARY_KEY}__#{scope}__LIST", offset.to_i, offset.to_i + limit.to_i - 1)
+        return [] if keys.empty?
+        result = self.store.redis_pool.pipelined do
+          keys.each do |key|
+            self.store.hget("#{RUNNING_PRIMARY_KEY}__#{scope}", key)
+          end
+        end
+        result = result.map do |r|
+          if r.nil?
+            nil
+          else
+            JSON.parse(r, :allow_nan => true, :create_additions => true)
+          end
+        end
+        return result
+      else
+        keys = self.store.zrevrange("#{COMPLETED_PRIMARY_KEY}__#{scope}__LIST", offset.to_i, offset.to_i + limit.to_i - 1)
+        return [] if keys.empty?
+        result = self.store.redis_pool.pipelined do
+          keys.each do |key|
+            self.store.hget("#{COMPLETED_PRIMARY_KEY}__#{scope}", key)
+          end
+        end
+        result = result.map do |r|
+          if r.nil?
+            nil
+          else
+            JSON.parse(r, :allow_nan => true, :create_additions => true)
+          end
+        end
+        return result
+      end
+    end
+
+    def self.count(scope:, type: "running")
+      if type == "running"
+        return self.store.zcount("#{RUNNING_PRIMARY_KEY}__#{scope}__LIST", 0, Float::INFINITY)
+      else
+        return self.store.zcount("#{COMPLETED_PRIMARY_KEY}__#{scope}__LIST", 0, Float::INFINITY)
+      end
+    end
+
+    def initialize(
+      name:, # id
+      state:, # spawning, init, running, paused, waiting, error, breakpoint, crashed, stopped, completed, completed_errors, killed
+      shard: 0, # Future enhancement of script runner shards
+      filename:, # The initial filename
+      current_filename: nil, # The current filename
+      line_no: 0, # The current line number
+      start_line_no: 1, # The line number to start the script at
+      end_line_no: nil, # The line number to end the script at
+      username:, # The username of the person who started the script
+      user_full_name:, # The full name of the person who started the script
+      start_time:, # The time the script started ISO format
+      end_time: nil, # The time the script ended ISO format
+      disconnect: false,
+      environment: nil,
+      suite_runner: nil,
+      errors: nil,
+      pid: nil,
+      log: nil,
+      report: nil,
+      updated_at: nil,
+      scope:
+    )
+      @state = state
+      if is_complete?()
+        super("#{COMPLETED_PRIMARY_KEY}__#{scope}", name: name, updated_at: updated_at, plugin: nil, scope: scope)
+      else
+        super("#{RUNNING_PRIMARY_KEY}__#{scope}", name: name, updated_at: updated_at, plugin: nil, scope: scope)
+      end
+      @shard = shard.to_i
+      @filename = filename
+      @current_filename = current_filename
+      @line_no = line_no
+      @start_line_no = start_line_no
+      @end_line_no = end_line_no
+      @username = username
+      @user_full_name = user_full_name
+      @start_time = start_time
+      @end_time = end_time
+      @disconnect = disconnect
+      @environment = environment
+      @suite_runner = suite_runner
+      @errors = errors
+      @pid = pid
+      @log = log
+      @report = report
+    end
+
+    def is_complete?
+      return (@state == 'completed' or @state == 'completed_errors' or @state == 'stopped' or @state == 'crashed' or @state == 'killed')
+    end
+
+    def state=(new_state)
+      # If the state is already a flavor of complete, leave it alone (first wins)
+      if not is_complete?()
+        @state = new_state
+        # If setting to complete, check for errors
+        # and set the state to complete_errors if they exist
+        if @state == 'completed' and @errors
+          @state = 'completed_errors'
+        end
+      end
+    end
+
+    # Update the Redis hash at primary_key and set the field "name"
+    # to the JSON generated via calling as_json
+    def create(update: false, force: false, queued: false, isoformat: true)
+      @updated_at = Time.now.utc.to_nsec_from_epoch
+
+      if queued
+        write_store = self.class.store_queued
+      else
+        write_store = self.class.store
+      end
+      write_store.hset(@primary_key, @name, JSON.generate(self.as_json(:allow_nan => true), :allow_nan => true))
+
+      # Also add to ordered set on create
+      write_store.zadd(@primary_key + "__LIST", @name.to_i, @name) if not update
+    end
+
+    def update(force: false, queued: false)
+      # Magically handle the change from running to completed
+      if is_complete?() and @primary_key == "#{RUNNING_PRIMARY_KEY}__#{@scope}"
+        # Destroy the running key
+        destroy()
+        @destroyed = false
+
+        # Move to completed
+        @primary_key = "#{COMPLETED_PRIMARY_KEY}__#{@scope}"
+        create(update: false, force: force, queued: queued, isoformat: true)
+      else
+        create(update: true, force: force, queued: queued, isoformat: true)
+      end
+    end
+
+    # Delete the model from the Store
+    def destroy
+      @destroyed = true
+      undeploy()
+      self.class.store.hdel(@primary_key, @name)
+      # Also remove from ordered set
+      self.class.store.zremrangebyscore(@primary_key + "__LIST", @name.to_i, @name.to_i)
+    end
+
+    def as_json(*a)
+      {
+        'name' => @name,
+        'state' => @state,
+        'shard' => @shard,
+        'filename' => @filename,
+        'current_filename' => @current_filename,
+        'line_no' => @line_no,
+        'start_line_no' => @start_line_no,
+        'end_line_no' => @end_line_no,
+        'username' => @username,
+        'user_full_name' => @user_full_name,
+        'start_time' => @start_time,
+        'end_time' => @end_time,
+        'disconnect' => @disconnect,
+        'environment' => @environment,
+        'suite_runner' => @suite_runner,
+        'errors' => @errors,
+        'pid' => @pid,
+        'log' => @log,
+        'report' => @report,
+        'updated_at' => @updated_at,
+        'scope' => @scope
+      }
+    end
+  end
+end

data/lib/openc3/script/api_shared.rb

@@ -503,6 +503,10 @@ module OpenC3
       !cached
     end
 
+    def goto(line_no_or_procedure_name, line_no = nil)
+      raise "goto is not supported outside of ScriptRunner"
+    end
+
     # Require an additional ruby file
     def load_utility(procedure_name)
       return start(procedure_name)

data/lib/openc3/script/script_runner.rb

@@ -167,17 +167,17 @@ module OpenC3
       end
     end
 
-    def running_script_list(scope: $openc3_scope)
+    def running_script_list(limit: 10, offset: 0, scope: $openc3_scope)
       endpoint = "/script-api/running-script"
-      response = $script_runner_api_server.request('get', endpoint, scope: scope)
+      response = $script_runner_api_server.request('get', endpoint, query: {"limit" => limit, "offset" => offset}, scope: scope)
       if response.nil? || response.status != 200
         _script_response_error(response, "Running script list request failed", scope: scope)
       else
-        return JSON.parse(response.body, :allow_nan => true, :create_additions => true)
+        return JSON.parse(response.body, :allow_nan => true, :create_additions => true)['items']
       end
     end
 
-    def running_script_get(id, scope: $openc3_scope)
+    def script_get(id, scope: $openc3_scope)
       endpoint = "/script-api/running-script/#{id}"
       response = $script_runner_api_server.request('get', endpoint, scope: scope)
       if response.nil? || response.status != 200
@@ -186,6 +186,7 @@ module OpenC3
         return JSON.parse(response.body, :allow_nan => true, :create_additions => true)
       end
     end
+    alias running_script_get script_get # Deprecated alias for compatibility
 
     def _running_script_action(id, action_name, scope: $openc3_scope)
       endpoint = "/script-api/running-script/#{id}/#{action_name}"
@@ -249,13 +250,27 @@ module OpenC3
       end
     end
 
-    def completed_script_list(scope: $openc3_scope)
+    def running_script_execute_while_paused(id, filename, line_no, end_line_no = nil, scope: $openc3_scope)
+      endpoint = "/script-api/running-script/#{id}/executewhilepaused"
+      if end_line_no
+        response = $script_runner_api_server.request('post', endpoint, json: true, data: {'args' => [filename, line_no, end_line_no]}, scope: scope)
+      else
+        response = $script_runner_api_server.request('post', endpoint, json: true, data: {'args' => [filename, line_no]}, scope: scope)
+      end
+      if response.nil? || response.status != 200
+        _script_response_error(response, "Running script executewhilepaused request failed", scope: scope)
+      else
+        return true
+      end
+    end
+
+    def completed_script_list(limit: 10, offset: 0, scope: $openc3_scope)
       endpoint = "/script-api/completed-scripts"
-      response = $script_runner_api_server.request('get', endpoint, scope: scope)
+      response = $script_runner_api_server.request('get', endpoint, query: {"limit" => limit, "offset" => offset}, scope: scope)
       if response.nil? || response.status != 200
         _script_response_error(response, "Completed script list request failed", scope: scope)
       else
-        return JSON.parse(response.body, :allow_nan => true, :create_additions => true)
+        return JSON.parse(response.body, :allow_nan => true, :create_additions => true)['items']
       end
     end
   end

data/lib/openc3/utilities/authentication.rb

@@ -29,7 +29,7 @@ module OpenC3
   class OpenC3AuthenticationError < StandardError; end
   class OpenC3AuthenticationRetryableError < OpenC3AuthenticationError; end
 
-  # OpenC3 base / open source authentication code
+  # OpenC3 COSMOS Core authentication code
   class OpenC3Authentication
     def initialize()
       @token = ENV['OPENC3_API_PASSWORD']

data/lib/openc3/utilities/cosmos_rails_formatter.rb

@@ -29,7 +29,7 @@ module OpenC3
             user = {}
           end
           username = user['username']
-          # Open Source username (EE has the actual username)
+          # Core username (EE has the actual username)
           username ||= 'anonymous'
         end
       end

data/lib/openc3/utilities/message_log.rb

@@ -64,6 +64,7 @@ module OpenC3
 
     # Closes the message log and marks it read only
     def stop(take_mutex = true, metadata: {})
+      bucket_key = nil
       @mutex.lock if take_mutex
       if @file and not @file.closed?
         @file.close
@@ -77,6 +78,7 @@ module OpenC3
         end
       end
       @mutex.unlock if take_mutex
+      return bucket_key
     end
 
     # Creates a new message log and sets the filename

data/lib/openc3/utilities/metric.rb

@@ -133,5 +133,5 @@ end
 begin
   require 'openc3-enterprise/utilities/metric'
 rescue LoadError
-  # Open Source Edition - Do nothing here
+  # LoadError expected in COSMOS Core
 end

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '6.3.0'
+OPENC3_VERSION = '6.4.0'
 module OpenC3
   module Version
     MAJOR = '6'
-    MINOR = '3'
+    MINOR = '4'
     PATCH = '0'
     OTHER = ''
-    BUILD = '52f29bf512b463d226b93d18f31aa71936d472b2'
+    BUILD = '7f674e6c8a5d1e77fc64182365b831a17751b78d'
   end
-  VERSION = '6.3.0'
-  GEM_VERSION = '6.3.0'
+  VERSION = '6.4.0'
+  GEM_VERSION = '6.4.0'
 end

data/templates/tool_angular/package.json

@@ -1,6 +1,6 @@
 {
   "name": "<%= tool_name %>",
-  "version": "6.3.0",
+  "version": "6.4.0",
   "scripts": {
     "ng": "ng",
     "start": "ng serve",
@@ -23,7 +23,7 @@
     "@angular/platform-browser-dynamic": "^18.2.6",
     "@angular/router": "^18.2.6",
     "@astrouxds/astro-web-components": "^7.24.0",
-    "@openc3/js-common": "6.3.0",
+    "@openc3/js-common": "6.4.0",
     "rxjs": "~7.8.0",
     "single-spa": "^5.9.5",
     "single-spa-angular": "^9.2.0",

data/templates/tool_react/package.json

@@ -16,7 +16,7 @@
     "@emotion/react": "^11.13.3",
     "@emotion/styled": "^11.11.0",
     "@mui/material": "^6.1.1",
-    "@openc3/js-common": "6.3.0",
+    "@openc3/js-common": "6.4.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "single-spa-react": "^5.1.4"

data/templates/tool_svelte/package.json

@@ -12,7 +12,7 @@
   },
   "dependencies": {
     "@astrouxds/astro-web-components": "^7.24.0",
-    "@openc3/js-common": "6.3.0",
+    "@openc3/js-common": "6.4.0",
     "@smui/button": "^7.0.0",
     "@smui/common": "^7.0.0",
     "@smui/card": "^7.0.0",

data/templates/tool_vue/eslint.config.mjs

@@ -1,30 +1,11 @@
-import prettier from 'eslint-plugin-prettier'
-import globals from 'globals'
-import parser from 'vue-eslint-parser'
-import path from 'node:path'
-import { fileURLToPath } from 'node:url'
-import js from '@eslint/js'
-import { FlatCompat } from '@eslint/eslintrc'
-
-const __filename = fileURLToPath(import.meta.url)
-const __dirname = path.dirname(__filename)
-const compat = new FlatCompat({
-  baseDirectory: __dirname,
-  recommendedConfig: js.configs.recommended,
-  allConfig: js.configs.all,
-})
+import prettierConfig from "@vue/eslint-config-prettier"
+import pluginVue from "eslint-plugin-vue"
+import globals from "globals"
+import parser from "vue-eslint-parser"
 
 export default [
-  ...compat.extends(
-    'plugin:vue/vue3-essential',
-    'plugin:prettier/recommended',
-    '@vue/prettier',
-  ),
+  ...pluginVue.configs['flat/recommended'],
   {
-    plugins: {
-      prettier,
-    },
-
     languageOptions: {
       globals: {
         ...globals.node,
@@ -32,32 +13,26 @@ export default [
 
       parser: parser,
       ecmaVersion: 2022,
-      sourceType: 'module',
+      sourceType: "module",
     },
 
     rules: {
-      'no-console': 'error',
-      'no-debugger': 'error',
+      "no-console": "error",
+      "no-debugger": "error",
 
-      'prettier/prettier': [
-        'warn',
-        {
-          endOfLine: 'auto',
-        },
-      ],
+      "prettier/prettier": ["warn", {
+        endOfLine: "auto",
+      }],
 
-      'vue/multi-word-component-names': 'off',
+      "vue/multi-word-component-names": "off",
 
-      'vue/valid-v-slot': [
-        'error',
-        {
-          allowModifiers: true,
-        },
-      ],
+      "vue/valid-v-slot": ["error", {
+        allowModifiers: true,
+      }],
     },
   },
   {
-    files: ['**/__tests__/*.{j,t}s?(x)', '**/tests/unit/**/*.spec.{j,t}s?(x)'],
+    files: ["**/__tests__/*.{j,t}s?(x)", "**/tests/unit/**/*.spec.{j,t}s?(x)"],
 
     languageOptions: {
       globals: {
@@ -65,4 +40,5 @@ export default [
       },
     },
   },
+  prettierConfig,
 ]

data/templates/tool_vue/package.json

@@ -1,6 +1,6 @@
 {
   "name": "<%= tool_name %>",
-  "version": "6.3.0",
+  "version": "6.4.0",
   "private": true,
   "type": "module",
   "scripts": {
@@ -11,8 +11,8 @@
   },
   "dependencies": {
     "@astrouxds/astro-web-components": "^7.24.0",
-    "@openc3/js-common": "6.3.0",
-    "@openc3/vue-common": "6.3.0",
+    "@openc3/js-common": "6.4.0",
+    "@openc3/vue-common": "6.4.0",
     "axios": "^1.7.7",
     "date-fns": "^4.1.0",
     "lodash": "^4.17.21",

data/templates/widget/package.json

@@ -1,6 +1,6 @@
 {
   "name": "<%= widget_name %>",
-  "version": "6.3.0",
+  "version": "6.4.0",
   "private": true,
   "type": "module",
   "scripts": {
@@ -8,7 +8,7 @@
   },
   "dependencies": {
     "@astrouxds/astro-web-components": "^7.24.0",
-    "@openc3/vue-common": "6.3.0",
+    "@openc3/vue-common": "6.4.0",
     "vuetify": "^3.7.1"
   },
   "devDependencies": {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openc3
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 6.4.0
 platform: ruby
 authors:
 - Ryan Melton
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement
@@ -1033,6 +1033,7 @@ files:
 - lib/openc3/models/router_model.rb
 - lib/openc3/models/router_status_model.rb
 - lib/openc3/models/scope_model.rb
+- lib/openc3/models/script_status_model.rb
 - lib/openc3/models/secret_model.rb
 - lib/openc3/models/setting_model.rb
 - lib/openc3/models/sorted_model.rb
@@ -1284,7 +1285,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.8
 specification_version: 4
 summary: OpenC3
 test_files: []