rollbar 2.8.3 → 3.6.0

data/lib/rollbar/plugins/rake.rb

@@ -0,0 +1,73 @@
+Rollbar.plugins.define('rake') do
+  require_dependency('rake')
+  dependency { !configuration.disable_monkey_patch }
+  dependency { defined?(Rake) }
+
+  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!
+        unless patch?
+          skip_patch
+
+          return
+        end
+
+        ::Rake.application.instance_eval do
+          class << self
+            include ::Rollbar::Rake::Handler
+          end
+        end
+
+        self.patched = true
+      end
+
+      def self.skip_patch
+        warn('[Rollbar] Rollbar is disabled for Rake tasks since your Rake ' \
+          'version is under 0.9.x. Please upgrade to 0.9.x or higher.')
+      end
+
+      def self.patch?
+        return false if patched?
+        return false unless rake_version
+
+        major, minor, = rake_version.split('.').map(&:to_i)
+
+        major > 0 || major == 0 && minor > 8
+      end
+
+      def self.patched?
+        patched
+      end
+
+      def self.rake_version
+        if Object.const_defined?('RAKEVERSION')
+          RAKEVERSION
+        elsif ::Rake.const_defined?('VERSION')
+          ::Rake::VERSION
+        end
+      end
+    end
+  end
+
+  execute do
+    Rollbar::Rake.patch!
+  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/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/sidekiq/plugin.rb

@@ -0,0 +1,77 @@
+require 'rollbar/scrubbers/params'
+
+module Rollbar
+  class Sidekiq
+    PARAM_BLACKLIST = %w[backtrace error_backtrace error_message error_class].freeze
+
+    class ResetScope
+      def call(_worker, msg, _queue, &block)
+        Rollbar.reset_notifier! # clears scope
+
+        return yield unless Rollbar.configuration.sidekiq_use_scoped_block
+
+        Rollbar.scoped(Rollbar::Sidekiq.job_scope(msg), &block)
+      end
+    end
+
+    def self.handle_exception(msg, e)
+      return if skip_report?(msg, e)
+
+      Rollbar.scope(job_scope(msg)).error(e, :use_exception_level_filters => true)
+    end
+
+    def self.skip_report?(msg, _e)
+      job_hash = job_hash_from_msg(msg)
+
+      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 self.job_scope(msg)
+      scope = {
+        :framework => "Sidekiq: #{::Sidekiq::VERSION}"
+      }
+      job_hash = job_hash_from_msg(msg)
+
+      unless job_hash.nil?
+        params = job_hash.reject { |k| PARAM_BLACKLIST.include?(k) }
+        scope[:request] = { :params => scrub_params(params) }
+        scope[:context] = params['class']
+        scope[:queue] = params['queue']
+      end
+
+      scope
+    end
+
+    def self.scrub_params(params)
+      options = {
+        :params => params,
+        :config => Rollbar.configuration.scrub_fields,
+        :whitelist => Rollbar.configuration.scrub_whitelist
+      }
+
+      Rollbar::Scrubbers::Params.call(options)
+    end
+
+    # see https://github.com/mperham/sidekiq/wiki/Middleware#server-middleware
+    def call(_worker, msg, _queue, &block)
+      Rollbar.reset_notifier! # clears scope
+
+      return yield unless Rollbar.configuration.sidekiq_use_scoped_block
+
+      Rollbar.scoped(Rollbar::Sidekiq.job_scope(msg), &block)
+    rescue Exception => e # rubocop:disable Lint/RescueException
+      Rollbar::Sidekiq.handle_exception(msg, e)
+      raise
+    end
+
+    def self.job_hash_from_msg(msg)
+      msg && (msg[:job] || msg)
+    end
+    private_class_method :job_hash_from_msg
+  end
+end

data/lib/rollbar/plugins/sidekiq.rb

@@ -0,0 +1,37 @@
+Rollbar.plugins.define('sidekiq >= 3') do
+  require_dependency('sidekiq')
+  dependency { !configuration.disable_monkey_patch }
+  dependency { defined?(Sidekiq) }
+  dependency { Sidekiq::VERSION.split('.')[0].to_i >= 3 }
+
+  execute do
+    require 'rollbar/plugins/sidekiq/plugin'
+
+    Sidekiq.configure_server do |config|
+      config.server_middleware do |chain|
+        chain.add Rollbar::Sidekiq::ResetScope
+      end
+
+      config.error_handlers << proc do |e, context, _sidekiq_config = nil|
+        Rollbar::Sidekiq.handle_exception(context, e)
+      end
+    end
+  end
+end
+
+Rollbar.plugins.define('sidekiq < 3') do
+  require_dependency('sidekiq')
+  dependency { !configuration.disable_monkey_patch }
+  dependency { defined?(Sidekiq) }
+  dependency { Sidekiq::VERSION.split('.')[0].to_i < 3 }
+
+  execute do
+    require 'rollbar/plugins/sidekiq/plugin'
+
+    Sidekiq.configure_server do |config|
+      config.server_middleware do |chain|
+        chain.add Rollbar::Sidekiq
+      end
+    end
+  end
+end

data/lib/rollbar/plugins/thread.rb

@@ -0,0 +1,14 @@
+Rollbar.plugins.define('thread') do
+  module Rollbar
+    module ThreadPlugin
+      def initialize(*args)
+        self[:_rollbar_notifier] ||= Rollbar.notifier.scope
+        super
+      end
+    end
+  end
+
+  execute do
+    Thread.send(:prepend, Rollbar::ThreadPlugin)
+  end
+end

data/lib/rollbar/plugins/validations.rb

@@ -0,0 +1,45 @@
+Rollbar.plugins.define('active_model') do
+  dependency { !configuration.disable_monkey_patch }
+  dependency { defined?(ActiveModel::Validations) }
+  dependency do
+    require 'active_model/version'
+
+    ActiveModel::VERSION::MAJOR >= 3
+  end
+
+  execute! do
+    module Rollbar
+      # Module that defines methods to be used by instances using
+      # ActiveModel::Validations
+      # The name is ActiveRecordExtension in order to not break backwards
+      # compatibility, although probably it should be named
+      # Rollbar::ValidationsExtension or similar
+      module ActiveRecordExtension
+        def report_validation_errors_to_rollbar
+          errors.full_messages.each do |error|
+            Rollbar.log_info(
+              "[Rollbar] Reporting form validation error: #{error} for #{self}"
+            )
+            Rollbar.warning("Form Validation Error: #{error} for #{self}")
+          end
+        end
+      end
+    end
+  end
+
+  execute! do
+    ActiveModel::Validations.module_eval do
+      include Rollbar::ActiveRecordExtension
+    end
+
+    active_support_was_defined = defined?(ActiveRecord::Base)
+
+    ActiveSupport.on_load(:active_record) do
+      if active_support_was_defined
+        ActiveRecord::Base.class_eval do
+          include Rollbar::ActiveRecordExtension
+        end
+      end
+    end
+  end
+end

data/lib/rollbar/plugins.rb

@@ -0,0 +1,47 @@
+require 'rollbar/plugin'
+
+module Rollbar
+  # Stores the available plugin definitions and loads them
+  class Plugins
+    attr_reader :collection
+
+    def initialize
+      @collection = []
+    end
+
+    def require_all
+      Dir.glob(plugin_files).each do |file|
+        require file.to_s
+      end
+    end
+
+    def plugin_files
+      File.expand_path('../plugins/*.rb', __FILE__)
+    end
+
+    def define(name, &block)
+      return if loaded?(name)
+
+      plugin = Rollbar::Plugin.new(name)
+      collection << plugin
+
+      plugin.instance_eval(&block)
+    end
+
+    def load!
+      collection.each do |plugin|
+        plugin.load! unless plugin.on_demand
+      end
+    end
+
+    def get(name)
+      collection.find { |plugin| plugin.name == name }
+    end
+
+    private
+
+    def loaded?(name)
+      collection.any? { |plugin| plugin.name == name }
+    end
+  end
+end

data/lib/rollbar/rails.rb

@@ -1,5 +1,4 @@
 module Rollbar
   module Rails
-
   end
 end

data/lib/rollbar/rake_tasks.rb

@@ -1,71 +1,9 @@
-require 'rollbar'
-
 namespace :rollbar do
-  desc "Verify your gem installation by sending a test exception to Rollbar"
+  desc 'Verify your gem installation by sending a test message to Rollbar'
   task :test => [:environment] do
-    Rails.logger = defined?(ActiveSupport::TaggedLogging) ?
-      ActiveSupport::TaggedLogging.new(Logger.new(STDOUT)) :
-      Logger.new(STDOUT)
-
-    Rails.logger.level = Logger::DEBUG
-    Rollbar.preconfigure do |config|
-      config.logger = Rails.logger
-    end
-
-    class RollbarTestingException < RuntimeError; end
-
-    unless Rollbar.configuration.access_token
-      puts "Rollbar needs an access token configured. Check the README for instructions."
-      exit
-    end
-
-    Rollbar.error('Test error from rollbar:test')
-
-    begin
-      require './app/controllers/application_controller'
-    rescue LoadError
-    end
-
-    unless defined?(ApplicationController)
-      puts "No ApplicationController found, using ActionController::Base instead"
-      class ApplicationController < ActionController::Base; end
-    end
-
-    puts "Setting up the controller."
-    class ApplicationController
-      prepend_before_filter :test_rollbar
-      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
-
-      def verify
-      end
-
-      def logger
-        nil
-      end
-    end
-
-    class RollbarTestController < ApplicationController; end
-
-    Rails.application.routes_reloader.execute_if_updated
-    Rails.application.routes.draw do
-      get 'verify' => 'application#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
-
-    puts "Processing..."
-    protocol = (defined? Rails.application.config.force_ssl && Rails.application.config.force_ssl) ? 'https' : 'http'
-    env = Rack::MockRequest.env_for("#{protocol}://www.example.com/verify")
-    status, headers, response = Rails.application.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
+    RollbarTest.run
   end
 end