openc3 7.1.1 → 7.2.0

data/lib/openc3/utilities/questdb_client.rb

@@ -511,9 +511,14 @@ module OpenC3
     # @param value_type [Symbol] :RAW or :CONVERTED
     # @param item_name [String, nil] Original (unsanitized) item name for mapping values.
     #   Defaults to safe_item_name if not provided.
+    # @param existing_columns [Hash{String=>String}, nil] Map of column name to QuestDB
+    #   column type for the table. When provided and a converted (__C) column is absent or
+    #   non-numeric (e.g. a states column stored as VARCHAR), CONVERTED aggregation falls
+    #   back to the raw column (mirrors the non-reduced read path). When nil, no fallback
+    #   check is performed.
     # @return [Array<String>, Hash] Two-element array: [select_fragments, column_mapping]
     #   column_mapping maps result column alias to [item_name, reduced_type, value_type]
-    def self.build_aggregation_selects(safe_item_name, value_type, item_name: nil)
+    def self.build_aggregation_selects(safe_item_name, value_type, item_name: nil, existing_columns: nil)
       item_name ||= safe_item_name
       selects = []
       mapping = {}
@@ -526,7 +531,17 @@ module OpenC3
           mapping[alias_name] = [item_name, reduced_type, :RAW]
         end
       when :CONVERTED
-        col = "#{safe_item_name}__C"
+        # The converted (__C) column only exists, and is only numerically aggregatable, when
+        # the item has a numeric conversion. When it is absent (e.g. POSPROGRESS, which only
+        # has a raw and __F column) or non-numeric (e.g. a states column stored as VARCHAR),
+        # aggregate the raw column instead, matching the CONVERTED fallback in
+        # decode_packet_row/JsonPacket#read.
+        converted_col = "#{safe_item_name}__C"
+        col = if existing_columns.nil? || numeric_column_type?(existing_columns[converted_col])
+          converted_col
+        else
+          safe_item_name
+        end
         { 'CN' => :MIN, 'CX' => :MAX, 'CA' => :AVG, 'CS' => :STDDEV }.each do |suffix, reduced_type|
           alias_name = "#{safe_item_name}__#{suffix}"
           selects << "#{reduced_type.to_s.downcase}(\"#{col}\") as \"#{alias_name}\""
@@ -544,9 +559,11 @@ module OpenC3
     #
     # @param packet_def [Hash, nil] Packet definition from TargetModel.packet
     # @param value_type [Symbol] :RAW or :CONVERTED
+    # @param existing_columns [Set<String>, nil] Column names that actually exist in the
+    #   table, used for CONVERTED-to-raw fallback (see build_aggregation_selects).
     # @return [Array<String>, Boolean] Two-element array: [select_fragments, has_numeric_items]
     #   select_fragments includes TIMESTAMP_SELECT as the first element.
-    def self.build_packet_reduced_selects(packet_def, value_type)
+    def self.build_packet_reduced_selects(packet_def, value_type, existing_columns: nil)
       selects = [TIMESTAMP_SELECT]
       has_items = false
       return [selects, false] unless packet_def && packet_def['items']
@@ -558,7 +575,7 @@ module OpenC3
         next unless value_type == :RAW || value_type == :CONVERTED
 
         safe_name = sanitize_column_name(item['name'])
-        agg_selects, _mapping = build_aggregation_selects(safe_name, value_type)
+        agg_selects, _mapping = build_aggregation_selects(safe_name, value_type, existing_columns: existing_columns)
         selects.concat(agg_selects)
         has_items = true
       end
@@ -615,6 +632,36 @@ module OpenC3
       false
     end
 
+    # QuestDB column types that can be aggregated with min/max/avg/stddev.
+    # Used by reduced queries to decide whether a converted (__C) column is
+    # numeric or must fall back to the raw column (e.g. states stored as VARCHAR).
+    NUMERIC_COLUMN_TYPES = Set.new(['BYTE', 'SHORT', 'INT', 'LONG', 'FLOAT', 'DOUBLE']).freeze
+
+    # Return true if the given QuestDB column type can be numerically aggregated.
+    #
+    # @param column_type [String, nil] QuestDB column type (e.g. 'DOUBLE', 'VARCHAR')
+    # @return [Boolean]
+    def self.numeric_column_type?(column_type)
+      !column_type.nil? && NUMERIC_COLUMN_TYPES.include?(column_type.to_s.upcase)
+    end
+
+    # Return a hash mapping column name to QuestDB column type for a table.
+    # Used by reduced queries to fall back to raw columns when a converted
+    # (__C) column was never created (e.g. items with no read_conversion) or
+    # is non-numeric (e.g. states stored as VARCHAR).
+    #
+    # @param table_name [String] Sanitized table name
+    # @return [Hash{String=>String}, nil] { column_name => column_type }, or nil if
+    #   the table does not exist or the schema cannot be queried
+    def self.table_columns(table_name, db_shard: 0)
+      result = query_with_retry("SHOW COLUMNS FROM \"#{table_name}\"", max_retries: 1, label: "show columns", db_shard: db_shard)
+      return nil unless result
+      # SHOW COLUMNS returns rows of [column, type, ...]
+      result.values.each_with_object({}) { |row, hash| hash[row[0]] = row[1] }
+    rescue StandardError
+      nil
+    end
+
     # Execute a paginated TSDB query, yielding each non-empty PG::Result page.
     # Handles LIMIT pagination and retry on error.
     #

data/lib/openc3/utilities/running_script.rb

@@ -45,6 +45,21 @@ if not defined? RAILS_ROOT
 end
 
 SCRIPT_API = 'script-api'
+# Per-script frontend channel events are mirrored into a short-lived Redis
+# stream so RunningScriptChannel can serve both the backlog (events published
+# before a client subscribed -- the anycable broadcast is pub/sub with no
+# history) and the live feed from a single ordered source. MAXLEN bounds
+# memory; the TTL is refreshed on every write so the stream lives while the
+# script runs and is auto-removed by Redis shortly after the last event -- no
+# explicit cleanup is needed for completion, crash, or an orphaned/killed
+# process.
+RUNNING_SCRIPT_CHANNEL_PREFIX = 'running-script-channel:'
+RUNNING_SCRIPT_REPLAY_MAXLEN = 1000
+RUNNING_SCRIPT_REPLAY_TTL = 86400 # seconds
+# Flush the replay queue quickly so live output/state stays near real-time while
+# remaining non-blocking. Applied via set_update_interval in RunningScript's
+# initialize so it only affects this (running script) process.
+RUNNING_SCRIPT_REPLAY_FLUSH_INTERVAL = 0.1 # seconds
 
 def running_script_publish(channel_name, data)
   stream_name = [SCRIPT_API, channel_name].compact.join(":")
@@ -52,9 +67,27 @@ def running_script_publish(channel_name, data)
 end
 
 def running_script_anycable_publish(channel_name, data)
-  stream_name = [SCRIPT_API, channel_name].compact.join(":")
-  stream_data = {"stream" => stream_name, "data" => JSON.generate(data, allow_nan: true)}
-  OpenC3::Store.publish("__anycable__", JSON.generate(stream_data, allow_nan: true))
+  json = JSON.generate(data, allow_nan: true)
+  if channel_name.start_with?(RUNNING_SCRIPT_CHANNEL_PREFIX)
+    # Per-script events are delivered to the frontend by RunningScriptChannel
+    # tailing this replay stream (backlog + live from a single ordered source),
+    # so they are NOT broadcast over anycable pub/sub -- doing both would deliver
+    # every message twice. Queued (EphemeralStoreQueued) so the script never
+    # blocks on Redis; best-effort so a replay failure can never affect script
+    # execution. Topic (read by the channel) uses the EphemeralStore.
+    begin
+      replay_key = "#{channel_name}:replay"
+      OpenC3::EphemeralStoreQueued.instance.write_topic(replay_key, { 'data' => json }, '*', RUNNING_SCRIPT_REPLAY_MAXLEN, '~')
+      OpenC3::EphemeralStoreQueued.instance.expire(replay_key, RUNNING_SCRIPT_REPLAY_TTL)
+    rescue StandardError => e
+      OpenC3::Logger.warn("running_script replay write failed: #{e.message}") rescue nil
+    end
+  else
+    # Other channels (all-scripts, etc.) are still delivered live over pub/sub.
+    stream_name = [SCRIPT_API, channel_name].compact.join(":")
+    stream_data = {"stream" => stream_name, "data" => json}
+    OpenC3::Store.publish("__anycable__", JSON.generate(stream_data, allow_nan: true))
+  end
 end
 
 module OpenC3
@@ -536,6 +569,11 @@ class RunningScript
 
   def initialize(script_status)
     @@instance = self
+    # Flush the replay queue (used by running_script_anycable_publish) quickly so
+    # live output/state stays near real-time. Set explicitly here so the interval
+    # is applied even if the queue instance was already created. Only affects
+    # this running-script process.
+    OpenC3::EphemeralStoreQueued.instance.set_update_interval(RUNNING_SCRIPT_REPLAY_FLUSH_INTERVAL)
     @script_status = script_status
     @script_status.pid = Process.pid
     @user_input = ''

data/lib/openc3/utilities/simulated_target.rb

@@ -44,8 +44,10 @@ module OpenC3
       @tlm_packets.each do |name, packet|
         packet.restore_defaults
         ids = packet.id_items
-        ids.each do |id|
-          packet.public_send((id.name + '=').to_sym, id.id_value)
+        if ids
+          ids.each do |id|
+            packet.public_send((id.name + '=').to_sym, id.id_value)
+          end
         end
       end
 

data/lib/openc3/version.rb

@@ -1,14 +1,14 @@
 # encoding: ascii-8bit
 
-OPENC3_VERSION = '7.1.1'
+OPENC3_VERSION = '7.2.0'
 module OpenC3
   module Version
     MAJOR = '7'
-    MINOR = '1'
-    PATCH = '1'
+    MINOR = '2'
+    PATCH = '0'
     OTHER = ''
-    BUILD = '1c377442111a2b1801fb5c6b49a27d604e2cce55'
+    BUILD = '57bc6819061782287e6e4c866874e13853dc6b40'
   end
-  VERSION = '7.1.1'
-  GEM_VERSION = '7.1.1'
+  VERSION = '7.2.0'
+  GEM_VERSION = '7.2.0'
 end

data/templates/command_validator/command_validator.py

@@ -1,24 +1,22 @@
 from openc3.packets.command_validator import CommandValidator
 # Using the OpenC3 API requires the following imports:
-# from openc3.api import wait_check
+from openc3.api import tlm, wait_check
 
 # Custom command validator class
 # See https://docs.openc3.com/docs/configuration/command
 class <%= validator_class %>(CommandValidator):
-    def __init__(self, *args):
-        super().__init__()
-        self.args = args
-
     # Called before a command is sent
-    # @param command [dict] The command dictionary containing all the command details
+    # @param command [Packet] The command object containing all the command details
     # @return [list] First element is True/False/None for success/failure/unknown,
     #   second element is an optional message string
     def pre_check(self, command):
         # Add your pre-command validation logic here
         # Example:
-        # target_name = command['target_name']
-        # command_name = command['cmd_name']
-        # params = command['cmd_params']
+        # target_name = command.target_name
+        # command_name = command.packet_name
+        # for item_name, item_def in command.items.items():
+        #     item_value = command.read(item_name)
+
         # self.count = tlm("TARGET PACKET COUNT")
         #
         # if some_condition:
@@ -29,7 +27,7 @@ class <%= validator_class %>(CommandValidator):
         return [True, None]
 
     # Called after a command is sent
-    # @param command [dict] The command dictionary containing all the command details
+    # @param command [Packet] The command object containing all the command details
     # @return [list] First element is True/False/None for success/failure/unknown,
     #   second element is an optional message string
     def post_check(self, command):

data/templates/command_validator/command_validator.rb

@@ -5,21 +5,18 @@ module OpenC3
   # Custom command validator class
   # See https://docs.openc3.com/docs/configuration/command
   class <%= validator_class %> < CommandValidator
-    def initialize(*args)
-      super()
-      @args = args
-    end
-
     # Called before a command is sent
-    # @param command [Hash] The command hash containing all the command details
+    # @param command [Packet] The command object containing all the command details
     # @return [Array<Boolean, String>] First element is true/false/nil for success/failure/unknown,
     #   second element is an optional message string
     def pre_check(command)
       # Add your pre-command validation logic here
       # Example:
-      # target_name = command['target_name']
-      # command_name = command['cmd_name']
-      # params = command['cmd_params']
+      # target_name = command.target_name
+      # command_name = command.packet_name
+      # command.items.each do |item_name, item_def|
+      #   item_value = command.read(item_name)
+      # end
       # @count = tlm("TARGET PACKET COUNT")
       #
       # if some_condition

data/templates/plugin/LICENSE.md

@@ -1,7 +1,19 @@
-Copyright 2023 <COPYRIGHT HOLDER>
+Copyright 2026 <COPYRIGHT HOLDER>
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to 
+deal in the Software without restriction, including without limitation the 
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or 
+sell copies of the Software, and to permit persons to whom the Software is 
+furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in 
+all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
+DEALINGS IN THE SOFTWARE.

data/templates/tool_angular/package.json

@@ -1,6 +1,6 @@
 {
   "name": "<%= tool_name %>",
-  "version": "7.1.1",
+  "version": "7.2.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": "7.1.1",
+    "@openc3/js-common": "7.2.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": "7.1.1",
+    "@openc3/js-common": "7.2.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": "7.1.1",
+    "@openc3/js-common": "7.2.0",
     "@smui/button": "^7.0.0",
     "@smui/common": "^7.0.0",
     "@smui/card": "^7.0.0",

data/templates/tool_vue/package.json

@@ -1,6 +1,6 @@
 {
   "name": "<%= tool_name %>",
-  "version": "7.1.1",
+  "version": "7.2.0",
   "private": true,
   "type": "module",
   "scripts": {
@@ -11,8 +11,8 @@
   },
   "dependencies": {
     "@astrouxds/astro-web-components": "^7.24.0",
-    "@openc3/js-common": "7.1.1",
-    "@openc3/vue-common": "7.1.1",
+    "@openc3/js-common": "7.2.0",
+    "@openc3/vue-common": "7.2.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": "7.1.1",
+  "version": "7.2.0",
   "private": true,
   "type": "module",
   "scripts": {
@@ -8,7 +8,7 @@
   },
   "dependencies": {
     "@astrouxds/astro-web-components": "^7.24.0",
-    "@openc3/vue-common": "7.1.1",
+    "@openc3/vue-common": "7.2.0",
     "vuetify": "^3.7.1"
   },
   "devDependencies": {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openc3
 version: !ruby/object:Gem::Version
-  version: 7.1.1
+  version: 7.2.0
 platform: ruby
 authors:
 - Ryan Melton