rollbar 2.20.0 → 2.22.1

data/lib/rollbar/request_data_extractor.rb

@@ -210,8 +210,7 @@ module Rollbar
     def json_request?(rack_req)
       json_regex = /\bjson\b/
 
-      !!(rack_req.env['CONTENT_TYPE'] =~ json_regex ||
-         rack_req.env['HTTP_ACCEPT'] =~ json_regex)
+      !!(rack_req.env['CONTENT_TYPE'] =~ json_regex)
     end
 
     def rollbar_route_params(env)

data/lib/rollbar/rollbar_test.rb

@@ -0,0 +1,147 @@
+require 'rollbar'
+begin
+  require 'rack/mock'
+rescue LoadError
+  puts 'Cannot load rack/mock'
+end
+require 'logger'
+
+# Module to inject into the Rails controllers or rack apps
+module RollbarTest # :nodoc:
+  def test_rollbar
+    puts 'Raising RollbarTestingException to simulate app failure.'
+
+    raise RollbarTestingException.new, ::RollbarTest.success_message
+  end
+
+  def self.run
+    return unless confirmed_token?
+
+    configure_rails if defined?(Rails)
+
+    puts 'Testing manual report...'
+    Rollbar.error('Test error from rollbar:test')
+
+    return unless defined?(Rack::MockRequest)
+
+    protocol, app = setup_app
+
+    puts 'Processing...'
+    env = Rack::MockRequest.env_for("#{protocol}://www.example.com/verify", 'REMOTE_ADDR' => '127.0.0.1')
+    status, = app.call(env)
+
+    puts error_message unless status.to_i == 500
+  end
+
+  def self.configure_rails
+    Rails.logger = if defined?(ActiveSupport::TaggedLogging)
+                     ActiveSupport::TaggedLogging.new(Logger.new(STDOUT))
+                   else
+                     Logger.new(STDOUT)
+                   end
+
+    Rails.logger.level = Logger::DEBUG
+    Rollbar.preconfigure do |config|
+      config.logger = Rails.logger
+    end
+  end
+
+  def self.confirmed_token?
+    return true if Rollbar.configuration.access_token
+
+    puts token_error_message
+
+    false
+  end
+
+  def self.authlogic_config
+    # from http://stackoverflow.com/questions/5270835/authlogic-activation-problems
+    return unless defined?(Authlogic)
+
+    Authlogic::Session::Base.controller = Authlogic::ControllerAdapters::RailsAdapter.new(self)
+  end
+
+  def self.setup_app
+    puts 'Setting up the test app.'
+
+    if defined?(Rails)
+      app = rails_app
+
+      draw_rails_route(app)
+
+      authlogic_config
+
+      [rails_protocol(app), app]
+    else
+      ['http', rack_app]
+    end
+  end
+
+  def self.rails_app
+    # The setup below is needed for Rails 5.x, but not for Rails 4.x and below.
+    # (And fails on Rails 4.x in various ways depending on the exact version.)
+    return Rails.application if Rails.version < '5.0.0'
+
+    # Spring now runs by default in development on all new Rails installs. This causes
+    # the new `/verify` route to not get picked up if `config.cache_classes == false`
+    # which is also a default in development env.
+    #
+    # `config.cache_classes` needs to be set, but the only possible time is at app load,
+    # so here we clone the default app with an updated config.
+    #
+    config = Rails.application.config
+    config.cache_classes = true
+
+    # Make a copy of the app, so the config can be updated.
+    Rails.application.class.name.constantize.new(:config => config)
+  end
+
+  def self.draw_rails_route(app)
+    app.routes_reloader.execute_if_updated
+    app.routes.draw do
+      get 'verify' => 'rollbar_test#verify', :as => 'verify'
+    end
+  end
+
+  def self.rails_protocol(app)
+    defined?(app.config.force_ssl && app.config.force_ssl) ? 'https' : 'http'
+  end
+
+  def self.rack_app
+    Class.new do
+      include RollbarTest
+
+      def self.call(_env)
+        new.test_rollbar
+      end
+    end
+  end
+
+  def self.token_error_message
+    'Rollbar needs an access token configured. Check the README for instructions.'
+  end
+
+  def self.error_message
+    'Test failed! You may have a configuration issue, or you could be using a gem that\'s blocking the test. Contact support@rollbar.com if you need help troubleshooting.'
+  end
+
+  def self.success_message
+    'Testing rollbar with "rake rollbar:test". If you can see this, it works.'
+  end
+end
+
+class RollbarTestingException < RuntimeError; end
+
+if defined?(Rails)
+  class RollbarTestController < ActionController::Base # :nodoc:
+    include RollbarTest
+
+    def verify
+      test_rollbar
+    end
+
+    def logger
+      nil
+    end
+  end
+end

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]),

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,7 +16,10 @@ module Rollbar
     STRATEGIES = [RawStrategy,
                   FramesStrategy,
                   StringsStrategy,
-                  MinBodyStrategy].freeze
+                  MinBodyStrategy,
+                  RemoveRequestStrategy,
+                  RemoveExtraStrategy,
+                  RemoveAnyKeyStrategy].freeze
 
     def self.truncate(payload, attempts = [])
       result = nil

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/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, 128, 64].freeze
+      STRING_THRESHOLDS = [1024, 512, 256].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

data/lib/rollbar/util.rb

@@ -63,9 +63,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/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