rollbar 1.4.3 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5014d11d0ce47ae5f2e50751236a81404148c787
-  data.tar.gz: 12aa1c0e3509ebdb622083e4d90ca20b731414d5
+  metadata.gz: 78c1bdf59f142827061ca417def8b9e593aaa877
+  data.tar.gz: 760a27633c4e7460602c81c506e71028f9a29bfb
 SHA512:
-  metadata.gz: 83428ce3fb1b1a7287a81e1f22a862b5d3c2d429e4f133c7c7e005927724f184b4123e4446e0d2a7777e23ac7856d0b769e4e9d7ffb1cf05ee29c930b25eadbc
-  data.tar.gz: de80c650cde9ba6e3909d3b45a4b4fb6346a2b49cec49298449e2cb7201bfcf0d32b44c2dd73a3afdea35295abbead953b86015fcf03082f08fc71c6a4c8a86b
+  metadata.gz: 8ce84b0b7705beaa2bea77b2ff23f5ecf187ed98e52e29d0123b205e51d3591e561193b38baa1eaf0b95e16a5bc04983fb07fa91db1841913005407e9fb5108b
+  data.tar.gz: 8a7ce81a92a3ff906e08e6a489a29f8e99dab6cb997928b7ddc7f74f0175ffa9d4e54facb942d61ddbd10ce305b92376897689b557ae740d9a09cd0f563853b1

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+## 1.4.4
+
+New features:
+
+- Added configuration option to gather backtraces for exceptions that don't already have one (i.e. if you do `Rollbar.error(Exception.new)`). Set `config.populate_empty_backtraces = true` to enable it. See [#206](https://github.com/rollbar/rollbar-gem/pull/206)
+
+Bug fixes:
+
+- Reverted capistrano change as it causes problems in some setups. See [#210](https://github.com/rollbar/rollbar-gem/pull/210)
+
+Other:
+
+- Refactored the Sidekiq handler (no changes to the interface). See [#197](https://github.com/rollbar/rollbar-gem/pull/197)
+
 ## 1.4.3
 
 New features:

data/Gemfile

@@ -12,3 +12,9 @@ gem 'racc',                             :platform => :rbx
 gem 'minitest',                         :platform => :rbx
 gem 'rubysl-test-unit',                 :platform => :rbx
 gem 'rubinius-developer_tools',         :platform => :rbx
+
+if RUBY_VERSION.chars.first.to_i > 1
+  gem 'byebug'
+else
+  gem 'debugger'
+end

data/README.md

@@ -1,4 +1,4 @@
-# Rollbar notifier for Ruby [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v1.4.3)](https://travis-ci.org/rollbar/rollbar-gem/branches)
+# Rollbar notifier for Ruby [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v1.4.4)](https://travis-ci.org/rollbar/rollbar-gem/branches)
 
 <!-- RemoveNext -->
 Ruby gem for reporting exceptions, errors, and log messages to [Rollbar](https://rollbar.com).
@@ -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.4.3'
+    gem 'rollbar', '~> 1.4.4'
 
 And then execute:
 
@@ -379,6 +379,23 @@ Rollbar.silenced {
 }
 ```
 
+# Sending backtrace without rescued exceptions
+
+If you use the gem in this way:
+
+```ruby
+exception = MyException.new('this is a message')
+Rollbar.error(exception)
+```
+
+You will notice a backtrace doesn't appear in your Rollbar dashboard. This is because `exception.backtrace` is `nil` in these cases. We can send the current backtrace for you even your exception doesn't have it. In order to enable this feature you should configure Rollbar in this way:
+
+```ruby
+Rollbar.configure do |config|
+  config.populate_empty_backtraces = true
+end
+```
+
 ## Delayed::Job integration
 
 If `delayed_job` is defined, Rollbar will automatically install a plugin that reports any uncaught exceptions that occur in jobs.

data/THANKS.md

@@ -23,6 +23,7 @@ Huge thanks to the following contributors (by github username). For the most up-
 - [GUI](https://github.com/GUI)
 - [ixti](https://github.com/ixti)
 - [jeremyvdw](https://github.com/jeremyvdw)
+- [jjb](https://github.com/jjb)
 - [johnknott](https://github.com/johnknott)
 - [jonah-williams](https://github.com/jonah-williams)
 - [jondeandres](https://github.com/jondeandres)

data/lib/rollbar.rb

@@ -339,23 +339,20 @@ module Rollbar
     end
 
     def trace_data(exception)
-      # parse backtrace
-      if exception.backtrace.respond_to?( :map )
-        frames = exception.backtrace.map { |frame|
-          # parse the line
-          match = frame.match(/(.*):(\d+)(?::in `([^']+)')?/)
-          if match
-            { :filename => match[1], :lineno => match[2].to_i, :method => match[3] }
-          else
-            { :filename => "<unknown>", :lineno => 0, :method => frame }
-          end
-        }
-        # reverse so that the order is as rollbar expects
-        frames.reverse!
-      else
-        frames = []
+      frames = exception_backtrace(exception).map do |frame|
+        # parse the line
+        match = frame.match(/(.*):(\d+)(?::in `([^']+)')?/)
+
+        if match
+          { :filename => match[1], :lineno => match[2].to_i, :method => match[3] }
+        else
+          { :filename => "<unknown>", :lineno => 0, :method => frame }
+        end
       end
 
+        # reverse so that the order is as rollbar expects
+      frames.reverse!
+
       {
         :frames => frames,
         :exception => {
@@ -365,6 +362,28 @@ module Rollbar
       }
     end
 
+    # Returns the backtrace to be sent to our API. There are 3 options:
+    #
+    # 1. The exception received has a backtrace, then that backtrace is returned.
+    # 2. configuration.populate_empty_backtraces is disabled, we return [] here
+    # 3. The user has configuration.populate_empty_backtraces is enabled, then:
+    #
+    # We want to send the caller as backtrace, but the first lines of that array
+    # are those from the user's Rollbar.error line until this method. We want
+    # to remove those lines.
+    def exception_backtrace(exception)
+      return exception.backtrace if exception.backtrace.respond_to?( :map )
+      return [] unless configuration.populate_empty_backtraces
+
+      caller_backtrace = caller
+      caller_backtrace.shift while caller_backtrace[0].include?(rollbar_lib_gem_dir)
+      caller_backtrace
+    end
+
+    def rollbar_lib_gem_dir
+      Gem::Specification.find_by_name('rollbar').gem_dir + '/lib'
+    end
+
     def trace_chain(exception)
       traces = [trace_data(exception)]
       visited = [exception]

data/lib/rollbar/configuration.rb

@@ -26,6 +26,7 @@ module Rollbar
     attr_accessor :person_id_method
     attr_accessor :person_username_method
     attr_accessor :person_email_method
+    attr_accessor :populate_empty_backtraces
     attr_accessor :report_dj_data
     attr_accessor :request_timeout
     attr_accessor :root
@@ -67,6 +68,7 @@ module Rollbar
       @person_username_method = 'username'
       @person_email_method = 'email'
       @project_gems = []
+      @populate_empty_backtraces = false
       @report_dj_data = true
       @request_timeout = 3
       @scrub_fields = [:passwd, :password, :password_confirmation, :secret,

data/lib/rollbar/sidekiq.rb

@@ -1,34 +1,33 @@
 # encoding: utf-8
 
-PARAM_BLACKLIST = %w[backtrace error_backtrace error_message error_class]
+module Rollbar
+  class Sidekiq
+    PARAM_BLACKLIST = %w[backtrace error_backtrace error_message error_class]
 
-if Sidekiq::VERSION < '3'
-  module Rollbar
-    class Sidekiq
-      def call(worker, msg, queue)
-        yield
-      rescue Exception => e
-        params = msg.reject{ |k| PARAM_BLACKLIST.include?(k) }
-        scope = { :request => { :params => params } }
+    def self.handle_exception(msg_or_context, e)
+      params = msg_or_context.reject{ |k| PARAM_BLACKLIST.include?(k) }
+      scope = { :request => { :params => params } }
 
-        Rollbar.scope(scope).error(e, :use_exception_level_filters => true)
-        raise
-      end
+      Rollbar.scope(scope).error(e, :use_exception_level_filters => true)
+    end
+
+    def call(worker, msg, queue)
+      yield
+    rescue Exception => e
+      Rollbar::Sidekiq.handle_exception(msg, e)
+      raise
     end
   end
+end
 
-  Sidekiq.configure_server do |config|
+Sidekiq.configure_server do |config|
+  if Sidekiq::VERSION < '3'
     config.server_middleware do |chain|
       chain.add Rollbar::Sidekiq
     end
-  end
-else
-  Sidekiq.configure_server do |config|
+  else
     config.error_handlers << Proc.new do |e, context|
-      params = context.reject{ |k| PARAM_BLACKLIST.include?(k) }
-      scope = { :request => { :params => params } }
-
-      Rollbar.scope(scope).error(e, :use_exception_level_filters => true)
+      Rollbar::Sidekiq.handle_exception(context, e)
     end
   end
 end

data/lib/rollbar/tasks/rollbar.cap

@@ -34,9 +34,9 @@ end
 
 namespace :load do
   task :defaults do
-    set :rollbar_user,  fetch(:rollbar_user,  Proc.new { ENV['USER'] || ENV['USERNAME'] } )
-    set :rollbar_env,   fetch(:rollbar_env,   Proc.new { fetch :rails_env, 'production' } )
-    set :rollbar_token, fetch(:rollbar_token, Proc.new { abort "Please specify the Rollbar access token, set :rollbar_token, 'your token'" } )
-    set :rollbar_role,  fetch(:rollbar_role,  Proc.new { :app } )
+    set :rollbar_user,  Proc.new { ENV['USER'] || ENV['USERNAME'] }
+    set :rollbar_env,   Proc.new { fetch :rails_env, 'production' }
+    set :rollbar_token, Proc.new { abort "Please specify the Rollbar access token, set :rollbar_token, 'your token'" }
+    set :rollbar_role,  Proc.new { :app }
   end
 end

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = "1.4.3"
+  VERSION = "1.4.4"
 end

data/rollbar.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'girl_friday', '>= 0.11.1'
   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 'genspec', '>= 0.2.8'
   gem.add_development_dependency 'sinatra'
   gem.add_development_dependency 'resque'
   gem.add_development_dependency 'delayed_job'

data/spec/rollbar/sidekiq_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+unless RUBY_VERSION == '1.8.7'
+  require 'sidekiq'
+  require 'rollbar/sidekiq'
+end
+
+describe Rollbar::Sidekiq, :reconfigure_notifier => false do
+  describe '.handle_exception' do
+    let(:msg_or_context) { ['hello', 'error_backtrace', 'backtrace', 'goodbye'] }
+    let(:exception) { StandardError.new('oh noes') }
+    let(:rollbar) { double }
+    let(:expected_args) { { :request => { :params => ['hello', 'goodbye'] } } }
+
+    subject { described_class }
+
+    it 'constructs scope from filtered params' do
+      allow(rollbar).to receive(:error)
+      expect(Rollbar).to receive(:scope).with(expected_args) {rollbar}
+
+      described_class.handle_exception(msg_or_context, exception)
+    end
+
+    it 'sends the passed-in error to rollbar' do
+      allow(Rollbar).to receive(:scope).and_return(rollbar)
+      expect(rollbar).to receive(:error).with(exception, :use_exception_level_filters => true)
+
+      described_class.handle_exception(msg_or_context, exception)
+    end
+  end
+
+  describe '#call' do
+    let(:msg) { ['hello'] }
+    let(:exception) { StandardError.new('oh noes') }
+    let(:middleware_block) { proc { raise exception } }
+
+    subject { Rollbar::Sidekiq.new }
+
+    it 'sends the error to Rollbar::Sidekiq.handle_exception' do
+      expect(Rollbar::Sidekiq).to receive(:handle_exception).with(msg, exception)
+
+      expect { subject.call(nil, msg, nil, &middleware_block) }.to raise_error(exception)
+    end
+  end
+end unless RUBY_VERSION == '1.8.7'
+
+

data/spec/rollbar_spec.rb

@@ -879,6 +879,25 @@ describe Rollbar do
       payload["data"][:body][:trace][:exception][:message].should == "oops"
     end
 
+    it 'gets the backtrace from the caller' do
+      Rollbar.configure do |config|
+        config.populate_empty_backtraces = true
+      end
+
+      exception = Exception.new
+
+      Rollbar.error(exception)
+
+      gem_dir = Gem::Specification.find_by_name('rollbar').gem_dir
+      gem_lib_dir = gem_dir + '/lib'
+      last_report = Rollbar.last_report
+
+      filepaths = last_report[:body][:trace][:frames].map {|frame| frame[:filename] }.reverse
+
+      expect(filepaths[0]).not_to include(gem_lib_dir)
+      expect(filepaths.any? {|filepath| filepath.include?(gem_dir) }).to be_true
+    end
+
     it 'should return the exception data with a uuid, on platforms with SecureRandom' do
       if defined?(SecureRandom) and SecureRandom.respond_to?(:uuid)
         exception_data = Rollbar.error(StandardError.new("oops"))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollbar
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.4.4
 platform: ruby
 authors:
 - Rollbar, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-04 00:00:00.000000000 Z
+date: 2015-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.2.7
+        version: 0.2.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.2.7
+        version: 0.2.8
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
@@ -309,6 +309,7 @@ files:
 - spec/rollbar/middleware/rack/builder_spec.rb
 - spec/rollbar/middleware/sinatra_spec.rb
 - spec/rollbar/rake_spec.rb
+- spec/rollbar/sidekiq_spec.rb
 - spec/rollbar/truncation/frames_strategy_spec.rb
 - spec/rollbar/truncation/min_body_strategy_spec.rb
 - spec/rollbar/truncation/strings_strategy_spec.rb
@@ -412,6 +413,7 @@ test_files:
 - spec/rollbar/middleware/rack/builder_spec.rb
 - spec/rollbar/middleware/sinatra_spec.rb
 - spec/rollbar/rake_spec.rb
+- spec/rollbar/sidekiq_spec.rb
 - spec/rollbar/truncation/frames_strategy_spec.rb
 - spec/rollbar/truncation/min_body_strategy_spec.rb
 - spec/rollbar/truncation/strings_strategy_spec.rb