sentry-ruby 5.21.0 → 5.22.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf62f77a0a968d4080fac612bf67f996bee72b51e050e17bf8d40c04c9c895ea
-  data.tar.gz: 348af55b8f56829cbf5fc5569ddc8308d4cd6ae508480de206443349e1221235
+  metadata.gz: 7cf4ebc58389dd621be706b53b86c30e689f9f52c5d5cbda72ef01528c540e5a
+  data.tar.gz: f347cb6245d5d37f2d883870b26d846244d33ef6cbb67b838fe231d1c17e95f8
 SHA512:
-  metadata.gz: 5baaf6d507772d4a3882a99a43b3f4c88ae4ee56ddfd505433dc88b1e1f21430a2b8fa374932ec4b94478e054a9d1baf12789594bcfe9574db94f449b6526fc2
-  data.tar.gz: 8eacb9b0e326b529c743af650920b17e382b379032895d112a83689965a53fe42ae48eb9c070cd86085b1d7d5d9cc7300e0d9199b975edc25ee4aca1f093ecd6
+  metadata.gz: 2dae846cd0a9d3c10d41d44a775bd39e6d175f559924bf101cd2a88816145ea2cf048962504615d5f05acca0b59451483a2b602a9fb87bba3b2be4364493fd27
+  data.tar.gz: b17875017e20c0126c8ddc5d360873430c92d69f0633134743198140c2258f828b3b444748c7a4cd8e0bb9137a9990f2dc394182ffcfe6a19d1e0f3795beebcd

data/Gemfile

@@ -28,5 +28,6 @@ gem "benchmark-memory"
 gem "yard", github: "lsegal/yard"
 gem "webrick"
 gem "faraday"
+gem "excon"
 
 eval_gemfile File.expand_path("../Gemfile", __dir__)

data/lib/sentry/excon/middleware.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module Sentry
+  module Excon
+    OP_NAME = "http.client"
+
+    class Middleware < ::Excon::Middleware::Base
+      def initialize(stack)
+        super
+        @instrumenter = Instrumenter.new
+      end
+
+      def request_call(datum)
+        @instrumenter.start_transaction(datum)
+        @stack.request_call(datum)
+      end
+
+      def response_call(datum)
+        @instrumenter.finish_transaction(datum)
+        @stack.response_call(datum)
+      end
+    end
+
+    class Instrumenter
+      SPAN_ORIGIN = "auto.http.excon"
+      BREADCRUMB_CATEGORY = "http"
+
+      include Utils::HttpTracing
+
+      def start_transaction(env)
+        return unless Sentry.initialized?
+
+        current_span = Sentry.get_current_scope&.span
+        @span = current_span&.start_child(op: OP_NAME, start_timestamp: Sentry.utc_now.to_f, origin: SPAN_ORIGIN)
+
+        request_info = extract_request_info(env)
+
+        if propagate_trace?(request_info[:url])
+          set_propagation_headers(env[:headers])
+        end
+      end
+
+      def finish_transaction(response)
+        return unless @span
+
+        response_status = response[:response][:status]
+        request_info = extract_request_info(response)
+
+        if record_sentry_breadcrumb?
+          record_sentry_breadcrumb(request_info, response_status)
+        end
+
+        set_span_info(@span, request_info, response_status)
+      ensure
+        @span&.finish
+      end
+
+      private
+
+      def extract_request_info(env)
+        url = env[:scheme] + "://" + env[:hostname] + env[:path]
+        result = { method: env[:method].to_s.upcase, url: url }
+
+        if Sentry.configuration.send_default_pii
+          result[:query] = env[:query]
+
+          # Handle excon 1.0.0+
+          result[:query] = build_nested_query(result[:query]) unless result[:query].is_a?(String)
+
+          result[:body] = env[:body]
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/sentry/excon.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+Sentry.register_patch(:excon) do
+  if defined?(::Excon)
+    require "sentry/excon/middleware"
+    if Excon.defaults[:middlewares]
+      Excon.defaults[:middlewares] << Sentry::Excon::Middleware unless Excon.defaults[:middlewares].include?(Sentry::Excon::Middleware)
+    end
+  end
+end

data/lib/sentry/hub.rb

@@ -255,7 +255,11 @@ module Sentry
 
       return unless session
       session.close
-      Sentry.session_flusher.add_session(session)
+
+      # NOTE: Under some circumstances, session_flusher nilified out of sync
+      #   See: https://github.com/getsentry/sentry-ruby/issues/2378
+      #   See: https://github.com/getsentry/sentry-ruby/pull/2396
+      Sentry.session_flusher&.add_session(session)
     end
 
     def with_session_tracking(&block)

data/lib/sentry/rspec.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+RSpec::Matchers.define :include_sentry_event do |event_message = "", **opts|
+  match do |sentry_events|
+    @expected_exception = expected_exception(**opts)
+    @context = context(**opts)
+    @tags = tags(**opts)
+
+    @expected_event = expected_event(event_message)
+    @matched_event = find_matched_event(event_message, sentry_events)
+
+    return false unless @matched_event
+
+    [verify_context(), verify_tags()].all?
+  end
+
+  chain :with_context do |context|
+    @context = context
+  end
+
+  chain :with_tags do |tags|
+    @tags = tags
+  end
+
+  failure_message do |sentry_events|
+    info = ["Failed to find event matching:\n"]
+    info << "  message: #{@expected_event.message.inspect}"
+    info << "  exception: #{@expected_exception.inspect}"
+    info << "  context: #{@context.inspect}"
+    info << "  tags: #{@tags.inspect}"
+    info << "\n"
+    info << "Captured events:\n"
+    info << dump_events(sentry_events)
+    info.join("\n")
+  end
+
+  def expected_event(event_message)
+    if @expected_exception
+      Sentry.get_current_client.event_from_exception(@expected_exception)
+    else
+      Sentry.get_current_client.event_from_message(event_message)
+    end
+  end
+
+  def expected_exception(**opts)
+    opts[:exception].new(opts[:message]) if opts[:exception]
+  end
+
+  def context(**opts)
+    opts.fetch(:context, @context || {})
+  end
+
+  def tags(**opts)
+    opts.fetch(:tags, @tags || {})
+  end
+
+  def find_matched_event(event_message, sentry_events)
+    @matched_event ||= sentry_events
+      .find { |event|
+        if @expected_exception
+          # Is it OK that we only compare the first exception?
+          event_exception = event.exception.values.first
+          expected_event_exception = @expected_event.exception.values.first
+
+          event_exception.type == expected_event_exception.type && event_exception.value == expected_event_exception.value
+        else
+          event.message == @expected_event.message
+        end
+      }
+  end
+
+  def dump_events(sentry_events)
+    sentry_events.map(&Kernel.method(:Hash)).map do |hash|
+      hash.select { |k, _| [:message, :contexts, :tags, :exception].include?(k) }
+    end.map do |hash|
+      JSON.pretty_generate(hash)
+    end.join("\n\n")
+  end
+
+  def verify_context
+    return true if @context.empty?
+
+    @matched_event.contexts.any? { |key, value| value == @context[key] }
+  end
+
+  def verify_tags
+    return true if @tags.empty?
+
+    @tags.all? { |key, value| @matched_event.tags.include?(key) && @matched_event.tags[key] == value }
+  end
+end

data/lib/sentry/session_flusher.rb

@@ -10,6 +10,7 @@ module Sentry
       @pending_aggregates = {}
       @release = configuration.release
       @environment = configuration.environment
+      @mutex = Mutex.new
 
       log_debug("[Sessions] Sessions won't be captured without a valid release") unless @release
     end
@@ -18,7 +19,6 @@ module Sentry
       return if @pending_aggregates.empty?
 
       @client.capture_envelope(pending_envelope)
-      @pending_aggregates = {}
     end
 
     alias_method :run, :flush
@@ -42,11 +42,15 @@ module Sentry
     end
 
     def pending_envelope
-      envelope = Envelope.new
+      aggregates = @mutex.synchronize do
+        aggregates = @pending_aggregates.values
+        @pending_aggregates = {}
+        aggregates
+      end
 
+      envelope = Envelope.new
       header = { type: "sessions" }
-      payload = { attrs: attrs, aggregates: @pending_aggregates.values }
-
+      payload = { attrs: attrs, aggregates: aggregates }
       envelope.add_item(header, payload)
       envelope
     end

data/lib/sentry/span.rb

@@ -44,6 +44,11 @@ module Sentry
       LINENO = "code.lineno"
       FUNCTION = "code.function"
       NAMESPACE = "code.namespace"
+
+      MESSAGING_MESSAGE_ID = "messaging.message.id"
+      MESSAGING_DESTINATION_NAME = "messaging.destination.name"
+      MESSAGING_MESSAGE_RECEIVE_LATENCY = "messaging.message.receive.latency"
+      MESSAGING_MESSAGE_RETRY_COUNT = "messaging.message.retry.count"
     end
 
     STATUS_MAP = {

data/lib/sentry/utils/http_tracing.rb

@@ -19,7 +19,7 @@ module Sentry
         crumb = Sentry::Breadcrumb.new(
           level: :info,
           category: self.class::BREADCRUMB_CATEGORY,
-          type: :info,
+          type: "info",
           data: { status: response_status, **request_info }
         )
 
@@ -36,6 +36,25 @@ module Sentry
           Sentry.configuration.propagate_traces &&
           Sentry.configuration.trace_propagation_targets.any? { |target| url.match?(target) }
       end
+
+      # Kindly borrowed from Rack::Utils
+      def build_nested_query(value, prefix = nil)
+        case value
+        when Array
+          value.map { |v|
+            build_nested_query(v, "#{prefix}[]")
+          }.join("&")
+        when Hash
+          value.map { |k, v|
+            build_nested_query(v, prefix ? "#{prefix}[#{k}]" : k)
+          }.delete_if(&:empty?).join("&")
+        when nil
+          URI.encode_www_form_component(prefix)
+        else
+          raise ArgumentError, "value must be a Hash" if prefix.nil?
+          "#{URI.encode_www_form_component(prefix)}=#{URI.encode_www_form_component(value)}"
+        end
+      end
     end
   end
 end

data/lib/sentry/vernier/profiler.rb

@@ -55,8 +55,7 @@ module Sentry
         return unless @sampled
         return if @started
 
-        ::Vernier.start_profile
-        @started = true
+        @started = ::Vernier.start_profile
 
         log("Started")
 
@@ -77,6 +76,12 @@ module Sentry
         @result = ::Vernier.stop_profile
 
         log("Stopped")
+      rescue RuntimeError => e
+        if e.message.include?("Profile not started")
+          log("Not stopped since not started")
+        else
+          log("Failed to stop Vernier: #{e.message}")
+        end
       end
 
       def active_thread_id

data/lib/sentry/version.rb

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

data/lib/sentry-ruby.rb

@@ -50,6 +50,8 @@ module Sentry
 
   THREAD_LOCAL = :sentry_hub
 
+  MUTEX = Mutex.new
+
   class << self
     # @!visibility private
     def exception_locals_tp
@@ -275,8 +277,10 @@ module Sentry
 
       @background_worker.shutdown
 
-      @main_hub = nil
-      Thread.current.thread_variable_set(THREAD_LOCAL, nil)
+      MUTEX.synchronize do
+        @main_hub = nil
+        Thread.current.thread_variable_set(THREAD_LOCAL, nil)
+      end
     end
 
     # Returns true if the SDK is initialized.
@@ -303,7 +307,7 @@ module Sentry
     #
     # @return [Hub]
     def get_main_hub
-      @main_hub
+      MUTEX.synchronize { @main_hub }
     end
 
     # Takes an instance of Sentry::Breadcrumb and stores it to the current active scope.
@@ -610,3 +614,4 @@ require "sentry/redis"
 require "sentry/puma"
 require "sentry/graphql"
 require "sentry/faraday"
+require "sentry/excon"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sentry-ruby
 version: !ruby/object:Gem::Version
-  version: 5.21.0
+  version: 5.22.1
 platform: ruby
 authors:
 - Sentry Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-07 00:00:00.000000000 Z
+date: 2024-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -87,6 +87,8 @@ files:
 - lib/sentry/error_event.rb
 - lib/sentry/event.rb
 - lib/sentry/exceptions.rb
+- lib/sentry/excon.rb
+- lib/sentry/excon/middleware.rb
 - lib/sentry/faraday.rb
 - lib/sentry/graphql.rb
 - lib/sentry/hub.rb
@@ -121,6 +123,7 @@ files:
 - lib/sentry/rake.rb
 - lib/sentry/redis.rb
 - lib/sentry/release_detector.rb
+- lib/sentry/rspec.rb
 - lib/sentry/scope.rb
 - lib/sentry/session.rb
 - lib/sentry/session_flusher.rb
@@ -148,15 +151,15 @@ files:
 - lib/sentry/version.rb
 - sentry-ruby-core.gemspec
 - sentry-ruby.gemspec
-homepage: https://github.com/getsentry/sentry-ruby/tree/5.21.0/sentry-ruby
+homepage: https://github.com/getsentry/sentry-ruby/tree/5.22.1/sentry-ruby
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.21.0/sentry-ruby
-  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.21.0/sentry-ruby
-  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.21.0/CHANGELOG.md
+  homepage_uri: https://github.com/getsentry/sentry-ruby/tree/5.22.1/sentry-ruby
+  source_code_uri: https://github.com/getsentry/sentry-ruby/tree/5.22.1/sentry-ruby
+  changelog_uri: https://github.com/getsentry/sentry-ruby/blob/5.22.1/CHANGELOG.md
   bug_tracker_uri: https://github.com/getsentry/sentry-ruby/issues
-  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/5.21.0
+  documentation_uri: http://www.rubydoc.info/gems/sentry-ruby/5.22.1
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -172,7 +175,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 a client interface for the Sentry error logger