sentry-rails 5.4.2 → 5.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92b1952096935f672e03a41883297d867b70e433c92434b24420062c37d2325f
-  data.tar.gz: 3cdfb19c85436bdc509e00512734fe6eb11880bdbe22ef50e6d99908f38daf16
+  metadata.gz: 7eadae379dbfc72a3685f48b7379a52c1fea827eb4c57d1eba6565f87cad406f
+  data.tar.gz: 81a628792cffda07caed69c4fc5191c77f27da32cfe70226bfac3aeda3951c33
 SHA512:
-  metadata.gz: 2271053cd6e6d9f04ba55258d177347f8df8ce74d6c15bdb3083eef6cc3cd1b8f4847c448071c8e03b33d90498acc04f384c4cfe3730c792af046a1860a76a53
-  data.tar.gz: 345700856d420c3e562201cedb88d18d396d4f60487bb945f262bffba028ca7f9b12aa481deeebad7607e8f9baa0c4db30308d97a856b45bd7fd0e3f75e06258
+  metadata.gz: 0b8575d57dd6be491b3221c40a62864ac183a26274717f122a67d61300f093ff215e38ad182a301db9cc0f57e1d3a257e564bb845aca86429b96574baf901c2a
+  data.tar.gz: 68e82698caa67fb3d5d7643e86379015dde236ffd38de7a560af0e207d48928643becc8918b7f4aa48cf533c849b4b6f3496f3cc9513f61408545e80e8811212

data/Gemfile

@@ -5,13 +5,15 @@ git_source(:github) { |name| "https://github.com/#{name}.git" }
 gemspec
 gem "sentry-ruby", path: "../sentry-ruby"
 
+platform :jruby do
+  gem 'activerecord-jdbcmysql-adapter'
+  gem "jdbc-sqlite3"
+end
+
 rails_version = ENV["RAILS_VERSION"]
 rails_version = "7.0.0" if rails_version.nil?
 rails_version = Gem::Version.new(rails_version)
 
-gem 'activerecord-jdbcmysql-adapter', platform: :jruby
-gem "jdbc-sqlite3", platform: :jruby
-
 if rails_version < Gem::Version.new("6.0.0")
   gem "sqlite3", "~> 1.3.0", platform: :ruby
 else
@@ -37,10 +39,17 @@ gem 'simplecov'
 gem "simplecov-cobertura", "~> 1.4"
 gem "rexml"
 
+# https://github.com/flavorjones/loofah/pull/267
+# loofah changed the required ruby version in a patch so we need to explicitly pin it
+gem "loofah", "2.20.0" if RUBY_VERSION.to_f < 2.5
+
 gem "rake", "~> 12.0"
 
-gem "object_tracer"
-gem "debug", github: "ruby/debug", platform: :ruby if RUBY_VERSION.to_f >= 2.6
+if RUBY_VERSION.to_f >= 2.6
+  gem "debug", github: "ruby/debug", platform: :ruby
+  gem "irb"
+end
+
 gem "pry"
 
 gem "benchmark-ips"

data/lib/sentry/rails/action_cable.rb

@@ -2,6 +2,8 @@ module Sentry
   module Rails
     module ActionCableExtensions
       class ErrorHandler
+        OP_NAME = "websocket.server".freeze
+
         class << self
           def capture(connection, transaction_name:, extra_context: nil, &block)
             return block.call unless Sentry.initialized?
@@ -13,13 +15,14 @@ module Sentry
             Sentry.with_scope do |scope|
               scope.set_rack_env(env)
               scope.set_context("action_cable", extra_context) if extra_context
-              scope.set_transaction_name(transaction_name)
-              transaction = start_transaction(env, scope.transaction_name)
+              scope.set_transaction_name(transaction_name, source: :view)
+              transaction = start_transaction(env, scope)
               scope.set_span(transaction) if transaction
 
               begin
-                block.call
+                result = block.call
                 finish_transaction(transaction, 200)
+                result
               rescue Exception => e # rubocop:disable Lint/RescueException
                 Sentry::Rails.capture_exception(e)
                 finish_transaction(transaction, 500)
@@ -29,10 +32,12 @@ module Sentry
             end
           end
 
-          def start_transaction(env, transaction_name)
+          def start_transaction(env, scope)
             sentry_trace = env["HTTP_SENTRY_TRACE"]
-            options = { name: transaction_name, op: "rails.action_cable".freeze }
-            transaction = Sentry::Transaction.from_sentry_trace(sentry_trace, **options) if sentry_trace
+            baggage = env["HTTP_BAGGAGE"]
+
+            options = { name: scope.transaction_name, source: scope.transaction_source, op: OP_NAME }
+            transaction = Sentry::Transaction.from_sentry_trace(sentry_trace, baggage: baggage, **options) if sentry_trace
             Sentry.start_transaction(transaction: transaction, **options)
           end
 

data/lib/sentry/rails/active_job.rb

@@ -16,16 +16,18 @@ module Sentry
       end
 
       class SentryReporter
+        OP_NAME = "queue.active_job".freeze
+
         class << self
           def record(job, &block)
             Sentry.with_scope do |scope|
               begin
-                scope.set_transaction_name(job.class.name)
+                scope.set_transaction_name(job.class.name, source: :task)
                 transaction =
                   if job.is_a?(::Sentry::SendEventJob)
                     nil
                   else
-                    Sentry.start_transaction(name: scope.transaction_name, op: "active_job")
+                    Sentry.start_transaction(name: scope.transaction_name, source: scope.transaction_source, op: OP_NAME)
                   end
 
                 scope.set_span(transaction) if transaction

data/lib/sentry/rails/background_worker.rb

@@ -3,8 +3,11 @@ module Sentry
     def _perform(&block)
       block.call
     ensure
-      # make sure the background worker returns AR connection if it accidentally acquire one during serialization
-      ActiveRecord::Base.connection_pool.release_connection
+      # some applications have partial or even no AR connection
+      if ActiveRecord::Base.connected?
+        # make sure the background worker returns AR connection if it accidentally acquire one during serialization
+        ActiveRecord::Base.connection_pool.release_connection
+      end
     end
   end
 end

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

@@ -1,20 +1,76 @@
-require "sentry/rails/instrument_payload_cleanup_helper"
-
 module Sentry
   module Rails
     module Breadcrumb
       module ActiveSupportLogger
-        class << self
-          include InstrumentPayloadCleanupHelper
+        ALLOWED_LIST = {
+          # action_controller
+          "write_fragment.action_controller" => %i[key],
+          "read_fragment.action_controller" => %i[key],
+          "exist_fragment?.action_controller" => %i[key],
+          "expire_fragment.action_controller" => %i[key],
+          "start_processing.action_controller" => %i[controller action params format method path],
+          "process_action.action_controller" => %i[controller action params format method path status view_runtime db_runtime],
+          "send_file.action_controller" => %i[path],
+          "redirect_to.action_controller" => %i[status location],
+          "halted_callback.action_controller" => %i[filter],
+          # action_dispatch
+          "process_middleware.action_dispatch" => %i[middleware],
+          # action_view
+          "render_template.action_view" => %i[identifier layout],
+          "render_partial.action_view" => %i[identifier],
+          "render_collection.action_view" => %i[identifier count cache_hits],
+          "render_layout.action_view" => %i[identifier],
+          # active_record
+          "sql.active_record" => %i[sql name statement_name cached],
+          "instantiation.active_record" => %i[record_count class_name],
+          # action_mailer
+          # not including to, from, or subject..etc. because of PII concern
+          "deliver.action_mailer" => %i[mailer date perform_deliveries],
+          "process.action_mailer" => %i[mailer action params],
+          # active_support
+          "cache_read.active_support" => %i[key store hit],
+          "cache_generate.active_support" => %i[key store],
+          "cache_fetch_hit.active_support" => %i[key store],
+          "cache_write.active_support" => %i[key store],
+          "cache_delete.active_support" => %i[key store],
+          "cache_exist?.active_support" => %i[key store],
+          # active_job
+          "enqueue_at.active_job" => %i[],
+          "enqueue.active_job" => %i[],
+          "enqueue_retry.active_job" => %i[],
+          "perform_start.active_job" => %i[],
+          "perform.active_job" => %i[],
+          "retry_stopped.active_job" => %i[],
+          "discard.active_job" => %i[],
+          # action_cable
+          "perform_action.action_cable" => %i[channel_class action],
+          "transmit.action_cable" => %i[channel_class],
+          "transmit_subscription_confirmation.action_cable" => %i[channel_class],
+          "transmit_subscription_rejection.action_cable" => %i[channel_class],
+          "broadcast.action_cable" => %i[broadcasting],
+          # active_storage
+          "service_upload.active_storage" => %i[service key checksum],
+          "service_streaming_download.active_storage" => %i[service key],
+          "service_download_chunk.active_storage" => %i[service key],
+          "service_download.active_storage" => %i[service key],
+          "service_delete.active_storage" => %i[service key],
+          "service_delete_prefixed.active_storage" => %i[service prefix],
+          "service_exist.active_storage" => %i[service key exist],
+          "service_url.active_storage" => %i[service key url],
+          "service_update_metadata.active_storage" => %i[service key],
+          "preview.active_storage" => %i[key],
+          "analyze.active_storage" => %i[analyzer],
+        }.freeze
 
+        class << self
           def add(name, started, _finished, _unique_id, data)
             # skip Rails' internal events
             return if name.start_with?("!")
 
+            allowed_keys = ALLOWED_LIST[name]
+
             if data.is_a?(Hash)
-              # we should only mutate the copy of the data
-              data = data.dup
-              cleanup_data(data)
+              data = data.slice(*allowed_keys)
             end
 
             crumb = Sentry::Breadcrumb.new(

data/lib/sentry/rails/capture_exceptions.rb

@@ -1,11 +1,13 @@
 module Sentry
   module Rails
     class CaptureExceptions < Sentry::Rack::CaptureExceptions
-      def initialize(app)
+      RAILS_7_1 = Gem::Version.new(::Rails.version) >= Gem::Version.new("7.1.0.alpha")
+
+      def initialize(_)
         super
 
-        if defined?(::Sprockets::Rails)
-          @assets_regex = %r(\A/{0,2}#{::Rails.application.config.assets.prefix})
+        if Sentry.initialized?
+          @assets_regexp = Sentry.configuration.rails.assets_regexp
         end
       end
 
@@ -17,20 +19,12 @@ module Sentry
       end
 
       def transaction_op
-        "rails.request".freeze
+        "http.server".freeze
       end
 
       def capture_exception(exception, env)
-        request = ActionDispatch::Request.new(env)
-
         # the exception will be swallowed by ShowExceptions middleware
-        return if request.show_exceptions? && !Sentry.configuration.rails.report_rescued_exceptions
-
-        current_scope = Sentry.get_current_scope
-
-        if original_transaction = env["sentry.original_transaction"]
-          current_scope.set_transaction_name(original_transaction)
-        end
+        return if show_exceptions?(exception, env) && !Sentry.configuration.rails.report_rescued_exceptions
 
         Sentry::Rails.capture_exception(exception).tap do |event|
           env[ERROR_EVENT_ID_KEY] = event.event_id if event
@@ -39,15 +33,27 @@ module Sentry
 
       def start_transaction(env, scope)
         sentry_trace = env["HTTP_SENTRY_TRACE"]
-        options = { name: scope.transaction_name, op: transaction_op }
+        baggage = env["HTTP_BAGGAGE"]
 
-        if @assets_regex && scope.transaction_name.match?(@assets_regex)
+        options = { name: scope.transaction_name, source: scope.transaction_source, op: transaction_op }
+
+        if @assets_regexp && scope.transaction_name.match?(@assets_regexp)
           options.merge!(sampled: false)
         end
 
-        transaction = Sentry::Transaction.from_sentry_trace(sentry_trace, **options) if sentry_trace
+        transaction = Sentry::Transaction.from_sentry_trace(sentry_trace, baggage: baggage, **options) if sentry_trace
         Sentry.start_transaction(transaction: transaction, custom_sampling_context: { env: env }, **options)
       end
+
+      def show_exceptions?(exception, env)
+        request = ActionDispatch::Request.new(env)
+
+        if RAILS_7_1
+          ActionDispatch::ExceptionWrapper.new(nil, exception).show?(request)
+        else
+          request.show_exceptions?
+        end
+      end
     end
   end
 end

data/lib/sentry/rails/configuration.rb

@@ -60,12 +60,29 @@ module Sentry
 
       attr_accessor :tracing_subscribers
 
+      # sentry-rails by default skips asset request' transactions by checking if the path matches
+      #
+      # ```rb
+      # %r(\A/{0,2}#{::Rails.application.config.assets.prefix})
+      # ```
+      #
+      # If you want to use a different pattern, you can configure the `assets_regexp` option like:
+      #
+      # ```rb
+      # Sentry.init do |config|
+      #   config.rails.assets_regexp = /my_regexp/
+      # end
+      # ```
+      attr_accessor :assets_regexp
+
       def initialize
         @register_error_subscriber = false
         @report_rescued_exceptions = true
         @skippable_job_adapters = []
+        @assets_regexp = if defined?(::Sprockets::Rails)
+          %r(\A/{0,2}#{::Rails.application.config.assets.prefix})
+        end
         @tracing_subscribers = Set.new([
-          Sentry::Rails::Tracing::ActionControllerSubscriber,
           Sentry::Rails::Tracing::ActionViewSubscriber,
           Sentry::Rails::Tracing::ActiveRecordSubscriber,
           Sentry::Rails::Tracing::ActiveStorageSubscriber

data/lib/sentry/rails/controller_transaction.rb

@@ -2,8 +2,34 @@ module Sentry
   module Rails
     module ControllerTransaction
       def self.included(base)
-        base.prepend_before_action do |controller|
-          Sentry.get_current_scope.set_transaction_name("#{controller.class}##{controller.action_name}")
+        base.prepend_around_action(:sentry_around_action)
+      end
+
+      private
+
+      def sentry_around_action
+        if Sentry.initialized?
+          transaction_name = "#{self.class}##{action_name}"
+          Sentry.get_current_scope.set_transaction_name(transaction_name, source: :view)
+          Sentry.with_child_span(op: "view.process_action.action_controller", description: transaction_name) do |child_span|
+            if child_span
+              begin
+                result = yield
+              ensure
+                child_span.set_http_status(response.status)
+                child_span.set_data(:format, request.format)
+                child_span.set_data(:method, request.method)
+                child_span.set_data(:path, request.path)
+                child_span.set_data(:params, request.params)
+              end
+
+              result
+            else
+              yield
+            end
+          end
+        else
+          yield
         end
       end
     end

data/lib/sentry/rails/error_subscriber.rb

@@ -1,7 +1,8 @@
 module Sentry
   module Rails
     # This is not a user-facing class. You should use it with Rails 7.0's error reporter feature and its interfaces.
-    # See https://github.com/rails/rails/blob/main/activesupport/lib/active_support/error_reporter.rb for more information.
+    # See https://github.com/rails/rails/blob/main/activesupport/lib/active_support/error_reporter.rb to learn more about reporting APIs.
+    # If you want Sentry to subscribe to the error reporter, please set `config.rails.register_error_subscriber` to `true`.
     class ErrorSubscriber
       SKIP_SOURCES = Regexp.union([/.*_cache_store.active_support/])
 
@@ -13,6 +14,11 @@ module Sentry
           tags[:source] = source
         end
 
+        if context[:tags].is_a?(Hash)
+          context = context.dup
+          tags.merge!(context.delete(:tags))
+        end
+
         Sentry::Rails.capture_exception(error, level: severity, contexts: { "rails.error" => context }, tags: tags)
       end
     end

data/lib/sentry/rails/railtie.rb

@@ -56,7 +56,9 @@ module Sentry
 
       at_exit do
         # TODO: Add a condition for Rails 7.1 to avoid confliction with https://github.com/rails/rails/pull/44999
-        Sentry::Rails.capture_exception($ERROR_INFO, tags: { source: "runner" }) if $ERROR_INFO
+        if $ERROR_INFO && !($ERROR_INFO.is_a?(SystemExit) && $ERROR_INFO.success?)
+          Sentry::Rails.capture_exception($ERROR_INFO, tags: { source: "runner" })
+        end
       end
     end
 
@@ -115,7 +117,7 @@ module Sentry
     end
 
     def activate_tracing
-      if Sentry.configuration.tracing_enabled?
+      if Sentry.configuration.tracing_enabled? && Sentry.configuration.instrumenter == :sentry
         subscribers = Sentry.configuration.rails.tracing_subscribers
         Sentry::Rails::Tracing.register_subscribers(subscribers)
         Sentry::Rails::Tracing.subscribe_tracing_events

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

@@ -8,14 +8,20 @@ module Sentry
         extend InstrumentPayloadCleanupHelper
 
         EVENT_NAMES = ["process_action.action_controller"].freeze
+        OP_NAME = "view.process_action.action_controller".freeze
 
         def self.subscribe!
+          Sentry.logger.warn <<~MSG
+            DEPRECATION WARNING: sentry-rails has changed its approach on controller span recording and #{self.name} is now depreacted.
+            Please stop using or referencing #{self.name} as it will be removed in the next major release.
+          MSG
+
           subscribe_to_event(EVENT_NAMES) do |event_name, duration, payload|
             controller = payload[:controller]
             action = payload[:action]
 
             record_on_current_span(
-              op: event_name,
+              op: OP_NAME,
               start_timestamp: payload[START_TIMESTAMP_NAME],
               description: "#{controller}##{action}",
               duration: duration

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

@@ -14,6 +14,7 @@ module Sentry
 
             record_on_current_span(op: SPAN_PREFIX + event_name, start_timestamp: payload[START_TIMESTAMP_NAME], description: payload[:sql], duration: duration) do |span|
               span.set_data(:connection_id, payload[:connection_id])
+              span.set_tag(:cached, true) if payload.fetch(:cached, false) # cached key is only set for hits in the QueryCache, from Rails 5.1
             end
           end
         end

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

@@ -21,7 +21,7 @@ module Sentry
 
         def self.subscribe!
           subscribe_to_event(EVENT_NAMES) do |event_name, duration, payload|
-            record_on_current_span(op: event_name, start_timestamp: payload[START_TIMESTAMP_NAME], description: payload[:service], duration: duration) do |span|
+            record_on_current_span(op: "file.#{event_name}".freeze, start_timestamp: payload[START_TIMESTAMP_NAME], description: payload[:service], duration: duration) do |span|
               payload.each do |key, value|
                 span.set_data(key, value) unless key == START_TIMESTAMP_NAME
               end

data/lib/sentry/rails/tracing.rb

@@ -67,7 +67,7 @@ module Sentry
       end
 
       def self.get_current_transaction
-        Sentry.get_current_scope.get_transaction
+        Sentry.get_current_scope.get_transaction if Sentry.initialized?
       end
 
       # it's just a container for the extended method

data/lib/sentry/rails/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Rails
-    VERSION = "5.4.2"
+    VERSION = "5.10.0"
   end
 end

data/sentry-rails.gemspec

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 5.4.2
+  version: 5.10.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-17 00:00:00.000000000 Z
+date: 2023-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.4.2
+        version: 5.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.4.2
+        version: 5.10.0
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -49,7 +49,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - Makefile

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at stan001212@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [https://contributor-covenant.org/version/1/4][version]
-
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/