sentry-rails 4.1.0 → 4.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e5e6de4bbd5e0e1530fcd38e5978b153c846bac123e92db1941fd8c58318eef
-  data.tar.gz: 3b0ea04fd34eab29d19052fde261954890e3ce59e8f090592e23653e1aab7a4f
+  metadata.gz: ea1c3fea4d0f1f017e5b56786e85414e459a181e8e4cebe2a45374b6c3e648dc
+  data.tar.gz: b41da6b3dc3a3a7836ed533029821b4f53dc40e8b7cb0d10023a52af13236218
 SHA512:
-  metadata.gz: 785b7d05b9ff2a18e5e3939aeac265ae02426a617f9fda15865fc69d1d196706fcc658a4a54731dd3eb918f714e6825651002528c2f20ad0b426e5fa0b248d24
-  data.tar.gz: f9065c5331efae105803df2fcaed4e7c7cf18286d2b07ae046e1e48004cde67c0c3e171a5ca82cfae2cada9f23bb4a9ee12442fc3391415e2634389799ead5af
+  metadata.gz: 359b3757908046fa6dfde636715b598a6977c3a131b11e4a7f8d8df3666246e867867ca3c32161bbb645fe9bc0110c50efac415ed42b4db754e21cf36878af86
+  data.tar.gz: 4605d701de78b04adc04c74dc7b7dd1a1e02c1d500a663965d4ba9de35cf35db4a70331d21afd2b2c07a5c2917d2ccb0e2b7a7cced8f5026188e189cf119ecdb

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Changelog
 
+## 4.1.5
+
+- Add `ActionDispatch::Http::MimeNegotiation::InvalidType` to the list of default ignored Rails exceptions [#1215](https://github.com/getsentry/sentry-ruby/pull/1215) (by @agrobbin)
+- Continue ActiveJob execution if Sentry is not initialized [#1217](https://github.com/getsentry/sentry-ruby/pull/1217)
+  - Fixes [#1211](https://github.com/getsentry/sentry-ruby/issues/1211) and [#1216](https://github.com/getsentry/sentry-ruby/issues/1216)
+- Only extend ActiveJob when it's defined [#1218](https://github.com/getsentry/sentry-ruby/pull/1218)
+  - Fixes [#1210](https://github.com/getsentry/sentry-ruby/issues/1210)
+- Filter out redundant event/payload from breadcrumbs logger [#1222](https://github.com/getsentry/sentry-ruby/pull/1222)
+- Copy request env before Rails' ShowExceptions middleware [#1223](https://github.com/getsentry/sentry-ruby/pull/1223)
+- Don't subscribe render_partial and render_collection events [#1224](https://github.com/getsentry/sentry-ruby/pull/1224)
+
+## 4.1.4
+
+- Don't include headers & request info in tracing span or breadcrumb [#1199](https://github.com/getsentry/sentry-ruby/pull/1199)
+- Don't run RescuedExceptionInterceptor unless Sentry is initialized [#1204](https://github.com/getsentry/sentry-ruby/pull/1204)
+
+## 4.1.3
+
+- Remove DelayedJobAdapter from ignored list [#1179](https://github.com/getsentry/sentry-ruby/pull/1179)
+
+## 4.1.2
+
+- Use middleware instead of method override to handle rescued exceptions [#1168](https://github.com/getsentry/sentry-ruby/pull/1168)
+  - Fixes [#738](https://github.com/getsentry/sentry-ruby/issues/738)
+- Adopt Integrable module [#1177](https://github.com/getsentry/sentry-ruby/pull/1177)
+
+## 4.1.1
+
+- Use stricter dependency declaration [#1159](https://github.com/getsentry/sentry-ruby/pull/1159)
+
 ## 4.1.0
 
 - Merge & rename 2 Rack middlewares [#1147](https://github.com/getsentry/sentry-ruby/pull/1147)

data/Gemfile

@@ -12,7 +12,7 @@ gem "sqlite3", platform: :ruby
 
 gem "rails", "~> #{rails_version}"
 gem "rspec-rails", "~> 4.0"
-gem "codecov"
+gem "codecov", "0.2.12"
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"

data/README.md

@@ -44,7 +44,7 @@ Sentry.init do |config|
   # the default value is true
   config.rails.report_rescued_exceptions = true
 
-  # this gem also provides a new breadcrumb logger that accepts instrumentaions from ActiveSupport
+  # this gem also provides a new breadcrumb logger that accepts instrumentations from ActiveSupport
   # it's not activated by default, but you can enable it with
   config.breadcrumbs_logger = [:active_support_logger]
 end

data/lib/sentry/rails.rb

@@ -1,14 +1,12 @@
 require "sentry-ruby"
+require "sentry/integrable"
 require "sentry/rails/configuration"
 require "sentry/rails/railtie"
 require "sentry/rails/tracing"
 
 module Sentry
   module Rails
-    META = { "name" => "sentry.ruby.rails", "version" => Sentry::Rails::VERSION }.freeze
-  end
-
-  def self.sdk_meta
-    Sentry::Rails::META
+    extend Integrable
+    register_integration name: "rails", version: Sentry::Rails::VERSION
   end
 end

data/lib/sentry/rails/active_job.rb

@@ -3,18 +3,21 @@ module Sentry
     module ActiveJobExtensions
       ALREADY_SUPPORTED_SENTRY_ADAPTERS = %w(
         ActiveJob::QueueAdapters::SidekiqAdapter
-        ActiveJob::QueueAdapters::DelayedJobAdapter
       ).freeze
 
       def self.included(base)
         base.class_eval do
           around_perform do |job, block|
-            if already_supported_by_specific_integration?(job)
-              block.call
-            else
-              Sentry.with_scope do
-                capture_and_reraise_with_sentry(job, block)
+            if Sentry.initialized?
+              if already_supported_by_specific_integration?(job)
+                block.call
+              else
+                Sentry.with_scope do
+                  capture_and_reraise_with_sentry(job, block)
+                end
               end
+            else
+              block.call
             end
           end
         end
@@ -26,7 +29,7 @@ module Sentry
         rescue_handler_result = rescue_with_handler(e)
         return rescue_handler_result if rescue_handler_result
 
-        Sentry.capture_exception(e, :extra => sentry_context(job))
+        Sentry::Rails.capture_exception(e, extra: sentry_context(job))
         raise e
       end
 

data/lib/sentry/rails/breadcrumb/active_support_logger.rb

@@ -3,7 +3,18 @@ module Sentry
     module Breadcrumb
       module ActiveSupportLogger
         class << self
+          IGNORED_DATA_TYPES = [:request, :headers, :exception, :exception_object]
+
           def add(name, started, _finished, _unique_id, data)
+            # skip Rails' internal events
+            return if name.start_with?("!")
+
+            if data.is_a?(Hash)
+              # we should only mutate the copy of the data
+              data = data.dup
+              cleanup_data(data)
+            end
+
             crumb = Sentry::Breadcrumb.new(
               data: data,
               category: name,
@@ -12,6 +23,12 @@ module Sentry
             Sentry.add_breadcrumb(crumb)
           end
 
+          def cleanup_data(data)
+            IGNORED_DATA_TYPES.each do |key|
+              data.delete(key) if data.key?(key)
+            end
+          end
+
           def inject
             @subscriber = ::ActiveSupport::Notifications.subscribe(/.*/) do |name, started, finished, unique_id, data|
               # we only record events that has a started timestamp

data/lib/sentry/rails/capture_exceptions.rb

@@ -1,8 +1,18 @@
 module Sentry
   module Rails
     class CaptureExceptions < Sentry::Rack::CaptureExceptions
+      private
+
       def collect_exception(env)
-        super || env["action_dispatch.exception"]
+        super || env["action_dispatch.exception"] || env["sentry.rescued_exception"]
+      end
+
+      def transaction_op
+        "rails.request".freeze
+      end
+
+      def capture_exception(exception)
+        Sentry::Rails.capture_exception(exception)
       end
     end
   end

data/lib/sentry/rails/configuration.rb

@@ -20,6 +20,7 @@ module Sentry
       'ActionController::RoutingError',
       'ActionController::UnknownAction',
       'ActionController::UnknownFormat',
+      'ActionDispatch::Http::MimeNegotiation::InvalidType',
       'ActionController::UnknownHttpMethod',
       'ActionDispatch::Http::Parameters::ParseError',
       'ActiveJob::DeserializationError', # Can cause infinite loops

data/lib/sentry/rails/controller_methods.rb

@@ -3,13 +3,13 @@ module Sentry
     module ControllerMethods
       def capture_message(message, options = {})
         with_request_scope do
-          Sentry.capture_message(message, **options)
+          Sentry::Rails.capture_message(message, **options)
         end
       end
 
       def capture_exception(exception, options = {})
         with_request_scope do
-          Sentry.capture_exception(exception, **options)
+          Sentry::Rails.capture_exception(exception, **options)
         end
       end
 

data/lib/sentry/rails/controller_transaction.rb

@@ -2,10 +2,8 @@ module Sentry
   module Rails
     module ControllerTransaction
       def self.included(base)
-        base.prepend_around_action do |controller, block|
+        base.prepend_before_action do |controller|
           Sentry.get_current_scope.set_transaction_name("#{controller.class}##{controller.action_name}")
-          block.call
-          Sentry.get_current_scope.transaction_names.pop
         end
       end
     end

data/lib/sentry/rails/overrides/streaming_reporter.rb

@@ -3,7 +3,7 @@ module Sentry
     module Overrides
       module StreamingReporter
         def log_error(exception)
-          Sentry.capture_exception(exception)
+          Sentry::Rails.capture_exception(exception)
           super
         end
       end
@@ -14,7 +14,7 @@ module Sentry
         end
 
         def log_error_with_raven(exception)
-          Sentry.capture_exception(exception)
+          Sentry::Rails.capture_exception(exception)
           log_error_without_raven(exception)
         end
       end

data/lib/sentry/rails/railtie.rb

@@ -1,16 +1,19 @@
 require "rails"
 require "sentry/rails/capture_exceptions"
+require "sentry/rails/rescued_exception_interceptor"
 require "sentry/rails/backtrace_cleaner"
 require "sentry/rails/controller_methods"
 require "sentry/rails/controller_transaction"
-require "sentry/rails/active_job"
 require "sentry/rails/overrides/streaming_reporter"
 
 module Sentry
   class Railtie < ::Rails::Railtie
     # middlewares can't be injected after initialize
     initializer "sentry.use_rack_middleware" do |app|
+      # need to be placed at first to capture as many errors as possible
       app.config.middleware.insert 0, Sentry::Rails::CaptureExceptions
+      # need to be placed at last to smuggle app exceptions via env
+      app.config.middleware.use(Sentry::Rails::RescuedExceptionInterceptor)
     end
 
     config.after_initialize do
@@ -18,8 +21,7 @@ module Sentry
 
       configure_sentry_logger
       extend_controller_methods
-      extend_active_job
-      override_exceptions_handling
+      extend_active_job if defined?(ActiveJob)
       override_streaming_reporter
       setup_backtrace_cleanup_callback
       inject_breadcrumbs_logger
@@ -31,6 +33,7 @@ module Sentry
     end
 
     def extend_active_job
+      require "sentry/rails/active_job"
       ActiveJob::Base.send(:prepend, Sentry::Rails::ActiveJobExtensions)
     end
 
@@ -57,19 +60,6 @@ module Sentry
       end
     end
 
-    def override_exceptions_handling
-      if Sentry.configuration.rails.report_rescued_exceptions
-        require 'sentry/rails/overrides/debug_exceptions_catcher'
-        if defined?(::ActionDispatch::DebugExceptions)
-          exceptions_class = ::ActionDispatch::DebugExceptions
-        elsif defined?(::ActionDispatch::ShowExceptions)
-          exceptions_class = ::ActionDispatch::ShowExceptions
-        end
-
-        exceptions_class.send(:prepend, Sentry::Rails::Overrides::DebugExceptionsCatcher)
-      end
-    end
-
     def override_streaming_reporter
       ActiveSupport.on_load :action_view do
         ActionView::StreamingTemplateRenderer::Body.send(:prepend, Sentry::Rails::Overrides::StreamingReporter)

data/lib/sentry/rails/rescued_exception_interceptor.rb

@@ -0,0 +1,29 @@
+module Sentry
+  module Rails
+    class RescuedExceptionInterceptor
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        return @app.call(env) unless Sentry.initialized?
+
+        begin
+          @app.call(env)
+        rescue => e
+          request = ActionDispatch::Request.new(env)
+
+          # Rails' ShowExceptions#render_exception will mutate env for the exceptions app
+          # so we need to hold a copy of env to report the accurate data (like request's url)
+          if request.show_exceptions?
+            scope = Sentry.get_current_scope
+            scope.set_rack_env(scope.rack_env.dup)
+          end
+
+          env["sentry.rescued_exception"] = e if Sentry.configuration.rails.report_rescued_exceptions
+          raise e
+        end
+      end
+    end
+  end
+end

data/lib/sentry/rails/tracing/action_controller_subscriber.rb

@@ -15,6 +15,9 @@ module Sentry
               description: "#{controller}##{action}",
               duration: duration
             ) do |span|
+              payload = payload.dup
+              payload.delete(:headers)
+              payload.delete(:request)
               span.set_data(:payload, payload)
               span.set_http_status(payload[:status])
             end

data/lib/sentry/rails/tracing/action_view_subscriber.rb

@@ -2,19 +2,11 @@ module Sentry
   module Rails
     module Tracing
       class ActionViewSubscriber < AbstractSubscriber
-        EVENT_NAMES = ["render_template.action_view", "render_partial.action_view", "render_collection.action_view"]
+        EVENT_NAME = "render_template.action_view".freeze
 
         def self.subscribe!
-          EVENT_NAMES.each do |event_name|
-            subscribe_to_event(event_name) do |event_name, duration, payload|
-              record_on_current_span(op: event_name, start_timestamp: payload[:start_timestamp], description: payload[:identifier], duration: duration)
-            end
-          end
-        end
-
-        def self.unsubscribe!
-          EVENT_NAMES.each do |event_name|
-            ActiveSupport::Notifications.unsubscribe(event_name)
+          subscribe_to_event(EVENT_NAME) do |event_name, duration, payload|
+            record_on_current_span(op: event_name, start_timestamp: payload[:start_timestamp], description: payload[:identifier], duration: duration)
           end
         end
       end

data/lib/sentry/rails/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Rails
-    VERSION = "4.1.0"
+    VERSION = "4.1.5"
   end
 end

data/sentry-rails.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rails", ">= 5.0"
-  spec.add_dependency "sentry-ruby", ">= 4.1.0"
+  spec.add_dependency "sentry-ruby", "~> 4.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.1.5
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-18 00:00:00.000000000 Z
+date: 2021-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,16 +28,16 @@ dependencies:
   name: sentry-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 4.1.2
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -67,9 +67,9 @@ files:
 - lib/sentry/rails/configuration.rb
 - lib/sentry/rails/controller_methods.rb
 - lib/sentry/rails/controller_transaction.rb
-- lib/sentry/rails/overrides/debug_exceptions_catcher.rb
 - lib/sentry/rails/overrides/streaming_reporter.rb
 - lib/sentry/rails/railtie.rb
+- lib/sentry/rails/rescued_exception_interceptor.rb
 - lib/sentry/rails/tracing.rb
 - lib/sentry/rails/tracing/abstract_subscriber.rb
 - lib/sentry/rails/tracing/action_controller_subscriber.rb

data/lib/sentry/rails/overrides/debug_exceptions_catcher.rb

@@ -1,19 +0,0 @@
-module Sentry
-  module Rails
-    module Overrides
-      module DebugExceptionsCatcher
-        def render_exception(env_or_request, exception)
-          begin
-            env = env_or_request.respond_to?(:env) ? env_or_request.env : env_or_request
-            Sentry.with_scope do |scope|
-              scope.set_rack_env(env)
-              Sentry.capture_exception(exception)
-            end
-          rescue
-          end
-          super
-        end
-      end
-    end
-  end
-end