rsmp 0.37.0 → 0.39.0

data/lib/rsmp/helpers/error.rb

@@ -0,0 +1,72 @@
+module RSMP
+  class Error < StandardError
+  end
+
+  class InvalidPacket < Error
+  end
+
+  class MalformedMessage < Error
+  end
+
+  # Raised when schema validation fails.
+  class SchemaError < Error
+    attr_accessor :schemas
+  end
+
+  class InvalidMessage < Error
+  end
+
+  class UnknownMessage < Error
+  end
+
+  class MissingAcknowledgment < Error
+  end
+
+  class MissingWatchdog < Error
+  end
+
+  class MessageRejected < Error
+  end
+
+  class MissingAttribute < InvalidMessage
+  end
+
+  class FatalError < Error
+  end
+
+  class HandshakeError < FatalError
+  end
+
+  class NotReady < Error
+  end
+
+  class TimeoutError < Error
+  end
+
+  class DisconnectError < Error
+  end
+
+  class ConnectionError < Error
+  end
+
+  class UnknownComponent < Error
+  end
+
+  class UnknownCommand < Error
+  end
+
+  class UnknownStatus < Error
+  end
+
+  class ConfigurationError < Error
+  end
+
+  class RepeatedAlarmError < Error
+  end
+
+  class RepeatedStatusError < Error
+  end
+
+  class TimestampError < Error
+  end
+end

data/lib/rsmp/helpers/inspect.rb

@@ -0,0 +1,41 @@
+module RSMP
+  # Custom inspect, to reduce noise
+  #
+  # Instance variables of classes starting with Async or RSMP are shown
+  # with only their class name and object id, which reduces output,
+  # especially for deep object structures.
+  # Additionally, a list of variables to shown in short format can be passed.
+  #
+  # The short form is generated by using to_s() insted of inspect()
+  #
+  # Array#to_s and Hash#to_s usually show items, but here we show just number
+  # of items, when the short form is requested.
+  module Inspect
+    def inspector *short_items
+      instance_variables.map do |var_name|
+        var = instance_variable_get(var_name)
+        class_name = var.class.name
+
+        short = short_items.include?(var_name) ||
+                class_name.start_with?('Async') ||
+                class_name.start_with?('RSMP')
+
+        if short
+          if var.is_a?(Array) || var.is_a?(Hash)
+            "#{var_name}: #<#{class_name}:#{class_name.object_id}, #{var.size} items>"
+          else
+            "#{var_name}: #{var}"
+          end
+        else
+          "#{var_name}: #{var.inspect}"
+        end
+      end.join(', ')
+    end
+
+    # override this if you want additional variable to be shown in the short format,
+    # or ottherwise change the inspect format
+    def inspect
+      "#<#{self.class.name}:#{object_id}, #{inspector}>"
+    end
+  end
+end

data/lib/rsmp/log/archive.rb

@@ -0,0 +1,97 @@
+module RSMP
+  # Archive of log items, which can be messages or info items.
+  # All items are timestamped, and stored chronologically.
+  class Archive
+    include Inspect
+
+    attr_reader :items
+
+    @index = 0
+
+    class << self
+      attr_accessor :index
+    end
+
+    def initialize(max = 100)
+      @items = []
+      @max = max
+    end
+
+    def inspect
+      "#<#{self.class.name}:#{object_id}, #{inspector(:@items)}>"
+    end
+
+    def self.prepare_item(item)
+      raise ArgumentError unless item.is_a? Hash
+
+      cleaned = item.slice(:author, :level, :ip, :port, :site_id, :component, :text, :message, :exception)
+      cleaned[:timestamp] = Clock.now
+      if item[:message]
+        cleaned[:direction] = item[:message].direction
+        cleaned[:component] = item[:message].attributes['cId']
+      end
+
+      cleaned
+    end
+
+    def self.increase_index
+      self.index += 1
+    end
+
+    def self.current_index
+      index
+    end
+
+    def by_level(levels)
+      items.select { |item| levels.include? item[:level] }
+    end
+
+    def strings
+      items.map { |item| item[:str] }
+    end
+
+    def add(item)
+      item[:index] = RSMP::Archive.increase_index
+      @items << item
+      return unless @items.size > @max
+
+      @items.shift
+    end
+
+    private
+
+    def find(options, &)
+      # search backwards from newest to older, stopping once messages
+      # are older that options[:earliest]
+      out = []
+      @items.reverse_each do |item|
+        break if too_old?(item, options[:earliest])
+        next unless matches_filters?(item, options, &)
+
+        out.unshift item
+      end
+      out
+    end
+
+    def too_old?(item, earliest)
+      earliest && item[:timestamp] < earliest
+    end
+
+    def matches_filters?(item, options, &block)
+      return false if options[:level] && item[:level] != options[:level]
+      return false if options[:type] && !matches_type?(item, options[:type])
+      return false if options[:with_message] && !message?(item)
+      return false if block_given? && block.call != true
+
+      true
+    end
+
+    def matches_type?(item, type)
+      item[:message] && item[:message].type == type
+    end
+
+    def message?(item)
+      item[:direction] && item[:message]
+    end
+  end
+end

data/lib/rsmp/log/colorization.rb

@@ -0,0 +1,41 @@
+module RSMP
+  class Logger
+    # Handles colorization of log output
+    module Colorization
+      def default_colors
+        {
+          'info' => 'white',
+          'log' => 'light_blue',
+          'statistics' => 'light_black',
+          'warning' => 'light_yellow',
+          'error' => 'red',
+          'debug' => 'light_black',
+          'collect' => 'light_black'
+        }
+      end
+
+      def colorize_with_map(level, str, colors)
+        color = colors[level.to_s]
+        color ? str.colorize(color.to_sym) : str
+      end
+
+      def apply_hash_colors(level, str)
+        colors = default_colors
+        colors.merge! @settings['color'] if @settings['color'].is_a?(Hash)
+        colorize_with_map(level, str, colors)
+      end
+
+      def colorize(level, str)
+        return str if @settings['color'] == false || @settings['color'].nil?
+
+        if @settings['color'] == true || @settings['color'].is_a?(Hash)
+          apply_hash_colors(level, str)
+        elsif %i[nack warning error].include?(level)
+          str.colorize(@settings['color']).bold
+        else
+          str.colorize @settings['color']
+        end
+      end
+    end
+  end
+end

data/lib/rsmp/log/filtering.rb

@@ -0,0 +1,54 @@
+module RSMP
+  class Logger
+    # Handles filtering logic for log output
+    module Filtering
+      def level_enabled?(item)
+        return false if @settings['info'] == false && item[:level] == :info
+        return false if @settings['debug'] != true && item[:level] == :debug
+        return false if @settings['statistics'] != true && item[:level] == :statistics
+        return false if @settings['test'] != true && item[:level] == :test
+
+        true
+      end
+
+      def message_ignored?(item)
+        return false unless item[:message]
+
+        type = item[:message].type
+        ack = %w[MessageAck MessageNotAck].include?(type)
+        return true unless ignorable?(type, ack, item)
+        return true unless acknowledgement_enabled?(ack, item)
+
+        false
+      end
+
+      def ignorable?(type, ack, item)
+        @ignorable.each_pair do |key, types|
+          ignore = [types].flatten
+          next unless @settings[key] == false
+          return false if ignore.include?(type)
+
+          return false if ack && item[:message].original && ignore.include?(item[:message].original.type)
+        end
+        true
+      end
+
+      def acknowledgement_enabled?(ack, item)
+        return true unless ack
+        return true if @settings['acknowledgements'] != false
+        return true if %i[not_acknowledged warning error].include?(item[:level])
+
+        false
+      end
+
+      def output?(item, force: false)
+        return false if muted?(item)
+        return false if @settings['active'] == false && force != true
+        return false unless level_enabled?(item)
+        return false if message_ignored?(item)
+
+        true
+      end
+    end
+  end
+end

data/lib/rsmp/log/logger.rb

@@ -0,0 +1,207 @@
+module RSMP
+  # Formats and outputs log messages according to configured settings.
+  class Logger
+    include Filtering
+    include Colorization
+
+    attr_accessor :settings
+
+    def default_output_settings
+      {
+        'active' => true,
+        'path' => nil,
+        'stream' => nil,
+        'color' => true,
+        'debug' => false,
+        'statistics' => false,
+        'hide_ip_and_port' => false,
+        'acknowledgements' => false,
+        'watchdogs' => false,
+        'alarms' => true,
+        'json' => false,
+        'tabs' => '-'
+      }
+    end
+
+    def default_field_settings
+      {
+        'prefix' => false,
+        'index' => false,
+        'author' => false,
+        'timestamp' => true,
+        'ip' => false,
+        'port' => false,
+        'site_id' => true,
+        'component' => true,
+        'direction' => false,
+        'level' => false,
+        'id' => true,
+        'text' => true
+      }
+    end
+
+    def default_logger_settings
+      default_output_settings.merge(default_field_settings)
+    end
+
+    def default_field_lengths
+      {
+        'index' => 7,
+        'author' => 13,
+        'timestamp' => 24,
+        'ip' => 22,
+        'port' => 5,
+        'site_id' => 19,
+        'component' => 19,
+        'direction' => 3,
+        'level' => 7,
+        'id' => 4
+      }
+    end
+
+    def ignorable_messages
+      {
+        'versions' => ['Version'],
+        'statuses' => %w[StatusRequest StatusSubscribe StatusUnsubscribe StatusResponse StatusUpdate],
+        'commands' => %w[CommandRequest CommandResponse],
+        'watchdogs' => 'Watchdog',
+        'alarms' => ['Alarm'],
+        'aggregated_status' => %w[AggregatedStatus AggregatedStatusRequest]
+      }
+    end
+
+    def apply_default_lengths(settings)
+      lengths = default_field_lengths
+      settings.to_h do |key, value|
+        if value == true && lengths[key]
+          [key, lengths[key]]
+        else
+          [key, value]
+        end
+      end
+    end
+
+    def initialize(settings = {})
+      @ignorable = ignorable_messages
+      @settings = settings ? default_logger_settings.merge(settings) : default_logger_settings
+      @settings = apply_default_lengths(@settings)
+      @muted = {}
+      setup_output_destination
+    end
+
+    def setup_output_destination
+      @stream = if @settings['stream']
+                  @settings['stream']
+                elsif @settings['path']
+                  File.open(@settings['path'], 'a') # appending
+                else
+                  $stdout
+                end
+    end
+
+    def mute(ip, port)
+      @muted["#{ip}:#{port}"] = true
+    end
+
+    def unmute(ip, port)
+      @muted.delete "#{ip}:#{port}"
+    end
+
+    def unmute_all
+      @muted = {}
+    end
+
+    def muted?(item)
+      item[:ip] && item[:port] && @muted["#{item[:ip]}:#{item[:port]}"]
+    end
+
+    def level_enabled?(item)
+      return false if @settings['info'] == false && item[:level] == :info
+      return false if @settings['debug'] != true && item[:level] == :debug
+      return false if @settings['statistics'] != true && item[:level] == :statistics
+      return false if @settings['test'] != true && item[:level] == :test
+
+      true
+    end
+
+    def output(level, str)
+      return if str.empty? || /^\s+$/.match(str)
+
+      str = colorize level, str
+      @stream.puts str
+      @stream.flush
+    end
+
+    def log(item, force: false)
+      return unless output?(item, force: force)
+
+      output item[:level], build_output(item)
+    end
+
+    def self.shorten_message_id(m_id, length = 4)
+      if m_id
+        m_id[0..(length - 1)].ljust(length)
+      else
+        ' ' * length
+      end
+    end
+
+    def dump(archive, num: nil)
+      num ||= archive.items.size
+      log = archive.items.last(num).map do |item|
+        str = build_output item
+        colorize item[:level], str
+      end
+      log.join("\n")
+    end
+
+    def build_part(parts, item, key, &block)
+      skey = key.to_s
+      return unless @settings[skey]
+
+      part = item[key]
+      part = yield part if block
+      part = part.to_s
+      part = part.ljust @settings[skey] if @settings[skey].is_a?(Integer)
+
+      # replace the first char with a dash if string is all whitespace
+      part = @settings['tabs'].ljust(part.length) if @settings['tabs'] && part !~ /\S/
+      parts << part
+    end
+
+    def add_metadata_parts(parts, item)
+      build_part(parts, item, :prefix) { @settings['prefix'] if @settings['prefix'] != false }
+      build_part(parts, item, :index)
+      build_part(parts, item, :author)
+      build_part(parts, item, :timestamp) { |part| Clock.to_s part }
+    end
+
+    def add_connection_parts(parts, item)
+      build_part(parts, item, :ip)
+      build_part(parts, item, :port)
+      build_part(parts, item, :site_id)
+      build_part(parts, item, :component)
+    end
+
+    def add_message_parts(parts, item)
+      build_part(parts, item, :direction) { |part| { in: 'In', out: 'Out' }[part] }
+      build_part(parts, item, :level, &:capitalize)
+      build_part(parts, item, :id) { Logger.shorten_message_id(item[:message].m_id, 4) if item[:message] }
+      build_part(parts, item, :text)
+      build_part(parts, item, :json) { item[:message]&.json }
+      build_part(parts, item, :exception) { |e| [e.class, e.backtrace].flatten.join("\n") }
+    end
+
+    def add_output_parts(parts, item)
+      add_metadata_parts(parts, item)
+      add_connection_parts(parts, item)
+      add_message_parts(parts, item)
+    end
+
+    def build_output(item)
+      parts = []
+      add_output_parts(parts, item)
+      parts.join('  ').chomp(@settings['tabs'].to_s).rstrip
+    end
+  end
+end

data/lib/rsmp/{logging.rb → log/logging.rb}

@@ -3,24 +3,23 @@
 #
 
 module RSMP
+  # Logging integration providing `archive` and `logger` helpers.
   module Logging
     attr_reader :archive, :logger
 
-    def initialize_logging options
+    def initialize_logging(options)
       @archive = options[:archive] || RSMP::Archive.new
       @logger = options[:logger] || RSMP::Logger.new(options[:log_settings])
     end
 
-    def author
-    end
+    def author; end
 
-    def log str, options={}
-      default = { text:str, level: :log, author: author, ip: @ip, port: @port }
+    def log(str, options = {})
+      default = { text: str, level: :log, author: author, ip: @ip, port: @port }
       prepared = RSMP::Archive.prepare_item default.merge(options)
       @archive.add prepared
       @logger.log prepared
       prepared
     end
-
   end
-end
+end