rookout 0.1.37 → 0.1.40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 661b78a375817aaf8b11e7d11baa2a1a55824a4faeb7b07800b2ab77d05fb21a
-  data.tar.gz: d2abdb693639eddc830978c88a426f8d660db1ddcc09359d190eac69e2686de2
+  metadata.gz: 7605e9deab6fab2b1456185132e9db8100f143e0486a6cbef13a20a368047ad1
+  data.tar.gz: 900c58be123cfad2b749a16dce8ed3e6fa572af1177ee3778fe9318c02a2f81b
 SHA512:
-  metadata.gz: 4cfd877508902044f7a6a003ed6b9f4e87f24452dac85873f4281b30e17445f085f4cc7d46dea0919a6536755f01b81b67d89ce4a21eb063f97f69a51403053b
-  data.tar.gz: 606d7c8765066bd747ab7d3ecf098c39c934f023708d7e6eef7348bded9bb5b5175b101faf548f39838408ff865b383cab876f41c39fae0c0d6c2acd8d33d036
+  metadata.gz: 0d4bf7792481a091c0110353cf727f44486b08dd099bba996ce83c7b05e88213f8a714dcbfb2840944876a49a8a794f2496c501c1c19ec5c341f1493ab925ace
+  data.tar.gz: 5069a96af2a1a11b0e7d07be6def3a42bdbf0b94658bc16ff652d06ae623295f5c9b4ea02cbee21cae3d68a236f283568d0136d04edcc51937c68c4a31ba635b

data/lib/rookout/augs/aug.rb

@@ -10,13 +10,11 @@ module Rookout
     require_relative "../logger"
 
     class Aug
-      def initialize aug_id, action, condition, rate_limiter, _max_aug_time
-        # NOTE: max_aux_time is not implemented
-
+      def initialize aug_id, action, condition, limits_manager, _max_aug_time
         @id = aug_id
         @action = action
         @condition = condition
-        @rate_limiter = rate_limiter
+        @limits_manager = limits_manager
 
         @enabled = true
         @status = nil
@@ -36,7 +34,7 @@ module Rookout
         namespace = create_namespaces frame, extracted
         return if @condition && !@condition.evaluate(namespace)
 
-        @rate_limiter.with_limit do
+        @limits_manager.with_limit do
           report_id = Utils.uuid
           Logger.instance.info "Executing aug-\t#{id} (msg ID #{report_id})"
           @action.execute @id, report_id, namespace, output

data/lib/rookout/augs/aug_factory.rb

@@ -10,7 +10,9 @@ module Rookout
     require_relative "locations/location_exception_handler"
     require_relative "aug_rate_limiter"
     require_relative "aug"
+    require_relative "limits_manager"
     require_relative "../utils"
+    require_relative "../logger"
 
     class AugFactory
       def initialize output
@@ -34,10 +36,10 @@ module Rookout
         end
         condition = condition_configuration.nil? ? nil : Conditions::Condition.new(condition_configuration)
 
-        rate_limit = create_rate_limit configuration
+        limits_manager = create_limits_manager configuration
 
         max_aug_time_ns = Utils.milliseconds_to_nanoseconds max_aug_time
-        aug = Aug.new aug_id, action, condition, rate_limit, max_aug_time_ns
+        aug = Aug.new aug_id, action, condition, limits_manager, max_aug_time_ns
 
         location_configuration = configuration["location"]
         raise Exceptions::RookAugInvalidKey.new("location", configuration) unless location_configuration.is_a? Hash
@@ -62,25 +64,48 @@ module Rookout
         end
       end
 
-      def create_rate_limit configuration
-        window_quota = 200
-        window_size = 5000
+      def create_limits_manager configuration
+        limiters = []
+        if global_rate_limiter.nil?
+          rate_limit = parse_rate_limit configuration["rateLimit"], configuration["rateLimitModifier"], 200, 5000
+          limiters.append AugRateLimiter.new(*rate_limit)
+        else
+          limiters.append global_rate_limiter
+        end
 
-        rate_limit = configuration["rateLimit"]
-        if rate_limit
-          rate_limit_splitted = rate_limit.split "/"
-          if rate_limit_splitted.length == 2
-            window_quota = rate_limit_splitted[0].to_i
-            window_size = rate_limit_splitted[1].to_i
-          end
+        LimitsManager.new limiters
+      end
+
+      def global_rate_limiter
+        if @global_rate_limiter.nil? && !Rookout::Config.global_rate_limit.nil?
+          rate_limit = parse_rate_limit Rookout::Config.global_rate_limit, "0", 0, 0
+          @global_rate_limiter = AugRateLimiter.new(*rate_limit)
+          Logger.instance.debug "Using global rate limiter with configuration: #{rate_limit}"
+          Rookout::Config.using_global_rate_limiter = true
         end
 
-        rate_limit_modifier = configuration["rateLimitModifier"] || 5
+        @global_rate_limiter
+      end
+
+      def parse_rate_limit config, modifier_config, default_quota, default_window
+        window_quota = default_quota
+        window_size = default_window
+
+        unless config.nil? || config.empty?
+          rate_limit_split = config.split "/"
+          unless rate_limit_split.length == 2 && rate_limit_split[0].is_number? && rate_limit_split[1].is_number?
+            raise Exceptions::RookInvalidRateLimitConfiguration, config
+          end
+
+          window_quota = rate_limit_split[0].to_i
+          window_size = rate_limit_split[1].to_i
+        end
 
         window_quota_ns = Utils.milliseconds_to_nanoseconds window_quota
         window_size_ns = Utils.milliseconds_to_nanoseconds window_size
+        rate_limit_modifier = modifier_config.to_i || 5
 
-        AugRateLimiter.new window_quota_ns, window_size_ns, rate_limit_modifier
+        [window_quota_ns, window_size_ns, rate_limit_modifier]
       end
     end
   end

data/lib/rookout/augs/aug_rate_limiter.rb

@@ -8,51 +8,50 @@ module Rookout
         @quota = quota
         @has_quota = !@quota.nil? && (@quota > 0)
         @window_size = window_size
-        @active_weight = quota / active_limit
+        if active_limit > 0
+          @active_weight = quota / active_limit
+        else
+          @active_weight = 0
+        end
 
         @mutex = Mutex.new
         @active_count = 0
         @windows = {}
       end
 
-      def with_limit start_time = nil
-        active = false
-        start_time ||= Time.now
-
-        # If quota, verify it
-        if @has_quota
-          # Get current time
-          now_ns = Utils.time_to_nanoseconds start_time
-
-          # Calculate window keys
-          current_window_key, prev_window_key = timestamp_to_window_keys now_ns
-
-          @mutex.synchronize do
-            # Clean old windows
-            cleanup now_ns
-            # Increase active count
-            @active_count += 1
-            active = true
-
-            # If exceeding quota
-            if current_usage(now_ns, current_window_key, prev_window_key) > @quota
-              warning = Processor::RookError.new Exceptions::RookRuleRateLimited.new
-              UserWarnings.notify_warning warning
-              return
-            end
+      def before_run start_time
+        # If no quota, we can safely exit
+        unless @has_quota
+          return true
+        end
+        now_ns = Utils.time_to_nanoseconds start_time
+        current_window_key, prev_window_key = timestamp_to_window_keys now_ns
+
+        @mutex.synchronize do
+          # Clean old windows
+          cleanup now_ns
+          usage = current_usage now_ns, current_window_key, prev_window_key
+          @active_count += 1
+
+          # If exceeding quota
+          if usage > @quota
+            warning = Processor::RookError.new Exceptions::RookRuleRateLimited.create
+            UserWarnings.notify_warning warning
+            return false
           end
+
+          return true
         end
+      end
 
-        begin
-          yield
-        ensure
-          if @has_quota
-            @mutex.synchronize { record_usage current_window_key, Utils.time_to_nanoseconds(Time.now) - now_ns }
-          end
+      def after_run start_time
+        if @has_quota
+          now_ns = Utils.time_to_nanoseconds start_time
+          current_window_key, = timestamp_to_window_keys now_ns
+          @mutex.synchronize { record_usage current_window_key, Utils.time_to_nanoseconds(Time.now) - now_ns }
         end
-      ensure
         # Reduce active count
-        @mutex.synchronize { @active_count -= 1 } if active
+        @mutex.synchronize { @active_count -= 1 }
       end
 
       private

data/lib/rookout/augs/limits_manager.rb

@@ -0,0 +1,31 @@
+module Rookout
+  module Augs
+    class LimitsManager
+      def initialize limiters
+        @limiters = limiters
+      end
+
+      def with_limit start_time = nil
+        start_time ||= Time.now
+        can_execute = true
+        after_execute = []
+
+        @limiters.each do |limiter|
+          if limiter.before_run start_time
+            after_execute.append -> { limiter.after_run start_time }
+          else
+            can_execute = false
+          end
+        end
+
+        if can_execute
+          yield
+        end
+      ensure
+        unless after_execute.nil?
+          after_execute.each(&:call)
+        end
+      end
+    end
+  end
+end

data/lib/rookout/commit.rb

@@ -1,3 +1,3 @@
 module Rookout
-  COMMIT = "e56488a23c33cbe4ad104217694c08c994586597".freeze
+  COMMIT = "c62d573f33d1f62ad05aec7d28a4757fafb9a2b4".freeze
 end

data/lib/rookout/config.rb

@@ -76,8 +76,18 @@ module Rookout
 
       Rookout::Config.true_values = ["y", "Y", "yes", "Yes", "YES", "true", "True", "TRUE", "1"]
 
+      attr_accessor :global_rate_limit
+      attr_accessor :using_global_rate_limiter
+
+      Rookout::Config.global_rate_limit = nil
+      Rookout::Config.using_global_rate_limiter = false
 
       def update_config configuration
+        update_var2_config configuration
+        update_global_rate_limit_config configuration
+      end
+
+      def update_var2_config configuration
         is_config_proto2 = configuration["RUBY_PROTOBUF_VERSION_2"]
         return if is_config_proto2.nil?
         is_env_proto2 = ENV["ROOKOUT_Protobuf_Version2"]
@@ -89,6 +99,18 @@ module Rookout
         end
         Logger.instance.info "Updating ROOKOUT_Protobuf_Version2 value to: #{@protobuf_version2}"
       end
+
+      def update_global_rate_limit_config configuration
+        global_rate_limit = ENV["ROOKOUT_GLOBAL_RATE_LIMIT"]
+        if global_rate_limit.nil?
+          global_rate_limit = configuration["RUBY_GLOBAL_RATE_LIMIT"]
+        end
+
+        return if global_rate_limit.nil?
+
+        @global_rate_limit = global_rate_limit
+        Logger.instance.info "Updating global rate limit to: #{global_rate_limit}"
+      end
     end
   end
 end

data/lib/rookout/exceptions.rb

@@ -95,13 +95,29 @@ module Rookout
       end
     end
 
-    class RookRuleRateLimited < ToolException
+    class RookRuleAugRateLimited < ToolException
       def initialize
         super "Breakpoint was disabled due to rate-limiting. " \
               "For more information: https://docs.rookout.com/docs/breakpoints-tasks.html#rate-limiting"
       end
     end
 
+    class RookRuleGlobalRateLimited < ToolException
+      def initialize
+        super "Breakpoint was disabled due to global rate-limiting. " \
+              "For more information: https://docs.rookout.com/docs/breakpoints-tasks.html#rate-limiting"
+      end
+    end
+
+    class RookRuleRateLimited
+      def self.create
+        if Rookout::Config.using_global_rate_limiter
+          return RookRuleGlobalRateLimited.new
+        end
+        RookRuleAugRateLimited.new
+      end
+    end
+
     class RookInvalidToken < ToolException
       def initialize token = ""
         super "The Rookout token supplied #{token[0..6]} is not valid; please check the token and try again",
@@ -214,6 +230,15 @@ module Rookout
       end
     end
 
+    class RookInvalidRateLimitConfiguration < ToolException
+      def initialize config
+        super "Invalid rate limit configuration: #{config}",
+              {
+                "rate_limit_config" => config
+              }
+      end
+    end
+
     class RookUnsupportedLiveLogger < ToolException
       def initialize
         super "Live Logger is not supported. Try using Rookout Live Debugger instead."

data/lib/rookout/processor/namespace_serializer2.rb

@@ -9,6 +9,13 @@ module Rookout
       require_relative "./namespaces/container_namespace"
       require_relative "./namespaces/traceback_namespace"
 
+      begin
+        require "hashie/mash"
+        MASH = ::Hashie::Mash
+      rescue LoadError
+        MASH = nil
+      end
+
       def initialize
         @string_cache = {}
         @estimated_pending_bytes = 0
@@ -98,7 +105,7 @@ module Rookout
           dump_time obj, variant
         elsif obj.class == Array
           dump_array obj, variant, current_depth, config, log_object_errors
-        elsif obj.class == Hash
+        elsif obj.class == Hash || (!MASH.nil? && obj.is_a?(MASH))
           dump_hash obj, variant, current_depth, config, log_object_errors
         elsif obj.is_a? Exception
           dump_exception obj, variant, current_depth, config, log_object_errors

data/lib/rookout/sanitizer.rb

@@ -0,0 +1,22 @@
+require "set"
+module Rookout
+  class Sanitizer
+    @@blacklisted_properties = Set["labels", "ROOKOUT_LABELS"]
+
+    def self.sanitize_object! obj
+      obj.each_key do |key|
+        if obj[key].is_a?(String) && !@@blacklisted_properties.include?(key.to_s)
+          obj[key] = obj[key].strip
+        end
+      end
+    end
+
+    def self.sanitize_properties!
+      ENV.each do |key, val|
+        if key.start_with?("ROOKOUT_") && !@@blacklisted_properties.include?(key.to_s)
+          ENV[key] = val.strip
+        end
+      end
+    end
+  end
+end

data/lib/rookout/utils.rb

@@ -18,3 +18,9 @@ module Utils
     ((10**9) * secs) + nsecs
   end
 end
+
+class String
+  def is_number?
+    to_f.to_s == self || to_i.to_s == self
+  end
+end

data/lib/rookout/version.rb

@@ -1,3 +1,3 @@
 module Rookout
-  VERSION = "0.1.37".freeze
+  VERSION = "0.1.40".freeze
 end

data/lib/rookout.rb

@@ -2,6 +2,10 @@ module Rookout
   module_function
 
   def start options = {}
+    require_relative "rookout/sanitizer"
+    Sanitizer.sanitize_object! options
+    Sanitizer.sanitize_properties!
+
     require_relative "rookout/interface"
     Interface.instance.start options
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rookout
 version: !ruby/object:Gem::Version
-  version: 0.1.37
+  version: 0.1.40
 platform: ruby
 authors:
 - Liran Haimovitch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-24 00:00:00.000000000 Z
+date: 2022-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
@@ -192,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 description: rookout is the Ruby SDK for the Rookout Debugging Platform
 email:
 - support@rookout.com
@@ -211,6 +225,7 @@ files:
 - lib/rookout/augs/aug_rate_limiter.rb
 - lib/rookout/augs/augs_manager.rb
 - lib/rookout/augs/conditions/condition.rb
+- lib/rookout/augs/limits_manager.rb
 - lib/rookout/augs/locations/location.rb
 - lib/rookout/augs/locations/location_exception_handler.rb
 - lib/rookout/augs/locations/location_file_line.rb
@@ -259,6 +274,7 @@ files:
 - lib/rookout/protobuf/variant2_pb.rb
 - lib/rookout/protobuf/variant_pb.rb
 - lib/rookout/rookout_singleton.rb
+- lib/rookout/sanitizer.rb
 - lib/rookout/services/position.rb
 - lib/rookout/services/tracer.rb
 - lib/rookout/trigger_services.rb
@@ -285,7 +301,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: rookout is the Ruby SDK for the Rookout Debugging Platform