rollbar 0.13.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3f1bfea5b0039c34e065755ca4d589cfc5756b8
-  data.tar.gz: 2ccff055b8ca9a5e3d5e95f5ba57874de697acc8
+  metadata.gz: 3f2c782eb71538b4fa602e2e56c56233559858f7
+  data.tar.gz: 6ad6c0a6b66963dc0b0a2bdb0705df9d95e4f468
 SHA512:
-  metadata.gz: f6e7fdacbe2ca39f560f4d616a6282413b6d170c8b8aaeca4f616725d84be8beaf55e2318c994aebf1b74028c42824401da745645c553c2671f60867b37be4d0
-  data.tar.gz: a3ba21e9df754a5f47381a5f83f6aa90e4554ab4720af6e543e15d6124450600825f64e9e0271f2c08e6cf87edc9262373aa88e173a3c8b739ad7247526f58df
+  metadata.gz: fddd828f6ff42f93a0211e4967baf4a99ff1c93f1b5c1ee1a231004627b80c5b18dfbf6684d94a141144e29bebd17e5d9e6d977844506fb62cd7524272e29ebe
+  data.tar.gz: f6820508de41ddc3fcb9ff89bab83da096a6b778d97bdca10297982561f139d6f1c7591d120bb9165a3bcc3601d7ca5f17c89a137cb49f114b00c8c01273f77c

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+**1.0.0**
+- Clean up some unused requires
+- Strip out invalid UTF-8 characters from payload keys/values, fixes [#85](https://github.com/rollbar/rollbar-gem/issues/85)
+- Bumping to 1.0 due to the suggestion in [#119](https://github.com/rollbar/rollbar-gem/issues/119)
+
 **0.13.2**
 - Sidekiq payload is no longer mutated when Rollbar reports a Sidekiq job exception
 - Fix sucker_punch async reporting when using a forking application server such as Unicorn (`preload_app true`). Jobs are now instantiated for every report instead of a reused global job instance

data/lib/rollbar.rb

@@ -1,23 +1,26 @@
 require 'net/https'
-
-require 'securerandom' if defined?(SecureRandom)
 require 'socket'
 require 'thread'
 require 'uri'
-
-require 'girl_friday' if defined?(GirlFriday)
-require 'sucker_punch' if defined?(SuckerPunch)
 require 'multi_json'
 
+begin
+  require 'securerandom'
+rescue LoadError
+end
+
 require 'rollbar/version'
 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)
 
+unless ''.respond_to? :encode
+  require 'iconv'
+end
+
 module Rollbar
   MAX_PAYLOAD_SIZE = 128 * 1024 #128kb
 
@@ -30,7 +33,7 @@ module Rollbar
     def preconfigure
       yield(configuration)
     end
-    
+
     # Configures the gem.
     #
     # Call on app startup to set the `access_token` (required) and other config params.
@@ -47,7 +50,7 @@ module Rollbar
         configuration.enabled = true
       end
       yield(configuration)
-      
+
       require_hooks
     end
 
@@ -252,7 +255,7 @@ module Rollbar
         require 'rollbar/delayed_job'
         Rollbar::Delayed::wrap_worker
       end
-      
+
       require 'rollbar/sidekiq' if defined?(Sidekiq)
       require 'rollbar/goalie' if defined?(Goalie)
       require 'rollbar/rack' if defined?(Rack)
@@ -444,6 +447,9 @@ module Rollbar
         :access_token => configuration.access_token,
         :data => data
       }
+      
+      enforce_valid_utf8(payload)
+      
       result = MultiJson.dump(payload)
 
       # Try to truncate strings in the payload a few times if the payload is too big
@@ -602,6 +608,22 @@ module Rollbar
         log_error "[Rollbar] Error sending failsafe : #{e}"
       end
     end
+    
+    def enforce_valid_utf8(payload)
+      normalizer = Proc.new do |value|
+        if value.is_a?(String)
+          if value.respond_to? :encode
+            value.encode('UTF-8', 'binary', :invalid => :replace, :undef => :replace, :replace => '')
+          else
+            ::Iconv.conv('UTF-8//IGNORE', 'UTF-8', value)
+          end
+        else
+          value
+        end
+      end
+
+      Rollbar::Util::iterate_and_update(payload, normalizer)
+    end
 
     def truncate_payload(payload, byte_threshold)
       truncator = Proc.new do |value|

data/lib/rollbar/railtie.rb

@@ -1,4 +1,4 @@
-require 'rails'
+require 'rails/railtie'
 require 'rollbar'
 
 module Rollbar
@@ -6,7 +6,7 @@ module Rollbar
     rake_tasks do
       require 'rollbar/rake_tasks'
     end
-    
+
     if defined? ActiveRecord
       initializer 'rollbar.middleware.rails' do |app|
         require 'rollbar/middleware/rails/rollbar_request_store'

data/lib/rollbar/util.rb

@@ -12,12 +12,27 @@ module Rollbar
           end
         end
       else
+        key_updates = []
+        
         obj.each do |k, v|
+          new_key = nil
+          
           if v.is_a?(Hash) || v.is_a?(Array)
             self.iterate_and_update(v, block)
+            new_key = block.call(k)
           else
+            new_key = block.call(k)
             obj[k] = block.call(v)
           end
+          
+          if new_key != k
+            key_updates.push([k, new_key])
+          end
+        end
+        
+        key_updates.each do |old_key, new_key|
+          obj[new_key] = obj[old_key]
+          obj.delete(old_key)
         end
       end
     end
@@ -32,4 +47,4 @@ module Rollbar
       str.unpack("U*").slice(0, length - ellipsis.length).pack("U*") + ellipsis
     end
   end
-end
+end

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = "0.13.2"
+  VERSION = "1.0.0"
 end

data/spec/rollbar_spec.rb

@@ -666,6 +666,25 @@ describe Rollbar do
       hash = MultiJson.load(json)
       hash["data"]["foo"]["bar"].should == "baz"
     end
+    
+    it 'should strip out invalid utf-8' do
+      json = Rollbar.send(:build_payload, {
+        :good_key => "\255bad value",
+        "bad\255 key" => "good value",
+        "bad key 2\255" => "bad \255value",
+        :hash => {
+          "bad array \255key" => ["bad\255 array element", "good array element"]
+        }
+      })
+      
+      hash = MultiJson.load(json)
+      hash["data"]["good_key"].should == 'bad value'
+      hash["data"]["bad key"].should == 'good value'
+      hash["data"]["bad key 2"].should == 'bad value'
+      hash["data"]["hash"].should == {
+        "bad array key" => ["bad array element", "good array element"]
+      }
+    end
 
     it 'should truncate large strings if the payload is too big' do
       json = Rollbar.send(:build_payload, {:foo => {:bar => "baz"}, :large => 'a' * (128 * 1024), :small => 'b' * 1024})
@@ -686,6 +705,44 @@ describe Rollbar do
       Rollbar::MAX_PAYLOAD_SIZE = orig_max
     end
   end
+  
+  context 'enforce_valid_utf8' do
+    it 'should replace invalid utf8 values' do
+      payload = {
+        :bad_value => "bad value 1\255",
+        :bad_value_2 => "bad\255 value 2",
+        "bad\255 key" => "good value",
+        :hash => {
+          :inner_bad_value => "\255\255bad value 3",
+          "inner \255bad key" => 'inner good value',
+          "bad array key\255" => [
+            'good array value 1', 
+            "bad\255 array value 1\255",
+            {
+              :inner_inner_bad => "bad inner \255inner value"
+            }
+          ]
+        }
+      }
+
+      payload_copy = payload.clone
+      Rollbar.send(:enforce_valid_utf8, payload_copy)
+      
+      payload_copy[:bad_value].should == "bad value 1"
+      payload_copy[:bad_value_2].should == "bad value 2"
+      payload_copy["bad key"].should == "good value"
+      payload_copy.keys.should_not include("bad\456 key")
+      payload_copy[:hash][:inner_bad_value].should == "bad value 3"
+      payload_copy[:hash]["inner bad key"].should == 'inner good value'
+      payload_copy[:hash]["bad array key"].should == [
+        'good array value 1', 
+        'bad array value 1', 
+        {
+          :inner_inner_bad => 'bad inner inner value'
+        }
+      ]
+    end
+  end
 
   context 'truncate_payload' do
     it 'should truncate all nested strings in the payload' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollbar
 version: !ruby/object:Gem::Version
-  version: 0.13.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Brian Rue
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-09 00:00:00.000000000 Z
+date: 2014-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json