sentry-ruby 5.22.2 → 5.22.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8b76c7e3289d19422a8ab07bdc53a2ac0fd907d3e55fd86c18ee1eb37daa7d7
-  data.tar.gz: a560347120c4a0781e7ef67d9252e90dacf37c6d32f36a3c41da01110e0cbdc9
+  metadata.gz: ccdc435e6c9cc7602051e6ae33794509604f6a6973e8098acb3b39cdaa727056
+  data.tar.gz: 7963e284f23ac79656f94eccbed48840be1746927bcae3ae18a66c60aea923c5
 SHA512:
-  metadata.gz: 2b04dafc81567da6edc9dc86436b1815db4001962c0dc8bea82fcced79c8f95ec23f22122b1eb127fc278edcd39da0c91569284f5a170db4ef9c19827ba4cbc8
-  data.tar.gz: 7ee0819a7f3ea956a96123fb813731c440ffacbfc73e5ae37b47b650f8dded96dc4379321d1b714505c8f87a34c1b93a1ca6849a4a59697ad35f9eee5b827934
+  metadata.gz: da82afec03f9100f4d1389ac96069328a61f658b3ebf39b982aa8eb1284fbc19bd00168d4d89b3b4e8b0a0d82b98e161a4d38f4e5afbc88bdbbcfa3b7aadd958
+  data.tar.gz: 1711020af1887f806b3cc01a9e1d2540b616e5f3e5d77da85cb252e85ae90af9062de51eb9e552a434595345d0978a10b6002cd2944e0baaf4414275e58fd399

data/lib/sentry/client.rb

@@ -183,7 +183,15 @@ module Sentry
       if event_type != TransactionEvent::TYPE && configuration.before_send
         event = configuration.before_send.call(event, hint)
 
-        unless event.is_a?(ErrorEvent)
+        case event
+        when ErrorEvent, CheckInEvent
+          # do nothing
+        when Hash
+          log_debug(<<~MSG)
+            Returning a Hash from before_send is deprecated and will be removed in the next major version.
+            Please return a Sentry::ErrorEvent object instead.
+          MSG
+        else
           # Avoid serializing the event object in this case because we aren't sure what it is and what it contains
           log_debug(<<~MSG)
             Discarded event because before_send didn't return a Sentry::ErrorEvent object but an instance of #{event.class}
@@ -196,10 +204,17 @@ module Sentry
       if event_type == TransactionEvent::TYPE && configuration.before_send_transaction
         event = configuration.before_send_transaction.call(event, hint)
 
-        if event.is_a?(TransactionEvent)
+        if event.is_a?(TransactionEvent) || event.is_a?(Hash)
           spans_after = event.is_a?(TransactionEvent) ? event.spans.size : 0
           spans_delta = spans_before - spans_after
           transport.record_lost_event(:before_send, "span", num: spans_delta) if spans_delta > 0
+
+          if event.is_a?(Hash)
+            log_debug(<<~MSG)
+              Returning a Hash from before_send_transaction is deprecated and will be removed in the next major version.
+              Please return a Sentry::TransactionEvent object instead.
+            MSG
+          end
         else
           # Avoid serializing the event object in this case because we aren't sure what it is and what it contains
           log_debug(<<~MSG)

data/lib/sentry/configuration.rb

@@ -360,8 +360,47 @@ module Sentry
       def add_post_initialization_callback(&block)
         post_initialization_callbacks << block
       end
+
+      def validations
+        @validations ||= {}
+      end
+
+      def validate(attribute, optional: false, type: nil)
+        validations[attribute] = {
+          optional: optional,
+          type: type,
+          proc: build_validation_proc(optional, type)
+        }
+      end
+
+      private
+
+      def build_validation_proc(optional, type)
+        case type
+        when :numeric
+          ->(value) do
+            if optional && value.nil?
+              true
+            else
+              unless value.is_a?(Numeric)
+                message = "must be a Numeric"
+                message += " or nil" if optional
+
+                { error: message, value: value }
+              else
+                true
+              end
+            end
+          end
+        else
+          ->(value) { true }
+        end
+      end
     end
 
+    validate :traces_sample_rate, optional: true, type: :numeric
+    validate :profiles_sample_rate, optional: true, type: :numeric
+
     def initialize
       self.app_dirs_pattern = APP_DIRS_PATTERN
       self.debug = Sentry::Utils::EnvHelper.env_to_bool(ENV["SENTRY_DEBUG"])
@@ -417,6 +456,24 @@ module Sentry
       run_post_initialization_callbacks
     end
 
+    def validate
+      if profiler_class == Sentry::Profiler && profiles_sample_rate && !Sentry.dependency_installed?(:StackProf)
+        log_warn("Please add the 'stackprof' gem to your Gemfile to use the StackProf profiler with Sentry.")
+      end
+
+      if profiler_class == Sentry::Vernier::Profiler && profiles_sample_rate && !Sentry.dependency_installed?(:Vernier)
+        log_warn("Please add the 'vernier' gem to your Gemfile to use the Vernier profiler with Sentry.")
+      end
+
+      self.class.validations.each do |attribute, validation|
+        value = public_send(attribute)
+
+        next if (result = validation[:proc].call(value)) === true
+
+        raise ArgumentError, result[:error]
+      end
+    end
+
     def dsn=(value)
       @dsn = init_dsn(value)
     end
@@ -489,18 +546,11 @@ module Sentry
       @traces_sample_rate ||= 1.0 if enable_tracing
     end
 
-    def is_numeric_or_nil?(value)
-      value.is_a?(Numeric) || value.nil?
-    end
-
     def traces_sample_rate=(traces_sample_rate)
-      raise ArgumentError, "traces_sample_rate must be a Numeric or nil" unless is_numeric_or_nil?(traces_sample_rate)
       @traces_sample_rate = traces_sample_rate
     end
 
     def profiles_sample_rate=(profiles_sample_rate)
-      raise ArgumentError, "profiles_sample_rate must be a Numeric or nil" unless is_numeric_or_nil?(profiles_sample_rate)
-      log_warn("Please make sure to include the 'stackprof' gem in your Gemfile to use Profiling with Sentry.") unless defined?(StackProf)
       @profiles_sample_rate = profiles_sample_rate
     end
 
@@ -509,7 +559,6 @@ module Sentry
         begin
           require "vernier"
         rescue LoadError
-          raise ArgumentError, "Please add the 'vernier' gem to your Gemfile to use the Vernier profiler with Sentry."
         end
       end
 

data/lib/sentry/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sentry
-  VERSION = "5.22.2"
+  VERSION = "5.22.4"
 end

data/lib/sentry-ruby.rb

@@ -232,6 +232,7 @@ module Sentry
       yield(config) if block_given?
       config.detect_release
       apply_patches(config)
+      config.validate
       client = Client.new(config)
       scope = Scope.new(max_breadcrumbs: config.max_breadcrumbs)
       hub = Hub.new(client, scope)
@@ -608,6 +609,11 @@ module Sentry
     def utc_now
       Time.now.utc
     end
+
+    # @!visibility private
+    def dependency_installed?(name)
+      Object.const_defined?(name)
+    end
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby
 version: !ruby/object:Gem::Version
-  version: 5.22.2
+  version: 5.22.4
 platform: ruby
 authors:
 - Sentry Team
 bindir: bin
 cert_chain: []
-date: 2025-01-24 00:00:00.000000000 Z
+date: 2025-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -150,15 +150,15 @@ files:
 - lib/sentry/version.rb
 - sentry-ruby-core.gemspec
 - sentry-ruby.gemspec
-homepage: https://github.com/getsentry/sentry-ruby/tree/5.22.2/sentry-ruby
+homepage: https://github.com/getsentry/sentry-ruby/tree/5.22.4/sentry-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.22.2/sentry-ruby
-  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.22.2/sentry-ruby
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.22.2/CHANGELOG.md
+  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.22.4/sentry-ruby
+  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.22.4/sentry-ruby
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.22.4/CHANGELOG.md
   bug_tracker_uri: https://github.com/getsentry/sentry-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/5.22.2
+  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/5.22.4
 rdoc_options: []
 require_paths:
 - lib