sentry-rails 5.9.0 → 5.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93209fe5a0b0e76d0260c3355410492f36d8d72ef4f4852b4345d80656eb9dc6
-  data.tar.gz: e67e804834d28db4c5237757caffded4856d6a9594f337b2412e76c874a1cd58
+  metadata.gz: 8136167d60f6ee67885cdde939a5aa1e29f0e9f9bc1bd64b0ff4aecc29a477a9
+  data.tar.gz: d03846dced0b11fbe03df3b3386c01e2d4ff84d5cfc64dcaf33612f82f2de69a
 SHA512:
-  metadata.gz: eadf2d1e97b5ab7a6abf9fdc03609bf1c362e1ebba96b369f895c04a8d8341acbb2d3f121c1d03420fbcb32083abc1a07489a1f1b12b02c99b8b4c8bebfdbd41
-  data.tar.gz: 1c71775f931fd3b08a7dc1567a3baff47d6c56a128f34e5eb8ab42be9c1b89fae3e2201feba4e495e09e1fb8a343039ce4be3ccdc88bcea9ed63c6b024366a06
+  metadata.gz: '0900b1dd825499e01d9a5ce77c71bc7821581420abbb60ea8123fcdafed8d7fd9db53b8fb31bdcbbe445e95583c9b477b47f15bdeb58bc3988c54289f328d1bb'
+  data.tar.gz: 356eb3d7a526cb1bcd4ee56c3b32201fbbbfe58b0f6ea2cb8152fd7d732964522dea8bc83e08411271fc531c92a5cc9185b2a17dfd50d06153a1ca0f9a6ba87a

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

@@ -1,48 +1,62 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 git_source(:github) { |name| "https://github.com/#{name}.git" }
 
+eval_gemfile "../Gemfile"
+
 # Specify your gem's dependencies in sentry-ruby.gemspec
 gemspec
 gem "sentry-ruby", path: "../sentry-ruby"
 
+platform :jruby do
+  gem "activerecord-jdbcmysql-adapter"
+  gem "jdbc-sqlite3"
+end
+
+ruby_version = Gem::Version.new(RUBY_VERSION)
+
 rails_version = ENV["RAILS_VERSION"]
-rails_version = "7.0.0" if rails_version.nil?
+rails_version = "8.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
+gem "rails", "~> #{rails_version}"
+
+if rails_version >= Gem::Version.new("8.0.0")
+  gem "rspec-rails"
+  gem "sqlite3", "~> 2.1.1", platform: :ruby
+elsif rails_version >= Gem::Version.new("7.1.0")
+  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 "sqlite3", platform: :ruby
+  gem "rspec-rails", "~> 4.0"
+  gem "psych", "~> 3.0.0"
+
+  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 rails_version > Gem::Version.new("7.0.0")
-  gem "rails", github: "rails/rails"
-else
-  gem "rails", "~> #{rails_version}"
+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
 
 gem "mini_magick"
 
 gem "sprockets-rails"
 
-gem "sidekiq"
-
-gem "rspec", "~> 3.0"
-gem "rspec-retry"
-gem "rspec-rails", "~> 4.0"
-gem 'simplecov'
-gem "simplecov-cobertura", "~> 1.4"
-gem "rexml"
-
-gem "rake", "~> 12.0"
-
-gem "object_tracer"
-gem "debug", github: "ruby/debug", platform: :ruby if RUBY_VERSION.to_f >= 2.6
-gem "pry"
-
 gem "benchmark-ips"
 gem "benchmark_driver"
 gem "benchmark-ipsa"

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/Rakefile

@@ -1,14 +1,17 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require_relative "../lib/sentry/test/rake_tasks"
 
-RSpec::Core::RakeTask.new(:spec).tap do |task|
-  task.rspec_opts = "--order rand"
-end
+Sentry::Test::RakeTasks.define_spec_tasks(
+  spec_pattern: "spec/sentry/**/*_spec.rb",
+  spec_rspec_opts: "--order rand --format progress",
+  isolated_specs_pattern: "spec/isolated/**/*_spec.rb",
+  isolated_rspec_opts: "--format progress"
+)
 
-task :isolated_specs do
-  Dir["spec/isolated/*"].each do |file|
-    sh "bundle exec ruby #{file}"
-  end
-end
+Sentry::Test::RakeTasks.define_versioned_specs_task(
+  rspec_opts: "--order rand --format progress"
+)
 
-task :default => [:spec, :isolated_specs]
+task default: [:spec, :"spec:versioned", :"spec:isolated"]

data/app/jobs/sentry/send_event_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 if defined?(ActiveJob)
   module Sentry
     parent_job =
@@ -31,4 +33,3 @@ else
     class SendEventJob; end
   end
 end
-

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+class SentryGenerator < ::Rails::Generators::Base
+  class_option :dsn, type: :string, desc: "Sentry DSN"
+
+  class_option :inject_meta, type: :boolean, default: true, desc: "Inject meta tag into layout"
+
+  def copy_initializer_file
+    dsn = options[:dsn] ? "'#{options[:dsn]}'" : "ENV['SENTRY_DSN']"
+
+    create_file "config/initializers/sentry.rb", <<~RUBY
+      # frozen_string_literal: true
+
+      Sentry.init do |config|
+        config.breadcrumbs_logger = [:active_support_logger]
+        config.dsn = #{dsn}
+        config.traces_sample_rate = 1.0
+      end
+    RUBY
+  end
+
+  def inject_code_into_layout
+    return unless options[:inject_meta]
+
+    inject_into_file "app/views/layouts/application.html.erb", before: "</head>\n" do
+      "  <%= Sentry.get_trace_propagation_meta.html_safe %>\n  "
+    end
+  end
+end

data/lib/sentry/rails/action_cable.rb

@@ -1,8 +1,11 @@
+# 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
           def capture(connection, transaction_name:, extra_context: nil, &block)
@@ -33,11 +36,14 @@ 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
+            options = {
+              name: scope.transaction_name,
+              source: scope.transaction_source,
+              op: OP_NAME,
+              origin: SPAN_ORIGIN
+            }
+
+            transaction = Sentry.continue_trace(env, **options)
             Sentry.start_transaction(transaction: transaction, **options)
           end
 

data/lib/sentry/rails/active_job.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require "set"
+
 module Sentry
   module Rails
     module ActiveJobExtensions
@@ -16,7 +20,12 @@ module Sentry
       end
 
       class SentryReporter
-        OP_NAME = "queue.active_job".freeze
+        OP_NAME = "queue.active_job"
+        SPAN_ORIGIN = "auto.queue.active_job"
+
+        EVENT_HANDLERS = {
+          "enqueue_retry.active_job" => :retry_handler
+        }
 
         class << self
           def record(job, &block)
@@ -27,7 +36,12 @@ module Sentry
                   if job.is_a?(::Sentry::SendEventJob)
                     nil
                   else
-                    Sentry.start_transaction(name: scope.transaction_name, source: scope.transaction_source, op: OP_NAME)
+                    Sentry.start_transaction(
+                      name: scope.transaction_name,
+                      source: scope.transaction_source,
+                      op: OP_NAME,
+                      origin: SPAN_ORIGIN
+                    )
                   end
 
                 scope.set_span(transaction) if transaction
@@ -38,19 +52,54 @@ module Sentry
               rescue Exception => e # rubocop:disable Lint/RescueException
                 finish_sentry_transaction(transaction, 500)
 
-                Sentry::Rails.capture_exception(
-                  e,
-                  extra: sentry_context(job),
-                  tags: {
-                    job_id: job.job_id,
-                    provider_job_id: job.provider_job_id
-                  }
-                )
+                capture_exception(job, e)
+
                 raise
               end
             end
           end
 
+          def capture_exception(job, e)
+            Sentry::Rails.capture_exception(
+              e,
+              extra: sentry_context(job),
+              tags: {
+                job_id: job.job_id,
+                provider_job_id: job.provider_job_id
+              }
+            )
+          end
+
+          def register_event_handlers
+            EVENT_HANDLERS.each do |name, handler|
+              subscribers << ActiveSupport::Notifications.subscribe(name) do |*args|
+                public_send(handler, *args)
+              end
+            end
+          end
+
+          def detach_event_handlers
+            subscribers.each do |subscriber|
+              ActiveSupport::Notifications.unsubscribe(subscriber)
+            end
+            subscribers.clear
+          end
+
+          # This handler does not capture error unless `active_job_report_on_retry_error` is true
+          def retry_handler(*args)
+            handle_error_event(*args) do |job, error|
+              return if !Sentry.initialized? || job.already_supported_by_sentry_integration?
+              return unless Sentry.configuration.rails.active_job_report_on_retry_error
+
+              capture_exception(job, error)
+            end
+          end
+
+          def handle_error_event(*args)
+            event = ActiveSupport::Notifications::Event.new(*args)
+            yield(event.payload[:job], event.payload[:error])
+          end
+
           def finish_sentry_transaction(transaction, status)
             return unless transaction
 
@@ -71,6 +120,12 @@ module Sentry
 
           def sentry_serialize_arguments(argument)
             case argument
+            when Range
+              if (argument.begin || argument.end).is_a?(ActiveSupport::TimeWithZone)
+                argument.to_s
+              else
+                argument.map { |v| sentry_serialize_arguments(v) }
+              end
             when Hash
               argument.transform_values { |v| sentry_serialize_arguments(v) }
             when Array, Enumerable
@@ -81,6 +136,12 @@ module Sentry
               argument
             end
           end
+
+          private
+
+          def subscribers
+            @__subscribers__ ||= Set.new
+          end
         end
       end
     end

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,20 +1,16 @@
-require "sentry/rails/instrument_payload_cleanup_helper"
+# frozen_string_literal: true
 
 module Sentry
   module Rails
     module Breadcrumb
       module ActiveSupportLogger
         class << self
-          include InstrumentPayloadCleanupHelper
-
           def add(name, started, _finished, _unique_id, data)
             # skip Rails' internal events
             return if name.start_with?("!")
 
             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[name])
             end
 
             crumb = Sentry::Breadcrumb.new(
@@ -25,7 +21,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/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,6 +1,11 @@
+# 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"
+
       def initialize(_)
         super
 
@@ -17,32 +22,43 @@ module Sentry
       end
 
       def transaction_op
-        "http.server".freeze
+        "http.server"
       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 }
+        options = {
+          name: scope.transaction_name,
+          source: scope.transaction_source,
+          op: transaction_op,
+          origin: SPAN_ORIGIN
+        }
 
         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