sentry-rails 4.1.2 → 4.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d6a1afa9da4c0ec517f7cf0b494f7965f9d6b30450ed005face3d28d541430e
-  data.tar.gz: 21a9be637731b712e430eee4652a3b98d7eef0475c7027833172b2dfb8a414fd
+  metadata.gz: 1e101fa2f42e1bf68db025a8c02a391ee510cfb43d286c63156397efcbcc1f6a
+  data.tar.gz: 8673fc2ff559d18b09c41b05e373116feb1ae7b04cbe4de5f99637afaf05c8da
 SHA512:
-  metadata.gz: 8d9c22704d42808bb82104540524468e696da6e24340b6e79216c1dfd0510a8e30099915fb9502c676ecc4f399d7bf29c48468708e2b29a2b9b656a771c8264d
-  data.tar.gz: 4eaff646e0096e0221c4389ff65ce50cd80a8ed4c03673718c1a5990b7a02f5d4639dffcb02a8622bc5f1f5b563c8c0dcaad8af77a72577d577c1744c81529a5
+  metadata.gz: 156a36ae19a647b1b17e4278108296356339363f659d714b24dfcc095c14d59ae01ef85bc08c0c1a3331e401522bd7130214432a2a931f40fdeedff0ef6a0bcb
+  data.tar.gz: 897b9c2f0d82266b2725cbbd30bd8478fda5e1c3dae80927e6e3f73917d8ab417066c1be545b552a39d1ed6560f5ca8c16e0247cbf3199d3cabe110f41cd175c

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## 4.1.7
+
+- Use env to carry original transaction name [#1255](https://github.com/getsentry/sentry-ruby/pull/1255)
+- Fix duration of tracing event in Rails 5 [#1254](https://github.com/getsentry/sentry-ruby/pull/1254) (by @abcang)
+- Filter out static file transaction [#1247](https://github.com/getsentry/sentry-ruby/pull/1247)
+
+## 4.1.6
+
+- Prevent exceptions app from overriding event's transaction name [#1230](https://github.com/getsentry/sentry-ruby/pull/1230)
+- Fix project root detection [#1242](https://github.com/getsentry/sentry-ruby/pull/1242)
+- Use sentry-ruby-core as the main SDK dependency [#1244](https://github.com/getsentry/sentry-ruby/pull/1244)
+
+## 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)

data/Gemfile

@@ -11,6 +11,7 @@ gem "jdbc-sqlite3", platform: :jruby
 gem "sqlite3", platform: :ruby
 
 gem "rails", "~> #{rails_version}"
+gem "sprockets-rails"
 gem "rspec-rails", "~> 4.0"
 gem "codecov", "0.2.12"
 

data/Makefile

@@ -0,0 +1,3 @@
+build:
+	bundle install
+	gem build sentry-rails.gemspec

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/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

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,6 +1,14 @@
 module Sentry
   module Rails
     class CaptureExceptions < Sentry::Rack::CaptureExceptions
+      def initialize(app)
+        super
+
+        if defined?(::Sprockets::Rails)
+          @assets_regex = %r(\A/{0,2}#{::Rails.application.config.assets.prefix})
+        end
+      end
+
       private
 
       def collect_exception(env)
@@ -12,8 +20,21 @@ module Sentry
       end
 
       def capture_exception(exception)
+        current_scope = Sentry.get_current_scope
+
+        if original_transaction = current_scope.rack_env["sentry.original_transaction"]
+          current_scope.set_transaction_name(original_transaction)
+        end
+
         Sentry::Rails.capture_exception(exception)
       end
+
+      def finish_span(span, status_code)
+        if @assets_regex.nil? || !span.name.match?(@assets_regex)
+          span.set_http_status(status_code)
+          span.finish
+        end
+      end
     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/overrides/file_handler.rb

@@ -0,0 +1,16 @@
+module Sentry
+  module Rails
+    module Overrides
+      module FileHandler
+        def serve(*args)
+          if Sentry.initialized? && current_transaction = Sentry.get_current_scope.span
+            # we don't want to expose a setter for @sampled just for this case
+            current_transaction.instance_variable_set(:@sampled, false)
+          end
+
+          super
+        end
+      end
+    end
+  end
+end

data/lib/sentry/rails/railtie.rb

@@ -4,8 +4,8 @@ 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"
+require "sentry/rails/overrides/file_handler"
 
 module Sentry
   class Railtie < ::Rails::Railtie
@@ -17,23 +17,30 @@ module Sentry
       app.config.middleware.use(Sentry::Rails::RescuedExceptionInterceptor)
     end
 
-    config.after_initialize do
+    config.after_initialize do |app|
       next unless Sentry.initialized?
 
+      configure_project_root
       configure_sentry_logger
       extend_controller_methods
-      extend_active_job
+      extend_active_job if defined?(ActiveJob)
       override_streaming_reporter
+      override_file_handler if app.config.public_file_server.enabled
       setup_backtrace_cleanup_callback
       inject_breadcrumbs_logger
       activate_tracing
     end
 
+    def configure_project_root
+      Sentry.configuration.project_root = ::Rails.root.to_s
+    end
+
     def configure_sentry_logger
       Sentry.configuration.logger = ::Rails.logger
     end
 
     def extend_active_job
+      require "sentry/rails/active_job"
       ActiveJob::Base.send(:prepend, Sentry::Rails::ActiveJobExtensions)
     end
 
@@ -66,6 +73,12 @@ module Sentry
       end
     end
 
+    def override_file_handler
+      ActiveSupport.on_load :action_controller do
+        ActionDispatch::FileHandler.send(:prepend, Sentry::Rails::Overrides::FileHandler)
+      end
+    end
+
     def activate_tracing
       if Sentry.configuration.tracing_enabled?
         Sentry::Rails::Tracing.subscribe_tracing_events

data/lib/sentry/rails/rescued_exception_interceptor.rb

@@ -6,9 +6,22 @@ module Sentry
       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
+            copied_env = scope.rack_env.dup
+            copied_env["sentry.original_transaction"] = scope.transaction_name
+            scope.set_rack_env(copied_env)
+          end
+
           env["sentry.rescued_exception"] = e if Sentry.configuration.rails.report_rescued_exceptions
           raise e
         end

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

@@ -14,11 +14,11 @@ module Sentry
 
           def subscribe_to_event(event_name)
             if ::Rails.version.to_i == 5
-              ActiveSupport::Notifications.subscribe(event_name) do |_, start, finish, _, payload|
+              ActiveSupport::Notifications.subscribe(event_name) do |*args|
                 next unless Tracing.get_current_transaction
 
-                duration = finish.to_f - start.to_f
-                yield(event_name, duration, payload)
+                event = ActiveSupport::Notifications::Event.new(*args)
+                yield(event_name, event.duration, event.payload)
               end
             else
               ActiveSupport::Notifications.subscribe(event_name) do |event|

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.2"
+    VERSION = "4.1.7"
   end
 end

data/sentry-rails.gemspec

@@ -16,12 +16,12 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/sentry-rails/CHANGELOG.md"
 
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rails", ">= 5.0"
-  spec.add_dependency "sentry-ruby", "~> 4.1.2"
+  spec.add_dependency "sentry-ruby-core", "~> 4.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.1.7
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2021-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: sentry-ruby
+  name: sentry-ruby-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -49,11 +49,11 @@ files:
 - ".craft.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
 - bin/console
@@ -67,6 +67,7 @@ files:
 - lib/sentry/rails/configuration.rb
 - lib/sentry/rails/controller_methods.rb
 - lib/sentry/rails/controller_transaction.rb
+- lib/sentry/rails/overrides/file_handler.rb
 - lib/sentry/rails/overrides/streaming_reporter.rb
 - lib/sentry/rails/railtie.rb
 - lib/sentry/rails/rescued_exception_interceptor.rb
@@ -83,7 +84,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/getsentry/sentry-ruby
   source_code_uri: https://github.com/getsentry/sentry-ruby
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/master/sentry-rails/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.5
-before_install: gem install bundler -v 2.1.1