sentry-rails 5.9.0 → 5.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93209fe5a0b0e76d0260c3355410492f36d8d72ef4f4852b4345d80656eb9dc6
-  data.tar.gz: e67e804834d28db4c5237757caffded4856d6a9594f337b2412e76c874a1cd58
+  metadata.gz: 39ae75bb0a992ced9247272ab6d20ff61aee51ee2a9a02f309204fb01533aae3
+  data.tar.gz: 6a00192e48a695c90ed994ccdb40cc4def17c1263c1c469d2c7daac5f933607b
 SHA512:
-  metadata.gz: eadf2d1e97b5ab7a6abf9fdc03609bf1c362e1ebba96b369f895c04a8d8341acbb2d3f121c1d03420fbcb32083abc1a07489a1f1b12b02c99b8b4c8bebfdbd41
-  data.tar.gz: 1c71775f931fd3b08a7dc1567a3baff47d6c56a128f34e5eb8ab42be9c1b89fae3e2201feba4e495e09e1fb8a343039ce4be3ccdc88bcea9ed63c6b024366a06
+  metadata.gz: a99466d8bbab1261f08b0bdf2a1394e5dfb473fc53e9f4af91fb67411ef668c2e49c26496be127a7e2f5350c4d745388eddb0f357963caafe966a77cc8ce3028
+  data.tar.gz: 33f3d414890890cda3529d8f21f916f74db743ce466b8fc7f70a1529a659d1be6360f6e98097ddf30ea896c8d85c497acd2e73c1831d1025fcc669f56f6562e5

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,22 @@ 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
+
+  if rails_version == Gem::Version.new("6.0.0") && RUBY_VERSION.to_f == 2.7
+    gem "irb", "~> 1.7.4"   # irb 1.8 adds psych via rdoc that causes CI to fail
+  else
+    gem "irb"
+  end
+end
+
 gem "pry"
 
 gem "benchmark-ips"

data/lib/sentry/rails/action_cable.rb

@@ -33,11 +33,8 @@ module Sentry
           end
 
           def start_transaction(env, scope)
-            sentry_trace = env["HTTP_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
+            transaction = Sentry.continue_trace(env, **options)
             Sentry.start_transaction(transaction: transaction, **options)
           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,6 +1,8 @@
 module Sentry
   module Rails
     class CaptureExceptions < Sentry::Rack::CaptureExceptions
+      RAILS_7_1 = Gem::Version.new(::Rails.version) >= Gem::Version.new("7.1.0.alpha")
+
       def initialize(_)
         super
 
@@ -21,28 +23,34 @@ module Sentry
       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
+        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
         end
       end
 
       def start_transaction(env, scope)
-        sentry_trace = env["HTTP_SENTRY_TRACE"]
-        baggage = env["HTTP_BAGGAGE"]
-
         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, baggage: baggage, **options) if sentry_trace
+        transaction = Sentry.continue_trace(env, **options)
         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

@@ -12,7 +12,7 @@ module Sentry
       @excluded_exceptions = @excluded_exceptions.concat(Sentry::Rails::IGNORE_DEFAULT)
 
       if ::Rails.logger
-        @logger = ::Rails.logger
+        @logger = ::Rails.logger.dup
       else
         @logger.warn(Sentry::LOGGER_PROGNAME) do
           <<~MSG

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

@@ -13,8 +13,31 @@ module Sentry
             next if EXCLUDED_EVENTS.include? payload[:name]
 
             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
+
+              connection = payload[:connection]
+
+              if payload[:connection_id]
+                span.set_data(:connection_id, payload[:connection_id])
+
+                # we fallback to the base connection on rails < 6.0.0 since the payload doesn't have it
+                base_connection = ActiveRecord::Base.connection
+                connection ||= base_connection if payload[:connection_id] == base_connection.object_id
+              end
+
+              next unless connection
+
+              db_config = if connection.pool.respond_to?(:db_config)
+                            connection.pool.db_config.configuration_hash
+                          elsif connection.pool.respond_to?(:spec)
+                            connection.pool.spec.config
+                          end
+
+              span.set_data(Span::DataConventions::DB_SYSTEM, db_config[:adapter]) if db_config[:adapter]
+              span.set_data(Span::DataConventions::DB_NAME, db_config[:database]) if db_config[:database]
+              span.set_data(Span::DataConventions::SERVER_ADDRESS, db_config[:host]) if db_config[:host]
+              span.set_data(Span::DataConventions::SERVER_PORT, db_config[:port]) if db_config[:port]
+              span.set_data(Span::DataConventions::SERVER_SOCKET_ADDRESS, db_config[:socket]) if db_config[:socket]
             end
           end
         end

data/lib/sentry/rails/version.rb

@@ -1,5 +1,5 @@
 module Sentry
   module Rails
-    VERSION = "5.9.0"
+    VERSION = "5.11.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.9.0"
+  spec.add_dependency "sentry-ruby", "~> 5.11.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 5.9.0
+  version: 5.11.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-19 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.9.0
+        version: 5.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.9.0
+        version: 5.11.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/