openc3 5.11.3 → 5.13.0

data/lib/openc3/microservices/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 2023, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -79,7 +79,7 @@ module OpenC3
     end
 
     def initialize(name, is_plugin: false)
-      Logger.info("Microservice running from: ruby #{$0} #{ARGV.join(" ")}")
+      @shutdown_complete = false
       raise "Microservice must be named" unless name
 
       @name = name
@@ -120,6 +120,7 @@ module OpenC3
       # Get configuration for any targets
       @target_names = @config["target_names"]
       @target_names ||= []
+      # NOTE: setup_targets doesn't do anything if @target_names is empty
       System.setup_targets(@target_names, @temp_dir, scope: @scope) unless is_plugin
 
       # Use at_exit to shutdown cleanly no matter how we die
@@ -199,6 +200,7 @@ module OpenC3
     end
 
     def shutdown
+      return if @shutdown_complete
       @logger.info("Shutting down microservice: #{@name}")
       @cancel_thread = true
       @microservice_status_sleeper.cancel if @microservice_status_sleeper
@@ -206,6 +208,7 @@ module OpenC3
       FileUtils.remove_entry(@temp_dir) if File.exist?(@temp_dir)
       @metric.shutdown
       @logger.info("Shutting down microservice complete: #{@name}")
+      @shutdown_complete = true
     end
   end
 end

data/lib/openc3/microservices/reaction_microservice.rb

@@ -229,6 +229,7 @@ module OpenC3
 
     def get_token(username)
       if ENV['OPENC3_API_CLIENT'].nil?
+        ENV['OPENC3_API_PASSWORD'] ||= ENV['OPENC3_SERVICE_PASSWORD']
         return OpenC3Authentication.new().token
       else
         # Check for offline access token

data/lib/openc3/microservices/timeline_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 2023, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -43,6 +43,7 @@ module OpenC3
 
     def get_token(username)
       if ENV['OPENC3_API_CLIENT'].nil?
+        ENV['OPENC3_API_PASSWORD'] ||= ENV['OPENC3_SERVICE_PASSWORD']
         return OpenC3Authentication.new().token
       else
         # Check for offline access token
@@ -125,7 +126,8 @@ module OpenC3
 
     def clear_expired(activity)
       begin
-        ActivityModel.range_destroy(name: @timeline_name, scope: @scope, min: activity.start, max: activity.stop)
+        num = ActivityModel.range_destroy(name: @timeline_name, scope: @scope, min: activity.start, max: activity.stop)
+        @logger.info "#{@timeline_name} clear_expired removed #{num} items from #{activity.start} to #{activity.stop}"
         activity.add_event(status: 'completed')
       rescue StandardError => e
         @logger.error "#{@timeline_name} clear_expired failed > #{activity.as_json(:allow_nan => true)} #{e.message}"
@@ -231,15 +233,15 @@ module OpenC3
       @logger.info "#{@timeline_name} timeine manager exiting"
     end
 
-    # Add task to remove events older than 7 time
+    # Add task to remove events older than 7 days
     def add_expire_activity
       now = Time.now.to_i
       @expire = now + 3_000
       activity = ActivityModel.new(
         name: @timeline_name,
         scope: @scope,
-        start: (now - 86_400 * 7),
-        stop: (now - 82_800 * 7),
+        start: 0,
+        stop: (now - 86_400 * 7),
         kind: 'EXPIRE',
         data: {}
       )

data/lib/openc3/microservices/trigger_group_microservice.rb

@@ -333,7 +333,8 @@ module OpenC3
       )
       return nil if packet.nil?
       _, limit = packet.read_with_limits_state(operand[ITEM_TYPE], operand[ITEM_VALUE_TYPE].intern)
-      return limit
+      # Convert limit symbol to string since we'll be comparing with strings
+      return limit.to_s
     end
 
     # extract the value outlined in the operand to get the packet item value

data/lib/openc3/migrations/20231022000000_tlm_viewer_config.rb

@@ -0,0 +1,22 @@
+require 'openc3/utilities/migration'
+require 'openc3/models/tool_config_model'
+
+module OpenC3
+  class TlmViewerConfig < Migration
+    def self.run
+      ScopeModel.names.each do |scope|
+        # Get all existing ToolConfigModels and change keys from tlm_viewer to telemetry_viewer
+        names = ToolConfigModel.list_configs('tlm_viewer')
+        names.each do |name|
+          config = ToolConfigModel.load_config('tlm_viewer', name)
+          ToolConfigModel.save_config('telemetry_viewer', name, config)
+          ToolConfigModel.delete_config('tlm_viewer', name)
+        end
+      end
+    end
+  end
+end
+
+unless ENV['OPENC3_NO_MIGRATE']
+  OpenC3::TlmViewerConfig.run
+end

data/lib/openc3/models/activity_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 2023, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -94,13 +94,31 @@ module OpenC3
     # Remove one member from a sorted set.
     # @return [Integer] count of the members removed
     def self.destroy(name:, scope:, score:)
-      Store.zremrangebyscore("#{scope}#{PRIMARY_KEY}__#{name}", score, score)
+      result = Store.zremrangebyscore("#{scope}#{PRIMARY_KEY}__#{name}", score, score)
+      notification = {
+        # start / stop to match SortedModel
+        'data' => JSON.generate({'start' => score}),
+        'kind' => 'deleted',
+        'type' => 'activity',
+        'timeline' => name
+      }
+      TimelineTopic.write_activity(notification, scope: scope)
+      return result
     end
 
     # Remove members from min to max of the sorted set.
     # @return [Integer] count of the members removed
     def self.range_destroy(name:, scope:, min:, max:)
-      Store.zremrangebyscore("#{scope}#{PRIMARY_KEY}__#{name}", min, max)
+      result = Store.zremrangebyscore("#{scope}#{PRIMARY_KEY}__#{name}", min, max)
+      notification = {
+        # start / stop to match SortedModel
+        'data' => JSON.generate({'start' => min, 'stop' => max}),
+        'kind' => 'deleted',
+        'type' => 'activity',
+        'timeline' => name
+      }
+      TimelineTopic.write_activity(notification, scope: scope)
+      return result
     end
 
     # @return [ActivityModel] Model generated from the passed JSON

data/lib/openc3/models/cvt_model.rb

@@ -237,10 +237,11 @@ module OpenC3
       end
 
       tgt_pkt_key = "#{scope}__tlm__#{target_name}__#{packet_name}"
-      @@override_cache[tgt_pkt_key] = [Time.now, hash]
       if hash.empty?
+        @@override_cache.delete(tgt_pkt_key)
         Store.hdel("#{scope}__override__#{target_name}", packet_name)
       else
+        @@override_cache[tgt_pkt_key] = [Time.now, hash]
         Store.hset("#{scope}__override__#{target_name}", packet_name, JSON.generate(hash.as_json(:allow_nan => true)))
       end
     end

data/lib/openc3/models/gem_model.rb

@@ -27,6 +27,7 @@ require 'rubygems'
 require 'rubygems/uninstaller'
 require 'tempfile'
 require 'openc3/utilities/process_manager'
+require 'openc3/api/api'
 require 'pathname'
 
 module OpenC3
@@ -35,6 +36,8 @@ module OpenC3
   # and destroy to allow interaction with gem files from the PluginModel and
   # the GemsController.
   class GemModel
+    include Api
+
     def self.names
       result = Pathname.new("#{ENV['GEM_HOME']}/gems").children.select { |c| c.directory? }.collect { |p| File.basename(p) + '.gem' }
       return result.sort
@@ -53,7 +56,7 @@ module OpenC3
         FileUtils.cp(gem_file_path, "#{ENV['GEM_HOME']}/cache/#{File.basename(gem_file_path)}")
         if gem_install
           Logger.info "Installing gem: #{gem_filename}"
-          result = OpenC3::ProcessManager.instance.spawn(["ruby", "/openc3/bin/openc3cli", "geminstall", gem_filename, scope], "gem_install", gem_filename, Time.now + 3600.0, scope: scope)
+          result = OpenC3::ProcessManager.instance.spawn(["ruby", "/openc3/bin/openc3cli", "geminstall", gem_filename, scope], "package_install", gem_filename, Time.now + 3600.0, scope: scope)
           return result.name
         end
       else

data/lib/openc3/models/interface_model.rb

@@ -145,7 +145,13 @@ module OpenC3
       unless @cmd
         type = self.class._get_type
         microservice_name = "#{@scope}__#{type}__#{@name}"
-        @cmd = ["ruby", "#{type.downcase}_microservice.rb", microservice_name]
+        if config_params[0] and File.extname(config_params[0]) == '.py'
+          work_dir.sub!('openc3/lib', 'openc3/python')
+          @cmd = ["python", "#{type.downcase}_microservice.py", microservice_name]
+        else
+          # If there are no config_params we assume ruby
+          @cmd = ["ruby", "#{type.downcase}_microservice.rb", microservice_name]
+        end
       end
       @work_dir = work_dir
       @ports = ports
@@ -417,7 +423,7 @@ module OpenC3
       # Respawn the microservice
       type = self.class._get_type
       microservice_name = "#{@scope}__#{type}__#{@name}"
-      microservice = MicroserviceModel.get_model(name: microservice_name, scope: scope)
+      microservice = MicroserviceModel.get_model(name: microservice_name, scope: @scope)
       microservice.target_names.delete(target_name) unless @target_names.include?(target_name)
       microservice.update
     end
@@ -432,11 +438,11 @@ module OpenC3
 
       if unmap_old
         # Remove from old interface
-        all_interfaces = InterfaceModel.all(scope: scope)
+        all_interfaces = InterfaceModel.all(scope: @scope)
         old_interface = nil
         all_interfaces.each do |old_interface_name, old_interface_details|
           if old_interface_details['target_names'].include?(target_name)
-            old_interface = InterfaceModel.from_json(old_interface_details, scope: scope)
+            old_interface = InterfaceModel.from_json(old_interface_details, scope: @scope)
             old_interface.unmap_target(target_name, cmd_only: cmd_only, tlm_only: tlm_only) if old_interface
           end
         end
@@ -451,7 +457,7 @@ module OpenC3
       # Respawn the microservice
       type = self.class._get_type
       microservice_name = "#{@scope}__#{type}__#{@name}"
-      microservice = MicroserviceModel.get_model(name: microservice_name, scope: scope)
+      microservice = MicroserviceModel.get_model(name: microservice_name, scope: @scope)
       microservice.target_names << target_name unless microservice.target_names.include?(target_name)
       microservice.update
     end

data/lib/openc3/models/metadata_model.rb

@@ -33,6 +33,17 @@ module OpenC3
       "#{scope}#{PRIMARY_KEY}"
     end
 
+    def self.notify(scope:, kind:, start:, stop: nil)
+      json = {'type' => METADATA_TYPE, 'start' => start}
+      json['stop'] = stop if stop
+      notification = {
+        'data' => JSON.generate(json),
+        'kind' => kind,
+        'type' => 'calendar',
+      }
+      CalendarTopic.write_entry(notification, scope: scope)
+    end
+
     attr_reader :color, :metadata, :constraints, :type
 
     # @param [Integer] start - Time metadata is active in seconds from Epoch

data/lib/openc3/models/microservice_model.rb

@@ -42,6 +42,7 @@ module OpenC3
     attr_accessor :parent
     attr_accessor :secrets
     attr_accessor :prefix
+    attr_accessor :disable_erb
 
     # NOTE: The following three class methods are used by the ModelController
     # and are reimplemented to enable various Model class methods to work
@@ -101,6 +102,7 @@ module OpenC3
       needs_dependencies: false,
       secrets: [],
       prefix: nil,
+      disable_erb: nil,
       scope:
     )
       parts = name.split("__")
@@ -125,6 +127,7 @@ module OpenC3
       @needs_dependencies = needs_dependencies
       @secrets = secrets
       @prefix = prefix
+      @disable_erb = disable_erb
       @bucket = Bucket.getClient()
     end
 
@@ -145,7 +148,8 @@ module OpenC3
         'plugin' => @plugin,
         'needs_dependencies' => @needs_dependencies,
         'secrets' => @secrets.as_json(*a),
-        'prefix' => @prefix
+        'prefix' => @prefix,
+        'disable_erb' => @disable_erb
       }
     end
 
@@ -201,6 +205,12 @@ module OpenC3
       when 'ROUTE_PREFIX'
         parser.verify_num_parameters(1, 1, "#{keyword} <Route Prefix>")
         @prefix = parameters[0]
+      when 'DISABLE_ERB'
+        # 0 to unlimited parameters
+        @disable_erb ||= []
+        if parameters
+          @disable_erb.concat(parameters)
+        end
       else
         raise ConfigParser::Error.new(parser, "Unknown keyword and parameters for Microservice: #{keyword} #{parameters.join(" ")}")
       end
@@ -220,8 +230,11 @@ module OpenC3
 
         # Load microservice files
         data = File.read(filename, mode: "rb")
-        OpenC3.set_working_dir(File.dirname(filename)) do
-          data = ERB.new(data.comment_erb(), trim_mode: "-").result(binding.set_variables(variables)) if data.is_printable? and File.basename(filename)[0] != '_'
+        erb_disabled = check_disable_erb(filename)
+        unless erb_disabled
+          OpenC3.set_working_dir(File.dirname(filename)) do
+            data = ERB.new(data.comment_erb(), trim_mode: "-").result(binding.set_variables(variables)) if data.is_printable? and File.basename(filename)[0] != '_'
+          end
         end
         unless validate_only
           @bucket.put_object(bucket: ENV['OPENC3_CONFIG_BUCKET'], key: key, body: data)

data/lib/openc3/models/model.rb

@@ -182,6 +182,24 @@ module OpenC3
         'plugin' => @plugin,
         'scope' => @scope }
     end
+
+    def check_disable_erb(filename)
+      erb_disabled = false
+      if @disable_erb
+        if @disable_erb.length == 0
+          # Disable all ERB
+          erb_disabled = true
+        else
+          @disable_erb.each do |pattern|
+            if filename =~ Regexp.new(pattern)
+              erb_disabled = true
+              break
+            end
+          end
+        end
+      end
+      return erb_disabled
+    end
   end
 
   class EphemeralModel < Model

data/lib/openc3/models/note_model.rb

@@ -33,6 +33,17 @@ module OpenC3
       "#{scope}#{PRIMARY_KEY}"
     end
 
+    def self.notify(scope:, kind:, start:, stop: nil)
+      json = {'type' => NOTE_TYPE, 'start' => start}
+      json['stop'] = stop if stop
+      notification = {
+        'data' => JSON.generate(json),
+        'kind' => kind,
+        'type' => 'calendar',
+      }
+      CalendarTopic.write_entry(notification, scope: scope)
+    end
+
     attr_reader :stop, :color, :description, :type
 
     # @param [String] scope - OpenC3 scope to track event to

data/lib/openc3/models/plugin_model.rb

@@ -34,6 +34,7 @@ require 'openc3/models/router_model'
 require 'openc3/models/tool_model'
 require 'openc3/models/widget_model'
 require 'openc3/models/microservice_model'
+require 'openc3/api/api'
 require 'tmpdir'
 require 'tempfile'
 require 'fileutils'
@@ -43,6 +44,8 @@ module OpenC3
   # microservices and tools. The PluginModel installs all these pieces as well
   # as destroys them all when the plugin is removed.
   class PluginModel < Model
+    include Api
+
     PRIMARY_KEY = 'openc3_plugins'
     # Reserved VARIABLE names. See local_mode.rb: update_local_plugin()
     RESERVED_VARIABLE_NAMES = ['target_name', 'microservice_name', 'scope']
@@ -170,6 +173,21 @@ module OpenC3
         end
         needs_dependencies = pkg.spec.runtime_dependencies.length > 0
         needs_dependencies = true if Dir.exist?(File.join(gem_path, 'lib'))
+
+        # Handle python requirements.txt
+        if File.exist?(File.join(gem_path, 'requirements.txt'))
+          begin
+            pypi_url = get_setting('pypi_url', scope: scope)
+          rescue
+            # If Redis isn't running try the ENV, then simply pypi.org/simple
+            pypi_url = ENV['PYPI_URL']
+            pypi_url ||= 'https://pypi.org/simple'
+          end
+          Logger.info "Installing python packages from requirements.txt"
+          puts `pip install --user -i #{pypi_url} -r #{File.join(gem_path, 'requirements.txt')}`
+          needs_dependencies = true
+        end
+
         # If needs_dependencies hasn't already been set we need to scan the plugin.txt
         # to see if they've explicitly set the NEEDS_DEPENDENCIES keyword
         unless needs_dependencies
@@ -278,10 +296,15 @@ module OpenC3
 
     # Undeploy all models associated with this plugin
     def undeploy
+      errors = []
       microservice_count = 0
       microservices = MicroserviceModel.find_all_by_plugin(plugin: @name, scope: @scope)
       microservices.each do |name, model_instance|
-        model_instance.destroy
+        begin
+          model_instance.destroy
+        rescue Exception => error
+          errors << error
+        end
         microservice_count += 1
       end
       # Wait for the operator to wake up and remove the microservice processes
@@ -290,15 +313,44 @@ module OpenC3
       # Save TargetModel for last as it has the most to cleanup
       [InterfaceModel, RouterModel, ToolModel, WidgetModel, TargetModel].each do |model|
         model.find_all_by_plugin(plugin: @name, scope: @scope).each do |name, model_instance|
-          model_instance.destroy
+          begin
+            model_instance.destroy
+          rescue Exception => error
+            errors << error
+          end
         end
       end
       # Cleanup Redis stuff that might have been left by microservices
       microservices.each do |name, model_instance|
-        model_instance.cleanup
+        begin
+          model_instance.cleanup
+        rescue Exception => error
+          errors << error
+        end
+      end
+      # Raise all the errors at once
+      if errors.length > 0
+        message = ''
+        errors.each do |error|
+          message += "\n#{error.formatted}\n"
+        end
+        raise message
       end
     rescue Exception => error
-      Logger.error("Error undeploying plugin model #{@name} in scope #{@scope} due to #{error}")
+      Logger.error("Error undeploying plugin model #{@name} in scope #{@scope} due to: #{error}")
+    ensure
+      # Double check everything is gone
+      found = []
+      [MicroserviceModel, InterfaceModel, RouterModel, ToolModel, WidgetModel, TargetModel].each do |model|
+        model.find_all_by_plugin(plugin: @name, scope: @scope).each do |name, model_instance|
+          found << model_instance
+        end
+      end
+      if found.length > 0
+        # If undeploy failed we need to not move forward with anything else
+        Logger.error("Error undeploying plugin model #{@name} in scope #{@scope} due to: Plugin submodels still exist after undeploy = #{found.length}")
+        raise "Plugin #{@name} submodels still exist after undeploy = #{found.length}"
+      end
     end
 
     # Reinstall

data/lib/openc3/models/python_package_model.rb

@@ -0,0 +1,104 @@
+# encoding: ascii-8bit
+
+# Copyright 2023 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 'fileutils'
+require 'openc3/utilities/process_manager'
+require 'pathname'
+
+module OpenC3
+  # This class acts like a Model but doesn't inherit from Model because it doesn't
+  # actual interact with the Store (Redis). Instead we implement names, get, put
+  # and destroy to allow interaction with python package files from the PluginModel and
+  # the PackagesController.
+  class PythonPackageModel
+    def self.names
+      paths = Dir.glob("#{ENV['PYTHONUSERBASE']}/lib/*")
+      results = []
+      paths.each do |path|
+        results.concat(Pathname.new(File.join(path, 'site-packages')).children.select { |c| c.directory? and File.extname(c) == '.dist-info' }.collect { |p| File.basename(p, '.dist-info') })
+      end
+      return results.sort
+    end
+
+    def self.get(name)
+      path = "#{ENV['PYTHONUSERBASE']}/cache"
+      FileUtils.mkdir_p(path) unless Dir.exist?(path)
+      result = Pathname.new(path).children.select { |c| c.file? and File.basename(c, File.extname(c)) == name }
+      if result.length > 0
+        return result[0] if File.exist?(result[0])
+      end
+      raise "Package #{name} not found"
+    end
+
+    def self.put(package_file_path, package_install: true, scope:)
+      if File.file?(package_file_path)
+        package_filename = File.basename(package_file_path)
+        FileUtils.mkdir_p("#{ENV['PYTHONUSERBASE']}/cache") unless Dir.exist?("#{ENV['PYTHONUSERBASE']}/cache")
+        cache_path = "#{ENV['PYTHONUSERBASE']}/cache/#{File.basename(package_file_path)}"
+        FileUtils.cp(package_file_path, cache_path)
+        if package_install
+          return self.install(cache_path, scope: scope)
+        end
+      else
+        message = "Package file #{package_file_path} does not exist!"
+        Logger.error message
+        raise message
+      end
+      return nil
+    end
+
+    def self.install(name_or_path, scope:)
+      if File.exist?(name_or_path)
+        package_file_path = name_or_path
+      else
+        package_file_path = get(name_or_path)
+      end
+      package_filename = File.basename(package_file_path)
+      begin
+        pypi_url = get_setting('pypi_url', scope: scope)
+      rescue
+        # If Redis isn't running try the ENV, then simply pypi.org/simple
+        pypi_url = ENV['PYPI_URL']
+        pypi_url ||= 'https://pypi.org/simple'
+      end
+      Logger.info "Installing python package: #{name_or_path}"
+      result = OpenC3::ProcessManager.instance.spawn(["pip", "install", "--user", "-i", pypi_url, package_file_path], "package_install", package_filename, Time.now + 3600.0, scope: scope)
+      return result.name
+    end
+
+    def self.destroy(name, scope:)
+      package_name, version = self.extract_name_and_version(name)
+      Logger.info "Uninstalling package: #{name}"
+      result = OpenC3::ProcessManager.instance.spawn(["pip", "uninstall", package_name, "-y"], "package_uninstall", name, Time.now + 3600.0, scope: scope)
+      return result.name
+    end
+
+    def self.extract_name_and_version(name)
+      split_name = name.split('-')
+      if split_name.length > 1
+        package_name = split_name[0..-2].join('-')
+        version = File.basename(split_name[-1], '.dist-info')
+      else
+        package_name = name
+        version = "Unknown"
+      end
+
+      return package_name, version
+    end
+  end
+end

data/lib/openc3/models/scope_model.rb

@@ -305,6 +305,8 @@ module OpenC3
       SettingModel.set({ name: 'source_url', data: 'https://github.com/OpenC3/cosmos' }, scope: @scope) unless setting
       setting = SettingModel.get(name: 'rubygems_url')
       SettingModel.set({ name: 'rubygems_url', data: 'https://rubygems.org' }, scope: @scope) unless setting
+      setting = SettingModel.get(name: 'pypi_url')
+      SettingModel.set({ name: 'pypi_url', data: 'https://pypi.org/simple' }, scope: @scope) unless setting
     end
   end
 end

data/lib/openc3/models/sorted_model.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 2023, 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.
 
 # https://www.rubydoc.info/gems/redis/Redis/Commands/SortedSets
@@ -39,7 +39,12 @@ module OpenC3
 
     # MUST be overriden by any subclasses
     def self.pk(scope)
-      "#{scope}#{PRIMARY_KEY}"
+      return "#{scope}#{PRIMARY_KEY}"
+    end
+
+    # MUST be overriden by any subclasses
+    def self.notify(scope:, kind:, start:, stop: nil)
+      # Do nothing by default
     end
 
     # @return [String|nil] String of the saved json or nil if start not found
@@ -52,7 +57,7 @@ module OpenC3
     # @return [Array<Hash>] Array up to the limit of the models (as Hash objects) stored under the primary key
     def self.all(scope:, limit: 100)
       result = Store.zrevrangebyscore(self.pk(scope), '+inf', '-inf', limit: [0, limit])
-      result.map { |item| JSON.parse(item, :allow_nan => true, :create_additions => true) }
+      return result.map { |item| JSON.parse(item, :allow_nan => true, :create_additions => true) }
     end
 
     # @return [String|nil] json or nil if metadata empty
@@ -71,24 +76,28 @@ module OpenC3
         raise SortedInputError.new "start: #{start} must be before stop: #{stop}"
       end
       result = Store.zrangebyscore(self.pk(scope), start, stop, limit: [0, limit])
-      result.map { |item| JSON.parse(item, :allow_nan => true, :create_additions => true) }
+      return result.map { |item| JSON.parse(item, :allow_nan => true, :create_additions => true) }
     end
 
     # @return [Integer] count of the members stored under the primary key
     def self.count(scope:)
-      Store.zcard(self.pk(scope))
+      return Store.zcard(self.pk(scope))
     end
 
     # Remove member from a sorted set
     # @return [Integer] count of the members removed, 0 if not found
     def self.destroy(scope:, start:)
-      Store.zremrangebyscore(self.pk(scope), start, start)
+      result = Store.zremrangebyscore(self.pk(scope), start, start)
+      self.notify(kind: 'deleted', start: start, scope: scope)
+      return result
     end
 
     # Remove members from min to max of the sorted set.
     # @return [Integer] count of the members removed
     def self.range_destroy(scope:, start:, stop:)
-      Store.zremrangebyscore(self.pk(scope), start, stop)
+      result = Store.zremrangebyscore(self.pk(scope), start, stop)
+      self.notify(kind: 'deleted', start: start, stop: stop, scope: scope)
+      return result
     end
 
     attr_reader :start