rollbar 1.2.11 → 1.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 933cce1a042ee31e447197924df32209b62743df
-  data.tar.gz: 93018fc7e8419165e4b337d43511ea65bcff4637
+  metadata.gz: d7d45f060a4cd05cfc90f7594dea1826eb5d7e0f
+  data.tar.gz: 0c877c9d5dab1ccdade96748f28cf7268e03865c
 SHA512:
-  metadata.gz: 0d4548ff4e1c0fafbdf5a4c21a4897345c38ec94ff742f1a80d26cd6efcd0f062151597be620c20d070c4f735820ef11e442fe1bf4d8d39a022dc7b44c71e67b
-  data.tar.gz: 37612d8022dfd5a395b2e663fb111b943be5aac57fb9ba5101059bce7fe72c15294325403439bd34d5f137ba533bc14e532ce6d985c3412e15eba00dbeaba983
+  metadata.gz: 3b87159bca2a58f15dbb5550d7861b5a80209cb2ce62b624559e3a6f7ff768110fec7e9a379ad9e7943dfcc9af3910cafb1ce49a32eca101f1b7295544fbe036
+  data.tar.gz: e3050f14f5a86a5773368cb424762c05e930a125da0d35fe92535553261a649acb7118250b48711fad800453a9c6380dc6fb5be6ba4b7099af8b10b967b9e4c8

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## 1.2.12
+
+Bug fixes:
+
+- Fix bug introduced in 1.2.11 that broke the sidekiq async handler. See [#190](https://github.com/rollbar/rollbar-gem/issues/190)
+- Skip Rake monkeypatch for Rake < 0.9.0. Fixes [#187](https://github.com/rollbar/rollbar-gem/issues/187)
+
+
 ## 1.2.11
 
 New features:

data/README.md

@@ -1,4 +1,4 @@
-# Rollbar notifier for Ruby [![Build Status](https://api.travis-ci.org/rollbar/rollbar-gem.svg?branch=v1.2.11)](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.2.12)](https://travis-ci.org/rollbar/rollbar-gem/branches)
 
 <!-- RemoveNext -->
 Ruby gem for reporting exceptions, errors, and log messages to [Rollbar](https://rollbar.com).
@@ -9,7 +9,7 @@ Ruby gem for reporting exceptions, errors, and log messages to [Rollbar](https:/
 
 Add this line to your application's Gemfile:
 
-    gem 'rollbar', '~> 1.2.11'
+    gem 'rollbar', '~> 1.2.12'
 
 And then execute:
 

data/THANKS.md

@@ -14,12 +14,14 @@ Huge thanks to the following contributors (by github username). For the most up-
 - [dlackty](https://github.com/dlackty)
 - [fab](https://github.com/fab)
 - [firstbanco](https://github.com/firstbanco)
+- [flomotlik](https://github.com/flomotlik)
 - [Florent2](https://github.com/Florent2)
 - [gersmann](https://github.com/gersmann)
 - [grosser](https://github.com/grosser)
 - [ixti](https://github.com/ixti)
 - [jeremyvdw](https://github.com/jeremyvdw)
 - [johnknott](https://github.com/johnknott)
+- [jonah-williams](https://github.com/jonah-williams)
 - [jondeandres](https://github.com/jondeandres)
 - [JoshuaOSHickman](https://github.com/JoshuaOSHickman)
 - [juggler](https://github.com/juggler)

data/lib/rollbar/rake.rb

@@ -1,12 +1,38 @@
 require 'rake'
 
-module Rake
-  class Application
-    alias_method :orig_display_error_message, :display_error_message
+module Rollbar
+  module Rake
+    def self.patch!
+      skip_patch && return unless patch?
 
-    def display_error_message(ex)
-      Rollbar.error(ex)
-      orig_display_error_message(ex)
+      ::Rake::Application.class_eval do
+        alias_method :orig_display_error_message, :display_error_message
+
+        def display_error_message(ex)
+          Rollbar.error(ex)
+          orig_display_error_message(ex)
+        end
+      end
+    end
+
+    def self.skip_patch
+      warn('[Rollbar] Rollbar is disabled for Rake tasks since your Rake version is under 0.9.x. Please upgrade to 0.9.x or higher.')
+    end
+
+    def self.patch?
+      major, minor, *_ = rake_version.split('.').map(&:to_i)
+
+      major > 0 || major == 0 && minor > 8
+    end
+
+    def self.rake_version
+      if Object.const_defined?('RAKEVERSION')
+        return RAKEVERSION
+      elsif Rake.const_defined?('VERSION')
+        return Rake::VERSION
+      end
     end
   end
 end
+
+Rollbar::Rake.patch!

data/lib/rollbar/truncation/frames_strategy.rb

@@ -11,9 +11,9 @@ module Rollbar
 
       def call(payload)
         new_payload = payload.clone
-        body = new_payload['data'][:body]
+        body = new_payload['data']['body']
 
-        if body[:trace_chain]
+        if body['trace_chain']
           truncate_trace_chain(body)
         else
           truncate_trace(body)
@@ -23,19 +23,19 @@ module Rollbar
       end
 
       def truncate_trace(body)
-        trace_data = body[:trace]
-        frames = trace_data[:frames]
-        trace_data[:frames] = select_frames(frames)
+        trace_data = body['trace']
+        frames = trace_data['frames']
+        trace_data['frames'] = select_frames(frames)
 
-        body[:trace][:frames] = select_frames(body[:trace][:frames])
+        body['trace']['frames'] = select_frames(body['trace']['frames'])
       end
 
       def truncate_trace_chain(body)
-        chain = body[:trace_chain]
+        chain = body['trace_chain']
 
-        body[:trace_chain] = chain.map do |trace_data|
-          frames = trace_data[:frames]
-          trace_data[:frames] = select_frames(frames)
+        body['trace_chain'] = chain.map do |trace_data|
+          frames = trace_data['frames']
+          trace_data['frames'] = select_frames(frames)
           trace_data
         end
       end

data/lib/rollbar/truncation/min_body_strategy.rb

@@ -11,14 +11,14 @@ module Rollbar
 
       def call(payload)
         new_payload = payload.clone
-        body = new_payload['data'][:body]
+        body = new_payload['data']['body']
 
-        if body[:trace_chain]
-          body[:trace_chain] = body[:trace_chain].map do |trace_data|
+        if body['trace_chain']
+          body['trace_chain'] = body['trace_chain'].map do |trace_data|
             truncate_trace_data(trace_data)
           end
         else
-          body[:trace] = truncate_trace_data(body[:trace])
+          body['trace'] = truncate_trace_data(body['trace'])
         end
 
 
@@ -26,9 +26,9 @@ module Rollbar
       end
 
       def truncate_trace_data(trace_data)
-        trace_data[:exception].delete(:description)
-        trace_data[:exception][:message] = trace_data[:exception][:message][0, 255]
-        trace_data[:frames] = select_frames(trace_data[:frames], 1)
+        trace_data['exception'].delete('description')
+        trace_data['exception']['message'] = trace_data['exception']['message'][0, 255]
+        trace_data['frames'] = select_frames(trace_data['frames'], 1)
 
         trace_data
       end

data/lib/rollbar/util/hash.rb

@@ -0,0 +1,24 @@
+module Rollbar
+  module Util
+    module Hash
+      def self.deep_stringify_keys(hash)
+        hash.reduce({}) do |h, (key, value)|
+          h[key.to_s] = map_value(value, :deep_stringify_keys)
+
+          h
+        end
+      end
+
+      def self.map_value(thing, m)
+        case thing
+        when ::Hash
+          send(m, thing)
+        when Array
+          thing.map { |v| map_value(v, m) }
+        else
+          thing
+        end
+      end
+    end
+  end
+end

data/lib/rollbar/util.rb

@@ -4,8 +4,8 @@ module Rollbar
       if obj.is_a?(Array)
         for i in 0 ... obj.size
           value = obj[i]
-          
-          if value.is_a?(Hash) || value.is_a?(Array)
+
+          if value.is_a?(::Hash) || value.is_a?(Array)
             self.iterate_and_update(value, block)
           else
             obj[i] = block.call(value)
@@ -13,42 +13,42 @@ module Rollbar
         end
       else
         key_updates = []
-        
+
         obj.each do |k, v|
           new_key = nil
-          
-          if v.is_a?(Hash) || v.is_a?(Array)
+
+          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
-    
+
     def self.iterate_and_update_hash(hash, block)
       hash.each do |k, v|
-        if v.is_a?(Hash)
+        if v.is_a?(::Hash)
           self.iterate_and_update_hash(v, block)
         else
           hash[k] = block.call(k, v)
         end
       end
     end
-    
+
     def self.deep_copy(obj)
-      if obj.is_a?(Hash)
+      if obj.is_a?(::Hash)
         result = obj.clone
         obj.each {|k, v| result[k] = deep_copy(v)}
         result
@@ -61,10 +61,10 @@ module Rollbar
         obj
       end
     end
-    
+
     def self.deep_merge(hash1, hash2)
       hash2.each_key do |k|
-        if hash1[k].is_a? Hash and hash2[k].is_a? Hash
+        if hash1[k].is_a? ::Hash and hash2[k].is_a? ::Hash
           hash1[k] = deep_merge(hash1[k], hash2[k])
         elsif hash1[k].is_a? Array and hash2[k].is_a? Array
           hash1[k] += deep_copy(hash2[k])
@@ -72,17 +72,17 @@ module Rollbar
           hash1[k] = deep_copy(hash2[k])
         end
       end
-      
+
       hash1
     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

data/lib/rollbar/version.rb

@@ -1,3 +1,3 @@
 module Rollbar
-  VERSION = "1.2.11"
+  VERSION = "1.2.12"
 end

data/lib/rollbar.rb

@@ -599,7 +599,10 @@ module Rollbar
     end
 
     def dump_payload(payload)
-      result = Truncation.truncate(payload)
+      # Ensure all keys are strings since we can receive the payload inline or
+      # from an async handler job, which can be serialized.
+      stringified_payload = Rollbar::Util::Hash.deep_stringify_keys(payload)
+      result = Truncation.truncate(stringified_payload)
       return result unless Truncation.truncate?(result)
 
       original_size = MultiJson.dump(payload).bytesize

data/rollbar.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'sinatra'
   gem.add_development_dependency 'resque'
   gem.add_development_dependency 'delayed_job'
+  gem.add_development_dependency 'rake', '>= 0.9.0'
 end

data/spec/rollbar/rake_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'rollbar/rake'
+
+describe Rollbar::Rake do
+  let(:application) { Rake::Application.new }
+  let(:exception) { Exception.new }
+
+  context 'with supported rake version' do
+    before do
+      allow(Rollbar::Rake).to receive(:rake_version).and_return('0.9.0')
+    end
+
+    it 'reports error to Rollbar' do
+      expect(Rollbar::Rake).not_to receive(:skip_patch)
+      expect(Rollbar).to receive(:error).with(exception)
+      expect(application).to receive(:orig_display_error_message).with(exception)
+
+      Rollbar::Rake.patch! # Really here Rake is already patched
+      application.display_error_message(exception)
+    end
+  end
+
+  context 'with unsupported rake version' do
+    before do
+      allow(Rollbar::Rake).to receive(:rake_version).and_return('0.8.7')
+    end
+
+    it 'reports error to Rollbar' do
+      expect(Rollbar::Rake).to receive(:skip_patch)
+
+      Rollbar::Rake.patch!
+    end
+  end
+end

data/spec/rollbar/truncation/frames_strategy_spec.rb

@@ -9,16 +9,16 @@ describe Rollbar::Truncation::FramesStrategy do
   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 }
+      let(:frames) { payload['data']['body']['trace']['frames'].clone }
 
       before do
-        payload['data'][:body][:trace][:frames] = expand_frames(frames)
+        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)))
+        result = MultiJson.load(described_class.call(payload))
 
-        new_frames = result[:data][:body][:trace][:frames]
+        new_frames = result['data']['body']['trace']['frames']
 
         expect(new_frames.count).to be_eql(300)
         expect(new_frames.first).to be_eql(frames.first)
@@ -29,19 +29,19 @@ describe Rollbar::Truncation::FramesStrategy do
     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 }
+      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)
+        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)))
+        result = MultiJson.load(described_class.call(payload))
 
-        new_frames1 = result[:data][:body][:trace_chain][0][:frames]
-        new_frames2 = result[:data][:body][:trace_chain][1][:frames]
+        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)

data/spec/rollbar/truncation/min_body_strategy_spec.rb

@@ -7,40 +7,40 @@ describe Rollbar::Truncation::MinBodyStrategy do
 
     context 'with trace key ' do
       let(:payload_fixture) { 'payloads/sample.trace.json' }
-      let!(:frames) { payload['data'][:body][:trace][:frames].clone }
+      let!(:frames) { payload['data']['body']['trace']['frames'].clone }
 
       before do
-        payload['data'][:body][:trace][:exception][:message] = message
+        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)))
+        result = 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)
+        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 }
+      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
+        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)))
+        result = 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)
+        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)
+        expect(traces[1]['frames']).to have(2).items
+        expect(traces[1]['exception']['message']).to be_eql('a' * 255)
       end
     end
   end

data/spec/rollbar/truncation/strings_strategy_spec.rb

@@ -8,36 +8,36 @@ describe Rollbar::Truncation::StringsStrategy 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 }]
+        '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)))
+      result = 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)
+      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',
+          '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}/)
+        result = MultiJson.load(described_class.call(payload))
+        expect(result['truncated']).to match(/^Ŝǻмρļẻ śţяịņģa*\.{3}/)
       end
     end
 

data/spec/rollbar/util/hash_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'rollbar/util/hash'
+
+describe Rollbar::Util::Hash do
+  let(:value) do
+    {
+      :foo => 'bar',
+      :bar => {
+        :foo => 'bar',
+        :bar => [{:foo => 'bar'}]
+      },
+    }
+  end
+
+  it 'converts the symbol keys to string' do
+    new_hash = described_class.deep_stringify_keys(value)
+
+    expect(new_hash['foo']).to be_eql('bar')
+    expect(new_hash['bar']['foo']).to be_eql('bar')
+    expect(new_hash['bar']['bar'][0]['foo']).to be_eql('bar')
+  end
+end

data/spec/support/fixture_helpers.rb

@@ -7,21 +7,4 @@ module FixtureHelpers
   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

@@ -5,7 +5,7 @@ end
 shared_context 'payload from fixture', :fixture => :payload do
   let(:payload) do
     {
-      'data' => symbolize_recursive(load_payload_fixture(payload_fixture)),
+      'data' => load_payload_fixture(payload_fixture),
       'access_token' => 'the-token'
     }
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rollbar
 version: !ruby/object:Gem::Version
-  version: 1.2.11
+  version: 1.2.12
 platform: ruby
 authors:
 - Rollbar, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-02 00:00:00.000000000 Z
+date: 2014-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -164,6 +164,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 description: Rails plugin to catch and send exceptions to Rollbar
 email:
 - support@rollbar.com
@@ -226,6 +240,7 @@ files:
 - lib/rollbar/truncation/raw_strategy.rb
 - lib/rollbar/truncation/strings_strategy.rb
 - lib/rollbar/util.rb
+- lib/rollbar/util/hash.rb
 - lib/rollbar/version.rb
 - rollbar.gemspec
 - spec/controllers/home_controller_spec.rb
@@ -293,10 +308,12 @@ files:
 - spec/rollbar/logger_proxy_spec.rb
 - spec/rollbar/middleware/rack/builder_spec.rb
 - spec/rollbar/middleware/sinatra_spec.rb
+- spec/rollbar/rake_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/util/hash_spec.rb
 - spec/rollbar_bc_spec.rb
 - spec/rollbar_spec.rb
 - spec/spec_helper.rb
@@ -394,10 +411,12 @@ test_files:
 - spec/rollbar/logger_proxy_spec.rb
 - spec/rollbar/middleware/rack/builder_spec.rb
 - spec/rollbar/middleware/sinatra_spec.rb
+- spec/rollbar/rake_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/util/hash_spec.rb
 - spec/rollbar_bc_spec.rb
 - spec/rollbar_spec.rb
 - spec/spec_helper.rb