rookout 0.1.38 → 0.1.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7230e6476d46d4184cd1887296f946c67fcc2e5e35b3b404f9f66444ef4d964
-  data.tar.gz: '098f43b827ae84b56adb3e19905899487d3082ce66862b1938bf823ec2cee7de'
+  metadata.gz: 07a2d9fa41fdf140e81f22c1a46f47bbaf5412b31d1ab62c1f59460c07113c03
+  data.tar.gz: 9dd40c49cc6b8417aa3424cedd26aad1b8e63813fe0e2fcc063749d03c20f602
 SHA512:
-  metadata.gz: 81e11a89868203775659bcab8b1a9ac4141cba01ca33ab6bd3f33f71d4be46c39f2652d1b3a2c413260104cf8b215c448ba8251081bb2e389fe32c12238fe5c4
-  data.tar.gz: 22c3bbe9a67a1cefa8cc1928c4882fb585c479bb0e36b75c4ebf9abe0c7b5839e364169347b7c37b8dd40aec14641449e7ddf55db968378e9f2bcc876c9bcf4e
+  metadata.gz: 7204403b2efd52cce60b533b396c93ffc963b60554d3fbf4fbc414f4a2d6a80c0ced39e7d6c6cceda6d2470ee46563cc8704871b058957599f8b6f7ad1d433ff
+  data.tar.gz: 2a05c92e5f984035bcbe84e5e4f2f25be8b2458032272c03fd4e94f8e94252bcaf8c11d7989c294e5a7d07773e95170bb7f479c3806945636869b2b7b491349d

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 != ""
+          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 = "d0495f7919f4fa023c9192c095b24bcdfbf4c825".freeze
+  COMMIT = "ed682099e24a661d30178506cb58f2a25d4af877".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 = ""
+      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 = 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/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.38".freeze
+  VERSION = "0.1.41".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.38
+  version: 0.1.41
 platform: ruby
 authors:
 - Liran Haimovitch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-23 00:00:00.000000000 Z
+date: 2022-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: binding_of_caller
@@ -225,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
@@ -273,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