rollbar 1.2.10 → 1.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8fe0625e1b83ab34a865d3b6a98052126d9229e1
-  data.tar.gz: 8dc7faf2db9193997ceae0b41946a854b4b4ec80
+  metadata.gz: 933cce1a042ee31e447197924df32209b62743df
+  data.tar.gz: 93018fc7e8419165e4b337d43511ea65bcff4637
 SHA512:
-  metadata.gz: df09cf158a09200135d4c3237f76dcf444000f4d3d5f8b32dbf2ebc5e7a836afbc6f04c2ee67fd36d2dc10039887566574f511a51411fb55e277eaee74b38a28
-  data.tar.gz: 37d0a58dae25f5a9f7230a548a2b0c1bc55b8bb7e4e472c86075561681bd963ac2c9d3424300d548928da88e08b78b1a5017e6eba20b5417b7e98201865a7aa9
+  metadata.gz: 0d4548ff4e1c0fafbdf5a4c21a4897345c38ec94ff742f1a80d26cd6efcd0f062151597be620c20d070c4f735820ef11e442fe1bf4d8d39a022dc7b44c71e67b
+  data.tar.gz: 37612d8022dfd5a395b2e663fb111b943be5aac57fb9ba5101059bce7fe72c15294325403439bd34d5f137ba533bc14e532ce6d985c3412e15eba00dbeaba983

data/.travis.yml

@@ -15,6 +15,9 @@ rvm:
   - jruby-19mode
   - jruby-head
   - rbx
+env:
+  - SKIP_DUMMY_ROLLBAR=true
+  - SKIP_DUMMY_ROLLBAR=false
 matrix:
   allow_failures:
     - rvm: ruby-head

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## 1.2.11
+
+New features:
+
+- Improved truncation algorithm, so that more kinds of large payloads will be successfully brought below the 128kb limit and successfully reported. See [#185](https://github.com/rollbar/rollbar-gem/pull/185)
+
+Bug fixes:
+
+- Fix issue where using Rollbar outside of a web process was prone to errors being silently ignored. See [#183](https://github.com/rollbar/rollbar-gem/issues/183)
+
+
 ## 1.2.10
 
 Bug fixes:

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.10)](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.11)](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.10'
+    gem 'rollbar', '~> 1.2.11'
 
 And then execute:
 

data/lib/rollbar.rb

@@ -19,13 +19,13 @@ require 'rollbar/util'
 require 'rollbar/railtie' if defined?(Rails)
 require 'rollbar/delay/girl_friday'
 require 'rollbar/delay/thread'
+require 'rollbar/truncation'
 
 unless ''.respond_to? :encode
   require 'iconv'
 end
 
 module Rollbar
-  MAX_PAYLOAD_SIZE = 128 * 1024 #128kb
   ATTACHMENT_CLASSES = %w[
     ActionDispatch::Http::UploadedFile
     Rack::Multipart::UploadedFile
@@ -599,31 +599,15 @@ module Rollbar
     end
 
     def dump_payload(payload)
-      result = MultiJson.dump(payload)
-
-      # Try to truncate strings in the payload a few times if the payload is too big
-      original_size = result.bytesize
-      if original_size > 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
-            final_size = result.bytesize
-            send_failsafe("Could not send payload due to it being too large after truncating attempts. Original size: #{original_size} Final size: #{final_size}", nil)
-            log_error "[Rollbar] Payload too large to be sent: #{MultiJson.dump(payload)}"
-            return
-          end
-        end
-      end
+      result = Truncation.truncate(payload)
+      return result unless Truncation.truncate?(result)
 
-      result
+      original_size = MultiJson.dump(payload).bytesize
+      final_size = result.bytesize
+      send_failsafe("Could not send payload due to it being too large after truncating attempts. Original size: #{original_size} Final size: #{final_size}", nil)
+      log_error "[Rollbar] Payload too large to be sent: #{MultiJson.dump(payload)}"
+
+      nil
     end
 
     ## Logging
@@ -667,12 +651,16 @@ module Rollbar
       # This monkey patch is always needed in order
       # to use Rollbar.scoped
       require 'rollbar/core_ext/thread'
+
+      reset_notifier!
     end
 
     def reconfigure
       @configuration = Configuration.new
       @configuration.enabled = true
       yield(configuration)
+
+      reset_notifier!
     end
 
     def unconfigure

data/lib/rollbar/truncation.rb

@@ -0,0 +1,30 @@
+require 'rollbar/util'
+require 'rollbar/truncation/mixin'
+require 'rollbar/truncation/raw_strategy'
+require 'rollbar/truncation/frames_strategy'
+require 'rollbar/truncation/strings_strategy'
+require 'rollbar/truncation/min_body_strategy'
+
+module Rollbar
+  module Truncation
+    extend ::Rollbar::Truncation::Mixin
+
+    MAX_PAYLOAD_SIZE = 128 * 1024 # 128kb
+    STRATEGIES = [RawStrategy,
+                  FramesStrategy,
+                  StringsStrategy,
+                  MinBodyStrategy
+                 ]
+
+    def self.truncate(payload)
+      result = nil
+
+      STRATEGIES.each do |strategy|
+        result = strategy.call(payload)
+        break unless truncate?(result)
+      end
+
+      result
+    end
+  end
+end

data/lib/rollbar/truncation/frames_strategy.rb

@@ -0,0 +1,44 @@
+require 'rollbar/truncation/mixin'
+
+module Rollbar
+  module Truncation
+    class FramesStrategy
+      include ::Rollbar::Truncation::Mixin
+
+      def self.call(payload)
+        new.call(payload)
+      end
+
+      def call(payload)
+        new_payload = payload.clone
+        body = new_payload['data'][:body]
+
+        if body[:trace_chain]
+          truncate_trace_chain(body)
+        else
+          truncate_trace(body)
+        end
+
+        dump(new_payload)
+      end
+
+      def truncate_trace(body)
+        trace_data = body[:trace]
+        frames = trace_data[:frames]
+        trace_data[:frames] = select_frames(frames)
+
+        body[:trace][:frames] = select_frames(body[:trace][:frames])
+      end
+
+      def truncate_trace_chain(body)
+        chain = body[:trace_chain]
+
+        body[:trace_chain] = chain.map do |trace_data|
+          frames = trace_data[:frames]
+          trace_data[:frames] = select_frames(frames)
+          trace_data
+        end
+      end
+    end
+  end
+end

data/lib/rollbar/truncation/min_body_strategy.rb

@@ -0,0 +1,37 @@
+require 'rollbar/truncation/mixin'
+
+module Rollbar
+  module Truncation
+    class MinBodyStrategy
+      include ::Rollbar::Truncation::Mixin
+
+      def self.call(payload)
+        new.call(payload)
+      end
+
+      def call(payload)
+        new_payload = payload.clone
+        body = new_payload['data'][:body]
+
+        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])
+        end
+
+
+        dump(new_payload)
+      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
+      end
+    end
+  end
+end

data/lib/rollbar/truncation/mixin.rb

@@ -0,0 +1,21 @@
+require 'multi_json'
+
+module Rollbar
+  module Truncation
+    module Mixin
+      def dump(payload)
+        MultiJson.dump(payload)
+      end
+
+      def truncate?(result)
+        result.bytesize > MAX_PAYLOAD_SIZE
+      end
+
+      def select_frames(frames, range = 150)
+        return frames unless frames.count > range * 2
+
+        frames[0, range] + frames[-range, range]
+      end
+    end
+  end
+end

data/lib/rollbar/truncation/raw_strategy.rb

@@ -0,0 +1,17 @@
+require 'rollbar/truncation/mixin'
+
+module Rollbar
+  module Truncation
+    class RawStrategy
+      include ::Rollbar::Truncation::Mixin
+
+      def self.call(payload)
+        new.call(payload)
+      end
+
+      def call(payload)
+        dump(payload)
+      end
+    end
+  end
+end

data/lib/rollbar/truncation/strings_strategy.rb

@@ -0,0 +1,42 @@
+require 'rollbar/util'
+require 'rollbar/truncation/mixin'
+
+module Rollbar
+  module Truncation
+    class StringsStrategy
+      include ::Rollbar::Truncation::Mixin
+
+      STRING_THRESHOLDS = [1024, 512, 256]
+
+      def self.call(payload)
+        new.call(payload)
+      end
+
+      def call(payload)
+        result = nil
+        new_payload = payload.clone
+
+        STRING_THRESHOLDS.each do |threshold|
+          truncate_proc = truncate_strings_proc(threshold)
+
+          ::Rollbar::Util.iterate_and_update(new_payload, truncate_proc)
+          result = dump(new_payload)
+
+          break unless truncate?(result)
+        end
+
+        result
+      end
+
+      def truncate_strings_proc(threshold)
+        proc do |value|
+          if value.is_a?(String) && value.bytesize > threshold
+            Rollbar::Util.truncate(value, threshold)
+          else
+            value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rollbar/version.rb

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

data/spec/dummyapp/config/initializers/rollbar.rb

@@ -19,4 +19,4 @@ Rollbar.configure do |config|
   # Valid levels: 'critical', 'error', 'warning', 'info', 'debug', 'ignore'
   # 'ignore' will cause the exception to not be reported at all.
   # config.exception_level_filters.merge!('MyCriticalException' => 'critical')
-end unless ENV['SKIP_DUMMY_ROLLBAR']
+end unless ENV['SKIP_DUMMY_ROLLBAR'] == "true"

data/spec/fixtures/payloads/sample.trace.json

@@ -0,0 +1,275 @@
+{
+  "body": {
+    "trace": {
+      "frames": [
+        {
+          "method": "main",
+          "lineno": 832,
+          "filename": "kernel/loader.rb"
+        },
+        {
+          "method": "epilogue",
+          "lineno": 720,
+          "filename": "kernel/loader.rb"
+        },
+        {
+          "method": "run_at_exits",
+          "lineno": 695,
+          "filename": "kernel/loader.rb"
+        },
+        {
+          "method": "call",
+          "lineno": 20,
+          "filename": "kernel/bootstrap/proc.rb"
+        },
+        {
+          "method": "autorun",
+          "lineno": 17,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rspec-core-2.99.2/lib/rspec/core/runner.rb"
+        },
+        {
+          "method": "run",
+          "lineno": 103,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rspec-core-2.99.2/lib/rspec/core/runner.rb"
+        },
+        {
+          "method": "run",
+          "lineno": 21,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rspec-core-2.99.2/lib/rspec/core/command_line.rb"
+        },
+        {
+          "method": "report",
+          "lineno": 58,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rspec-core-2.99.2/lib/rspec/core/reporter.rb"
+        },
+        {
+          "method": "run",
+          "lineno": 24,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rspec-core-2.99.2/lib/rspec/core/command_line.rb"
+        },
+        {
+          "method": "map",
+          "lineno": 97,
+          "filename": "kernel/bootstrap/array.rb"
+        },
+        {
+          "method": "run",
+          "lineno": 24,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rspec-core-2.99.2/lib/rspec/core/command_line.rb"
+        },
+        {
+          "method": "run",
+          "lineno": 497,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rspec-core-2.99.2/lib/rspec/core/example_group.rb"
+        },
+        {
+          "method": "map",
+          "lineno": 97,
+          "filename": "kernel/bootstrap/array.rb"
+        },
+        {
+          "method": "run",
+          "lineno": 497,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rspec-core-2.99.2/lib/rspec/core/example_group.rb"
+        },
+        {
+          "method": "run",
+          "lineno": 496,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rspec-core-2.99.2/lib/rspec/core/example_group.rb"
+        },
+        {
+          "method": "run_examples",
+          "lineno": 511,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rspec-core-2.99.2/lib/rspec/core/example_group.rb"
+        },
+        {
+          "method": "map",
+          "lineno": 97,
+          "filename": "kernel/bootstrap/array.rb"
+        },
+        {
+          "method": "run_examples",
+          "lineno": 515,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rspec-core-2.99.2/lib/rspec/core/example_group.rb"
+        },
+        {
+          "method": "run",
+          "lineno": 113,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rspec-core-2.99.2/lib/rspec/core/example.rb"
+        },
+        {
+          "method": "with_around_each_hooks",
+          "lineno": 248,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rspec-core-2.99.2/lib/rspec/core/example.rb"
+        },
+        {
+          "method": "run",
+          "lineno": 116,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rspec-core-2.99.2/lib/rspec/core/example.rb"
+        },
+        {
+          "method": "instance_eval_with_args",
+          "lineno": 16,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rspec-core-2.99.2/lib/rspec/core/extensions/instance_eval_with_args.rb"
+        },
+        {
+          "method": "instance_exec",
+          "lineno": 101,
+          "filename": "kernel/common/eval.rb"
+        },
+        {
+          "method": "__script__",
+          "lineno": 15,
+          "filename": "/home/travis/build/rollbar/rollbar-gem/spec/requests/home_spec.rb"
+        },
+        {
+          "method": "to",
+          "lineno": 117,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rspec-expectations-2.99.2/lib/rspec/expectations/expectation_target.rb"
+        },
+        {
+          "method": "to",
+          "lineno": 59,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rspec-expectations-2.99.2/lib/rspec/expectations/expectation_target.rb"
+        },
+        {
+          "method": "handle_matcher",
+          "lineno": 24,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rspec-expectations-2.99.2/lib/rspec/expectations/handler.rb"
+        },
+        {
+          "method": "matches?",
+          "lineno": 42,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rspec-expectations-2.99.2/lib/rspec/matchers/built_in/raise_error.rb"
+        },
+        {
+          "method": "call",
+          "lineno": 20,
+          "filename": "kernel/bootstrap/proc.rb"
+        },
+        {
+          "method": "__script__",
+          "lineno": 15,
+          "filename": "/home/travis/build/rollbar/rollbar-gem/spec/requests/home_spec.rb"
+        },
+        {
+          "method": "__script__",
+          "lineno": 333,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/actionpack-3.2.17/lib/action_dispatch/testing/integration.rb"
+        },
+        {
+          "method": "get",
+          "lineno": 33,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/actionpack-3.2.17/lib/action_dispatch/testing/integration.rb"
+        },
+        {
+          "method": "process",
+          "lineno": 299,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/actionpack-3.2.17/lib/action_dispatch/testing/integration.rb"
+        },
+        {
+          "method": "request",
+          "lineno": 122,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rack-test-0.6.2/lib/rack/test.rb"
+        },
+        {
+          "method": "env_for (env_for_with_rollbar)",
+          "lineno": 8,
+          "filename": "/home/travis/build/rollbar/rollbar-gem/lib/rollbar/middleware/rack/test_session.rb"
+        },
+        {
+          "method": "env_for_without_rollbar (env_for)",
+          "lineno": 220,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rack-test-0.6.2/lib/rack/test.rb"
+        },
+        {
+          "method": "set_cookie",
+          "lineno": 24,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rack-test-0.6.2/lib/rack/mock_session.rb"
+        },
+        {
+          "method": "merge",
+          "lineno": 132,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rack-test-0.6.2/lib/rack/test/cookie_jar.rb"
+        },
+        {
+          "method": "each",
+          "lineno": 76,
+          "filename": "kernel/bootstrap/array.rb"
+        },
+        {
+          "method": "merge",
+          "lineno": 133,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rack-test-0.6.2/lib/rack/test/cookie_jar.rb"
+        },
+        {
+          "method": "initialize",
+          "lineno": 21,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rack-test-0.6.2/lib/rack/test/cookie_jar.rb"
+        },
+        {
+          "method": "parse_query",
+          "lineno": 70,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rack-1.4.5/lib/rack/utils.rb"
+        },
+        {
+          "method": "each",
+          "lineno": 76,
+          "filename": "kernel/bootstrap/array.rb"
+        },
+        {
+          "method": "parse_query",
+          "lineno": 72,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rack-1.4.5/lib/rack/utils.rb"
+        },
+        {
+          "method": "map",
+          "lineno": 97,
+          "filename": "kernel/bootstrap/array.rb"
+        },
+        {
+          "method": "call (__yield__)",
+          "lineno": 172,
+          "filename": "kernel/common/proc.rb"
+        },
+        {
+          "method": "call",
+          "lineno": 71,
+          "filename": "kernel/common/method.rb"
+        },
+        {
+          "method": "unescape",
+          "lineno": 41,
+          "filename": "/home/travis/.rvm/gems/rbx/gems/rack-1.4.5/lib/rack/utils.rb"
+        },
+        {
+          "method": "decode_www_form_component",
+          "lineno": 898,
+          "filename": "/home/travis/.rvm/rubies/rbx/gems/gems/rubysl-uri-2.0.0/lib/uri/common.rb"
+        }
+      ],
+      "exception": {
+        "message": "invalid %-encoding (8%B)",
+        "class": "ArgumentError"
+      }
+    }
+  },
+  "uuid": "d9a419d7-7b11-4435-bf5a-ffaa0fa9ff8c",
+  "language": "ruby",
+  "level": "error",
+  "timestamp": 1416877955,
+  "server": {
+    "pid": 3586,
+    "host": "testing-worker-linux-docker-eeafdf0f-2420-linux-9",
+    "root": "/home/travis/build/rollbar/rollbar-gem/spec/dummyapp"
+  },
+  "environment": "unspecified",
+  "framework": "Rails: 3.2.17",
+  "notifier": {
+    "version": "1.2.9",
+    "name": "rollbar-gem"
+  },
+  "metadata": {
+    "customer_timestamp": 1416877955
+  }
+}