sentry-rails 5.28.0 → 6.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bc5fa70737646471ed734ab7db1ccdfb235713916b64698fdcde43d0a6dae42
-  data.tar.gz: 52e0db8ece18a740d682ab4524747473f34ea3e6109d91c585e0ed717531c0e3
+  metadata.gz: d0b45b14487fb54357f496eea076b669d064b0f38bbd1960014960ecaf9214df
+  data.tar.gz: 1cd430829a299cdd9b357c940e17aa0c3984e6dc30d5f888f50a28b75accff9c
 SHA512:
-  metadata.gz: 85298718a87c6a372d2dceb12ca5de499a1d83c618331d3c75b95863c2bf66115ac6fe7311a7e4ec1361d33d0d45a1bed493f9ae5cf6a1964b33e343c36b1192
-  data.tar.gz: 2a496639bf0df1e9f1e5d81a374a63728cc5935e3ac70450e28c1cb06c812e8398dc406169b97ccdd34da5aa747371d09676c1828fe8e0f0e48823edaad26ac0
+  metadata.gz: ebba56359ebb4c5ac43076f10b069864a61004ba33ddf893ba2a5eba825f8da1f12d18ad685a900a3b253ee8521566a983e83508809b33e02f2d634ff078f181
+  data.tar.gz: e01b630f88aa297426743f96635e837d6de0fd888c3dec63b8382affae263c8764f6c92a9972a765d38d5aa8252629c1a568a3edde98e26b3368f530010009f6

data/.rspec

@@ -1,3 +1,3 @@
---format documentation
+--format progress
 --color
 --require spec_helper

data/Gemfile

@@ -21,10 +21,8 @@ rails_version = ENV.fetch("RAILS_VERSION") do
     "8.0"
   elsif ruby_version >= Gem::Version.new("3.1")
     "7.2"
-  elsif ruby_version >= Gem::Version.new("2.7")
+  else
     "7.1"
-  elsif ruby_version >= Gem::Version.new("2.4")
-    "5.2"
   end
 end
 
@@ -32,21 +30,19 @@ rails_version = Gem::Version.new(rails_version)
 
 gem "rails", "~> #{rails_version}"
 
-if rails_version >= Gem::Version.new("8.0.0")
-  gem "rspec-rails"
+if rails_version >= Gem::Version.new("8.1.0")
+  gem "rspec-rails", "~> 8.0.0"
+  gem "sqlite3", "~> 2.1.1", platform: :ruby
+elsif rails_version >= Gem::Version.new("8.0.0")
+  gem "rspec-rails", "~> 8.0.0"
   gem "sqlite3", "~> 2.1.1", platform: :ruby
 elsif rails_version >= Gem::Version.new("7.1.0")
   gem "psych", "~> 4.0.0"
-  gem "rspec-rails"
+  gem "rspec-rails", "~> 7.0"
   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
+  gem "rspec-rails", "~> 6.0"
+  gem "sqlite3", "~> 1.7.3", platform: :ruby
 else
   gem "psych", "~> 3.0.0"
   gem "rspec-rails", "~> 4.0"
@@ -58,12 +54,6 @@ else
   end
 end
 
-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"

data/bin/test

@@ -24,7 +24,7 @@ require 'optparse'
 require 'fileutils'
 
 class RailsVersionTester
-  SUPPORTED_VERSIONS = %w[5.0 5.1 5.2 6.0 6.1 7.0 7.1 7.2 8.0].freeze
+  SUPPORTED_VERSIONS = %w[5.2 6.0 6.1 7.0 7.1 7.2 8.0 8.1].freeze
 
   def initialize
     @options = {}

data/lib/sentry/rails/active_job.rb

@@ -32,17 +32,13 @@ module Sentry
             Sentry.with_scope do |scope|
               begin
                 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,
-                      source: scope.transaction_source,
-                      op: OP_NAME,
-                      origin: SPAN_ORIGIN
-                    )
-                  end
+
+                transaction = Sentry.start_transaction(
+                  name: scope.transaction_name,
+                  source: scope.transaction_source,
+                  op: OP_NAME,
+                  origin: SPAN_ORIGIN
+                )
 
                 scope.set_span(transaction) if transaction
 

data/lib/sentry/rails/configuration.rb

@@ -1,6 +1,5 @@
 # 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"

data/lib/sentry/rails/log_subscriber.rb

@@ -27,7 +27,7 @@ module Sentry
     #     end
     #   end
     class LogSubscriber < ActiveSupport::LogSubscriber
-      ORIGIN = "auto.logger.rails.log_subscriber"
+      ORIGIN = "auto.log.rails.log_subscriber"
 
       class << self
         if ::Rails.version.to_f < 6.0

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

@@ -27,6 +27,8 @@ module Sentry
         #
         # @param event [ActiveSupport::Notifications::Event] The controller action event
         def process_action(event)
+          return unless Sentry.initialized?
+
           payload = event.payload
 
           controller = payload[:controller]

data/lib/sentry/rails/log_subscribers/action_mailer_subscriber.rb

@@ -26,6 +26,8 @@ module Sentry
         #
         # @param event [ActiveSupport::Notifications::Event] The email delivery event
         def deliver(event)
+          return unless Sentry.initialized?
+
           payload = event.payload
 
           mailer = payload[:mailer]
@@ -57,6 +59,8 @@ module Sentry
         #
         # @param event [ActiveSupport::Notifications::Event] The email processing event
         def process(event)
+          return unless Sentry.initialized?
+
           payload = event.payload
 
           mailer = payload[:mailer]

data/lib/sentry/rails/log_subscribers/active_job_subscriber.rb

@@ -26,6 +26,8 @@ module Sentry
         #
         # @param event [ActiveSupport::Notifications::Event] The job performance event
         def perform(event)
+          return unless Sentry.initialized?
+
           job = event.payload[:job]
           duration = duration_ms(event)
 
@@ -63,6 +65,8 @@ module Sentry
         #
         # @param event [ActiveSupport::Notifications::Event] The job enqueue event
         def enqueue(event)
+          return unless Sentry.initialized?
+
           job = event.payload[:job]
 
           attributes = {
@@ -89,6 +93,8 @@ module Sentry
         end
 
         def retry_stopped(event)
+          return unless Sentry.initialized?
+
           job = event.payload[:job]
           error = event.payload[:error]
 
@@ -111,6 +117,8 @@ module Sentry
         end
 
         def discard(event)
+          return unless Sentry.initialized?
+
           job = event.payload[:job]
           error = event.payload[:error]
 

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

@@ -29,6 +29,7 @@ module Sentry
         #
         # @param event [ActiveSupport::Notifications::Event] The SQL event
         def sql(event)
+          return unless Sentry.initialized?
           return if EXCLUDED_NAMES.include?(event.payload[:name])
 
           sql = event.payload[:sql]
@@ -46,6 +47,17 @@ module Sentry
             cached: cached
           }
 
+          binds = event.payload[:binds]
+
+          if Sentry.configuration.send_default_pii && !binds&.empty?
+            type_casted_binds = type_casted_binds(event)
+
+            binds.each_with_index do |bind, index|
+              name = bind.is_a?(Symbol) ? bind : bind.name
+              attributes["db.query.parameter.#{name}"] = type_casted_binds[index].to_s
+            end
+          end
+
           attributes[:statement_name] = statement_name if statement_name && statement_name != "SQL"
           attributes[:connection_id] = connection_id if connection_id
 
@@ -60,6 +72,16 @@ module Sentry
           )
         end
 
+        if RUBY_ENGINE == "jruby"
+          def type_casted_binds(event)
+            event.payload[:type_casted_binds].call
+          end
+        else
+          def type_casted_binds(event)
+            event.payload[:type_casted_binds]
+          end
+        end
+
         private
 
         def build_log_message(statement_name)

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

@@ -9,17 +9,6 @@ module Sentry
           super
         end
       end
-
-      module OldStreamingReporter
-        def self.included(base)
-          base.send(:alias_method_chain, :log_error, :raven)
-        end
-
-        def log_error_with_raven(exception)
-          Sentry::Rails.capture_exception(exception)
-          log_error_without_raven(exception)
-        end
-      end
     end
   end
 end

data/lib/sentry/rails/railtie.rb

@@ -101,17 +101,12 @@ module Sentry
     end
 
     def inject_breadcrumbs_logger
-      if Sentry.configuration.breadcrumbs_logger.include?(:active_support_logger)
+      if Sentry.configuration.breadcrumbs_logger.include?(:active_support_logger) ||
+        ## legacy name redirected for backwards compat
+        Sentry.configuration.breadcrumbs_logger.include?(:monotonic_active_support_logger)
         require "sentry/rails/breadcrumb/active_support_logger"
         Sentry::Rails::Breadcrumb::ActiveSupportLogger.inject(Sentry.configuration.rails.active_support_logger_subscription_items)
       end
-
-      if Sentry.configuration.breadcrumbs_logger.include?(:monotonic_active_support_logger)
-        return warn "Usage of `monotonic_active_support_logger` require a version of Rails >= 6.1, please upgrade your Rails version or use another logger" if ::Rails.version.to_f < 6.1
-
-        require "sentry/rails/breadcrumb/monotonic_active_support_logger"
-        Sentry::Rails::Breadcrumb::MonotonicActiveSupportLogger.inject
-      end
     end
 
     def setup_backtrace_cleanup_callback

data/lib/sentry/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Sentry
   module Rails
-    VERSION = "5.28.0"
+    VERSION = "6.1.0"
   end
 end

data/sentry-rails.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.license = 'MIT'
 
   spec.platform = Gem::Platform::RUBY
-  spec.required_ruby_version = '>= 2.4'
+  spec.required_ruby_version = '>= 2.7'
   spec.extra_rdoc_files = ["README.md", "LICENSE.txt"]
   spec.files = `git ls-files | grep -Ev '^(spec|benchmarks|examples|\.rubocop\.yml)'`.split("\n")
 
@@ -30,6 +30,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "railties", ">= 5.0"
-  spec.add_dependency "sentry-ruby", "~> 5.28.0"
+  spec.add_dependency "railties", ">= 5.2.0"
+  spec.add_dependency "sentry-ruby", "~> 6.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sentry-rails
 version: !ruby/object:Gem::Version
-  version: 5.28.0
+  version: 6.1.0
 platform: ruby
 authors:
 - Sentry Team
@@ -15,28 +15,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: sentry-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.28.0
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.28.0
+        version: 6.1.0
 description: A gem that provides Rails integration for the Sentry error logger
 email: accounts@sentry.io
 executables: []
@@ -65,14 +65,12 @@ files:
 - lib/sentry/rails/background_worker.rb
 - lib/sentry/rails/backtrace_cleaner.rb
 - lib/sentry/rails/breadcrumb/active_support_logger.rb
-- lib/sentry/rails/breadcrumb/monotonic_active_support_logger.rb
 - lib/sentry/rails/capture_exceptions.rb
 - lib/sentry/rails/configuration.rb
 - lib/sentry/rails/controller_methods.rb
 - lib/sentry/rails/controller_transaction.rb
 - lib/sentry/rails/engine.rb
 - lib/sentry/rails/error_subscriber.rb
-- lib/sentry/rails/instrument_payload_cleanup_helper.rb
 - lib/sentry/rails/log_subscriber.rb
 - lib/sentry/rails/log_subscribers/action_controller_subscriber.rb
 - lib/sentry/rails/log_subscribers/action_mailer_subscriber.rb
@@ -85,22 +83,21 @@ files:
 - lib/sentry/rails/structured_logging.rb
 - lib/sentry/rails/tracing.rb
 - lib/sentry/rails/tracing/abstract_subscriber.rb
-- lib/sentry/rails/tracing/action_controller_subscriber.rb
 - 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.28.0/sentry-rails
+homepage: https://github.com/getsentry/sentry-ruby/tree/6.1.0/sentry-rails
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.28.0/sentry-rails
-  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.28.0/sentry-rails
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.28.0/CHANGELOG.md
+  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/6.1.0/sentry-rails
+  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/6.1.0/sentry-rails
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/6.1.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/getsentry/sentry-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/sentry-rails/5.28.0
+  documentation_uri: http://www.rubydoc.info/gems/sentry-rails/6.1.0
 rdoc_options: []
 require_paths:
 - lib
@@ -108,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

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

@@ -1,46 +0,0 @@
-# frozen_string_literal: true
-
-require "sentry/rails/instrument_payload_cleanup_helper"
-
-module Sentry
-  module Rails
-    module Breadcrumb
-      module MonotonicActiveSupportLogger
-        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)
-            end
-
-            crumb = Sentry::Breadcrumb.new(
-              data: data,
-              category: name,
-              timestamp: started.to_i
-            )
-            Sentry.add_breadcrumb(crumb)
-          end
-
-          def inject
-            @subscriber = ::ActiveSupport::Notifications.monotonic_subscribe(/.*/) do |name, started, finished, unique_id, data|
-              # we only record events that has a float as started timestamp
-              if started.is_a?(Float)
-                add(name, started, finished, unique_id, data)
-              end
-            end
-          end
-
-          def detach
-            ::ActiveSupport::Notifications.unsubscribe(@subscriber)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/sentry/rails/instrument_payload_cleanup_helper.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Sentry
-  module Rails
-    module InstrumentPayloadCleanupHelper
-      IGNORED_DATA_TYPES = [:request, :response, :headers, :exception, :exception_object, Tracing::START_TIMESTAMP_NAME]
-
-      def cleanup_data(data)
-        IGNORED_DATA_TYPES.each do |key|
-          data.delete(key) if data.key?(key)
-        end
-      end
-    end
-  end
-end

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

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require "sentry/rails/tracing/abstract_subscriber"
-require "sentry/rails/instrument_payload_cleanup_helper"
-
-module Sentry
-  module Rails
-    module Tracing
-      class ActionControllerSubscriber < AbstractSubscriber
-        extend InstrumentPayloadCleanupHelper
-
-        EVENT_NAMES = ["process_action.action_controller"].freeze
-        OP_NAME = "view.process_action.action_controller"
-        SPAN_ORIGIN = "auto.view.rails"
-
-        def self.subscribe!
-          Sentry.sdk_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: OP_NAME,
-              origin: SPAN_ORIGIN,
-              start_timestamp: payload[START_TIMESTAMP_NAME],
-              description: "#{controller}##{action}",
-              duration: duration
-            ) do |span|
-              payload = payload.dup
-              cleanup_data(payload)
-              span.set_data(:payload, payload)
-              span.set_http_status(payload[:status])
-            end
-          end
-        end
-      end
-    end
-  end
-end