rollbar 2.19.1 → 2.27.1

data/lib/rollbar/scrubbers/url.rb

@@ -14,7 +14,6 @@ module Rollbar
 
       def call(options = {})
         url = options[:url]
-        return url unless Rollbar::LanguageSupport.can_scrub_url?
 
         filter(url,
                build_regex(options[:scrub_fields]),
@@ -23,7 +22,7 @@ module Rollbar
                options.fetch(:randomize_scrub_length, true),
                options[:scrub_fields].include?(SCRUB_ALL),
                build_whitelist_regex(options[:whitelist] || []))
-      rescue => e
+      rescue StandardError => e
         Rollbar.logger.error("[Rollbar] There was an error scrubbing the url: #{e}, options: #{options.inspect}")
         url
       end
@@ -33,6 +32,7 @@ module Rollbar
       def build_whitelist_regex(whitelist)
         fields = whitelist.find_all { |f| f.is_a?(String) || f.is_a?(Symbol) }
         return unless fields.any?
+
         Regexp.new(fields.map { |val| /\A#{Regexp.escape(val.to_s)}\z/ }.join('|'))
       end
 
@@ -67,10 +67,7 @@ module Rollbar
 
         params = decode_www_form(query)
 
-        encoded_query = encode_www_form(filter_query_params(params, regex, randomize_scrub_length, scrub_all, whitelist))
-
-        # We want this to rebuild array params like foo[]=1&foo[]=2
-        URI.escape(CGI.unescape(encoded_query))
+        encode_www_form(filter_query_params(params, regex, randomize_scrub_length, scrub_all, whitelist))
       end
 
       def decode_www_form(query)
@@ -78,7 +75,15 @@ module Rollbar
       end
 
       def encode_www_form(params)
-        URI.encode_www_form(params)
+        restore_square_brackets(URI.encode_www_form(params))
+      end
+
+      def restore_square_brackets(query)
+        # We want this to rebuild array params like foo[]=1&foo[]=2
+        #
+        # URI.encode_www_form follows the spec at https://url.spec.whatwg.org/#concept-urlencoded-serializer
+        # and percent encodes square brackets. Here we change them back.
+        query.gsub('%5B', '[').gsub('%5D', ']')
       end
 
       def filter_query_params(params, regex, randomize_scrub_length, scrub_all, whitelist)
@@ -95,12 +100,16 @@ module Rollbar
         if randomize_scrub_length
           random_filtered_value
         else
-          '*' * (value.length rescue 8)
+          '*' * (begin
+                   value.length
+                 rescue StandardError
+                   8
+                 end)
         end
       end
 
       def random_filtered_value
-        '*' * (rand(5) + 3)
+        '*' * rand(3..7)
       end
     end
   end

data/lib/rollbar/scrubbers.rb

@@ -1,17 +1,17 @@
 module Rollbar
   module Scrubbers
-    extend self
+    module_function
 
     def scrub_value(value)
       if Rollbar.configuration.randomize_scrub_length
         random_filtered_value
       else
-        '*' * (value.length rescue 8)
+        '*' * 6
       end
     end
 
     def random_filtered_value
-      '*' * (rand(5) + 3)
+      '*' * rand(3..7)
     end
   end
 end

data/lib/rollbar/truncation/frames_strategy.rb

@@ -11,7 +11,7 @@ module Rollbar
       end
 
       def call(payload)
-        new_payload = Rollbar::Util.deep_copy(payload)
+        new_payload = payload
         body = new_payload['data']['body']
 
         if body['trace_chain']

data/lib/rollbar/truncation/min_body_strategy.rb

@@ -11,8 +11,7 @@ module Rollbar
       end
 
       def call(payload)
-        new_payload = Rollbar::Util.deep_copy(payload)
-        body = new_payload['data']['body']
+        body = payload['data']['body']
 
         if body['trace_chain']
           body['trace_chain'] = body['trace_chain'].map do |trace_data|
@@ -22,7 +21,7 @@ module Rollbar
           body['trace'] = truncate_trace_data(body['trace'])
         end
 
-        dump(new_payload)
+        dump(payload)
       end
 
       def truncate_trace_data(trace_data)

data/lib/rollbar/truncation/mixin.rb

@@ -9,7 +9,7 @@ module Rollbar
         result.bytesize > MAX_PAYLOAD_SIZE
       end
 
-      def select_frames(frames, range = 150)
+      def select_frames(frames, range = 50)
         return frames unless frames.count > range * 2
 
         frames[0, range] + frames[-range, range]

data/lib/rollbar/truncation/remove_any_key_strategy.rb

@@ -0,0 +1,123 @@
+require 'rollbar/util'
+
+module Rollbar
+  module Truncation
+    class RemoveAnyKeyStrategy
+      include ::Rollbar::Truncation::Mixin
+
+      attr_accessor :payload, :data, :sizes, :extracted_title
+
+      def self.call(payload)
+        new(payload).call
+      end
+
+      def initialize(payload)
+        @payload = payload
+        @data = payload['data']
+        @extracted_title = extract_title(data['body']) if data['body']
+      end
+
+      def call
+        remove_unknown_root_keys
+
+        json_payload = remove_oversized_data_keys
+
+        return json_payload if json_payload
+
+        dump(payload)
+      end
+
+      def remove_unknown_root_keys
+        payload.keys.reject { |key| root_keys.include?(key) }.each do |key|
+          truncation_key['root'] ||= {}
+          size = dump(payload.delete(key)).bytesize
+          truncation_key['root'][key] = "unknown root key removed, size: #{size} bytes"
+        end
+      end
+
+      def remove_oversized_data_keys
+        data_keys.keys.sort { |a, b| data_keys[b] <=> data_keys[a] }.each do |key|
+          json_payload = remove_key_and_return_payload(key)
+
+          return json_payload unless truncate?(json_payload)
+        end
+
+        false
+      end
+
+      def remove_key_and_return_payload(key)
+        size = data_keys[key]
+
+        data.delete(key)
+
+        replace_message_body if key == 'body'
+
+        truncation_key[key] = "key removed, size: #{size} bytes"
+
+        dump(payload)
+      end
+
+      def replace_message_body
+        data['body'] = message_key
+        data['title'] ||= extracted_title if extracted_title
+      end
+
+      def truncation_key
+        @truncation_key ||=
+          # initialize the diagnostic key for truncation
+          (data['notifier']['diagnostic'] ||= {}) &&
+          (data['notifier']['diagnostic']['truncation'] ||= {})
+      end
+
+      def root_keys
+        # Valid keys in root of payload
+        %w[access_token data]
+      end
+
+      def skip_keys
+        # Don't try to truncate these data keys
+        %w[notifier uuid title platform language framework level]
+      end
+
+      def message_key
+        # use this message if data.body gets removed
+        {
+          'message' => {
+            'body' => 'Payload keys removed due to oversized payload. See diagnostic key'
+          }
+        }
+      end
+
+      def extract_title(body)
+        return body['message']['body'] if body['message'] && body['message']['body']
+        return extract_title_from_trace(body['trace']) if body['trace']
+        return extract_title_from_trace(body['trace_chain'][0]) if body['trace_chain'] && body['trace_chain'][0]
+      end
+
+      def extract_title_from_trace(trace)
+        exception = trace['exception']
+
+        "#{exception['class']}: #{exception['message']}"
+      end
+
+      def data_keys
+        @data_keys ||= {}.tap do |hash|
+          data.keys.reject { |key| skip_keys.include?(key) }.each do |key|
+            set_key_size(key, hash)
+          end
+        end
+      end
+
+      def set_key_size(key, hash)
+        size = dump(data[key]).bytesize
+        hash[key] = size
+      rescue ::JSON::GeneratorError
+        hash[key] = 0 # don't try to truncate non JSON object
+
+        # Log it
+        truncation_key['non_json_keys'] ||= {}
+        truncation_key['non_json_keys'][key] = data[key].class
+      end
+    end
+  end
+end

data/lib/rollbar/truncation/remove_extra_strategy.rb

@@ -0,0 +1,35 @@
+require 'rollbar/util'
+
+module Rollbar
+  module Truncation
+    class RemoveExtraStrategy
+      include ::Rollbar::Truncation::Mixin
+
+      def self.call(payload)
+        new.call(payload)
+      end
+
+      def call(payload)
+        body = payload['data']['body']
+
+        delete_message_extra(body)
+        delete_trace_chain_extra(body)
+        delete_trace_extra(body)
+
+        dump(payload)
+      end
+
+      def delete_message_extra(body)
+        body['message'].delete('extra') if body['message'] && body['message']['extra']
+      end
+
+      def delete_trace_chain_extra(body)
+        body['trace_chain'][0].delete('extra') if body['trace_chain'] && body['trace_chain'][0]['extra']
+      end
+
+      def delete_trace_extra(body)
+        body['trace'].delete('extra') if body['trace'] && body['trace']['extra']
+      end
+    end
+  end
+end

data/lib/rollbar/truncation/remove_request_strategy.rb

@@ -0,0 +1,21 @@
+require 'rollbar/util'
+
+module Rollbar
+  module Truncation
+    class RemoveRequestStrategy
+      include ::Rollbar::Truncation::Mixin
+
+      def self.call(payload)
+        new.call(payload)
+      end
+
+      def call(payload)
+        data = payload['data']
+
+        data.delete('request') if data['request']
+
+        dump(payload)
+      end
+    end
+  end
+end

data/lib/rollbar/truncation/strings_strategy.rb

@@ -6,7 +6,7 @@ module Rollbar
     class StringsStrategy
       include ::Rollbar::Truncation::Mixin
 
-      STRING_THRESHOLDS = [1024, 512, 256]
+      STRING_THRESHOLDS = [1024, 512, 256, 128].freeze
 
       def self.call(payload)
         new.call(payload)
@@ -14,13 +14,12 @@ module Rollbar
 
       def call(payload)
         result = nil
-        new_payload = Rollbar::Util.deep_copy(payload)
 
         STRING_THRESHOLDS.each do |threshold|
           truncate_proc = truncate_strings_proc(threshold)
 
-          ::Rollbar::Util.iterate_and_update(new_payload, truncate_proc)
-          result = dump(new_payload)
+          ::Rollbar::Util.iterate_and_update(payload, truncate_proc)
+          result = dump(payload)
 
           break unless truncate?(result)
         end
@@ -30,7 +29,9 @@ module Rollbar
 
       def truncate_strings_proc(threshold)
         proc do |value|
-          if value.is_a?(String) && value.bytesize > threshold
+          # Rollbar::Util.truncate will operate on characters, not bytes,
+          # so use value.length, not bytesize.
+          if value.is_a?(String) && value.length > threshold
             Rollbar::Util.truncate(value, threshold)
           else
             value

data/lib/rollbar/truncation.rb

@@ -4,6 +4,9 @@ require 'rollbar/truncation/raw_strategy'
 require 'rollbar/truncation/frames_strategy'
 require 'rollbar/truncation/strings_strategy'
 require 'rollbar/truncation/min_body_strategy'
+require 'rollbar/truncation/remove_request_strategy'
+require 'rollbar/truncation/remove_extra_strategy'
+require 'rollbar/truncation/remove_any_key_strategy'
 
 module Rollbar
   module Truncation
@@ -13,13 +16,17 @@ module Rollbar
     STRATEGIES = [RawStrategy,
                   FramesStrategy,
                   StringsStrategy,
-                  MinBodyStrategy]
+                  MinBodyStrategy,
+                  RemoveRequestStrategy,
+                  RemoveExtraStrategy,
+                  RemoveAnyKeyStrategy].freeze
 
-    def self.truncate(payload)
+    def self.truncate(payload, attempts = [])
       result = nil
 
       STRATEGIES.each do |strategy|
         result = strategy.call(payload)
+        attempts << result.bytesize
         break unless truncate?(result)
       end
 

data/lib/rollbar/util/hash.rb

@@ -5,6 +5,7 @@ module Rollbar
         return if seen[hash.object_id]
 
         seen[hash.object_id] = true
+        replace_seen_children(hash, seen)
 
         hash.reduce({}) do |h, (key, value)|
           h[key.to_s] = map_value(value, :deep_stringify_keys, seen)
@@ -22,12 +23,26 @@ module Rollbar
             thing
           else
             seen[thing.object_id] = true
+            replace_seen_children(thing, seen)
             thing.map { |v| map_value(v, meth, seen) }
           end
         else
           thing
         end
       end
+
+      def self.replace_seen_children(thing, seen)
+        case thing
+        when ::Hash
+          thing.keys.each do |key|
+            thing[key] = "removed circular reference: #{thing[key]}" if seen[thing[key].object_id]
+          end
+        when Array
+          thing.each_with_index do |_, i|
+            thing[i] = "removed circular reference: #{thing[i]}" if seen[thing[i].object_id]
+          end
+        end
+      end
     end
   end
 end

data/lib/rollbar/util/ip_anonymizer.rb

@@ -5,26 +5,27 @@ module Rollbar
 
       def self.anonymize_ip(ip_string)
         return ip_string unless Rollbar.configuration.anonymize_user_ip
+
         ip = IPAddr.new(ip_string)
         return anonymize_ipv6 ip if ip.ipv6?
         return anonymize_ipv4 ip if ip.ipv4?
-      rescue
+      rescue StandardError
         nil
       end
-      
+
       def self.anonymize_ipv4(ip)
         ip_parts = ip.to_s.split '.'
-        
+
         ip_parts[ip_parts.count - 1] = '0'
-        
+
         IPAddr.new(ip_parts.join('.')).to_s
       end
-      
+
       def self.anonymize_ipv6(ip)
         ip_parts = ip.to_s.split ':'
-        
+
         ip_string = ip_parts[0..2].join(':') + ':0000:0000:0000:0000:0000'
-        
+
         IPAddr.new(ip_string).to_s
       end
     end

data/lib/rollbar/util/ip_obfuscator.rb

@@ -13,7 +13,7 @@ module Rollbar
         obfuscated_ip_int32 = ip_int32 ^ secret_int32 % (2 << 31)
 
         IPAddr.new(obfuscated_ip_int32, Socket::AF_INET).to_s
-      rescue
+      rescue StandardError
         nil
       end
     end

data/lib/rollbar/util.rb

@@ -2,6 +2,10 @@ require 'rollbar/util/hash'
 
 module Rollbar
   module Util # :nodoc:
+    def self.iterate_and_update_with_block(obj, &block)
+      iterate_and_update(obj, block)
+    end
+
     def self.iterate_and_update(obj, block, seen = {})
       return if obj.frozen? || seen[obj.object_id]
 
@@ -63,9 +67,9 @@ module Rollbar
 
     def self.clone_obj(obj)
       if obj.is_a?(::Hash)
-        obj.clone
+        obj.dup
       elsif obj.is_a?(Array)
-        obj.clone.clear
+        obj.dup.clear
       else
         obj
       end

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = '2.19.1'
+  VERSION = '2.27.1'.freeze
 end

data/lib/rollbar.rb

@@ -1,7 +1,6 @@
 require 'net/protocol'
 require 'net/https'
 require 'socket'
-require 'thread'
 require 'uri'
 require 'open-uri'
 require 'forwardable'
@@ -22,10 +21,10 @@ require 'rollbar/notifier'
 # The Rollbar module. It stores a Rollbar::Notifier per thread and
 # provides some module methods in order to use the current thread notifier.
 module Rollbar
-  PUBLIC_NOTIFIER_METHODS = %w(debug info warn warning error critical log logger
+  PUBLIC_NOTIFIER_METHODS = %w[debug info warn warning error critical log logger
                                process_item process_from_async_handler scope
                                send_failsafe log_info log_debug log_warning
-                               log_error silenced scope_object).freeze
+                               log_error silenced scope_object].freeze
 
   class << self
     extend Forwardable

data/lib/tasks/benchmark.rake

@@ -0,0 +1,103 @@
+require 'benchmark'
+
+namespace :benchmark do
+  desc 'Measure TracePoint perf for current Ruby'
+  task :trace_point do
+    ARGV.each { |a| task(a.to_sym { ; }) } # Keep rake from treating these ask task names.
+
+    options = {}.tap do |hash|
+      ARGV.each { |arg| hash[arg] = true }
+    end
+
+    puts "options: #{options}"
+
+    trace_with_bindings = BenchmarkTraceWithBindings.new(options)
+
+    trace_with_bindings.enable
+    puts(Benchmark.measure do
+      TraceTest.benchmark_with_locals
+    end)
+    trace_with_bindings.disable
+
+    puts "counts: #{trace_with_bindings.counts}" if options['counts']
+  end
+end
+
+class TraceTest # :nodoc:
+  class << self
+    def benchmark_with_locals
+      foo = false
+
+      (0..20_000).each do |index|
+        foo = TraceTest
+
+        change_frame_with_locals(foo, index)
+      end
+    end
+
+    def change_frame_with_locals(foo, _index)
+      foo.tap do |obj|
+        bar = 'bar'
+        hash = { :foo => obj, :bar => bar } # rubocop:disable Lint/UselessAssignment
+      end
+    end
+  end
+end
+
+class BenchmarkTraceWithBindings # :nodoc:
+  attr_reader :frames, :exception_frames, :options, :counts
+
+  def initialize(options = {})
+    @options = options
+    @frames = []
+    @exception_frames = []
+    @exception_signature = nil
+    @counts = init_counts({})
+  end
+
+  def init_counts(counts)
+    [:call, :b_call, :c_call, :class].each do |event|
+      counts[event] = 0
+    end
+    counts
+  end
+
+  def enable
+    return if options['disable']
+
+    trace_point.enable if defined?(TracePoint)
+  end
+
+  def disable
+    return if options['disable']
+
+    trace_point.disable if defined?(TracePoint)
+  end
+
+  def trace_point # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    return unless defined?(TracePoint)
+
+    @trace_point ||= TracePoint.new(:call, :return, :b_call, :b_return, :c_call, :c_return, :raise) do |tp|
+      next if options['hook_only']
+
+      case tp.event
+      when :call, :b_call, :c_call, :class
+        @counts[tp.event] += 1 if options['counts']
+        frame = options['frame'] ? frame(tp) : {}
+        frames.push frame if options['stack']
+      when :return, :b_return, :c_return, :end
+        frames.pop if options['stack']
+      end
+    end
+  end
+
+  def frame(trace)
+    {
+      :binding => trace.binding,
+      :defined_class => trace.defined_class,
+      :method_id => trace.method_id,
+      :path => trace.path,
+      :lineno => trace.lineno
+    }
+  end
+end

data/rollbar.gemspec

@@ -1,21 +1,29 @@
 # -*- encoding: utf-8 -*-
+
 require File.expand_path('../lib/rollbar/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  is_jruby = defined?(JRUBY_VERSION) || (defined?(RUBY_ENGINE) && 'jruby' == RUBY_ENGINE)
+  _is_jruby = defined?(JRUBY_VERSION) || (defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby')
 
   gem.authors       = ['Rollbar, Inc.']
   gem.email         = ['support@rollbar.com']
-  gem.description   = %q{Easy and powerful exception tracking for Ruby}
+  gem.description   = 'Easy and powerful exception tracking for Ruby'
   gem.executables   = ['rollbar-rails-runner']
-  gem.summary       = %q{Reports exceptions to Rollbar}
+  gem.summary       = 'Reports exceptions to Rollbar'
   gem.homepage      = 'https://rollbar.com'
   gem.license       = 'MIT'
   gem.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  gem.files        += ['spec/support/rollbar_api.rb'] # useful helper for app spec/tests.
   gem.name          = 'rollbar'
   gem.require_paths = ['lib']
   gem.required_ruby_version = '>= 1.9.3'
-  gem.version       = Rollbar::VERSION
+  gem.version = Rollbar::VERSION
 
-  gem.add_runtime_dependency 'multi_json'
+  if gem.respond_to?(:metadata)
+    gem.metadata['changelog_uri'] = 'https://github.com/rollbar/rollbar-gem/releases'
+    gem.metadata['source_code_uri'] = 'https://github.com/rollbar/rollbar-gem'
+    gem.metadata['bug_tracker_uri'] = 'https://github.com/rollbar/rollbar-gem/issues'
+    gem.metadata['homepage_uri'] = 'https://rollbar.com/'
+    gem.metadata['documentation_uri'] = 'https://docs.rollbar.com/docs/ruby'
+  end
 end