sentry-rails 4.0.0 → 4.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77b9b80b3b1a86d1ae7505e280d02e11e434c63b0952921fc4bf5e7e8784c7a6
-  data.tar.gz: fa67dc90e35e176250e8c1bc6634d96be8fb10a4c59d150010939d786a9e660d
+  metadata.gz: b6d5b6ddf199bc5669f9e6808ad6e2b3673280224556627a11f5ce8b528cf322
+  data.tar.gz: 701956e40f0024ed399289489c7d0e3caa4554266b1912a708502ded4a1facb4
 SHA512:
-  metadata.gz: '0949c417ea51c4bf46c73ab457fb0b5dccfeae5b6e19d94236a1cce86f84ce6818dfc2c86ad8390bd0fbdd7dca2e256e6e45c90ca9911607088783cd9be009fb'
-  data.tar.gz: 002ad77da75a4d906822cd6f42cc1334ebea2ce3998623db5fc27bcc229f1afc02b4c30b0d375a106f47ea69adf7f6b472c1a8d3d82be158fed8d5e8341ef578
+  metadata.gz: 8869449bc60e1eca6da3e2f9c08b638137ad51eeeb8776a534af4649bf31d7af2321bd37a104dc86efb1a364cd8744890ce980b4405af0c815030fb0e3e1e25b
+  data.tar.gz: 426b79fa8bec147d34d3c0ef7c52ae7db4279df0d6b094858c20f63eb77f3e5b732ad42a280d059b00ce598d140fe0df476741df5b98dc3edb3d28473828d01a

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## 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)
+  - Fixes [#1153](https://github.com/getsentry/sentry-ruby/pull/1153)
+  - Removed `Sentry::Rack::Tracing` middleware and renamed `Sentry::Rack::CaptureException` to `Sentry::Rack::CaptureExceptions`
+- Tidy up rails integration [#1150](https://github.com/getsentry/sentry-ruby/pull/1150)
+- Check SDK initialization before running integrations [#1151](https://github.com/getsentry/sentry-ruby/pull/1151)
+  - Fixes [#1145](https://github.com/getsentry/sentry-ruby/pull/1145)
+
 ## 4.0.0
 
 - Only documents update for the official release and no API/feature changes.

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,7 +3,6 @@ module Sentry
     module ActiveJobExtensions
       ALREADY_SUPPORTED_SENTRY_ADAPTERS = %w(
         ActiveJob::QueueAdapters::SidekiqAdapter
-        ActiveJob::QueueAdapters::DelayedJobAdapter
       ).freeze
 
       def self.included(base)
@@ -26,7 +25,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

@@ -4,6 +4,13 @@ module Sentry
       module ActiveSupportLogger
         class << self
           def add(name, started, _finished, _unique_id, data)
+            if data.is_a?(Hash) && (data.key(:request) || data.key?(:headers))
+              # we should only mutate the copy of the data
+              data = data.dup
+              data.delete(:request)
+              data.delete(:headers)
+            end
+
             crumb = Sentry::Breadcrumb.new(
               data: data,
               category: name,
@@ -14,7 +21,10 @@ module Sentry
 
           def inject
             @subscriber = ::ActiveSupport::Notifications.subscribe(/.*/) do |name, started, finished, unique_id, data|
-              add(name, started, finished, unique_id, data)
+              # we only record events that has a started timestamp
+              if started.is_a?(Time)
+                add(name, started, finished, unique_id, data)
+              end
             end
           end
 

data/lib/sentry/rails/capture_exceptions.rb

@@ -0,0 +1,19 @@
+module Sentry
+  module Rails
+    class CaptureExceptions < Sentry::Rack::CaptureExceptions
+      private
+
+      def collect_exception(env)
+        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
+end

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,5 +1,6 @@
 require "rails"
-require "sentry/rails/capture_exception"
+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"
@@ -8,12 +9,35 @@ 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|
-      app.config.middleware.insert 0, Sentry::Rails::CaptureException
-      app.config.middleware.insert 0, Sentry::Rack::Tracing
+      # 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
 
-    initializer 'sentry.action_controller' do
+    config.after_initialize do
+      next unless Sentry.initialized?
+
+      configure_sentry_logger
+      extend_controller_methods
+      extend_active_job
+      override_streaming_reporter
+      setup_backtrace_cleanup_callback
+      inject_breadcrumbs_logger
+      activate_tracing
+    end
+
+    def configure_sentry_logger
+      Sentry.configuration.logger = ::Rails.logger
+    end
+
+    def extend_active_job
+      ActiveJob::Base.send(:prepend, Sentry::Rails::ActiveJobExtensions)
+    end
+
+    def extend_controller_methods
       ActiveSupport.on_load :action_controller do
         include Sentry::Rails::ControllerMethods
         include Sentry::Rails::ControllerTransaction
@@ -21,51 +45,32 @@ module Sentry
       end
     end
 
-    initializer 'sentry.action_view' do
-      ActiveSupport.on_load :action_view do
-        ActionView::StreamingTemplateRenderer::Body.send(:prepend, Sentry::Rails::Overrides::StreamingReporter)
+    def inject_breadcrumbs_logger
+      if Sentry.configuration.breadcrumbs_logger.include?(:active_support_logger)
+        require 'sentry/rails/breadcrumb/active_support_logger'
+        Sentry::Rails::Breadcrumb::ActiveSupportLogger.inject
       end
     end
 
-    config.after_initialize do
-      Sentry.configuration.logger = ::Rails.logger
-
+    def setup_backtrace_cleanup_callback
       backtrace_cleaner = Sentry::Rails::BacktraceCleaner.new
 
       Sentry.configuration.backtrace_cleanup_callback = lambda do |backtrace|
         backtrace_cleaner.clean(backtrace)
       end
+    end
 
-      if Sentry.configuration.breadcrumbs_logger.include?(:active_support_logger)
-        require 'sentry/rails/breadcrumb/active_support_logger'
-        Sentry::Rails::Breadcrumb::ActiveSupportLogger.inject
-      end
-
-      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)
+    def override_streaming_reporter
+      ActiveSupport.on_load :action_view do
+        ActionView::StreamingTemplateRenderer::Body.send(:prepend, Sentry::Rails::Overrides::StreamingReporter)
       end
+    end
 
+    def activate_tracing
       if Sentry.configuration.tracing_enabled?
         Sentry::Rails::Tracing.subscribe_tracing_events
         Sentry::Rails::Tracing.patch_active_support_notifications
       end
     end
-
-    initializer 'sentry.active_job' do
-      ActiveSupport.on_load :active_job do
-        require 'sentry/rails/active_job'
-      end
-    end
-
-    # rake_tasks do
-    #   require 'sentry/integrations/tasks'
-    # end
   end
 end

data/lib/sentry/rails/rescued_exception_interceptor.rb

@@ -0,0 +1,20 @@
+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
+          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/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Rails
-    VERSION = "4.0.0"
+    VERSION = "4.1.4"
   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.0.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.0.0
+  version: 4.1.4
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-10 00:00:00.000000000 Z
+date: 2021-01-15 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.0.0
+        version: 4.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.1.2
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -63,13 +63,13 @@ files:
 - lib/sentry/rails/active_job.rb
 - lib/sentry/rails/backtrace_cleaner.rb
 - lib/sentry/rails/breadcrumb/active_support_logger.rb
-- lib/sentry/rails/capture_exception.rb
+- lib/sentry/rails/capture_exceptions.rb
 - 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/capture_exception.rb

@@ -1,9 +0,0 @@
-module Sentry
-  module Rails
-    class CaptureException < Sentry::Rack::CaptureException
-      def collect_exception(env)
-        super || env["action_dispatch.exception"]
-      end
-    end
-  end
-end

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