rollbar 2.12.0 → 2.13.0

data/spec/rollbar/notifier_spec.rb

@@ -0,0 +1,43 @@
+require 'rollbar'
+require 'rollbar/notifier'
+
+describe Rollbar::Notifier do
+  describe '#scope' do
+    let(:new_scope) do
+      { 'foo' => 'bar' }
+    end
+    let(:new_config) do
+      { 'environment' => 'foo' }
+    end
+
+    it 'creates a new notifier with merged scope and configuration' do
+      new_notifier = subject.scope(new_scope, new_config)
+
+      expect(new_notifier).not_to be(subject)
+      expect(subject.configuration.environment).to be_eql(nil)
+      expect(new_notifier.configuration.environment).to be_eql('foo')
+      expect(new_notifier.scope_object['foo']).to be_eql('bar')
+      expect(new_notifier.configuration).not_to be(subject.configuration)
+      expect(new_notifier.scope_object).not_to be(subject.scope_object)
+    end
+  end
+
+  describe '#scope!' do
+    let(:new_scope) do
+      { 'foo' => 'bar' }
+    end
+    let(:new_config) do
+      { 'environment' => 'foo' }
+    end
+
+    it 'mutates the notifier with a merged scope and configuration' do
+      result = subject.scope!(new_scope, new_config)
+
+      expect(result).to be(subject)
+      expect(subject.configuration.environment).to be_eql('foo')
+      expect(subject.scope_object['foo']).to be_eql('bar')
+      expect(subject.configuration).to be(subject.configuration)
+      expect(subject.scope_object).to be(subject.scope_object)
+    end
+  end
+end

data/spec/rollbar/plugins/delayed_job/{job_data.rb → job_data_spec.rb}

@@ -1,8 +1,21 @@
 require 'spec_helper'
-
-require 'rollbar/delayed_job'
+require 'rollbar/plugins/delayed_job/job_data'
 require 'delayed/backend/test'
 
+# In delayed_job/lib/delayed/syck_ext.rb YAML.load_dj
+# is broken cause it's defined as an instance method
+# instead of module/class method. This is breaking
+# the tests for ruby 1.8.7
+if YAML.parser.class.name =~ /syck|yecht/i
+  module YAML
+    def self.load_dj(yaml)
+      # See https://github.com/dtao/safe_yaml
+      # When the method is there, we need to load our YAML like this...
+      respond_to?(:unsafe_load) ? load(yaml, :safe => false) : load(yaml)
+    end
+  end
+end
+
 describe Rollbar::Delayed::JobData do
   describe '#to_hash' do
     let(:handler) { { 'foo' => 'bar' } }

data/spec/rollbar/plugins/rack_spec.rb

@@ -41,11 +41,11 @@ describe Rollbar::Middleware::Rack::Builder, :reconfigure_notifier => true do
         request.get('/will_crash', :params => params)
       end.to raise_error(exception)
 
-      expect(Rollbar.last_report[:request][:params]).to be_eql(params)
+      expect(Rollbar.last_report[:request][:GET]).to be_eql(params)
     end
   end
 
-  context 'with POST parameters' do
+  context 'with JSON body parameters' do
     let(:params) do
       { 'key' => 'value' }
     end
@@ -55,7 +55,7 @@ describe Rollbar::Middleware::Rack::Builder, :reconfigure_notifier => true do
         request.post('/will_crash', :input => params.to_json, 'CONTENT_TYPE' => 'application/json')
       end.to raise_error(exception)
 
-      expect(Rollbar.last_report[:request][:params]).to be_eql(params)
+      expect(Rollbar.last_report[:request][:body]).to be_eql(params.to_json)
     end
   end
 
@@ -69,8 +69,8 @@ describe Rollbar::Middleware::Rack::Builder, :reconfigure_notifier => true do
         request.post('/will_crash', :input => params.to_json, 'CONTENT_TYPE' => 'application/json')
       end.to raise_error(exception)
 
-      reported_params = Rollbar.last_report[:request][:params]
-      expect(reported_params['body.multi']).to be_eql([{'key' => 'value'}, 'string', 10])
+      reported_body = Rollbar.last_report[:request][:body]
+      expect(reported_body).to be_eql({ 'body.multi' => [{'key' => 'value'}, 'string', 10] }.to_json)
     end
   end
 
@@ -82,8 +82,8 @@ describe Rollbar::Middleware::Rack::Builder, :reconfigure_notifier => true do
         request.post('/will_crash', :input => params.to_json, 'CONTENT_TYPE' => 'application/json')
       end.to raise_error(exception)
 
-      reported_params = Rollbar.last_report[:request][:params]
-      expect(reported_params['body.value']).to be_eql(1000)
+      reported_body = Rollbar.last_report[:request][:body]
+      expect(reported_body).to be_eql({ 'body.value' => params }.to_json)
     end
   end
 

data/spec/rollbar/plugins/rake_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 Rollbar.plugins.load!
 
 describe Rollbar::Rake do
-  let(:application) { Rake::Application.new }
+  let(:application) { Rake.application }
   let(:exception) { Exception.new }
 
   context 'with supported rake version' do
@@ -12,7 +12,6 @@ describe Rollbar::Rake do
     end
 
     it 'reports error to Rollbar' do
-      expect(Rollbar::Rake).not_to receive(:skip_patch)
       expect(Rollbar).to receive(:error).with(exception, :use_exception_level_filters => true)
       expect(application).to receive(:orig_display_error_message).with(exception)
 

data/spec/rollbar/plugins/resque/failure_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'rollbar/plugins/resque/failure'
+
+describe Resque::Failure::Rollbar do
+  let(:exception) { StandardError.new('BOOM') }
+  let(:worker) { Resque::Worker.new(:test) }
+  let(:queue) { 'test' }
+  let(:payload) { { 'class' => Object, 'args' => 89 } }
+  let(:backend) do
+    Resque::Failure::Rollbar.new(exception, worker, queue, payload)
+  end
+
+  context 'with Rollbar version <= 1.3' do
+    before do
+      allow(backend).to receive(:rollbar_version).and_return('1.3.0')
+    end
+
+    it 'should be notified of an error' do
+      expect_any_instance_of(Rollbar::Notifier).to receive(:log).with('error', exception, payload)
+      backend.save
+    end
+  end
+
+  context 'with Rollbar version > 1.3' do
+    let(:payload_with_options) { payload.merge(:use_exception_level_filters => true) }
+
+    before do
+      allow(backend).to receive(:rollbar_version).and_return('1.4.0')
+    end
+
+    it 'sends the :use_exception_level_filters option' do
+      expect_any_instance_of(Rollbar::Notifier).to receive(:error).with(exception, payload_with_options)
+      backend.save
+    end
+  end
+end

data/spec/rollbar/request_data_extractor_spec.rb

@@ -71,7 +71,7 @@ describe Rollbar::RequestDataExtractor do
   describe '#extract_request_data_from_rack' do
     it 'returns a Hash object' do
       expect(Rollbar::Scrubbers::URL).to receive(:call).with(kind_of(Hash)).and_call_original
-      expect(Rollbar::Scrubbers::Params).to receive(:call).with(kind_of(Hash)).and_call_original.exactly(7)
+      expect(Rollbar::Scrubbers::Params).to receive(:call).with(kind_of(Hash)).and_call_original.exactly(6)
 
       result = subject.extract_request_data_from_rack(env)
 
@@ -97,6 +97,108 @@ describe Rollbar::RequestDataExtractor do
 
         expect(result).to be_kind_of(Hash)
       end
+
+      context 'with CONTENT_TYPE and CONTENT_LENGTH headers' do
+        let(:env) do
+          Rack::MockRequest.env_for('/',
+                                    'HTTP_HOST' => 'localhost:81',
+                                    'HTTP_X_FORWARDED_HOST' => 'example.org:9292',
+                                    'CONTENT_TYPE' => 'application/json',
+                                    'CONTENT_LENGTH' => 20)
+
+
+        end
+
+        it 'adds the content type header to the headers key' do
+          result = subject.extract_request_data_from_rack(env)
+
+          expect(result[:headers]['Content-Type']).to be_eql('application/json')
+          expect(result[:headers]['Content-Length']).to be_eql(20)
+        end
+      end
+    end
+
+    context 'with multiple addresses in X-Forwarded-For' do
+      let(:env) do
+        Rack::MockRequest.env_for('/',
+                                  'HTTP_HOST' => 'localhost:81',
+                                  'HTTP_X_FORWARDED_FOR' => header_value,
+                                  'REMOTE_ADDR' => '3.3.3.3',
+                                  'CONTENT_TYPE' => 'application/json',
+                                  'CONTENT_LENGTH' => 20)
+
+
+      end
+
+      context 'with public client IP' do
+        let(:header_value) { '2.2.2.2, 3.3.3.3' }
+
+        it 'extracts the correct user IP' do
+          result = subject.extract_request_data_from_rack(env)
+
+          expect(result[:user_ip]).to be_eql('2.2.2.2')
+        end
+      end
+
+      context 'with private first client IP' do
+        let(:header_value) { '192.168.1.1, 2.2.2.2, 3.3.3.3' }
+
+        it 'extracts the correct user IP' do
+          result = subject.extract_request_data_from_rack(env)
+
+          expect(result[:user_ip]).to be_eql('2.2.2.2')
+        end
+      end
+    end
+
+    context 'with JSON POST body' do
+      let(:params) { { 'key' => 'value' } }
+      let(:body) { params.to_json }
+      let(:env) do
+        Rack::MockRequest.env_for('/?foo=bar',
+                                  'CONTENT_TYPE' => 'application/json',
+                                  :input => body,
+                                  :method => 'POST')
+
+
+      end
+
+      it 'extracts the correct user IP' do
+        result = subject.extract_request_data_from_rack(env)
+        expect(result[:body]).to be_eql(body)
+      end
+    end
+
+    context 'with POST params' do
+      let(:params) { { 'key' => 'value' } }
+      let(:env) do
+        Rack::MockRequest.env_for('/?foo=bar',
+                                  :params => params,
+                                  :method => 'POST')
+
+
+      end
+
+      it 'extracts the correct user IP' do
+        result = subject.extract_request_data_from_rack(env)
+        expect(result[:POST]).to be_eql(params)
+      end
+    end
+
+    context 'with GET params' do
+      let(:params) { { 'key' => 'value' } }
+      let(:env) do
+        Rack::MockRequest.env_for('/?foo=bar',
+                                  :params => params,
+                                  :method => 'GET')
+
+
+      end
+
+      it 'extracts the correct user IP' do
+        result = subject.extract_request_data_from_rack(env)
+        expect(result[:GET]).to be_eql(params)
+      end
     end
   end
 end

data/spec/rollbar/truncation/min_body_strategy_spec.rb

@@ -45,7 +45,7 @@ describe Rollbar::Truncation::MinBodyStrategy do
     end
 
     context 'with a message payload' do
-      let(:payload_fixture) { 'payloads/sample.trace_chain.json' }
+      let(:payload_fixture) { 'payloads/message.json' }
 
       it "doesn't truncate anything and returns same payload" do
         result = Rollbar::JSON.load(described_class.call(payload))

data/spec/rollbar/truncation/strings_strategy_spec.rb

@@ -43,7 +43,7 @@ describe Rollbar::Truncation::StringsStrategy do
 
     context 'when first threshold is not enough' do
       let(:payload) do
-        129.times.to_enum.reduce({}) do |hash, i|
+        512.times.to_enum.reduce({}) do |hash, i|
           hash[i.to_s] = 'a' * 1024
           hash
         end
@@ -58,7 +58,7 @@ describe Rollbar::Truncation::StringsStrategy do
 
     context 'when second threshold is still not enough' do
       let(:payload) do
-        257.times.to_enum.reduce({}) do |hash, i|
+        1024.times.to_enum.reduce({}) do |hash, i|
           hash[i.to_s] = 'a' * 1024
           hash
         end

data/spec/rollbar_bc_spec.rb

@@ -77,7 +77,7 @@ describe Rollbar do
       end
     end
 
-    after(:each) do
+    after do
       Rollbar.unconfigure
       configure
     end
@@ -136,7 +136,7 @@ describe Rollbar do
       end
     end
 
-    after(:each) do
+    after do
       Rollbar.unconfigure
       configure
     end
@@ -162,14 +162,14 @@ describe Rollbar do
     end
 
     it 'should not be enabled when not configured' do
-      Rollbar.unconfigure
+      Rollbar.clear_notifier!
 
       Rollbar.configuration.enabled.should be_nil
       Rollbar.report_exception(@exception).should == 'disabled'
     end
 
     it 'should stay disabled if configure is called again' do
-      Rollbar.unconfigure
+      Rollbar.clear_notifier!
 
       # configure once, setting enabled to false.
       Rollbar.configure do |config|

data/spec/rollbar_spec.rb

@@ -10,6 +10,7 @@ require 'active_support/json/encoding'
 require 'rollbar/item'
 begin
   require 'rollbar/delay/sidekiq'
+  require 'rollbar/delay/sucker_punch'
 rescue LoadError
 end
 
@@ -23,15 +24,15 @@ require 'spec_helper'
 
 describe Rollbar do
   let(:notifier) { Rollbar.notifier }
+
   before do
-    Rollbar.unconfigure
+    Rollbar.clear_notifier!
     configure
   end
 
   context 'when notifier has been used before configure it' do
     before do
-      Rollbar.unconfigure
-      Rollbar.reset_notifier!
+      Rollbar.clear_notifier!
     end
 
     it 'is finally reset' do
@@ -44,6 +45,49 @@ describe Rollbar do
     end
   end
 
+  shared_examples 'stores the root notifier' do
+
+  end
+
+  describe '.configure' do
+    before { Rollbar.clear_notifier! }
+
+    it 'stores the root notifier' do
+      Rollbar.configure { |c| }
+      expect(Rollbar.root_notifier).to be(Rollbar.notifier)
+    end
+  end
+
+  describe '.preconfigure' do
+    before { Rollbar.clear_notifier! }
+
+    it 'stores the root notifier' do
+      Rollbar.preconfigure { |c| }
+      expect(Rollbar.root_notifier).to be(Rollbar.notifier)
+    end
+  end
+
+  describe '.reconfigure' do
+    before { Rollbar.clear_notifier! }
+
+    it 'stores the root notifier' do
+      Rollbar.reconfigure { |c| }
+      expect(Rollbar.root_notifier).to be(Rollbar.notifier)
+    end
+  end
+
+  describe '.unconfigure' do
+    before { Rollbar.clear_notifier! }
+
+    it 'stores the root notifier' do
+      expect(Rollbar.root_notifier).to receive(:unconfigure)
+
+      Rollbar.unconfigure
+
+      expect(Rollbar.root_notifier).to be(Rollbar.notifier)
+    end
+  end
+
   context 'Notifier' do
     describe '#log' do
       let(:exception) do
@@ -58,8 +102,7 @@ describe Rollbar do
 
       context 'executing a Thread before Rollbar is configured' do
         before do
-          Rollbar.reset_notifier!
-          Rollbar.unconfigure
+          Rollbar.clear_notifier!
 
           Thread.new {}
 
@@ -333,10 +376,12 @@ describe Rollbar do
       end
 
       it 'should not modify any parent notifier configuration' do
+        Rollbar.clear_notifier!
         configure
         Rollbar.configuration.code_version.should be_nil
         Rollbar.configuration.payload_options.should be_empty
 
+        notifier = Rollbar.notifier.scope
         notifier.configure do |config|
           config.code_version = '123'
           config.payload_options = {
@@ -394,8 +439,7 @@ describe Rollbar do
         end
       end
 
-      after(:each) do
-        Rollbar.unconfigure
+      after do
         configure
       end
 
@@ -439,18 +483,15 @@ describe Rollbar do
     let(:logger_mock) { double("Rails.logger").as_null_object }
     let(:user) { User.create(:email => 'email@example.com', :encrypted_password => '', :created_at => Time.now, :updated_at => Time.now) }
 
-    before(:each) do
+    before do
+      Rollbar.unconfigure
       configure
+
       Rollbar.configure do |config|
         config.logger = logger_mock
       end
     end
 
-    after(:each) do
-      Rollbar.unconfigure
-      configure
-    end
-
     it 'should report exceptions without person or request data' do
       logger_mock.should_receive(:info).with('[Rollbar] Success')
       Rollbar.error(exception)
@@ -476,22 +517,20 @@ describe Rollbar do
     end
 
     it 'should not be enabled when not configured' do
-      Rollbar.unconfigure
+      Rollbar.clear_notifier!
 
       Rollbar.configuration.enabled.should be_nil
       Rollbar.error(exception).should == 'disabled'
     end
 
     it 'should stay disabled if configure is called again' do
-      Rollbar.unconfigure
-
       # configure once, setting enabled to false.
       Rollbar.configure do |config|
         config.enabled = false
       end
 
       # now configure again (perhaps to change some other values)
-      Rollbar.configure do |config| end
+      Rollbar.configure { |_| }
 
       Rollbar.configuration.enabled.should == false
       Rollbar.error(exception).should == 'disabled'
@@ -833,8 +872,7 @@ describe Rollbar do
       end
     end
 
-    after(:each) do
-      Rollbar.unconfigure
+    after do
       configure
     end
 
@@ -880,15 +918,15 @@ describe Rollbar do
   end
 
   context 'asynchronous_handling' do
-    before(:each) do
+    before do
+      Rollbar.clear_notifier!
       configure
       Rollbar.configure do |config|
         config.logger = logger_mock
       end
     end
 
-    after(:each) do
-      Rollbar.unconfigure
+    after do
       configure
     end
 
@@ -1042,13 +1080,9 @@ describe Rollbar do
     describe "#use_sucker_punch", :if => defined?(SuckerPunch) do
       it "should send the payload to sucker_punch delayer" do
         logger_mock.should_receive(:info).with('[Rollbar] Scheduling item')
-        logger_mock.should_receive(:info).with('[Rollbar] Sending item')
-        logger_mock.should_receive(:info).with('[Rollbar] Success')
-
-        Rollbar.configure do |config|
-          config.use_sucker_punch
-        end
+        expect(Rollbar::Delay::SuckerPunch).to receive(:call)
 
+        Rollbar.configure(&:use_sucker_punch)
         Rollbar.error(exception)
       end
     end
@@ -1099,7 +1133,7 @@ describe Rollbar do
       Rollbar.send(:logger).should_not be_nil
     end
 
-    after(:each) do
+    after do
       reset_configuration
     end
   end
@@ -1222,6 +1256,18 @@ describe Rollbar do
         expect(sent_payload['data'][:body][:message][:body]).to be_eql(expected_body)
       end
     end
+
+    context 'with uuid and host' do
+      let(:host) { 'the-host' }
+      let(:uuid) { 'the-uuid' }
+      it 'sets the uuid and host in correct keys' do
+        sent_payload = notifier.send(:send_failsafe, 'testing uuid and host',
+                                     exception, uuid, host)
+
+        expect(sent_payload['data'][:custom][:orig_uuid]).to be_eql('the-uuid')
+        expect(sent_payload['data'][:custom][:orig_host]).to be_eql('the-host')
+      end
+    end
   end
 
   context 'when reporting internal error with nil context' do
@@ -1267,7 +1313,7 @@ describe Rollbar do
     end
 
     it 'changes data in scope_object inside the block' do
-      Rollbar.reset_notifier!
+      Rollbar.clear_notifier!
       configure
 
       current_notifier_id = Rollbar.notifier.object_id
@@ -1330,12 +1376,13 @@ describe Rollbar do
     end
   end
 
-  describe '.reset_notifier' do
-    it 'resets the notifier' do
-      notifier1_id = Rollbar.notifier.object_id
+  describe '.clear_notifier' do
+    before { Rollbar.notifier }
 
-      Rollbar.reset_notifier!
-      expect(Rollbar.notifier.object_id).not_to be_eql(notifier1_id)
+    it 'resets the notifier' do
+      Rollbar.clear_notifier!
+      expect(Rollbar.instance_variable_get('@notifier')).to be_nil
+      expect(Rollbar.instance_variable_get('@root_notifier')).to be_nil
     end
   end
 
@@ -1373,8 +1420,7 @@ describe Rollbar do
 
   describe '.preconfigure'do
     before do
-      Rollbar.unconfigure
-      Rollbar.reset_notifier!
+      Rollbar.clear_notifier!
     end
 
     it 'resets the notifier' do
@@ -1417,6 +1463,22 @@ describe Rollbar do
     end
   end
 
+  describe '.with_config' do
+    let(:new_config) do
+      { 'environment' => 'foo' }
+    end
+
+    it 'uses the new config and restores the old one' do
+      config1 = described_class.configuration
+
+      subject.with_config(:environment => 'bar') do
+        expect(described_class.configuration).not_to be(config1)
+      end
+
+      expect(described_class.configuration).to be(config1)
+    end
+  end
+
   # configure with some basic params
   def configure
     reconfigure_notifier