rollbar 2.20.1 → 2.21.0

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

@@ -6,6 +6,7 @@ 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
@@ -17,7 +18,8 @@ module Rollbar
                   StringsStrategy,
                   MinBodyStrategy,
                   RemoveRequestStrategy,
-                  RemoveExtraStrategy].freeze
+                  RemoveExtraStrategy,
+                  RemoveAnyKeyStrategy].freeze
 
     def self.truncate(payload, attempts = [])
       result = nil

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/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

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = '2.20.1'.freeze
+  VERSION = '2.21.0'.freeze
 end

data/rollbar.gemspec

@@ -18,8 +18,6 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 1.9.3'
   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'

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rollbar
 version: !ruby/object:Gem::Version
-  version: 2.20.1
+  version: 2.21.0
 platform: ruby
 authors:
 - Rollbar, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-30 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2019-07-12 00:00:00.000000000 Z
+dependencies: []
 description: Easy and powerful exception tracking for Ruby
 email:
 - support@rollbar.com
@@ -59,7 +45,7 @@ files:
 - gemfiles/rails50.gemfile
 - gemfiles/rails51.gemfile
 - gemfiles/rails52.gemfile
-- gemfiles/ruby_1_8_and_1_9_2.gemfile
+- gemfiles/rails60.gemfile
 - lib/generators/rollbar/rollbar_generator.rb
 - lib/generators/rollbar/templates/initializer.rb
 - lib/rails/rollbar_runner.rb
@@ -88,8 +74,6 @@ files:
 - lib/rollbar/item/locals.rb
 - lib/rollbar/js.rb
 - lib/rollbar/json.rb
-- lib/rollbar/json/default.rb
-- lib/rollbar/json/oj.rb
 - lib/rollbar/language_support.rb
 - lib/rollbar/lazy_store.rb
 - lib/rollbar/logger.rb
@@ -128,6 +112,7 @@ files:
 - lib/rollbar/rails.rb
 - lib/rollbar/rake_tasks.rb
 - lib/rollbar/request_data_extractor.rb
+- lib/rollbar/rollbar_test.rb
 - lib/rollbar/scrubbers.rb
 - lib/rollbar/scrubbers/params.rb
 - lib/rollbar/scrubbers/url.rb
@@ -136,6 +121,7 @@ files:
 - lib/rollbar/truncation/min_body_strategy.rb
 - lib/rollbar/truncation/mixin.rb
 - lib/rollbar/truncation/raw_strategy.rb
+- lib/rollbar/truncation/remove_any_key_strategy.rb
 - lib/rollbar/truncation/remove_extra_strategy.rb
 - lib/rollbar/truncation/remove_request_strategy.rb
 - lib/rollbar/truncation/strings_strategy.rb

data/gemfiles/ruby_1_8_and_1_9_2.gemfile

@@ -1,51 +0,0 @@
-require 'rubygems/version'
-
-source 'https://rubygems.org'
-
-is_jruby = defined?(JRUBY_VERSION) || (defined?(RUBY_ENGINE) && 'jruby' == RUBY_ENGINE)
-
-gem 'appraisal', '= 1.0.2'
-gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
-gem 'hitimes', '< 1.2.2'
-gem 'jruby-openssl', :platform => :jruby
-gem 'rails', '3.0.20'
-gem 'rake', '< 11'
-gem 'rspec-rails', '>= 2.14.0'
-gem 'sqlite3', '< 1.4.0', :platform => [:ruby, :mswin, :mingw]
-
-gem 'oj', '~> 2.12.14' unless is_jruby
-if RUBY_VERSION > '1.8.7' && RUBY_VERSION < '2.2.2'
-  gem 'sidekiq', '>= 2.13.0', '< 5.0'
-end
-
-platforms :rbx do
-  gem 'minitest'
-  gem 'racc'
-  gem 'rubinius-developer_tools'
-  gem 'rubysl', '~> 2.0' unless RUBY_VERSION.start_with?('1')
-end
-
-if RUBY_VERSION.start_with?('1.9')
-  gem 'celluloid', '< 0.17.0'
-  gem 'sucker_punch', '~> 1.0'
-elsif RUBY_VERSION.start_with?('2')
-  gem 'sucker_punch', '~> 2.0'
-end
-
-gem 'database_cleaner', '~> 1.0.0'
-gem 'delayed_job', '4.1.3', :require => false
-gem 'genspec', '= 0.2.8'
-gem 'girl_friday', '>= 0.11.1'
-gem 'redis', '< 3.3.5'
-gem 'resque', '< 2.0.0'
-gem 'sinatra'
-
-ruby_version = RUBY_VERSION.dup
-
-if Gem::Version.new(ruby_version) < Gem::Version.new('2.0')
-  gem 'mime-types', '< 3.0'
-end
-
-gem 'capistrano', '<= 3.4.1', :require => false
-
-gemspec :path => '../'

data/lib/rollbar/json/default.rb

@@ -1,11 +0,0 @@
-module Rollbar
-  module JSON
-    module Default
-      module_function
-
-      def options
-        {}
-      end
-    end
-  end
-end

data/lib/rollbar/json/oj.rb

@@ -1,16 +0,0 @@
-module Rollbar
-  module JSON
-    module Oj
-      module_function
-
-      def options
-        {
-          :mode => :compat,
-          :use_to_json => false,
-          :symbol_keys => false,
-          :circular => false
-        }
-      end
-    end
-  end
-end