sentry-ruby 5.4.0 → 5.4.1

data/lib/sentry/dsn.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module Sentry
+  class DSN
+    PORT_MAP = { 'http' => 80, 'https' => 443 }.freeze
+    REQUIRED_ATTRIBUTES = %w(host path public_key project_id).freeze
+
+    attr_reader :scheme, :secret_key, :port, *REQUIRED_ATTRIBUTES
+
+    def initialize(dsn_string)
+      @raw_value = dsn_string
+
+      uri = URI.parse(dsn_string)
+      uri_path = uri.path.split('/')
+
+      if uri.user
+        # DSN-style string
+        @project_id = uri_path.pop
+        @public_key = uri.user
+        @secret_key = !(uri.password.nil? || uri.password.empty?) ? uri.password : nil
+      end
+
+      @scheme = uri.scheme
+      @host = uri.host
+      @port = uri.port if uri.port
+      @path = uri_path.join('/')
+    end
+
+    def valid?
+      REQUIRED_ATTRIBUTES.all? { |k| public_send(k) }
+    end
+
+    def to_s
+      @raw_value
+    end
+
+    def server
+      server = "#{scheme}://#{host}"
+      server += ":#{port}" unless port == PORT_MAP[scheme]
+      server
+    end
+
+    def csp_report_uri
+      "#{server}/api/#{project_id}/security/?sentry_key=#{public_key}"
+    end
+
+    def envelope_endpoint
+      "#{path}/api/#{project_id}/envelope/"
+    end
+  end
+end

data/lib/sentry/envelope.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Sentry
+  # @api private
+  class Envelope
+    class Item
+      STACKTRACE_FRAME_LIMIT_ON_OVERSIZED_PAYLOAD = 500
+      MAX_SERIALIZED_PAYLOAD_SIZE = 1024 * 200
+
+      attr_accessor :headers, :payload
+
+      def initialize(headers, payload)
+        @headers = headers
+        @payload = payload
+      end
+
+      def type
+        @headers[:type] || 'event'
+      end
+
+      def to_s
+        <<~ITEM
+          #{JSON.generate(@headers)}
+          #{JSON.generate(@payload)}
+        ITEM
+      end
+
+      def serialize
+        result = to_s
+
+        if result.bytesize > MAX_SERIALIZED_PAYLOAD_SIZE
+          remove_breadcrumbs!
+          result = to_s
+        end
+
+        if result.bytesize > MAX_SERIALIZED_PAYLOAD_SIZE
+          reduce_stacktrace!
+          result = to_s
+        end
+
+        [result, result.bytesize > MAX_SERIALIZED_PAYLOAD_SIZE]
+      end
+
+      def size_breakdown
+        payload.map do |key, value|
+          "#{key}: #{JSON.generate(value).bytesize}"
+        end.join(", ")
+      end
+
+      private
+
+      def remove_breadcrumbs!
+        if payload.key?(:breadcrumbs)
+          payload.delete(:breadcrumbs)
+        elsif payload.key?("breadcrumbs")
+          payload.delete("breadcrumbs")
+        end
+      end
+
+      def reduce_stacktrace!
+        if exceptions = payload.dig(:exception, :values) || payload.dig("exception", "values")
+          exceptions.each do |exception|
+            # in most cases there is only one exception (2 or 3 when have multiple causes), so we won't loop through this double condition much
+            traces = exception.dig(:stacktrace, :frames) || exception.dig("stacktrace", "frames")
+
+            if traces && traces.size > STACKTRACE_FRAME_LIMIT_ON_OVERSIZED_PAYLOAD
+              size_on_both_ends = STACKTRACE_FRAME_LIMIT_ON_OVERSIZED_PAYLOAD / 2
+              traces.replace(
+                traces[0..(size_on_both_ends - 1)] + traces[-size_on_both_ends..-1],
+              )
+            end
+          end
+        end
+      end
+    end
+
+    attr_accessor :headers, :items
+
+    def initialize(headers = {})
+      @headers = headers
+      @items = []
+    end
+
+    def add_item(headers, payload)
+      @items << Item.new(headers, payload)
+    end
+
+    def item_types
+      @items.map(&:type)
+    end
+
+    def event_id
+      @headers[:event_id]
+    end
+  end
+end

data/lib/sentry/error_event.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Sentry
+  # ErrorEvent represents error or normal message events.
+  class ErrorEvent < Event
+    # @return [ExceptionInterface]
+    attr_reader :exception
+
+    # @return [ThreadsInterface]
+    attr_reader :threads
+
+    # @return [Hash]
+    def to_hash
+      data = super
+      data[:threads] = threads.to_hash if threads
+      data[:exception] = exception.to_hash if exception
+      data
+    end
+
+    # @!visibility private
+    def add_threads_interface(backtrace: nil, **options)
+      @threads = ThreadsInterface.build(
+        backtrace: backtrace,
+        stacktrace_builder: @stacktrace_builder,
+        **options
+      )
+    end
+
+    # @!visibility private
+    def add_exception_interface(exception)
+      if exception.respond_to?(:sentry_context)
+        @extra.merge!(exception.sentry_context)
+      end
+
+      @exception = Sentry::ExceptionInterface.build(exception: exception, stacktrace_builder: @stacktrace_builder)
+    end
+  end
+end

data/lib/sentry/event.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require 'socket'
+require 'securerandom'
+require 'sentry/interface'
+require 'sentry/backtrace'
+require 'sentry/utils/real_ip'
+require 'sentry/utils/request_id'
+require 'sentry/utils/custom_inspection'
+
+module Sentry
+  # This is an abstract class that defines the shared attributes of an event.
+  # Please don't use it directly. The user-facing classes are its child classes.
+  class Event
+    TYPE = "event"
+    # These are readable attributes.
+    SERIALIZEABLE_ATTRIBUTES = %i(
+      event_id level timestamp
+      release environment server_name modules
+      message user tags contexts extra
+      fingerprint breadcrumbs transaction
+      platform sdk type
+    )
+
+    # These are writable attributes.
+    WRITER_ATTRIBUTES = SERIALIZEABLE_ATTRIBUTES - %i(type timestamp level)
+
+    MAX_MESSAGE_SIZE_IN_BYTES = 1024 * 8
+
+    SKIP_INSPECTION_ATTRIBUTES = [:@modules, :@stacktrace_builder, :@send_default_pii, :@trusted_proxies, :@rack_env_whitelist]
+
+    include CustomInspection
+
+    attr_writer(*WRITER_ATTRIBUTES)
+    attr_reader(*SERIALIZEABLE_ATTRIBUTES)
+
+    # @return [RequestInterface]
+    attr_reader :request
+
+    # @param configuration [Configuration]
+    # @param integration_meta [Hash, nil]
+    # @param message [String, nil]
+    def initialize(configuration:, integration_meta: nil, message: nil)
+      # Set some simple default values
+      @event_id      = SecureRandom.uuid.delete("-")
+      @timestamp     = Sentry.utc_now.iso8601
+      @platform      = :ruby
+      @type          = self.class::TYPE
+      @sdk           = integration_meta || Sentry.sdk_meta
+
+      @user          = {}
+      @extra         = {}
+      @contexts      = {}
+      @tags          = {}
+
+      @fingerprint = []
+
+      # configuration data that's directly used by events
+      @server_name = configuration.server_name
+      @environment = configuration.environment
+      @release = configuration.release
+      @modules = configuration.gem_specs if configuration.send_modules
+
+      # configuration options to help events process data
+      @send_default_pii = configuration.send_default_pii
+      @trusted_proxies = configuration.trusted_proxies
+      @stacktrace_builder = configuration.stacktrace_builder
+      @rack_env_whitelist = configuration.rack_env_whitelist
+
+      @message = (message || "").byteslice(0..MAX_MESSAGE_SIZE_IN_BYTES)
+    end
+
+    class << self
+      # @!visibility private
+      def get_log_message(event_hash)
+        message = event_hash[:message] || event_hash['message']
+
+        return message unless message.nil? || message.empty?
+
+        message = get_message_from_exception(event_hash)
+
+        return message unless message.nil? || message.empty?
+
+        message = event_hash[:transaction] || event_hash["transaction"]
+
+        return message unless message.nil? || message.empty?
+
+        '<no message value>'
+      end
+
+      # @!visibility private
+      def get_message_from_exception(event_hash)
+        if exception = event_hash.dig(:exception, :values, 0)
+          "#{exception[:type]}: #{exception[:value]}"
+        elsif exception = event_hash.dig("exception", "values", 0)
+          "#{exception["type"]}: #{exception["value"]}"
+        end
+      end
+    end
+
+    # @deprecated This method will be removed in v5.0.0. Please just use Sentry.configuration
+    # @return [Configuration]
+    def configuration
+      Sentry.configuration
+    end
+
+    # Sets the event's timestamp.
+    # @param time [Time, Float]
+    # @return [void]
+    def timestamp=(time)
+      @timestamp = time.is_a?(Time) ? time.to_f : time
+    end
+
+    # Sets the event's level.
+    # @param level [String, Symbol]
+    # @return [void]
+    def level=(level) # needed to meet the Sentry spec
+      @level = level.to_s == "warn" ? :warning : level
+    end
+
+    # Sets the event's request environment data with RequestInterface.
+    # @see RequestInterface
+    # @param env [Hash]
+    # @return [void]
+    def rack_env=(env)
+      unless request || env.empty?
+        add_request_interface(env)
+
+        if @send_default_pii
+          user[:ip_address] = calculate_real_ip_from_rack(env)
+        end
+
+        if request_id = Utils::RequestId.read_from(env)
+          tags[:request_id] = request_id
+        end
+      end
+    end
+
+    # @return [Hash]
+    def to_hash
+      data = serialize_attributes
+      data[:breadcrumbs] = breadcrumbs.to_hash if breadcrumbs
+      data[:request] = request.to_hash if request
+      data
+    end
+
+    # @return [Hash]
+    def to_json_compatible
+      JSON.parse(JSON.generate(to_hash))
+    end
+
+    private
+
+    def add_request_interface(env)
+      @request = Sentry::RequestInterface.new(env: env, send_default_pii: @send_default_pii, rack_env_whitelist: @rack_env_whitelist)
+    end
+
+    def serialize_attributes
+      self.class::SERIALIZEABLE_ATTRIBUTES.each_with_object({}) do |att, memo|
+        if value = public_send(att)
+          memo[att] = value
+        end
+      end
+    end
+
+    # When behind a proxy (or if the user is using a proxy), we can't use
+    # REMOTE_ADDR to determine the Event IP, and must use other headers instead.
+    def calculate_real_ip_from_rack(env)
+      Utils::RealIp.new(
+        :remote_addr => env["REMOTE_ADDR"],
+        :client_ip => env["HTTP_CLIENT_IP"],
+        :real_ip => env["HTTP_X_REAL_IP"],
+        :forwarded_for => env["HTTP_X_FORWARDED_FOR"],
+        :trusted_proxies => @trusted_proxies
+      ).calculate_ip
+    end
+  end
+end

data/lib/sentry/exceptions.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Sentry
+  class Error < StandardError
+  end
+
+  class ExternalError < Error
+  end
+end

data/lib/sentry/hub.rb

@@ -0,0 +1,220 @@
+# frozen_string_literal: true
+
+require "sentry/scope"
+require "sentry/client"
+require "sentry/session"
+
+module Sentry
+  class Hub
+    include ArgumentCheckingHelper
+
+    attr_reader :last_event_id
+
+    def initialize(client, scope)
+      first_layer = Layer.new(client, scope)
+      @stack = [first_layer]
+      @last_event_id = nil
+    end
+
+    def new_from_top
+      Hub.new(current_client, current_scope)
+    end
+
+    def current_client
+      current_layer&.client
+    end
+
+    def configuration
+      current_client.configuration
+    end
+
+    def current_scope
+      current_layer&.scope
+    end
+
+    def clone
+      layer = current_layer
+
+      if layer
+        scope = layer.scope&.dup
+
+        Hub.new(layer.client, scope)
+      end
+    end
+
+    def bind_client(client)
+      layer = current_layer
+
+      if layer
+        layer.client = client
+      end
+    end
+
+    def configure_scope(&block)
+      block.call(current_scope)
+    end
+
+    def with_scope(&block)
+      push_scope
+      yield(current_scope)
+    ensure
+      pop_scope
+    end
+
+    def push_scope
+      new_scope =
+        if current_scope
+          current_scope.dup
+        else
+          Scope.new
+        end
+
+      @stack << Layer.new(current_client, new_scope)
+    end
+
+    def pop_scope
+      @stack.pop
+    end
+
+    def start_transaction(transaction: nil, custom_sampling_context: {}, **options)
+      return unless configuration.tracing_enabled?
+
+      transaction ||= Transaction.new(**options.merge(hub: self))
+
+      sampling_context = {
+        transaction_context: transaction.to_hash,
+        parent_sampled: transaction.parent_sampled
+      }
+
+      sampling_context.merge!(custom_sampling_context)
+
+      transaction.set_initial_sample_decision(sampling_context: sampling_context)
+      transaction
+    end
+
+    def capture_exception(exception, **options, &block)
+      check_argument_type!(exception, ::Exception)
+
+      return if Sentry.exception_captured?(exception)
+
+      return unless current_client
+
+      options[:hint] ||= {}
+      options[:hint][:exception] = exception
+      event = current_client.event_from_exception(exception, options[:hint])
+
+      return unless event
+
+      current_scope.session&.update_from_exception(event.exception)
+
+      capture_event(event, **options, &block).tap do
+        # mark the exception as captured so we can use this information to avoid duplicated capturing
+        exception.instance_variable_set(Sentry::CAPTURED_SIGNATURE, true)
+      end
+    end
+
+    def capture_message(message, **options, &block)
+      check_argument_type!(message, ::String)
+
+      return unless current_client
+
+      options[:hint] ||= {}
+      options[:hint][:message] = message
+      backtrace = options.delete(:backtrace)
+      event = current_client.event_from_message(message, options[:hint], backtrace: backtrace)
+
+      return unless event
+
+      capture_event(event, **options, &block)
+    end
+
+    def capture_event(event, **options, &block)
+      check_argument_type!(event, Sentry::Event)
+
+      return unless current_client
+
+      hint = options.delete(:hint) || {}
+      scope = current_scope.dup
+
+      if block
+        block.call(scope)
+      elsif custom_scope = options[:scope]
+        scope.update_from_scope(custom_scope)
+      elsif !options.empty?
+        scope.update_from_options(**options)
+      end
+
+      event = current_client.capture_event(event, scope, hint)
+
+      if event && configuration.debug
+        configuration.log_debug(event.to_json_compatible)
+      end
+
+      @last_event_id = event&.event_id unless event.is_a?(Sentry::TransactionEvent)
+      event
+    end
+
+    def add_breadcrumb(breadcrumb, hint: {})
+      return unless configuration.enabled_in_current_env?
+
+      if before_breadcrumb = current_client.configuration.before_breadcrumb
+        breadcrumb = before_breadcrumb.call(breadcrumb, hint)
+      end
+
+      return unless breadcrumb
+
+      current_scope.add_breadcrumb(breadcrumb)
+    end
+
+    # this doesn't do anything to the already initialized background worker
+    # but it temporarily disables dispatching events to it
+    def with_background_worker_disabled(&block)
+      original_background_worker_threads = configuration.background_worker_threads
+      configuration.background_worker_threads = 0
+
+      block.call
+    ensure
+      configuration.background_worker_threads = original_background_worker_threads
+    end
+
+    def start_session
+      return unless current_scope
+      current_scope.set_session(Session.new)
+    end
+
+    def end_session
+      return unless current_scope
+      session = current_scope.session
+      current_scope.set_session(nil)
+
+      return unless session
+      session.close
+      Sentry.session_flusher.add_session(session)
+    end
+
+    def with_session_tracking(&block)
+      return yield unless configuration.auto_session_tracking
+
+      start_session
+      yield
+    ensure
+      end_session
+    end
+
+    private
+
+    def current_layer
+      @stack.last
+    end
+
+    class Layer
+      attr_accessor :client
+      attr_reader :scope
+
+      def initialize(client, scope)
+        @client = client
+        @scope = scope
+      end
+    end
+  end
+end

data/lib/sentry/integrable.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Sentry
+  module Integrable
+    def register_integration(name:, version:)
+      Sentry.register_integration(name, version)
+      @integration_name = name
+    end
+
+    def integration_name
+      @integration_name
+    end
+
+    def capture_exception(exception, **options, &block)
+      options[:hint] ||= {}
+      options[:hint][:integration] = integration_name
+      Sentry.capture_exception(exception, **options, &block)
+    end
+
+    def capture_message(message, **options, &block)
+      options[:hint] ||= {}
+      options[:hint][:integration] = integration_name
+      Sentry.capture_message(message, **options, &block)
+    end
+  end
+end

data/lib/sentry/interface.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Sentry
+  class Interface
+    # @return [Hash]
+    def to_hash
+      Hash[instance_variables.map { |name| [name[1..-1].to_sym, instance_variable_get(name)] }]
+    end
+  end
+end
+
+require "sentry/interfaces/exception"
+require "sentry/interfaces/request"
+require "sentry/interfaces/single_exception"
+require "sentry/interfaces/stacktrace"
+require "sentry/interfaces/threads"

data/lib/sentry/interfaces/exception.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+require "set"
+
+module Sentry
+  class ExceptionInterface < Interface
+    # @return [<Array[SingleExceptionInterface]>]
+    attr_reader :values
+
+    # @param exceptions [Array<SingleExceptionInterface>]
+    def initialize(exceptions:)
+      @values = exceptions
+    end
+
+    # @return [Hash]
+    def to_hash
+      data = super
+      data[:values] = data[:values].map(&:to_hash) if data[:values]
+      data
+    end
+
+    # Builds ExceptionInterface with given exception and stacktrace_builder.
+    # @param exception [Exception]
+    # @param stacktrace_builder [StacktraceBuilder]
+    # @see SingleExceptionInterface#build_with_stacktrace
+    # @see SingleExceptionInterface#initialize
+    # @return [ExceptionInterface]
+    def self.build(exception:, stacktrace_builder:)
+      exceptions = Sentry::Utils::ExceptionCauseChain.exception_to_array(exception).reverse
+      processed_backtrace_ids = Set.new
+
+      exceptions = exceptions.map do |e|
+        if e.backtrace && !processed_backtrace_ids.include?(e.backtrace.object_id)
+          processed_backtrace_ids << e.backtrace.object_id
+          SingleExceptionInterface.build_with_stacktrace(exception: e, stacktrace_builder: stacktrace_builder)
+        else
+          SingleExceptionInterface.new(exception: exception)
+        end
+      end
+
+      new(exceptions: exceptions)
+    end
+  end
+end