rollbar 0.12.7 → 0.12.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49719df8414ae90f604bc7b140f82c6966d564b2
-  data.tar.gz: 9e06c6c36b98bf02398bcdf4d6268f57fa01d390
+  metadata.gz: e51b5cb888086a9cd992d4c36cfc2fabd83b3635
+  data.tar.gz: 47c5991fb45cd69fe233e0dafc2d6c7c676c4196
 SHA512:
-  metadata.gz: aeb6ea575bd2c8ba206936f76882cf304cffb1822be011f375c302f03b95f261558f792cea8aabcd79a799dce7c42d663b1034b1da39c2c7aee8fa9c03d4e375
-  data.tar.gz: d2848c3268c75a73f1086ff8a8511b5eacb4d5649646fb7fbe1d9b7721efbed8932ae1ff21653e0b8b02aec78bc7e343c2b7d39c41d729adb373a1162062a9b5
+  metadata.gz: 894839031c7728ccd229396aa54d2125f33a0a067b1ce7fd09eb02f603db56a1a4f7f933679e3464bc8140d98c3ec9ee23236f25d8d803a621688b640f09494a
+  data.tar.gz: e64f0af2245fd337b668f1870c440e4c51211d31f301d05ab39bb14ec9eea51ff6bae5a1f0600cd984aef9a85386140b1684c2f909c5e6a7faa57e241e64ec07

data/CHANGELOG.md

@@ -1,10 +1,13 @@
 # Change Log
 
+**0.12.8**
+- Added funcitonality to walk the payload and truncate strings to attempt to reduce size if the payload is too large (more than 32kb total)
+
 **0.12.7**
 - Fix error reporting errors when route controller or action is nil (bug introduced in 0.12.4)
 
 **0.12.6**
-- Added [#78](https://github.com/rollbar/rollbar-gem/pull/78), ability to ignore exceptions from specific persons
+- Added [#78](https://github.com/rollbar/rollbar-gem/pull/78), added configuration option to ignore specific person exceptions
 
 **0.12.5**
 - Fixed SIGSEGV with the delayed_job plugin and Ruby 2.1.0

data/lib/rollbar.rb

@@ -14,10 +14,13 @@ require 'rollbar/configuration'
 require 'rollbar/request_data_extractor'
 require 'rollbar/exception_reporter'
 require 'rollbar/active_record_extension' if defined?(ActiveRecord)
+require 'rollbar/util'
 
 require 'rollbar/railtie' if defined?(Rails)
 
 module Rollbar
+  MAX_PAYLOAD_SIZE = 32 * 1042 #32kb
+  
   class << self
     attr_writer :configuration
     attr_accessor :last_report
@@ -321,6 +324,10 @@ module Rollbar
     end
 
     def schedule_payload(payload)
+      if payload.nil?
+        return
+      end
+      
       log_info '[Rollbar] Scheduling payload'
 
       if configuration.use_async
@@ -345,7 +352,28 @@ module Rollbar
         :access_token => configuration.access_token,
         :data => data
       }
-      MultiJson.dump(payload)
+      result = MultiJson.dump(payload)
+      
+      # Try to truncate strings in the payload a few times if the payload is too big
+      if result.bytesize > MAX_PAYLOAD_SIZE
+        thresholds = [1024, 512, 256]
+        thresholds.each_with_index do |threshold, i|
+          new_payload = payload.clone
+          
+          truncate_payload(new_payload, threshold)
+          
+          result = MultiJson.dump(new_payload)
+          
+          if result.bytesize <= MAX_PAYLOAD_SIZE
+            break
+          elsif i == thresholds.length - 1
+            send_failsafe('Could not send payload due to it being too large after truncating attempts', nil)
+            return
+          end
+        end
+      end
+      
+      result
     end
 
     def base_data(level = 'error')
@@ -380,7 +408,7 @@ module Rollbar
       unless config.custom_data_method.nil?
         data[:custom] = config.custom_data_method.call
       end
-
+      
       data
     end
 
@@ -505,9 +533,19 @@ module Rollbar
         log_error "[Rollbar] Error sending failsafe : #{e}"
       end
     end
-
+    
+    def truncate_payload(payload, byte_threshold)
+      truncator = Proc.new do |value|
+        if value.is_a?(String) and value.bytesize > byte_threshold
+          Rollbar::Util::truncate(value, byte_threshold)
+        else
+          value
+        end
+      end
+      
+      Rollbar::Util::iterate_and_update(payload, truncator)
+    end
   end
-
 end
 
 # Setting Ratchetio as an alias to Rollbar for ratchetio-gem backwards compatibility

data/lib/rollbar/util.rb

@@ -0,0 +1,35 @@
+module Rollbar
+  module Util
+    def self.iterate_and_update(obj, block)
+      if obj.is_a?(Array)
+        for i in 0 ... obj.size
+          value = obj[i]
+          
+          if value.is_a?(Hash) || value.is_a?(Array)
+            self.iterate_and_update(value, block)
+          else
+            obj[i] = block.call(value)
+          end
+        end
+      else
+        obj.each do |k, v|
+          if v.is_a?(Hash) || v.is_a?(Array)
+            self.iterate_and_update(v, block)
+          else
+            obj[k] = block.call(v)
+          end
+        end
+      end
+    end
+    
+    def self.truncate(str, length)
+      ellipsis = '...'
+      
+      if str.length <= length or str.length <= ellipsis.length
+        return str
+      end
+      
+      str.unpack("U*").slice(0, length - ellipsis.length).pack("U*") + ellipsis
+    end
+  end
+end

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = "0.12.7"
+  VERSION = "0.12.8"
 end

data/spec/rollbar_spec.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'logger'
 require 'socket'
 require 'spec_helper'
@@ -603,11 +605,75 @@ describe Rollbar do
   end
 
   context 'build_payload' do
+    before(:each) do
+      configure
+      Rollbar.configure do |config|
+        config.logger = logger_mock
+      end
+    end
+    
+    let(:logger_mock) { double("Rails.logger").as_null_object }
+    
     it 'should build valid json' do
       json = Rollbar.send(:build_payload, {:foo => {:bar => "baz"}})
       hash = MultiJson.load(json)
       hash["data"]["foo"]["bar"].should == "baz"
     end
+    
+    it 'should truncate large strings if the payload is too big' do
+      json = Rollbar.send(:build_payload, {:foo => {:bar => "baz"}, :large => 'a' * (64 * 1024), :small => 'b' * 1024})
+      hash = MultiJson.load(json)
+      hash["data"]["large"].should == '%s...' % ('a' * 1021)
+      hash["data"]["small"].should == 'b' * 1024
+    end
+    
+    it 'should send a failsafe message if the payload cannot be reduced enough' do
+      logger_mock.should_receive(:error).with('[Rollbar] Sending failsafe response due to Could not send payload due to it being too large after truncating attempts.')
+      logger_mock.should_receive(:info).with('[Rollbar] Success')
+      
+      orig_max = Rollbar::MAX_PAYLOAD_SIZE
+      
+      Rollbar::MAX_PAYLOAD_SIZE = 1
+      Rollbar.report_exception(@exception)
+      
+      Rollbar::MAX_PAYLOAD_SIZE = orig_max
+    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
+      Rollbar.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
+      Rollbar.send(:truncate_payload, payload_copy, 6)
+      
+      payload_copy[:truncated].should == "Ŝǻм..."
+      payload_copy[:not_truncated].should == '123456'
+    end
   end
 
   context 'base_data' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollbar
 version: !ruby/object:Gem::Version
-  version: 0.12.7
+  version: 0.12.8
 platform: ruby
 authors:
 - Brian Rue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-13 00:00:00.000000000 Z
+date: 2014-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -167,6 +167,7 @@ files:
 - lib/rollbar/rake_tasks.rb
 - lib/rollbar/request_data_extractor.rb
 - lib/rollbar/sidekiq.rb
+- lib/rollbar/util.rb
 - lib/rollbar/version.rb
 - rollbar.gemspec
 - spec/controllers/home_controller_spec.rb