sentry-rails 5.20.1 → 5.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f224892c221e7a3250fb8b51f7484699ce5e927e4d4bb6e757c0bd5dc232c3d
-  data.tar.gz: 5dd2b6914d7bdee52f83bfbcaf12d56b7044cd25fda0ef2d9ca736553254a306
+  metadata.gz: 8bedf276549ddb2522027c7c8de8cfcecae915f5760fef3057d47512533ead95
+  data.tar.gz: 37b3bfa86da3eea8f64d8d55142358ee7fcc3ad3e6f468751cd26eed81967e2a
 SHA512:
-  metadata.gz: 536c8d9aa4c7e16c23452cd4e7ee675c5a7f1740567f0f99a806f5b2ae57721f4ffeced8e4430a43008bacc7921cfad827ae21efc99c5b901d1c6479975d1ab3
-  data.tar.gz: d7e621b58c24bbee5b7559ab81b5b12230af0ca3a01947107e76fa0dc6f11d804e2a1673cdde660e9304e81b3674f2d3574dc31909b5e03a82e7560555907b5f
+  metadata.gz: 7d91f74cc7780297d352c28da1f631aaf6cc68f2121c23996e4e76e82f747f2ee10ffd95744a03926752fe2a46491c9600e2aef84552940d9a8a98638ffad7ff
+  data.tar.gz: d150984b74034e144df813124c21d9f21e41fab9ef66c176626d856e45f5ae2d610a2470ec65de22a5d44dfb25cf42484241ad071efdd7350ca7e5429baa403b

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 git_source(:github) { |name| "https://github.com/#{name}.git" }
 
@@ -10,40 +12,38 @@ platform :jruby do
   gem "jdbc-sqlite3"
 end
 
+ruby_version = Gem::Version.new(RUBY_VERSION)
+
 rails_version = ENV["RAILS_VERSION"]
-rails_version = "7.1.0" if rails_version.nil?
+rails_version = "8.0.0" if rails_version.nil?
 rails_version = Gem::Version.new(rails_version)
 
-if rails_version < Gem::Version.new("6.0.0")
-  gem "sqlite3", "~> 1.3.0", platform: :ruby
-else
-  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.7.0")
-    gem "sqlite3", "~> 1.7.3", platform: :ruby
-  else
-    gem "sqlite3", "~> 1.6.9", platform: :ruby
-  end
-end
+gem "rails", "~> #{rails_version}"
 
-if rails_version >= Gem::Version.new("8.0.0.alpha")
-  gem "rails", github: "rails/rails"
+if rails_version >= Gem::Version.new("8.0.0")
   gem "rspec-rails"
+  gem "sqlite3", platform: :ruby
 elsif rails_version >= Gem::Version.new("7.1.0")
-  gem "rails", "~> #{rails_version}"
   gem "rspec-rails"
+  gem "sqlite3", "~> 1.7.3", platform: :ruby
+elsif rails_version >= Gem::Version.new("6.1.0")
+  gem "rspec-rails", "~> 4.0"
+
+  if ruby_version >= Gem::Version.new("2.7.0")
+    gem "sqlite3", "~> 1.7.3", platform: :ruby
+  else
+    gem "sqlite3", "~> 1.6.9", platform: :ruby
+  end
 else
   gem "rspec-rails", "~> 4.0"
-  gem "rails", "~> #{rails_version}"
   gem "psych", "~> 3.0.0"
-end
-
-gem "mini_magick"
-
-gem "sprockets-rails"
-
-gem "sidekiq"
 
-
-ruby_version = Gem::Version.new(RUBY_VERSION)
+  if rails_version >= Gem::Version.new("6.0.0")
+    gem "sqlite3", "~> 1.4.0", platform: :ruby
+  else
+    gem "sqlite3", "~> 1.3.0", platform: :ruby
+  end
+end
 
 if ruby_version < Gem::Version.new("2.5.0")
   # https://github.com/flavorjones/loofah/pull/267
@@ -51,6 +51,10 @@ if ruby_version < Gem::Version.new("2.5.0")
   gem "loofah", "2.20.0"
 end
 
+gem "mini_magick"
+
+gem "sprockets-rails"
+
 gem "benchmark-ips"
 gem "benchmark_driver"
 gem "benchmark-ipsa"

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 

data/app/jobs/sentry/send_event_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if defined?(ActiveJob)
   module Sentry
     parent_job =

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "sentry/ruby"

data/lib/generators/sentry_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails/generators/base"
 
 class SentryGenerator < ::Rails::Generators::Base

data/lib/sentry/rails/action_cable.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Sentry
   module Rails
     module ActionCableExtensions
       class ErrorHandler
-        OP_NAME = "websocket.server".freeze
+        OP_NAME = "websocket.server"
         SPAN_ORIGIN = "auto.http.rails.actioncable"
 
         class << self

data/lib/sentry/rails/active_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   module Rails
     module ActiveJobExtensions
@@ -16,8 +18,8 @@ module Sentry
       end
 
       class SentryReporter
-        OP_NAME = "queue.active_job".freeze
-        SPAN_ORIGIN = "auto.queue.active_job".freeze
+        OP_NAME = "queue.active_job"
+        SPAN_ORIGIN = "auto.queue.active_job"
 
         class << self
           def record(job, &block)

data/lib/sentry/rails/background_worker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   class BackgroundWorker
     def _perform(&block)

data/lib/sentry/rails/backtrace_cleaner.rb

@@ -1,21 +1,21 @@
+# frozen_string_literal: true
+
 require "active_support/backtrace_cleaner"
 require "active_support/core_ext/string/access"
 
 module Sentry
   module Rails
     class BacktraceCleaner < ActiveSupport::BacktraceCleaner
-      APP_DIRS_PATTERN = /\A(?:\.\/)?(?:app|config|lib|test|\(\w*\))/.freeze
-      RENDER_TEMPLATE_PATTERN = /:in `.*_\w+_{2,3}\d+_\d+'/.freeze
+      APP_DIRS_PATTERN = /\A(?:\.\/)?(?:app|config|lib|test|\(\w*\))/
+      RENDER_TEMPLATE_PATTERN = /:in `.*_\w+_{2,3}\d+_\d+'/
 
       def initialize
         super
-        # we don't want any default silencers because they're too aggressive
+        # We don't want any default silencers because they're too aggressive
         remove_silencers!
+        # We don't want any default filters because Rails 7.2 starts shortening the paths. See #2472
+        remove_filters!
 
-        @root = "#{Sentry.configuration.project_root}/"
-        add_filter do |line|
-          line.start_with?(@root) ? line.from(@root.size) : line
-        end
         add_filter do |line|
           if line =~ RENDER_TEMPLATE_PATTERN
             line.sub(RENDER_TEMPLATE_PATTERN, "")

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   module Rails
     module Breadcrumb

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "sentry/rails/instrument_payload_cleanup_helper"
 
 module Sentry

data/lib/sentry/rails/capture_exceptions.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Sentry
   module Rails
     class CaptureExceptions < Sentry::Rack::CaptureExceptions
       RAILS_7_1 = Gem::Version.new(::Rails.version) >= Gem::Version.new("7.1.0.alpha")
-      SPAN_ORIGIN = "auto.http.rails".freeze
+      SPAN_ORIGIN = "auto.http.rails"
 
       def initialize(_)
         super
@@ -20,7 +22,7 @@ module Sentry
       end
 
       def transaction_op
-        "http.server".freeze
+        "http.server"
       end
 
       def capture_exception(exception, env)

data/lib/sentry/rails/configuration.rb

@@ -1,7 +1,10 @@
+# frozen_string_literal: true
+
 require "sentry/rails/tracing/action_controller_subscriber"
 require "sentry/rails/tracing/action_view_subscriber"
 require "sentry/rails/tracing/active_record_subscriber"
 require "sentry/rails/tracing/active_storage_subscriber"
+require "sentry/rails/tracing/active_support_subscriber"
 
 module Sentry
   class Configuration
@@ -162,6 +165,7 @@ module Sentry
         end
         @tracing_subscribers = Set.new([
           Sentry::Rails::Tracing::ActionViewSubscriber,
+          Sentry::Rails::Tracing::ActiveSupportSubscriber,
           Sentry::Rails::Tracing::ActiveRecordSubscriber,
           Sentry::Rails::Tracing::ActiveStorageSubscriber
         ])

data/lib/sentry/rails/controller_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   module Rails
     module ControllerMethods

data/lib/sentry/rails/controller_transaction.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Sentry
   module Rails
     module ControllerTransaction
-      SPAN_ORIGIN = "auto.view.rails".freeze
+      SPAN_ORIGIN = "auto.view.rails"
 
       def self.included(base)
         base.prepend_around_action(:sentry_around_action)
@@ -21,8 +23,10 @@ module Sentry
                 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)
+
+                pii = Sentry.configuration.send_default_pii
+                child_span.set_data(:path, pii ? request.fullpath : request.filtered_path)
+                child_span.set_data(:params, pii ? request.params : request.filtered_parameters)
               end
 
               result

data/lib/sentry/rails/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   class Engine < ::Rails::Engine
     isolate_namespace Sentry

data/lib/sentry/rails/error_subscriber.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 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.
@@ -25,7 +27,20 @@ module Sentry
           hint.merge!(context.delete(:hint))
         end
 
-        Sentry::Rails.capture_exception(error, level: severity, contexts: { "rails.error" => context }, tags: tags, hint: hint)
+        options = { level: severity, contexts: { "rails.error" => context }, tags: tags, hint: hint }
+
+        case error
+        when String
+          Sentry::Rails.capture_message(error, **options)
+        when Exception
+          Sentry::Rails.capture_exception(error, **options)
+        else
+          log_debug("Expected an Exception or a String, got: #{error.inspect}")
+        end
+      end
+
+      def log_debug(message)
+        Sentry.configuration.logger.debug(message)
       end
     end
   end

data/lib/sentry/rails/instrument_payload_cleanup_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   module Rails
     module InstrumentPayloadCleanupHelper

data/lib/sentry/rails/overrides/streaming_reporter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   module Rails
     module Overrides

data/lib/sentry/rails/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "sentry/rails/capture_exceptions"
 require "sentry/rails/rescued_exception_interceptor"
 require "sentry/rails/backtrace_cleaner"

data/lib/sentry/rails/rescued_exception_interceptor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   module Rails
     class RescuedExceptionInterceptor
@@ -17,7 +19,16 @@ module Sentry
       end
 
       def report_rescued_exceptions?
-        Sentry.configuration.rails.report_rescued_exceptions
+        # In rare edge cases, `Sentry.configuration` might be `nil` here.
+        # Hence, we use a safe navigation and fallback to a reasonable default
+        # of `true` in case the configuration couldn't be loaded.
+        # See https://github.com/getsentry/sentry-ruby/issues/2386
+        report_rescued_exceptions = Sentry.configuration&.rails&.report_rescued_exceptions
+        return report_rescued_exceptions unless report_rescued_exceptions.nil?
+
+        # `true` is the default for `report_rescued_exceptions`, as specified in
+        # `sentry-rails/lib/sentry/rails/configuration.rb`.
+        true
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   module Rails
     module Tracing

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "sentry/rails/tracing/abstract_subscriber"
 require "sentry/rails/instrument_payload_cleanup_helper"
 
@@ -8,8 +10,8 @@ module Sentry
         extend InstrumentPayloadCleanupHelper
 
         EVENT_NAMES = ["process_action.action_controller"].freeze
-        OP_NAME = "view.process_action.action_controller".freeze
-        SPAN_ORIGIN = "auto.view.rails".freeze
+        OP_NAME = "view.process_action.action_controller"
+        SPAN_ORIGIN = "auto.view.rails"
 
         def self.subscribe!
           Sentry.logger.warn <<~MSG

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "sentry/rails/tracing/abstract_subscriber"
 
 module Sentry
@@ -5,8 +7,8 @@ module Sentry
     module Tracing
       class ActionViewSubscriber < AbstractSubscriber
         EVENT_NAMES = ["render_template.action_view"].freeze
-        SPAN_PREFIX = "template.".freeze
-        SPAN_ORIGIN = "auto.template.rails".freeze
+        SPAN_PREFIX = "template."
+        SPAN_ORIGIN = "auto.template.rails"
 
         def self.subscribe!
           subscribe_to_event(EVENT_NAMES) do |event_name, duration, payload|

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "sentry/rails/tracing/abstract_subscriber"
 
 module Sentry
@@ -19,12 +21,12 @@ module Sentry
           analyze.active_storage
         ].freeze
 
-        SPAN_ORIGIN = "auto.file.rails".freeze
+        SPAN_ORIGIN = "auto.file.rails"
 
         def self.subscribe!
           subscribe_to_event(EVENT_NAMES) do |event_name, duration, payload|
             record_on_current_span(
-              op: "file.#{event_name}".freeze,
+              op: "file.#{event_name}",
               origin: SPAN_ORIGIN,
               start_timestamp: payload[START_TIMESTAMP_NAME],
               description: payload[:service],

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

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "sentry/rails/tracing/abstract_subscriber"
+
+module Sentry
+  module Rails
+    module Tracing
+      class ActiveSupportSubscriber < AbstractSubscriber
+        READ_EVENT_NAMES = %w[
+          cache_read.active_support
+        ].freeze
+
+        WRITE_EVENT_NAMES = %w[
+          cache_write.active_support
+          cache_increment.active_support
+          cache_decrement.active_support
+        ].freeze
+
+        REMOVE_EVENT_NAMES = %w[
+          cache_delete.active_support
+        ].freeze
+
+        FLUSH_EVENT_NAMES = %w[
+          cache_prune.active_support
+        ].freeze
+
+        EVENT_NAMES = READ_EVENT_NAMES + WRITE_EVENT_NAMES + REMOVE_EVENT_NAMES + FLUSH_EVENT_NAMES
+
+        SPAN_ORIGIN = "auto.cache.rails"
+
+        def self.subscribe!
+          subscribe_to_event(EVENT_NAMES) do |event_name, duration, payload|
+            record_on_current_span(
+              op: operation_name(event_name),
+              origin: SPAN_ORIGIN,
+              start_timestamp: payload[START_TIMESTAMP_NAME],
+              description: payload[:store],
+              duration: duration
+            ) do |span|
+              span.set_data("cache.key", [*payload[:key]].select { |key| Utils::EncodingHelper.valid_utf_8?(key) })
+              span.set_data("cache.hit", payload[:hit] == true) # Handle nil case
+            end
+          end
+        end
+
+        def self.operation_name(event_name)
+          case
+          when READ_EVENT_NAMES.include?(event_name)
+            "cache.get"
+          when WRITE_EVENT_NAMES.include?(event_name)
+            "cache.put"
+          when REMOVE_EVENT_NAMES.include?(event_name)
+            "cache.remove"
+          when FLUSH_EVENT_NAMES.include?(event_name)
+            "cache.flush"
+          else
+            "other"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sentry/rails/tracing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   module Rails
     module Tracing

data/lib/sentry/rails/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Sentry
   module Rails
-    VERSION = "5.20.1"
+    VERSION = "5.22.0"
   end
 end

data/lib/sentry/rails.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails"
 require "sentry-ruby"
 require "sentry/integrable"

data/lib/sentry-rails.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require "sentry/rails/version"
 require "sentry/rails"

data/sentry-rails.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "lib/sentry/rails/version"
 
 Gem::Specification.new do |spec|
@@ -29,5 +31,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "railties", ">= 5.0"
-  spec.add_dependency "sentry-ruby", "~> 5.20.1"
+  spec.add_dependency "sentry-ruby", "~> 5.22.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 5.20.1
+  version: 5.22.0
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-27 00:00:00.000000000 Z
+date: 2024-12-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.20.1
+        version: 5.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.20.1
+        version: 5.22.0
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -82,17 +82,18 @@ files:
 - lib/sentry/rails/tracing/action_view_subscriber.rb
 - lib/sentry/rails/tracing/active_record_subscriber.rb
 - lib/sentry/rails/tracing/active_storage_subscriber.rb
+- lib/sentry/rails/tracing/active_support_subscriber.rb
 - lib/sentry/rails/version.rb
 - sentry-rails.gemspec
-homepage: https://github.com/getsentry/sentry-ruby/tree/5.20.1/sentry-rails
+homepage: https://github.com/getsentry/sentry-ruby/tree/5.22.0/sentry-rails
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.20.1/sentry-rails
-  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.20.1/sentry-rails
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.20.1/CHANGELOG.md
+  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.22.0/sentry-rails
+  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.22.0/sentry-rails
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.22.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/getsentry/sentry-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/sentry-rails/5.20.1
+  documentation_uri: http://www.rubydoc.info/gems/sentry-rails/5.22.0
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -108,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: A gem that provides Rails integration for the Sentry error logger