raygun4ruby 3.2.6 → 4.0.1

data/lib/raygun/configuration.rb

@@ -1,194 +1,202 @@
-module Raygun
-  class Configuration
-
-    def self.config_option(name)
-      define_method(name) do
-        read_value(name)
-      end
-
-      define_method("#{name}=") do |value|
-        set_value(name, value)
-      end
-    end
-
-    def self.proc_config_option(name)
-      define_method(name) do |&block|
-        set_value(name, block) unless block == nil
-        read_value(name)
-      end
-
-      define_method("#{name}=") do |value|
-        set_value(name, value)
-      end
-    end
-
-    # Your Raygun API Key - this can be found on your dashboard at https://app.raygun.com
-    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/documentation/language-guides/javascript/crash-reporting/installation/
-    config_option :js_api_version
-
-    # Array of exception classes to ignore
-    config_option :ignore
-
-    # Version to use
-    config_option :version
-
-    # Custom Data to send with each exception
-    proc_config_option :custom_data
-
-    # Tags to send with each exception
-    proc_config_option :tags
-
-    # Logger to use when we find an exception :)
-    config_option :logger
-
-    # Should we actually report exceptions to Raygun? (Usually disabled in Development mode, for instance)
-    config_option :enable_reporting
-
-    # Failsafe logger (for exceptions that happen when we're attempting to report exceptions)
-    config_option :failsafe_logger
-
-    # Which controller method should we call to find out the affected user?
-    config_option :affected_user_method
-
-    # Mapping of methods for the affected user object - which methods should we call for user information
-    config_option :affected_user_mapping
-
-    # Which parameter keys should we filter out by default?
-    proc_config_option :filter_parameters
-
-    # Should we switch to a white listing mode for keys instead of the default blacklist?
-    config_option :filter_payload_with_whitelist
-
-    # If :filter_payload_with_whitelist is true, which keys should we whitelist?
-    proc_config_option :whitelist_payload_shape
-
-    # Hash of proxy settings - :address, :port (defaults to 80), :username and :password (both default to nil)
-    config_option :proxy_settings
-
-    # Set this to true to have raygun4ruby log the reason why it skips reporting an exception
-    config_option :debug
-
-    # Override this if you wish to connect to a different Raygun API than the standard one
-    config_option :api_url
-
-    # Should Raygun include the raw request body in the payload? This will not include
-    # form submissions and will not be filtered by the blacklist
-    config_option :record_raw_data
-
-    # Should the exceptions to Raygun be sent asynchronously?
-    config_option :send_in_background
-
-    # How long to wait for the POST request to the API server before timing out
-    config_option :error_report_send_timeout
-
-    # Exception classes to ignore by default
-    IGNORE_DEFAULT = ['ActiveRecord::RecordNotFound',
-                      'ActionController::RoutingError',
-                      'ActionController::InvalidAuthenticityToken',
-                      'ActionDispatch::ParamsParser::ParseError',
-                      'CGI::Session::CookieStore::TamperedWithCookie',
-                      'ActionController::UnknownAction',
-                      'AbstractController::ActionNotFound',
-                      'Mongoid::Errors::DocumentNotFound']
-
-    DEFAULT_FILTER_PARAMETERS = [ :password, :card_number, :cvv ]
-
-    DEFAULT_WHITELIST_PAYLOAD_SHAPE_REQUEST = {
-      hostName: true,
-      url: true,
-      httpMethod: true,
-      iPAddress: true,
-      queryString: true,
-      headers: true,
-      form: {}, # Set to empty hash so that it doesn't just filter out the whole thing, but instead filters out each individual param
-      rawData: true
-    }.freeze
-    DEFAULT_WHITELIST_PAYLOAD_SHAPE = {
-      machineName: true,
-      version: true,
-      error: true,
-      userCustomData: true,
-      tags: true,
-      request: DEFAULT_WHITELIST_PAYLOAD_SHAPE_REQUEST
-    }.freeze
-
-    attr_reader :defaults
-
-    def initialize
-      @config_values = {}
-
-      # set default attribute values
-      @defaults = OpenStruct.new(
-        ignore:                        IGNORE_DEFAULT,
-        custom_data:                   {},
-        tags:                          [],
-        enable_reporting:              true,
-        affected_user_method:          :current_user,
-        affected_user_mapping:         AffectedUser::DEFAULT_MAPPING,
-        filter_parameters:             DEFAULT_FILTER_PARAMETERS,
-        filter_payload_with_whitelist: false,
-        whitelist_payload_shape:       DEFAULT_WHITELIST_PAYLOAD_SHAPE,
-        proxy_settings:                {},
-        debug:                         false,
-        api_url:                       'https://api.raygun.com/',
-        breadcrumb_level:              :info,
-        record_raw_data:               false,
-        send_in_background:            false,
-        error_report_send_timeout:     10
-      )
-    end
-
-    def [](key)
-      read_value(key)
-    end
-
-    def []=(key, value)
-      set_value(key, value)
-    end
-
-    def silence_reporting
-      !enable_reporting
-    end
-
-    def silence_reporting=(value)
-      self.enable_reporting = !value
-    end
-
-    def breadcrumb_level
-      read_value(:breadcrumb_level)
-    end
-
-    def breadcrumb_level=(value)
-      if Raygun::Breadcrumbs::BREADCRUMB_LEVELS.include?(value)
-        set_value(:breadcrumb_level, value)
-      elsif read_value(:debug)
-        Raygun.log("[Raygun.configuration] unknown breadcrumb level: #{value} not setting")
-      end
-    end
-
-    def affected_user_identifier_methods
-      Raygun.deprecation_warning("Please note: You should now user config.affected_user_method_mapping.Identifier instead of config.affected_user_identifier_methods")
-      read_value(:affected_user_mapping)[:identifier]
-    end
-
-    private
-
-      def read_value(name)
-        if @config_values.has_key?(name)
-          @config_values[name]
-        else
-          @defaults.send(name)
-        end
-      end
-
-      def set_value(name, value)
-        @config_values[name] = value
-      end
-
-  end
-end
+module Raygun
+  class Configuration
+
+    def self.config_option(name)
+      define_method(name) do
+        read_value(name)
+      end
+
+      define_method("#{name}=") do |value|
+        set_value(name, value)
+      end
+    end
+
+    def self.proc_config_option(name)
+      define_method(name) do |&block|
+        set_value(name, block) unless block == nil
+        read_value(name)
+      end
+
+      define_method("#{name}=") do |value|
+        set_value(name, value)
+      end
+    end
+
+    # Your Raygun API Key - this can be found on your dashboard at https://app.raygun.com
+    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/documentation/language-guides/javascript/crash-reporting/installation/
+    config_option :js_api_version
+
+    # Array of exception classes to ignore
+    config_option :ignore
+
+    # Version to use
+    config_option :version
+
+    # Custom Data to send with each exception
+    proc_config_option :custom_data
+
+    # Tags to send with each exception
+    proc_config_option :tags
+
+    # Logger to use when we find an exception :)
+    config_option :logger
+
+    # Should we actually report exceptions to Raygun? (Usually disabled in Development mode, for instance)
+    config_option :enable_reporting
+
+    # Failsafe logger (for exceptions that happen when we're attempting to report exceptions)
+    config_option :failsafe_logger
+
+    # Which controller method should we call to find out the affected user?
+    config_option :affected_user_method
+
+    # Mapping of methods for the affected user object - which methods should we call for user information
+    config_option :affected_user_mapping
+
+    # Which parameter keys should we filter out by default?
+    proc_config_option :filter_parameters
+
+    # Should we switch to a white listing mode for keys instead of the default blacklist?
+    config_option :filter_payload_with_whitelist
+
+    # If :filter_payload_with_whitelist is true, which keys should we whitelist?
+    proc_config_option :whitelist_payload_shape
+
+    # Hash of proxy settings - :address, :port (defaults to 80), :username and :password (both default to nil)
+    config_option :proxy_settings
+
+    # Set this to true to have raygun4ruby log the reason why it skips reporting an exception
+    config_option :debug
+
+    # Override this if you wish to connect to a different Raygun API than the standard one
+    config_option :api_url
+
+    # Should Raygun include the raw request body in the payload? This will not include
+    # form submissions and will not be filtered by the blacklist
+    config_option :record_raw_data
+
+    # Should the exceptions to Raygun be sent asynchronously?
+    config_option :send_in_background
+
+    # How long to wait for the POST request to the API server before timing out
+    config_option :error_report_send_timeout
+
+    # Should we register an error handler with [Rails' built in API](https://edgeguides.rubyonrails.org/error_reporting.html)
+    config_option :register_rails_error_handler
+
+    # Should we track jobs that are retried in Sidekiq (ones that raise Sidekiq::JobRetry::Handled). Set to "false" to ignore.
+    config_option :track_retried_sidekiq_jobs
+
+    # Exception classes to ignore by default
+    IGNORE_DEFAULT = ['ActiveRecord::RecordNotFound',
+                      'ActionController::RoutingError',
+                      'ActionController::InvalidAuthenticityToken',
+                      'ActionDispatch::ParamsParser::ParseError',
+                      'CGI::Session::CookieStore::TamperedWithCookie',
+                      'ActionController::UnknownAction',
+                      'AbstractController::ActionNotFound',
+                      'Mongoid::Errors::DocumentNotFound',
+                      'Sidekiq::JobRetry::Skip']
+
+    DEFAULT_FILTER_PARAMETERS = [ :password, :card_number, :cvv ]
+
+    DEFAULT_WHITELIST_PAYLOAD_SHAPE_REQUEST = {
+      hostName: true,
+      url: true,
+      httpMethod: true,
+      iPAddress: true,
+      queryString: true,
+      headers: true,
+      form: {}, # Set to empty hash so that it doesn't just filter out the whole thing, but instead filters out each individual param
+      rawData: true
+    }.freeze
+    DEFAULT_WHITELIST_PAYLOAD_SHAPE = {
+      machineName: true,
+      version: true,
+      error: true,
+      userCustomData: true,
+      tags: true,
+      request: DEFAULT_WHITELIST_PAYLOAD_SHAPE_REQUEST
+    }.freeze
+
+    attr_reader :defaults
+
+    def initialize
+      @config_values = {}
+
+      # set default attribute values
+      @defaults = OpenStruct.new(
+        ignore:                        IGNORE_DEFAULT,
+        custom_data:                   {},
+        tags:                          [],
+        enable_reporting:              true,
+        affected_user_method:          :current_user,
+        affected_user_mapping:         AffectedUser::DEFAULT_MAPPING,
+        filter_parameters:             DEFAULT_FILTER_PARAMETERS,
+        filter_payload_with_whitelist: false,
+        whitelist_payload_shape:       DEFAULT_WHITELIST_PAYLOAD_SHAPE,
+        proxy_settings:                {},
+        debug:                         false,
+        api_url:                       'https://api.raygun.com/',
+        breadcrumb_level:              :info,
+        record_raw_data:               false,
+        send_in_background:            false,
+        error_report_send_timeout:     10,
+        track_retried_sidekiq_jobs:    true
+      )
+    end
+
+    def [](key)
+      read_value(key)
+    end
+
+    def []=(key, value)
+      set_value(key, value)
+    end
+
+    def silence_reporting
+      !enable_reporting
+    end
+
+    def silence_reporting=(value)
+      self.enable_reporting = !value
+    end
+
+    def breadcrumb_level
+      read_value(:breadcrumb_level)
+    end
+
+    def breadcrumb_level=(value)
+      if Raygun::Breadcrumbs::BREADCRUMB_LEVELS.include?(value)
+        set_value(:breadcrumb_level, value)
+      elsif read_value(:debug)
+        Raygun.log("[Raygun.configuration] unknown breadcrumb level: #{value} not setting")
+      end
+    end
+
+    def affected_user_identifier_methods
+      Raygun.deprecation_warning("Please note: You should now user config.affected_user_method_mapping.Identifier instead of config.affected_user_identifier_methods")
+      read_value(:affected_user_mapping)[:identifier]
+    end
+
+    private
+
+      def read_value(name)
+        if @config_values.has_key?(name)
+          @config_values[name]
+        else
+          @defaults.send(name)
+        end
+      end
+
+      def set_value(name, value)
+        @config_values[name] = value
+      end
+
+  end
+end

data/lib/raygun/demo_exception.rb

@@ -1,23 +1,23 @@
-module Raygun
-
-  class ItWorksException < StandardError; end
-
-  module DemoException
-
-    def track_test_exception
-      Raygun.configuration.silence_reporting = false
-      raise ItWorksException.new("Woohoo! Your Raygun<->Ruby connection is set up correctly")
-    rescue ItWorksException => e
-      response = Raygun.track_exception(e)
-
-      if response.success?
-        puts "Success! Now go check your Raygun Dashboard"
-      else
-        puts "Oh-oh, something went wrong - double check your API key"
-        puts "API Key - " << Raygun.configuration.api_key << ")"
-        puts "API Response - " << response
-      end
-    end
-
-  end
+module Raygun
+
+  class ItWorksException < StandardError; end
+
+  module DemoException
+
+    def track_test_exception
+      Raygun.configuration.silence_reporting = false
+      raise ItWorksException.new("Woohoo! Your Raygun<->Ruby connection is set up correctly")
+    rescue ItWorksException => e
+      response = Raygun.track_exception(e)
+
+      if response.success?
+        puts "Success! Now go check your Raygun Crash Reporting dashboard"
+      else
+        puts "Oh-oh, something went wrong - double check your API key"
+        puts "API Key - " << Raygun.configuration.api_key << ")"
+        puts "API Response - " << response
+      end
+    end
+
+  end
 end

data/lib/raygun/error.rb

@@ -1,10 +1,10 @@
-module Raygun
-  class Error < StandardError
-    attr_reader :raygun_custom_data
-
-    def initialize(message, raygun_custom_data = {})
-      super(message)
-      @raygun_custom_data = raygun_custom_data
-    end
-  end
-end
+module Raygun
+  class Error < StandardError
+    attr_reader :raygun_custom_data
+
+    def initialize(message, raygun_custom_data = {})
+      super(message)
+      @raygun_custom_data = raygun_custom_data
+    end
+  end
+end

data/lib/raygun/error_subscriber.rb

@@ -0,0 +1,25 @@
+# Subscribes to errors using Rails' error reporting API
+# https://edgeguides.rubyonrails.org/error_reporting.html
+class Raygun::ErrorSubscriber
+  def report(error, handled:, severity:, context:, source: nil)
+    tags = context.delete(:tags) if context.is_a?(Hash)
+
+    data = {
+      custom_data: {
+        "rails.error": {
+          handled: handled,
+          severity: severity,
+          context: context,
+          source: source
+        },
+      },
+      tags: ["rails_error_reporter", *tags].compact
+    }
+
+    if source == "job.sidekiq" && defined?(Sidekiq)
+      Raygun::SidekiqReporter.call(error, data)
+    else
+      Raygun.track_exception(error, data)
+    end
+  end
+end

data/lib/raygun/javascript_tracker.rb

@@ -1,42 +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
+# 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/breadcrumbs_store_initializer.rb

@@ -1,19 +1,19 @@
-module Raygun
-  module Middleware
-    class BreadcrumbsStoreInitializer
-      def initialize(app)
-        @app = app
-      end
-
-      def call(env)
-        Breadcrumbs::Store.initialize
-
-        begin
-          @app.call(env)
-        ensure
-          Breadcrumbs::Store.clear
-        end
-      end
-    end
-  end
-end
+module Raygun
+  module Middleware
+    class BreadcrumbsStoreInitializer
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        Breadcrumbs::Store.initialize
+
+        begin
+          @app.call(env)
+        ensure
+          Breadcrumbs::Store.clear
+        end
+      end
+    end
+  end
+end