raygun4ruby 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b2d4b0893569016193338e74716ee400aa22318
-  data.tar.gz: c95e698b2376c2592dc19b341a3c82ca213d64bd
+  metadata.gz: 38293d7b440b4bfd6832b011cd1e21e35bb6fbf9
+  data.tar.gz: b6f121cd013f4bb492f818a1affc0d4d8e85c42b
 SHA512:
-  metadata.gz: a7ac04cea20753d0e5618af7d8676c8ce48648932de4311d5dc38d311b942f9677e352c3739bb21591b61aeb40859aa1f34af8698a7257a6d27b25a60cba1462
-  data.tar.gz: e1374a86dc5768b89fc10e32548dc6f6beb22b9560b35d9d81b0aee467f53f945cd6c1bc865816fef72fea52db37e2ab64fce8f758b89dced6fb9fd9a53b60b3
+  metadata.gz: 39e682dda4b6aeb589c7cd1dab4f3314f170cabdbbaf83538aab686197237bc8ba3b4618307b12ad9cacc8f3fb5e5dd3e2bf8d0df96ae13849895027eea6c95c
+  data.tar.gz: d35f07722386ed7b3b27827709be074dbd52e1984860689290466af3dcfe19b98487a770db769b717ba17d988bdb868ab178a61c4f560b8b8571a208943a9d5f

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 3.2.0 (21/02/2019):
+Bugfix:
+  - Fix NoMethodError Exception: undefined method `include?' for nil:NilClass in `JavascriptExceptionTracking` class. Thanks @yamanaltereh for this ([#141](https://github.com/MindscapeHQ/raygun4ruby/pull/141))
+  - Fix ([#145](https://github.com/MindscapeHQ/raygun4ruby/issues/145)), "raygun4ruby will load pry if it is in the gem bundle". Thanks to @eoinkelly for reporting this
+
+Feature:
+  - If you have recorded a large number of Breadcrumbs, or just very large ones, Raygun4Ruby will now only send up to 100KB of them instead of all of them, potentially going over the 128KB payload limit Raygun accepts ([#147](https://github.com/MindscapeHQ/raygun4ruby/pull/147))
+
 ## 3.1.1 (16/01/2019):
 Bugfix:
   - Don't attempt to modify response unless JS api key is present
@@ -6,7 +14,7 @@ Bugfix:
 
 ## 3.1.0 (15/01/2019):
 
-Feature:  
+Feature:
     - Ability to automatically configure Raygun4JS on the client side by injecting it into outbound HTML pages. Thanks @MikeRogers0 for this ([#138](https://github.com/MindscapeHQ/raygun4ruby/pull/138))
 
 ## 3.0.0 (18/12/2018):

data/README.md

@@ -19,7 +19,7 @@ Or install it yourself as:
 
 ## Usage
 
-### Rails 3/4
+### Rails 3/4/5
 
 Run:
 
@@ -83,7 +83,7 @@ rescue => e
 end
 ```
 
-You can also pass a Hash as the second parameter to `track_exception`. It should look like a [Rack Env Hash](http://rack.rubyforge.org/doc/SPEC.html)
+You can also pass a Hash as the second parameter to `track_exception`. It should look like a [Rack Env Hash](https://www.rubydoc.info/github/rack/rack/master/file/SPEC)
 
 ### Customizing The Parameter Filtering
 

data/lib/raygun.rb

@@ -6,11 +6,6 @@ require "socket"
 require "rack"
 require "ostruct"
 
-begin
-  require "pry"
-rescue LoadError
-end
-
 require "raygun/version"
 require "raygun/configuration"
 require "raygun/client"
@@ -152,6 +147,8 @@ module Raygun
         env[:custom_data] ||= {}
         env[:custom_data].merge!(original_stacktrace: exception_instance.backtrace)
 
+        ::Raygun::Breadcrumbs::Store.clear
+
         track_exception(new_exception, env, user, retry_count - 1)
       else
         raise e

data/lib/raygun/breadcrumbs/breadcrumb.rb

@@ -25,6 +25,10 @@ module Raygun
           v != nil
         end]
       end
+
+      def size
+        return message.length + 100
+      end
     end
   end
 end

data/lib/raygun/breadcrumbs/store.rb

@@ -47,6 +47,16 @@ module Raygun
         stored != nil && stored.length > 0
       end
 
+      def self.take_until_size(size)
+        breadcrumb_size = 0
+
+        stored.reverse.take_while do |crumb|
+          breadcrumb_size += crumb.size
+
+          breadcrumb_size < size
+        end.reverse
+      end
+
       private
 
       def self.should_record?(crumb)

data/lib/raygun/client.rb

@@ -5,6 +5,7 @@ module Raygun
 
     ENV_IP_ADDRESS_KEYS = %w(action_dispatch.remote_ip raygun.remote_ip REMOTE_ADDR)
     NO_API_KEY_MESSAGE  = "[RAYGUN] Just a note, you've got no API Key configured, which means we can't report exceptions. Specify your Raygun API key using Raygun#setup (find yours at https://app.raygun.io)"
+    MAX_BREADCRUMBS_SIZE = 100_000
 
     include HTTParty
 
@@ -214,7 +215,7 @@ module Raygun
             }
         }
         store = ::Raygun::Breadcrumbs::Store
-        error_details[:breadcrumbs] = store.stored.map(&:build_payload) if store.any?
+        error_details[:breadcrumbs] = store.take_until_size(MAX_BREADCRUMBS_SIZE).map(&:build_payload) if store.any?
 
         Raygun.log('set details and breadcrumbs')
 

data/lib/raygun/middleware/javascript_exception_tracking.rb

@@ -8,7 +8,7 @@ module Raygun::Middleware
       status, headers, response = @app.call(env)
 
       # It's a html file, inject our JS
-      if headers['Content-Type'].include?('text/html')
+      if headers['Content-Type']&.include?('text/html')
         response = inject_javascript_to_response(response)
       end
 

data/lib/raygun/version.rb

@@ -1,3 +1,3 @@
 module Raygun
-  VERSION = "3.1.1"
+  VERSION = "3.2.0"
 end

data/raygun4ruby.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "webmock"
 
   spec.add_development_dependency 'rails', "= 5.2"
-  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'sqlite3', '~> 1.3.6'
   spec.add_development_dependency 'capybara'
   spec.add_development_dependency "rspec-rails"
   spec.add_development_dependency "launchy"

data/spec/raygun/breadcrumbs/breadcrumb_spec.rb

@@ -129,6 +129,43 @@ module Raygun
           expect(payload[:CustomData]).to eq(foo: 'bar')
         end
       end
+
+      describe "#size" do
+        before do
+          Timecop.freeze
+          Store.initialize
+        end
+        after do
+          Timecop.return
+          Store.clear
+        end
+
+        let(:message) { "This is a breadcrumb message" }
+
+        let(:breadcrumb) do
+          Store.record(
+            message: message,
+            category: "test",
+            level: :info,
+            class_name: "HomeController",
+            method_name: "index",
+            line_number: 17,
+            metadata: {
+              foo: 'bar'
+            }
+          )
+
+          Store.stored[0]
+        end
+
+        let(:size) { breadcrumb.size }
+
+        it "returns the estimated size of the breadcrumb" do
+          # Can't check all the fields but message so assume a standard 100 length for all of them
+          # The message should be the bulk of large breadcrumbs anyway
+          expect(size).to eq(message.length + 100)
+        end
+      end
     end
   end
 end

data/spec/raygun/breadcrumbs/store_spec.rb

@@ -67,6 +67,30 @@ module Raygun
         end
       end
 
+      describe "#take_until_size" do
+        before do
+          subject.initialize
+        end
+
+        it "takes the most recent breadcrumbs until the size limit is reached" do
+          subject.record(message: '1' * 100)
+          subject.record(message: '2' * 100)
+          subject.record(message: '3' * 100)
+
+          crumbs = subject.take_until_size(500)
+
+          expect(crumbs.length).to eq(2)
+          expect(crumbs[0].message).to eq('2' * 100)
+          expect(crumbs[1].message).to eq('3' * 100)
+        end
+
+        it "does not crash with no recorded breadcrumbs" do
+          crumbs = subject.take_until_size(500)
+
+          expect(crumbs).to eq([])
+        end
+      end
+
       context "adding a breadcrumb" do
         class Foo
           include ::Raygun::Breadcrumbs

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: raygun4ruby
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Mindscape
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-16 00:00:00.000000000 Z
+date: 2019-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -231,16 +231,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement