raygun4ruby 3.2.1 → 3.2.6

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

data/lib/raygun/middleware/javascript_exception_tracking.rb

@@ -1,32 +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
+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/middleware/rack_exception_interceptor.rb

@@ -1,18 +1,18 @@
-module Raygun
-  module Middleware
-    class RackExceptionInterceptor
-
-      def initialize(app)
-        @app = app
-      end
-
-      def call(env)
-        response = @app.call(env)
-      rescue Exception => exception
-        Raygun.track_exception(exception, env) if Raygun.configured?
-        raise exception
-      end
-
-    end
-  end
-end
+module Raygun
+  module Middleware
+    class RackExceptionInterceptor
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        response = @app.call(env)
+      rescue Exception => exception
+        Raygun.track_exception(exception, env) if Raygun.configured?
+        raise exception
+      end
+
+    end
+  end
+end

data/lib/raygun/middleware/rails_insert_affected_user.rb

@@ -1,26 +1,26 @@
-module Raygun
-  module Middleware
-    # Adapted from the Rollbar approach https://github.com/rollbar/rollbar-gem/blob/master/lib/rollbar/middleware/rails/rollbar_request_store.rb
-    class RailsInsertAffectedUser
-
-      def initialize(app)
-        @app = app
-      end
-
-      def call(env)
-        @app.call(env)
-      rescue Exception => exception
-        controller = env["action_controller.instance"]
-        affected_user_method = Raygun.configuration.affected_user_method
-
-        if controller && controller.respond_to?(affected_user_method, true)
-          user = controller.send(affected_user_method)
-
-          env["raygun.affected_user"] = Raygun::AffectedUser.information_hash(user)
-        end
-
-        raise exception
-      end
-    end
-  end
-end
+module Raygun
+  module Middleware
+    # Adapted from the Rollbar approach https://github.com/rollbar/rollbar-gem/blob/master/lib/rollbar/middleware/rails/rollbar_request_store.rb
+    class RailsInsertAffectedUser
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        @app.call(env)
+      rescue Exception => exception
+        controller = env["action_controller.instance"]
+        affected_user_method = Raygun.configuration.affected_user_method
+
+        if controller && controller.respond_to?(affected_user_method, true)
+          user = controller.send(affected_user_method)
+
+          env["raygun.affected_user"] = Raygun::AffectedUser.information_hash(user)
+        end
+
+        raise exception
+      end
+    end
+  end
+end

data/lib/raygun/railtie.rb

@@ -1,39 +1,39 @@
-require "raygun/middleware/rails_insert_affected_user"
-
-class Raygun::Railtie < Rails::Railtie
-  initializer "raygun.configure_rails_initialization" do |app|
-
-    # Thanks Airbrake: See https://github.com/rails/rails/pull/8624
-    middleware = if defined?(ActionDispatch::DebugExceptions)
-                   if Rails::VERSION::STRING >= "5"
-                     ActionDispatch::DebugExceptions
-                   else
-                     # Rails >= 3.2.0
-                     "ActionDispatch::DebugExceptions"
-                   end
-                 else
-                   # Rails < 3.2.0
-                   "ActionDispatch::ShowExceptions"
-                 end
-
-    raygun_middleware = [
-      Raygun::Middleware::RailsInsertAffectedUser,
-      Raygun::Middleware::RackExceptionInterceptor,
-      Raygun::Middleware::BreadcrumbsStoreInitializer,
-      Raygun::Middleware::JavascriptExceptionTracking
-    ]
-    raygun_middleware = raygun_middleware.map(&:to_s) unless Rails::VERSION::STRING >= "5"
-    raygun_middleware.each do |m|
-      app.config.middleware.insert_after(middleware, m)
-    end
-  end
-
-  config.to_prepare do
-    Raygun.default_configuration.logger           = Rails.logger
-    Raygun.default_configuration.enable_reporting = Rails.env.production?
-  end
-
-  rake_tasks do
-    load "tasks/raygun.tasks"
-  end
-end
+require "raygun/middleware/rails_insert_affected_user"
+
+class Raygun::Railtie < Rails::Railtie
+  initializer "raygun.configure_rails_initialization" do |app|
+
+    # Thanks Airbrake: See https://github.com/rails/rails/pull/8624
+    middleware = if defined?(ActionDispatch::DebugExceptions)
+                   if Rails::VERSION::STRING >= "5"
+                     ActionDispatch::DebugExceptions
+                   else
+                     # Rails >= 3.2.0
+                     "ActionDispatch::DebugExceptions"
+                   end
+                 else
+                   # Rails < 3.2.0
+                   "ActionDispatch::ShowExceptions"
+                 end
+
+    raygun_middleware = [
+      Raygun::Middleware::RailsInsertAffectedUser,
+      Raygun::Middleware::RackExceptionInterceptor,
+      Raygun::Middleware::BreadcrumbsStoreInitializer,
+      Raygun::Middleware::JavascriptExceptionTracking
+    ]
+    raygun_middleware = raygun_middleware.map(&:to_s) unless Rails::VERSION::STRING >= "5"
+    raygun_middleware.each do |m|
+      app.config.middleware.insert_after(middleware, m)
+    end
+  end
+
+  config.to_prepare do
+    Raygun.default_configuration.logger           = Rails.logger
+    Raygun.default_configuration.enable_reporting = Rails.env.production?
+  end
+
+  rake_tasks do
+    load "tasks/raygun.tasks"
+  end
+end

data/lib/raygun/services/apply_whitelist_filter_to_payload.rb

@@ -1,27 +1,27 @@
-module Raygun
-  module Services
-    class ApplyWhitelistFilterToPayload
-      def call(whitelist, payload)
-        filter_hash(whitelist, payload)
-      end
-
-      private
-
-      def filter_hash(whitelist, hash)
-        # dup the input so each level of the hash is dup'd
-        # not just the top as dup isn't deep
-        hash = hash.dup
-
-        hash.each do |k, v|
-          unless whitelist && (whitelist[k] || whitelist[k.to_sym])
-            hash[k] = '[FILTERED]'
-          end
-
-          if v.is_a?(Hash) && whitelist[k].is_a?(Hash)
-            hash[k] = filter_hash(whitelist[k], v)
-          end
-        end
-      end
-    end
-  end
-end
+module Raygun
+  module Services
+    class ApplyWhitelistFilterToPayload
+      def call(whitelist, payload)
+        filter_hash(whitelist, payload)
+      end
+
+      private
+
+      def filter_hash(whitelist, hash)
+        # dup the input so each level of the hash is dup'd
+        # not just the top as dup isn't deep
+        hash = hash.dup
+
+        hash.each do |k, v|
+          unless whitelist && (whitelist[k] || whitelist[k.to_sym])
+            hash[k] = '[FILTERED]'
+          end
+
+          if v.is_a?(Hash) && whitelist[k].is_a?(Hash)
+            hash[k] = filter_hash(whitelist[k], v)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/raygun/sidekiq.rb

@@ -1,67 +1,71 @@
-# Adapted from Bugsnag code as per Sidekiq 2.x comment request
-#
-# SideKiq 2.x: https://github.com/mperham/sidekiq/blob/2-x/lib/sidekiq/exception_handler.rb
-# Bugsnag: https://github.com/bugsnag/bugsnag-ruby/blob/master/lib/bugsnag/sidekiq.rb
-
-module Raygun
-
-  class SidekiqMiddleware  # Used for Sidekiq 2.x only
-    def call(worker, message, queue)
-      begin
-        yield
-      rescue Exception => ex
-        raise ex if [Interrupt, SystemExit, SignalException].include?(ex.class)
-        SidekiqReporter.call(ex, worker: worker, message: message, queue: queue)
-        raise ex
-      end
-    end
-  end
-
-  class SidekiqReporter
-    def self.call(exception, context_hash)
-      user = affected_user(context_hash)
-      data =  {
-        custom_data: {
-          sidekiq_context: context_hash
-        }
-      }
-      ::Raygun.track_exception(
-          exception,
-          data,
-          user
-        )
-    end
-
-    # Extracts affected user information out of a Sidekiq worker class
-    def self.affected_user(context_hash)
-      job = context_hash[:job]
-
-      return if job.nil? || job['class'].nil? || !Module.const_defined?(job['class'])
-
-      worker_class = Module.const_get(job['class'])
-      affected_user_method = Raygun.configuration.affected_user_method
-
-      return if worker_class.nil? || !worker_class.respond_to?(affected_user_method)
-
-      worker_class.send(affected_user_method, job['args'])
-    rescue => e
-      return unless Raygun.configuration.failsafe_logger
-
-      failsafe_log("Problem in sidekiq affected user tracking: #{e.class}: #{e.message}\n\n#{e.backtrace.join("\n")}")
-
-      nil
-    end
-  end
-end
-
-if Sidekiq::VERSION < '3'
-  Sidekiq.configure_server do |config|
-    config.server_middleware do |chain|
-      chain.add Raygun::SidekiqMiddleware
-    end
-  end
-else
-  Sidekiq.configure_server do |config|
-    config.error_handlers << Raygun::SidekiqReporter
-  end
-end
+# Adapted from Bugsnag code as per Sidekiq 2.x comment request
+#
+# SideKiq 2.x: https://github.com/mperham/sidekiq/blob/2-x/lib/sidekiq/exception_handler.rb
+# Bugsnag: https://github.com/bugsnag/bugsnag-ruby/blob/master/lib/bugsnag/sidekiq.rb
+
+module Raygun
+
+  class SidekiqMiddleware  # Used for Sidekiq 2.x only
+    def call(worker, message, queue)
+      begin
+        yield
+      rescue Exception => ex
+        raise ex if [Interrupt, SystemExit, SignalException].include?(ex.class)
+        SidekiqReporter.call(ex, worker: worker, message: message, queue: queue)
+        raise ex
+      end
+    end
+  end
+
+  class SidekiqReporter
+    def self.call(exception, context_hash)
+      user = affected_user(context_hash)
+      data =  {
+        custom_data: {
+          sidekiq_context: context_hash
+        },
+        tags: ['sidekiq']
+      }
+      if correlation_id = exception.instance_variable_get(:@__raygun_correlation_id)
+        data.merge!(correlation_id: correlation_id)
+      end
+      ::Raygun.track_exception(
+          exception,
+          data,
+          user
+        )
+    end
+
+    # Extracts affected user information out of a Sidekiq worker class
+    def self.affected_user(context_hash)
+      job = context_hash[:job]
+
+      return if job.nil? || job['class'].nil? || !Module.const_defined?(job['class'])
+
+      worker_class = Module.const_get(job['class'])
+      affected_user_method = Raygun.configuration.affected_user_method
+
+      return if worker_class.nil? || !worker_class.respond_to?(affected_user_method)
+
+      worker_class.send(affected_user_method, job['args'])
+    rescue => e
+      return unless Raygun.configuration.failsafe_logger
+
+      failsafe_log("Problem in sidekiq affected user tracking: #{e.class}: #{e.message}\n\n#{e.backtrace.join("\n")}")
+
+      nil
+    end
+  end
+end
+
+if Sidekiq::VERSION < '3'
+  Sidekiq.configure_server do |config|
+    config.server_middleware do |chain|
+      chain.add Raygun::SidekiqMiddleware
+    end
+  end
+else
+  Sidekiq.configure_server do |config|
+    config.error_handlers << Raygun::SidekiqReporter
+  end
+end