rollbar 1.5.0 → 1.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 629a976cd25d915aed389102855a596e77a6c8af
+  data.tar.gz: 4dee53826f0b68b41031143156df4f74ed5a1edb
+SHA512:
+  metadata.gz: 682326d676624bf665d6ecef1b0b5fb5d7040dd2acd44126b41070684fdb5a341d2464302e6fc6fc6ce5493483fe6dedf07359303d738c654f23463e773d75ee
+  data.tar.gz: c56866b778b5209a2d273340c54ff01d7b6c72de07a986b38072d23e3e0e3c018440b5b2bb31c09c48383c25ed131aedfe0534662b72afbcb19c68228f191034

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Change Log
 
+## 1.5.1
+
+Bug fixes:
+
+- Fixed crashes when `Configuration#custom_data_method` fails. Now a report for that crash will be reported also. See [#235](https://github.com/rollbar/rollbar-gem/pull/235)
+
 ## 1.5.0
 
 Bug fixes:

data/README.md

@@ -1,15 +1,19 @@
-# Rollbar notifier for Ruby [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v1.5.0)](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.5.1)](https://travis-ci.org/rollbar/rollbar-gem/branches)
 
 <!-- RemoveNext -->
-Ruby gem for reporting exceptions, errors, and log messages to [Rollbar](https://rollbar.com).
+[Rollbar](https://rollbar.com) is an error tracking service for Ruby and other languages. The Rollbar service will alert you of problems with your code and help you understand them in a ways never possible before. We love it and we hope you will too.
+
+This is the Ruby library for Rollbar. It will instrument many kinds of Ruby applications automatically at the framework level. You can also make direct calls to send exceptions and messages to Rollbar.
 
 <!-- Sub:[TOC] -->
 
-## Installation
+## Getting Started
 
 Add this line to your application's Gemfile:
 
-    gem 'rollbar', '~> 1.5.0
+```ruby
+gem 'rollbar', '~> 1.5.1'
+```
 
 And then execute:
 
@@ -30,11 +34,9 @@ $ rails generate rollbar POST_SERVER_ITEM_ACCESS_TOKEN
 <!-- RemoveNextIfProject -->
 Be sure to replace ```POST_SERVER_ITEM_ACCESS_TOKEN``` with your project's ```post_server_item``` access token, which you can find in the Rollbar.com interface.
 
-That's all you need to use Rollbar with Rails.
-
-That will create the file ```config/initializers/rollbar.rb```, which holds the configuration values (currently just your access token).
+That will create the file ```config/initializers/rollbar.rb```, which initializes Rollbar and holds your access token and other configuration values.
 
-If you want to store your access token outside of your repo, run the same command without arguments, and create an environment variable ```ROLLBAR_ACCESS_TOKEN``` that holds your server-side access token:
+If you want to store your access token outside of your repo, run the same command without arguments and create an environment variable ```ROLLBAR_ACCESS_TOKEN``` that holds your server-side access token:
 
 ```bash
 $ rails generate rollbar
@@ -51,9 +53,10 @@ $ heroku config:add ROLLBAR_ACCESS_TOKEN=POST_SERVER_ITEM_ACCESS_TOKEN
 
 That's all you need to use Rollbar with Rails.
 
+
 ### If using Rack
 
-Be sure to initialize Rollbar with your access token somewhere during startup:
+Initialize Rollbar with your access token somewhere during startup:
 
 ```ruby
 Rollbar.configure do |config|
@@ -63,13 +66,12 @@ Rollbar.configure do |config|
 end
 ```
 
-
 <!-- RemoveNextIfProject -->
 Be sure to replace ```POST_SERVER_ITEM_ACCESS_TOKEN``` with your project's ```post_server_item``` access token, which you can find in the Rollbar.com interface.
 
 This monkey patches `Rack::Builder` to work with Rollbar automatically.
 
-For more control, disable the monkey patch in the rollbar configuration:
+For more control, disable the monkey patch:
 
 ```ruby
 Rollbar.configure do |config|
@@ -109,7 +111,7 @@ Uncaught exceptions in Rails controllers will be automatically reported to Rollb
 
 You can use one of `Rollbar.log(level, ...)`, `Rollbar.debug()`, `Rollbar.info()`, `Rollbar.warning()`, `Rollbar.error()` and `Rollbar.critical()` to report exceptions and messages.
 
-The methods take in any number of arguments, but the last exception is used as the reported exception, the last string is used as the message/description, and the last hash is used as the extra data.
+The methods accept any number of arguments. The last exception is used as the reported exception, the last string is used as the message/description, and the last hash is used as the extra data.
 
 For example:
 
@@ -290,7 +292,7 @@ class RollbarPersonData
   end
 end
 
-# You can add the middleware to your application, for ex:
+# You can add the middleware to your application, for example:
 
 class App < Sinatra::Base
   use Rollbar::Middleware::Sinatra
@@ -353,6 +355,8 @@ config.custom_data_method = lambda {
 
 This data will appear in the Occurrences tab and on the Occurrence Detail pages in the Rollbar interface.
 
+If your `custom_data_method` crashes while reporting an error, Rollbar will report that new error and will attach its uuid URL to the parent error report.
+
 ## Exception level filters
 
 By default, all uncaught exceptions are reported at the "error" level, except for the following, which are reported at "warning" level:
@@ -646,7 +650,7 @@ Some users have reported problems with Zeus when ```rake``` was not explicitly i
 
 You can find upgrading notes in [UPGRADING.md](UPGRADING.md).
 
-## Issues
+## Known Issues
 
 We've received some issues from users having problems when they use [Oj](https://github.com/ohler55/oj) as the JSON serialization library with [MultiJson](https://github.com/intridea/multi_json). To avoid these problems, we recommend upgrading to Oj version 2.11.0:
 

data/lib/rollbar.rb

@@ -35,6 +35,9 @@ module Rollbar
 
   class Notifier
     attr_accessor :configuration
+    attr_accessor :last_report
+
+    @file_semaphore = Mutex.new
 
     def initialize(parent_notifier = nil, payload_options = nil)
       if parent_notifier
@@ -48,11 +51,6 @@ module Rollbar
       end
     end
 
-    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
@@ -75,6 +73,17 @@ module Rollbar
       self
     end
 
+    # Returns a new notifier with same configuration options
+    # but it sets Configuration#safely to true.
+    # We are using this flag to avoid having inifite loops
+    # when evaluating some custom user methods.
+    def safely
+      new_notifier = scope
+      new_notifier.configuration.safely = true
+
+      new_notifier
+    end
+
     # Turns off reporting for the given block.
     #
     # @example
@@ -195,6 +204,15 @@ module Rollbar
       report_internal_error(e)
     end
 
+    def custom_data
+      data = configuration.custom_data_method.call
+      Rollbar::Util.deep_copy(data)
+    rescue => e
+      return {} if configuration.safely?
+
+      report_custom_data_error(e)
+    end
+
     private
 
     def ignored?(exception, use_exception_level_filters = false)
@@ -312,10 +330,7 @@ module Rollbar
     end
 
     def build_payload_body(message, exception, extra)
-      unless configuration.custom_data_method.nil?
-        custom = Rollbar::Util.deep_copy(configuration.custom_data_method.call)
-        extra = Rollbar::Util.deep_merge(custom, extra || {})
-      end
+      extra = Rollbar::Util.deep_merge(custom_data, extra || {}) if custom_data_method?
 
       if exception
         build_payload_body_exception(message, exception, extra)
@@ -324,6 +339,20 @@ module Rollbar
       end
     end
 
+    def custom_data_method?
+      !!configuration.custom_data_method
+    end
+
+    def report_custom_data_error(e)
+      data = safely.error(e)
+
+      return {} unless data[:uuid]
+
+      uuid_url = uuid_rollbar_url(data)
+
+      { :_error_in_custom_data_method => uuid_url }
+    end
+
     def build_payload_body_exception(message, exception, extra)
       traces = trace_chain(exception)
 
@@ -650,10 +679,15 @@ module Rollbar
 
     def log_instance_link(data)
       if data[:uuid]
-        log_info "[Rollbar] Details: #{configuration.web_base}/instance/uuid?uuid=#{data[:uuid]} (only available if report was successful)"
+        uuid_url = uuid_rollbar_url(data)
+        log_info "[Rollbar] Details: #{uuid_url} (only available if report was successful)"
       end
     end
 
+    def uuid_rollbar_url(data)
+      "#{configuration.web_base}/instance/uuid?uuid=#{data[:uuid]}"
+    end
+
     def logger
       @logger ||= LoggerProxy.new(configuration.logger)
     end
@@ -700,6 +734,10 @@ module Rollbar
       @configuration ||= Configuration.new
     end
 
+    def safely?
+      configuration.safely?
+    end
+
     def require_hooks
       return if configuration.disable_monkey_patch
       wrap_delayed_worker

data/lib/rollbar/configuration.rb

@@ -30,6 +30,7 @@ module Rollbar
     attr_accessor :report_dj_data
     attr_accessor :request_timeout
     attr_accessor :root
+    attr_accessor :safely
     attr_accessor :scrub_fields
     attr_accessor :uncaught_exception_level
     attr_accessor :scrub_headers
@@ -40,6 +41,8 @@ module Rollbar
 
     attr_reader :project_gem_paths
 
+    alias_method :safely?, :safely
+
     DEFAULT_ENDPOINT = 'https://api.rollbar.com/api/1/item/'
     DEFAULT_WEB_BASE = 'https://rollbar.com'
 
@@ -75,6 +78,7 @@ module Rollbar
                        :confirm_password, :password_confirmation, :secret_token]
       @uncaught_exception_level = 'error'
       @scrub_headers = ['Authorization']
+      @safely = false
       @use_async = false
       @use_eventmachine = false
       @web_base = DEFAULT_WEB_BASE

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = "1.5.0"
+  VERSION = "1.5.1"
 end

data/spec/rollbar_spec.rb

@@ -13,6 +13,10 @@ end
 
 describe Rollbar do
   let(:notifier) { Rollbar.notifier }
+  before do
+    Rollbar.unconfigure
+    configure
+  end
 
   context 'when notifier has been used before configure it' do
     before do
@@ -287,11 +291,6 @@ describe Rollbar do
     end
 
     context 'build_payload' do
-      after(:each) do
-        Rollbar.unconfigure
-        configure
-      end
-
       context 'a basic payload' do
         let(:extra_data) { {:key => 'value', :hash => {:inner_key => 'inner_value'}} }
         let(:payload) { notifier.send(:build_payload, 'info', 'message', nil, extra_data) }
@@ -409,6 +408,32 @@ describe Rollbar do
         payload['data'][:body][:message][:extra][:f].should == 'f'
       end
 
+      context 'with custom_data_method crashing' do
+        next unless defined?(SecureRandom) and SecureRandom.respond_to?(:uuid)
+
+        let(:crashing_exception) { StandardError.new }
+        let(:custom_method) { proc { raise crashing_exception } }
+        let(:extra) { { :foo => :bar } }
+        let(:custom_data_report) do
+          { :_error_in_custom_data_method => SecureRandom.uuid }
+        end
+        let(:expected_extra) { extra.merge(custom_data_report) }
+
+        before do
+          notifier.configure do |config|
+            config.custom_data_method = custom_method
+          end
+
+          expect(notifier).to receive(:report_custom_data_error).once.and_return(custom_data_report)
+        end
+
+        it 'doesnt crash the report' do
+          payload = notifier.send(:build_payload, 'info', 'message', nil, extra)
+
+          expect(payload['data'][:body][:message][:extra]).to be_eql(expected_extra)
+        end
+      end
+
       it 'should include project_gem_paths' do
         notifier.configure do |config|
           config.project_gems = ['rails', 'rspec']
@@ -1664,6 +1689,35 @@ describe Rollbar do
     end
   end
 
+  describe '#custom_data' do
+    before do
+      Rollbar.configure do |config|
+        config.custom_data_method = proc { raise 'this-will-raise' } 
+      end
+
+      expect_any_instance_of(Rollbar::Notifier).to receive(:error).and_return(report_data)
+    end
+
+    context 'with uuid in reported data' do
+      next unless defined?(SecureRandom) and SecureRandom.respond_to?(:uuid)
+
+      let(:report_data) { { :uuid => SecureRandom.uuid } }
+      let(:expected_url) { "https://rollbar.com/instance/uuid?uuid=#{report_data[:uuid]}" }
+
+      it 'returns the uuid in :_error_in_custom_data_method' do
+        expect(notifier.custom_data).to be_eql(:_error_in_custom_data_method => expected_url)
+      end
+    end
+
+    context 'without uuid in reported data' do
+      let(:report_data) { { :some => 'other-data' } }
+
+      it 'returns the uuid in :_error_in_custom_data_method' do
+        expect(notifier.custom_data).to be_eql({})
+      end
+    end
+  end
+
   # configure with some basic params
   def configure
     reconfigure_notifier

metadata

@@ -1,206 +1,181 @@
 --- !ruby/object:Gem::Specification
 name: rollbar
 version: !ruby/object:Gem::Version
-  version: 1.5.0
-  prerelease: 
+  version: 1.5.1
 platform: ruby
 authors:
 - Rollbar, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2015-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: girl_friday
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.11.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.11.1
 - !ruby/object:Gem::Dependency
   name: sucker_punch
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: genspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.8
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: resque
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: delayed_job
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
 description: Rails plugin to catch and send exceptions to Rollbar
@@ -211,8 +186,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -355,27 +330,26 @@ files:
 homepage: https://github.com/rollbar/rollbar-gem
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.3.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Reports exceptions to Rollbar
 test_files:
 - spec/controllers/home_controller_spec.rb