rollbar 2.16.2 → 2.22.1

data/lib/rollbar/plugin.rb

@@ -7,6 +7,8 @@ module Rollbar
     attr_reader :name
     attr_reader :dependencies
     attr_reader :callables
+    attr_reader :revert_callables
+    attr_accessor :on_demand
     attr_accessor :loaded
 
     private :loaded=
@@ -15,31 +17,73 @@ module Rollbar
       @name = name
       @dependencies = []
       @callables = []
+      @revert_callables = []
       @loaded = false
+      @on_demand = false
+    end
+
+    def load_on_demand
+      @on_demand = true
     end
 
     def configuration
       Rollbar.configuration
     end
 
+    def load_scoped!(transparent = false)
+      if transparent
+        load! if load?
+
+        result = yield
+
+        unload! if loaded
+      else
+        return unless load?
+
+        load!
+
+        result = yield
+
+        unload!
+      end
+
+      result
+    end
+
     def load!
       return unless load?
 
       begin
         callables.each(&:call)
-      rescue => e
+      rescue StandardError => e
         log_loading_error(e)
       ensure
         self.loaded = true
       end
     end
 
+    def unload!
+      return unless loaded
+
+      begin
+        revert_callables.each(&:call)
+      rescue StandardError => e
+        log_unloading_error(e)
+      ensure
+        self.loaded = false
+      end
+    end
+
     def execute(&block)
       callables << block
     end
 
-    def execute!(&block)
-      block.call if load?
+    def execute!
+      yield if load?
+    end
+
+    def revert(&block)
+      revert_callables << block
     end
 
     private
@@ -61,7 +105,7 @@ module Rollbar
 
     def load?
       !loaded && dependencies_satisfy?
-    rescue => e
+    rescue StandardError => e
       log_loading_error(e)
 
       false
@@ -71,8 +115,12 @@ module Rollbar
       dependencies.all?(&:call)
     end
 
-    def log_loading_error(e)
-      Rollbar.log_error("Error trying to load plugin '#{name}': #{e.class}, #{e.message}")
+    def log_loading_error(error)
+      Rollbar.log_error("Error trying to load plugin '#{name}': #{error.class}, #{error.message}")
+    end
+
+    def log_unloading_error(error)
+      Rollbar.log_error("Error trying to unload plugin '#{name}': #{error.class}, #{error.message}")
     end
   end
 end

data/lib/rollbar/plugins.rb

@@ -29,7 +29,13 @@ module Rollbar
     end
 
     def load!
-      collection.each(&:load!)
+      collection.each do |plugin|
+        plugin.load! unless plugin.on_demand
+      end
+    end
+
+    def get(name)
+      collection.find { |plugin| plugin.name == name }
     end
 
     private

data/lib/rollbar/plugins/active_job.rb

@@ -6,9 +6,13 @@ module Rollbar
         Rollbar.error(exception,
                       :job => self.class.name,
                       :job_id => job_id,
-                      :use_exception_level_filters => true)
+                      :use_exception_level_filters => true,
+                      :arguments => arguments)
         raise exception
       end
     end
   end
 end
+
+# Automatically add to ActionMailer::DeliveryJob
+ActionMailer::DeliveryJob.send(:include, Rollbar::ActiveJob) if defined?(ActionMailer::DeliveryJob)

data/lib/rollbar/plugins/basic_socket.rb

@@ -1,16 +1,31 @@
 Rollbar.plugins.define('basic_socket') do
+  load_on_demand
+
   dependency { !configuration.disable_core_monkey_patch }
 
   # Needed to avoid active_support (< 4.1.0) bug serializing JSONs
-  dependency { defined?(ActiveSupport::VERSION::STRING) }
+  dependency do
+    defined?(ActiveSupport::VERSION::STRING) &&
+      Gem::Version.new(ActiveSupport::VERSION::STRING) < Gem::Version.new('4.1.0')
+  end
 
   execute do
-    require 'socket'
-
-    class BasicSocket
-      def as_json(*)
-        to_s
+    class BasicSocket # :nodoc:
+      def new_as_json(_options = nil)
+        {
+          :value => inspect
+        }
       end
+      # alias_method is recommended over alias when aliasing at runtime.
+      # https://github.com/rubocop-hq/ruby-style-guide#alias-method
+      alias_method :original_as_json, :as_json # rubocop:disable Style/Alias
+      alias_method :as_json, :new_as_json # rubocop:disable Style/Alias
+    end
+  end
+
+  revert do
+    class BasicSocket # :nodoc:
+      alias_method :as_json, :original_as_json # rubocop:disable Style/Alias
     end
   end
 end

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

@@ -10,7 +10,7 @@ module Rollbar
       def to_hash
         job_data = extract_job_data
 
-        handler_parent = job_data['job'] ? job_data['job'] : job_data
+        handler_parent = job_data['job'] || job_data
         handler_parent['handler'] = handler_data
 
         job_data
@@ -32,7 +32,7 @@ module Rollbar
         return payload_object unless payload_object.respond_to?(:object)
 
         object_data(payload_object.object)
-      rescue
+      rescue StandardError
         {}
       end
 
@@ -42,7 +42,7 @@ module Rollbar
           :args => job.payload_object.args,
           :object => object.is_a?(Class) ? object.name : object.to_s
         }
-      rescue
+      rescue StandardError
         {}
       end
     end

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

@@ -9,10 +9,10 @@ module Rollbar
 
     class RollbarPlugin < ::Delayed::Plugin
       callbacks do |lifecycle|
-        lifecycle.around(:invoke_job, &Delayed::invoke_job_callback)
+        lifecycle.around(:invoke_job, &Delayed.invoke_job_callback)
         lifecycle.after(:failure) do |_, job, _, _|
           data = Rollbar::Delayed.build_job_data(job)
-          ::Rollbar.scope(:request => data).error(job.last_error, :use_exception_level_filters => true) if job.last_error
+          ::Rollbar.scope(:request => data).error("Job has failed and won't be retried anymore: " + job.last_error, :use_exception_level_filters => true) if job.last_error
         end
       end
     end
@@ -37,7 +37,7 @@ module Rollbar
       proc do |job, *args, &block|
         begin
           block.call(job, *args)
-        rescue => e
+        rescue StandardError => e
           report(e, job)
 
           raise e

data/lib/rollbar/plugins/goalie.rb

@@ -10,10 +10,18 @@ Rollbar.plugins.define('goalie') do
 
           begin
             controller = env['action_controller.instance']
-            request_data = controller.rollbar_request_data rescue nil
-            person_data = controller.rollbar_person_data rescue nil
+            request_data = begin
+                             controller.rollbar_request_data
+                           rescue StandardError
+                             nil
+                           end
+            person_data = begin
+                            controller.rollbar_person_data
+                          rescue StandardError
+                            nil
+                          end
             exception_data = Rollbar.scope(:request => request_data, :person => person_data).error(exception, :use_exception_level_filters => true)
-          rescue => e
+          rescue StandardError => e
             Rollbar.log_warning "[Rollbar] Exception while reporting exception to Rollbar: #{e}"
           end
 

data/lib/rollbar/plugins/rails/controller_methods.rb

@@ -1,4 +1,5 @@
 require 'rollbar/request_data_extractor'
+require 'rollbar/util'
 
 module Rollbar
   module Rails
@@ -6,13 +7,25 @@ module Rollbar
       include RequestDataExtractor
 
       def rollbar_person_data
-        user = send(Rollbar.configuration.person_method)
+        (user = send(Rollbar.configuration.person_method)) unless Rollbar::Util.method_in_stack_twice(:rollbar_person_data, __FILE__)
         # include id, username, email if non-empty
         if user
           {
-            :id => (user.send(Rollbar.configuration.person_id_method) rescue nil),
-            :username => (user.send(Rollbar.configuration.person_username_method) rescue nil),
-            :email => (user.send(Rollbar.configuration.person_email_method) rescue nil)
+            :id => (begin
+                      user.send(Rollbar.configuration.person_id_method)
+                    rescue StandardError
+                      nil
+                    end),
+            :username => (begin
+                            user.send(Rollbar.configuration.person_username_method)
+                          rescue StandardError
+                            nil
+                          end),
+            :email => (begin
+                         user.send(Rollbar.configuration.person_email_method)
+                       rescue StandardError
+                         nil
+                       end)
           }
         else
           {}

data/lib/rollbar/plugins/rails/railtie_mixin.rb

@@ -1,5 +1,3 @@
-require 'rollbar'
-
 module Rollbar
   module RailtieMixin
     extend ActiveSupport::Concern
@@ -16,7 +14,13 @@ module Rollbar
             config.environment ||= ::Rails.env
             config.root ||= ::Rails.root
             config.framework = "Rails: #{::Rails::VERSION::STRING}"
-            config.filepath ||= ::Rails.application.class.parent_name + '.rollbar'
+            config.filepath ||= begin
+              if ::Rails.application.class.respond_to?(:module_parent_name)
+                ::Rails.application.class.module_parent_name + '.rollbar'
+              else
+                ::Rails.application.class.parent_name + '.rollbar'
+              end
+            end
           end
         end
       end

data/lib/rollbar/plugins/rake.rb

@@ -58,9 +58,9 @@ Rollbar.plugins.define('rake') do
 
       def self.rake_version
         if Object.const_defined?('RAKEVERSION')
-          return RAKEVERSION
+          RAKEVERSION
         elsif ::Rake.const_defined?('VERSION')
-          return ::Rake::VERSION
+          ::Rake::VERSION
         end
       end
     end

data/lib/rollbar/plugins/sidekiq/plugin.rb

@@ -2,10 +2,10 @@ require 'rollbar/scrubbers/params'
 
 module Rollbar
   class Sidekiq
-    PARAM_BLACKLIST = %w[backtrace error_backtrace error_message error_class]
+    PARAM_BLACKLIST = %w[backtrace error_backtrace error_message error_class].freeze
 
     class ClearScope
-      def call(worker, msg, queue)
+      def call(_worker, _msg, _queue)
         Rollbar.reset_notifier!
 
         yield
@@ -38,12 +38,16 @@ module Rollbar
       Rollbar::Scrubbers::Params.call(options)
     end
 
-    def self.skip_report?(job_hash, e)
-      !job_hash.nil? && (job_hash['retry'] && job_hash['retry_count'] &&
-        job_hash['retry_count'] < ::Rollbar.configuration.sidekiq_threshold)
+    def self.skip_report?(job_hash, _e)
+      return false if job_hash.nil?
+
+      # when rollbar middleware catches, sidekiq's retry_job processor hasn't set
+      # the retry_count for the current job yet, so adding 1 gives the actual retry count
+      actual_retry_count = job_hash.fetch('retry_count', -1) + 1
+      job_hash['retry'] && actual_retry_count < ::Rollbar.configuration.sidekiq_threshold
     end
 
-    def call(worker, msg, queue)
+    def call(_worker, msg, _queue)
       Rollbar.reset_notifier!
 
       yield

data/lib/rollbar/rake_tasks.rb

@@ -1,93 +1,10 @@
-require 'rollbar'
-begin
-  require 'rack/mock'
-rescue LoadError
-end
-require 'logger'
 
 namespace :rollbar do
   desc 'Verify your gem installation by sending a test exception to Rollbar'
   task :test => [:environment] do
-    if defined?(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
-
-    class RollbarTestingException < RuntimeError; end
-
-    unless Rollbar.configuration.access_token
-      puts 'Rollbar needs an access token configured. Check the README for instructions.'
-
-      exit
-    end
-
-    puts 'Testing manual report...'
-    Rollbar.error('Test error from rollbar:test')
-
-    # Module to inject into the Rails controllers or
-    # rack apps
-    module RollbarTest
-      def test_rollbar
-        puts 'Raising RollbarTestingException to simulate app failure.'
-
-        raise RollbarTestingException.new, 'Testing rollbar with "rake rollbar:test". If you can see this, it works.'
-      end
-    end
-
-    if defined?(Rack::MockRequest)
-      if defined?(Rails)
-        puts 'Setting up the controller.'
-
-        class RollbarTestController < ActionController::Base
-          include RollbarTest
-
-          def verify
-            test_rollbar
-          end
-
-          def logger
-            nil
-          end
-        end
-
-        Rails.application.routes_reloader.execute_if_updated
-        Rails.application.routes.draw do
-          get 'verify' => 'rollbar_test#verify', :as => 'verify'
-        end
-
-        # from http://stackoverflow.com/questions/5270835/authlogic-activation-problems
-        if defined? Authlogic
-          Authlogic::Session::Base.controller = Authlogic::ControllerAdapters::RailsAdapter.new(self)
-        end
-
-        protocol = (defined? Rails.application.config.force_ssl && Rails.application.config.force_ssl) ? 'https' : 'http'
-        app = Rails.application
-      else
-        protocol = 'http'
-        app = Class.new do
-          include RollbarTest
-
-          def self.call(_env)
-            new.test_rollbar
-          end
-        end
-      end
-
-      puts 'Processing...'
-      env = Rack::MockRequest.env_for("#{protocol}://www.example.com/verify")
-      status, = app.call(env)
+    rollbar_dir = Gem.loaded_specs['rollbar'].full_gem_path
+    require "#{rollbar_dir}/lib/rollbar/rollbar_test"
 
-      unless status.to_i == 500
-        puts '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
-    end
+    RollbarTest.run
   end
 end