sentry-rails 4.1.5 → 4.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea1c3fea4d0f1f017e5b56786e85414e459a181e8e4cebe2a45374b6c3e648dc
-  data.tar.gz: b41da6b3dc3a3a7836ed533029821b4f53dc40e8b7cb0d10023a52af13236218
+  metadata.gz: e22a278e6c74ad09c754d5270c227c1dd0989c90654d2f3f55d3ca06e06ad577
+  data.tar.gz: c3bed6941cf8abdc306d20fd6ef7ebcecf08bb246b05921002423ac984a20d2b
 SHA512:
-  metadata.gz: 359b3757908046fa6dfde636715b598a6977c3a131b11e4a7f8d8df3666246e867867ca3c32161bbb645fe9bc0110c50efac415ed42b4db754e21cf36878af86
-  data.tar.gz: 4605d701de78b04adc04c74dc7b7dd1a1e02c1d500a663965d4ba9de35cf35db4a70331d21afd2b2c07a5c2917d2ccb0e2b7a7cced8f5026188e189cf119ecdb
+  metadata.gz: bdda28d73217516a73ffdf82ddc81687649255623a38ebcd3f9aa52d98bdf6ced7882a13c1d9dae8509eda5e1bc82a99c2762c8c5e89cd27153a98e81ba7d691
+  data.tar.gz: 396aaacdf3db30251891de7bf4c5e6e5c27f5ce69eb6c9fc157f5fc70dada5c4fa782dac0dcf6050c6a8cf2474f680d801f4a7dac555b20f990aca077e8cfbc9

data/CHANGELOG.md

@@ -1,5 +1,65 @@
 # Changelog
 
+## 4.2.2
+
+- Always define Sentry::SendEventJob to avoid eager load issues [#1286](https://github.com/getsentry/sentry-ruby/pull/1286)
+  - Fixes [#1283](https://github.com/getsentry/sentry-ruby/issues/1283)
+
+## 4.2.1
+
+- Add additional checks to SendEventJob's definition [#1275](https://github.com/getsentry/sentry-ruby/pull/1275)
+  - Fixes [#1270](https://github.com/getsentry/sentry-ruby/issues/1270)
+  - Fixes [#1277](https://github.com/getsentry/sentry-ruby/issues/1277)
+
+## 4.2.0
+
+### Features
+
+- Make sentry-rails a Rails engine and provide default job class for async [#1181](https://github.com/getsentry/sentry-ruby/pull/1181)
+
+`sentry-rails` now provides a default ActiveJob class for sending events asynchronously. You can use it directly without define your own one:
+
+```ruby
+config.async = lambda { |event, hint| Sentry::SendEventJob.perform_later(event, hint) }
+```
+
+- Add configuration option for trusted proxies [#1126](https://github.com/getsentry/sentry-ruby/pull/1126)
+
+`sentry-rails` now injects `Rails.application.config.action_dispatch.trusted_proxies` into `Sentry.configuration.trusted_proxies` automatically.
+
+- Allow users to configure ActiveJob adapters to ignore [#1256](https://github.com/getsentry/sentry-ruby/pull/1256)
+
+```ruby
+# sentry-rails will skip active_job reporting for jobs that use ActiveJob::QueueAdapters::SidekiqAdapter
+# you should use this option when:
+# - you don't want to see events from a certain adapter
+# - you already have a better reporting setup for the adapter (like having `sentry-sidekiq` installed)
+config.rails.skippable_job_adapters = ["ActiveJob::QueueAdapters::SidekiqAdapter"]
+```
+
+- Tag `job_id` and `provider_job_id` on ActiveJob events [#1259](https://github.com/getsentry/sentry-ruby/pull/1259)
+
+<img width="1330" alt="example of tagged event" src="https://user-images.githubusercontent.com/5079556/106389781-3a03f100-6420-11eb-810c-a99869eb26dd.png">
+
+- Use another method for post initialization callback [#1261](https://github.com/getsentry/sentry-ruby/pull/1261)
+
+### Bug Fixes
+
+- Inspect exception cause by default & don't exclude ActiveJob::DeserializationError [#1180](https://github.com/getsentry/sentry-ruby/pull/1180)
+  - Fixes [#1071](https://github.com/getsentry/sentry-ruby/issues/1071)
+
+## 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)
@@ -63,4 +123,3 @@ Release test
 ## 0.1.0
 
 First version
-

data/Gemfile

@@ -8,15 +8,24 @@ rails_version = "6.1.0" if rails_version.nil?
 
 gem 'activerecord-jdbcmysql-adapter', platform: :jruby
 gem "jdbc-sqlite3", platform: :jruby
-gem "sqlite3", platform: :ruby
+
+if rails_version.to_f < 6
+  gem "sqlite3", "~> 1.3.0", platform: :ruby
+else
+  gem "sqlite3", platform: :ruby
+end
 
 gem "rails", "~> #{rails_version}"
+gem "sprockets-rails"
 gem "rspec-rails", "~> 4.0"
 gem "codecov", "0.2.12"
 
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
 
+# TODO: Remove this if https://github.com/jruby/jruby/issues/6547 is addressed
+gem "i18n", "<= 1.8.7"
+
 gem "sidekiq"
 
 gem "sentry-ruby", path: "../sentry-ruby"

data/Makefile

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

data/app/jobs/sentry/send_event_job.rb

@@ -0,0 +1,34 @@
+if defined?(ActiveJob)
+  module Sentry
+    parent_job =
+      if defined?(::ApplicationJob) && ::ApplicationJob.ancestors.include?(::ActiveJob::Base)
+        ::ApplicationJob
+      else
+        ::ActiveJob::Base
+      end
+
+    class SendEventJob < parent_job
+      # the event argument is usually large and creates noise
+      self.log_arguments = false if respond_to?(:log_arguments=)
+
+      # this will prevent infinite loop when there's an issue deserializing SentryJob
+      if respond_to?(:discard_on)
+        discard_on ActiveJob::DeserializationError
+      else
+        # mimic what discard_on does for Rails 5.0
+        rescue_from ActiveJob::DeserializationError do
+          logger.error "Discarded #{self.class} due to a #{exception}. The original exception was #{error.cause.inspect}."
+        end
+      end
+
+      def perform(event, hint = {})
+        Sentry.send_event(event, hint)
+      end
+    end
+  end
+else
+  module Sentry
+    class SendEventJob; end
+  end
+end
+

data/lib/sentry/rails.rb

@@ -1,6 +1,7 @@
 require "sentry-ruby"
 require "sentry/integrable"
 require "sentry/rails/configuration"
+require "sentry/rails/engine"
 require "sentry/rails/railtie"
 require "sentry/rails/tracing"
 

data/lib/sentry/rails/active_job.rb

@@ -1,10 +1,6 @@
 module Sentry
   module Rails
     module ActiveJobExtensions
-      ALREADY_SUPPORTED_SENTRY_ADAPTERS = %w(
-        ActiveJob::QueueAdapters::SidekiqAdapter
-      ).freeze
-
       def self.included(base)
         base.class_eval do
           around_perform do |job, block|
@@ -29,28 +25,30 @@ module Sentry
         rescue_handler_result = rescue_with_handler(e)
         return rescue_handler_result if rescue_handler_result
 
-        Sentry::Rails.capture_exception(e, extra: sentry_context(job))
+        Sentry::Rails.capture_exception(
+          e,
+          extra: sentry_context(job),
+          tags: {
+            job_id: job.job_id,
+            provider_job_id: job.provider_job_id
+          }
+        )
         raise e
       end
 
       def already_supported_by_specific_integration?(job)
-        ALREADY_SUPPORTED_SENTRY_ADAPTERS.include?(job.class.queue_adapter.class.to_s)
+        Sentry.configuration.rails.skippable_job_adapters.include?(job.class.queue_adapter.class.to_s)
       end
 
       def sentry_context(job)
-        ctx = {
-          :active_job => job.class.name,
-          :arguments => job.arguments,
-          :scheduled_at => job.scheduled_at,
-          :job_id => job.job_id,
-          :locale => job.locale
+        {
+          active_job: job.class.name,
+          arguments: job.arguments,
+          scheduled_at: job.scheduled_at,
+          job_id: job.job_id,
+          provider_job_id: job.provider_job_id,
+          locale: job.locale
         }
-        # Add provider_job_id details if Rails 5
-        if job.respond_to?(:provider_job_id)
-          ctx[:provider_job_id] = job.provider_job_id
-        end
-
-        ctx
       end
     end
   end

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

@@ -2,7 +2,7 @@ module Sentry
   class Configuration
     attr_reader :rails
 
-    def post_initialization_callback
+    add_post_initialization_callback do
       @rails = Sentry::Rails::Configuration.new
       @excluded_exceptions = @excluded_exceptions.concat(Sentry::Rails::IGNORE_DEFAULT)
     end
@@ -23,7 +23,6 @@ module Sentry
       'ActionDispatch::Http::MimeNegotiation::InvalidType',
       'ActionController::UnknownHttpMethod',
       'ActionDispatch::Http::Parameters::ParseError',
-      'ActiveJob::DeserializationError', # Can cause infinite loops
       'ActiveRecord::RecordNotFound'
     ].freeze
     class Configuration
@@ -33,8 +32,14 @@ module Sentry
       # will report exceptions even when they are rescued by these middlewares.
       attr_accessor :report_rescued_exceptions
 
+      # Some adapters, like sidekiq, already have their own sentry integration.
+      # In those cases, we should skip ActiveJob's reporting to avoid duplicated reports.
+      attr_accessor :skippable_job_adapters
+
       def initialize
         @report_rescued_exceptions = true
+        # TODO: Remove this in 4.2.0
+        @skippable_job_adapters = []
       end
     end
   end

data/lib/sentry/rails/engine.rb

@@ -0,0 +1,5 @@
+module Sentry
+  class Engine < ::Rails::Engine
+    isolate_namespace Sentry
+  end
+end

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

@@ -5,6 +5,7 @@ require "sentry/rails/backtrace_cleaner"
 require "sentry/rails/controller_methods"
 require "sentry/rails/controller_transaction"
 require "sentry/rails/overrides/streaming_reporter"
+require "sentry/rails/overrides/file_handler"
 
 module Sentry
   class Railtie < ::Rails::Railtie
@@ -16,22 +17,33 @@ 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
+      configure_trusted_proxies
       extend_controller_methods
       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 configure_trusted_proxies
+      Sentry.configuration.trusted_proxies += Array(::Rails.application.config.action_dispatch.trusted_proxies)
+    end
+
     def extend_active_job
       require "sentry/rails/active_job"
       ActiveJob::Base.send(:prepend, Sentry::Rails::ActiveJobExtensions)
@@ -66,6 +78,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

@@ -17,7 +17,9 @@ module Sentry
           # 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)
+            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

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/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Rails
-    VERSION = "4.1.5"
+    VERSION = "4.2.2"
   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.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 4.1.5
+  version: 4.2.2
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-21 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -25,19 +25,19 @@ 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:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: 4.2.0
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -49,13 +49,14 @@ files:
 - ".craft.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
+- app/jobs/sentry/send_event_job.rb
 - bin/console
 - bin/setup
 - lib/sentry-rails.rb
@@ -67,6 +68,8 @@ files:
 - lib/sentry/rails/configuration.rb
 - lib/sentry/rails/controller_methods.rb
 - lib/sentry/rails/controller_transaction.rb
+- lib/sentry/rails/engine.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 +86,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