raygun4ruby 3.0.0 → 3.2.3.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 61736f6afdee2839d8085205074cc3e36a0d1ab2
-  data.tar.gz: 91f356594710741eec38c69f2e1122eb7bfdf3e9
+SHA256:
+  metadata.gz: 84452b508afb10629e9422d50d1ad50d50d39fa55b02b6b5f8acb8a4ae90dc5d
+  data.tar.gz: 9467456b70b0f9bade783999435f146547de3620f2921766bc43df4ece319558
 SHA512:
-  metadata.gz: 1c5a29513ec9b6603e798381c89005802a87ac470bcfdb6e77f2287523d880f4db7dc0fe6122254e8f8722aa5e54fb5f418b72702fa1b4a2cb5defc69626556b
-  data.tar.gz: b44748b701d56a4359644c679abe517ef9540049c9a8acd960babbe2614d68d27457ec2563298d625ed4485f6f2d6705ffc512bba0e6e4f36b3ed193b2cf0919
+  metadata.gz: d54eaf8070ed7fe63f3d1fbc65453c036bba550762f28ce7279a055fd692faeb03081c91b2d60f371136df413e97c175bbef143b5f22c8e63a518ed4be5ec515
+  data.tar.gz: c51ab8b3f6e4743d2d95600c5325c485ecad3fce332e87adf61ed93a051939963e8d09f8064fccb126e536ce76c44144057c9012ba6cf97ef67ec4249633fe58

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+spec/dummy/log

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -1,14 +1,20 @@
+language: ruby
+
 before_install:
-  - gem install bundler
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '< 2'
 
 script:
   - bundle exec rake
 
 rvm:
- - 2.0.0
- - 2.2.5
- - 2.3.3
- - 2.4.0
+ - 2.0.0-p648
+ - 2.1.0
+ - 2.2.10
+ - 2.3.8
+ - 2.4.5
+ - 2.5.3
+ - 2.6.1
 
 gemfile:
   - Gemfile

data/CHANGELOG.md

@@ -1,3 +1,29 @@
+## 3.2.2 (10/06/2020):
+  - Introduce support for Raygun APM exceptions correlation ([#154](https://github.com/MindscapeHQ/raygun4ruby/pull/154))
+
+## 3.2.1 (25/02/2019):
+Bugfix:
+  - Remove Ruby 2.3 syntax to retain support for Ruby >= 2.0 ([#148](https://github.com/MindscapeHQ/raygun4ruby/pull/148))
+
+## 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
+  - Don't attempt to modify response unless it responds to indexing ([])
+  - See PR ([#140](https://github.com/MindscapeHQ/raygun4ruby/pull/140))
+
+## 3.1.0 (15/01/2019):
+
+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):
   Breaking changes:
     Parameter filters are now applied if you are using the `filter_payload_with_whitelist` functionality. Previously if this was set to true the parameter filtering was bailed out of ([#136](https://github.com/MindscapeHQ/raygun4ruby/pull/136/files))

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
 
@@ -182,7 +182,7 @@ Raygun.setup do |config|
   config.api_key = "YOUR_RAYGUN_API_KEY"
   config.filter_payload_with_whitelist = true
 
-  config.whitelist_payload_keys do |payload|
+  config.whitelist_payload_shape do |payload|
     # Return the payload mutated into your desired form
     payload
   end

data/Rakefile

@@ -7,7 +7,7 @@ namespace :test do
 
   desc "Test the basics of the adapter"
   Rake::TestTask.new(:units) do |t|
-    t.test_files = FileList["test/unit/*_test.rb", "specs/**/*_spec.rb"]
+    t.test_files = FileList["test/unit/*_test.rb"]
   end
 
   desc "Run a test against the live API"
@@ -15,6 +15,13 @@ namespace :test do
     t.test_files = FileList["test/integration/*_test.rb"]
   end
 
+  begin
+    require 'rspec/core/rake_task'
+
+    RSpec::Core::RakeTask.new(:spec)
+
+  rescue LoadError
+  end
 end
 
-task default: "test:units"
+task default: ["test:units", "test:spec"]

data/lib/raygun.rb

@@ -6,16 +6,13 @@ require "socket"
 require "rack"
 require "ostruct"
 
-begin
-  require "pry"
-rescue LoadError
-end
-
 require "raygun/version"
 require "raygun/configuration"
 require "raygun/client"
+require "raygun/javascript_tracker"
 require "raygun/middleware/rack_exception_interceptor"
 require "raygun/middleware/breadcrumbs_store_initializer"
+require "raygun/middleware/javascript_exception_tracking"
 require "raygun/testable"
 require "raygun/error"
 require "raygun/affected_user"
@@ -150,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
 
@@ -191,6 +192,7 @@ module Raygun
         Raygun.log('set tags')
 
         grouping_key = env.delete(:grouping_key)
+        correlation_id = env.delete(:correlation_id)
 
         configuration_custom_data = Raygun.configuration.custom_data
         configured_custom_data = if configuration_custom_data.is_a?(Proc)
@@ -214,11 +216,12 @@ 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')
 
         error_details.merge!(groupingKey: grouping_key) if grouping_key
+        error_details.merge!(correlationId: correlation_id) if correlation_id
 
         user_details = if affected_user_present?(env)
                          user_information(env)

data/lib/raygun/configuration.rb

@@ -25,6 +25,12 @@ module Raygun
     # Your Raygun API Key - this can be found on your dashboard at Raygun.io
     config_option :api_key
 
+    # Your JS Raygun API Key - Should be different to your api_key, it's best practice to separate your errors between front end and back end.
+    config_option :js_api_key
+
+    # Your JS Raygun API Version, defaults to latest as found on https://raygun.com/raygun-providers/javascript
+    config_option :js_api_version
+
     # Array of exception classes to ignore
     config_option :ignore
 

data/lib/raygun/javascript_tracker.rb

@@ -0,0 +1,42 @@
+# Client for injecting JavaScript code for tracking front end exceptions
+# https://raygun.com/docs/languages/javascript
+module Raygun
+  class JavaScriptTracker
+    def head_html
+      return unless js_api_key?
+      [
+        '<script type="text/javascript">',
+        '!function(a,b,c,d,e,f,g,h){a.RaygunObject=e,a[e]=a[e]||function(){',
+        '(a[e].o=a[e].o||[]).push(arguments)},f=b.createElement(c),g=b.getElementsByTagName(c)[0],',
+        'f.async=1,f.src=d,g.parentNode.insertBefore(f,g),h=a.onerror,a.onerror=function(b,c,d,f,g){',
+        'h&&h(b,c,d,f,g),g||(g=new Error(b)),a[e].q=a[e].q||[],a[e].q.push({',
+        'e:g})}}(window,document,"script","//cdn.raygun.io/raygun4js/' + js_api_version + 'raygun.min.js","rg4js");',
+        '</script>'
+      ].join('').html_safe
+    end
+
+    def body_html
+      return unless js_api_key?
+      [
+        '<script type="text/javascript">',
+        "rg4js('apiKey', '#{js_api_key}');",
+        "rg4js('enableCrashReporting', true);",
+        '</script>'
+      ].join('').html_safe
+    end
+
+    private
+
+    def js_api_key
+      @js_api_key ||= Raygun.configuration.js_api_key
+    end
+
+    def js_api_version
+      @js_api_version ||= Raygun.configuration.js_api_version ? "#{Raygun.configuration.js_api_version}/" : ''
+    end
+
+    def js_api_key?
+      js_api_key.present?
+    end
+  end
+end

data/lib/raygun/middleware/javascript_exception_tracking.rb

@@ -0,0 +1,32 @@
+module Raygun::Middleware
+  class JavascriptExceptionTracking
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      status, headers, response = @app.call(env)
+
+      # It's a html file, inject our JS
+      if headers['Content-Type'] && headers['Content-Type'].include?('text/html')
+        response = inject_javascript_to_response(response)
+      end
+
+      [status, headers, response]
+    end
+
+    def inject_javascript_to_response(response)
+      if Raygun.configuration.js_api_key.present? && response.respond_to?('[]')
+        response[0].gsub!('</head>', "#{js_tracker.head_html}</head>")
+        response[0].gsub!('</body>', "#{js_tracker.body_html}</body>")
+      end
+
+      response
+    end
+
+    private
+    def js_tracker
+      @js_tracker = Raygun::JavaScriptTracker.new
+    end
+  end
+end

data/lib/raygun/railtie.rb

@@ -19,7 +19,8 @@ class Raygun::Railtie < Rails::Railtie
     raygun_middleware = [
       Raygun::Middleware::RailsInsertAffectedUser,
       Raygun::Middleware::RackExceptionInterceptor,
-      Raygun::Middleware::BreadcrumbsStoreInitializer
+      Raygun::Middleware::BreadcrumbsStoreInitializer,
+      Raygun::Middleware::JavascriptExceptionTracking
     ]
     raygun_middleware = raygun_middleware.map(&:to_s) unless Rails::VERSION::STRING >= "5"
     raygun_middleware.each do |m|

data/lib/raygun/sidekiq.rb

@@ -25,6 +25,9 @@ module Raygun
           sidekiq_context: context_hash
         }
       }
+      if correlation_id = exception.instance_variable_get(:@__raygun_correlation_id)
+        data.merge!(correlation_id: correlation_id)
+      end
       ::Raygun.track_exception(
           exception,
           data,

data/lib/raygun/version.rb

@@ -1,3 +1,3 @@
 module Raygun
-  VERSION = "3.0.0"
+  VERSION = "3.2.3.pre"
 end

data/raygun4ruby.gemspec

@@ -26,13 +26,20 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "concurrent-ruby"
 
   spec.add_development_dependency "bundler", ">= 1.1"
-  spec.add_development_dependency "rake", "~> 11"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "timecop"
-  spec.add_development_dependency "minitest", "~> 4.2"
+  spec.add_development_dependency "minitest", "~> 5.11"
   spec.add_development_dependency "redis-namespace", ">= 1.3.1"
   spec.add_development_dependency "resque"
   spec.add_development_dependency "sidekiq", [">= 3", "< 3.2.2"]
   spec.add_development_dependency "mocha"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "webmock"
+
+  spec.add_development_dependency 'rails', "= 4.2.11"
+  spec.add_development_dependency 'sqlite3', '~> 1.3.6'
+  spec.add_development_dependency 'capybara'
+  spec.add_development_dependency "rspec-rails", '~> 3.9'
+  spec.add_development_dependency "launchy"
+  spec.add_development_dependency "simplecov"
 end

data/spec/dummy/.gitignore

@@ -0,0 +1,17 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.bundle
+
+# Ignore the default SQLite database.
+/db/*.sqlite3
+/db/*.sqlite3-journal
+
+# Ignore all logfiles and tempfiles.
+/log/*
+!/log/.keep
+/tmp

data/spec/dummy/Gemfile

@@ -0,0 +1,47 @@
+source 'https://rubygems.org'
+
+
+# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
+gem 'rails', '4.2.11'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3'
+# Use SCSS for stylesheets
+gem 'sass-rails', '~> 5.0'
+# Use Uglifier as compressor for JavaScript assets
+gem 'uglifier', '>= 1.3.0'
+# Use CoffeeScript for .coffee assets and views
+gem 'coffee-rails', '~> 4.1.0'
+# See https://github.com/rails/execjs#readme for more supported runtimes
+# gem 'therubyracer', platforms: :ruby
+
+# Use jquery as the JavaScript library
+gem 'jquery-rails'
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem 'turbolinks'
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem 'jbuilder', '~> 2.0'
+# bundle exec rake doc:rails generates the API under doc/api.
+gem 'sdoc', '~> 0.4.0', group: :doc
+
+# Use ActiveModel has_secure_password
+# gem 'bcrypt', '~> 3.1.7'
+
+# Use Unicorn as the app server
+# gem 'unicorn'
+
+# Use Capistrano for deployment
+# gem 'capistrano-rails', group: :development
+
+group :development, :test do
+  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
+  gem 'byebug'
+end
+
+group :development do
+  # Access an IRB console on exception pages or by using <%= console %> in views
+  gem 'web-console', '~> 2.0'
+
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+end
+