sentry-ruby-core 4.7.3 → 4.8.3

data/lib/sentry/linecache.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module Sentry
+  # @api private
   class LineCache
     def initialize
       @cache = {}

data/lib/sentry/net/http.rb

@@ -1,6 +1,9 @@
+# frozen_string_literal: true
+
 require "net/http"
 
 module Sentry
+  # @api private
   module Net
     module HTTP
       OP_NAME = "net.http"

data/lib/sentry/rack/capture_exceptions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   module Rack
     class CaptureExceptions

data/lib/sentry/rack.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rack'
 
 require 'sentry/rack/capture_exceptions'

data/lib/sentry/rake.rb

@@ -1,11 +1,14 @@
+# frozen_string_literal: true
+
 require "rake"
 require "rake/task"
 
 module Sentry
   module Rake
     module Application
+      # @api private
       def display_error_message(ex)
-        Sentry.capture_exception(ex, hint: { background: false }) do |scope|
+        Sentry.capture_exception(ex) do |scope|
           task_name = top_level_tasks.join(' ')
           scope.set_transaction_name(task_name)
           scope.set_tag("rake_task", task_name)
@@ -16,16 +19,23 @@ module Sentry
     end
 
     module Task
+      # @api private
       def execute(args=nil)
         return super unless Sentry.initialized? && Sentry.get_current_hub
 
-        Sentry.get_current_hub.with_background_worker_disabled do
-          super
-        end
+        super
       end
     end
   end
 end
 
-Rake::Application.prepend(Sentry::Rake::Application)
-Rake::Task.prepend(Sentry::Rake::Task)
+# @api private
+module Rake
+  class Application
+    prepend(Sentry::Rake::Application)
+  end
+
+  class Task
+    prepend(Sentry::Rake::Task)
+  end
+end

data/lib/sentry/release_detector.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Sentry
+  # @api private
+  class ReleaseDetector
+    class << self
+      def detect_release(project_root:, running_on_heroku:)
+        detect_release_from_env ||
+        detect_release_from_git ||
+        detect_release_from_capistrano(project_root) ||
+        detect_release_from_heroku(running_on_heroku)
+      end
+
+      def detect_release_from_heroku(running_on_heroku)
+        return unless running_on_heroku
+        ENV['HEROKU_SLUG_COMMIT']
+      end
+
+      def detect_release_from_capistrano(project_root)
+        revision_file = File.join(project_root, 'REVISION')
+        revision_log = File.join(project_root, '..', 'revisions.log')
+
+        if File.exist?(revision_file)
+          File.read(revision_file).strip
+        elsif File.exist?(revision_log)
+          File.open(revision_log).to_a.last.strip.sub(/.*as release ([0-9]+).*/, '\1')
+        end
+      end
+
+      def detect_release_from_git
+        Sentry.sys_command("git rev-parse --short HEAD") if File.directory?(".git")
+      end
+
+      def detect_release_from_env
+        ENV['SENTRY_RELEASE']
+      end
+    end
+  end
+end

data/lib/sentry/scope.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "sentry/breadcrumb_buffer"
 require "etc"
 
@@ -112,7 +114,7 @@ module Sentry
     end
 
     def set_extra(key, value)
-      @extra.merge!(key => value)
+      set_extras(key => value)
     end
 
     def set_tags(tags_hash)
@@ -121,17 +123,19 @@ module Sentry
     end
 
     def set_tag(key, value)
-      @tags.merge!(key => value)
+      set_tags(key => value)
     end
 
     def set_contexts(contexts_hash)
       check_argument_type!(contexts_hash, Hash)
-      @contexts.merge!(contexts_hash)
+      @contexts.merge!(contexts_hash) do |key, old, new|
+        new.merge(old)
+      end
     end
 
     def set_context(key, value)
       check_argument_type!(value, Hash)
-      @contexts.merge!(key => value)
+      set_contexts(key => value)
     end
 
     def set_level(level)

data/lib/sentry/span.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "securerandom"
 
 module Sentry

data/lib/sentry/transaction.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   class Transaction < Span
     SENTRY_TRACE_REGEXP = Regexp.new(
@@ -129,7 +131,10 @@ module Sentry
         @name = UNLABELD_NAME
       end
 
-      return unless @sampled || @parent_sampled
+      unless @sampled || @parent_sampled
+        hub.current_client.transport.record_lost_event(:sample_rate, 'transaction')
+        return
+      end
 
       event = hub.current_client.event_from_transaction(self)
       hub.capture_event(event)

data/lib/sentry/transport/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   class Transport
     class Configuration

data/lib/sentry/transport/dummy_transport.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   class DummyTransport < Transport
     attr_accessor :events

data/lib/sentry/transport/http_transport.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'zlib'
 
@@ -139,10 +141,10 @@ module Sentry
     end
 
     def ssl_configuration
-      (@transport_configuration.ssl || {}).merge(
-        :verify => @transport_configuration.ssl_verification,
-        :ca_file => @transport_configuration.ssl_ca_file
-      )
+      {
+        verify: @transport_configuration.ssl_verification,
+        ca_file: @transport_configuration.ssl_ca_file
+      }.merge(@transport_configuration.ssl || {})
     end
   end
 end

data/lib/sentry/transport.rb

@@ -1,22 +1,41 @@
+# frozen_string_literal: true
+
 require "json"
 require "base64"
+require "sentry/envelope"
 
 module Sentry
   class Transport
     PROTOCOL_VERSION = '7'
     USER_AGENT = "sentry-ruby/#{Sentry::VERSION}"
+    CLIENT_REPORT_INTERVAL = 30
+
+    # https://develop.sentry.dev/sdk/client-reports/#envelope-item-payload
+    CLIENT_REPORT_REASONS = [
+      :ratelimit_backoff,
+      :queue_overflow,
+      :cache_overflow, # NA
+      :network_error,
+      :sample_rate,
+      :before_send,
+      :event_processor
+    ]
 
     include LoggingHelper
 
-    attr_accessor :configuration
-    attr_reader :logger, :rate_limits
+    attr_reader :logger, :rate_limits, :discarded_events, :last_client_report_sent
 
     def initialize(configuration)
-      @configuration = configuration
       @logger = configuration.logger
       @transport_configuration = configuration.transport
       @dsn = configuration.dsn
       @rate_limits = {}
+      @send_client_reports = configuration.send_client_reports
+
+      if @send_client_reports
+        @discarded_events = Hash.new(0)
+        @last_client_report_sent = Time.now
+      end
     end
 
     def send_data(data, options = {})
@@ -27,14 +46,9 @@ module Sentry
       event_hash = event.to_hash
       item_type = get_item_type(event_hash)
 
-      unless configuration.sending_allowed?
-        log_debug("Envelope [#{item_type}] not sent: #{configuration.error_messages}")
-
-        return
-      end
-
       if is_rate_limited?(item_type)
         log_info("Envelope [#{item_type}] not sent: rate limiting")
+        record_lost_event(:ratelimit_backoff, item_type)
 
         return
       end
@@ -91,20 +105,38 @@ module Sentry
 
     def encode(event)
       # Convert to hash
-      event_hash = event.to_hash
+      event_payload = event.to_hash
+      event_id = event_payload[:event_id] || event_payload["event_id"]
+      item_type = get_item_type(event_payload)
+
+      envelope = Envelope.new(
+        {
+          event_id: event_id,
+          dsn: @dsn.to_s,
+          sdk: Sentry.sdk_meta,
+          sent_at: Sentry.utc_now.iso8601
+        }
+      )
+
+      envelope.add_item(
+        { type: item_type, content_type: 'application/json' },
+        event_payload
+      )
+
+      client_report_headers, client_report_payload = fetch_pending_client_report
+      envelope.add_item(client_report_headers, client_report_payload) if client_report_headers
 
-      event_id = event_hash[:event_id] || event_hash["event_id"]
-      item_type = get_item_type(event_hash)
+      log_info("Sending envelope [#{item_type}] #{event_id} to Sentry")
 
-      envelope = <<~ENVELOPE
-        {"event_id":"#{event_id}","dsn":"#{configuration.dsn.to_s}","sdk":#{Sentry.sdk_meta.to_json},"sent_at":"#{Sentry.utc_now.iso8601}"}
-        {"type":"#{item_type}","content_type":"application/json"}
-        #{JSON.generate(event_hash)}
-      ENVELOPE
+      envelope.to_s
+    end
 
-      log_info("Sending envelope [#{item_type}] #{event_id} to Sentry")
+    def record_lost_event(reason, item_type)
+      return unless @send_client_reports
+      return unless CLIENT_REPORT_REASONS.include?(reason)
 
-      envelope
+      item_type ||= 'event'
+      @discarded_events[[reason, item_type]] += 1
     end
 
     private
@@ -112,6 +144,32 @@ module Sentry
     def get_item_type(event_hash)
       event_hash[:type] || event_hash["type"] || "event"
     end
+
+    def fetch_pending_client_report
+      return nil unless @send_client_reports
+      return nil if @last_client_report_sent > Time.now - CLIENT_REPORT_INTERVAL
+      return nil if @discarded_events.empty?
+
+      discarded_events_hash = @discarded_events.map do |key, val|
+        reason, type = key
+
+        # 'event' has to be mapped to 'error'
+        category = type == 'transaction' ? 'transaction' : 'error'
+
+        { reason: reason, category: category, quantity: val }
+      end
+
+      item_header = { type: 'client_report' }
+      item_payload = {
+        timestamp: Sentry.utc_now.iso8601,
+        discarded_events: discarded_events_hash
+      }
+
+      @discarded_events = Hash.new(0)
+      @last_client_report_sent = Time.now
+
+      [item_header, item_payload]
+    end
   end
 end
 

data/lib/sentry/utils/argument_checking_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   module ArgumentCheckingHelper
     private

data/lib/sentry/utils/custom_inspection.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Sentry
+  module CustomInspection
+    def inspect
+      attr_strings = (instance_variables - self.class::SKIP_INSPECTION_ATTRIBUTES).each_with_object([]) do |attr, result|
+        value = instance_variable_get(attr)
+        result << "#{attr}=#{value.inspect}" if value
+      end
+
+      "#<#{self.class.name} #{attr_strings.join(", ")}>"
+    end
+  end
+end

data/lib/sentry/utils/exception_cause_chain.rb

@@ -1,19 +1,19 @@
+# frozen_string_literal: true
+
 module Sentry
   module Utils
     module ExceptionCauseChain
       def self.exception_to_array(exception)
-        if exception.respond_to?(:cause) && exception.cause
-          exceptions = [exception]
-          while exception.cause
-            exception = exception.cause
-            break if exceptions.any? { |e| e.object_id == exception.object_id }
+        exceptions = [exception]
+
+        while exception.cause
+          exception = exception.cause
+          break if exceptions.any? { |e| e.object_id == exception.object_id }
 
-            exceptions << exception
-          end
-          exceptions
-        else
-          [exception]
+          exceptions << exception
         end
+
+        exceptions
       end
     end
   end

data/lib/sentry/utils/logging_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   module LoggingHelper
     def log_error(message, exception, debug: false)

data/lib/sentry/utils/real_ip.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ipaddr'
 
 # Based on ActionDispatch::RemoteIp. All security-related precautions from that

data/lib/sentry/utils/request_id.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
   module Utils
     module RequestId

data/lib/sentry/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Sentry
-  VERSION = "4.7.3"
+  VERSION = "4.8.3"
 end