rollbar 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26233ef7ffa02228b4777c5ef26655f9208541e9
-  data.tar.gz: 14feffe767b5d9764afc4508ed139a9d2394ada3
+  metadata.gz: 6ba9f625302b093e422f24c2c3a35a7e6388c099
+  data.tar.gz: ef53f6cd97ed94d5db499b77c496a81f6c6eb6f8
 SHA512:
-  metadata.gz: c38f8b6ea8dbdafe38b68cbc5b1902b21e7a55f29ebc154fe23d4a9a2a50d4bba01e623b917f4ba6e3ee17611cbb4d55b07035e40d83ae35eaa90b7ed4fab326
-  data.tar.gz: 08a2f63d80dd45c48eb297e6cfbfc0f551004ad7c4280b2b6a71bb79b3887c814910307c83b742f5ad420586e795f95cf52e4bf7f1a00561e54d3cb4ef671c7e
+  metadata.gz: 5752f3f6282c97ffce3142bd39089946eb79f0f7a9a864f9be56f74ec563ebc49b0839a92eb4388ef5d0445cc6f1fb80ae7ffc28860811e6884c5abf50257457
+  data.tar.gz: c00267db9b445b402c2a84b3b608a3b3c23c17371611467ed79a173a1b6eb45a02f2e6d496c2b8131da45750cccb14723c55d61810ed6c65a82f1fa97d41231b

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+**1.1.0**
+- New feature: `failover_handlers`. You can specify a list of async handlers, which will be tried in sequence upon failure. See [#135](https://github.com/rollbar/rollbar-gem/pull/135).
+- Support nested exceptions for Ruby 2.1. See [#136](https://github.com/rollbar/rollbar-gem/pull/136)
+- Fix handling of utf8 sequences in payload symbols. See [#131](https://github.com/rollbar/rollbar-gem/pull/131). Thanks [@kroky](https://github.com/kroky) for the fix and [@jondeandres](https://github.com/jondeandres) for reviewing.
+- Fix logic bugs in assignments for `scrub_fields` and `scrub_headers`. See [#137](https://github.com/rollbar/rollbar-gem/pull/137)
+
 **1.0.1**
 - Use the payload's access token for the X-Rollbar-Access-Token header, instead of the configured access token. Fixes an issue where payloads would be reported into the wrong project when sent via Resque. See [#128](https://github.com/rollbar/rollbar-gem/pull/128). Thanks to [@jondeandres](https://github.com/jondeandres) for the fix.
 

data/README.md

@@ -9,7 +9,7 @@ Ruby gem for reporting exceptions, errors, and log messages to [Rollbar](https:/
 
 Add this line to your application's Gemfile:
 
-    gem 'rollbar', '~> 1.0.0'
+    gem 'rollbar', '~> 1.1.0'
 
 And then execute:
 
@@ -239,7 +239,7 @@ config.delayed_job_enabled = false
 
 ## Asynchronous reporting
 
-By default, all messages are reported synchronously. You can enable asynchronous reporting with [girl_friday](https://github.com/mperham/girl_friday) or [sucker_punch](https://github.com/brandonhilkert/sucker_punch) or [Sidekiq](https://github.com/mperham/sidekiq).
+By default, all messages are reported synchronously. You can enable asynchronous reporting with [girl_friday](https://github.com/mperham/girl_friday), [sucker_punch](https://github.com/brandonhilkert/sucker_punch), [Sidekiq](https://github.com/mperham/sidekiq), [Resque](https://github.com/resque/resque) or using threading.
 
 ### Using girl_friday
 
@@ -285,11 +285,40 @@ Start Sidekiq from the root directory of your Rails app and declare the name of
 $ bundle exec sidekiq -q rollbar
 ```
 
+### Using Resque
+
+Add the following in ```config/initializers/rollbar.rb```:
+
+```ruby
+config.use_resque
+```
+
+You can also supply a custom Resque queue:
+
+```ruby
+config.use_resque :queue => 'my_queue'
+```
+
+Now you can just start a new Resque worker processing jobs in that queue:
+
+```bash
+$ QUEUE=my_queue bundle exec resque:work
+```
+
+### Using threading
+
+Add the following in ```config/initializers/rollbar.rb```:
+
+```ruby
+config.use_thread
+```
+
 ### Using another handler
 
-You can supply your own handler using ```config.async_handler```. The handler should schedule the payload for later processing (i.e. with a delayed_job, in a resque queue, etc.) and should itself return immediately. For example:
+You can supply your own handler using ```config.async_handler```. The object to set for `async_handler` should respond to `#call` and receive the payload. The handler should schedule the payload for later processing (i.e. with a delayed_job, in a resque queue, etc.) and should itself return immediately. For example:
 
 ```ruby
+config.use_async
 config.async_handler = Proc.new { |payload|
   Thread.new { Rollbar.process_payload(payload) }
 }
@@ -297,6 +326,21 @@ config.async_handler = Proc.new { |payload|
 
 Make sure you pass ```payload``` to ```Rollbar.process_payload``` in your own implementation.
 
+## Failover handlers
+
+If you are using `async_handler` to process asynchronous the error it's possible that the handler fails before it calls `Rollbar.process_payload`. For example, for the Resque handler, the Redis connection could fail so the job is finally not processed.
+
+To ensure that the error is sent you can define a chain of failover handlers that Rollbar will use to send the payload in case that the primary handler fails. The failover handlers, as for `async_handler`, are just objects responding to `#call`.
+
+To configure the failover handlers you can add the following:
+
+```ruby
+config.use_resque
+config.failover_handlers = [Rollbar::Delay::GirlFriday, Rollbar::Delay::Thread]
+```
+
+With the configuration above Resque will be your primary asynchronous handler but if it fails queueing the job Rollbar will use GirlFriday at first, and just a thread in case that GirlFriday fails too.
+
 ## Using with rollbar-agent
 
 For even more asynchrony, you can configure the gem to write to a file instead of sending the payload to Rollbar servers directly. [rollbar-agent](https://github.com/rollbar/rollbar-agent) can then be hooked up to this file to actually send the payload across. To enable, add the following in ```config/initializers/rollbar.rb```:
@@ -376,7 +420,7 @@ If you're using [Goalie](https://github.com/obvio171/goalie) for custom error pa
 
 ## Using with Resque
 
-Check out [resque-rollbar](https://github.com/CrowdFlower/resque-rollbar) for using Rollbar as a failure backend for Resque.
+Check out [resque-rollbar](https://github.com/dimko/resque-rollbar) for using Rollbar as a failure backend for Resque.
 
 
 ## Using with Zeus

data/THANKS.md

@@ -18,9 +18,11 @@ Huge thanks to the following contributors (by github username). For the most up-
 - [ixti](https://github.com/ixti)
 - [jeremyvdw](https://github.com/jeremyvdw)
 - [johnknott](https://github.com/johnknott)
+- [jondeandres](https://github.com/jondeandres)
 - [JoshuaOSHickman](https://github.com/JoshuaOSHickman)
 - [juggler](https://github.com/juggler)
 - [kavu](https://github.com/kavu)
+- [kroky](https://github.com/kroky)
 - [lanej](https://github.com/lanej)
 - [magnolia-fan](https://github.com/magnolia-fan)
 - [mauricio](https://github.com/mauricio)

data/lib/rollbar.rb

@@ -16,6 +16,8 @@ require 'rollbar/exception_reporter'
 require 'rollbar/active_record_extension' if defined?(ActiveRecord)
 require 'rollbar/util'
 require 'rollbar/railtie' if defined?(Rails)
+require 'rollbar/delay/girl_friday'
+require 'rollbar/delay/thread'
 
 unless ''.respond_to? :encode
   require 'iconv'
@@ -28,6 +30,8 @@ module Rollbar
     attr_writer :configuration
     attr_accessor :last_report
 
+    @file_semaphore = Mutex.new
+
     # Similar to configure below, but used only internally within the gem
     # to configure it without initializing any of the third party hooks
     def preconfigure
@@ -46,9 +50,8 @@ module Rollbar
     #   end
     def configure
       # if configuration.enabled has not been set yet (is still 'nil'), set to true.
-      if configuration.enabled.nil?
-        configuration.enabled = true
-      end
+      configuration.enabled = true if configuration.enabled.nil?
+
       yield(configuration)
 
       require_hooks
@@ -225,6 +228,7 @@ module Rollbar
         puts "[Rollbar] #{message}"
       end
     end
+
     def log_debug(message)
       begin
         logger.debug message
@@ -234,6 +238,12 @@ module Rollbar
       end
     end
 
+    def default_async_handler
+      return Rollbar::Delay::GirlFriday if defined?(GirlFriday)
+
+      Rollbar::Delay::Thread
+    end
+
     private
 
     def attach_request_data(payload, request_data)
@@ -307,6 +317,37 @@ module Rollbar
 
       data[:level] = force_level if force_level
 
+      traces = trace_chain(exception)
+
+      if traces.size > 1
+        body = {
+          :trace_chain => traces
+        }
+      elsif traces.size == 1
+        body = {
+          :trace => traces[0]
+        }
+      end
+
+      data[:body] = body
+
+      data[:server] = server_data
+
+      data
+    end
+
+    def trace_chain(exception)
+      traces = [trace_data(exception)]
+
+      while exception.respond_to?(:cause) && (cause = exception.cause)
+        traces << trace_data(cause)
+        exception = cause
+      end
+
+      traces
+    end
+
+    def trace_data(exception)
       # parse backtrace
       if exception.backtrace.respond_to?( :map )
         frames = exception.backtrace.map { |frame|
@@ -324,19 +365,13 @@ module Rollbar
         frames = []
       end
 
-      data[:body] = {
-        :trace => {
-          :frames => frames,
-          :exception => {
-            :class => exception.class.name,
-            :message => exception.message
-          }
+      {
+        :frames => frames,
+        :exception => {
+          :class => exception.class.name,
+          :message => exception.message
         }
       }
-
-      data[:server] = server_data
-
-      data
     end
 
     def logger
@@ -425,29 +460,45 @@ module Rollbar
     end
 
     def schedule_payload(payload)
-      if payload.nil?
-        return
-      end
+      return if payload.nil?
 
       log_info '[Rollbar] Scheduling payload'
 
       if configuration.use_async
-        unless configuration.async_handler
-          configuration.async_handler = method(:default_async_handler)
-        end
-
-        if configuration.write_to_file
-          unless @file_semaphore
-            @file_semaphore = Mutex.new
-          end
-        end
-
-        configuration.async_handler.call(payload)
+        process_async_payload(payload)
       else
         process_payload(payload)
       end
     end
 
+    def process_async_payload(payload)
+      configuration.async_handler ||= default_async_handler
+      configuration.async_handler.call(payload)
+    rescue
+      if configuration.failover_handlers.empty?
+        log_error '[Rollbar] Async handler failed, and there are no failover handlers configured. See the docs for "failover_handlers"'
+        return
+      end
+
+      async_failover(payload)
+    end
+
+    def async_failover(payload)
+      log_warning '[Rollbar] Primary async handler failed. Trying failovers...'
+
+      failover_handlers = configuration.failover_handlers
+
+      failover_handlers.each do |handler|
+        begin
+          handler.call(payload)
+        rescue
+          next unless handler == failover_handlers.last
+
+          log_error "[Rollbar] All failover handlers failed while processing payload: #{MultiJson.dump(payload)}"
+        end
+      end
+    end
+
     def build_payload(data)
       payload = {
         'access_token' => configuration.access_token,
@@ -534,21 +585,6 @@ module Rollbar
       data
     end
 
-    def default_async_handler(payload)
-      if defined?(GirlFriday)
-        unless @queue
-          @queue = GirlFriday::WorkQueue.new(nil, :size => 5) do |payload|
-            process_payload(payload)
-          end
-        end
-
-        @queue.push(payload)
-      else
-        log_warning '[Rollbar] girl_friday not found to handle async call, falling back to Thread'
-        Thread.new { process_payload(payload) }
-      end
-    end
-
     # Reports an internal error in the Rollbar library. This will be reported within the configured
     # Rollbar project. We'll first attempt to provide a report including the exception traceback.
     # If that fails, we'll fall back to a more static failsafe response.
@@ -617,19 +653,23 @@ module Rollbar
     end
 
     def enforce_valid_utf8(payload)
-      normalizer = Proc.new do |value|
-        if value.is_a?(String)
-          if value.respond_to? :encode
-            value.encode('UTF-8', 'binary', :invalid => :replace, :undef => :replace, :replace => '')
-          else
-            ::Iconv.conv('UTF-8//IGNORE', 'UTF-8', value)
-          end
+      normalizer = lambda do |object|
+        is_symbol = object.is_a?(Symbol)
+
+        return object unless object == object.to_s || is_symbol
+
+        value = object.to_s
+
+        if value.respond_to? :encode
+          encoded_value = value.encode('UTF-8', 'binary', :invalid => :replace, :undef => :replace, :replace => '')
         else
-          value
+          encoded_value = ::Iconv.conv('UTF-8//IGNORE', 'UTF-8', value)
         end
+
+        is_symbol ? encoded_value.to_sym : encoded_value
       end
 
-      Rollbar::Util::iterate_and_update(payload, normalizer)
+      Rollbar::Util.iterate_and_update(payload, normalizer)
     end
 
     def truncate_payload(payload, byte_threshold)

data/lib/rollbar/configuration.rb

@@ -15,6 +15,7 @@ module Rollbar
     attr_accessor :endpoint
     attr_accessor :environment
     attr_accessor :exception_level_filters
+    attr_accessor :failover_handlers
     attr_accessor :filepath
     attr_accessor :framework
     attr_accessor :ignored_person_ids
@@ -53,6 +54,7 @@ module Rollbar
         'AbstractController::ActionNotFound' => 'warning',
         'ActionController::RoutingError' => 'warning'
       }
+      @failover_handlers = []
       @framework = 'Plain'
       @ignored_person_ids = []
       @person_method = 'current_user'
@@ -77,6 +79,15 @@ module Rollbar
       @async_handler  = Rollbar::Delay::Sidekiq.new(options)
     end
 
+    def use_resque(options = {})
+      require 'rollbar/delay/resque' if defined?(Resque)
+
+      Rollbar::Delay::Resque::Job.queue = options[:queue] if options[:queue]
+
+      @use_async      = true
+      @async_handler  = Rollbar::Delay::Resque
+    end
+
     def use_sidekiq=(value)
       deprecation_message = "#use_sidekiq=(value) has been deprecated in favor of #use_sidekiq(options = {}). Please update your rollbar configuration."
       defined?(ActiveSupport) ? ActiveSupport::Deprecation.warn(deprecation_message) : puts(deprecation_message)
@@ -84,6 +95,12 @@ module Rollbar
       value.is_a?(Hash) ? use_sidekiq(value) : use_sidekiq
     end
 
+    def use_thread
+      require 'rollbar/delay/thread'
+      @use_async = true
+      @async_handler = Rollbar::Delay::Thread
+    end
+
     def use_sucker_punch
       require 'rollbar/delay/sucker_punch' if defined?(SuckerPunch)
       @use_async      = true

data/lib/rollbar/delay/girl_friday.rb

@@ -0,0 +1,26 @@
+module Rollbar
+  module Delay
+    class GirlFriday
+
+      class << self
+        attr_accessor :queue
+
+        def call(payload)
+          new.call(payload)
+        end
+      end
+
+      def queue_class
+        ::GirlFriday::WorkQueue
+      end
+
+      def call(payload)
+        self.class.queue = queue_class.new(nil, :size => 5) do |payload|
+          Rollbar.process_payload(payload)
+        end
+
+        self.class.queue.push(payload)
+      end
+    end
+  end
+end

data/lib/rollbar/delay/resque.rb

@@ -0,0 +1,31 @@
+require 'resque'
+
+module Rollbar
+  module Delay
+    class Resque
+      def self.call(payload)
+        new.call(payload)
+      end
+
+      def call(payload)
+        ::Resque.enqueue(Job, payload)
+      end
+
+      class Job
+        class << self
+          attr_accessor :queue
+        end
+
+        self.queue = :default
+
+        def self.perform(payload)
+          new.perform(payload)
+        end
+
+        def perform(payload)
+          Rollbar.process_payload(payload)
+        end
+      end
+    end
+  end
+end

data/lib/rollbar/delay/thread.rb

@@ -0,0 +1,13 @@
+module Rollbar
+  module Delay
+    class Thread
+      def self.call(payload)
+        new.call(payload)
+      end
+
+      def call(payload)
+        ::Thread.new { Rollbar.process_payload(payload) }
+      end
+    end
+  end
+end

data/lib/rollbar/middleware/sinatra.rb

@@ -0,0 +1,27 @@
+require 'rollbar'
+require 'rollbar/exception_reporter'
+
+module Rollbar
+  module Middleware
+    class Sinatra
+      include ::Rollbar::ExceptionReporter
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        response = @app.call(env)
+        report_exception_to_rollbar(env, framework_error(env)) if framework_error(env)
+        response
+      rescue ::Exception => exception
+        report_exception_to_rollbar(env, exception)
+        raise
+      end
+
+      def framework_error(env)
+        env['sinatra.error']
+      end
+    end
+  end
+end

data/lib/rollbar/request_data_extractor.rb

@@ -12,13 +12,13 @@ module Rollbar
         controller = env['action_controller.instance']
         person_data = controller.rollbar_person_data rescue {}
       end
-      
+
       person_data
     end
 
     def extract_request_data_from_rack(env)
       rack_req = Rack::Request.new(env)
-      
+
       sensitive_params = sensitive_params_list(env)
       request_params = rollbar_filtered_params(sensitive_params, rollbar_request_params(env))
       get_params = rollbar_filtered_params(sensitive_params, rollbar_get_params(rack_req))
@@ -26,9 +26,9 @@ module Rollbar
       cookies = rollbar_filtered_params(sensitive_params, rollbar_request_cookies(rack_req))
       session = rollbar_filtered_params(sensitive_params, env['rack.session.options'])
       route_params = rollbar_filtered_params(sensitive_params, rollbar_route_params(env))
-      
+
       params = request_params.merge(get_params).merge(post_params)
-      
+
       data = {
         :params => params,
         :url => rollbar_url(env),
@@ -39,11 +39,11 @@ module Rollbar
         :method => rollbar_request_method(env),
         :route => route_params,
       }
-      
+
       if env["action_dispatch.request_id"]
         data[:request_id] = env["action_dispatch.request_id"]
       end
-      
+
       data
     end
 
@@ -68,13 +68,13 @@ module Rollbar
 
     def rollbar_url(env)
       scheme = env['HTTP_X_FORWARDED_PROTO'] || env['rack.url_scheme']
-      
+
       host = env['HTTP_X_FORWARDED_HOST'] || env['HTTP_HOST'] || env['SERVER_NAME']
       path = env['ORIGINAL_FULLPATH'] || env['REQUEST_URI']
       unless path.nil? || path.empty?
         path = '/' + path.to_s if path.to_s.slice(0, 1) != '/'
       end
-      
+
       port = env['HTTP_X_FORWARDED_PORT']
       if port && !(scheme.downcase == 'http' && port.to_i == 80) && \
                  !(scheme.downcase == 'https' && port.to_i == 443) && \
@@ -88,7 +88,7 @@ module Rollbar
     def rollbar_user_ip(env)
       (env['action_dispatch.remote_ip'] || env['HTTP_X_REAL_IP'] || env['HTTP_X_FORWARDED_FOR'] || env['REMOTE_ADDR']).to_s
     end
-    
+
     def rollbar_get_params(rack_req)
       rack_req.GET
     rescue
@@ -104,7 +104,7 @@ module Rollbar
     def rollbar_request_params(env)
       env['action_dispatch.request.parameters'] || {}
     end
-    
+
     def rollbar_route_params(env)
       begin
         route = ::Rails.application.routes.recognize_path(env['PATH_INFO'])
@@ -117,7 +117,7 @@ module Rollbar
         {}
       end
     end
-    
+
     def rollbar_request_cookies(rack_req)
       rack_req.cookies
     rescue
@@ -126,7 +126,7 @@ module Rollbar
 
     def rollbar_filtered_params(sensitive_params, params)
       @sensitive_params_regexp ||= Regexp.new(sensitive_params.map{ |val| Regexp.escape(val.to_s).to_s }.join('|'), true)
-      
+
       if params.nil?
         {}
       else
@@ -152,11 +152,11 @@ module Rollbar
     end
 
     def sensitive_params_list(env)
-      Rollbar.configuration.scrub_fields |= Array(env['action_dispatch.parameter_filter'])
+      Array(Rollbar.configuration.scrub_fields) | Array(env['action_dispatch.parameter_filter'])
     end
 
     def sensitive_headers_list
-      Rollbar.configuration.scrub_headers |= []
+      Rollbar.configuration.scrub_headers || []
     end
 
     def rollbar_scrubbed(value)

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/rollbar.gemspec

@@ -24,4 +24,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'sucker_punch', '>= 1.0.0' if RUBY_VERSION != '1.8.7'
   gem.add_development_dependency 'sidekiq', '>= 2.13.0' if RUBY_VERSION != '1.8.7'
   gem.add_development_dependency 'genspec', '>= 0.2.7'
+  gem.add_development_dependency 'sinatra'
+  gem.add_development_dependency 'resque'
 end

data/spec/requests/home_spec.rb

@@ -22,7 +22,7 @@ describe HomeController do
         expect{ get 'current_user', nil, :cookie => '8%B' }.to raise_exception
 
         Rollbar.last_report.should_not be_nil
-  
+
         exception_info = Rollbar.last_report[:body][:trace][:exception]
         exception_info[:class].should == 'ArgumentError'
         exception_info[:message].should == 'invalid %-encoding (8%B)'
@@ -44,11 +44,13 @@ describe HomeController do
     end
 
     it "should report uncaught exceptions" do
-      expect{ get 'current_user' }.to raise_exception
+      expect { get 'current_user' }.to raise_exception
+
+      body = Rollbar.last_report[:body]
+      trace = body[:trace] && body[:trace] || body[:trace_chain][0]
 
-      exception_info = Rollbar.last_report[:body][:trace][:exception]
-      exception_info[:class].should == 'NoMethodError'
-      # exception_info[:message].should == 'undefined method `-\' for "1":String'
+      trace[:exception][:class].should == 'NoMethodError'
+      trace[:exception][:message].should == 'undefined method `-\' for "1":String'
     end
   end
 end

data/spec/rollbar/configuration_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'rollbar/configuration'
+
+describe Rollbar::Configuration do
+
+  describe '#use_thread' do
+    it 'enables async and sets a Thread as handler' do
+      subject.use_thread
+
+      expect(subject.use_async).to be_eql(true)
+      expect(subject.async_handler).to be_eql(Rollbar::Delay::Thread)
+    end
+  end
+
+  describe '#use_resque' do
+    it 'enables async and sets Resque as the handler' do
+      require 'resque'
+      subject.use_resque(:queue => 'errors')
+
+      expect(subject.use_async).to be_eql(true)
+      expect(subject.async_handler).to be_eql(Rollbar::Delay::Resque)
+    end
+  end
+end

data/spec/rollbar/delay/girl_friday_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+# require girl_friday in the test instead in the implementation
+# just to let the user decide to load it or not
+require 'girl_friday'
+require 'rollbar/delay/girl_friday'
+
+describe Rollbar::Delay::GirlFriday do
+  describe '.call' do
+    let(:payload) do
+      { :key => 'value' }
+    end
+
+    it 'push the payload into the queue' do
+      expect_any_instance_of(::GirlFriday::WorkQueue).to receive(:push).with(payload)
+      described_class.call(payload)
+    end
+  end
+end

data/spec/rollbar/delay/resque_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'rollbar/delay/resque'
+
+describe Rollbar::Delay::Resque do
+  describe '.call' do
+    let(:payload) do
+      { :key => 'value' }
+    end
+
+    before do
+      allow(Resque).to receive(:inline?).and_return(true)
+    end
+
+    it 'process the payload' do
+      loaded_hash = MultiJson.load(MultiJson.dump(payload))
+
+      expect(Rollbar).to receive(:process_payload).with(loaded_hash)
+      described_class.call(payload)
+    end
+  end
+end

data/spec/rollbar/delay/thread_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Rollbar::Delay::Thread do
+  describe '.call' do
+    let(:payload) { { :key => 'value' } }
+
+    it 'process the payload in a new thread' do
+      expect(Rollbar).to receive(:process_payload).with(payload)
+
+      th = described_class.call(payload)
+      th.join
+    end
+  end
+end

data/spec/rollbar/middleware/sinatra_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+require 'rollbar/middleware/sinatra'
+require 'sinatra/base'
+require 'rack/test'
+
+class SinatraDummy < Sinatra::Base
+  class DummyError < StandardError; end
+
+  use Rollbar::Middleware::Sinatra
+
+  get '/foo' do
+    raise DummyError.new
+  end
+
+  get '/bar' do
+    'this will not crash'
+  end
+end
+
+describe Rollbar::Middleware::Sinatra do
+  include Rack::Test::Methods
+
+  def app
+    SinatraDummy
+  end
+
+  let(:expected_report_args) do
+    [exception, kind_of(Hash), kind_of(Hash)]
+  end
+
+  describe '#call' do
+    context 'for a crashing endpoint' do
+      # this is the default for test mode in Sinatra
+      context 'with raise_errors? == true' do
+        let(:exception) { kind_of(SinatraDummy::DummyError) }
+
+        before do
+          allow(app.settings).to receive(:raise_errors?).and_return(true)
+        end
+
+        it 'reports the error to Rollbar API and raises error' do
+          expect(Rollbar).to receive(:report_exception).with(*expected_report_args)
+
+          expect do
+            get '/foo'
+          end.to raise_error(SinatraDummy::DummyError)
+        end
+      end
+
+      context 'with raise_errors? == false' do
+        let(:exception) { kind_of(SinatraDummy::DummyError) }
+
+        before do
+          allow(app.settings).to receive(:raise_errors?).and_return(false)
+        end
+
+        it 'reports the error to Rollbar, but nothing is raised' do
+          expect(Rollbar).to receive(:report_exception).with(*expected_report_args)
+          get '/foo'
+        end
+      end
+    end
+
+    context 'for a NOT crashing endpoint' do
+      it 'doesnt report any error to Rollbar API' do
+        expect(Rollbar).not_to receive(:report_exception)
+        get '/bar'
+      end
+    end
+
+    context 'if the middleware itself fails' do
+      let(:exception) { Exception.new }
+
+      before do
+        allow_any_instance_of(described_class).to receive(:framework_error).and_raise(exception)
+        allow(app.settings).to receive(:raise_errors?).and_return(false)
+      end
+
+      it 'reports the report error' do
+        expect(Rollbar).to receive(:report_exception).with(*expected_report_args)
+
+        expect do
+          get '/foo'
+        end.to raise_error(exception)
+      end
+    end
+  end
+end

data/spec/rollbar_spec.rb

@@ -12,6 +12,7 @@ rescue LoadError
 end
 
 describe Rollbar do
+  let(:configuration) { Rollbar.configuration }
 
   describe '.report_exception' do
     before(:each) do
@@ -443,14 +444,14 @@ describe Rollbar do
 
       Rollbar.configure do |config|
         config.use_async = true
-        GirlFriday::WorkQueue::immediate!
+        GirlFriday::WorkQueue.immediate!
       end
 
       Rollbar.report_exception(@exception)
 
       Rollbar.configure do |config|
         config.use_async = false
-        GirlFriday::WorkQueue::queue!
+        GirlFriday::WorkQueue.queue!
       end
     end
 
@@ -471,7 +472,7 @@ describe Rollbar do
 
       Rollbar.configure do |config|
         config.use_async = false
-        config.async_handler = Rollbar.method(:default_async_handler)
+        config.async_handler = Rollbar.default_async_handler
       end
     end
 
@@ -498,6 +499,84 @@ describe Rollbar do
 
         Rollbar.report_exception(@exception)
       end
+
+      context 'with async failover handlers' do
+        before do
+          Rollbar.reconfigure do |config|
+            config.use_async = true
+            config.async_handler = async_handler
+            config.failover_handlers = handlers
+            config.logger = logger_mock
+          end
+        end
+
+        let(:exception) { StandardError.new('the error') }
+
+        context 'if the async handler doesnt fail' do
+          let(:async_handler) { proc { |_| 'success' } }
+          let(:handler) { proc { |_| 'success' } }
+          let(:handlers) { [handler] }
+
+          it 'doesnt call any failover handler' do
+            expect(handler).not_to receive(:call)
+
+            Rollbar.report_exception(exception)
+          end
+        end
+
+        context 'if the async handler fails' do
+          let(:async_handler) { proc { |_| fail 'this handler will crash' } }
+
+          context 'if any failover handlers is configured' do
+            let(:handlers) { [] }
+            let(:log_message) do
+              '[Rollbar] Async handler failed, and there are no failover handlers configured. See the docs for "failover_handlers"'
+            end
+
+            it 'logs the error but doesnt try to report an internal error' do
+              expect(logger_mock).to receive(:error).with(log_message)
+
+              Rollbar.report_exception(exception)
+            end
+          end
+
+          context 'if the first failover handler success' do
+            let(:handler) { proc { |_| 'success' } }
+            let(:handlers) { [handler] }
+
+            it 'calls the failover handler and doesnt report internal error' do
+              expect(Rollbar).not_to receive(:report_internal_error)
+              expect(handler).to receive(:call)
+
+              Rollbar.report_exception(exception)
+            end
+          end
+
+          context 'with two handlers, the first failing' do
+            let(:handler1) { proc { |_| fail 'this handler fails' } }
+            let(:handler2) { proc { |_| 'success' } }
+            let(:handlers) { [handler1, handler2] }
+
+            it 'calls the second handler and doesnt report internal error' do
+              expect(handler2).to receive(:call)
+
+              Rollbar.report_exception(exception)
+            end
+          end
+
+          context 'with two handlers, both failing' do
+            let(:handler1) { proc { |_| fail 'this handler fails' } }
+            let(:handler2) { proc { |_| fail 'this will also fail' } }
+            let(:handlers) { [handler1, handler2] }
+
+            it 'reports internal error' do
+              expect(logger_mock).to receive(:error)
+
+              Rollbar.report_exception(exception)
+            end
+          end
+        end
+      end
     end
 
     describe "#use_sucker_punch", :if => defined?(SuckerPunch) do
@@ -514,7 +593,7 @@ describe Rollbar do
 
         Rollbar.configure do |config|
           config.use_async = false
-          config.async_handler = Rollbar.method(:default_async_handler)
+          config.async_handler = Rollbar.default_async_handler
         end
       end
     end
@@ -539,7 +618,7 @@ describe Rollbar do
 
         Rollbar.configure do |config|
           config.use_async = false
-          config.async_handler = Rollbar.method(:default_async_handler)
+          config.async_handler = Rollbar.default_async_handler
         end
       end
     end
@@ -592,7 +671,7 @@ describe Rollbar do
     end
   end
 
-  context 'exception_data' do
+  describe '.exception_data' do
     before(:each) do
       configure
       begin
@@ -647,6 +726,51 @@ describe Rollbar do
       end
     end
 
+    context 'with nested exceptions' do
+      let(:crashing_code) do
+        proc do
+          begin
+            begin
+              fail CauseException.new('the cause')
+            rescue
+              fail StandardError.new('the error')
+            end
+          rescue => e
+            e
+          end
+        end
+      end
+      let(:rescued_exception) { crashing_code.call }
+
+      if Exception.instance_methods.include?(:cause)
+        it 'sends the two exceptions in the trace_chain attribute' do
+          data = Rollbar.send(:exception_data, rescued_exception)
+          body = data[:body]
+
+          body[:trace].should be_nil
+          body[:trace_chain].should be_kind_of(Array)
+
+          chain = body[:trace_chain]
+          chain[0][:exception][:class].should match(/StandardError/)
+          chain[0][:exception][:message].should match(/the error/)
+
+          chain[1][:exception][:class].should match(/CauseException/)
+          chain[1][:exception][:message].should match(/the cause/)
+        end
+
+      else
+        it 'sends only the last exception in the trace attribute' do
+          data = Rollbar.send(:exception_data, rescued_exception)
+          body = data[:body]
+
+          body[:trace].should be_kind_of(Hash)
+          body[:trace_chain].should be_nil
+
+          body[:trace][:exception][:class].should match(/StandardError/)
+          body[:trace][:exception][:message].should match(/the error/)
+        end
+      end
+    end
   end
 
   context 'logger' do
@@ -739,13 +863,16 @@ describe Rollbar do
 
   context 'enforce_valid_utf8' do
     it 'should replace invalid utf8 values' do
+      bad_key = "inner \x92bad key"
+      bad_key.force_encoding('ASCII-8BIT') if bad_key.respond_to?('force_encoding')
+      
       payload = {
         :bad_value => "bad value 1\255",
         :bad_value_2 => "bad\255 value 2",
         "bad\255 key" => "good value",
         :hash => {
           :inner_bad_value => "\255\255bad value 3",
-          "inner \255bad key" => 'inner good value',
+          bad_key.to_sym => 'inner good value',
           "bad array key\255" => [
             'good array value 1',
             "bad\255 array value 1\255",
@@ -764,7 +891,7 @@ describe Rollbar do
       payload_copy["bad key"].should == "good value"
       payload_copy.keys.should_not include("bad\456 key")
       payload_copy[:hash][:inner_bad_value].should == "bad value 3"
-      payload_copy[:hash]["inner bad key"].should == 'inner good value'
+      payload_copy[:hash][:"inner bad key"].should == 'inner good value'
       payload_copy[:hash]["bad array key"].should == [
         'good array value 1',
         'bad array value 1',

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 
-ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ENV'] = ENV['RACK_ENV'] = 'test'
 require File.expand_path('../dummyapp/config/environment', __FILE__)
 require 'rspec/rails'
 require 'database_cleaner'

data/spec/support/cause_exception.rb

@@ -0,0 +1 @@
+class CauseException < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollbar
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Rollbar, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-04 00:00:00.000000000 Z
+date: 2014-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -122,6 +122,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 0.2.7
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rails plugin to catch and send exceptions to Rollbar
 email:
 - support@rollbar.com
@@ -152,8 +180,11 @@ files:
 - lib/rollbar/capistrano.rb
 - lib/rollbar/capistrano3.rb
 - lib/rollbar/configuration.rb
+- lib/rollbar/delay/girl_friday.rb
+- lib/rollbar/delay/resque.rb
 - lib/rollbar/delay/sidekiq.rb
 - lib/rollbar/delay/sucker_punch.rb
+- lib/rollbar/delay/thread.rb
 - lib/rollbar/delayed_job.rb
 - lib/rollbar/exception_reporter.rb
 - lib/rollbar/goalie.rb
@@ -161,6 +192,7 @@ files:
 - lib/rollbar/middleware/rack/test_session.rb
 - lib/rollbar/middleware/rails/rollbar_request_store.rb
 - lib/rollbar/middleware/rails/show_exceptions.rb
+- lib/rollbar/middleware/sinatra.rb
 - lib/rollbar/rack.rb
 - lib/rollbar/rails.rb
 - lib/rollbar/rails/controller_methods.rb
@@ -228,8 +260,14 @@ files:
 - spec/dummyapp/script/rails
 - spec/generators/rollbar/rollbar_generator_spec.rb
 - spec/requests/home_spec.rb
+- spec/rollbar/configuration_spec.rb
+- spec/rollbar/delay/girl_friday_spec.rb
+- spec/rollbar/delay/resque_spec.rb
+- spec/rollbar/delay/thread_spec.rb
+- spec/rollbar/middleware/sinatra_spec.rb
 - spec/rollbar_spec.rb
 - spec/spec_helper.rb
+- spec/support/cause_exception.rb
 homepage: https://github.com/rollbar/rollbar-gem
 licenses:
 - MIT
@@ -310,5 +348,11 @@ test_files:
 - spec/dummyapp/script/rails
 - spec/generators/rollbar/rollbar_generator_spec.rb
 - spec/requests/home_spec.rb
+- spec/rollbar/configuration_spec.rb
+- spec/rollbar/delay/girl_friday_spec.rb
+- spec/rollbar/delay/resque_spec.rb
+- spec/rollbar/delay/thread_spec.rb
+- spec/rollbar/middleware/sinatra_spec.rb
 - spec/rollbar_spec.rb
 - spec/spec_helper.rb
+- spec/support/cause_exception.rb