rollbar 2.12.0 → 2.13.0

data/lib/rollbar/plugins/delayed_job/job_data.rb

@@ -1,29 +1,48 @@
-class JobData
-  attr_reader :job
+module Rollbar
+  module Delayed
+    class JobData
+      attr_reader :job
 
-  def initialize(job)
-    @job = job
-  end
+      def initialize(job)
+        @job = job
+      end
 
-  def to_hash
-    job_data = job.as_json
-    handler_parent = job_data['job'] ? job_data['job'] : job_data
-    handler_parent['handler'] = handler_data
+      def to_hash
+        job_data = extract_job_data
 
-    job_data
-  end
+        handler_parent = job_data['job'] ? job_data['job'] : job_data
+        handler_parent['handler'] = handler_data
+
+        job_data
+      end
+
+      private
+
+      def extract_job_data
+        if job.respond_to?(:as_json)
+          job.as_json
+        else
+          Hash[job.to_hash.map { |k, v| [k.to_s, v] }]
+        end
+      end
+
+      def handler_data
+        payload_object = job.payload_object
 
-  private
+        return payload_object unless payload_object.respond_to?(:object)
 
-  def handler_data
-    object = job.payload_object.object
+        object_data(payload_object.object)
+      end
 
-    {
-      :method_name => job.payload_object.method_name,
-      :args => job.payload_object.args,
-      :object => object.is_a?(Class) ? object.name : object.to_s
-    }
-  rescue
-    {}
+      def object_data(object)
+        {
+          :method_name => job.payload_object.method_name,
+          :args => job.payload_object.args,
+          :object => object.is_a?(Class) ? object.name : object.to_s
+        }
+      rescue
+        {}
+      end
+    end
   end
 end

data/lib/rollbar/plugins/rails.rb

@@ -31,7 +31,7 @@ Rollbar.plugins.define('rails-rollbar.js') do
           # customer is using SecureHeaders > 3.0
           class Rails
             def load(plugin)
-              plugin_execute = plugin_execute_proc(plugin)
+              plugin_execute = plugin_execute_proc_body(plugin)
 
               return after_secure_headers(&plugin_execute) if secure_headers_middleware?
 
@@ -42,7 +42,7 @@ Rollbar.plugins.define('rails-rollbar.js') do
               Rollbar::Railtie.initializer('rollbar.js.frameworks.rails', :after => 'secure_headers.middleware', &block)
             end
 
-            def plugin_execute_proc(plugin)
+            def plugin_execute_proc_body(plugin)
               proc do
                 plugin.execute do
                   if Rollbar.configuration.js_enabled

data/lib/rollbar/plugins/rake.rb

@@ -5,17 +5,38 @@ Rollbar.plugins.define('rake') do
 
   module Rollbar
     module Rake
+      class << self
+        attr_accessor :patched
+      end
+
+      module Handler
+        def self.included(base)
+          base.class_eval do
+            alias_method :orig_display_error_message, :display_error_message
+            alias_method :display_error_message, :display_error_message_with_rollbar
+          end
+        end
+
+        def display_error_message_with_rollbar(ex)
+          Rollbar.error(ex, :use_exception_level_filters => true)
+          orig_display_error_message(ex)
+        end
+      end
+
       def self.patch!
-        skip_patch && return unless patch?
+        unless patch?
+          skip_patch
 
-        ::Rake::Application.class_eval do
-          alias_method :orig_display_error_message, :display_error_message
+          return
+        end
 
-          def display_error_message(ex)
-            Rollbar.error(ex, :use_exception_level_filters => true)
-            orig_display_error_message(ex)
+        ::Rake.application.instance_eval do
+          class << self
+            include ::Rollbar::Rake::Handler
           end
         end
+
+        self.patched = true
       end
 
       def self.skip_patch
@@ -23,6 +44,7 @@ Rollbar.plugins.define('rake') do
       end
 
       def self.patch?
+        return false if patched?
         return false unless rake_version
 
         major, minor, = rake_version.split('.').map(&:to_i)
@@ -30,6 +52,10 @@ Rollbar.plugins.define('rake') do
         major > 0 || major == 0 && minor > 8
       end
 
+      def self.patched?
+        patched
+      end
+
       def self.rake_version
         if Object.const_defined?('RAKEVERSION')
           return RAKEVERSION

data/lib/rollbar/plugins/resque.rb

@@ -0,0 +1,11 @@
+Rollbar.plugins.define('resque') do
+  require_dependency('resque')
+
+  # We want to have Resque::Failure::Rollbar loaded before
+  # possible initializers, so the users can use the class
+  # when configuring Rollbar::Failure.backend or
+  # Rollbar::Failure::Multiple.classes
+  execute! do
+    require 'rollbar/plugins/resque/failure'
+  end
+end

data/lib/rollbar/plugins/resque/failure.rb

@@ -0,0 +1,39 @@
+require 'rollbar'
+
+module Resque
+  module Failure
+    # Falure class to use in Resque in order to send
+    # Resque errors to the Rollbar API
+    class Rollbar < Base
+      def save
+        payload_with_options =
+          if use_exception_level_filters?
+            payload.merge(:use_exception_level_filters => true)
+          else
+            payload
+          end
+
+        rollbar.error(exception, payload_with_options)
+      end
+
+      private
+
+      # We want to disable async reporting since original
+      # resque-rollbar implementation disabled it.
+      def rollbar
+        notifier = ::Rollbar.notifier.scope
+        notifier.configuration.use_async = false
+
+        notifier
+      end
+
+      def use_exception_level_filters?
+        Gem::Version.new(rollbar_version) > Gem::Version.new('1.3.0')
+      end
+
+      def rollbar_version
+        ::Rollbar::VERSION
+      end
+    end
+  end
+end

data/lib/rollbar/plugins/validations.rb

@@ -29,5 +29,15 @@ Rollbar.plugins.define('active_model') do
     ActiveModel::Validations.module_eval do
       include Rollbar::ActiveRecordExtension
     end
+
+    # If ActiveRecord::Base has been already loaded,
+    # it's including a not updated version of ActiveModel::Validations
+    # We then want to include Rollbar::ActiveRecordExtension
+    # in ActiveRecord::Base
+    if defined?(ActiveRecord::Base)
+      ActiveRecord::Base.class_eval do
+        include Rollbar::ActiveRecordExtension
+      end
+    end
   end
 end

data/lib/rollbar/request_data_extractor.rb

@@ -5,9 +5,12 @@ require 'rollbar/scrubbers'
 require 'rollbar/scrubbers/url'
 require 'rollbar/scrubbers/params'
 require 'rollbar/util/ip_obfuscator'
+require 'rollbar/json'
 
 module Rollbar
   module RequestDataExtractor
+    ALLOWED_HEADERS_REGEX = /^HTTP_|^CONTENT_TYPE$|^CONTENT_LENGTH$/
+
     def extract_person_data_from_controller(env)
       if env.has_key?('rollbar.person_data')
         person_data = env['rollbar.person_data'] || {}
@@ -21,9 +24,8 @@ module Rollbar
 
     def extract_request_data_from_rack(env)
       rack_req = ::Rack::Request.new(env)
-
       sensitive_params = sensitive_params_list(env)
-      request_params = scrub_params(rollbar_request_params(env), sensitive_params)
+
       get_params = scrub_params(rollbar_get_params(rack_req), sensitive_params)
       post_params = scrub_params(rollbar_post_params(rack_req), sensitive_params)
       raw_body_params = scrub_params(mergeable_raw_body_params(rack_req), sensitive_params)
@@ -32,17 +34,18 @@ module Rollbar
       route_params = scrub_params(rollbar_route_params(env), sensitive_params)
 
       url = scrub_url(rollbar_url(env), sensitive_params)
-      params = request_params.merge(get_params).merge(post_params).merge(raw_body_params)
 
       data = {
-        :params => params,
         :url => url,
+        :params => route_params,
+        :GET => get_params,
+        :POST => post_params,
+        :body => Rollbar::JSON.dump(raw_body_params),
         :user_ip => rollbar_user_ip(env),
         :headers => rollbar_headers(env),
         :cookies => cookies,
         :session => session,
-        :method => rollbar_request_method(env),
-        :route => route_params
+        :method => rollbar_request_method(env)
       }
 
       if env['action_dispatch.request_id']
@@ -92,7 +95,7 @@ module Rollbar
     end
 
     def rollbar_headers(env)
-      env.keys.grep(/^HTTP_/).map do |header|
+      env.keys.grep(ALLOWED_HEADERS_REGEX).map do |header|
         name = header.gsub(/^HTTP_/, '').split('_').map(&:capitalize).join('-')
         if name == 'Cookie'
           {}
@@ -125,13 +128,33 @@ module Rollbar
     end
 
     def rollbar_user_ip(env)
-      user_ip_string = (env['action_dispatch.remote_ip'] || env['HTTP_X_REAL_IP'] || env['HTTP_X_FORWARDED_FOR'] || env['REMOTE_ADDR']).to_s
+      user_ip_string = (env['action_dispatch.remote_ip'] || env['HTTP_X_REAL_IP'] || x_forwarded_for_client(env['HTTP_X_FORWARDED_FOR']) || env['REMOTE_ADDR']).to_s
 
       Rollbar::Util::IPObfuscator.obfuscate_ip(user_ip_string)
     rescue
       nil
     end
 
+    def x_forwarded_for_client(header_value)
+      return nil unless header_value
+
+      ips = header_value.split(',').map(&:strip)
+
+      find_not_private_ip(ips)
+    end
+
+    def find_not_private_ip(ips)
+      ips.detect do |ip|
+        octets = ip.match(/^(\d{1,3}).(\d{1,3}).(\d{1,3}).(\d{1,3})$/)[1, 4].map(&:to_i)
+
+        is_private = (octets[0] == 10) ||
+                     ((octets[0] == 172) && (octets[1] >= 16) && (octets[1] <= 31)) ||
+                     ((octets[0] == 192) && (octets[1] == 168))
+
+        !is_private
+      end
+    end
+
     def rollbar_get_params(rack_req)
       rack_req.GET
     rescue
@@ -162,21 +185,16 @@ module Rollbar
          rack_req.env['ACCEPT'] =~ /\bjson\b/)
     end
 
-    def rollbar_request_params(env)
-      env['action_dispatch.request.parameters'] || {}
-    end
-
     def rollbar_route_params(env)
       return {} unless defined?(Rails)
 
       begin
-        route = ::Rails.application.routes.recognize_path(env['PATH_INFO'])
+        environment = { :method => rollbar_request_method(env) }
 
-        {
-          :controller => route[:controller],
-          :action => route[:action],
-          :format => route[:format]
-        }
+        # recognize_path() will return the controller, action
+        # route params (if any)and format (if defined)
+        ::Rails.application.routes.recognize_path(env['PATH_INFO'],
+                                                  environment)
       rescue
         {}
       end

data/lib/rollbar/scrubbers/params.rb

@@ -1,3 +1,4 @@
+require 'tempfile'
 require 'rollbar/scrubbers'
 
 module Rollbar
@@ -7,7 +8,7 @@ module Rollbar
     # Also, if that configuration option is se to :scrub_all, it will scrub all
     # received parameters
     class Params
-      SKIPPED_CLASSES = [Tempfile]
+      SKIPPED_CLASSES = [::Tempfile]
       ATTACHMENT_CLASSES = %w(ActionDispatch::Http::UploadedFile Rack::Multipart::UploadedFile).freeze
       SCRUB_ALL = :scrub_all
 

data/lib/rollbar/truncation.rb

@@ -9,7 +9,7 @@ module Rollbar
   module Truncation
     extend ::Rollbar::Truncation::Mixin
 
-    MAX_PAYLOAD_SIZE = 128 * 1024 # 128kb
+    MAX_PAYLOAD_SIZE = 512 * 1024 # 512kb
     STRATEGIES = [RawStrategy,
                   FramesStrategy,
                   StringsStrategy,

data/lib/rollbar/truncation/frames_strategy.rb

@@ -1,4 +1,5 @@
 require 'rollbar/truncation/mixin'
+require 'rollbar/util'
 
 module Rollbar
   module Truncation
@@ -10,7 +11,7 @@ module Rollbar
       end
 
       def call(payload)
-        new_payload = payload.clone
+        new_payload = Rollbar::Util.deep_copy(payload)
         body = new_payload['data']['body']
 
         if body['trace_chain']

data/lib/rollbar/truncation/min_body_strategy.rb

@@ -1,4 +1,5 @@
 require 'rollbar/truncation/mixin'
+require 'rollbar/util'
 
 module Rollbar
   module Truncation
@@ -10,7 +11,7 @@ module Rollbar
       end
 
       def call(payload)
-        new_payload = payload.clone
+        new_payload = Rollbar::Util.deep_copy(payload)
         body = new_payload['data']['body']
 
         if body['trace_chain']

data/lib/rollbar/truncation/strings_strategy.rb

@@ -14,7 +14,7 @@ module Rollbar
 
       def call(payload)
         result = nil
-        new_payload = payload.clone
+        new_payload = Rollbar::Util.deep_copy(payload)
 
         STRING_THRESHOLDS.each do |threshold|
           truncate_proc = truncate_strings_proc(threshold)

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = '2.12.0'
+  VERSION = '2.13.0'.freeze
 end

data/spec/controllers/home_controller_spec.rb

@@ -6,6 +6,7 @@ describe HomeController do
   let(:notifier) { Rollbar.notifier }
 
   before do
+    Rollbar.clear_notifier!
     reset_configuration
     preconfigure_rails_notifier
 
@@ -53,7 +54,6 @@ describe HomeController do
       data.should have_key(:headers)
       data.should have_key(:session)
       data.should have_key(:method)
-      data.should have_key(:route)
     end
 
     it "should build empty person data when no one is logged-in" do
@@ -169,21 +169,10 @@ describe HomeController do
     end
 
     context "rollbar_route_params", :type => 'request' do
-      it "should save route params in request[:route]" do
-        route = controller.send(:rollbar_request_data)[:route]
-
-        route.should have_key(:controller)
-        route.should have_key(:action)
-        route.should have_key(:format)
-
-        route[:controller].should == 'home'
-        route[:action].should == 'index'
-      end
-
       it "should save controller and action in the payload body" do
         post '/report_exception'
 
-        route = controller.send(:rollbar_request_data)[:route]
+        route = controller.send(:rollbar_request_data)[:params]
 
         route[:controller].should == 'home'
         route[:action].should == 'report_exception'
@@ -206,7 +195,7 @@ describe HomeController do
 
       post '/report_exception', params
 
-      filtered = Rollbar.last_report[:request][:params]
+      filtered = Rollbar.last_report[:request][:POST]
 
       expect(filtered["passwd"]).to match(/\**/)
       expect(filtered["password"]).to match(/\**/)
@@ -229,7 +218,7 @@ describe HomeController do
 
       post '/report_exception', params
 
-      filtered = Rollbar.last_report[:request][:params]
+      filtered = Rollbar.last_report[:request][:POST]
 
       filtered["passwd"].should == "visible"
       # config.filter_parameters is set to [:password] in
@@ -262,7 +251,7 @@ describe HomeController do
       put '/report_exception', { :putparam => "putval" }
 
       Rollbar.last_report.should_not be_nil
-      Rollbar.last_report[:request][:params]["putparam"].should == "putval"
+      Rollbar.last_report[:request][:POST]["putparam"].should == "putval"
     end
 
     context 'using deprecated report_exception' do
@@ -272,7 +261,7 @@ describe HomeController do
         put '/deprecated_report_exception', { :putparam => "putval" }
 
         Rollbar.last_report.should_not be_nil
-        Rollbar.last_report[:request][:params]["putparam"].should == "putval"
+        Rollbar.last_report[:request][:POST]["putparam"].should == "putval"
       end
     end
 
@@ -284,7 +273,7 @@ describe HomeController do
       post '/report_exception', params, { 'CONTENT_TYPE' => 'application/json' }
 
       Rollbar.last_report.should_not be_nil
-      Rollbar.last_report[:request][:params]['jsonparam'].should == 'jsonval'
+      expect(Rollbar.last_report[:request][:body]).to be_eql(params)
     end
   end
 
@@ -306,7 +295,7 @@ describe HomeController do
         config['action_dispatch.show_exceptions'] = true
       end
 
-      after(:each) do
+      after do
         if Dummy::Application.respond_to? :env_config
           config = Dummy::Application.env_config
         else
@@ -356,7 +345,7 @@ describe HomeController do
       expect { get '/foo/bar', { :foo => :bar } }.to raise_exception(ActionController::RoutingError)
 
       report = Rollbar.last_report
-      expect(report[:request][:params]['foo']).to be_eql('bar')
+      expect(report[:request][:GET]['foo']).to be_eql('bar')
     end
   end
 
@@ -378,7 +367,7 @@ describe HomeController do
       it "saves attachment data" do
         expect { post '/file_upload', { :upload => file1 } }.to raise_exception(NameError)
 
-        upload_param = Rollbar.last_report[:request][:params]['upload']
+        upload_param = Rollbar.last_report[:request][:POST]['upload']
 
         expect(upload_param).to have_key(:filename)
         expect(upload_param).to have_key(:type)
@@ -392,7 +381,7 @@ describe HomeController do
     context 'with multiple uploads', :type => :request do
       it "saves attachment data for all uploads" do
         expect { post '/file_upload', { :upload => [file1, file2] } }.to raise_exception(NameError)
-        sent_params = Rollbar.last_report[:request][:params]['upload']
+        sent_params = Rollbar.last_report[:request][:POST]['upload']
 
         expect(sent_params).to be_kind_of(Array)
         expect(sent_params.size).to be(2)
@@ -420,7 +409,7 @@ describe HomeController do
         post '/cause_exception', params, { 'ACCEPT' => 'application/vnd.github.v3+json' }
       end.to raise_exception(NameError)
 
-      expect(Rollbar.last_report[:request][:params]['foo']).to be_eql('bar')
+      expect(Rollbar.last_report[:request][:POST]['foo']).to be_eql('bar')
     end
   end
 
@@ -448,7 +437,7 @@ describe HomeController do
     end
   end
 
-  after(:each) do
+  after do
     Rollbar.configure do |config|
       config.logger = ::Rails.logger
     end