rollbar 1.2.10 → 1.2.11

data/spec/rollbar/truncation/frames_strategy_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+require 'rollbar/truncation/frames_strategy'
+
+describe Rollbar::Truncation::FramesStrategy do
+  def expand_frames(frames)
+    frames * (1 + 300 / frames.count)
+  end
+
+  describe '.call', :fixture => :payload do
+    context 'with trace key' do
+      let(:payload_fixture) { 'payloads/sample.trace.json' }
+      let(:frames) { payload['data'][:body][:trace][:frames].clone }
+
+      before do
+        payload['data'][:body][:trace][:frames] = expand_frames(frames)
+      end
+
+      it 'returns a new payload with 300 frames' do
+        result = symbolize_recursive(MultiJson.load(described_class.call(payload)))
+
+        new_frames = result[:data][:body][:trace][:frames]
+
+        expect(new_frames.count).to be_eql(300)
+        expect(new_frames.first).to be_eql(frames.first)
+        expect(new_frames.last).to be_eql(frames.last)
+      end
+    end
+
+    context 'with trace_chain key' do
+      let(:payload_fixture) { 'payloads/sample.trace_chain.json' }
+
+      let(:frames1) { payload['data'][:body][:trace_chain][0][:frames].clone }
+      let(:frames2) { payload['data'][:body][:trace_chain][1][:frames].clone }
+
+      before do
+        payload['data'][:body][:trace_chain][0][:frames] = expand_frames(frames1)
+        payload['data'][:body][:trace_chain][1][:frames] = expand_frames(frames2)
+      end
+
+      it 'returns a new payload with 300 frames for each chain item' do
+        result = symbolize_recursive(MultiJson.load(described_class.call(payload)))
+
+        new_frames1 = result[:data][:body][:trace_chain][0][:frames]
+        new_frames2 = result[:data][:body][:trace_chain][1][:frames]
+
+        expect(new_frames1.count).to be_eql(300)
+        expect(new_frames1.first).to be_eql(frames1.first)
+        expect(new_frames1.last).to be_eql(frames1.last)
+
+        expect(new_frames2.count).to be_eql(300)
+        expect(new_frames2.first).to be_eql(frames2.first)
+        expect(new_frames2.last).to be_eql(frames2.last)
+      end
+    end
+  end
+end

data/spec/rollbar/truncation/min_body_strategy_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+require 'rollbar/truncation/frames_strategy'
+
+describe Rollbar::Truncation::MinBodyStrategy do
+  describe '.call', :fixture => :payload do
+    let(:message) { 'a' * 1_000 }
+
+    context 'with trace key ' do
+      let(:payload_fixture) { 'payloads/sample.trace.json' }
+      let!(:frames) { payload['data'][:body][:trace][:frames].clone }
+
+      before do
+        payload['data'][:body][:trace][:exception][:message] = message
+      end
+
+      it 'truncates the exception message and frames array' do
+        result = symbolize_recursive(MultiJson.load(described_class.call(payload)))
+
+        trace = result[:data][:body][:trace]
+        expect(trace[:frames]).to have(2).items
+        expect(trace[:exception][:message]).to be_eql('a' * 255)
+      end
+    end
+
+    context 'with trace_chain key ' do
+      let(:payload_fixture) { 'payloads/sample.trace_chain.json' }
+      let!(:frames1) { payload['data'][:body][:trace_chain][0][:frames].clone }
+      let!(:frames2) { payload['data'][:body][:trace_chain][1][:frames].clone }
+
+      before do
+        payload['data'][:body][:trace_chain][0][:exception][:message] = message
+        payload['data'][:body][:trace_chain][1][:exception][:message] = message
+      end
+
+      it 'truncates the exception message and frames array' do
+        result = symbolize_recursive(MultiJson.load(described_class.call(payload)))
+
+        traces = result[:data][:body][:trace_chain]
+        expect(traces[0][:frames]).to have(2).items
+        expect(traces[0][:exception][:message]).to be_eql('a' * 255)
+
+        expect(traces[1][:frames]).to have(2).items
+        expect(traces[1][:exception][:message]).to be_eql('a' * 255)
+      end
+    end
+  end
+end

data/spec/rollbar/truncation/strings_strategy_spec.rb

@@ -0,0 +1,89 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+require 'rollbar/truncation/frames_strategy'
+
+describe Rollbar::Truncation::StringsStrategy do
+  describe '.call' do
+    let(:long_message) { 'a' * 2000 }
+    let(:payload) do
+      {
+        :truncated => long_message,
+        :not_truncated => '123456',
+        :hash => {
+          :inner_truncated => long_message,
+          :inner_not_truncated => '567',
+          :array => ['12345678', '12', { :inner_inner => long_message }]
+        }
+      }
+    end
+
+    it 'should truncate all nested strings in the payload' do
+      result = symbolize_recursive(MultiJson.load(described_class.call(payload)))
+
+      expect(result[:truncated].size).to be_eql(1024)
+      expect(result[:hash][:inner_truncated].size).to be_eql(1024)
+      expect(result[:hash][:array][2][:inner_inner].size).to be_eql(1024)
+    end
+
+    context 'with utf8 strings' do
+      let(:long_message) { 'Ŝǻмρļẻ śţяịņģ' + 'a' * 2000 }
+      let(:payload) do
+        {
+          :truncated => long_message,
+          :not_truncated => '123456',
+        }
+      end
+
+      it 'should truncate utf8 strings properly' do
+        result = symbolize_recursive(MultiJson.load(described_class.call(payload)))
+        expect(result[:truncated]).to match(/^Ŝǻмρļẻ śţяịņģa*\.{3}/)
+      end
+    end
+
+    context 'when first threshold is not enough' do
+      let(:payload) do
+        129.times.to_enum.reduce({}) do |hash, i|
+          hash[i.to_s] = 'a' * 1024
+          hash
+        end
+      end
+
+      it 'truncates to 512 size strings' do
+        result = MultiJson.load(described_class.call(payload))
+
+        expect(result['0'].size).to be_eql(512)
+      end
+    end
+
+    context 'when second threshold is still not enough' do
+      let(:payload) do
+        257.times.to_enum.reduce({}) do |hash, i|
+          hash[i.to_s] = 'a' * 1024
+          hash
+        end
+      end
+
+      it 'truncates to 256 size strings, the third threshold' do
+        result = MultiJson.load(described_class.call(payload))
+
+        expect(result['0'].size).to be_eql(256)
+      end
+    end
+
+    context 'when third threshold is still not enough' do
+      let(:payload) do
+        1024.times.to_enum.reduce({}) do |hash, i|
+          hash[i.to_s] = 'a' * 1024
+          hash
+        end
+      end
+
+      it 'just return the value for third threshold' do
+        result = MultiJson.load(described_class.call(payload))
+
+        expect(result['0'].size).to be_eql(256)
+      end
+    end
+  end
+end

data/spec/rollbar/truncation_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+require 'rollbar/truncation'
+
+describe Rollbar::Truncation do
+  describe '.truncate' do
+    let(:payload) { {} }
+
+    context 'if truncation is not needed' do
+      it 'only calls RawStrategy is truncation is not needed' do
+        allow(described_class).to receive(:truncate?).and_return(false)
+        expect(Rollbar::Truncation::RawStrategy).to receive(:call).with(payload)
+
+        Rollbar::Truncation.truncate(payload)
+      end
+    end
+
+    context 'if truncation is needed' do
+      it 'calls the next strategy, FramesStrategy' do
+        allow(described_class).to receive(:truncate?).and_return(true, false)
+        expect(Rollbar::Truncation::RawStrategy).to receive(:call).with(payload)
+        expect(Rollbar::Truncation::FramesStrategy).to receive(:call).with(payload)
+
+        Rollbar::Truncation.truncate(payload)
+      end
+    end
+  end
+end

data/spec/rollbar_spec.rb

@@ -13,6 +13,23 @@ end
 
 describe Rollbar do
   let(:notifier) { Rollbar.notifier }
+
+  context 'when notifier has been used before configure it' do
+    before do
+      Rollbar.unconfigure
+      Rollbar.reset_notifier!
+    end
+
+    it 'is finally reset' do
+      Rollbar.log_debug('Testing notifier')
+      expect(Rollbar.error('error message')).to be_eql('disabled')
+
+      reconfigure_notifier
+
+      expect(Rollbar.error('error message')).not_to be_eql('disabled')
+    end
+  end
+
   context 'Notifier' do
     context 'log' do
       let(:exception) do
@@ -642,42 +659,6 @@ describe Rollbar do
         body[:message][:extra][:hash].should == {:inner_key => 'inner_value'}
       end
     end
-
-    context 'truncate_payload' do
-      it 'should truncate all nested strings in the payload' do
-        payload = {
-          :truncated => '1234567',
-          :not_truncated => '123456',
-          :hash => {
-            :inner_truncated => '123456789',
-            :inner_not_truncated => '567',
-            :array => ['12345678', '12', {:inner_inner => '123456789'}]
-          }
-        }
-
-        payload_copy = payload.clone
-        notifier.send(:truncate_payload, payload_copy, 6)
-
-        payload_copy[:truncated].should == '123...'
-        payload_copy[:not_truncated].should == '123456'
-        payload_copy[:hash][:inner_truncated].should == '123...'
-        payload_copy[:hash][:inner_not_truncated].should == '567'
-        payload_copy[:hash][:array].should == ['123...', '12', {:inner_inner => '123...'}]
-      end
-
-      it 'should truncate utf8 strings properly' do
-        payload = {
-          :truncated => 'Ŝǻмρļẻ śţяịņģ',
-          :not_truncated => '123456',
-        }
-
-        payload_copy = payload.clone
-        notifier.send(:truncate_payload, payload_copy, 6)
-
-        payload_copy[:truncated].should == "Ŝǻм..."
-        payload_copy[:not_truncated].should == '123456'
-      end
-    end
   end
 
   context 'reporting' do

data/spec/spec_helper.rb

@@ -16,6 +16,7 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 
 RSpec.configure do |config|
   config.include(NotifierHelpers)
+  config.include(FixtureHelpers)
 
   config.color_enabled = true
   config.formatter = 'documentation'
@@ -38,7 +39,7 @@ RSpec.configure do |config|
   end
   config.backtrace_exclusion_patterns = [/gems\/rspec-.*/]
 
-  if ENV['SKIP_DUMMY_ROLLBAR']
+  if ENV['SKIP_DUMMY_ROLLBAR'] == 'true'
     config.filter_run(:skip_dummy_rollbar => true)
   else
     config.filter_run_excluding(:skip_dummy_rollbar => true)

data/spec/support/fixture_helpers.rb

@@ -0,0 +1,27 @@
+module FixtureHelpers
+  def fixture_file(relative_path)
+    root = File.expand_path('../../fixtures', __FILE__)
+    File.join(root, relative_path)
+  end
+
+  def load_payload_fixture(relative_path)
+    MultiJson.load(File.read(fixture_file(relative_path)))
+  end
+
+  def symbolize_recursive(hash)
+    {}.tap do |h|
+      hash.each { |key, value| h[key.to_sym] = map_value(value) }
+    end
+  end
+
+  def map_value(thing)
+    case thing
+    when Hash
+      symbolize_recursive(thing)
+    when Array
+      thing.map { |v| map_value(v) }
+    else
+      thing
+    end
+  end
+end

data/spec/support/shared_contexts.rb

@@ -1,3 +1,12 @@
 shared_context 'reconfigure notifier', :reconfigure_notifier => true do
   before { reconfigure_notifier }
 end
+
+shared_context 'payload from fixture', :fixture => :payload do
+  let(:payload) do
+    {
+      'data' => symbolize_recursive(load_payload_fixture(payload_fixture)),
+      'access_token' => 'the-token'
+    }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollbar
 version: !ruby/object:Gem::Version
-  version: 1.2.10
+  version: 1.2.11
 platform: ruby
 authors:
 - Rollbar, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-24 00:00:00.000000000 Z
+date: 2014-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -219,6 +219,12 @@ files:
 - lib/rollbar/request_data_extractor.rb
 - lib/rollbar/sidekiq.rb
 - lib/rollbar/tasks/rollbar.cap
+- lib/rollbar/truncation.rb
+- lib/rollbar/truncation/frames_strategy.rb
+- lib/rollbar/truncation/min_body_strategy.rb
+- lib/rollbar/truncation/mixin.rb
+- lib/rollbar/truncation/raw_strategy.rb
+- lib/rollbar/truncation/strings_strategy.rb
 - lib/rollbar/util.rb
 - lib/rollbar/version.rb
 - rollbar.gemspec
@@ -275,6 +281,8 @@ files:
 - spec/dummyapp/public/500.html
 - spec/dummyapp/public/favicon.ico
 - spec/dummyapp/script/rails
+- spec/fixtures/payloads/sample.trace.json
+- spec/fixtures/payloads/sample.trace_chain.json
 - spec/generators/rollbar/rollbar_generator_spec.rb
 - spec/requests/home_spec.rb
 - spec/rollbar/configuration_spec.rb
@@ -285,10 +293,15 @@ files:
 - spec/rollbar/logger_proxy_spec.rb
 - spec/rollbar/middleware/rack/builder_spec.rb
 - spec/rollbar/middleware/sinatra_spec.rb
+- spec/rollbar/truncation/frames_strategy_spec.rb
+- spec/rollbar/truncation/min_body_strategy_spec.rb
+- spec/rollbar/truncation/strings_strategy_spec.rb
+- spec/rollbar/truncation_spec.rb
 - spec/rollbar_bc_spec.rb
 - spec/rollbar_spec.rb
 - spec/spec_helper.rb
 - spec/support/cause_exception.rb
+- spec/support/fixture_helpers.rb
 - spec/support/notifier_helpers.rb
 - spec/support/shared_contexts.rb
 homepage: https://github.com/rollbar/rollbar-gem
@@ -369,6 +382,8 @@ test_files:
 - spec/dummyapp/public/500.html
 - spec/dummyapp/public/favicon.ico
 - spec/dummyapp/script/rails
+- spec/fixtures/payloads/sample.trace.json
+- spec/fixtures/payloads/sample.trace_chain.json
 - spec/generators/rollbar/rollbar_generator_spec.rb
 - spec/requests/home_spec.rb
 - spec/rollbar/configuration_spec.rb
@@ -379,9 +394,14 @@ test_files:
 - spec/rollbar/logger_proxy_spec.rb
 - spec/rollbar/middleware/rack/builder_spec.rb
 - spec/rollbar/middleware/sinatra_spec.rb
+- spec/rollbar/truncation/frames_strategy_spec.rb
+- spec/rollbar/truncation/min_body_strategy_spec.rb
+- spec/rollbar/truncation/strings_strategy_spec.rb
+- spec/rollbar/truncation_spec.rb
 - spec/rollbar_bc_spec.rb
 - spec/rollbar_spec.rb
 - spec/spec_helper.rb
 - spec/support/cause_exception.rb
+- spec/support/fixture_helpers.rb
 - spec/support/notifier_helpers.rb
 - spec/support/shared_contexts.rb