raygun4ruby 3.2.6 → 4.0.1

data/lib/raygun.rb

@@ -1,179 +1,197 @@
-require "concurrent"
-require "httparty"
-require "logger"
-require "json"
-require "socket"
-require "rack"
-require "ostruct"
-
-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/demo_exception"
-require "raygun/error"
-require "raygun/affected_user"
-require "raygun/services/apply_whitelist_filter_to_payload"
-require "raygun/breadcrumbs/breadcrumb"
-require "raygun/breadcrumbs/store"
-require "raygun/breadcrumbs"
-require "raygun/railtie" if defined?(Rails)
-
-module Raygun
-
-  # used to identify ourselves to Raygun
-  CLIENT_URL  = "https://github.com/MindscapeHQ/raygun4ruby"
-  CLIENT_NAME = "Raygun4Ruby Gem"
-
-  class << self
-    include DemoException
-
-    # Configuration Object (instance of Raygun::Configuration)
-    attr_writer :configuration
-
-    def setup
-      yield(configuration)
-
-      log("configuration settings: #{configuration.inspect}")
-    end
-
-    def configuration
-      @configuration ||= Configuration.new
-    end
-
-    def default_configuration
-      configuration.defaults
-    end
-
-    def reset_configuration
-      @configuration = Configuration.new
-    end
-
-    def configured?
-      !!configuration.api_key
-    end
-
-    def track_exception(exception_instance, env = {}, user = nil, retry_count = 1)
-      log('tracking exception')
-
-      if configuration.send_in_background
-        track_exception_async(exception_instance, env, user, retry_count)
-      else
-        track_exception_sync(exception_instance, env, user, retry_count)
-      end
-    end
-
-    def track_exceptions
-      yield
-    rescue => e
-      track_exception(e)
-    end
-
-    def record_breadcrumb(
-        message: nil,
-        category: '',
-        level: :info,
-        timestamp: Time.now.utc,
-        metadata: {},
-        class_name: nil,
-        method_name: nil,
-        line_number: nil
-    )
-      log('recording breadcrumb')
-
-      Raygun::Breadcrumbs::Store.record(
-        message: message,
-        category: category,
-        level: level,
-        timestamp: timestamp,
-        metadata: metadata,
-        class_name: class_name,
-        method_name: method_name,
-        line_number: line_number,
-      )
-    end
-
-    def log(message)
-      return unless configuration.debug
-
-      configuration.logger.info("[Raygun] #{message}") if configuration.logger
-    end
-
-    def failsafe_log(message)
-      configuration.failsafe_logger.info(message)
-    end
-
-    def deprecation_warning(message)
-      if defined?(ActiveSupport::Deprecation)
-        ActiveSupport::Deprecation.warn(message)
-      else
-        puts message
-      end
-    end
-
-    private
-
-    def track_exception_async(*args)
-      future = Concurrent::Future.execute { track_exception_sync(*args) }
-      future.add_observer(lambda do |_, value, reason|
-        if value == nil || !value.responds_to?(:response) || value.response.code != "202"
-          log("unexpected response from Raygun, could indicate error: #{value.inspect}")
-        end
-      end, :call)
-    end
-
-    def track_exception_sync(exception_instance, env, user, retry_count)
-      if should_report?(exception_instance)
-        log('attempting to send exception')
-        resp = Client.new.track_exception(exception_instance, env, user)
-        log('sent payload to api')
-
-        resp
-      end
-    rescue Exception => e
-      log('error sending exception to raygun, see failsafe logger for more information')
-
-      if configuration.failsafe_logger
-        failsafe_log("Problem reporting exception to Raygun: #{e.class}: #{e.message}\n\n#{e.backtrace.join("\n")}")
-      end
-
-      if retry_count > 0
-        new_exception = e.exception("raygun4ruby encountered an exception processing your exception")
-        new_exception.set_backtrace(e.backtrace)
-
-        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
-      end
-    end
-
-
-    def print_api_key_warning
-      $stderr.puts(NO_API_KEY_MESSAGE)
-    end
-
-    def should_report?(exception)
-      if configuration.silence_reporting
-        log('skipping reporting because Configuration.silence_reporting is enabled')
-
-        return false
-      end
-
-      if configuration.ignore.flatten.include?(exception.class.to_s)
-        log("skipping reporting of exception #{exception.class} because it is in the ignore list")
-
-        return false
-      end
-
-      true
-    end
-  end
-end
+require "concurrent"
+require "httparty"
+require "logger"
+require "json"
+require "socket"
+require "rack"
+require "ostruct"
+
+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/demo_exception"
+require "raygun/error_subscriber"
+require "raygun/error"
+require "raygun/affected_user"
+require "raygun/services/apply_whitelist_filter_to_payload"
+require "raygun/breadcrumbs/breadcrumb"
+require "raygun/breadcrumbs/store"
+require "raygun/breadcrumbs"
+require "raygun/railtie" if defined?(Rails)
+
+module Raygun
+
+  # used to identify ourselves to Raygun
+  CLIENT_URL  = "https://github.com/MindscapeHQ/raygun4ruby"
+  CLIENT_NAME = "Raygun4Ruby Gem"
+
+  class << self
+    include DemoException
+
+    # Configuration Object (instance of Raygun::Configuration)
+    attr_writer :configuration
+
+    # List of futures that are currently running
+    @@active_futures = []
+
+    def setup
+      yield(configuration)
+
+      log("configuration settings: #{configuration.inspect}")
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def default_configuration
+      configuration.defaults
+    end
+
+    def reset_configuration
+      @configuration = Configuration.new
+    end
+
+    def configured?
+      !!configuration.api_key
+    end
+
+    def track_exception(exception_instance, env = {}, user = nil, retry_count = 1)
+      log('tracking exception')
+      
+      exception_instance.set_backtrace(caller) if exception_instance.is_a?(Exception) && exception_instance.backtrace.nil?
+
+      result = if configuration.send_in_background
+        track_exception_async(exception_instance, env, user, retry_count)
+      else
+        track_exception_sync(exception_instance, env, user, retry_count)
+      end
+
+      result
+    end
+
+    def track_exceptions
+      yield
+    rescue => e
+      track_exception(e)
+    end
+
+    def record_breadcrumb(
+        message: nil,
+        category: '',
+        level: :info,
+        timestamp: Time.now.utc,
+        metadata: {},
+        class_name: nil,
+        method_name: nil,
+        line_number: nil
+    )
+      log('recording breadcrumb')
+
+      Raygun::Breadcrumbs::Store.record(
+        message: message,
+        category: category,
+        level: level,
+        timestamp: timestamp,
+        metadata: metadata,
+        class_name: class_name,
+        method_name: method_name,
+        line_number: line_number,
+      )
+    end
+
+    def log(message)
+      return unless configuration.debug
+
+      configuration.logger.info("[Raygun] #{message}") if configuration.logger
+    end
+
+    def failsafe_log(message)
+      configuration.failsafe_logger.info(message)
+    end
+
+    def deprecation_warning(message)
+      if defined?(ActiveSupport::Deprecation)
+        ActiveSupport::Deprecation.warn(message)
+      else
+        puts message
+      end
+    end
+
+    def wait_for_futures
+      @@active_futures.each(&:value)
+    end
+
+    private
+
+    def track_exception_async(exception_instance, env, user, retry_count)
+      env[:rg_breadcrumb_store] = Raygun::Breadcrumbs::Store.take_until_size(Client::MAX_BREADCRUMBS_SIZE) if Raygun::Breadcrumbs::Store.any?
+
+      future = Concurrent::Future.execute { track_exception_sync(exception_instance, env, user, retry_count) }
+      future.add_observer(lambda do |_, value, reason|
+        if value == nil || !value.responds_to?(:response) || value.response.code != "202"
+          log("unexpected response from Raygun, could indicate error: #{value.inspect}")
+        end
+        @@active_futures.delete(future)
+      end, :call)
+      @@active_futures << future
+
+      future
+    end
+
+    def track_exception_sync(exception_instance, env, user, retry_count)
+      if should_report?(exception_instance)
+        log('attempting to send exception')
+        resp = Client.new.track_exception(exception_instance, env, user)
+        log('sent payload to api')
+
+        resp
+      end
+    rescue Exception => e
+      log('error sending exception to raygun, see failsafe logger for more information')
+
+      if configuration.failsafe_logger
+        failsafe_log("Problem reporting exception to Raygun: #{e.class}: #{e.message}\n\n#{e.backtrace.join("\n")}")
+      end
+
+      if retry_count > 0
+        new_exception = e.exception("raygun4ruby encountered an exception processing your exception")
+        new_exception.set_backtrace(e.backtrace)
+
+        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
+      end
+    end
+
+
+    def print_api_key_warning
+      $stderr.puts(NO_API_KEY_MESSAGE)
+    end
+
+    def should_report?(exception)
+      if configuration.silence_reporting
+        log('skipping reporting because Configuration.silence_reporting is enabled')
+
+        return false
+      end
+
+      if configuration.ignore.flatten.include?(exception.class.to_s)
+        log("skipping reporting of exception #{exception.class} because it is in the ignore list")
+
+        return false
+      end
+
+      true
+    end
+  end
+end

data/lib/raygun4ruby.rb

@@ -1 +1 @@
-require "raygun"
+require "raygun"

data/lib/resque/failure/raygun.rb

@@ -1,26 +1,26 @@
-begin
-  require 'resque'
-rescue LoadError
-  raise "Can't find 'resque' gem. You'll need to require it before you require the Raygun Failure handler"
-end
-
-module Resque
-  module Failure
-    class Raygun < Base
-
-      def save
-        ::Raygun.track_exception(exception,
-          custom_data: {
-            resque: {
-              worker: worker.to_s,
-              queue:  queue.to_s,
-              job:    payload['class'].to_s,
-              args:   payload['args'].inspect
-            }
-          }
-        )
-      end
-
-    end
-  end
+begin
+  require 'resque'
+rescue LoadError
+  raise "Can't find 'resque' gem. You'll need to require it before you require the Raygun Failure handler"
+end
+
+module Resque
+  module Failure
+    class Raygun < Base
+
+      def save
+        ::Raygun.track_exception(exception,
+          custom_data: {
+            resque: {
+              worker: worker.to_s,
+              queue:  queue.to_s,
+              job:    payload['class'].to_s,
+              args:   payload['args'].inspect
+            }
+          }
+        )
+      end
+
+    end
+  end
 end

data/lib/tasks/raygun.tasks

@@ -1,8 +1,8 @@
-namespace :raygun do
-
-  desc "Test Raygun integration"
-  task :test => :environment do
-    Raygun.track_test_exception
-  end
-
+namespace :raygun do
+
+  desc "Test Raygun integration"
+  task :test => :environment do
+    Raygun.track_test_exception
+  end
+
 end

data/raygun4ruby.gemspec

@@ -1,45 +1,43 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'raygun/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "raygun4ruby"
-  spec.version       = Raygun::VERSION
-  spec.authors       = ["Mindscape", "Nik Wakelin"]
-  spec.email         = ["hello@raygun.com"]
-  spec.description   = %q{Ruby Adapter for Raygun}
-  spec.summary       = %q{This gem provides support for Ruby and Ruby on Rails for the Raygun error reporter}
-  spec.homepage      = "https://raygun.com"
-  spec.license       = "MIT"
-  spec.required_ruby_version = '>= 2.0'
-
-  spec.files         = `git ls-files | grep -Ev '^(test)'`.split("\n")
-  spec.test_files    = `git ls-files -- test/*`.split("\n")
-
-  spec.executables   = []
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "httparty", "> 0.13.7"
-  spec.add_runtime_dependency "json"
-  spec.add_runtime_dependency "rack"
-  spec.add_runtime_dependency "concurrent-ruby"
-
-  spec.add_development_dependency "bundler", ">= 1.1"
-  spec.add_development_dependency "rake", ">= 12.3.3"
-  spec.add_development_dependency "timecop"
-  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
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "raygun/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "raygun4ruby"
+  spec.version       = Raygun::VERSION
+  spec.authors       = ["Mindscape", "Nik Wakelin"]
+  spec.email         = ["hello@raygun.com"]
+  spec.description   = %q{Ruby Adapter for Raygun}
+  spec.summary       = %q{This gem provides support for Ruby and Ruby on Rails for the Raygun.com error reporter}
+  spec.homepage      = "https://raygun.com"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.0"
+
+  spec.files         = `git ls-files | grep -Ev "^(test)"`.split("\n")
+  spec.test_files    = `git ls-files -- test/*`.split("\n")
+
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "httparty", "> 0.13.7"
+  spec.add_runtime_dependency "json"
+  spec.add_runtime_dependency "rack"
+  spec.add_runtime_dependency "concurrent-ruby"
+
+  spec.add_development_dependency "bundler", ">= 2.3"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "timecop"
+  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 "mocha"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
+
+  spec.add_development_dependency "capybara"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "launchy"
+  spec.add_development_dependency "simplecov"
+end

data/spec/features/javascript_spec.rb

@@ -1,48 +1,48 @@
-require 'rails_helper'
-
-feature 'JavaScript Tracking', feature: true do
-  before { Raygun.configuration.js_api_key = nil }
-  after { Raygun.configuration.js_api_key = nil }
-
-  it "Includes the Raygun Javascript Middleware" do
-    expect(Rails.application.config.middleware).to include(Raygun::Middleware::JavascriptExceptionTracking)
-  end
-
-  it "Does not inject the JS snippet" do
-    visit root_path
-
-    expect(page.html).to_not include('cdn.raygun.io/raygun4js/raygun.min.js')
-    expect(page.html).to_not include('rg4js(')
-  end
-
-  context 'With a JS API Key' do
-    before { Raygun.configuration.js_api_key = 'Sample key' }
-
-    it "Injects the JS snippet" do
-      visit root_path
-
-      expect(page.html).to include('cdn.raygun.io/raygun4js/raygun.min.js')
-      expect(page.html).to include('rg4js(')
-    end
-
-    it "Does not inject the JS snippet" do
-      visit root_path(format: :json)
-
-      expect(page.html).to_not include('cdn.raygun.io/raygun4js/raygun.min.js')
-      expect(page.html).to_not include('rg4js(')
-    end
-  end
-
-  context "With JS version overriden" do
-    before do
-      Raygun.configuration.js_api_version = "2.14.1"
-      Raygun.configuration.js_api_key = "Sample key"
-    end
-
-    it "Uses the overriden version" do
-      visit root_path
-
-      expect(page.html).to include('cdn.raygun.io/raygun4js/2.14.1/raygun.min.js')
-    end
-  end
-end
+require 'rails_helper'
+
+feature 'JavaScript Tracking', feature: true do
+  before { Raygun.configuration.js_api_key = nil }
+  after { Raygun.configuration.js_api_key = nil }
+
+  it "Includes the Raygun Javascript Middleware" do
+    expect(Rails.application.config.middleware).to include(Raygun::Middleware::JavascriptExceptionTracking)
+  end
+
+  it "Does not inject the JS snippet" do
+    visit root_path
+
+    expect(page.html).to_not include('cdn.raygun.io/raygun4js/raygun.min.js')
+    expect(page.html).to_not include('rg4js(')
+  end
+
+  context 'With a JS API Key' do
+    before { Raygun.configuration.js_api_key = 'Sample key' }
+
+    it "Injects the JS snippet" do
+      visit root_path
+
+      expect(page.html).to include('cdn.raygun.io/raygun4js/raygun.min.js')
+      expect(page.html).to include('rg4js(')
+    end
+
+    it "Does not inject the JS snippet" do
+      visit root_path(format: :json)
+
+      expect(page.html).to_not include('cdn.raygun.io/raygun4js/raygun.min.js')
+      expect(page.html).to_not include('rg4js(')
+    end
+  end
+
+  context "With JS version overriden" do
+    before do
+      Raygun.configuration.js_api_version = "2.14.1"
+      Raygun.configuration.js_api_key = "Sample key"
+    end
+
+    it "Uses the overriden version" do
+      visit root_path
+
+      expect(page.html).to include('cdn.raygun.io/raygun4js/2.14.1/raygun.min.js')
+    end
+  end
+end