sentry-rails 5.11.0 → 5.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39ae75bb0a992ced9247272ab6d20ff61aee51ee2a9a02f309204fb01533aae3
-  data.tar.gz: 6a00192e48a695c90ed994ccdb40cc4def17c1263c1c469d2c7daac5f933607b
+  metadata.gz: 500c760aca4cc420df9f10a1bf920e3bd4dd03ff1667a80019b2660c95ad803b
+  data.tar.gz: 15aeba9d0fbd870fe8c562f7105df10f45ba8973f49f8fbf4b044b31f4711a43
 SHA512:
-  metadata.gz: a99466d8bbab1261f08b0bdf2a1394e5dfb473fc53e9f4af91fb67411ef668c2e49c26496be127a7e2f5350c4d745388eddb0f357963caafe966a77cc8ce3028
-  data.tar.gz: 33f3d414890890cda3529d8f21f916f74db743ce466b8fc7f70a1529a659d1be6360f6e98097ddf30ea896c8d85c497acd2e73c1831d1025fcc669f56f6562e5
+  metadata.gz: 6bb7d84aade0f54a4e77ebbf0f7e24d6bb41f7a0ea417e8e22d24542f2e5bb8c5c4480f029ef33602b3ebd67dd2a8af2fc3093460f669c4b89d51b964d8846a8
+  data.tar.gz: 2c7410b417f20976b18d85c9e08588be14523473d07481b6407670f9ba27358098fd543eca38bd87aff8ab053e13cffecc5431d4dab4af7639d28175805c6968

data/.gitignore

@@ -5,7 +5,7 @@
 /doc/
 /pkg/
 /spec/reports/
-/spec/dummy/test_rails_app/db
+/spec/dummy/test_rails_app/db*
 /tmp/
 
 # rspec failure tracking

data/Gemfile

@@ -11,7 +11,7 @@ platform :jruby do
 end
 
 rails_version = ENV["RAILS_VERSION"]
-rails_version = "7.0.0" if rails_version.nil?
+rails_version = "7.1.0" if rails_version.nil?
 rails_version = Gem::Version.new(rails_version)
 
 if rails_version < Gem::Version.new("6.0.0")
@@ -20,10 +20,13 @@ else
   gem "sqlite3", platform: :ruby
 end
 
-if rails_version > Gem::Version.new("7.0.0")
+if rails_version >= Gem::Version.new("7.2.0.alpha")
   gem "rails", github: "rails/rails"
+elsif rails_version >= Gem::Version.new("7.1.0")
+  gem "rails", "~> #{rails_version}"
 else
   gem "rails", "~> #{rails_version}"
+  gem "psych", "~> 3.0.0"
 end
 
 gem "mini_magick"
@@ -39,22 +42,25 @@ 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
+ruby_version = Gem::Version.new(RUBY_VERSION)
 
-gem "rake", "~> 12.0"
+if ruby_version < Gem::Version.new("2.5.0")
+  # 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"
+end
 
-if RUBY_VERSION.to_f >= 2.6
+if ruby_version >= Gem::Version.new("2.6.0")
   gem "debug", github: "ruby/debug", platform: :ruby
+  gem "irb"
 
-  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"
+  if ruby_version >= Gem::Version.new("3.0.0")
+    gem "ruby-lsp-rspec"
   end
 end
 
+gem "rake", "~> 12.0"
+
 gem "pry"
 
 gem "benchmark-ips"

data/README.md

@@ -11,7 +11,7 @@
 
 
 [![Gem Version](https://img.shields.io/gem/v/sentry-rails.svg)](https://rubygems.org/gems/sentry-rails)
-![Build Status](https://github.com/getsentry/sentry-ruby/workflows/sentry-rails%20Test/badge.svg)
+![Build Status](https://github.com/getsentry/sentry-ruby/actions/workflows/sentry_rails_test.yml/badge.svg)
 [![Coverage Status](https://img.shields.io/codecov/c/github/getsentry/sentry-ruby/master?logo=codecov)](https://codecov.io/gh/getsentry/sentry-ruby/branch/master)
 [![Gem](https://img.shields.io/gem/dt/sentry-rails.svg)](https://rubygems.org/gems/sentry-rails/)
 [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=sentry-rails&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=sentry-rails&package-manager=bundler&version-scheme=semver)

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

@@ -2,75 +2,13 @@ module Sentry
   module Rails
     module Breadcrumb
       module ActiveSupportLogger
-        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)
-              data = data.slice(*allowed_keys)
+              data = data.slice(*@allowed_keys[name])
             end
 
             crumb = Sentry::Breadcrumb.new(
@@ -81,7 +19,9 @@ module Sentry
             Sentry.add_breadcrumb(crumb)
           end
 
-          def inject
+          def inject(allowed_keys)
+            @allowed_keys = allowed_keys
+
             @subscriber = ::ActiveSupport::Notifications.subscribe(/.*/) do |name, started, finished, unique_id, data|
               # we only record events that has a started timestamp
               if started.is_a?(Time)

data/lib/sentry/rails/configuration.rb

@@ -12,7 +12,12 @@ module Sentry
       @excluded_exceptions = @excluded_exceptions.concat(Sentry::Rails::IGNORE_DEFAULT)
 
       if ::Rails.logger
-        @logger = ::Rails.logger.dup
+        if ::Rails.logger.respond_to?(:broadcasts)
+          dupped_broadcasts = ::Rails.logger.broadcasts.map(&:dup)
+          @logger = ::ActiveSupport::BroadcastLogger.new(*dupped_broadcasts)
+        else
+          @logger = ::Rails.logger.dup
+        end
       else
         @logger.warn(Sentry::LOGGER_PROGNAME) do
           <<~MSG
@@ -41,6 +46,67 @@ module Sentry
       'ActionDispatch::Http::Parameters::ParseError',
       'ActiveRecord::RecordNotFound'
     ].freeze
+
+    ACTIVE_SUPPORT_LOGGER_SUBSCRIPTION_ITEMS_DEFAULT = {
+      # 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 Configuration
       # Rails 7.0 introduced a new error reporter feature, which the SDK once opted-in by default.
       # But after receiving multiple issue reports, the integration seemed to cause serious troubles to some users.
@@ -75,6 +141,10 @@ module Sentry
       # ```
       attr_accessor :assets_regexp
 
+      # Hash of subscription items that will be shown in breadcrumbs active support logger.
+      # @return [Hash<String, Array<Symbol>>]
+      attr_accessor :active_support_logger_subscription_items
+
       def initialize
         @register_error_subscriber = false
         @report_rescued_exceptions = true
@@ -87,6 +157,7 @@ module Sentry
           Sentry::Rails::Tracing::ActiveRecordSubscriber,
           Sentry::Rails::Tracing::ActiveStorageSubscriber
         ])
+        @active_support_logger_subscription_items = Sentry::Rails::ACTIVE_SUPPORT_LOGGER_SUBSCRIPTION_ITEMS_DEFAULT.dup
       end
     end
   end

data/lib/sentry/rails/railtie.rb

@@ -89,7 +89,7 @@ module Sentry
     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
+        Sentry::Rails::Breadcrumb::ActiveSupportLogger.inject(Sentry.configuration.rails.active_support_logger_subscription_items)
       end
 
       if Sentry.configuration.breadcrumbs_logger.include?(:monotonic_active_support_logger)

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

@@ -33,6 +33,8 @@ module Sentry
                             connection.pool.spec.config
                           end
 
+              next unless db_config
+
               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]

data/lib/sentry/rails/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 5.11.0
+  version: 5.13.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-06 00:00:00.000000000 Z
+date: 2023-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.11.0
+        version: 5.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.11.0
+        version: 5.13.0
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []