rollbar 2.10.0 → 2.11.0

data/lib/rollbar/plugins.rb

@@ -0,0 +1,41 @@
+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(&:load!)
+    end
+
+    private
+
+    def loaded?(name)
+      collection.any? { |plugin| plugin.name == name }
+    end
+  end
+end

data/lib/rollbar/plugins/basic_socket.rb

@@ -0,0 +1,16 @@
+Rollbar.plugins.define('basic_socket') do
+  dependency { !configuration.disable_core_monkey_patch }
+
+  # Needed to avoid active_support (< 4.1.0) bug serializing JSONs
+  dependency { defined?(ActiveSupport::VERSION::STRING) }
+
+  execute do
+    require 'socket'
+
+    class BasicSocket
+      def as_json(*)
+        to_s
+      end
+    end
+  end
+end

data/lib/rollbar/plugins/delayed_job.rb

@@ -0,0 +1,12 @@
+Rollbar.plugins.define('delayed_job') do
+  dependency { !configuration.disable_monkey_patch }
+  dependency do
+    defined?(Delayed) && defined?(Delayed::Worker) && configuration.delayed_job_enabled
+  end
+
+  execute do
+    require 'rollbar/plugins/delayed_job/plugin'
+
+    Rollbar::Delayed.wrap_worker
+  end
+end

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

@@ -0,0 +1,16 @@
+class JobData
+  attr_reader :job
+
+  def initialize(job)
+    @job = job
+  end
+
+  def to_hash
+    job_data = job.as_json
+    # Here job_data['handler'] is a YAML object comming
+    # from the storage backend
+    job_data['handler'] = job.payload_object.as_json
+
+    job_data
+  end
+end

data/lib/rollbar/{delayed_job.rb → plugins/delayed_job/plugin.rb}

@@ -1,4 +1,5 @@
 require 'delayed_job'
+require 'rollbar/plugins/delayed_job/job_data'
 
 module Rollbar
   module Delayed
@@ -6,23 +7,6 @@ module Rollbar
       attr_accessor :wrapped
     end
 
-    class JobData
-      attr_reader :job
-
-      def initialize(job)
-        @job = job
-      end
-
-      def to_hash
-        job_data = job.as_json
-        # Here job_data['handler'] is a YAML object comming
-        # from the storage backend
-        job_data['handler'] = job.payload_object.as_json
-
-        job_data
-      end
-    end
-
     class RollbarPlugin < ::Delayed::Plugin
       callbacks do |lifecycle|
         lifecycle.around(:invoke_job, &Delayed::invoke_job_callback)

data/lib/rollbar/plugins/goalie.rb

@@ -0,0 +1,46 @@
+Rollbar.plugins.define('goalie') do
+  dependency { !configuration.disable_monkey_patch }
+  dependency { defined?(Goalie) }
+
+  execute do
+    module Rollbar
+      module Goalie
+        def render_exception_with_rollbar(env, exception)
+          exception_data = nil
+
+          begin
+            controller = env['action_controller.instance']
+            request_data = controller.rollbar_request_data rescue nil
+            person_data = controller.rollbar_person_data rescue nil
+            exception_data = Rollbar.scope(:request => request_data, :person => person_data).error(exception, :use_exception_level_filters => true)
+          rescue => e
+            Rollbar.log_warning "[Rollbar] Exception while reporting exception to Rollbar: #{e}"
+          end
+
+          # if an exception was reported, save uuid in the env
+          # so it can be displayed to the user on the error page
+          if exception_data.is_a?(Hash)
+            env['rollbar.exception_uuid'] = exception_data[:uuid]
+            Rollbar.log_info "[Rollbar] Exception uuid saved in env: #{exception_data[:uuid]}"
+          elsif exception_data == 'disabled'
+            Rollbar.log_info "[Rollbar] Exception not reported because Rollbar is disabled"
+          elsif exception_data == 'ignored'
+            Rollbar.log_info "[Rollbar] Exception not reported because it was ignored"
+          end
+
+          # now continue as normal
+          render_exception_without_rollbar(env, exception)
+        end
+      end
+    end
+  end
+
+  execute do
+    Goalie::CustomErrorPages.class_eval do
+      include Rollbar::Goalie
+
+      alias_method :render_exception_without_rollbar, :render_exception
+      alias_method :render_exception, :render_exception_with_rollbar
+    end
+  end
+end

data/lib/rollbar/plugins/rack.rb

@@ -0,0 +1,16 @@
+Rollbar.plugins.define('rack') do
+  dependency { !configuration.disable_monkey_patch }
+  dependency { !configuration.disable_rack_monkey_patch }
+
+  execute do
+    if defined?(Rack::Builder)
+      require 'rollbar/middleware/rack/builder'
+      Rack::Builder.send(:include, Rollbar::Middleware::Rack::Builder)
+    end
+
+    if defined?(Rack::Test::Session)
+      require 'rollbar/middleware/rack/test_session'
+      Rack::Test::Session.send(:include, Rollbar::Middleware::Rack::TestSession)
+    end
+  end
+end

data/lib/rollbar/plugins/rails.rb

@@ -0,0 +1,77 @@
+Rollbar.plugins.define('rails32-errors') do
+  dependency { defined?(Rails::VERSION) && Rails::VERSION::MAJOR >= 3 }
+  dependency { Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('3.2') }
+
+  execute! do
+    require 'rollbar/plugins/rails/railtie32'
+  end
+end
+
+Rollbar.plugins.define('rails30-errors') do
+  dependency { defined?(Rails::VERSION) && Rails::VERSION::MAJOR >= 3 }
+  dependency { Gem::Version.new(Rails::VERSION::STRING) < Gem::Version.new('3.2') }
+
+  execute! do
+    require 'rollbar/plugins/rails/railtie30'
+  end
+end
+
+Rollbar.plugins.define('rails-rollbar.js') do
+  dependency { defined?(Rails::VERSION) && Rails::VERSION::MAJOR >= 3 }
+
+  execute! do
+    module Rollbar
+      module Js
+        module Frameworks
+          # Adds Rollbar::Middleware::Js to the Rails middleware stack
+          # We need to delay the final insert to the last moment since
+          # this feature may be disable.
+          # But we need to prepare the middleware insert now because
+          # we need to use our Rails railtie initializer in case the
+          # customer is using SecureHeaders > 3.0
+          class Rails
+            def load(plugin)
+              plugin_execute = plugin_execute_proc(plugin)
+
+              return after_secure_headers(&plugin_execute) if secure_headers_middleware?
+
+              plugin_execute.call
+            end
+
+            def after_secure_headers(&block)
+              Rollbar::Railtie.initializer('rollbar.js.frameworks.rails', :after => 'secure_headers.middleware', &block)
+            end
+
+            def plugin_execute_proc(plugin)
+              proc do
+                plugin.execute do
+                  return unless Rollbar.configuration.js_enabled
+                  require 'rollbar/middleware/js'
+
+                  config = {
+                    :options => Rollbar.configuration.js_options,
+                    :enabled => Rollbar.configuration.js_enabled
+                  }
+                  ::Rails.configuration.middleware.use(::Rollbar::Middleware::Js, config)
+                end
+              end
+            end
+
+            def secure_headers_middleware?
+              begin
+                require 'secure_headers'
+              rescue LoadError
+              end
+
+              defined?(::SecureHeaders::Middleware)
+            end
+          end
+        end
+      end
+    end
+  end
+
+  execute! do
+    Rollbar::Js::Frameworks::Rails.new.load(self)
+  end
+end

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

@@ -0,0 +1,17 @@
+require 'rails/railtie'
+require 'rollbar/plugins/rails/railtie_mixin'
+
+module Rollbar
+  class Railtie < ::Rails::Railtie
+    include Rollbar::RailtieMixin
+
+    initializer 'rollbar.middleware.rails' do |app|
+      require 'rollbar/middleware/rails/rollbar'
+      require 'rollbar/middleware/rails/show_exceptions'
+
+      app.config.middleware.insert_after ActionDispatch::ShowExceptions,
+                                         Rollbar::Middleware::Rails::RollbarMiddleware
+      ActionDispatch::ShowExceptions.send(:include, Rollbar::Middleware::Rails::ShowExceptions)
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+require 'rails/railtie'
+require 'rollbar/plugins/rails/railtie_mixin'
+
+module Rollbar
+  class Railtie < ::Rails::Railtie
+    include Rollbar::RailtieMixin
+
+    initializer 'rollbar.middleware.rails' do |app|
+      require 'rollbar/middleware/rails/rollbar'
+      require 'rollbar/middleware/rails/show_exceptions'
+
+      app.config.middleware.insert_after ActionDispatch::DebugExceptions,
+                                         Rollbar::Middleware::Rails::RollbarMiddleware
+      ActionDispatch::DebugExceptions.send(:include, Rollbar::Middleware::Rails::ShowExceptions)
+    end
+  end
+end
+

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

@@ -0,0 +1,33 @@
+require 'rollbar'
+
+module Rollbar
+  module RailtieMixin
+    extend ActiveSupport::Concern
+
+    included do
+      rake_tasks do
+        require 'rollbar/rake_tasks'
+      end
+
+      initializer 'rollbar.configuration' do
+        config.after_initialize do
+          Rollbar.preconfigure do |config|
+            config.default_logger = proc { ::Rails.logger }
+            config.environment ||= ::Rails.env
+            config.root ||= ::Rails.root
+            config.framework = "Rails: #{::Rails::VERSION::STRING}"
+            config.filepath ||= ::Rails.application.class.parent_name + '.rollbar'
+          end
+        end
+      end
+
+      initializer 'rollbar.controller_methods' do
+        ActiveSupport.on_load(:action_controller) do
+          # lazily load action_controller methods
+          require 'rollbar/plugins/rails/controller_methods'
+          include Rollbar::Rails::ControllerMethods
+        end
+      end
+    end
+  end
+end

data/lib/rollbar/plugins/rake.rb

@@ -0,0 +1,45 @@
+Rollbar.plugins.define('rake') do
+  dependency { !configuration.disable_monkey_patch }
+  dependency { defined?(Rake) }
+
+  module Rollbar
+    module Rake
+      def self.patch!
+        skip_patch && return unless patch?
+
+        ::Rake::Application.class_eval do
+          alias_method :orig_display_error_message, :display_error_message
+
+          def display_error_message(ex)
+            Rollbar.error(ex, :use_exception_level_filters => true)
+            orig_display_error_message(ex)
+          end
+        end
+      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 unless rake_version
+
+        major, minor, = rake_version.split('.').map(&:to_i)
+
+        major > 0 || major == 0 && minor > 8
+      end
+
+      def self.rake_version
+        if Object.const_defined?('RAKEVERSION')
+          return RAKEVERSION
+        elsif ::Rake.const_defined?('VERSION')
+          return ::Rake::VERSION
+        end
+      end
+    end
+  end
+
+  execute do
+    Rollbar::Rake.patch!
+  end
+end

data/lib/rollbar/plugins/sidekiq.rb

@@ -0,0 +1,35 @@
+Rollbar.plugins.define('sidekiq >= 3') do
+  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::ClearScope
+      end
+
+      config.error_handlers << proc do |e, context|
+        Rollbar::Sidekiq.handle_exception(context, e)
+      end
+    end
+  end
+end
+
+Rollbar.plugins.define('sidekiq < 3') do
+  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/{sidekiq.rb → plugins/sidekiq/plugin.rb}

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Rollbar
   class Sidekiq
     PARAM_BLACKLIST = %w[backtrace error_backtrace error_message error_class]
@@ -43,19 +41,3 @@ module Rollbar
     end
   end
 end
-
-Sidekiq.configure_server do |config|
-  if Sidekiq::VERSION.split('.')[0].to_i < 3
-    config.server_middleware do |chain|
-      chain.add Rollbar::Sidekiq
-    end
-  else
-    config.server_middleware do |chain|
-      chain.add Rollbar::Sidekiq::ClearScope
-    end
-
-    config.error_handlers << proc do |e, context|
-      Rollbar::Sidekiq.handle_exception(context, e)
-    end
-  end
-end